Extends

• ArchBaseActionWithOutputsSuccessFailureTimeout

Members

readonly displayTypeName :string

Returns the display type name string 'ArchActionCallGuide'.

readonly guideInputs :ArchNamedValueList

Inputs for the call Guide action

readonly guideOutputs :ArchNamedValueList

Outputs for the call Guide action

readonly guideOutputsFailure :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 isArchActionCallGuide :boolean

Returns true indicating that this is an ArchActionCallGuide instance.

readonly outputTimeout :ArchActionOutput

The timeout output for this action

Inherited From:

• ArchBaseActionWithOutputsSuccessFailureTimeout#outputTimeout

readonly voiceProcessingPrompt :ArchValueCommunication

The voice processing prompt communication for the Call Guide action.

Methods

setGuideByIdAsync(guideId, callbackFunctionopt) → {Promise.<ArchActionCallGuide>}

This sets the guide that will be used by the guide identifier.

Parameters:

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

Returns:

Promise.<ArchActionCallGuide>

setGuideByNameAsync(guideName, callbackFunctionopt) → {Promise.<ArchActionCallGuide>}

This sets the guide that will be used by the guide name.

Parameters:

Name	Type	Attributes	Description
guideName	string		the name of the Guide to set.
callbackFunction	function	<optional>	a callback function to call if the Guide is successfully looked up and configured on this action. The first parameter passed to the callback function will be this Architect call guide action instance.

Returns:

Promise.<ArchActionCallGuide>