Class RTMStreamChannel`Abstract`

Hierarchy

RTMStreamChannel

Index

Constructors

Methods

getSubscribedUserList join joinTopic leave leaveTopic publishTopicMessage release subscribeTopic unsubscribeTopic

Constructors

constructor

new RTMStreamChannel(): RTMStreamChannel
Returns RTMStreamChannel

Methods

`Abstract` getSubscribedUserList

getSubscribedUserList(topicName): Promise<GetSubscribedUserListResponse>
Parameters
- topicName: string
Returns Promise<GetSubscribedUserListResponse>
- Defined in api/RTMStreamChannel.ts:75

`Abstract` join

join(options?): Promise<JoinChannelResponse>
Parameters
- Optional options: JoinChannelOptions
Returns Promise<JoinChannelResponse>
- Defined in api/RTMStreamChannel.ts:55

`Abstract` joinTopic

joinTopic(topicName, options?): Promise<JoinTopicResponse>
Parameters
- topicName: string
- Optional options: JoinTopicOptions
Returns Promise<JoinTopicResponse>
- Defined in api/RTMStreamChannel.ts:57

`Abstract` leave

leave(): Promise<LeaveChannelResponse>
Returns Promise<LeaveChannelResponse>
- Defined in api/RTMStreamChannel.ts:56

`Abstract` leaveTopic

leaveTopic(topicName): Promise<LeaveTopicResponse>
Parameters
- topicName: string
Returns Promise<LeaveTopicResponse>
- Defined in api/RTMStreamChannel.ts:66

`Abstract` publishTopicMessage

publishTopicMessage(topicName, message, options?): Promise<PublishTopicMessageResponse>
Parameters
- topicName: string
- message: string | Uint8Array
- Optional options: TopicMessageOptions
Returns Promise<PublishTopicMessageResponse>
- Defined in api/RTMStreamChannel.ts:61

`Abstract` release

release(): number
Returns number
- Defined in api/RTMStreamChannel.ts:78

`Abstract` subscribeTopic

subscribeTopic(topicName, options?): Promise<SubscribeTopicResponse>
Parameters
- topicName: string
- Optional options: TopicOptions
Returns Promise<SubscribeTopicResponse>
- Defined in api/RTMStreamChannel.ts:67

`Abstract` unsubscribeTopic

unsubscribeTopic(topicName, options?): Promise<UnsubscribeTopicResponse>
Parameters
- topicName: string
- Optional options: TopicOptions
Returns Promise<UnsubscribeTopicResponse>
- Defined in api/RTMStreamChannel.ts:71