Interface ChannelStateChange

Contains state change information emitted by ChannelBase and RealtimeChannelBase objects.

Hierarchy

  • ChannelStateChange

Properties

current: ChannelState

The new current ChannelState.

hasBacklog?: boolean

Indicates whether the client can expect a backlog of messages from a rewind or resume.

previous: ChannelState

The previous state. For the UPDATE event, this is equal to the current ChannelState.

reason?: Types.ErrorInfo

An ErrorInfo object containing any information relating to the transition.

resumed: boolean

Indicates whether message continuity on this channel is preserved, see Nonfatal channel errors for more info.

Generated using TypeDoc