Class SdkEventBus

Event bus for SDK events. For the list of events and their payload check SdkEvents.

Index

Methods

clear off on once stopDataModelEventsTracking stopLayerEventsTracking trackDataModelEvents trackLayerEvents

Methods

clear

clear(): void
Unregister all event handlers at once.

Returns void

off

off<EventName extends keyof SdkEvents>(
    args: {
        eventHandler: EventHandler<SdkEvents[EventName]>;
        eventName: EventName;
    },
): void
Unregister a callback from the event.
Type Parameters
- EventName extends keyof SdkEvents
Parameters
- args: { eventHandler: EventHandler<SdkEvents[EventName]>; eventName: EventName }
  - eventHandler: EventHandler<SdkEvents[EventName]>
    A callback to be unregistered.
  - eventName: EventName
    A name of the event.
Returns void
Throws
InvalidStateError if the callback wasn't registered or already unregistered.

on

on<EventName extends keyof SdkEvents>(
    args: {
        eventHandler: EventHandler<SdkEvents[EventName]>;
        eventName: EventName;
    },
): () => void
Register a callback for an event.
Type Parameters
- EventName extends keyof SdkEvents
Parameters
- args: { eventHandler: EventHandler<SdkEvents[EventName]>; eventName: EventName }
  - eventHandler: EventHandler<SdkEvents[EventName]>
    A callback to be executed when the event happens.
  - eventName: EventName
    A name of the event.
Returns () => void
a cleanup function that will unregister the handler from the event.

once

once<EventName extends keyof SdkEvents>(
args: { eventName: EventName },
): Promise<SdkEvents[EventName]>
Wait for the next occurrence of the event.
Type Parameters
- EventName extends keyof SdkEvents
Parameters
- args: { eventName: EventName }
  - eventName: EventName
    A name of the event to wait for.
Returns Promise<SdkEvents[EventName]>
a promise that gets resolved once the event happens.

stopDataModelEventsTracking

stopDataModelEventsTracking(args: { dataModelName: DataModelName }): void
Stop tracking events of a data model.
Parameters
- args: { dataModelName: DataModelName }
  - dataModelName: DataModelName
    the name of the data model to stop tracking.
Returns void
Throws
InvalidStateError if a data model with provided dataModelName doesn't exist.

stopLayerEventsTracking

stopLayerEventsTracking(args: { layerName: string }): void
Stop tracking events of a layer.
Parameters
- args: { layerName: string }
  - layerName: string
    A name of a layer which events need to stop being tracked.
Returns void
Throws
InvalidStateError if a layer with provided layerName doesn't exist.

trackDataModelEvents

trackDataModelEvents(args: { dataModelName: DataModelName }): void
Start tracking events of a data model.
Parameters
- args: { dataModelName: DataModelName }
  - dataModelName: DataModelName
    the name of the data model to track.
Returns void
Throws
InvalidStateError if a data model with provided dataModelName doesn't exist.

trackLayerEvents

trackLayerEvents(args: { layerName: string }): void
Start tracking events of a layer.
Parameters
- args: { layerName: string }
  - layerName: string
    A name of a layer which events need to be tracked.
Returns void
Throws
InvalidStateError if a layer with provided layerName doesn't exist.

Class SdkEventBus

Index

Methods

Methods

clear

Returns void

off

Type Parameters

Parameters

eventHandler: EventHandler<SdkEvents[EventName]>

eventName: EventName

Returns void

Throws

on

Type Parameters

Parameters

eventHandler: EventHandler<SdkEvents[EventName]>

eventName: EventName

Returns () => void

once

Type Parameters

Parameters

eventName: EventName

Returns Promise<SdkEvents[EventName]>

stopDataModelEventsTracking

Parameters

dataModelName: DataModelName

Returns void

Throws

stopLayerEventsTracking

Parameters

layerName: string

Returns void

Throws

trackDataModelEvents

Parameters

dataModelName: DataModelName

Returns void

Throws

trackLayerEvents

Parameters

layerName: string

Returns void

Throws

Settings

On This Page