Extends

• ArchBaseActionFlowOutcome

Members

static, readonly displayTypeName :string

Implements override support for the display type name string for this Architect Scripting object.

readonly displayTypeName :string

Implements override support for the display type name string for this Architect Scripting object.

Overrides:

• ArchBaseActionFlowOutcome#displayTypeName

readonly flowOutcomeValue :ArchValueString

The value to be set as the result of the flow outcome.

readonly isArchActionSetFlowOutcome :boolean

Returns true indicating that this is an ArchActionSetFlowOutcome instance.

readonly isArchBaseActionFlowOutcome :boolean

Returns true indicating that this is an ArchBaseActionFlowOutcome instance.

Inherited From:

• ArchBaseActionFlowOutcome#isArchBaseActionFlowOutcome

Methods

setFlowOutcomeByIdAsync(flowOutcomeId, callbackFunction) → {Promise.<ArchBaseActionFlowOutcome>}

This sets the flow outcome to use at runtime by its identifier.

Parameters:

Name	Type	Description
flowOutcomeId	string	the identifier of the flow outcome.
callbackFunction	function	a callback function to call if the flow outcome is successfully looked up and configured on this action. The first parameter passed to the callback function will be this action instance.

Returns:

Promise.<ArchBaseActionFlowOutcome>

Inherited From:

• ArchBaseActionFlowOutcome#setFlowOutcomeByIdAsync

setFlowOutcomeByNameAsync(flowOutcomeName, callbackFunctionopt) → {Promise.<ArchBaseActionFlowOutcome>}

This sets the flow outcome that will be used for use at runtime by the flow outcome name.

Parameters:

Name	Type	Attributes	Description
flowOutcomeName	string		the name of the Flow Outcome to set. The name is not case sensitive on the lookup.
callbackFunction	function	<optional>	a callback function to call if the Flow Outcome is successfully looked up and configured on this action. The first parameter passed to the callback function will be this Architect flow outcome action instance.

Returns:

Promise.<ArchBaseActionFlowOutcome>

Inherited From:

• ArchBaseActionFlowOutcome#setFlowOutcomeByNameAsync

setFlowOutcomeValue(newValue)

Set the value for the outcome in the Set Flow Outcome action. This is a helper method for doing archActionSetFlowOutcome.flowOutcomeValue.setLiteralString(<value>) The string values in ArchEnums#FLOW_OUTCOMES are the valid values that can be set.

Parameters:

Name	Type	Description
newValue	string	the outcome value to set