new ArchFactoryActions()
A factory instance that lets you add Architect actions to flows. Do not attempt to create an instance of this class. Architect Scripting will create the factory instance as needed.
Extends
Members
-
static, readonly displayTypeName :string
-
Returns the display type name string 'ArchFactoryActions'.
-
static, readonly isArchFactoryActions :boolean
-
Returns true indicating that this is an ArchFactoryActions instance.
-
readonly logStr :string
-
A logging string for the Architect Factory Actions instance.
- Overrides:
-
readonly logStrTypeOnly :string
-
This is a string suitable for logging information about this object where it's just the object's type. This is normally used when logging errors that occur in constructor parameter checking because the scripting object isn't set up and the normal logging str contents wouldn't be set up.
- Inherited From:
Methods
-
addActionAbortSurveyInvite(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionAbortSurveyInvite}
-
Adds an abort survey invite action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionAbortSurveyInvite -
addActionAddFlowMilestone(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionAddFlowMilestone}
-
Adds an Add Flow Milestone action to a task, state, bot or action output.
Parameters:
Name Type Attributes Description archMultiActionContainer
ArchTask | ArchState | ArchActionOutput the Architect task, state, bot or action output where the new action should be added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the task, state or action output where the new action should be added. If undefined, the new action will be appended to the task, state, bot or action output.
Returns:
ArchActionAddFlowMilestone -
addActionAskForBoolean(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionAskForBoolean}
-
Adds an Ask for Boolean action to a task, bot or action output.
Parameters:
Name Type Attributes Description archMultiActionContainer
ArchTask | ArchState | ArchActionOutput the Architect task, state or action output where the new action should be added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the task, state or action output where the new action should be added. If undefined, the new action will be appended to the task, state or action output.
Returns:
ArchActionAskForBoolean -
addActionAskForIntent(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionAskForIntent}
-
Adds an Ask for Intent action to a task, bot or action output.
Parameters:
Name Type Attributes Description archMultiActionContainer
ArchTask | ArchState | ArchActionOutput the Architect task, state or action output where the new action should be added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the task, state or action output where the new action should be added. If undefined, the new action will be appended to the task, state or action output.
Returns:
ArchActionAskForIntent -
addActionAskForSlot(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionAskForSlot}
-
Adds an Ask for Slot action to a task, bot or action output.
Parameters:
Name Type Attributes Description archMultiActionContainer
ArchTask | ArchState | ArchActionOutput the Architect task, state or action output where the new action should be added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the task, state or action output where the new action should be added. If undefined, the new action will be appended to the task, state or action output.
Returns:
ArchActionAskForSlot -
addActionAskSurveyQuestion(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionAskSurveyQuestion}
-
Adds an Ask Survey Question action to a task, bot or action output.
Parameters:
Name Type Attributes Description archMultiActionContainer
ArchTask | ArchState | ArchActionOutput the Architect task, state or action output where the new action should be added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the task, state or action output where the new action should be added. If undefined, the new action will be appended to the task, state or action output.
Returns:
ArchActionAskSurveyQuestion -
addActionAudioMonitoring(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionAudioMonitoring}
-
Adds an Audio Monitoring action to an
ArchBaseMultiActionContainer
such as anaction output
ortask
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionAudioMonitoring -
addActionCallAudioConnector(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionCallAudioConnector}
-
Adds a Call Audio Connector action to a task, state or action output.
Parameters:
Name Type Attributes Description archMultiActionContainer
ArchTask | ArchState | ArchActionOutput the Architect task, state or action output where the new action should be added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the task, state or action output where the new action should be added. If undefined, the new action will be appended to the task, state or action output.
Returns:
ArchActionCallAudioConnector -
addActionCallBotFlow(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionCallBotFlow}
-
Adds a Call Bot Flow action to a task, state or action output.
Parameters:
Name Type Attributes Description archMultiActionContainer
ArchTask | ArchState | ArchActionOutput the Architect task, state or action output where the new action should be added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the task, state or action output where the new action should be added. If undefined, the new action will be appended to the task, state or action output.
Returns:
ArchActionCallBotFlow -
addActionCallCommonModule(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionCallCommonModule}
-
Adds a call common module action to a task, state or action output.
Parameters:
Name Type Attributes Description archMultiActionContainer
ArchTask | ArchState | ArchActionOutput the Architect task, state or action output where the new action should be added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the task, state or action output where the new action should be added. If undefined, the new action will be appended to the task, state or action output.
Returns:
ArchActionCallCommonModule -
addActionCallData(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionCallData}
-
Adds a non-secure data action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionCallData -
addActionCallDataSecure(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionCallDataSecure}
-
Adds a secure data action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionCallDataSecure -
addActionCallDialogEngineBot(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionCallDialogEngineBot}
-
Adds a Call Dialog Engine Bot action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionCallDialogEngineBot -
addActionCallDialogflowBot(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionCallDialogflowBot}
-
Adds a Call Dialogflow Bot action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionCallDialogflowBot -
addActionCallDialogflowCxBot(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionCallDialogflowCxBot}
-
Adds a Call Dialogflow CX Bot action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionCallDialogflowCxBot -
addActionCallDigitalBotFlow(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionCallDigitalBotFlow}
-
Adds a Call Digital Bot Flow action to a task, state or action output.
Parameters:
Name Type Attributes Description archMultiActionContainer
ArchTask | ArchState | ArchActionOutput the Architect task, state or action output where the new action should be added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the task, state or action output where the new action should be added. If undefined, the new action will be appended to the task, state or action output.
Returns:
ArchActionCallDigitalBotFlow -
addActionCallLexBot(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionCallLexBot}
-
Adds a Call Lex Bot action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionCallLexBot -
addActionCallLexV2Bot(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionCallLexV2Bot}
-
Adds a Call Lex V2 Bot action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionCallLexV2Bot -
addActionCallNuanceMixBot(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionCallNuanceMixBot}
-
Adds a Call Nuance Mix Bot action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionCallNuanceMixBot -
addActionCallTask(archMultiActionContainer, nameopt, targetTaskopt, previousArchActionopt) → {ArchActionCallTask}
-
Adds a call task action to a task, state or action output.
Parameters:
Name Type Attributes Description archMultiActionContainer
ArchTask | ArchState | ArchActionOutput the Architect task, state or action output where the new action should be added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
targetTask
ArchTask <optional>
the task to call.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the task, state or action output where the new action should be added. If undefined, the new action will be appended to the task, state or action output.
Returns:
ArchActionCallTask -
addActionChangeState(archMultiActionContainer, nameopt, targetStateopt, previousArchActionopt) → {ArchActionChangeState}
-
Adds a change state action to a state or action output.
Parameters:
Name Type Attributes Description archMultiActionContainer
ArchState | ArchActionOutput the Architect state or action output where the new action should be added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
targetState
ArchState <optional>
the state to change to.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the state or action output where the new action should be added. If undefined, the new action will be appended to the state or action output.
Returns:
ArchActionChangeState -
addActionClearActiveIntent(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionClearActiveIntent}
-
Adds a Clear Active Intent action to a task, bot or action output.
Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionClearActiveIntent -
addActionClearPostFlow(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionClearPostFlow}
-
Adds a Clear Post-Flow action to an
ArchBaseMultiActionContainer
such as anaction output
ortask
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionClearPostFlow -
addActionClearSlot(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionClearSlot}
-
Adds a Clear Slot action to a task, bot or action output.
Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionClearSlot -
addActionClearUtilizationLabel(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionClearUtilizationLabel}
-
Adds a Clear Utilization Label action to an
ArchBaseMultiActionContainer
such as anaction output
ortask
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionClearUtilizationLabel -
addActionClearVoicemailSnippet(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionClearVoicemailSnippet}
-
Adds a Clear Voicemail Snippet action to an
ArchBaseMultiActionContainer
such as anaction output
ortask
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionClearVoicemailSnippet -
addActionCollectInput(archMultiActionContainer, nameopt, inputAudioTTSopt, inputVariableopt, interDigitTimeoutMSopt, noEntryTimeoutMSopt, previousArchActionopt) → {ArchActionCollectInput}
-
Adds a collect input action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
inputAudioTTS
string <optional>
default audio case text to speech to use for the input audio.
inputVariable
string | ArchBaseVariable <optional>
the variable to use to hold the input data.
interDigitTimeoutMS
number <optional>
the inter-digit timeout in milliseconds. If specified, this value should be a non-negative integer.
noEntryTimeoutMS
number <optional>
the no-entry timeout duration length in milliseconds. If specified, this value should be a non-negative integer.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionCollectInput -
addActionCommunicate(archMultiActionContainer, nameopt, communicationExpressionopt, previousArchActionopt) → {ArchActionCommunicate}
-
Adds a Communication action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
communicationExpression
string <optional>
the communication expression text to use for the Communication setting on the communicate action.
previousArchAction
ArchBaseAction <optional>
the previous Architect action. If undefined, the action will be appended to the container.
Returns:
ArchActionCommunicate -
addActionCompleteSurveyInvite(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionCompleteSurveyInvite}
-
Adds a complete survey invite action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionCompleteSurveyInvite -
addActionCreateCallback(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionCreateCallback}
-
Adds a Create Callback action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionCreateCallback -
addActionDataTableLookup(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionDataTableLookup}
-
Adds a data table lookup action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionDataTableLookup -
addActionDecision(archMultiActionContainer, nameopt, conditionExpressionopt, previousArchActionopt) → {ArchActionDecision}
-
Adds a decision action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
conditionExpression
string <optional>
the boolean expression text to use for the condition on the decision action.
previousArchAction
ArchBaseAction <optional>
the previous Architect action. If undefined, the action will be appended to the container.
Returns:
ArchActionDecision -
addActionDecryptData(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionDecryptData}
-
Adds a Decrypt Data action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionDecryptData -
addActionDetectSilence(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionDetectSilence}
-
Adds a detect silence action to an
ArchBaseMultiActionContainer
such as anaction output
ortask
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionDetectSilence -
addActionDialByExtension(archMultiActionContainer, nameopt, extensionVariableopt, repromptTTSopt, repromptCountopt, interDigitTimeoutMSopt, previousArchActionopt) → {ArchActionDialByExtension}
-
Adds a dial by extension action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
extensionVariable
string | ArchVariableString <optional>
the Architect string variable to hold the entered extension.
repromptTTS
string <optional>
the text to speech to use for reprompting.
repromptCount
number <optional>
the number of times to reprompt. If specified, this value should be a non-negative integer.
interDigitTimeoutMS
number <optional>
the inter-digit timeout duration in milliseconds. If specified, this value should be a non-negative integer.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionDialByExtension -
addActionDigitalMenu(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionDigitalMenu}
-
Adds a Digital Menu action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchTask | ArchState | ArchActionOutput the Architect task, state or action output where the new action should be added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the task, state or action output where the new action should be added. If undefined, the new action will be appended to the task or action output.
Returns:
ArchActionDigitalMenu -
addActionDisconnect(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionDisconnect}
-
Adds a disconnect action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionDisconnect -
addActionDisconnectWorkitem(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionDisconnectWorkitem}
-
Adds a Disconnect Workitem action to an
ArchBaseMultiActionContainer
such as anaction output
ortask
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionDisconnectWorkitem -
addActionEnableParticipantRecord(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionEnableParticipantRecord}
-
Adds an enable Participant Record action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionEnableParticipantRecord -
addActionEncryptData(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionEncryptData}
-
Adds an Encrypt Data action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionEncryptData -
addActionEndState(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionEndState}
-
Adds an End State action to an
ArchBaseMultiActionContainer
such as anaction output
orstate
in a workflow flow type.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionEndState -
addActionEndTask(archMultiActionContainer, nameopt, targetBranchopt, previousArchActionopt) → {ArchActionEndTask}
-
Adds an end task action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
targetBranch
ArchBranch <optional>
the branch to use.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionEndTask -
addActionEndWorkflow(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionEndWorkflow}
-
Adds an End Workflow action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
in a workflow flow type.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionEndWorkflow -
addActionEvaluateSchedule(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionEvaluateSchedule}
-
Adds an evaluate schedule action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionEvaluateSchedule -
addActionEvaluateScheduleGroup(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionEvaluateScheduleGroup}
-
Adds an evaluate schedule group action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionEvaluateScheduleGroup -
addActionExitBotFlow(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionExitBotFlow}
-
Adds an exit bot flow action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionExitBotFlow -
addActionExitWorkitemFlow(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionExitWorkitemFlow}
-
Adds an exit workitem flow action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionExitWorkitemFlow -
addActionExtractSecureData(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionExtractSecureData}
-
Adds an extract secure data action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionExtractSecureData -
addActionFindEmergencyGroup(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionFindEmergencyGroup}
-
Adds a Find Emergency Group action to an
ArchBaseMultiActionContainer
such as anaction output
ortask
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionFindEmergencyGroup -
addActionFindGrammar(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionFindGrammar}
-
Adds a Find Grammar action to an
ArchBaseMultiActionContainer
such as anaction output
ortask
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionFindGrammar -
addActionFindGrammarById(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionFindGrammarById}
-
Adds a Find Grammar by Id action to an
ArchBaseMultiActionContainer
such as anaction output
ortask
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionFindGrammarById -
addActionFindGroup(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionFindGroup}
-
Adds a Find Group action to an
ArchBaseMultiActionContainer
such as anaction output
ortask
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionFindGroup -
addActionFindKnowledgeBaseDocumentById(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionFindKnowledgeBaseDocumentById}
-
Adds a Find KnowledgeBaseDocument by Id action to an
ArchBaseMultiActionContainer
such as anaction output
ortask
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
-
addActionFindLanguageSkill(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionFindLanguageSkill}
-
Adds a Find Language Skill action to an
ArchBaseMultiActionContainer
such as anaction output
ortask
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionFindLanguageSkill -
addActionFindQueue(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionFindQueue}
-
Adds a Find Queue action to an
ArchBaseMultiActionContainer
such as anaction output
ortask
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionFindQueue -
addActionFindQueueById(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionFindQueueById}
-
Adds a Find Queue by Id action to an
ArchBaseMultiActionContainer
such as anaction output
ortask
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionFindQueueById -
addActionFindSchedule(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionFindSchedule}
-
Adds a Find Schedule action to an
ArchBaseMultiActionContainer
such as anaction output
ortask
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionFindSchedule -
addActionFindScheduleGroup(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionFindScheduleGroup}
-
Adds a Find Schedule Group action to an
ArchBaseMultiActionContainer
such as anaction output
ortask
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionFindScheduleGroup -
addActionFindSkill(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionFindSkill}
-
Adds a Find Skill action to an
ArchBaseMultiActionContainer
such as anaction output
ortask
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionFindSkill -
addActionFindSystemPrompt(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionFindSystemPrompt}
-
Adds a Find System Prompt action to an
ArchBaseMultiActionContainer
such as anaction output
ortask
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionFindSystemPrompt -
addActionFindUser(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionFindUser}
-
Adds a Find User action to an
ArchBaseMultiActionContainer
such as anaction output
ortask
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionFindUser -
addActionFindUserById(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionFindUserById}
-
Adds a Find User by Id action to an
ArchBaseMultiActionContainer
such as anaction output
ortask
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionFindUserById -
addActionFindUserPrompt(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionFindUserPrompt}
-
Adds a Find User Prompt action to an
ArchBaseMultiActionContainer
such as anaction output
ortask
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionFindUserPrompt -
addActionFindUsersById(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionFindUsersById}
-
Adds a Find Users by Id action to an
ArchBaseMultiActionContainer
such as anaction output
ortask
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionFindUsersById -
addActionFindUtilizationLabel(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionFindUtilizationLabel}
-
Adds a Find Utilization Label action to an
ArchBaseMultiActionContainer
such as anaction output
ortask
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionFindUtilizationLabel -
addActionFlushAudio(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionFlushAudio}
-
Adds a Flush Audio action to an
ArchBaseMultiActionContainer
such as anaction output
ortask
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionFlushAudio -
addActionFromDefinition(archDefinitionAction, archMultiActionContainer, nameopt, previousArchActionopt) → {ArchBaseAction}
-
Adds an action instance from an action definition to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archDefinitionAction
ArchDefinitionAction the action definition that specifies what type of action to create.
archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchBaseAction -
addActionGetConversationData(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionGetConversationData}
-
Adds a get conversation data action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionGetConversationData -
addActionGetExternalContact(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionGetExternalContact}
-
Adds a Get External Contact action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionGetExternalContact -
addActionGetExternalOrganization(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionGetExternalOrganization}
-
Adds a Get External Organization action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionGetExternalOrganization -
addActionGetJourneyOutcome(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionGetJourneyOutcome}
-
Adds a Get Journey Outcome action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionGetJourneyOutcome -
addActionGetJourneyOutcomeScoresBySession(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionGetJourneyOutcomeScoresBySession}
-
Adds a Get Journey Outcome Scores by Session action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
-
addActionGetJourneySegment(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionGetJourneySegment}
-
Adds a Get Journey Segment action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionGetJourneySegment -
addActionGetJourneySession(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionGetJourneySession}
-
Adds a Get Journey Session action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionGetJourneySession -
addActionGetJourneySessionsByExternalContact(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionGetJourneySessionsByExternalContact}
-
Adds a Get Journey Sessions by External Contact action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
-
addActionGetParticipantData(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionGetParticipantData}
-
Adds a get participant data action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionGetParticipantData -
addActionGetRawSIPHeaders(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionGetJourneyOutcome}
-
Adds a Get Raw SIP Headers action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionGetJourneyOutcome -
addActionGetResponse(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionGetResponse}
-
Adds a Get Response action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionGetResponse -
addActionGetSecuredData(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionGetSecuredData}
-
Adds a Get Secured Data action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionGetSecuredData -
addActionGetSIPHeaders(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionGetJourneyOutcome}
-
Adds a Get SIP Headers action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionGetJourneyOutcome -
addActionHoldMusic(archMultiActionContainer, nameopt, playStyleopt, durationExpressionopt, previousArchActionopt) → {ArchActionHoldMusic}
-
Adds a hold music action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
. The prompt to play will be set to Flow.HoldPrompt on the returned new action instance.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
playStyle
string <optional>
whether to play the whole prompt or for a certain duration. The string values in
ArchEnums#PLAY_POSITION_STYLES
lists valid values. This defaults to 'prompt' if not specified.durationExpression
string <optional>
the duration expression to use that supplies the duration of the play style when playStyle is 'duration'.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionHoldMusic -
addActionInitializeFlowOutcome(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionInitializeFlowOutcome}
-
Adds an Initialize Flow Outcome action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionInitializeFlowOutcome -
addActionJumpToMenu(archMultiActionContainer, nameopt, archTargetMenuopt, previousArchActionopt) → {ArchActionJumpToMenu}
-
Adds a jump to menu action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
archTargetMenu
ArchMenu | ArchMenuSubMenu <optional>
the Architect menu or sub menu to transfer to.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionJumpToMenu -
addActionJumpToTask(archMultiActionContainer, nameopt, targetTaskopt, previousArchActionopt) → {ArchActionJumpToTask}
-
Adds a jump to task action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
targetTask
ArchTask <optional>
the task to transfer to.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionJumpToTask -
addActionLoop(archMultiActionContainer, nameopt, currentIndexVariableopt, loopCountExpressionopt, previousArchActionopt) → {ArchActionLoop}
-
Adds a Loop action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
currentIndexVariable
string | ArchVariableInteger <optional>
the current index variable to set on the loop.
loopCountExpression
string <optional>
the loop count integer expression text that specifies the number of times the loop should run.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionLoop -
addActionLoopAnythingElse(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionLoopAnythingElse}
-
Adds an "Anything Else?" Loop action to a task, bot or action output.
Parameters:
Name Type Attributes Description archMultiActionContainer
ArchTask | ArchState | ArchActionOutput the Architect task, state or action output where the new action should be added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the task, state or action output where the new action should be added. If undefined, the new action will be appended to the task, state or action output.
Returns:
ArchActionLoopAnythingElse -
addActionLoopExit(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionLoopExit}
-
Adds a loop exit action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
. Remember that a loop exit has to be contained somewhere within a loop to be valid.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionLoopExit -
addActionLoopNext(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionLoopNext}
-
Adds a loop next action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
. Remember that a loop next has to be contained somewhere within a loop to be valid.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionLoopNext -
addActionLoopUntil(archMultiActionContainer, nameopt, currentIndexVariableopt, maxLoopCountExpressionopt, previousArchActionopt) → {ArchActionLoopUntil}
-
Adds a Loop Until action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
. When adding a loop until action using this method there will be no until cases automatically added to the returned Loop Until action like the success until case that is automatically added when a Loop Until action is added to a flow in the Architect UI. It's important to remember that when you add a Loop Until action that if you do not configure any until cases with exit criteria, do not set a maximum loop count on the action and there is no loop terminating action likeArchActionLoopExit
or flow terminating action in the loop output or next loop output that at runtime execution could get stuck in an infinite loop until the flow runtime engine would terminate flow execution due to a maximum number of actions being run.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
currentIndexVariable
string | ArchVariableInteger <optional>
the current index variable to set on the loop.
maxLoopCountExpression
string <optional>
the loop count integer expression text that specifies the number of times the loop should run. If no expression text is specified, no maximum loop count will be configured on the returned action.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionLoopUntil -
addActionPlayAudio(archMultiActionContainer, nameopt, defaultAudioTTSopt, previousArchActionopt) → {ArchActionPlayAudio}
-
Adds a play audio action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
defaultAudioTTS
string <optional>
default audio text to speech to use for the Play Audio action.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionPlayAudio -
addActionPlayAudioOnSilence(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionPlayAudioOnSilence}
-
Adds a play audio on silence action to an
ArchBaseMultiActionContainer
such as anaction output
ortask
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionPlayAudioOnSilence -
addActionPlayEstimatedWaitTime(archMultiActionContainer, nameopt, playbackModeopt, estimatedWaitTimeExpressionopt, previousArchActionopt) → {ArchActionPlayEstimatedWaitTime}
-
Adds a play estimated wait time action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Default Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
playbackMode
string <optional>
'lessThan' the estimated wait time playback mode. The string values in
ArchEnums#PLAY_ESTIMATED_WAIT_STYLES
lists valid values.estimatedWaitTimeExpression
string <optional>
'Call.EstimatedWaitTime' the expression to use that supplies the estimated wait time duration value.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionPlayEstimatedWaitTime -
addActionPlayPositionInQueue(archMultiActionContainer, nameopt, playbackModeopt, positionExpressionopt, previousArchActionopt) → {ArchActionPlayPositionInQueue}
-
Adds a play position in queue action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Default Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
playbackMode
string <optional>
'number' the position in queue playback mode. The string values in
ArchEnums#PLAY_POSITION_STYLES
lists valid values.positionExpression
string <optional>
'Call.PositionInQueue' the expression to use that supplies the position in queue integer value.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionPlayPositionInQueue -
addActionPlayUserGreeting(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionPlayUserGreeting}
-
Adds a play user greeting action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionPlayUserGreeting -
addActionPlayUserName(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionPlayUserName}
-
Adds a play user name action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionPlayUserName -
addActionPreviousMenu(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionPreviousMenu}
-
Adds a previous menu action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionPreviousMenu -
addActionProcessVoicemailInput(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionProcessVoicemailInput}
-
Adds a Process Voicemail Input action to an
ArchBaseMultiActionContainer
such as anaction output
ortask
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionProcessVoicemailInput -
addActionReturnToAgent(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionReturnToAgent}
-
Adds an Return To Agent action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionReturnToAgent -
addActionSearchExternalContacts(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionSearchExternalContacts}
-
Adds a Search External Contacts action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionSearchExternalContacts -
addActionSendAutoReply(archMultiActionContainer, nameopt, fromExpressionopt, replyToExpressionopt, ccExpressionopt, bccExpressionopt, messageBodyVariableopt, previousArchActionopt) → {ArchActionSendAutoReply}
-
Adds a Send Auto Reply action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
fromExpression
string <optional>
the from EmailAddress expression text.
replyToExpression
string <optional>
the replyTo EmailAddress expression text.
ccExpression
string <optional>
the cc EmailAddress collection expression text.
bccExpression
string <optional>
the bcc EmailAddress collection expression text.
messageBodyVariable
string | ArchBaseVariable <optional>
the variable to use to hold the message body.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionSendAutoReply -
addActionSendKnowledgeFeedback(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionSendKnowledgeFeedback}
-
Adds a Send Knowledge Feedback action to an
ArchBaseMultiActionContainer
such as aaction output
,task
Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added.
Returns:
ArchActionSendKnowledgeFeedback -
addActionSendNotification(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionSendNotification}
-
Adds a Send Notification action to an
ArchBaseMultiActionContainer
such as aaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added.
Returns:
ArchActionSendNotification -
addActionSendResponse(archMultiActionContainer, nameopt, messageBodyExpressionopt, previousArchActionopt) → {ArchActionSendResponse}
-
Adds a Send Response action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
messageBodyExpression
string <optional>
the message body expression text.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionSendResponse -
addActionSetConversationData(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionSetConversationData}
-
Adds a Set Conversation Data action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionSetConversationData -
addActionSetExternalTag(archMultiActionContainer, nameopt, externalTagExpressionopt, previousArchActionopt) → {ArchActionSetExternalTag}
-
Adds a Set External Tag action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
externalTagExpression
string <optional>
the expression text to set on the
ArchActionSetExternalTag#externalTag
value if a string is supplied.previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionSetExternalTag -
addActionSetFlowOutcome(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionSetFlowOutcome}
-
Adds a Set Flow Outcome action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionSetFlowOutcome -
addActionSetIntent(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionSetIntent}
-
Adds a Set Active Intent action to a task, bot or action output.
Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionSetIntent -
addActionSetLanguage(archMultiActionContainer, nameopt, languageopt, previousArchActionopt) → {ArchActionSetLanguage}
-
Adds a set language action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
language
ArchLanguage <optional>
the language to have the action set at runtime.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionSetLanguage -
addActionSetParticipantData(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionSetParticipantData}
-
Adds a set participant data action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionSetParticipantData -
addActionSetPostFlow(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionSetPostFlow}
-
Adds a Set Post-Flow action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionSetPostFlow -
addActionSetPriority(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionSetPriority}
-
Adds a Set Priority action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionSetPriority -
addActionSetScreenPop(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionSetScreenPop}
-
Adds a Set Screen Pop action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionSetScreenPop -
addActionSetSecuredData(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionSetSecuredData}
-
Adds a Set Secured Data action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionSetSecuredData -
addActionSetSkills(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionSetSkills}
-
Adds a Set Skills action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionSetSkills -
addActionSetUtilizationLabel(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionSetUtilizationLabel}
-
Adds a Set Utilization Label action to an
ArchBaseMultiActionContainer
such as anaction output
ortask
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionSetUtilizationLabel -
addActionSetUUIData(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionSetUUIData}
-
Adds a Set UUI Data action
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionSetUUIData -
addActionSetWhisperAudio(archMultiActionContainer, nameopt, audioExpressionopt, previousArchActionopt) → {ArchActionSetWhisperAudio}
-
Adds a set whisper audio action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
audioExpression
string <optional>
the audio expression text that will be played for the agent.
previousArchAction
ArchBaseAction <optional>
the previous Architect action. If undefined, the action will be appended to the container.
Returns:
ArchActionSetWhisperAudio -
addActionSetWrapupCode(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionSetWrapupCode}
-
Adds a set wrapup code action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionSetWrapupCode -
addActionShowKnowledgeArticle(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionShowKnowledgeArticle}
-
Adds a show knowledge article to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action. If undefined, the action will be appended to the container.
Returns:
ArchActionShowKnowledgeArticle -
addActionSwitch(archMultiActionContainer, nameopt, switchExpressionopt, caseExpressionOrExpressionsopt) → {ArchActionSwitch}
-
Adds a switch action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
. If switchExpression is a non-blank string, theArchActionSwitch#setExpressionSwitch
method is called with the switchExpression and caseExpression string / string array.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
switchExpression
string <optional>
the expression that supplies the value to switch on at runtime. If a non-blank string, this parameter along with the caseExpressionOrExpressions parameter is passed in to
ArchActionSwitch#setExpressionSwitch
.caseExpressionOrExpressions
string | Array.<string> <optional>
this parameter is passed in to
ArchActionSwitch#setExpressionSwitch
if the switchExpression parameter is a non-blank string.Returns:
ArchActionSwitch -
addActionTerminateWorkitem(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionTerminateWorkitem}
-
Adds a Terminate Workitem action to an
ArchBaseMultiActionContainer
such as anaction output
ortask
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionTerminateWorkitem -
addActionTranscription(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionTranscription}
-
Adds a transcription action to an
ArchBaseMultiActionContainer
such as anaction output
ortask
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionTranscription -
addActionTransferToAcd(archMultiActionContainer, nameopt, preTransferAudioTTSopt, previousArchActionopt) → {ArchActionTransferToAcd}
-
Adds a transfer to acd action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
preTransferAudioTTS
string <optional>
the pre-transfer text to speech to use for the default audio case.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionTransferToAcd -
addActionTransferToFlow(archMultiActionContainer, nameopt, preTransferAudioTTSopt, previousArchActionopt) → {ArchActionTransferToFlow}
-
Adds a transfer to flow action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
preTransferAudioTTS
string <optional>
the pre-transfer text to speech to use for the default audio case.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionTransferToFlow -
addActionTransferToFlowSecure(archMultiActionContainer, nameopt, preTransferAudioTTSopt, previousArchActionopt) → {ArchActionTransferToFlowSecure}
-
Adds a transfer to secure flow action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
preTransferAudioTTS
string <optional>
the pre-transfer text to speech to use for the default audio case.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionTransferToFlowSecure -
addActionTransferToGroup(archMultiActionContainer, nameopt, preTransferAudioTTSopt, previousArchActionopt) → {ArchActionTransferToGroup}
-
Adds a transfer to acd action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
preTransferAudioTTS
string <optional>
the pre-transfer text to speech to use for the default audio case.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionTransferToGroup -
addActionTransferToNumber(archMultiActionContainer, nameopt, preTransferAudioTTSopt, numberopt, previousArchActionopt) → {ArchActionTransferToNumber}
-
Adds a transfer to number action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
preTransferAudioTTS
string <optional>
the pre-transfer text to speech to use for the default audio case.
number
string <optional>
the literal number to which to transfer.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionTransferToNumber -
addActionTransferToUser(archMultiActionContainer, nameopt, preTransferAudioTTSopt, previousArchActionopt) → {ArchActionTransferToUser}
-
Adds a transfer to user action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
preTransferAudioTTS
string <optional>
the pre-transfer text to speech to use for the default audio case.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionTransferToUser -
addActionTransferToVoicemail(archMultiActionContainer, nameopt, preTransferAudioTTSopt, previousArchActionopt) → {ArchActionTransferToVoicemail}
-
Adds a transfer to voicemail action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
. Note that when adding a transfer to voicemail action in Architect Scripting, the voicemail_greeting prompt will not be set on the newly created action instance.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
preTransferAudioTTS
string <optional>
the pre-transfer text to speech to use for the default audio case.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionTransferToVoicemail -
addActionUpdateData(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionUpdateData}
-
Adds an update data action to an
ArchBaseMultiActionContainer
such as anaction output
,task
orstate
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting state, task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionUpdateData -
addActionUpdateWorkitem(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionUpdateWorkitem}
-
Adds a Update Workitem action to an
ArchBaseMultiActionContainer
such as anaction output
ortask
.Parameters:
Name Type Attributes Description archMultiActionContainer
ArchBaseMultiActionContainer the Architect multi-action container where the new action should be added. For example, an Architect Scripting task or action output where you want the action added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the archBaseMultiActionContainer after which the new action should be added. If not specified, the new action will be appended to the end of the action container.
Returns:
ArchActionUpdateWorkitem -
addActionWait(archMultiActionContainer, nameopt, durationExpressionopt, previousArchActionopt) → {ArchActionWait}
-
Adds a Wait action to a task, state or action output.
Parameters:
Name Type Attributes Description archMultiActionContainer
ArchTask | ArchState | ArchActionOutput the Architect task, state or action output where the new action should be added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
durationExpression
string <optional>
the wait duration expression text.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the task, state or action output where the new action should be added. If undefined, the new action will be appended to the task, state or action output.
Returns:
ArchActionWait -
addActionWaitForInput(archMultiActionContainer, nameopt, previousArchActionopt) → {ArchActionWaitForInput}
-
Adds a Wait for Input action to a task or action output.
Parameters:
Name Type Attributes Description archMultiActionContainer
ArchTask | ArchState | ArchActionOutput the Architect task, state or action output where the new action should be added.
name
string <optional>
the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction
ArchBaseAction <optional>
the previous Architect action in the task, state or action output where the new action should be added. If undefined, the new action will be appended to the task or action output.
Returns:
ArchActionWaitForInput -
isFilterMatch(archFilterObject) → {boolean}
-
Returns whether or not this Architect Scripting object is a match for the supplied ArchFilterObject instance.
Parameters:
Name Type Description archFilterObject
ArchFilterObject the object filter to use to determine if it's a match.
Returns:
boolean- Inherited From:
-
logError(errorStr)
-
Logs an error to the logging service with a log header from this object's
logStr
property value whenArchLogging#logErrors
is true.Parameters:
Name Type Description errorStr
string the error string to log.
- Inherited From:
-
logErrorAndThrow(errorStr)
-
Logs an error to the logging service with a log header from this object's
logStr
property value whenArchLogging#logErrors
is true and then throws the string in the errorStr parameter.Parameters:
Name Type Description errorStr
string the error string to log. This should be a non-blank string.
Throws:
- Throws the submitted error string.
- Inherited From:
-
logNote(noteStr)
-
Logs a note to the logging service with a log header from this object's
logStr
property value whenArchLogging#logNotes
is true.Parameters:
Name Type Description noteStr
string the note string to log. This should be a non-blank string.
- Inherited From:
-
logNoteVerbose(noteStr)
-
Logs a note to the logging service with a log header from this object's
logStr
property value whenArchLogging#logNotesVerbose
is true.Parameters:
Name Type Description noteStr
string the note string to log. This should be a non-blank string.
- Inherited From:
-
logWarning(warningStr)
-
Logs a warning to the logging service with a log header from this object's
logStr
property value whenArchLogging#logWarnings
is true.Parameters:
Name Type Description warningStr
string the warning string to log. This should be a non-blank string.
- Inherited From: