Interface IRtmEventHandler

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.

Hierarchy

IRtmEventHandler

Methods

`Optional` onAcquireLockResult

onAcquireLockResult(requestId, channelName, channelType, lockName, errorCode, errorDetails): void
Occurs when user acquire a lock
Parameters
- requestId: number
- channelName: string
  
  The name of the channel.
- channelType: RTM_CHANNEL_TYPE
  
  The type of the channel.
- lockName: string
  
  The name of the lock.
- errorCode: RTM_ERROR_CODE
  
  The error code.
- errorDetails: string
Returns void
- Defined in IAgoraRtmClient.ts:692

`Optional` onConnectionStateChanged

onConnectionStateChanged(channelName, state, reason): void
Occurs when the connection state changes between rtm sdk and agora service.
Parameters
- channelName: string
  
  The name of the channel.
- state: RTM_CONNECTION_STATE
  
  The new connection state.
- reason: RTM_CONNECTION_CHANGE_REASON
  
  The reason for the connection state change.
Returns void
- Defined in IAgoraRtmClient.ts:485

`Optional` onGetChannelMetadataResult

onGetChannelMetadataResult(requestId, channelName, channelType, data, errorCode): void
Occurs when user try to get the channel metadata
Parameters
- requestId: number
  
  The related request id when user perform this operation
- channelName: string
  
  The name of the channel.
- channelType: RTM_CHANNEL_TYPE
  
  The type of the channel.
- data: RtmMetadata
  
  The result metadata of getting operation.
- errorCode: RTM_ERROR_CODE
  
  The error code.
Returns void
- Defined in IAgoraRtmClient.ts:571

`Optional` onGetLocksResult

onGetLocksResult(requestId, channelName, channelType, lockDetailList, count, errorCode): void
Occurs when user try to get locks from the channel
Parameters
- requestId: number
- channelName: string
  
  The name of the channel.
- channelType: RTM_CHANNEL_TYPE
  
  The type of the channel.
- lockDetailList: LockDetail[]
  
  The details of the locks.
- count: number
  
  The count of the locks.
- errorCode: RTM_ERROR_CODE
  
  The error code.
Returns void
- Defined in IAgoraRtmClient.ts:724

`Optional` onGetOnlineUsersResult

onGetOnlineUsersResult(requestId, userStateList, count, nextPage, errorCode): void
Occurs when query who joined this channel
Parameters
- requestId: number
  
  The related request id when user perform this operation
- userStateList: UserState[]
- count: number
  
  The user count.
- nextPage: string
- errorCode: RTM_ERROR_CODE
  
  The error code.
Returns void
- Defined in IAgoraRtmClient.ts:755

`Optional` onGetUserChannelsResult

onGetUserChannelsResult(requestId, channels, count, errorCode): void
Occurs when query which channels the user joined
Parameters
- requestId: number
  
  The related request id when user perform this operation
- channels: ChannelInfo[]
  
  The channel informations.
- count: number
  
  The channel count.
- errorCode: RTM_ERROR_CODE
  
  The error code.
Returns void
- Defined in IAgoraRtmClient.ts:784

`Optional` onGetUserMetadataResult

onGetUserMetadataResult(requestId, userId, data, errorCode): void
Occurs when user try to get the user metadata
Parameters
- requestId: number
  
  The related request id when user perform this operation
- userId: string
  
  The id of the user.
- data: RtmMetadata
  
  The result metadata of getting operation.
- errorCode: RTM_ERROR_CODE
  
  The error code.
Returns void
- Defined in IAgoraRtmClient.ts:622

`Optional` onJoinResult

onJoinResult(requestId, channelName, userId, errorCode): void
Occurs when user join a stream channel.
Parameters
- requestId: number
- channelName: string
  
  The name of the channel.
- userId: string
  
  The id of the user.
- errorCode: RTM_ERROR_CODE
  
  The error code.
Returns void
- Defined in IAgoraRtmClient.ts:406

`Optional` onJoinTopicResult

onJoinTopicResult(requestId, channelName, userId, topic, meta, errorCode): void
Occurs when user join topic.
Parameters
- requestId: number
- channelName: string
  
  The name of the channel.
- userId: string
  
  The id of the user.
- topic: string
  
  The name of the topic.
- meta: string
  
  The meta of the topic.
- errorCode: RTM_ERROR_CODE
  
  The error code.
Returns void
- Defined in IAgoraRtmClient.ts:434

