Interface ChannelOptions

Passes additional properties to a Channel or RealtimeChannel object, such as encryption, ChannelMode and channel parameters.

Hierarchy

  • ChannelOptions

Properties

attachOnSubscribe?: boolean

A boolean which determines whether calling subscribe on a channel or presence object should trigger an implicit attach. Defaults to true

Note: this option is for realtime client libraries only

Requests encryption for this channel when not null, and specifies encryption-related parameters (such as algorithm, chaining mode, key length and key). See an example. When running in a browser, encryption is only available when the current environment is a secure context.

modes?: ChannelMode[]

An array of ChannelMode objects.

params?: ChannelParams

Channel Parameters that configure the behavior of the channel.

Generated using TypeDoc