Extends

• ArchBaseAction

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchActionCallCommonModule'.

readonly commonModuleFlowInfo :ArchFlowInfo

The common module flow set on this action.

readonly displayTypeName :string

Returns the display type name string 'ArchBaseAction'.

Overrides:

• ArchBaseAction#displayTypeName

readonly displayTypeNameArchitect :string

The Architect action type label

Inherited From:

• ArchBaseAction#displayTypeNameArchitect

readonly inputs :ArchNamedValueList

The contents of this named value list come from the flow inputs defined on the common module flow configured on this action. Remember that the flow input names in the named value list will match up with variables defined as inputs on the common module flow.

readonly isArchActionCallCommonModule :boolean

Returns true indicating that this is an ArchActionCallCommonModule instance.

readonly isArchBaseAction :boolean

A property that can be checked to verify the scripting object is a type of ArchBaseAction

Inherited From:

• ArchBaseAction#isArchBaseAction

readonly isMenuChoiceAction :boolean

Returns whether or not this action is the action property for a menu choice. For example, the ArchMenuDisconnect#actionDisconnect property on an ArchMenuDisconnect instance.

Inherited From:

• ArchBaseAction#isMenuChoiceAction

readonly isReachable :boolean

Returns whether or not this action is reachable at runtime.

Inherited From:

• ArchBaseAction#isReachable

readonly isSecure :boolean

Returns whether or not this action is secure which means either the action by its very nature is secure or it consumes secure data.

Inherited From:

• ArchBaseAction#isSecure

readonly isUnreachable :boolean

Returns whether or not this action is unreachable at runtime.

Inherited From:

• ArchBaseAction#isUnreachable

readonly logStr :string

A string suitable for logging that contains information about this action. This will contain the action tracking id, name and scripting type name.

Inherited From:

• ArchBaseAction#logStr

name :string

The name of the action

Inherited From:

• ArchBaseAction#name

readonly outputs :ArchNamedValueList

The contents of this named value list come from the flow outputs defined on the common module flow configured on this action. Remember that the flow output names in the named value list will match up with variables defined as outputs on the common module flow.

readonly parentFlow :ArchBaseFlow

Returns the parent flow for this action.

Inherited From:

• ArchBaseAction#parentFlow

readonly parentMenuChoice :ArchBaseMenuChoice

Returns the parent menu choice if this action is the action for a menu choice. Otherwise, nothing is returned.

Inherited From:

• ArchBaseAction#parentMenuChoice

readonly parentState :ArchState

Returns the parent state that contains this action if this action is in a state. Otherwise, nothing is returned.

Inherited From:

• ArchBaseAction#parentState

readonly parentTask :ArchTask|ArchTaskLoop

Returns the parent task that contains this action if this action is in a task or looping task. Otherwise, nothing is returned.

Inherited From:

• ArchBaseAction#parentTask

readonly trackingId :number

The integer tracking identifier for this action. This is the numeric identifier is displayed in the Architect user interface.

Inherited From:

• ArchBaseAction#trackingId

Methods

setCommonModuleFlowByIdAsync(commonModuleFlowId, flowVersionopt, callbackFunctionopt) → {Promise.<ArchActionCallCommonModule>}

This sets the common module flow to call at runtime by the flow identifier and flow version.

Parameters:

Name	Type	Attributes	Default	Description
commonModuleFlowId	string			the common module flow identifier.
flowVersion	string	<optional>	"latest"	the flow version to call. Valid values are ArchEnums#FLOW_VERSIONS.latest and ArchEnums#FLOW_VERSIONS.debug. If no value is supplied, the latest published version will be used.
callbackFunction	callbackArchActionCallCommonModule	<optional>		a function to call if the common module flow is successfully looked up and configured on this action. The first parameter passed to the callback function will be this Call Common Module action instance

Returns:

Promise.<ArchActionCallCommonModule>

setTargetFlowInfoAsync(newValue, callbackFunctionopt) → {Promise.<ArchActionCallCommonModule>}

The target common module flow to call for this ArchActionCallCommonModule instance. Note that this function accepts either an ArchFlowInfo or an ArchFlowInfoBasic instance. If the flow information supplied to the setter does not specify a common module flow, it will throw an exception. The type of common module flow specified must also match the type specified in the action instance's commonModuleFlowTypeEnum property

Parameters:

Name	Type	Attributes	Description
newValue	ArchFlowInfoBasic		the ArchFlowInfoBasic instance of the flow to call for the ArchActionCallCommonModule instance.
callbackFunction	function	<optional>	a callback function to call if the common module flow is successfully configured on this action. The first parameter passed to the callback function will be this Architect call common module action instance.

Returns:

Promise.<ArchActionCallCommonModule>