`Optional` onLeaveResult

onLeaveResult(requestId, channelName, userId, errorCode): void
Occurs when user leave a stream channel.
Parameters
- requestId: number
- channelName: string
  
  The name of the channel.
- userId: string
  
  The id of the user.
- errorCode: RTM_ERROR_CODE
  
  The error code.
Returns void
- Defined in IAgoraRtmClient.ts:419

`Optional` onLeaveTopicResult

onLeaveTopicResult(requestId, channelName, userId, topic, meta, errorCode): void
Occurs when user leave topic.
Parameters
- requestId: number
- channelName: string
  
  The name of the channel.
- userId: string
  
  The id of the user.
- topic: string
  
  The name of the topic.
- meta: string
  
  The meta of the topic.
- errorCode: RTM_ERROR_CODE
  
  The error code.
Returns void
- Defined in IAgoraRtmClient.ts:451

`Optional` onLockEvent

onLockEvent(event): void
Occurs when lock state changed
Parameters
- event: LockEvent
  
  details of lock event.
Returns void
- Defined in IAgoraRtmClient.ts:392

`Optional` onLoginResult

onLoginResult(errorCode): void
Occurs when user login.
Parameters
- errorCode: RTM_ERROR_CODE
  
  The error code.
Returns void
- Defined in IAgoraRtmClient.ts:519

`Optional` onMessageEvent

onMessageEvent(event): void
Occurs when receive a message.
Parameters
- event: MessageEvent
  
  details of message event.
Returns void
- Defined in IAgoraRtmClient.ts:373

`Optional` onPresenceEvent

onPresenceEvent(event): void
Occurs when remote user presence changed
Parameters
- event: PresenceEvent
  
  details of presence event.
Returns void
- Defined in IAgoraRtmClient.ts:379

`Optional` onPresenceGetStateResult

onPresenceGetStateResult(requestId, state, errorCode): void
Occurs when get user presence
Parameters
- requestId: number
  
  The related request id when user perform this operation
- state: UserState
- errorCode: RTM_ERROR_CODE
  
  The error code.
Returns void
- Defined in IAgoraRtmClient.ts:814

`Optional` onPresenceRemoveStateResult

onPresenceRemoveStateResult(requestId, errorCode): void
Occurs when delete user presence
Parameters
- requestId: number
  
  The related request id when user perform this operation
- errorCode: RTM_ERROR_CODE
  
  The error code.
Returns void
- Defined in IAgoraRtmClient.ts:803

`Optional` onPresenceSetStateResult

onPresenceSetStateResult(requestId, errorCode): void
Occurs when set user presence
Parameters
- requestId: number
  
  The related request id when user perform this operation
- errorCode: RTM_ERROR_CODE
  
  The error code.
Returns void
- Defined in IAgoraRtmClient.ts:796

`Optional` onPublishResult

onPublishResult(requestId, errorCode): void
Occurs when user publish message.
Parameters
- requestId: number
  
  The related request id when user publish message
- errorCode: RTM_ERROR_CODE
  
  The error code.
Returns void
- Defined in IAgoraRtmClient.ts:513

`Optional` onReleaseLockResult

onReleaseLockResult(requestId, channelName, channelType, lockName, errorCode): void
Occurs when user release a lock
Parameters
- requestId: number
- channelName: string
  
  The name of the channel.
- channelType: RTM_CHANNEL_TYPE
  
  The type of the channel.
- lockName: string
  
  The name of the lock.
- errorCode: RTM_ERROR_CODE
  
  The error code.
Returns void
- Defined in IAgoraRtmClient.ts:677

`Optional` onRemoveChannelMetadataResult

onRemoveChannelMetadataResult(requestId, channelName, channelType, errorCode): void
Occurs when user removing the channel metadata
Parameters
- requestId: number
  
  The related request id when user perform this operation
- channelName: string
  
  The name of the channel.
- channelType: RTM_CHANNEL_TYPE
  
  The type of the channel.
- errorCode: RTM_ERROR_CODE
  
  The error code.
Returns void
- Defined in IAgoraRtmClient.ts:556

`Optional` onRemoveLockResult

onRemoveLockResult(requestId, channelName, channelType, lockName, errorCode): void
Occurs when user delete a lock
Parameters
- requestId: number
- channelName: string
  
  The name of the channel.
- channelType: RTM_CHANNEL_TYPE
  
  The type of the channel.
- lockName: string
  
  The name of the lock.
