Class IRtmStorage`Abstract`

Hierarchy

IRtmStorage

Index

Constructors

Methods

createMetadata getChannelMetadata getUserMetadata removeChannelMetadata removeUserMetadata setChannelMetadata setUserMetadata subscribeUserMetadata unsubscribeUserMetadata updateChannelMetadata updateUserMetadata

Constructors

constructor

new IRtmStorage(): IRtmStorage
Returns IRtmStorage

Methods

`Abstract` createMetadata

createMetadata(): RtmMetadata
Creates the metadata object and returns the pointer. *

Returns RtmMetadata
Pointer of the metadata object.
- Defined in IAgoraRtmStorage.ts:66

`Abstract` getChannelMetadata

getChannelMetadata(channelName, channelType, requestId?): number
Get the metadata of a specified channel.
Parameters
- channelName: string
- channelType: RTM_CHANNEL_TYPE
- Optional requestId: number
  
  The unique ID of this request.
Returns number
- 0: Success.
- < 0: Failure.
- Defined in IAgoraRtmStorage.ts:144

`Abstract` getUserMetadata

getUserMetadata(userId, requestId?): number
Get the metadata of a specified user.
Parameters
- userId: string
- Optional requestId: number
Returns number
- 0: Success.
- < 0: Failure.
- Defined in IAgoraRtmStorage.ts:213

`Abstract` removeChannelMetadata

removeChannelMetadata(channelName, channelType, data, options, lockName, requestId?): number
Remove the metadata of a specified channel.
Parameters
- channelName: string
- channelType: RTM_CHANNEL_TYPE
- data: RtmMetadata
- options: MetadataOptions
- lockName: string
- Optional requestId: number
Returns number
- 0: Success.
- < 0: Failure.
- Defined in IAgoraRtmStorage.ts:125

`Abstract` removeUserMetadata

removeUserMetadata(userId, data, options, requestId?): number
Remove the metadata of a specified user.
Parameters
- userId: string
- data: RtmMetadata
- options: MetadataOptions
- Optional requestId: number
Returns number
- 0: Success.
- < 0: Failure.
- Defined in IAgoraRtmStorage.ts:197

`Abstract` setChannelMetadata

setChannelMetadata(channelName, channelType, data, options, lockName, requestId?): number
Set the metadata of a specified channel.
Parameters
- channelName: string
- channelType: RTM_CHANNEL_TYPE
- data: RtmMetadata
- options: MetadataOptions
- lockName: string
- Optional requestId: number
Returns number
- 0: Success.
- < 0: Failure.
- Defined in IAgoraRtmStorage.ts:81

`Abstract` setUserMetadata

setUserMetadata(userId, data, options, requestId?): number
Set the metadata of a specified user.
Parameters
- userId: string
- data: RtmMetadata
- options: MetadataOptions
- Optional requestId: number
Returns number
- 0: Success.
- < 0: Failure.
- Defined in IAgoraRtmStorage.ts:161

`Abstract` subscribeUserMetadata

subscribeUserMetadata(userId, requestId?): number
Subscribe the metadata update event of a specified user.
Parameters
- userId: string
- Optional requestId: number
Returns number
- 0: Success.
- < 0: Failure.
- Defined in IAgoraRtmStorage.ts:223

`Abstract` unsubscribeUserMetadata

unsubscribeUserMetadata(userId): number
unsubscribe the metadata update event of a specified user.
Parameters
- userId: string
Returns number
- 0: Success.
- < 0: Failure.
- Defined in IAgoraRtmStorage.ts:233

`Abstract` updateChannelMetadata

updateChannelMetadata(channelName, channelType, data, options, lockName, requestId?): number
Update the metadata of a specified channel.
Parameters
- channelName: string
- channelType: RTM_CHANNEL_TYPE
- data: RtmMetadata
- options: MetadataOptions
- lockName: string
- Optional requestId: number
Returns number
- 0: Success.
- < 0: Failure.
- Defined in IAgoraRtmStorage.ts:103

`Abstract` updateUserMetadata

updateUserMetadata(userId, data, options, requestId?): number
Update the metadata of a specified user.
Parameters
- userId: string
- data: RtmMetadata
- options: MetadataOptions
- Optional requestId: number
Returns number
- 0: Success.
- < 0: Failure.
- Defined in IAgoraRtmStorage.ts:179