Extends

• ArchBaseActionDialogflow

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchActionCallDialogflowCxBot'.

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.

Inherited From:

• ArchBaseActionDialogflow#dialogflowOutputsFailure

environment :string

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

Inherited From:

• ArchBaseActionDialogflow#environment

readonly eventName :ArchValueString

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

Inherited From:

• ArchBaseActionDialogflow#eventName

integrationName :string

Returns the integration name for the currently selected Dialogflow agent.

Inherited From:

• ArchBaseActionDialogflow#integrationName

readonly isArchActionCallDialogflowCxBot :boolean

Returns true indicating that this is an ArchActionCallDialogflowCxBot instance.

readonly isArchBaseActionDialogflow :boolean

Returns true indicating that this is an ArchBaseActionDialogflow instance.

Inherited From:

• ArchBaseActionDialogflow#isArchBaseActionDialogflow

readonly liveAgentHandoffMetadata :ArchBaseNameValuePairs

Returns the Live Agent Handoff Metadata output data configured on the action.

readonly outputSuccess :ArchActionOutput

The success output for this action

readonly sessionParameterOutputs :ArchBaseNameValuePairs

Returns the output Session Parameters configured on the action. If you are looking for the input Session Parameters, see ArchActionCallDialogflowCxBot#sessionParameters.

readonly sessionParameters :ArchBaseNameValuePairs

Returns the input Session Parameters configured on the action. This property returns the same value as ArchBaseActionBot#sessionVariables and exists because Session Variables are called Session Parameters in Dialogflow CX.

Methods

getOutputByIntentName(intentName)

This function will always throw an error. While it is supported on other ArchBaseActionBot subclasses, the Call Dialogflow CX Bot action does not support mapping intents to outputs.

Parameters:

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

Throws:

Error

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>

Inherited From:

• ArchBaseActionDialogflow#setDialogflowAgentByIdAsync

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>

Inherited From:

• ArchBaseActionDialogflow#setDialogflowAgentByIdWithEnvironmentAsync

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>

Inherited From:

• ArchBaseActionDialogflow#setDialogflowAgentByNameAsync

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>

Inherited From:

• ArchBaseActionDialogflow#setDialogflowAgentByNameWithEnvironmentAsync