new ArchFlowInQueueEmail(coreInQueueEmailFlowViewModel)
The Architect Scripting class that represents an In-Queue Email flow.
Instances of this Architect Scripting object should be created by calling ArchFactoryFlows#createFlowInQueueEmailAsync
Parameters:
| Name | Type | Description |
|---|---|---|
coreInQueueEmailFlowViewModel |
Object | ( Internal ) an Architect core in-queue email flow view model. |
Extends
Members
-
static, readonly displayTypeName :string
-
Returns the display type name string 'ArchFlowInQueueEmail'.
-
readonly isArchBaseFlowInQueueWorkflow :boolean
-
Returns true indicating that this is an ArchBaseFlowInQueueWorkflow object. This will be true for in-queue email and in-queue short message flows.
- Inherited From:
-
readonly isArchFlowInQueueEmail :boolean
-
Returns true indicating that this is an ArchFlowInQueueEmail instance.
-
readonly periodicState :ArchState
-
Returns the periodic state for this flow.
- Inherited From:
-
readonly startUpObject :ArchState
-
Returns the starting state for this flow. If there is no startup object configured, accessing this property returns null.
- Inherited From:
-
readonly states :Array.<ArchState>
-
The states in the flow.
- Inherited From:
Methods
-
deleteState(stateToDelete)
-
This function deletes the specified state from this flow.
Parameters:
Name Type Description stateToDeleteArchState the state to delete.
- Inherited From:
-
setPeriodicState(archState)
-
Sets the specified state to be the periodic state on the in-queue email or short message flow. Remember the same state cannot be used for both the starting state and the periodic state.
Parameters:
Name Type Description archStateArchState An Architect Scripting state object.
- Inherited From:
-
setStartingState(archState)
-
Sets the specified state to be the starting state on the flow.
Parameters:
Name Type Description archStateArchState An Architect Scripting state object.
- Inherited From: