Type alias MessageFilter

MessageFilter: {
    clientId: string;
    isRef?: boolean;
    name?: string;
    refTimeserial?: string;
    refType?: string;
}

Contains properties to filter messages with when calling RealtimeChannel.subscribe().

Type declaration

  • clientId: string

    Filters messages by a specific message clientId.

  • Optional isRef?: boolean

    Filters messages based on whether they contain an extras.ref.

  • Optional name?: string

    Filters messages by a specific message name.

  • Optional refTimeserial?: string

    Filters messages by a specific extras.ref.timeserial value.

  • Optional refType?: string

    Filters messages by a specific extras.ref.type value.

Generated using TypeDoc