Extends

• ArchBaseActionDialogflow

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchActionCallDialogflowBot'.

readonly _actionTypeId :string

Returns the action type identifier string from actionTypes.js

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.

Overrides:

• ArchBaseActionDialogflow#dialogflowOutputsFailure

readonly displayTypeNameArchitect :string

The Architect action type label

Overrides:

• ArchBaseActionDialogflow#displayTypeNameArchitect

environment :string

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

Overrides:

• ArchBaseActionDialogflow#environment

readonly eventName :ArchValueString

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

Overrides:

• ArchBaseActionDialogflow#eventName

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.

Overrides:

• ArchBaseActionDialogflow#followupResponseTimeout

readonly id :string

The identifier string for this object.

Overrides:

• ArchBaseActionDialogflow#id

readonly idMayBeBlank :string

Returns whether or not the id property may be blank or undefined for this object. For example, the returned settings from ArchMenu#settingsMenu will have a blank identifier along with the settings returned from ArchMenu#settingsSpeechRec. Note that this is an extremely rare case.

Overrides:

• ArchBaseActionDialogflow#idMayBeBlank

See:

• ArchBaseCoreObjectWithId#id

readonly inputText :ArchValueString

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

Overrides:

• ArchBaseActionDialogflow#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.

Overrides:

• ArchBaseActionDialogflow#intentNames

readonly intentParameters :ArchNamedValueList

The collection of intents and their parameters 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 parameters, which you can access also via getNamedValueByName.

readonly intentProbability :ArchValueDecimal

The confidence of the detected intent. If detected, the value will be >= 0.0 and <= 1.0. If no intent was detected, the value of the variable bound to this setting will remain untouched.

readonly isArchActionCallDialogflowBot :boolean

Returns true indicating that this is an ArchActionCallDialogflowBot instance.

readonly isArchBaseActionDialogflow :boolean

Returns true indicating that this is an ArchBaseActionDialogflow instance.

Overrides:

• ArchBaseActionDialogflow#isArchBaseActionDialogflow

readonly isArchBaseCoreObject :boolean

Returns true indicating that this is an ArchBaseCoreObject instance.

Overrides:

• ArchBaseActionDialogflow#isArchBaseCoreObject

readonly isMenuChoiceAction :boolean

Returns whether or not this action is the action property for a menu choice. For example, the ArchMenuDisconnect#actionDisconnect property on an ArchMenuDisconnect instance.

Overrides:

• ArchBaseActionDialogflow#isMenuChoiceAction

readonly isReachable :boolean

Returns whether or not this action is reachable at runtime.

Overrides:

• ArchBaseActionDialogflow#isReachable

readonly isSecure :boolean

Returns whether or not this action is secure which means either the action by its very nature is secure or it consumes secure data.

Overrides:

• ArchBaseActionDialogflow#isSecure

readonly isUnreachable :boolean

Returns whether or not this action is unreachable at runtime.

Overrides:

• ArchBaseActionDialogflow#isUnreachable

readonly liveAgentHandoffMetadata :ArchBaseNameValuePairs

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

readonly logStr :string

A string suitable for logging that contains information about this action. This will contain the action tracking id, name and scripting type name.

Overrides:

• ArchBaseActionDialogflow#logStr

readonly logStrTypeOnly :string

This is a string suitable for logging information about this object where it's just the object's type. This is normally used when logging errors that occur in constructor parameter checking because the scripting object isn't set up and the normal logging str contents wouldn't be set up.

Overrides:

• ArchBaseActionDialogflow#logStrTypeOnly

name :string

The name of the action

Overrides:

• ArchBaseActionDialogflow#name

readonly outputCount :number

Returns the number of outputs on this action. For actions that have a fake success output like what you see on the various transfer actions, that will be included in the count to be consistent with the Architect UI. Attempting to get the output count on a menu choice's action such as such as the ArchMenuTransferToAcd#actionTransferToAcd action on an ArchMenuTransferToAcd menu will return 0.

Overrides:

• ArchBaseActionDialogflow#outputCount

readonly outputFailure :ArchActionOutput

