Extends

• ArchBaseActionBot

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchActionCallNuanceMixBot'.

readonly availableChannelIds :Array.<string>

Returns an array of available Nuance bot channels for the currently-selected Nuance bot that are applicable for the flow type in which the action resides. If a Nuance bot is not selected or no Nuance bot channels are available an empty array is returned.

readonly botVariables :ArchNamedValueList

The collection of Bot Variables that can be used in this bot. To access a variable, you can use the getNamedValueByName function on this property and pass in the name of the variable you want to access.

channelId :ArchValueString

Returns the channel ID to be used when calling the bot.

readonly followupResponseTimeout :ArchValueDuration

Specifies the amount of time to wait for a user's response to a bot prompt. A negative or NOT_SET duration will be treated as immediate.

Inherited From:

• ArchBaseActionBot#followupResponseTimeout

readonly inputText :ArchValueString

The input text for the bot. This is usually only set in flows when chaining bot actions together.

Inherited From:

• ArchBaseActionBot#inputText

readonly intentNames :Array.<string>

Returns a unique array of names of intents that are configured for the selected bot. This array contains intent names for the bot that will be executed at flow runtime. As such, for some bots like Lex bots, this requires selecting the Lex bot alias since intents are defined on the alias prior to this array being populated.

Inherited From:

• ArchBaseActionBot#intentNames

readonly intentSlots :ArchNamedValueList

The collection of intents and their slots into which variables can be assigned. To access an intent, you can use the getNamedValueByName function on this property and pass in the name of the intent you want to access. That intent will contain its slots, which you can access also via getNamedValueByName.

readonly isArchActionCallNuanceMixBot :boolean

Returns true indicating that this is an ArchActionCallNuanceMixBot instance.

readonly nuanceMixBotOutputsFailure :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.

Methods

addSessionParameterNameValuePair(nameLiteralopt, valueExpressionopt) → {ArchBaseNameValuePair}

This adds a session parameter name value pair to the Call Dialogflow CX Bot action that is used to specify the session parameter''s name and corresponding value that should be assigned to it. This function functions the same as ArchBaseActionBot#addSessionVariableNameValuePair and exists because Session Variables are called Session Parameters in Dialogflow CX. On the returned ArchBaseNameValuePair:

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

Parameters:

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

Returns:

ArchBaseNameValuePair

Inherited From:

• ArchBaseActionBot#addSessionParameterNameValuePair

getOutputByIntentName(intentName) → {ArchActionOutput}

This gets an action output for this action that matches an intent name. It will not return the built-in Failure output.

Parameters:

Name	Type	Description
intentName	string	the name of the intent whose matching output to find

Returns:

ArchActionOutput

Inherited From:

• ArchBaseActionBot#getOutputByIntentName

setBotByIdAsync(nuanceMixIntegrationId, nuanceMixBotId, callbackFunctionopt) → {Promise.<ArchActionCallNuanceMixBot>}

This sets the NuanceMixBot version to call at runtime using the NuanceMixBot integration ID, and bot ID.

Parameters:

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

Returns:

Promise.<ArchActionCallNuanceMixBot>

setBotByNameAsync(nuanceMixIntegrationName, nuanceMixBotName, callbackFunctionopt, applicationNameopt) → {Promise.<ArchActionCallNuanceMixBot>}

This sets the NuanceMixBot to call at runtime using the NuanceMixBot integration name, and bot name.

Parameters:

Name	Type	Attributes	Description
nuanceMixIntegrationName	string		the name of the NuanceMixBot integration.
nuanceMixBotName	string		the name of the NuanceMixBot bot.
callbackFunction	callbackArchActionCallNuanceMixBot	<optional>	a callback function to call if the NuanceMixBot is successfully looked up and configured on this action. The first parameter passed to the callback function will be this Architect Call NuanceMixBot action instance.
applicationName	string	<optional>	the application name of the Nuance Mix Bot. If supplied, the application name is compared case sensitively.

Returns:

Promise.<ArchActionCallNuanceMixBot>