Creates a Nucleus Action.

name: String , Creates a Nucleus Action. originalMessage: Object , Creates a Nucleus Action. originUserID: String , Creates a Nucleus Action. CompletedActionStatus: , Creates a Nucleus Action. FailedActionStatus: , Creates a Nucleus Action. PendingActionStatus: , Creates a Nucleus Action. ProcessingActionStatus: , Creates a Nucleus Action. NucleusActionStatusWeightList: , Creates a Nucleus Action.

Updates the Nucleus Action final message.

Parameters

actionMessage: Object, Updates the Nucleus Action final message.

Updates the Nucleus Action status.

Parameters

actionStatus: String, Updates the Nucleus Action status.

Example:

$action.updateStatus(NucleusAction.CompletedActionStatus);

Author: Sebastien Filion

Overview: Define the Nucleus Action class that is used to create an action.

NucleusAction

name : String

originalMessage : Object

originUserID : String

NucleusAction

Kind: global class

• NucleusAction
  • new NucleusAction(actionName, actionMessage, [options])
  • instance
    • .updateMessage(actionMessage)
    • .updateStatus(actionStatus)
  • static
    • .CompletedActionStatus
    • .FailedActionStatus
    • .PendingActionStatus
    • .ProcessingActionStatus
    • .NucleusActionStatusWeightList

Creates a Nucleus Action.

Throws:

• Will throw an error if the action name is missing or an empty string.

Example

const $action = new NucleusAction(actionName, actionMessage, options);
const $action = new NucleusAction({ meta: { ... }, name: actionName, originalMessage: actionMessage,... });

Updates the Nucleus Action final message.

Kind: instance method of NucleusAction
Throws:

• Will throw an error if the action message is not an object.

Updates the Nucleus Action status.

Kind: instance method of NucleusAction

Example

$action.updateStatus(NucleusAction.CompletedActionStatus);

Kind: static property of NucleusAction

Kind: static property of NucleusAction

Kind: static property of NucleusAction

Kind: static property of NucleusAction

Kind: static property of NucleusAction

Kind: global variable

Kind: global variable

Kind: global variable

The list of available action status.

Kind: global enum

Kind: global typedef
Properties

• NucleusAction
  • new NucleusAction(actionName, actionMessage, [options])
  • instance
    • .updateMessage(actionMessage)
    • .updateStatus(actionStatus)
  • static
    • .CompletedActionStatus
    • .FailedActionStatus
    • .PendingActionStatus
    • .ProcessingActionStatus
    • .NucleusActionStatusWeightList

Creates a Nucleus Action.

Throws:

• Will throw an error if the action name is missing or an empty string.

Example

const $action = new NucleusAction(actionName, actionMessage, options);
const $action = new NucleusAction({ meta: { ... }, name: actionName, originalMessage: actionMessage,... });

Updates the Nucleus Action final message.

Kind: instance method of NucleusAction
Throws:

• Will throw an error if the action message is not an object.

Updates the Nucleus Action status.

Kind: instance method of NucleusAction

Example

$action.updateStatus(NucleusAction.CompletedActionStatus);

Kind: static property of NucleusAction

Kind: static property of NucleusAction

Kind: static property of NucleusAction

Kind: static property of NucleusAction

Kind: static property of NucleusAction