Type alias CustomEvent

CustomEvent: {
    payload: string;
    scope: CustomEventScope;
    sequenceNumber: number;

Allows sending arbitrary data to other participants while in a Space, such as chat messages or custom interactions. Every event is visible to all participants in the space.

Type declaration

  • payload: string

    Arbitrary event payload that can be no bigger than 4096 bytes.

  • scope: CustomEventScope
  • sequenceNumber: number

    An autoincremented number generated by the server based on the order it received the custom event.

Generated using TypeDoc