Extends

• ArchBaseActionWithOutputsSuccessFailure

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchActionCollectInput'.

readonly acceptJustPound :ArchValueBoolean

Whether or not the input collection will accept a single '*' character as well as numeric digits.

readonly acceptJustStar :ArchValueBoolean

Whether or not the input collection will accept a single '*' character as well as numeric digits.

readonly inputAudio :ArchAudio

The input audio for the collect input action. This is the audio that will be used to prompt the caller for their input.

readonly interDigitTimeout :ArchValueDuration

The inter-digit timeout duration. This property has a flow-level default.

readonly isArchActionCollectInput :boolean

Returns true indicating that this is an ArchActionCollectInput instance.

readonly noEntryTimeout :ArchValueDuration

The duration associated with the no entry timeout setting on the action. This property has a flow-level default.

readonly outputSuccess :ArchActionOutput

The success output for this action

Inherited From:

• ArchBaseActionWithOutputsSuccessFailure#outputSuccess

readonly valueVariableInputData :ArchValueString

The value that will hold the variable that receives the user entered input at runtime.

readonly verificationAudio :ArchAudio

The verification audio for the collect input action. This is the audio that will be used to verify the caller's input.

verificationType :string

The verification type set on the collect input action. The string values in ArchEnums#INPUT_VERIFICATION_TYPES lists valid values.

Methods

setDigitsExact(digitCount)

Sets the exact number of digits to collect on the collect input action.

Parameters:

Name	Type	Description
digitCount	number	the digit count which must be an integer that is >=1 and <= 40.

setDigitsRange(minDigitCount, maxDigitCount, terminatingDtmfopt, includeTerminatingDtmfWithInputDataopt)

Sets the range of digits to collect.

Parameters:

Name	Type	Attributes	Default	Description
minDigitCount	number			the minimum number of digits to collect. It must be an integer that is >=1 and <= 40.
maxDigitCount	number			the maximum number of digits to collect. It must be an integer that is >=1 and <= 40.
terminatingDtmf	string | number	<optional>		the terminating dtmf. Valid values are integers 0 through 9, strings '0' through '9', '*' or '#'.
includeTerminatingDtmfWithInputData	boolean	<optional>	false	whether or not to include the terminating digit in the result input data variable if pressed.

setInputDataVariable(inputDataVariable)

Helper method to set a variable on the valueVariableInputData property.

Parameters:

Name	Type	Description
inputDataVariable	string | ArchVariableString	the variable to hold the caller entered data