Interface RealtimeChannelEventSpec

An event a channel streams back (state changes, user actions).

interface RealtimeChannelEventSpec {
    Description: string;
    Name: string;
    PayloadSchema?: JSONObject;
}

Properties

Description: string

When it fires and what it means, for the model.

Name: string

Event name (e.g. 'state_changed', 'cell_filled').

PayloadSchema?: JSONObject

JSON Schema of the event payload.