Member Junction
    Preparing search index...

    Interface RealtimeChannelEvent

    One event a channel emitted on BaseRealtimeChannelClient.Events$.

    interface RealtimeChannelEvent {
        ChangeId?: number;
        Channel: string;
        Instance: string;
        Name: string;
        OccurredAt: number;
        Payload: JSONObject;
    }
    Index

    Properties

    ChangeId? Channel Instance Name OccurredAt Payload

    Properties

    ChangeId?: number

    The change id of the state change this event relates to, when it relates to one. A 'state_changed' event carries the id the change was assigned; a 'frame_pushed' event carries the id of the state its frame was captured at — so a consumer can check that the pixels and the state they are describing agree.

    Channel: string

    The emitting channel's key.

    Instance: string

    The emitting instance's id (see BaseRealtimeChannelClient.InstanceId).

    Name: string

    The event name (e.g. 'state_changed', 'opened', 'frame_pushed').

    OccurredAt: number

    When the event was emitted (epoch ms).

    Payload: JSONObject

    The event payload.

    Settings

    Member Visibility

    On This Page

    Properties