- errorCode: RTM_ERROR_CODE
  
  The error code.
Returns void
- Defined in IAgoraRtmClient.ts:662

`Optional` onRemoveUserMetadataResult

onRemoveUserMetadataResult(requestId, userId, errorCode): void
Occurs when user removing the user metadata
Parameters
- requestId: number
  
  The related request id when user perform this operation
- userId: string
  
  The id of the user.
- errorCode: RTM_ERROR_CODE
  
  The error code.
Returns void
- Defined in IAgoraRtmClient.ts:609

`Optional` onRevokeLockResult

onRevokeLockResult(requestId, channelName, channelType, lockName, errorCode): void
Occurs when user revoke a lock
Parameters
- requestId: number
- channelName: string
  
  The name of the channel.
- channelType: RTM_CHANNEL_TYPE
  
  The type of the channel.
- lockName: string
  
  The name of the lock.
- errorCode: RTM_ERROR_CODE
  
  The error code.
Returns void
- Defined in IAgoraRtmClient.ts:708

`Optional` onSetChannelMetadataResult

onSetChannelMetadataResult(requestId, channelName, channelType, errorCode): void
Occurs when user setting the channel metadata
Parameters
- requestId: number
  
  The related request id when user perform this operation
- channelName: string
  
  The name of the channel.
- channelType: RTM_CHANNEL_TYPE
  
  The type of the channel.
- errorCode: RTM_ERROR_CODE
  
  The error code.
Returns void
- Defined in IAgoraRtmClient.ts:528

`Optional` onSetLockResult

onSetLockResult(requestId, channelName, channelType, lockName, errorCode): void
Occurs when user set a lock
Parameters
- requestId: number
- channelName: string
  
  The name of the channel.
- channelType: RTM_CHANNEL_TYPE
  
  The type of the channel.
- lockName: string
  
  The name of the lock.
- errorCode: RTM_ERROR_CODE
  
  The error code.
Returns void
- Defined in IAgoraRtmClient.ts:647

`Optional` onSetUserMetadataResult

onSetUserMetadataResult(requestId, userId, errorCode): void
Occurs when user setting the user metadata
Parameters
- requestId: number
  
  The related request id when user perform this operation
- userId: string
  
  The id of the user.
- errorCode: RTM_ERROR_CODE
  
  The error code.
Returns void
- Defined in IAgoraRtmClient.ts:585

`Optional` onStorageEvent

onStorageEvent(event): void
Occurs when receive storage event
Parameters
- event: StorageEvent
  
  details of storage event.
Returns void
- Defined in IAgoraRtmClient.ts:398

`Optional` onSubscribeResult

onSubscribeResult(requestId, channelName, errorCode): void
Occurs when subscribe a channel
Parameters
- requestId: number
- channelName: string
  
  The name of the channel.
- errorCode: RTM_ERROR_CODE
  
  The error code.
Returns void
- Defined in IAgoraRtmClient.ts:502

`Optional` onSubscribeTopicResult

onSubscribeTopicResult(requestId, channelName, userId, topic, succeedUsers, failedUsers, errorCode): void
Occurs when user subscribe topic.
Parameters
- requestId: number
- channelName: string
  
  The name of the channel.
- userId: string
  
  The id of the user.
- topic: string
  
  The name of the topic.
- succeedUsers: UserList
  
  The subscribed users.
- failedUsers: UserList
- errorCode: RTM_ERROR_CODE
  
  The error code.
Returns void
- Defined in IAgoraRtmClient.ts:469

`Optional` onSubscribeUserMetadataResult

onSubscribeUserMetadataResult(requestId, userId, errorCode): void
Occurs when user subscribe a user metadata
Parameters
- requestId: number
- userId: string
  
  The id of the user.
- errorCode: RTM_ERROR_CODE
  
  The error code.
Returns void
- Defined in IAgoraRtmClient.ts:634

`Optional` onTokenPrivilegeWillExpire

onTokenPrivilegeWillExpire(channelName): void
Occurs when token will expire in 30 seconds.
Parameters
- channelName: string
  
  The name of the channel.
Returns void
- Defined in IAgoraRtmClient.ts:495

`Optional` onTopicEvent

onTopicEvent(event): void
Occurs when remote user join/leave topic or when user first join this channel, got snapshot of topics in this channel
Parameters
- event: TopicEvent
  
  details of topic event.
Returns void
- Defined in IAgoraRtmClient.ts:386

`Optional` onUpdateChannelMetadataResult

onUpdateChannelMetadataResult(requestId, channelName, channelType, errorCode): void
Occurs when user updating the channel metadata
Parameters
- requestId: number
  
  The related request id when user perform this operation
- channelName: string
  
  The name of the channel.
- channelType: RTM_CHANNEL_TYPE
  
  The type of the channel.
- errorCode: RTM_ERROR_CODE
  
  The error code.
Returns void
- Defined in IAgoraRtmClient.ts:542

`Optional` onUpdateUserMetadataResult

onUpdateUserMetadataResult(requestId, userId, errorCode): void
Occurs when user updating the user metadata
Parameters
- requestId: number
  
  The related request id when user perform this operation
- userId: string
  
  The id of the user.
- errorCode: RTM_ERROR_CODE
  
  The error code.
Returns void
- Defined in IAgoraRtmClient.ts:597

`Optional` onWhereNowResult

onWhereNowResult(requestId, channels, count, errorCode): void
Occurs when query which channels the user joined
Parameters
- requestId: number
  
  The related request id when user perform this operation
- channels: ChannelInfo[]
  
  The channel informations.
- count: number
  
  The channel count.
- errorCode: RTM_ERROR_CODE
  
  The error code.
Returns void
- Defined in IAgoraRtmClient.ts:770

`Optional` onWhoNowResult

onWhoNowResult(requestId, userStateList, count, nextPage, errorCode): void
Occurs when query who joined this channel
Parameters
- requestId: number
  
  The related request id when user perform this operation
- userStateList: UserState[]
- count: number
  
  The user count.
- nextPage: string
- errorCode: RTM_ERROR_CODE
  
  The error code.
Returns void
- Defined in IAgoraRtmClient.ts:740

Interface IRtmEventHandler

Hierarchy

Index

Methods

Methods

Optional onAcquireLockResult

Parameters

requestId: number

channelName: string

channelType: RTM_CHANNEL_TYPE

lockName: string

errorCode: RTM_ERROR_CODE

errorDetails: string

Returns void

Optional onConnectionStateChanged

Parameters

channelName: string

state: RTM_CONNECTION_STATE

reason: RTM_CONNECTION_CHANGE_REASON

Returns void

Optional onGetChannelMetadataResult

Parameters

requestId: number

channelName: string

channelType: RTM_CHANNEL_TYPE

data: RtmMetadata

errorCode: RTM_ERROR_CODE

Returns void

Optional onGetLocksResult

Parameters

requestId: number

channelName: string

channelType: RTM_CHANNEL_TYPE

lockDetailList: LockDetail[]

count: number

errorCode: RTM_ERROR_CODE

Returns void

Optional onGetOnlineUsersResult

Parameters

requestId: number

userStateList: UserState[]

count: number

nextPage: string

errorCode: RTM_ERROR_CODE

Returns void

Optional onGetUserChannelsResult

Parameters

requestId: number

channels: ChannelInfo[]

count: number

errorCode: RTM_ERROR_CODE

Returns void

Optional onGetUserMetadataResult

Parameters

requestId: number

userId: string

data: RtmMetadata

errorCode: RTM_ERROR_CODE

Returns void

Optional onJoinResult

Parameters

requestId: number

channelName: string

userId: string

errorCode: RTM_ERROR_CODE

Returns void

Optional onJoinTopicResult

Parameters

requestId: number

channelName: string

userId: string

topic: string

meta: string

errorCode: RTM_ERROR_CODE

Returns void

Optional onLeaveResult

Parameters

requestId: number

channelName: string

userId: string

`Optional` onAcquireLockResult

`Optional` onConnectionStateChanged

`Optional` onGetChannelMetadataResult

`Optional` onGetLocksResult

`Optional` onGetOnlineUsersResult

`Optional` onGetUserChannelsResult

`Optional` onGetUserMetadataResult

`Optional` onJoinResult

`Optional` onJoinTopicResult

`Optional` onLeaveResult

`Optional` onLeaveTopicResult

`Optional` onLockEvent

`Optional` onLoginResult

`Optional` onMessageEvent

`Optional` onPresenceEvent

`Optional` onPresenceGetStateResult

`Optional` onPresenceRemoveStateResult

`Optional` onPresenceSetStateResult

`Optional` onPublishResult

`Optional` onReleaseLockResult

`Optional` onRemoveChannelMetadataResult

`Optional` onRemoveLockResult