Class RTMClientAbstract

constructor

• new RTMClient(): RTMClient

• Returns RTMClient

Abstract history

Abstract lock

Abstract presence

Abstract storage

Abstract addEventListener

• addEventListener<EventType>(eventType, listener): void

• Type Parameters

  • EventType extends keyof RTMClientEventMap

  Parameters

  • eventType: EventType

  • listener: RTMClientEventMap[EventType]

  Returns void

Abstract createStreamChannel

• createStreamChannel(channelName): Promise<RTMStreamChannel>

• Parameters

  • channelName: string

  Returns Promise<RTMStreamChannel>

Abstract login

• login(options?): Promise<BaseResponse>

• Parameters

  • Optional options: LoginOptions

  Returns Promise<BaseResponse>

Abstract logout

• logout(): Promise<BaseResponse>

• Returns Promise<BaseResponse>

Abstract publish

• publish(channelName, message, options?): Promise<RTMOperationResponse>

• Parameters

  • channelName: string

  • message: string | Uint8Array

  • Optional options: PublishOptions

  Returns Promise<RTMOperationResponse>

Abstract release

• release(): number

• Returns number

Abstract removeAllListeners

• removeAllListeners<EventType>(eventType?): void

• Type Parameters

  • EventType extends keyof RTMClientEventMap

  Parameters

  • Optional eventType: EventType

  Returns void

Abstract removeEventListener

• removeEventListener<EventType>(eventType, listener?): void

• Type Parameters

  • EventType extends keyof RTMClientEventMap

  Parameters

  • eventType: EventType

  • Optional listener: RTMClientEventMap[EventType]

  Returns void

Abstract renewToken

• renewToken(token, options?): Promise<BaseResponse>

• Parameters

  • token: string

  • Optional options: RenewTokenOptions

  Returns Promise<BaseResponse>

Abstract subscribe

• subscribe(channelName, options?): Promise<RTMOperationResponse>

• Parameters

  • channelName: string

  • Optional options: SubscribeOptions

  Returns Promise<RTMOperationResponse>

Abstract unsubscribe

• unsubscribe(channelName): Promise<RTMOperationResponse>

• Parameters

  • channelName: string

  Returns Promise<RTMOperationResponse>