new ArchActionCallVoiceFlow(coreCallVoiceFlowAction)
The Architect Scripting class for Call Voice Flow action
Instances of this action should be created by calling ArchFactoryActions#addActionCallVoiceFlow
Parameters:
| Name | Type | Description |
|---|---|---|
coreCallVoiceFlowAction |
Object | ( Internal ) an Architect core Call Voice Flow action. |
- See:
-
- ArchFactoryActions#addActionCallVoiceFlow
Extends
Members
-
static, readonly botFlowTypeEnum :string
-
Returns the enum of the type of bot flow you can assign using
ArchBaseActionCallBotFlow#setTargetFlowInfoAsync -
static, readonly displayTypeName :string
-
Returns the display type name string 'ArchActionCallVoiceFlow'.
-
readonly exitReason :ArchValueString
-
The output value where you can set a string variable that will hold the exit reason returned from the bot flow instance invoked by this action.
- Inherited From:
-
readonly inputs :ArchNamedValueList
-
Inputs for the call Bot Flow action
- Inherited From:
-
readonly inputText :ArchValueString
-
The input text for the bot flow. Supplies an initial utterance to the bot that will be processed by the first Ask action executed in the bot flow.
- Inherited From:
-
readonly intent :ArchValueString
-
The output value where you can set a string variable that will hold the intent string returned from the bot flow instance invoked by this action. Remember that when invoking a bot flow that the flow does not have to return an intent so the bound variable could be set to a NOT_SET string by this action indicating that no intent was returned.
- Inherited From:
-
readonly isArchActionCallVoiceFlow :boolean
-
Returns true indicating that this is an ArchActionCallVoiceFlow instance.
-
readonly isArchBaseActionCallBotFlow :boolean
-
Returns true indicating that this is an ArchBaseActionCallBotFlow instance.
- Inherited From:
-
readonly outputs :ArchNamedValueList
-
Outputs for the call Bot Flow action
- Inherited From:
-
targetFlowInfo :ArchFlowInfoBasic
-
The target bot flow for this ArchBaseActionCallBotFlow instance that specifies the bot flow to call at runtime.
- Inherited From:
Methods
-
setTargetFlowInfoAsync(newValue, callbackFunctionopt) → {Promise.<ArchBaseActionCallBotFlow>}
-
The target bot flow to call for this ArchBaseActionCallBotFlow instance. Note that this function accepts either an
ArchFlowInfoor anArchFlowInfoBasicinstance. If the flow information supplied to the setter does not specify a bot flow, it will throw an exception. The type of bot flow specified must also match the type specified in the action instance's botFlowTypeEnum propertyParameters:
Name Type Attributes Description newValueArchFlowInfoBasic the
ArchFlowInfoBasicinstance of the flow to call for the ArchBaseActionCallBotFlow instance.callbackFunctionfunction <optional>
a callback function to call if the bot flow is successfully configured on this action. The first parameter passed to the callback function will be this Architect call bot flow action instance.
Returns:
Promise.<ArchBaseActionCallBotFlow>- Inherited From: