Class IRtmPresence`Abstract`

The IRtmPresence class.

This class provides the rtm presence methods that can be invoked by your app.

Hierarchy

IRtmPresence

Index

Constructors

Methods

getOnlineUsers getState getUserChannels removeState setState whereNow whoNow

Constructors

constructor

new IRtmPresence(): IRtmPresence
Returns IRtmPresence

Methods

`Abstract` getOnlineUsers

getOnlineUsers(channelName, channelType, options, requestId?): number
To query who joined this channel
Parameters
- channelName: string
- channelType: RTM_CHANNEL_TYPE
- options: GetOnlineUsersOptions
- Optional requestId: number
Returns number
- 0: Success.
- < 0: Failure.
- Defined in IAgoraRtmPresence.ts:109

`Abstract` getState

getState(channelName, channelType, userId, requestId?): number
Get user state
Parameters
- channelName: string
- channelType: RTM_CHANNEL_TYPE
- userId: string
- Optional requestId: number
Returns number
- 0: Success.
- < 0: Failure.
- Defined in IAgoraRtmPresence.ts:92

`Abstract` getUserChannels

getUserChannels(userId, requestId?): number
To query which channels the user joined
Parameters
- userId: string
- Optional requestId: number
Returns number
- 0: Success.
- < 0: Failure.
- Defined in IAgoraRtmPresence.ts:124

`Abstract` removeState

removeState(channelName, channelType, keys, count, requestId?): number
Delete user state
Parameters
- channelName: string
- channelType: RTM_CHANNEL_TYPE
- keys: string[]
- count: number
- Optional requestId: number
Returns number
- 0: Success.
- < 0: Failure.
- Defined in IAgoraRtmPresence.ts:74

`Abstract` setState

setState(channelName, channelType, items, count, requestId?): number
Set user state
Parameters
- channelName: string
- channelType: RTM_CHANNEL_TYPE
- items: StateItem[]
- count: number
- Optional requestId: number
Returns number
- 0: Success.
- < 0: Failure.
- Defined in IAgoraRtmPresence.ts:55

`Abstract` whereNow

whereNow(userId, requestId?): number
To query which channels the user joined
Parameters
- userId: string
- Optional requestId: number
Returns number
- 0: Success.
- < 0: Failure.
- Defined in IAgoraRtmPresence.ts:42

`Abstract` whoNow

whoNow(channelName, channelType, options, requestId?): number
To query who joined this channel
Parameters
- channelName: string
- channelType: RTM_CHANNEL_TYPE
- options: PresenceOptions
- Optional requestId: number
Returns number
- 0: Success.
- < 0: Failure.
- Defined in IAgoraRtmPresence.ts:27