Class SubscribeOptions

The subscribe option.

Hierarchy

  • SubscribeOptions

Constructors

constructor

Properties

beQuiet? withLock? withMessage? withMetadata? withPresence?

Constructors

constructor

  • Parameters

    • Optional props: Partial<{
          beQuiet?: boolean;
          withLock?: boolean;
          withMessage?: boolean;
          withMetadata?: boolean;
          withPresence?: boolean;
      }>

    Returns SubscribeOptions

Properties

Optional beQuiet

beQuiet?: boolean = false

Whether to subscribe channel in quiet mode Quiet mode means remote user will not receive any notification when we subscribe or unsubscribe or change our presence state

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

Settings

Member Visibility

Theme

On This Page