Extends

• ArchBaseAction

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchActionSetScreenPop'.

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 isArchActionSetScreenPop :boolean

Returns true indicating that this is an ArchActionSetScreenPop 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 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 scriptInputs :ArchNamedValueList

Inputs for the screen pop action, only accessible after the script name has been set successfully. Otherwise, undefined.

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

setScriptByIdAsync(scriptId, callbackFunctionopt) → {Promise.<ArchActionSetScreenPop>}

This sets the screen pop script with the specified id. Remember this script needs to be a script with the Screen Pop feature set on it to be valid.

Parameters:

Name	Type	Attributes	Description
scriptId	string		the identifier of the screen pop script to set.
callbackFunction	callbackArchActionSetScreenPop	<optional>	a function to call if the screen pop script is successfully looked up and configured on this action. The first parameter passed to the callback function will be this set screen pop action instance.

Returns:

Promise.<ArchActionSetScreenPop>

setScriptByNameAsync(scriptName, callbackFunctionopt) → {Promise.<ArchActionSetScreenPop>}

This sets the screen pop script with the specified name. Remember this script needs to be a script with the Screen Pop feature set on it to be valid.

Parameters:

Name	Type	Attributes	Description
scriptName	string		the name of the screen pop script to set.
callbackFunction	callbackArchActionSetScreenPop	<optional>	a function to call if the screen pop script is successfully looked up and configured on this action. The first parameter passed to the callback function will be this set screen pop action instance.

Returns:

Promise.<ArchActionSetScreenPop>