Extends

• ArchBaseFlowWorkflow

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchBaseFlowInQueueWorkflow'.

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.

readonly periodicState :ArchState

Returns the periodic state for this flow.

readonly startUpObject :ArchState

Returns the starting state for this flow. If there is no startup object configured, accessing this property returns null.

Inherited From:

• ArchBaseFlowWorkflow#startUpObject

readonly states :Array.<ArchState>

The states in the flow.

Inherited From:

• ArchBaseFlowWorkflow#states

Methods

deleteState(stateToDelete)

This function deletes the specified state from this flow.

Parameters:

Name	Type	Description
stateToDelete	ArchState	the state to delete.

Inherited From:

• ArchBaseFlowWorkflow#deleteState

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
archState	ArchState	An Architect Scripting state object.

setStartingState(archState)

Sets the specified state to be the starting state on the flow.

Parameters:

Name	Type	Description
archState	ArchState	An Architect Scripting state object.

Inherited From:

• ArchBaseFlowWorkflow#setStartingState