new ArchActionSetPostFlow(coreSetPostFlowActionViewModel)
The Architect Scripting class that represents the Set Post Flow action.
Instances of this action should be created by calling ArchFactoryActions#addActionSetPostFlow
Parameters:
| Name | Type | Description |
|---|---|---|
coreSetPostFlowActionViewModel |
Object | ( Internal ) an Architect core Set Post Flow action view model. |
Extends
Members
-
static, readonly displayTypeName :string
-
Returns the display type name string 'ArchActionSetPostFlow'.
-
readonly actionType :ArchValueString
-
This specifies the Post-Flow action to invoke. The string values in
ArchEnums#POST_FLOW_ACTION_TYPESlists valid values. -
readonly displayTypeName :string
-
Returns the display type name string 'ArchBaseAction'.
- Overrides:
-
readonly displayTypeNameArchitect :string
-
The Architect action type label
- Inherited From:
-
readonly invocationData :ArchValueJson
-
This is the invocation data that can be used when launching a flow.
-
readonly isArchActionSetPostFlow :boolean
-
Returns true indicating that this is an ArchActionSetPostFlow instance.
-
readonly isArchBaseAction :boolean
-
A property that can be checked to verify the scripting object is a type of ArchBaseAction
- Inherited From:
-
readonly isMenuChoiceAction :boolean
-
Returns whether or not this action is the action property for a
menu choice. For example, theArchMenuDisconnect#actionDisconnectproperty on anArchMenuDisconnectinstance.- Inherited From:
-
readonly isReachable :boolean
-
Returns whether or not this action is reachable at runtime.
- Inherited From:
-
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:
-
readonly isUnreachable :boolean
-
Returns whether or not this action is unreachable at runtime.
- Inherited From:
-
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:
-
name :string
-
The name of the action
- Inherited From:
-
readonly parentFlow :ArchBaseFlow
-
Returns the parent flow for this action.
- Inherited From:
-
readonly parentMenuChoice :ArchBaseMenuChoice
-
Returns the parent menu choice if this action is the action for a
menu choice. Otherwise, nothing is returned.- Inherited From:
-
readonly parentState :ArchState
-
Returns the parent state that contains this action if this action is in a
state. Otherwise, nothing is returned.- Inherited From:
-
readonly parentTask :ArchTask|ArchTaskLoop
-
Returns the parent task that contains this action if this action is in a
taskorlooping task. Otherwise, nothing is returned.- Inherited From:
-
readonly target :ArchValueString
-
This specifies the target for the Post-Flow. The string values in
ArchEnums#POST_FLOW_TARGET_TYPESlists valid values. -
targetFlowInfo :ArchFlowInfoBasic
-
The target flow for this ArchActionSetPostFlow instance that specifies the post flow to execute
-
readonly trackingId :number
-
The integer tracking identifier for this action. This is the numeric identifier is displayed in the Architect user interface.
- Inherited From:
Methods
-
getTargetTypeForActionType() → {string}
-
Returns the target type string for the currently configured
action type.Returns:
string -
setTargetFlowInfoAsync(targetFlowInfo, callbackFunctionopt)
-
The target flow to call for this ArchActionSetPostFlow instance. Note that this function accepts either an
ArchFlowInfoor anArchFlowInfoBasicinstance. If the flow information supplied to the setter does not specify a flow, it will throw an exception. The type of flow specified must also match the type specified in the action instance's actionType propertyParameters:
Name Type Attributes Description targetFlowInfoArchFlowInfo | ArchFlowInfoBasic the
ArchFlowInfoBasicorArchFlowInfothat specifies the flow to execute.callbackFunctionfunction <optional>
a callback function to call if the flow is successfully configured on this action. The first parameter passed to the callback function will be this Architect Set Post Flow action instance.