Event Callback

Callback List

HummerEventHandler

Callback	Function Name
void	onHummerLogin
void	onRefreshToken

Notification	Function Name
void	onHummerStateChanged
void	onHummerKicked
void	onHummerPreviousTokenExpired

RoomEventHandler

Callback	Function Name
void	onSetRoomAttributes
void	onAddOrUpdateRoomAttributes
void	onDeleteRoomAttributes
void	onClearRoomAttributes
void	onQueryRoomAttributes
void	onQueryRoomAttributesByKeys
void	onQueryMembers
void	onQueryMemberCounts
void	onSendMessage

Notification	Function Name
void	onRoomMessageReceived
void	onRoomAttributesSet
void	onRoomAttributesDeleted
void	onRoomAttributesCleared
void	onRoomAttributesAddedOrUpdated

MemberEventHandler

Callback	Function Name
void	onJoinRoom
void	onLeaveRoom
void	onSetMemberAttributes
void	onAddOrUpdateMemberAttributes
void	onClearMemberAttributes
void	onDeleteMemberAttributes
void	onQueryMemberAttributes
void	onQueryMemberAttributesByKeys

Notification	Function Name
void	onRoomMemberJoined
void	onRoomMemberLeft
void	onRoomMemberOffline
void	onRoomMemberCountChanged
void	onRoomMemberAttributesSet
void	onRoomMemberAttributesDeleted
void	onRoomMemberAttributesCleared
void	onRoomMemberAttributesAddedOrUpdated

PeerEventHandler

Callback	Function Name
void	onSendMessage
void	onQueryUserOnlineStatus

Notification	Function Name
void	onPeerMessageReceived

HummerLogCallback

Callback	Function Name
void	onHummerLogWithLevel

Callback Details

HummerEventHandler::onHummerStateChanged

void onHummerStateChanged(State oldState, State newState, const hmr::String& reason)

Callback of status change of a Hummer SDK.

Parameters

Parameter	Description
oldState	Previous status
newState	New status
reason	Change description

HummerEventHandler::onHummerKicked

void onHummerKicked(const Code& kickCode)

Callback of the SDK to remove users when login through multiple ends is detected.

Parameters

Parameter	Description
kickCode	Error code

HummerEventHandler::onHummerPreviousTokenExpired

void onHummerPreviousTokenExpired()

Callback notification returned by the SDK to the service layer upon token expiration.

Notes:

This callback is triggered only when token expires upon the SDK reconnection from disconnection. Once receiving this call, call refreshToken to refresh the token.

HummerEventHandler::onHummerLogin

void onHummerLogin(RequestId requestId, 
                   UserId userId, 
                   const Code& code)

Callback of the Hummer login result.

Parameters

Parameter	Description
requestId	Request ID for the corresponding request
UserId	Operator ID
code	Error code

HummerEventHandler::onRefreshToken

void onRefreshToken(RequestId requestId, const Code& code)

Callback of the refresh result of user token.

Parameters

Parameter	Description
requestId	Request ID for the corresponding request
code	Error code

RoomEventHandler

RoomEventHandler::onRoomAttributesSet

void onRoomAttributesSet(const RoomId& roomId, 
                         UserId userId, 
                         const Dictionary& attributes)

Notification of setting room profiles.

Parameters

Parameter	Description
roomId	Room ID
userId	Operator ID
attributes	Fully set profiles

RoomEventHandler::onRoomMessageReceived

void onRoomMessageReceived(const RoomId& roomId, 
                           UserId userId, 
                           const Message& msg)

When you send a signaling message to a room, all members in this room will receive a callback notification of this event.

Parameters

Parameter	Description
roomId	Room ID
userId	Sender ID
msg	Signaling message

RoomEventHandler::onRoomAttributesDeleted

 void onRoomAttributesDeleted(const RoomId& roomId,
                              UserId userId, 
                              const Dictionary& attributes)

Notification of deleting room profiles.

Parameters

Parameter	Description
roomId	Room ID
userId	Operator ID
attributes	Fully set profiles

RoomEventHandler::onRoomAttributesCleared

void onRoomAttributesCleared(const RoomId& roomId, 
                             UserId userId, 
                             const Dictionary& attributes)

Notification of clearing room profiles.

Parameters

Parameter	Description
roomId	Room ID
userId	Operator ID
attributes	Corresponding profiles

RoomEventHandler::onRoomAttributesAddedOrUpdated

