Class SubscribeOptions

The subscribe option.

Hierarchy

SubscribeOptions

Index

Constructors

Properties

withLock? withMessage? withMetadata? withPresence?

Constructors

constructor

new SubscribeOptions(props?): SubscribeOptions
Parameters
- Optional props: Partial<{
      withLock?: boolean;
      withMessage?: boolean;
      withMetadata?: boolean;
      withPresence?: boolean;
  }>
Returns SubscribeOptions
- Defined in AgoraRtmBase.ts:1006

Properties

`Optional` withLock

withLock?: boolean = false

Whether to subscribe channel with lock

`Optional` withMessage

withMessage?: boolean = true

Whether to subscribe channel with message

`Optional` withMetadata

withMetadata?: boolean = false

Whether to subscribe channel with metadata

`Optional` withPresence

withPresence?: boolean = true

Whether to subscribe channel with user presence