The failure output for this action

Overrides:

• ArchBaseActionDialogflow#outputFailure

readonly outputs :Array.<ArchActionOutput>

Returns an array of action outputs for this action. Remember that it is possible to have an undefined item in the returned ArchActionOutput array. This is true when the output is "fake". Accessing the outputs on a menu choice's action such as ArchMenuTransferToAcd#actionTransferToAcd will return an empty array.

Overrides:

• ArchBaseActionDialogflow#outputs

readonly parentFlow :ArchBaseFlow

Returns the parent flow for this action.

Overrides:

• ArchBaseActionDialogflow#parentFlow

readonly parentMenuChoice :ArchBaseMenuChoice

Returns the parent menu choice if this action is the action for a menu choice. Otherwise, nothing is returned.

Overrides:

• ArchBaseActionDialogflow#parentMenuChoice

readonly parentState :ArchState

Returns the parent state that contains this action if this action is in a state. Otherwise, nothing is returned.

Overrides:

• ArchBaseActionDialogflow#parentState

readonly parentTask :ArchTask|ArchTaskLoop

Returns the parent task that contains this action if this action is in a task or looping task. Otherwise, nothing is returned.

Overrides:

• ArchBaseActionDialogflow#parentTask

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.

Overrides:

• ArchBaseActionDialogflow#sessionVariables

readonly trackingId :number

The integer tracking identifier for this action. This is the numeric identifier is displayed in the Architect user interface.

Overrides:

• ArchBaseActionDialogflow#trackingId

Methods

addLiveAgentHandoffMetadataNameValuePair(nameLiteralopt, outputVariableopt) → {ArchBaseNameValuePair}

This adds an output Live Agent Handoff Metadata name value pair to the Call Dialogflow CX Bot action that is used to specify the output Live Agent Handoff Metadata 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 Live Agent Handoff Metadata 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 Live Agent Handoff Metadata property will be stored.

Parameters:

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

Returns:

ArchBaseNameValuePair

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

Overrides:

• ArchBaseActionDialogflow#addSessionParameterNameValuePair

addSessionParameterOutputNameValuePair(nameLiteralopt, outputVariableopt) → {ArchBaseNameValuePair}

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

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

Overrides:

• ArchBaseActionDialogflow#addSessionVariableNameValuePair

addSessionVariableOutputNameValuePair(nameLiteralopt, outputVariableopt) → {ArchBaseNameValuePair}

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

getOutputById(output) → {ArchActionOutput}

Gets an output by its identifier. If it cannot be found, this method will throw. Normally you won't need to use this method and will use the helper methods available on inheriting classes when accessing pre-defined outputs like success, failure, timeout, etc. etc. Attempting to get an output by id on a menu choice's action such as the ArchMenuTransferToAcd#actionTransferToAcd action on an ArchMenuTransferToAcd menu will return nothing.

Parameters:

Name	Type	Description
output	string | ArchBranch	identifies output you want to obtain. If output is an ArchBranch instance, the ArchBranch#outputId value will be used. Otherwise valid string identifier values can be found in ArchEnums#OUTPUT_IDS or can be a guid. Remember that requesting the 'success' output on an action with a fake success output will return nothing.

Returns:

ArchActionOutput

Overrides:

• ArchBaseActionDialogflow#getOutputById

getOutputByIndex(index) → {ArchActionOutput}

Returns the output at the given index. It's important to note that on actions that have a fake success output if you request the output at the index for the fake success, you will get nothing returned because the fake success output isn't something that you should do anything with. Attempting to access an output by index on a menu choice's action such as ArchMenuTransferToAcd#actionTransferToAcd will return nothing.

Parameters:

Name	Type	Description
index	number	the index of the output to retrieve. This value should be a non-negative integer.

Returns:

ArchActionOutput

Overrides:

• ArchBaseActionDialogflow#getOutputByIndex

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

Overrides:

• ArchBaseActionDialogflow#getOutputByIntentName

getOutputByName(output, wantDynamicOutputopt) → {ArchActionOutput}

