Extends

• ArchBaseActionBot

Members

static, readonly draftEnvironmentName :string

Returns the string 'Draft', which is the name for the Draft environment on a Dialogflow agent

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

environment :string

Returns the environment selected to be used when calling the selected Agent.

readonly eventName :ArchValueString

The initial event name to pass in to the Dialogflow agent.

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

integrationName :string

Returns the integration name for the currently selected Dialogflow agent.

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 isArchBaseActionDialogflow :boolean

Returns true indicating that this is an ArchBaseActionDialogflow instance.

readonly sessionVariables :ArchBaseNameValuePairs

Returns the input Session Variables configured on the action.

Inherited From:

• ArchBaseActionBotWithSessionVariables#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

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

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

setDialogflowAgentByIdAsync(dialogflowAgentId, callbackFunctionopt) → {Promise.<ArchBaseActionDialogflow>}

This sets the Dialogflow agent to call at runtime by its identifier. The Draft environment will be selected when calling this function.

Parameters:

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

Returns:

Promise.<ArchBaseActionDialogflow>

setDialogflowAgentByIdWithEnvironmentAsync(dialogflowAgentId, environmentName, callbackFunctionopt) → {Promise.<ArchBaseActionDialogflow>}

This sets the Dialogflow agent to call at runtime by its identifier and sets the environment to use by its name.

Parameters:

Name	Type	Attributes	Description
dialogflowAgentId	string		the identifier of the Dialogflow agent
environmentName	string		the name of the Dialogflow agent's environment to use. If no value is passed, 'Draft' will be used.
callbackFunction	callbackArchBaseActionDialogflow	<optional>	a callback function to call if the Dialogflow agent is successfully looked up and configured on this action. The first parameter passed to the callback function will be this Architect Call Dialogflow Bot action instance.

Returns:

Promise.<ArchBaseActionDialogflow>

setDialogflowAgentByNameAsync(agentName, projectIdopt, callbackFunctionopt, integrationNameopt) → {Promise.<ArchBaseActionDialogflow>}

This sets the Dialogflow agent to call at runtime by its name. The Draft environment will be selected when calling this function.

Parameters:

Name	Type	Attributes	Description
agentName	string		the name of the Dialogflow agent to set.
projectId	string	<optional>	optional parameter for filtering by the agent's project ID.
callbackFunction	callbackArchBaseActionDialogflow	<optional>	a callback function to call if the Dialogflow agent is successfully looked up and configured on this action. The first parameter passed to the callback function will be this Architect Call Dialogflow Bot action instance.
integrationName	string	<optional>	optional parameter for filtering by the agent's integration name.

Returns:

Promise.<ArchBaseActionDialogflow>

setDialogflowAgentByNameWithEnvironmentAsync(agentName, environmentName, projectIdopt, callbackFunctionopt, integrationNameopt) → {Promise.<ArchBaseActionDialogflow>}

This sets the Dialogflow agent to call at runtime by its name and sets the environment to use by its name.

Parameters:

Name	Type	Attributes	Description
agentName	string		the name of the Dialogflow agent to set.
environmentName	string		the name of the Dialogflow agent's environment to use. If no value is passed, 'Draft' will be used.
projectId	string	<optional>	optional parameter for filtering by the agent's project ID.
callbackFunction	callbackArchBaseActionDialogflow	<optional>	a callback function to call if the Dialogflow agent is successfully looked up and configured on this action. The first parameter passed to the callback function will be this Architect Call Dialogflow Bot action instance.
integrationName	string	<optional>	optional parameter for filtering by the agent's integration name.

Returns:

Promise.<ArchBaseActionDialogflow>