Extends

• ArchSettingsBotFlow

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchSettingsVoiceSurveyFlow'.

readonly id :string

The identifier string for this object.

Overrides:

• ArchSettingsBotFlow#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:

• ArchSettingsBotFlow#idMayBeBlank

See:

• ArchBaseCoreObjectWithId#id

readonly isArchBaseCoreObject :boolean

Returns true indicating that this is an ArchBaseCoreObject instance.

Overrides:

• ArchSettingsBotFlow#isArchBaseCoreObject

readonly isArchSettingsBotFlow :boolean

Returns true indicating that this is an ArchSettingsBotFlow instance.

Overrides:

• ArchSettingsBotFlow#isArchSettingsBotFlow

readonly isArchSettingsVoiceSurveyFlow :boolean

Returns true indicating that this is an ArchSettingsVoiceSurveyFlow instance.

readonly logStr :string

Returns a string suitable for logging that describes this bot flow settings instance.

Overrides:

• ArchSettingsBotFlow#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:

• ArchSettingsBotFlow#logStrTypeOnly

readonly surveyFormId :string

Returns the id of the survey form that is configured on the Voice Survey flow.

readonly surveyFormName :string

Returns the name of the survey form that is configured on the Voice Survey flow.

virtualAgentEnabled :boolean

Whether Virtual Agent functionality is enabled for this flow. Remember after enabling Virtual Agent functionality by setting this property to true, a flow needs to be published for Virtual Agent functionality to be used at flow runtime.

Overrides:

• ArchSettingsBotFlow#virtualAgentEnabled

Methods

getAnswerOptionsForSurveyQuestionText(questionText) → {ArchValueSurveyAnswerOptionCollection}

Returns the [answer option collection]{ArchValueSurveyAnswerOptionCollection} for the specified question text found within the survey form configured on the flow. The lookup is performed in a case sensitive manner. If the answer options cannot be found by the supplied question text, nothing is returned.

Parameters:

Name	Type	Description
questionText	string	the question text to look up

Returns:

• -

  ArchValueSurveyAnswerOptionCollection

• ArchValueSurveyAnswerOptionCollection

getDynamicSlotTypeSettingsByName(dynamicSlotTypeName) → {ArchSettingsNluDynamicSlotType}

Given a dynamic slot type name, this returns the ArchSettingsNluDynamicSlotType object for that dynamic slot type. This name lookup is case insensitive. If the dynamic slot type cannot be found, nothing is returned.

Parameters:

Name	Type	Description
dynamicSlotTypeName	string	the name of the dynamic slot type to find. This method will throw if the supplied dynamic slot type name value is null or undefined.

Returns:

ArchSettingsNluDynamicSlotType

Overrides:

• ArchSettingsBotFlow#getDynamicSlotTypeSettingsByName

getDynamicTimeslotTypeSettingsByName(dynamicTimeslotTypeName) → {ArchSettingsNluDynamicTimeslotType}

Given a dynamic timeslot slot type name, this returns the ArchSettingsNluDynamicTimeslotType object for that dynamic slot type. This name lookup is case insensitive. If the dynamic timeslot type cannot be found, nothing is returned.

Parameters:

Name	Type	Description
dynamicTimeslotTypeName	string	the name of the dynamic timeslot type to find. This method will throw if the supplied dynamic slot type name value is null or undefined.

Returns:

ArchSettingsNluDynamicTimeslotType

Overrides:

• ArchSettingsBotFlow#getDynamicTimeslotTypeSettingsByName

getIntentSettingsByIntentName(intentName) → {ArchSettingsNluIntent}

Given an intent name, this returns the ArchSettingsNluIntent object for that intent. This name lookup is case sensitive. If the intent cannot be found, nothing is returned.

Parameters:

Name	Type	Description
intentName	string	the name of the intent to find. This method will throw if the supplied intent name value is null or undefined.

Returns:

ArchSettingsNluIntent

Overrides:

• ArchSettingsBotFlow#getIntentSettingsByIntentName

getSlotSettingsBySlotName(slotName) → {ArchSettingsNluSlot}

Given a slot name, this returns the ArchSettingsNluSlot object for that slot. This name lookup is case sensitive. If the slot cannot be found, nothing is returned.

Parameters:

Name	Type	Description
slotName	string	the name of the slot to find. This method will throw if the supplied slot name value is null or undefined.

Returns:

ArchSettingsNluSlot

Overrides:

• ArchSettingsBotFlow#getSlotSettingsBySlotName

getSurveyQuestionsForSurveyForm() → {Array.<string>}

Returns an array of question text strings that are valid questions for the survey form configured on the flow.

Returns:

Array.<string>

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:

• ArchSettingsBotFlow#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:

• ArchSettingsBotFlow#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:

• ArchSettingsBotFlow#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:

• ArchSettingsBotFlow#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:

• ArchSettingsBotFlow#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:

• ArchSettingsBotFlow#logWarning

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:

• ArchSettingsBotFlow#traverse