Gets an output by its identifier. If it cannot be found, this method will throw. Normally you won't need to use this method and will use the helper methods available on inheriting classes when accessing pre-defined outputs like success, failure, timeout, etc. etc. Attempting to get an output by id on a menu choice's action such as the ArchMenuTransferToAcd#actionTransferToAcd action on an ArchMenuTransferToAcd menu will return nothing.

Parameters:

Name	Type	Attributes	Default	Description
output	string | ArchBranch			identifies output you want to obtain by name. If output is an ArchBranch instance, the ArchBranch#name value will be used. Remember that requesting the 'Success' output on an action with a fake success output will return nothing. For non-dynamic outputs, the name should be specified in English.
wantDynamicOutput	boolean	<optional>	false	because it is possible for some actions to have both a non-dynamic output and a dynamic output with the same name, this boolean will let you specify which output you want. An example of this would be the built in Failure output on a call bot action but that bot also has an intent named Failure so the action has two outputs with the same name of 'Failure'. Only one of those would be a dynamic output and that's the output for the Failure intent, not the built-in Failure action output.

Returns:

ArchActionOutput

Overrides:

• ArchBaseActionDialogflow#getOutputByName

isFilterMatch(archFilterObject) → {boolean}

Returns whether or not this Architect Scripting object is a match for the supplied ArchFilterObject instance.

Parameters:

Name	Type	Description
archFilterObject	ArchFilterObject	the object filter to use to determine if it's a match.

Returns:

boolean

Overrides:

• ArchBaseActionDialogflow#isFilterMatch

logError(errorStr)

Logs an error to the logging service with a log header from this object's logStr property value when ArchLogging#logErrors is true.

Parameters:

Name	Type	Description
errorStr	string	the error string to log.

Overrides:

• ArchBaseActionDialogflow#logError

logErrorAndThrow(errorStr)

Logs an error to the logging service with a log header from this object's logStr property value when ArchLogging#logErrors is true and then throws the string in the errorStr parameter.

Parameters:

Name	Type	Description
errorStr	string	the error string to log. This should be a non-blank string.

Throws:

• Throws the submitted error string.

Overrides:

• ArchBaseActionDialogflow#logErrorAndThrow

logNote(noteStr)

Logs a note to the logging service with a log header from this object's logStr property value when ArchLogging#logNotes is true.

Parameters:

Name	Type	Description
noteStr	string	the note string to log. This should be a non-blank string.

Overrides:

• ArchBaseActionDialogflow#logNote

logNoteVerbose(noteStr)

Logs a note to the logging service with a log header from this object's logStr property value when ArchLogging#logNotesVerbose is true.

Parameters:

Name	Type	Description
noteStr	string	the note string to log. This should be a non-blank string.

Overrides:

• ArchBaseActionDialogflow#logNoteVerbose

logWarning(warningStr)

Logs a warning to the logging service with a log header from this object's logStr property value when ArchLogging#logWarnings is true.

Parameters:

Name	Type	Description
warningStr	string	the warning string to log. This should be a non-blank string.

Overrides:

• ArchBaseActionDialogflow#logWarning

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>

Overrides:

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

Overrides:

• ArchBaseActionDialogflow#setDialogflowAgentByIdWithEnvironmentAsync

