Extends

• ArchBaseAction

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchActionPlayEstimatedWaitTime'.

readonly displayTypeName :string

Returns the display type name string 'ArchBaseAction'.

Overrides:

• ArchBaseAction#displayTypeName

readonly displayTypeNameArchitect :string

The Architect action type label

Inherited From:

• ArchBaseAction#displayTypeNameArchitect

readonly estimatedWaitTime :ArchValueDuration

The duration value that specifies the estimated wait time for the caller in the queue.

estimatedWaitTimeAudio :ArchAudio

The audio expression for the audio that informs the external participant on the call of their estimated wait time based on the action settings. You cannot set the audio in this expression directly.

readonly isArchActionPlayEstimatedWaitTime :boolean

Returns true indicating that this is an ArchActionPlayEstimatedWaitTime instance.

readonly isArchBaseAction :boolean

A property that can be checked to verify the scripting object is a type of ArchBaseAction

Inherited From:

• ArchBaseAction#isArchBaseAction

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.

Inherited From:

• ArchBaseAction#isMenuChoiceAction

readonly isReachable :boolean

Returns whether or not this action is reachable at runtime.

Inherited From:

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

Inherited From:

• ArchBaseAction#isSecure

readonly isUnreachable :boolean

Returns whether or not this action is unreachable at runtime.

Inherited From:

• ArchBaseAction#isUnreachable

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.

Inherited From:

• ArchBaseAction#logStr

name :string

The name of the action

Inherited From:

• ArchBaseAction#name

readonly parentFlow :ArchBaseFlow

Returns the parent flow for this action.

Inherited From:

• ArchBaseAction#parentFlow

readonly parentMenuChoice :ArchBaseMenuChoice

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

Inherited From:

• ArchBaseAction#parentMenuChoice

readonly parentState :ArchState

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

Inherited From:

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

Inherited From:

• ArchBaseAction#parentTask

playbackMode :string

The playback mode for the estimated wait time. The string values in ArchEnums#PLAY_ESTIMATED_WAIT_STYLES lists valid values.

readonly roundingInterval :ArchValueDuration

This option is available if the playback mode is set to either $ArchEnums#PLAY_ESTIMATED_WAIT_STYLES.about or ArchEnums#PLAY_ESTIMATED_WAIT_STYLES.lessThan modes. Select the amount of time in which to calculate estimated wait time and return approximate or less than calculations. Architect rounds up the estimated wait time to the selected threshold in even minutes. This property is the same as either the "Padding" or "Round Up Interval" in the Architect UI.

readonly specificRoundingIntervals :Array.<ArchValueDuration>

A snapshot of the specific rounding intervals for the play estimated wait time action. Each item contained within this array is an ArchValueDuration. Items in this array can be modified and the changes will be reflected appropriately for the action. To add a new specific rounding interval to the play estimated wait time action, use the addSpecificRoundingInterval function. ArchActionPlayEstimatedWaitTime#getSpecificRoundingIntervalByIndex can also be called to get a specific rounding interval which can then be modified. To remove a specific rounding interval from this array, use the ArchActionPlayEstimatedWaitTime#deleteSpecificRoundingIntervalByIndex function. Remember, this is a snapshot of intervals returned at the time this was called and modifying the array itself will not reflect changes on the action.

readonly specificRoundingIntervalsCount :number

The number of specific rounding intervals configured for the play estimated wait time action.

readonly supportsSpecificRoundingIntervals :boolean

Returns whether the play estimated wait time action supports specific rounding intervals based on the playback mode that is set.

readonly trackingId :number

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

Inherited From:

• ArchBaseAction#trackingId

Methods

addSpecificRoundingInterval() → {ArchValueDuration}

Adds a new rounding interval to the play estimated wait time action. This function will throw an error if the playback mode is set to ArchEnums#PLAY_ESTIMATED_WAIT_STYLES.range or ArchEnums#PLAY_ESTIMATED_WAIT_STYLES.exact since specific rounding intervals are not supported on those playback modes. The returned value is the new specific rounding interval of type ArchValueDuration which can then be modified.

Returns:

ArchValueDuration

deleteSpecificRoundingIntervalByIndex(index)

Removes a specific rounding interval from the play estimated wait time action at the specified index.

Parameters:

Name	Type	Description
index	number	the zero based index of the specific rounding interval to delete. This value should be a non-negative integer. For example: for the first specific rounding interval, pass in 0.

getSpecificRoundingIntervalByIndex(index) → {ArchValueDuration}

Returns a specific rounding interval from the play estimated wait time action at the specified index.

Parameters:

Name	Type	Description
index	number	the zero based index of the specific rounding interval to delete. This value should be a non-negative integer. For example: for the first specific rounding interval, pass in 0.

Returns:

ArchValueDuration