Interface: Runtime <T>
Defines the runtime object providing all unified-shell APIs for solution authors.
Type parameters
▪ T
Hierarchy
EventEmitter
↳ Runtime
EventEmitter Methods
emit
▸ emit<K>(type: K, event?: T[K]): void
Inherited from void
Invoke all handlers for the given type.
Type parameters:
▪ K: keyof T
Parameters:
| Name | Type | Description |
|---|---|---|
type | K | The event type to invoke. |
event? | T[K] | Any value passed to each handler - object is recommended, and powerful |
Returns: void
off
▸ off<K>(type: K, handler: function): void
Inherited from void
Remove an event handler for the given type.
Type parameters:
▪ K: keyof T
Parameters:
▪ type: K
Type of event to unregister handler from.
▪ handler: function
Handler function to remove.
▸ (event?: T[K]): void
Parameters:
| Name | Type |
|---|---|
event? | T[K] |
Returns: void
on
▸ on<K>(type: K, handler: function): void
Inherited from void
Registers an event handler for the given type.
Type parameters:
▪ K: keyof T
Parameters:
▪ type: K
Type of event to listen for.
▪ handler: function
Function to call in response to given event.
▸ (event?: T[K]): void
Parameters:
| Name | Type |
|---|---|
event? | T[K] |
Returns: void
Next steps
Explore details of the Index, Page, TopBar, and User external modules.
Explore the attributes and behavior of Adobe Experience Cloud Interfaces:
| Page | Topbar | User |
|---|---|---|
` |
Return to the Guides Index.