setDialogflowAgentByNameAsync(agentName, projectIdopt, callbackFunctionopt) → {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.

Returns:

Promise.<ArchBaseActionDialogflow>

Overrides:

• ArchBaseActionDialogflow#setDialogflowAgentByNameAsync

setDialogflowAgentByNameWithEnvironmentAsync(agentName, environmentName, projectIdopt, callbackFunctionopt) → {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.

Returns:

Promise.<ArchBaseActionDialogflow>

Overrides:

• ArchBaseActionDialogflow#setDialogflowAgentByNameWithEnvironmentAsync

traverse(callbackFunction, traverseFilteropt) → {number}

This method iterates over this object and ArchBaseCoreObject instances within it. For each object it will call the ArchBaseObject#isFilterMatch method with a filter and call the supplied callback function if isMatch returns true. The callback will be passed an ArchTraverseInfo with details about the match such as the match object itself along with current contextual information such as the object hierarchy for the match object relative to the object on which this traverse call is being made.

The traverse filter is one which you can create by calling ArchFactoryFilters#createFilterObject and then add desired clauses or clause containers to it. If not specified, this function will use a default filter.

Here is an example that does a simple flow traversal using the default filter and logs information about objects in the callback from the traverse object that's passed back:

archInboundCallFlow.traverse(function(traverseInfo) {
   archLogging.logNote('  Object     : ' + traverseInfo.matchObject.logStr);
   archLogging.logNote('    Hierarchy: ' + traverseInfo.context.hierarchyStr);
});

This might be enough for most uses and you can check various aspects about the object in the callback such as "is this an Architect action?" by seeing if traverseInfo.matchObject.isArchBaseAction is true. You can specify a filter for the traversal code to use as well and only have it call your callback when the object's ArchBaseCoreObject#isFilterMatch method returns true for the filter. Here's an example that creates a filter for callbacks on any type of transfer action, any decision action or objects whose name property case insensitively matches the word 'foo'. While this could all be done with one property callback clause the example will use multiple clauses for the sake of simplicity:

const myTraverseFilter = filterFactory.createFilterObject(archEnums.FILTER_CONTAINER_OPERATORS.or);
myTraverseFilter.addClausePropertyValueEquals('isArchBaseActionTransfer', true);
myTraverseFilter.addClausePropertyValueEquals('isArchActionDecision',     true);
myTraverseFilter.addClausePropertyCallback('name', function(propValue, archContainingObject, propName) {
      // We fully spelled out the function signature above but archContainingObject and propName are
      // not needed in this case.  The archContainingObject is the object that contains the
      // property and propName is the property name itself.  We pass in propName because the same
      // function could be used for multiple property callback clauses.
      // Remember to return a boolean true, false or undefined from ths callback.  :)
      return propValue && propValue.toLowerCase() === 'foo';
});
archTask.traverse(function(traverseContext) {
   // You will only be called back here for ArchBaseCoreObject instances that
   // have the isArchBaseActionTransfer or isArchActionDecision property values equal to true.
}, myTraverseFilter);

If you supply a filter with no clauses, this tells the traverse method to call the supplied callback function for every ArchBaseCoreObject it traverses.

If you want traversal itself to stop after a callback, simply return boolean false from the callback function you supply to the traverse call.

The traverse method does not process deprecated property names such as orgId, orgName or languageSettings. Additionally it does not traverse in to properties that would "jump out" of the current traversal. An example of this would be if the code was traversing an ArchActionJumpToMenu action that it would not start traversing in to the menu that it jumps to. Another example would be a ArchActionChangeState action where it would not traverse in to the target state of the action. This also means traversal does not traverse in to the ArchBaseValue#flowLevelDefault property.

And lastly, as Scripting evolves over time with new versions, you can expect to get callbacks for new object types such as new actions or new properties on objects. As such, it's important not to assume any particular order in callbacks to keep code most compatible with traversal callbacks. Or if you use inequality checks in filter clauses remember that new "stuff" may satisfy an inequality check which may or may not be anticipated in your logic.

Note: This traverse method is a helper method and is very handy for iterating over Architect Scripting objects and their properties in a generic fashion with filtering capabilities. Obviously you can write your own custom traversal code if this implementation doesn't cut it for some reason. :)

This function returns the number of times it called the callback function.

Parameters:

Name	Type	Attributes	Default	Description
callbackFunction	callbackTraverseInfo			the callback function to call for objects that match the traverse filter.
traverseFilter	ArchFilterObject	<optional>	ArchFactoryFilters#createFilterTraverseDefault	the filter to use when performing the traversal to determine which ArchBaseCoreObject instances you wish to be called back for. If no filter is specified, this function will call ArchFactoryFilters#createFilterTraverseDefault and use that traversal default filter. The wantArchBaseValues parameter on that call is set to true.

Returns:

number

Overrides:

• ArchBaseActionDialogflow#traverse