Class Action`Abstract`

Hierarchy (View Summary)

Action
- ActionFunction
- ActionGoto

Index

Constructors

Methods

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

Properties

name type plugin? index? parents global styles labels

Constructors

constructor

new Action(data: ActionJson): Action
Creates a new Action instance from JSON data. Initializes styles and labels; concrete subclasses handle type-specific logic.
Parameters
- data: ActionJson
  Action JSON including name, type, plugin, index, parents, styles, and labels.
Returns Action
- Defined in actions/action.ts:30

Methods

getName

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

Returns string
- Defined in actions/action.ts:46

getType

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

Returns "function" | "goto"
- 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
- 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
- Defined in actions/action.ts:64

getIndex

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

Returns number | undefined
- 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
- Defined in actions/action.ts:78

getParents

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

Returns string[]
- 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
- 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
- Defined in actions/action.ts:100

isGlobal

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

Returns boolean
- Defined in actions/action.ts:106

getStyles

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

Returns ActionStyles
- 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
- 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
- Defined in actions/action.ts:120

getLabels

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

Returns ActionLabels
- 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
- 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
- Defined in actions/action.ts:136

toJson

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

Returns ActionJson
- Defined in actions/action.ts:143

`Abstract`run

run(): Promise<unknown>
Executes the action logic. Implemented by each concrete subclass.

Returns Promise<unknown>
- Defined in actions/action.ts:159

Properties

`Protected`name

name: string

`Protected` `Abstract`type

type: "function" | "goto"

`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