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 a Channel or RealtimeChannel object, deleting it, and enabling it to be garbage collected. To release a channel, the ChannelState must be INITIALIZED, DETACHED, or FAILED.

  Parameters

  • name: string

    The channel name.

  Returns void