Class RTMStorage`Abstract`

Hierarchy

RTMStorage

Index

Constructors

Methods

getChannelMetadata getUserMetadata removeChannelMetadata removeUserMetadata setChannelMetadata setUserMetadata subscribeUserMetadata unsubscribeUserMetadata updateChannelMetadata updateUserMetadata

Constructors

constructor

new RTMStorage(): RTMStorage
Returns RTMStorage

Methods

`Abstract` getChannelMetadata

getChannelMetadata(channelName, channelType): Promise<GetChannelMetadataResponse>
Parameters
- channelName: string
- channelType: RtmChannelType
Returns Promise<GetChannelMetadataResponse>
- Defined in api/RTMStorage.ts:67

`Abstract` getUserMetadata

getUserMetadata(options?): Promise<GetUserMetadataResponse>
Parameters
- Optional options: GetUserMetadataOptions
Returns Promise<GetUserMetadataResponse>
- Defined in api/RTMStorage.ts:86

`Abstract` removeChannelMetadata

removeChannelMetadata(channelName, channelType, options?): Promise<ChannelMetadataOperationResponse>
Parameters
- channelName: string
- channelType: RtmChannelType
- Optional options: RemoveChannelMetadataOptions
Returns Promise<ChannelMetadataOperationResponse>
- Defined in api/RTMStorage.ts:71

`Abstract` removeUserMetadata

removeUserMetadata(options?): Promise<UserMetadataOperationResponse>
Parameters
- Optional options: RemoveUserMetadataOptions
Returns Promise<UserMetadataOperationResponse>
- Defined in api/RTMStorage.ts:89

`Abstract` setChannelMetadata

setChannelMetadata(channelName, channelType, data, options?): Promise<ChannelMetadataOperationResponse>
Parameters
- channelName: string
- channelType: RtmChannelType
- data: Metadata
- Optional options: IMetadataOptions
Returns Promise<ChannelMetadataOperationResponse>
- Defined in api/RTMStorage.ts:61

`Abstract` setUserMetadata

setUserMetadata(data, options?): Promise<UserMetadataOperationResponse>
Parameters
- data: Metadata
- Optional options: SetOrUpdateUserMetadataOptions
Returns Promise<UserMetadataOperationResponse>
- Defined in api/RTMStorage.ts:82

`Abstract` subscribeUserMetadata

subscribeUserMetadata(userId): Promise<UserMetadataOperationResponse>
Parameters
- userId: string
Returns Promise<UserMetadataOperationResponse>
- Defined in api/RTMStorage.ts:96

`Abstract` unsubscribeUserMetadata

unsubscribeUserMetadata(userId): Promise<UserMetadataOperationResponse>
Parameters
- userId: string
Returns Promise<UserMetadataOperationResponse>
- Defined in api/RTMStorage.ts:99

`Abstract` updateChannelMetadata

updateChannelMetadata(channelName, channelType, data, options?): Promise<ChannelMetadataOperationResponse>
Parameters
- channelName: string
- channelType: RtmChannelType
- data: Metadata
- Optional options: IMetadataOptions
Returns Promise<ChannelMetadataOperationResponse>
- Defined in api/RTMStorage.ts:76

`Abstract` updateUserMetadata

updateUserMetadata(data, options?): Promise<UserMetadataOperationResponse>
Parameters
- data: Metadata
- Optional options: SetOrUpdateUserMetadataOptions
Returns Promise<UserMetadataOperationResponse>
- Defined in api/RTMStorage.ts:92