Class ActionFunction

Hierarchy (View Summary)

Action
- ActionFunction

Index

Constructors

Methods

getName getType getPlugin setPlugin getIndex setIndex getParents getParent addParent isGlobal getStyles setStyles getLabels setLabels getCallback setCallback toJson run

Properties

name plugin? index? parents global styles labels type callback

Constructors

constructor

new ActionFunction(data: ActionFunctionJson): ActionFunction
Creates a new function action that executes an async callback.
Parameters
- data: ActionFunctionJson
  Action JSON including name and callback function.
Returns ActionFunction
Overrides Action.constructor
- Defined in actions/function/index.ts:16

Methods

getName

getName(): string
Returns the action's unique name.

Returns string
Inherited from Action.getName
- Defined in actions/action.ts:46

getType

getType(): "function" | "goto"
Returns the action type: "function" or "goto".

Returns "function" | "goto"
Inherited from Action.getType
- Defined in actions/action.ts:51

getPlugin

getPlugin(): string | undefined
Returns the plugin namespace this action belongs to, or undefined for the default plugin.

Returns string | undefined
Inherited from Action.getPlugin
- Defined in actions/action.ts:56

setPlugin

setPlugin(plugin: string | undefined): this
Sets the plugin namespace for this action.
Parameters
- plugin: string | undefined
  Plugin name string.
Returns this
Inherited from Action.setPlugin
- Defined in actions/action.ts:64

getIndex

getIndex(): number | undefined
Returns the display order index, or undefined if not set.

Returns number | undefined
Inherited from Action.getIndex
- Defined in actions/action.ts:70

setIndex

setIndex(index: number | undefined): this
Sets the display order index.
Parameters
- index: number | undefined
  Numeric sort position.
Returns this
Inherited from Action.setIndex
- Defined in actions/action.ts:78

getParents

getParents(): string[]
Returns all registered parent names as a flat array.

Returns string[]
Inherited from Action.getParents
- Defined in actions/action.ts:84

getParent

getParent(name: string): string | undefined
Returns the parent entry matching the given name, or undefined.
Parameters
- name: string
  Parent name to look up.
Returns string | undefined
Inherited from Action.getParent
- Defined in actions/action.ts:92

addParent

addParent(name: string): this
Registers a parent menu name.
Parameters
- name: string
  Parent name to add.
Returns this
Inherited from Action.addParent
- Defined in actions/action.ts:100

isGlobal

isGlobal(): boolean
Returns true when this action is accessible from every menu.

Returns boolean
Inherited from Action.isGlobal
- Defined in actions/action.ts:106

getStyles

getStyles(): ActionStyles
Returns the styles container for this action.

Returns ActionStyles
Inherited from Action.getStyles
- Defined in actions/action.ts:111

setStyles

setStyles(styles: ActionStyles): this
Sets the styles for this action from an instance or a plain JSON object.
Parameters
- styles: ActionStyles
  ActionStyles instance or compatible JSON.
Returns this
Inherited from Action.setStyles
- Defined in actions/action.ts:119
setStyles(styles: ActionStylesJson): this
Sets the styles for this action from an instance or a plain JSON object.
Parameters
- styles: ActionStylesJson
  ActionStyles instance or compatible JSON.
Returns this
Inherited from Action.setStyles
- Defined in actions/action.ts:120

getLabels

getLabels(): ActionLabels
Returns the labels container for this action.

Returns ActionLabels
Inherited from Action.getLabels
- Defined in actions/action.ts:127

setLabels

setLabels(labels: ActionLabels): this
Sets the labels for this action from an instance or a plain JSON object.
Parameters
- labels: ActionLabels
  ActionLabels instance or compatible JSON.
Returns this
Inherited from Action.setLabels
- Defined in actions/action.ts:135
setLabels(labels: ActionLabelsJson): this
Sets the labels for this action from an instance or a plain JSON object.
Parameters
- labels: ActionLabelsJson
  ActionLabels instance or compatible JSON.
Returns this
Inherited from Action.setLabels
- Defined in actions/action.ts:136

getCallback

getCallback(): Promise<void>
Invokes and returns the result of the stored callback.

Returns Promise<void>
- Defined in actions/function/index.ts:22

setCallback

setCallback(callback: () => Promise<void>): this
Replaces the stored callback function.
Parameters
- callback: () => Promise<void>
  Async function executed when the action runs.
Returns this
- Defined in actions/function/index.ts:30

toJson

toJson(): ActionFunctionJson
Serialises this function action to a plain JSON-compatible object.

Returns ActionFunctionJson
Overrides Action.toJson
- Defined in actions/function/index.ts:36

run

run(): Promise<void>
Executes the action by invoking the stored async callback.

Returns Promise<void>
Overrides Action.run
- Defined in actions/function/index.ts:45

Properties

`Protected`name

name: string

`Protected` `Optional`plugin

plugin?: string

`Protected` `Optional`index

index?: number

`Protected`parents

parents: Record<string, Exclude<ActionJson["parents"], undefined>[number]> = {}

`Protected`global

global: boolean = false

`Protected`styles

styles: ActionStyles

`Protected`labels

labels: ActionLabels

`Protected`type

type: "function"

`Protected`callback

callback: () => Promise<void>