Interface Channels<T>

all

get

• get(name, channelOptions?): T

• Creates a new Channel or RealtimeChannel object, with the specified ChannelOptions, or returns the existing channel object.

  Parameters

  • name: string

    The channel name.

  • Optional channelOptions: ChannelOptions

    A ChannelOptions object.

  Returns T

  A Channel or RealtimeChannel object.

getDerived

• getDerived(name, deriveOptions, channelOptions?): T
• Experimental

  Creates a new Channel or RealtimeChannel object, with the specified channel DeriveOptions and ChannelOptions, or returns the existing channel object.

  This is a preview feature and may change in a future non-major release. This experimental method allows you to create custom realtime data feeds by selectively subscribing to receive only part of the data from the channel. See the announcement post for more information.

  Parameters

  • name: string

    The channel name.

  • deriveOptions: DeriveOptions

    A DeriveOptions object.

  • Optional channelOptions: ChannelOptions

    A ChannelOptions object.

  Returns T

  A RealtimeChannel object.

release

• release(name): void

• Releases all SDK-held references to a Channel or RealtimeChannel object, enabling it to be garbage collected. Warning: this method has no guardrails; using a channel reference after it has been released is undefined behaviour. It can be useful for applications that work with a continually changing set of channels on a single client and need to avoid unbounded memory growth; if this does not describe you, don't call it. Realtime channels not already in the INITIALIZED, DETACHED, or FAILED state are detached before release.

  Parameters

  • name: string

    The channel name.

  Returns void