Interface: Runtime

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:

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:

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:

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:

Modules

Return to the Guides Index.