Extends

• ArchBaseActionBot

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchActionCallBotConnector'.

readonly botConnectorOutputsFailure :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 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 isArchActionCallBotConnector :boolean

Returns true indicating that this is an ArchActionCallBotConnector instance.

readonly sessionVariableOutputs :ArchBaseNameValuePairs

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

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

addSessionVariableOutputNameValuePair(nameLiteralopt, outputVariableopt) → {ArchBaseNameValuePair}

This adds an output session name value pair to the Call Bot 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

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(botConnectorIntegrationId, botConnectorBotId, botConnectorBotVersionId, callbackFunctionopt) → {Promise.<ArchActionCallBotConnector>}

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

Parameters:

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

Returns:

Promise.<ArchActionCallBotConnector>

setBotByNameAsync(botConnectorIntegrationName, botConnectorBotName, botConnectorBotVersionId, callbackFunctionopt) → {Promise.<ArchActionCallBotConnector>}

This sets the Bot Connector version to call at runtime using the Bot Connector integration name, bot name, and version ID.

Parameters:

Name	Type	Attributes	Description
botConnectorIntegrationName	string		the name of the Bot Connector integration.
botConnectorBotName	string		the name of the Bot Connector bot.
botConnectorBotVersionId	string		the identifier of the Bot Connector version.
callbackFunction	callbackArchActionCallBotConnector	<optional>	a callback function to call if the Bot Connector version is successfully looked up and configured on this action. The first parameter passed to the callback function will be this Architect Call Bot Connector action instance.

Returns:

Promise.<ArchActionCallBotConnector>