Events Interface
Version 1.95.0
EventsInterface
A collection of methods for working with events.
events.publish
Broadcasts or sends an event.
| Param | Type | Description |
|---|---|---|
| eventName | string |
The name of the event. |
| [options] | object |
Configuration and payload. |
| [options.data] | any |
The payload of the event. It accepts basic data types only: plain objects, arrays, simple types. |
| [options.target] | object |
The UID of the recipient widget. If no target is provided the event will be broadcast. |
events.publishWhenWidgetsReady
Broadcasts an event to all widgets in the same tab as the sender. The method will ensure that all of the widgets are marked as ready to receive events before executing the broadcast.
| Param | Type | Description |
|---|---|---|
| eventName | string |
The name of the event. |
| [options] | object |
Configuration and payload. |
| [options.data] | any |
The payload of the event. It accepts basic data types only: plain objects, arrays, simple types. |
events.unsubscribeAll
Unsubscribes the widget from all event subscriptions.