void onRoomAttributesAddedOrUpdated(const RoomId& roomId, 
                                    UserId userId, 
                                    const Dictionary& attributes)

Notification of updating room information.

Parameters

Parameter	Description
roomId	Room ID
userId	Operator ID
attributes	Corresponding profiles

RoomEventHandler::onSetRoomAttributes

void onSetRoomAttributes(RequestId requestId, 
                         const Code& code, 
                         const RoomId& roomId, 
                         const Dictionary& attributes, 
                         const RoomAttributeOptions& options)

Callback of the result of setting room profiles.

Notes:

Call setRoomAttributes to perform callback.

Parameters

Parameter	Description
requestId	Request ID for the corresponding request
code	Code ID for room operation result
roomId	Room ID
attributes	Corresponding profiles
options	Configuration information for sent signaling messages

RoomEventHandler::onAddOrUpdateRoomAttributes

onAddOrUpdateRoomAttributes(RequestId requestId, 
                            const Code& code, 
                            const RoomId& roomId, 
                            const Dictionary& attributes, 
                            const RoomAttributeOptions& options)

Callback of the result of adding or updating profiles of specific rooms.

Notes:

Call addOrUpdateRoomAttributes to perform callback.

Parameters

Parameter	Description
requestId	Request ID for the corresponding request
code	Code ID for room operation result
roomId	Room ID
attributes	Corresponding profiles
options	Configuration information for sent signaling messages

RoomEventHandler::onDeleteRoomAttributes

void onDeleteRoomAttributes(RequestId requestId, 
                            const Code& code, 
                            const RoomId& roomId, 
                            const String keys[], 
                            int numberOfKeys, 
                            const RoomAttributeOptions& options)

Callback of the result of deleting room profiles.

Notes:

Call deleteRoomAttributes to perform callback.

Parameters

Parameter	Description
requestId	Request ID for the corresponding request
code	Code ID for room operation result
roomId	Room ID
keys	Profile array
numberOfKeys	Number of profiles
options	Configuration information for sent signaling messages

RoomEventHandler::onClearRoomAttributes

void onClearRoomAttributes(RequestId requestId, 
                           const Code& code, 
                           const RoomId& roomId, 
                           const RoomAttributeOptions& options)

Callback of the result of clearing all room profiles.

Notes:

Call clearRoomAttributes to perform callback.

Parameters

Parameter	Description
requestId	Request ID for the corresponding request
code	Code ID for room operation result
roomId	Room ID
options	Configuration information for sent signaling messages

RoomEventHandler::onQueryRoomAttributes

void onQueryRoomAttributes(RequestId requestId, 
                           const Code& code, 
                           const RoomId& roomId, 
                           const Dictionary& attributes)

Callback of the result of searching all room profiles.

Notes:

Call queryRoomAttributes to perform callback.

Parameters

Parameter	Description
requestId	Request ID for the corresponding request
code	Code ID for room operation result
roomId	Room ID
attributes	Fully set profiles

RoomEventHandler::onQueryRoomAttributesByKeys

void onQueryRoomAttributesByKeys(RequestId requestId, 
                                 const Code& code, 
                                 const RoomId& roomId,
                                 const Dictionary& attributes)

Callback of the result of searching specific room profiles.

Notes:

Call queryRoomAttributesByKeys to perform callback.

Parameters

Parameter	Description
requestId	Request ID for the corresponding request
code	Code ID for room operation result
roomId	Room ID
attributes	Fully set profiles

MemberEventHandler

MemberEventHandler::onRoomMemberJoined

void onRoomMemberJoined(const RoomId& roomId, 
                        const UserId userIds[], 
                        int numberOfUserIds)

Notification of members joining a room. This notification will not be sent if over 500 members have joined the room.

Parameters

Parameter	Description
roomId	Room ID
userIds	User ID array
numberOfUserIds	Number of user IDs

MemberEventHandler::onRoomMemberLeft

void onRoomMemberLeft(const RoomId& roomId, 
                      const UserId userIds[], 
                      int numberOfUserIds)

Notification of members exiting a room. This notification will not be sent if over 500 members have joined the room.

Parameters

Parameter	Description
roomId	Room ID
userIds	User ID array
numberOfUserIds	Number of user IDs

MemberEventHandler::onRoomMemberOffline

void onRoomMemberOffline(const RoomId roomIds[], int numberOfRoomIds)

Notification of the current user exiting the room due to disconnection timeout.

Notes:

This notification is triggered only when the current user exits the room due to local disconnection timeout.

