ActionsPlugin

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

Extends

• Plugin<Application, IActionsPluginOptions>

Implements

• IActionsPlugin

Constructors

new ActionsPlugin()

new ActionsPlugin(id): ActionsPlugin

Defined in: plugins/Plugin.ts:48

Parameters

id

string = 'Plugin'

Returns

ActionsPlugin

Inherited from

Plugin.constructor

Properties

__dill_pixel_method_binding_root

__dill_pixel_method_binding_root: boolean

Defined in: plugins/Plugin.ts:39

Inherited from

Plugin.__dill_pixel_method_binding_root

---

id

readonly id: "actions" = 'actions'

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

Implementation of

IActionsPlugin.id

Overrides

Plugin.id

---

onActionContextChanged

onActionContextChanged: Signal<(context) => void>

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

Implementation of

IActionsPlugin.onActionContextChanged

Accessors

app

Get Signature

get app(): A

Defined in: plugins/Plugin.ts:53

Returns

A

Implementation of

IActionsPlugin.app

Inherited from

Plugin.app

---

context

Get Signature

get context(): string | string & object

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

Returns

string | string & object

Set Signature

set context(context): void

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

Parameters

context

string | string & object

Returns

void

Implementation of

IActionsPlugin.context

---

debug

Get Signature

get debug(): boolean

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

Returns

boolean

Set Signature

set debug(debug): void

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

Parameters

debug

boolean

Returns

void

Implementation of

IActionsPlugin.debug

---

options

Get Signature

get options(): O

Defined in: plugins/Plugin.ts:44

Returns

O

Implementation of

IActionsPlugin.options

Inherited from

Plugin.options

Methods

addSignalConnection()

addSignalConnection(…args): void

Defined in: plugins/Plugin.ts:79

Add signal connections to the container.

Parameters

args

…SignalConnection[]

The signal connections to add.

Returns

void

Implementation of

IActionsPlugin.addSignalConnection

Inherited from

Plugin.addSignalConnection

---

clearSignalConnections()

clearSignalConnections(): void

Defined in: plugins/Plugin.ts:85

Returns

void

Implementation of

IActionsPlugin.clearSignalConnections

Inherited from

Plugin.clearSignalConnections

---

destroy()

destroy(): void

Defined in: plugins/Plugin.ts:57

Returns

void

Implementation of

IActionsPlugin.destroy

Inherited from

Plugin.destroy

---

getAction()

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

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

Type Parameters

• TActionData = any

Parameters

action

Action

Returns

ActionSignal<TActionData>

Implementation of

IActionsPlugin.getAction

---

getActions()

getActions(): ActionMap

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

Returns

ActionMap

Implementation of

IActionsPlugin.getActions

---

initialize()

initialize(_options, app): void

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

Parameters

_options

Partial<IActionsPluginOptions>

app

IApplication

Returns

void

Implementation of

IActionsPlugin.initialize

Overrides

Plugin.initialize

---

postInitialize()

postInitialize(_app): void | Promise<void>

Defined in: plugins/Plugin.ts:68

Parameters

_app

IApplication

Returns

void | Promise<void>

Implementation of

IActionsPlugin.postInitialize

Inherited from

Plugin.postInitialize

---

sendAction()

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

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

Type Parameters

• TActionData = any

Parameters

actionId

Action

data?

TActionData

Returns

void

Implementation of

IActionsPlugin.sendAction

---

setActionContext()

setActionContext(context): string

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

Parameters

context

string | string & object

Returns

string

Implementation of

IActionsPlugin.setActionContext