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 flowMilestoneId :string

Returns the flow milestone identifier if there is one set on this ArchActionAddFlowMilestone instance. If there is not one set, nothing is returned.

readonly flowMilestoneName :string

Returns the flow milestone name if there is one set on this ArchActionAddFlowMilestone instance. If there is not one set, nothing is returned.

readonly isArchActionAddFlowMilestone :boolean

Returns true indicating that this is an ArchActionAddFlowMilestone instance.

readonly isArchBaseActionFlowOutcome :boolean

Returns true indicating that this is an ArchBaseActionFlowOutcome instance.

Inherited From:

• ArchBaseActionFlowOutcome#isArchBaseActionFlowOutcome

Methods

setFlowMilestoneByIdAsync(flowMilestoneId, callbackFunction) → {Promise.<ArchActionAddFlowMilestone>}

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

Parameters:

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

Returns:

Promise.<ArchActionAddFlowMilestone>

setFlowMilestoneByNameAsync(flowMilestoneName, callbackFunctionopt) → {Promise.<ArchActionAddFlowMilestone>}

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

Parameters:

Name	Type	Attributes	Description
flowMilestoneName	string		the name of the Flow Milestone to set. Flow milestone names are looked up case insensitively.
callbackFunction	function	<optional>	a callback function to call if the Flow Milestone is successfully looked up and configured on this action. The first parameter passed to the callback function will be this Architect flow milestone action instance.

Returns:

Promise.<ArchActionAddFlowMilestone>

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