Parameters

Parameter	Description
userIds	User ID array
numberOfUserIds	Number of user IDs

MemberEventHandler::onRoomMemberCountChanged

void onRoomMemberCountChanged(const RoomMemberCount memberCounts[], int numberOfCounts)

Notification of number change of room members.

Parameters

Parameter	Description
memberCounts	Room user array
numberOfCounts	Number of room members

MemberEventHandler::onRoomMemberAttributesSet

void onRoomMemberAttributesSet(const RoomId& roomId,
                               UserId userId, 
                               const Dictionary& attributes)

Notification of setting member attributes.

Parameters

Parameter	Description
roomId	Room ID
userId	Operator ID
attributes	Corresponding profiles

MemberEventHandler::onRoomMemberAttributesDeleted

void onRoomMemberAttributesDeleted(const RoomId& roomId, 
                                   UserId userId, 
                                   const Dictionary& attributes)

Notification of deleting member profiles.

Parameters

Parameter	Description
roomId	Room ID
userId	Operator ID
attributes	Corresponding profiles

MemberEventHandler::onRoomMemberAttributesCleared

void onRoomMemberAttributesCleared(const RoomId& roomId, 
                                   UserId userId, 
                                   const Dictionary& attributes)

Callback notification of clearing room member information.

Parameters

Parameter	Description
roomId	Room ID
userId	Operator ID
attributes	Corresponding profiles

MemberEventHandler::onRoomMemberAttributesAddedOrUpdated

void onRoomMemberAttributesAddedOrUpdated(const RoomId& roomId, 
                                          UserId userId,
                                          const Dictionary& attributes)

Callback notification of updating room member information.

Parameters

Parameter	Description
roomId	Room ID
userId	Operator ID
attributes	Corresponding profiles

MemberEventHandler::onJoinRoom

void onJoinRoom(RequestId requestId, 
                const Code& code, 
                const RoomId& roomId,
                const Dictionary& extras, 
                const RoomJoinningOptions& options)

Callback of the result of joining a room.

Notes:

Call joinRoom to perform callback.

Parameters

Parameter	Description
requestId	Request ID for the corresponding request
code	Code ID for a room operation result
roomId	Room ID
extras	Extension information for joining a room
options	Optional parameters for joining a room

MemberEventHandler::onLeaveRoom

void onLeaveRoom(RequestId requestId, 
                 const Code& code, 
                 const RoomId& roomId)

Callback of the result of exiting a room.

Notes:

Call leaveRoom to perform callback.

Parameters

Parameter	Description
requestId	Request ID for the corresponding request
code	Code ID for room operation result
roomId	Room ID

MemberEventHandler::onQueryMembers

void onQueryMembers(RequestId requestId, 
                    const Code& code, 
                    const RoomId& roomId, 
                    const UserId userIds[], 
                    int numberOfUserIds)

Callback of the result of searching room members.

Notes:

Call queryMembers to perform callback.

Parameters

Parameter	Description
requestId	Request ID for the corresponding request
code	Code ID for operation result
roomId	Room ID
userIds	User ID array
numberOfUserIds	NUmber of user IDs

MemberEventHandler::onQueryMemberCounts

void onQueryMemberCounts(RequestId requestId, 
                         const Code& code, 
                         const RoomMemberCount memberCounts[], 
                         int numberOfCounts)

Callback of the result of searching a list of room members.

Notes:

Call queryMemberCounts to perform callback.

Parameters

Parameter	Description
requestId	Request ID for the corresponding request
code	Code ID for operation result
memberCounts	Room member number set
numberOfCounts	Volume of room member number set

MemberEventHandler::onSendMessage

void onSendMessage(RequestId requestId, 
                   const Code& code,
                   const RoomId& roomId,
                   const Message& msg,
                   const MessagingOptions& options)

Callback of the result of sending room messages.

Notes:

Call sendMessage to perform callback.

Parameters

Parameter	Description
requestId	Request ID for the corresponding request
code	Code ID for room operation result
roomId	Room ID
msg	Message
options	Message options

MemberEventHandler::onSetMemberAttributes

 void onSetMemberAttributes(RequestId requestId, 
                            const Code& code, 
                            const RoomId& roomId, 
                            UserId userId, 
                            const Dictionary& attributes, 
                            const MemberAttributeOptions& options)

Callback of the result of setting room member profiles.

Notes:

Call setMemberAttributes to perform callback.

Parameters

