Options
All
  • Public
  • Public/Protected
  • All
Menu

Broadcasts live share events to all clients and can be received by an LiveEventTarget.

remarks

Live objects won't typically create an LiveEventSource directly. They will, instead, create an LiveEventTarget class, which can both send & receive events.

Type Parameters

Hierarchy

Index

Constructors

Methods

Constructors

Methods

  • sendEvent(evt?: Partial<TEvent>): TEvent
  • Broadcasts an event to any listening LiveEventTarget instances.

    Parameters

    • evt: Partial<TEvent> = {}

      Optional. Partial event object to send. The ILiveEvent.name, ILiveEvent.timestamp, and ILiveEvent.clientId fields will be automatically populated prior to sending.

    Returns TEvent

    The full event, including ILiveEvent.name, ILiveEvent.timestamp, and ILiveEvent.clientId fields if known.

Generated using TypeDoc