Class RTMPresence`Abstract`

Hierarchy

RTMPresence

Index

Constructors

Methods

getOnlineUsers getState getUserChannels removeState setState whereNow whoNow

Constructors

constructor

new RTMPresence(): RTMPresence
Returns RTMPresence

Methods

`Abstract` getOnlineUsers

getOnlineUsers(channelName, channelType, options?): Promise<WhoNowResponse>
Parameters
- channelName: string
- channelType: RtmChannelType
- Optional options: PresenceOptions
Returns Promise<WhoNowResponse>
- Defined in api/RTMPresence.ts:40

`Abstract` getState

getState(userId, channelName, channelType): Promise<GetStateResponse>
Parameters
- userId: string
- channelName: string
- channelType: RtmChannelType
Returns Promise<GetStateResponse>
- Defined in api/RTMPresence.ts:55

`Abstract` getUserChannels

getUserChannels(userId): Promise<WhereNowResponse>
Parameters
- userId: string
Returns Promise<WhereNowResponse>
- Defined in api/RTMPresence.ts:47

`Abstract` removeState

removeState(channelName, channelType, options?): Promise<BaseResponse>
Parameters
- channelName: string
- channelType: RtmChannelType
- Optional options: RemoveStateOptions
Returns Promise<BaseResponse>
- Defined in api/RTMPresence.ts:61

`Abstract` setState

setState(channelName, channelType, state): Promise<BaseResponse>
Parameters
- channelName: string
- channelType: RtmChannelType
- state: StateItem
Returns Promise<BaseResponse>
- Defined in api/RTMPresence.ts:49

`Abstract` whereNow

whereNow(userId): Promise<WhereNowResponse>
Parameters
- userId: string
Returns Promise<WhereNowResponse>
- Defined in api/RTMPresence.ts:46

`Abstract` whoNow

whoNow(channelName, channelType, options?): Promise<WhoNowResponse>
Parameters
- channelName: string
- channelType: RtmChannelType
- Optional options: PresenceOptions
Returns Promise<WhoNowResponse>
- Defined in api/RTMPresence.ts:35