Jocloud offers various client SDKs. A global real-time network (RTN) is connected through the SDK to provide RTS (Real-Time Signaling) with stable and reliable quality, high concurrency and ultra-low latency for developers, helping rapidly create a service scenario.
The code of the IM service SDK specific to Jocloud PC end is Hummer
.
API | Function |
---|---|
init | Initialize Hummer and start listening to Hummer status change |
getSDKVersion | Get Hummer version |
login | Log in an SDK |
logout | Log out an SDK |
getState | Get the current status of a HummerSDK |
refreshToken | Refresh a user token |
setLoggerFilePath | Directory of the log root path |
Callback | Function |
---|---|
onHummerLogin | Callback of Hummer login results |
onRefreshToken | Callback of refreshing results of a user token |
Notification | Function |
---|---|
onHummerStateChanged | Notification of SDK status change |
onHummerKicked | Notification received by the SDK of removal due to repeated logins |
onHummerPreviousTokenExpired | Notification of a user token expired |
API | Function |
---|---|
addEventHandler | Add listeners for signaling messages |
removeEventHandler | Remove listeners for signaling messages |
sendMessage | Send P2P signaling messages |
queryUserOnlineStatus | Batch search of user online status for indicating the status of specific users |
Callback | Function |
---|---|
onSendMessage | This event triggers the callback of sending P2P signaling messages. |
onQueryUserOnlineStatus | Callback of the batch search result of online users |
Notification | Function |
---|---|
onPeerMessageReceived | Notification for this event will be received upon receipt of P2P signaling messages |
API | Function |
---|---|
sendMessage | Send room messages |
addRoomEventHandler | Add room listeners |
removeRoomEventHandler | Remove room listeners |
setRoomAttributes | Set room profiles (full configuration of room profiles is supported for joining and exiting a room) |
addOrUpdateRoomAttributes | Update profiles of a specific room: update profiles while the profiles exist; otherwise, add profiles. |
deleteRoomAttributes | Delete specific profiles of specific rooms |
clearRoomAttributes | Clear profiles of specific rooms |
queryRoomAttributes | Search all profiles of specific rooms |
queryRoomAttributesByKeys | Search specific profiles of specific rooms |
queryMemberCounts | Batch search of the number of room members |
queryMembers | Search the list of room members |
Callback | Function |
---|---|
onQueryMembers | Callback of the result of searching room members |
onQueryMemberCounts | Callback of the result of searching the list of room members |
onSendMessage | Callback of the result of sending room messages |
onSetRoomAttributes | Callback of the result of setting room profiles |
onAddOrUpdateRoomAttributes | Callback of the result of adding or updating profiles of specific rooms |
onDeleteRoomAttributes | Callback of the result of deleting room profiles |
onClearRoomAttributes | Callback of the result of clearing all room profiles |
onQueryRoomAttributes | Callback of the result of searching all room profiles |
onQueryRoomAttributesByKeys | Callback of the result of searching specific room profiles |
Notification | Function |
---|---|
onRoomMessageReceived | When you send a signaling message to a room, all members in this room will receive a notification of this event. |
onRoomAttributesSet | Notification of setting room profiles |
onRoomAttributesDeleted | Notification of deleting room profiles |
onRoomAttributesCleared | Notification of clearing room profiles |
onRoomAttributesAddedOrUpdated | Notification of adding or updating room profiles |
API | Function |
---|---|
joinRoom | APIs for joining a room |
leaveRoom | APIs for exiting a room |
addMemberEventHandler | Add listeners for member events |
removeMemberEventHandler | Remove listeners for members |
setMemberAttributes | Set user information in the current room |
addOrUpdateMemberAttributes | Add or update user information in the current room |
deleteMemberAttributes | Delete specific user information in the current room |
clearMemberAttributes | Delete all user information in the current room |
queryMemberAttributes | Search all user profiles in the current room |
queryMemberAttributesByKeys | Search specific user profiles in the room |
Callback | Function |
---|---|
onJoinRoom | Callback of the result of joining a room |
onLeaveRoom | Callback of the result of exiting a room |
onSetMemberAttributes | Callback of the result of setting room member profiles |
onAddOrUpdateMemberAttributes | Callback of the result of updating room member profiles |
onClearMemberAttributes | Callback of the result of clearing all user profiles in the room |
onDeleteMemberAttributes | Callback of the result of deleting room member profiles |
onQueryMemberAttributes | Callback of the result of searching all room member profiles |
onQueryMemberAttributesByKeys | Callback of the result of searching specific room member profiles |
Notification | Function |
---|---|
onRoomMemberJoined | Notification of members joining a room |
onRoomMemberLeft | Notification of members exiting a room |
onRoomMemberOffline | Notification of the current user exited the room due to disconnection timeout |
onRoomMemberCountChanged | Notification of number change of room members |
onRoomMemberAttributesSet | Callback notification of setting room member information |
onRoomMemberAttributesDeleted | Callback notification of deleting room member information |
onRoomMemberAttributesCleared | Callback notification of clearing room member information |
onRoomMemberAttributesAddedOrUpdated | Callback notification of adding or updating room member information |