IActionsPlugin

Defined in: plugins/actions/ActionsPlugin.ts:8

Extends

• IPlugin

Type Parameters

• C extends ActionContext = ActionContext

Properties

app

app: IApplication

Defined in: plugins/Plugin.ts:10

Inherited from

IPlugin.app

---

context

context: C

Defined in: plugins/actions/ActionsPlugin.ts:9

---

debug

debug: boolean

Defined in: plugins/actions/ActionsPlugin.ts:16

---

id

id: string

Defined in: plugins/Plugin.ts:8

Inherited from

IPlugin.id

---

onActionContextChanged

onActionContextChanged: Signal<(context) => void>

Defined in: plugins/actions/ActionsPlugin.ts:10

---

options

readonly options: Partial<any>

Defined in: plugins/Plugin.ts:12

Inherited from

IPlugin.options

Methods

addSignalConnection()

addSignalConnection(…args): void

Defined in: plugins/Plugin.ts:20

Parameters

args

…SignalConnection[]

Returns

void

Inherited from

IPlugin.addSignalConnection

---

clearSignalConnections()

clearSignalConnections(): void

Defined in: plugins/Plugin.ts:22

Returns

void

Inherited from

IPlugin.clearSignalConnections

---

destroy()

destroy(): void

Defined in: plugins/Plugin.ts:18

Returns

void

Inherited from

IPlugin.destroy

---

getAction()

getAction<TActionData>(action): ActionSignal<TActionData>

Defined in: plugins/actions/ActionsPlugin.ts:12

Type Parameters

• TActionData = any

Parameters

action

Action

Returns

ActionSignal<TActionData>

---

getActions()

getActions(): ActionMap

Defined in: plugins/actions/ActionsPlugin.ts:13

Returns

ActionMap

---

initialize()

initialize(options, app): void

Defined in: plugins/actions/ActionsPlugin.ts:11

Parameters

options

Partial<IActionsPluginOptions>

app

IApplication

Returns

void

Overrides

IPlugin.initialize

---

postInitialize()

postInitialize(_app): void | Promise<void>

Defined in: plugins/Plugin.ts:16

Parameters

_app

IApplication

Returns

void | Promise<void>

Inherited from

IPlugin.postInitialize

---

registerCoreFunctions()

registerCoreFunctions(): void

Defined in: plugins/Plugin.ts:24

Returns

void

Inherited from

IPlugin.registerCoreFunctions

---

registerCoreSignals()

registerCoreSignals(): void

Defined in: plugins/Plugin.ts:26

Returns

void

Inherited from

IPlugin.registerCoreSignals

---

sendAction()

sendAction<TActionData>(actionId, data?): void

Defined in: plugins/actions/ActionsPlugin.ts:14

Type Parameters

• TActionData = any

Parameters

actionId

Action

data?

TActionData

Returns

void

---

setActionContext()

setActionContext(context): string

Defined in: plugins/actions/ActionsPlugin.ts:15

Parameters

context

C

Returns

string