Skip to main content

IAction

Interface

Properties

id

Readonly

An unique ID of an action item. Could be used to distinguish actions between each other.

Type

string


type

Readonly

Menu item type

Type

Action

Overrides

IMenuItem.type

Methods

destroy

Clean up (destroy) any subscriptions, intervals, or other resources that this IDestroyable instance has.

Signature

destroy() => void

Returns

void


execute

A method which will be called when an action should be executed (e.g. when a user clicks on the item)

Signature

execute() => void

Returns

void


getState

Signature

getState() => Readonly<ActionState>

Returns

Returns a state object of the action.

Readonly<ActionState>


onUpdate

Signature

onUpdate() => ISubscription<OnActionUpdateHandler>

Returns

A subscription for an event when an action is updated.

ISubscription<OnActionUpdateHandler>