Edit in GitHubLog an issue

Interface: Runtime <T>

Defines the runtime object providing all unified-shell APIs for solution authors.

Type parameters#

T

Hierarchy#

  • EventEmitter

    Runtime

Index#

EventEmitter Methods#

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:

NameTypeDescription
typeKThe event type to invoke.
event?T[K]Any value (object is recommended and powerful), passed to each handler.

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:

NameType
event?T[K]

Returns: void


on#

on<K>(type: K, handler: function): void

Inherited from void

Register 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:

NameType
event?T[K]

Returns: void

  • Privacy
  • Terms of Use
  • Do not sell my personal information
  • AdChoices
Copyright © 2022 Adobe. All rights reserved.