Extends

• ArchBaseActionBotWithSessionVariables

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchActionCallAudioConnector'.

readonly audioConnectorOutputsFailure :ArchNamedValueList

The contents of this named value list come from the Failure Outputs schema. It will contain two values: errorType and errorMessage. These values will be returned by the server if the action takes the Failure path.

readonly connectorId :ArchValueString

The connector identifier for the Audio Connector integration.

readonly isArchActionCallAudioConnector :boolean

Returns true indicating that this is an ArchActionCallAudioConnector instance.

readonly outputSuccess :ArchActionOutput

The success output for this action

readonly sessionVariableOutputs :ArchBaseNameValuePairs

Returns the output Session Variables configured on the action. If you are looking for the input Session Variables, see ArchBaseActionBot#sessionVariables.

readonly sessionVariables :ArchBaseNameValuePairs

Returns the input Session Variables configured on the action.

Inherited From:

• ArchBaseActionBotWithSessionVariables#sessionVariables

Methods

addSessionVariableNameValuePair(nameLiteralopt, valueExpressionopt) → {ArchBaseNameValuePair}

This adds a session variable name value pair to the Base Bot action that can be used to specify the session variable's name and corresponding value that should be assigned to it. On the returned ArchBaseNameValuePair pair:

• the name property specifies the name of the session variable whose value you want to set
• the value property is the value to set on the session variable at runtime.

Parameters:

Name	Type	Attributes	Description
nameLiteral	string	<optional>	a string that specifies the name of the session variable to set.
valueExpression	string	<optional>	a string expression that specifies the value to set on the session variable.

Returns:

ArchBaseNameValuePair

Inherited From:

• ArchBaseActionBotWithSessionVariables#addSessionVariableNameValuePair

addSessionVariableOutputNameValuePair(nameLiteralopt, outputVariableopt) → {ArchBaseNameValuePair}

This adds an output session name value pair to the Call Audio Connector action that is used to specify the output session property name to retrieve and the corresponding output variable where the value should be stored at runtime. On the returned ArchBaseNameValuePair:

• the name property specifies the name of the output session property whose value you want to retrieve
• the value property is an output string value property that specifies the string variable where the runtime value of the output session property will be stored.

Parameters:

Name	Type	Attributes	Description
nameLiteral	string	<optional>	a string that specifies the name of the output session property to retrieve.
outputVariable	string | ArchBaseVariable	<optional>	the variable that should hold the value of the session output variable at runtime. For example -> "Flow.MyStringVar"

Returns:

ArchBaseNameValuePair

setAudioConnectorByIdAsync(audioConnectorId, callbackFunctionopt) → {Promise.<ArchActionCallAudioConnector>}

This sets the Audio Connector bot to call at runtime by its identifier.

Parameters:

Name	Type	Attributes	Description
audioConnectorId	string		the identifier of the Audio Connector bot.
callbackFunction	function	<optional>	a callback function to call if the Audio Connector is successfully looked up and configured on this action. The first parameter passed to the callback function will be this Architect Call Audio Connector action instance.

Returns:

Promise.<ArchActionCallAudioConnector>

setAudioConnectorByNameAsync(audioConnectorName, callbackFunctionopt) → {Promise.<ArchActionCallAudioConnector>}

This sets the Audio Connector bot to call at runtime by its name.

Parameters:

Name	Type	Attributes	Description
audioConnectorName	string		the name of the Audio Connector bot.
callbackFunction	function	<optional>	a callback function to call if the Audio Connector is successfully looked up and configured on this action. The first parameter passed to the callback function will be this Architect Call Audio Connector action instance.

Returns:

Promise.<ArchActionCallAudioConnector>