Class JoinChannelOptions

Join channel options.

Hierarchy

JoinChannelOptions

Index

Constructors

Properties

token? withLock? withMetadata? withPresence?

Constructors

constructor

new JoinChannelOptions(props?): JoinChannelOptions
Parameters
- Optional props: Partial<{
      token?: string;
      withLock?: boolean;
      withMetadata?: boolean;
      withPresence?: boolean;
  }>
Returns JoinChannelOptions
- Defined in IAgoraStreamChannel.ts:61

Properties

`Optional` token

token?: string

Token used to join channel.

`Optional` withLock

withLock?: boolean = false

Whether to subscribe channel with lock

`Optional` withMetadata

withMetadata?: boolean = false

Whether to subscribe channel metadata information

`Optional` withPresence

withPresence?: boolean = true

Whether to subscribe channel with user presence