Interface DeckRealtimeEvent

One event from flarum/realtime, after Deck has put its payload in the store.

interface DeckRealtimeEvent {
    discussion: Discussion | null;
    model: Model | null;
    name: string;
    payload: any;
    post: Post | null;
}

Properties

discussion: Discussion | null

The discussion the event concerns, if any.

model: Model | null

The payload's main model, from the store. For post events this is the discussion.

name: string

As broadcast, e.g. Flarum\\Post\\Event\\Posted, revisedEvent, notification.

payload: any

The JSON:API document the event carried.

post: Post | null

For post events (new replies, edits, likes), the post itself.