Extends

• ArchBaseAction

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchActionGetParticipantData'.

readonly attributeNameOutputValuePairs :ArchBaseNameValuePairs

Returns the name value attribute pairs configured on this Get Participant Data 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 isArchActionGetParticipantData :boolean

Returns true indicating that this is an ArchActionGetParticipantData 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 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

addAttributeNameOutputValuePair(nameExpressionopt, variableExpressionopt) → {ArchBaseNameValuePair}

This adds an attribute name value pair to the Get Participant Data action that is used to specify the attribute name to retrieve and the corresponding output variable where the value should be stored at runtime. On the returned ArchBaseNameValuePair:

• the name property specifies the name of the attribute whose value you want to retrieve
• the value property is an output string value property that specifies the string variable where the runtime value of the attribute will be stored.

Parameters:

Name	Type	Attributes	Description
nameExpression	string	<optional>	a string expression that specifies the name of the attribute to retrieve.
variableExpression	string	<optional>	a string variable expression that specifies the name of the variable where the value should be stored. For example -> Flow.MyStringVar

Returns:

ArchBaseNameValuePair