Action.nucleus

Global

---

Class: NucleusAction

Class: NucleusAction

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.

NucleusAction.updateMessage(actionMessage)

Updates the Nucleus Action final message.

Parameters

actionMessage: Object, Updates the Nucleus Action final message.

NucleusAction.updateStatus(actionStatus)

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.

Classes

NucleusAction

Members

name : String

originalMessage : Object

originUserID : String

Typedefs

NucleusAction

NucleusAction

Kind: global class

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

new NucleusAction(actionName, actionMessage, [options])

Creates a Nucleus Action.

Throws:

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

Param	Type
actionName	String
actionMessage	Object
[options]	Object
[options.originEngineID]	String
[options.originEngineName]	String
[options.originProcessID]	String
[options.originUserID]	String

Example

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

nucleusAction.updateMessage(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.

Param	Type
actionMessage	Object

nucleusAction.updateStatus(actionStatus)

Updates the Nucleus Action status.

Kind: instance method of NucleusAction

Param	Type
actionStatus	String

Example

$action.updateStatus(NucleusAction.CompletedActionStatus);

NucleusAction.CompletedActionStatus

Kind: static property of NucleusAction

NucleusAction.FailedActionStatus

Kind: static property of NucleusAction

NucleusAction.PendingActionStatus

Kind: static property of NucleusAction

NucleusAction.ProcessingActionStatus

Kind: static property of NucleusAction

NucleusAction.NucleusActionStatusWeightList

Kind: static property of NucleusAction

name : String

Kind: global variable

originalMessage : Object

Kind: global variable

originUserID : String

Kind: global variable

NucleusActionStatusWeightList : enum

The list of available action status.

Kind: global enum

NucleusAction

Kind: global typedef
Properties

Name	Type
ID	String
[finalMessage]	Object
meta	Object
meta.createdISOTime	String
[meta.modifiedISOTime]	String
meta.originEngineID	String
meta.originEngineName	String
meta.originProcessID	String
meta.originUserID	String
name	String
originalMessage	Object
originUserID	String
[status]	String

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

new NucleusAction(actionName, actionMessage, [options])

Creates a Nucleus Action.

Throws:

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

Param	Type
actionName	String
actionMessage	Object
[options]	Object
[options.originEngineID]	String
[options.originEngineName]	String
[options.originProcessID]	String
[options.originUserID]	String

Example

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

nucleusAction.updateMessage(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.

Param	Type
actionMessage	Object

nucleusAction.updateStatus(actionStatus)

Updates the Nucleus Action status.

Kind: instance method of NucleusAction

Param	Type
actionStatus	String

Example

$action.updateStatus(NucleusAction.CompletedActionStatus);

NucleusAction.CompletedActionStatus

Kind: static property of NucleusAction

NucleusAction.FailedActionStatus

Kind: static property of NucleusAction

NucleusAction.PendingActionStatus

Kind: static property of NucleusAction

NucleusAction.ProcessingActionStatus

Kind: static property of NucleusAction

NucleusAction.NucleusActionStatusWeightList

Kind: static property of NucleusAction