Optional
onOccurs when user acquire a lock
The related request id when user perform this operation
The name of the channel.
The type of the channel.
The name of the lock.
The error code.
The details of error.
Optional
onThe name of the channel.
The new connection state.
The reason for the connection state change.
This callback is deprecated. Use LinkStateEvent instead. Occurs when the connection state changes between rtm sdk and agora service.
Optional
onOccurs when user try to get the channel metadata
The related request id when user perform this operation
The name of the channel.
The type of the channel.
The result metadata of getting operation.
The error code.
Optional
onOccurs when get history messages
The related request id when user perform this operation
The history message list.
The message count.
The timestamp of next history message. If newStart is 0, means there are no more history messages
The error code.
Optional
onOccurs when user try to get locks from the channel
The related request id when user perform this operation
The name of the channel.
The type of the channel.
The details of the locks.
The count of the locks.
The error code.
Optional
onOptional
onOptional
onOccurs when query which channels the user joined
The related request id when user perform this operation
The channel informations.
The channel count.
The error code.
Optional
onOptional
onOccurs when user join a stream channel.
The related request id when user perform this operation
The name of the channel.
The id of the user.
The error code.
Optional
onOccurs when user join topic.
The related request id when user perform this operation
The name of the channel.
The id of the user.
The name of the topic.
The meta of the topic.
The error code.
Optional
onOccurs when user leave a stream channel.
The related request id when user perform this operation
The name of the channel.
The id of the user.
The error code.
Optional
onOccurs when user leave topic.
The related request id when user perform this operation
The name of the channel.
The id of the user.
The name of the topic.
The meta of the topic.
The error code.
Optional
onOccurs when link state change
details of link state event
Optional
onOccurs when lock state changed
details of lock event.
Optional
onOccurs when user login.
The related request id when user perform this operation
The error code.
Optional
onOccurs when user logout.
The related request id when user perform this operation.
The error code.
Optional
onOccurs when receive a message.
details of message event.
Optional
onOccurs when remote user presence changed
details of presence event.
Optional
onOptional
onOccurs when delete user presence
The related request id when user perform this operation
The error code.
Optional
onOccurs when set user presence
The related request id when user perform this operation
The error code.
Optional
onOccurs when user publish message.
The related request id when user publish message
The error code.
Optional
onOccurs when user publish topic message.
The related request id when user perform this operation
The name of the channel.
The name of the topic.
The error code.
Optional
onOccurs when user release a lock
The related request id when user perform this operation
The name of the channel.
The type of the channel.
The name of the lock.
The error code.
Optional
onOccurs when user removing the channel metadata
The related request id when user perform this operation
The name of the channel.
The type of the channel.
The error code.
Optional
onOccurs when user delete a lock
The related request id when user perform this operation
The name of the channel.
The type of the channel.
The name of the lock.
The error code.
Optional
onOccurs when user removing the user metadata
The related request id when user perform this operation
The id of the user.
The error code.
Optional
onOccurs when user renew token.
The related request id when user renew token.
The type of server.
The name of the channel.
The error code.
Optional
onOccurs when user revoke a lock
The related request id when user perform this operation
The name of the channel.
The type of the channel.
The name of the lock.
The error code.
Optional
onOccurs when user setting the channel metadata
The related request id when user perform this operation
The name of the channel.
The type of the channel.
The error code.
Optional
onOccurs when user set a lock
The related request id when user perform this operation
The name of the channel.
The type of the channel.
The name of the lock.
The error code.
Optional
onOccurs when user setting the user metadata
The related request id when user perform this operation
The id of the user.
The error code.
Optional
onOccurs when receive storage event
details of storage event.
Optional
onOccurs when subscribe a channel
The related request id when user perform this operation
The name of the channel.
The error code.
Optional
onOptional
onOccurs when user subscribe a user metadata
The related request id when user perform this operation
The id of the user.
The error code.
Optional
onOptional
onOccurs when remote user join/leave topic or when user first join this channel, got snapshot of topics in this channel
details of topic event.
Optional
onOccurs when unsubscribe a channel
The related request id when user unsubscribe.
The name of the channel.
The error code.
Optional
onOccurs when user call unsubscribe topic.
The related request id when user perform this operation
The name of the channel.
The name of the topic.
The error code.
Optional
onOccurs when user unsubscribe a user metadata
The related request id when user perform this operation
The id of the user.
The error code.
Optional
onOccurs when user updating the channel metadata
The related request id when user perform this operation
The name of the channel.
The type of the channel.
The error code.
Optional
onOccurs when user updating the user metadata
The related request id when user perform this operation
The id of the user.
The error code.
Optional
onOccurs when query which channels the user joined
The related request id when user perform this operation
The channel informations.
The channel count.
The error code.
Optional
on
The IRtmEventHandler class.
The SDK uses this class to send callback event notifications to the app, and the app inherits the methods in this class to retrieve these event notifications.
All methods in this class have their default (empty) implementations, and the app can inherit only some of the required events instead of all. In the callback methods, the app should avoid time-consuming tasks or calling blocking APIs, otherwise the SDK may not work properly.