Interface ChannelStateChange

Contains state change information emitted by Channel and RealtimeChannel objects.

interface ChannelStateChange {
    current: ChannelState;
    hasBacklog?: boolean;
    previous: ChannelState;
    reason?: ErrorInfo;
    resumed: boolean;
}

Index

Properties

current hasBacklog? previous reason? resumed

Properties

current

current: ChannelState

The new current ChannelState.

`Optional`hasBacklog

hasBacklog?: boolean

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

previous

previous: ChannelState

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

`Optional`reason

reason?: ErrorInfo

An ErrorInfo object containing any information relating to the transition.

resumed

resumed: boolean

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