Parameter	Description
requestId	Request ID for the corresponding request
code	Code ID for room operation result
roomId	Room ID
userId	Sender ID
attributes	Message
options	Message options

MemberEventHandler::onAddOrUpdateMemberAttributes

void onAddOrUpdateMemberAttributes(RequestId requestId, 
                                   const Code& code, 
                                   const RoomId& roomId, 
                                   UserId userId, 
                                   const Dictionary& attributes, 
                                   const MemberAttributeOptions& options)

Callback of the result of updating room member profiles.

Notes:

Call addOrUpdateMemberAttributes to perform callback.

Parameters

Parameter	Description
requestId	Request ID for the corresponding request
code	Code ID for room operation result
roomId	Room ID
userId	Sender ID
attributes	Message
options	Message options

MemberEventHandler::onClearMemberAttributes

void onClearMemberAttributes(RequestId requestId, 
                             const Code& code, 
                             const RoomId& roomId, 
                             UserId userId, 
                             const MemberAttributeOptions& options)

Callback of the result of clearing all user profiles in a room.

Notes:

Call clearMemberAttributes to perform callback.

Parameters

Parameter	Description
requestId	Request ID generated for the corresponding request
code	Code ID for room operation result
roomId	Room ID
userId	Sender ID
options	Message options

MemberEventHandler::onDeleteMemberAttributes

void onDeleteMemberAttributes(RequestId requestId, 
                              const Code& code, 
                              const RoomId& roomId, 
                              UserId userId, 
                              const String keys[], 
                              int numberOfKeys, 
                              const MemberAttributeOptions& options)

Callback of the result of deleting room member profiles.

Notes:

Call deleteMemberAttributes to perform callback.

Parameters

Parameter	Description
requestId	Request ID for the corresponding request
code	Code ID for room operation result
roomId	Room ID
userId	Sender ID
keys	Profile array
numberOfKeys	Number of profiles
options	Message options

MemberEventHandler::onQueryMemberAttributes

void onQueryMemberAttributes(RequestId requestId, 
                             const Code& code, 
                             const RoomId& roomId,
                             UserId userId, 
                             const Dictionary& attributes)

Callback of the result of searching all room member profiles.

Notes:

Call queryMemberAttributes to perform callback.

Parameters

Parameter	Description
requestId	Request ID for the corresponding request
code	Code ID for room operation result
roomId	Room ID
userId	Sender ID
attributes	Fully set profiles

MemberEventHandler::onQueryMemberAttributesByKeys

void onQueryMemberAttributesByKeys(RequestId requestId, 
                                   const Code& code, 
                                   const RoomId& roomId, 
                                   UserId userId, 
                                   const Dictionary& attributes)

Callback of the result of searching specific profiles of room members.

Notes:

Call queryMemberAttributesByKeys to perform callback.

Parameters

Parameter	Description
requestId	Request ID for the corresponding request
code	Code ID for room operation result
roomId	Room ID
userId	Sender ID
attributes	Fully set profiles

PeerEventHandler

PeerEventHandler::onPeerMessageReceived

void onPeerMessageReceived(UserId userId, const Message& message)

A notification of this event will be received upon the receipt of P2P signaling messages.

Parameters

Parameter	Description
userId	Sender ID
message	Received signaling message

PeerEventHandler::onSendMessage

void onSendMessage(RequestId requestId, 
                   const Code& code,
                   UserId userId, 
                   const Message& message, 
                   const MessagingOptions& options)

This event carries the callback of sending P2P signaling messages.

Notes:

Call sendMessage to preform callback.

Parameters

Parameter	Description
requestId	Request ID for the corresponding request
code	Code ID for room operation result
userId	Sender ID
message	Received signaling message
options	Configuration information for sent signaling messages

PeerEventHandler::onQueryUserOnlineStatus

void onQueryUserOnlineStatus(RequestId requestId, 
                             const Code& code, 
                             const UserOnlineStatus status[], 
                             int count)

Callback of the result of batch search for online users.

Notes:

Call queryUserOnlineStatus to perform callback.

Parameters

Parameter	Description
requestId	Request ID for the corresponding request
code	Code ID for room operation result
status	Search result
count	Number of lists

HummerLogCallback::onHummerLogWithLevel

void onHummerLogWithLevel(HMRLogLevel level, const String& msg) = 0

Log output callback.

Parameters

Parameter	Description
level	Level of logs to be output, see detaisl in HMRLogLevel
msg	Logs to be output