Extends

• ArchBaseAction

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchActionHoldMusic'.

readonly bargeInEnabled :ArchValueBoolean

Whether or not the action should accept barge-in input while the hold music is playing.

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 isArchActionHoldMusic :boolean

Returns true indicating that this is an ArchActionHoldMusic 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

readonly playDuration :ArchValueDuration

The duration for which to play the prompt set on the hold music action. This only applies at runtime if the play style is set to 'duration'

playStyle :string

The play style set on this hold music action. The string values in ArchEnums#HOLD_MUSIC_PLAY_STYLES lists valid hold music play style values.

readonly prompt :ArchValuePrompt

The prompt to play in the hold music action.

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