ActionsPlugin
Defined in: plugins/actions/ActionsPlugin.ts:22
Extends
Section titled “Extends”Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ActionsPlugin(
id):ActionsPlugin
Defined in: plugins/Plugin.ts:48
Parameters
Section titled “Parameters”string = 'Plugin'
Returns
Section titled “Returns”ActionsPlugin
Inherited from
Section titled “Inherited from”Properties
Section titled “Properties”
readonlyid:"actions"='actions'
Defined in: plugins/actions/ActionsPlugin.ts:23
Implementation of
Section titled “Implementation of”Overrides
Section titled “Overrides”onActionContextChanged
Section titled “onActionContextChanged”onActionContextChanged:
Signal<(context) =>void>
Defined in: plugins/actions/ActionsPlugin.ts:25
Implementation of
Section titled “Implementation of”IActionsPlugin.onActionContextChanged
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get app():
Application
Defined in: plugins/Plugin.ts:52
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”Inherited from
Section titled “Inherited from”context
Section titled “context”Get Signature
Section titled “Get Signature”get context():
string|string&object
Defined in: plugins/actions/ActionsPlugin.ts:42
Returns
Section titled “Returns”string | string & object
Set Signature
Section titled “Set Signature”set context(
context):void
Defined in: plugins/actions/ActionsPlugin.ts:46
Parameters
Section titled “Parameters”context
Section titled “context”string | string & object
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”Get Signature
Section titled “Get Signature”get debug():
boolean
Defined in: plugins/actions/ActionsPlugin.ts:37
Returns
Section titled “Returns”boolean
Set Signature
Section titled “Set Signature”set debug(
debug):void
Defined in: plugins/actions/ActionsPlugin.ts:34
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”options
Section titled “options”Get Signature
Section titled “Get Signature”get options():
O
Defined in: plugins/Plugin.ts:44
Returns
Section titled “Returns”O
Implementation of
Section titled “Implementation of”Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”addSignalConnection()
Section titled “addSignalConnection()”addSignalConnection(…
args):void
Defined in: plugins/Plugin.ts:78
Add signal connections to the container.
Parameters
Section titled “Parameters”…SignalConnection[]
The signal connections to add.
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”IActionsPlugin.addSignalConnection
Inherited from
Section titled “Inherited from”clearSignalConnections()
Section titled “clearSignalConnections()”clearSignalConnections():
void
Defined in: plugins/Plugin.ts:84
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”IActionsPlugin.clearSignalConnections
Inherited from
Section titled “Inherited from”destroy()
Section titled “destroy()”destroy():
void
Defined in: plugins/Plugin.ts:56
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”Inherited from
Section titled “Inherited from”getAction()
Section titled “getAction()”getAction<
TActionData>(action):ActionSignal<TActionData>
Defined in: plugins/actions/ActionsPlugin.ts:58
Type Parameters
Section titled “Type Parameters”TActionData
Section titled “TActionData”TActionData = any
Parameters
Section titled “Parameters”action
Section titled “action”Returns
Section titled “Returns”ActionSignal<TActionData>
Implementation of
Section titled “Implementation of”getActions()
Section titled “getActions()”getActions():
ActionMap
Defined in: plugins/actions/ActionsPlugin.ts:65
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”initialize()
Section titled “initialize()”initialize(
_options,app):void
Defined in: plugins/actions/ActionsPlugin.ts:54
Parameters
Section titled “Parameters”_options
Section titled “_options”Partial<IActionsPluginOptions>
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”Overrides
Section titled “Overrides”postInitialize()
Section titled “postInitialize()”postInitialize(
_app):void|Promise<void>
Defined in: plugins/Plugin.ts:67
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void | Promise<void>
Implementation of
Section titled “Implementation of”Inherited from
Section titled “Inherited from”sendAction()
Section titled “sendAction()”sendAction<
TActionData>(actionId,data?):void
Defined in: plugins/actions/ActionsPlugin.ts:69
Type Parameters
Section titled “Type Parameters”TActionData
Section titled “TActionData”TActionData = any
Parameters
Section titled “Parameters”actionId
Section titled “actionId”TActionData
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”setActionContext()
Section titled “setActionContext()”setActionContext(
context):string
Defined in: plugins/actions/ActionsPlugin.ts:94
Parameters
Section titled “Parameters”context
Section titled “context”string | string & object
Returns
Section titled “Returns”string