new ArchActionPlayPositionInQueue(corePlayPositionInQueueActionViewModel)
The Architect Scripting class that represents the Play Position in Queue action.
Instances of this action should be created by calling ArchFactoryActions#addActionPlayPositionInQueue
Parameters:
| Name | Type | Description |
|---|---|---|
corePlayPositionInQueueActionViewModel |
Object | ( Internal ) an Architect core play position in queue action view model. |
Extends
Members
-
static, readonly displayTypeName :string
-
Returns the display type name string 'ArchActionPlayPositionInQueue'.
-
readonly displayTypeName :string
-
Returns the display type name string 'ArchBaseAction'.
- Overrides:
-
readonly displayTypeNameArchitect :string
-
The Architect action type label
- Inherited From:
-
readonly isArchActionPlayPositionInQueue :boolean
-
Returns true indicating that this is an ArchActionPlayPositionInQueue instance.
-
readonly isArchBaseAction :boolean
-
A property that can be checked to verify the scripting object is a type of ArchBaseAction
- Inherited From:
-
readonly isMenuChoiceAction :boolean
-
Returns whether or not this action is the action property for a
menu choice. For example, theArchMenuDisconnect#actionDisconnectproperty on anArchMenuDisconnectinstance.- Inherited From:
-
readonly isReachable :boolean
-
Returns whether or not this action is reachable at runtime.
- Inherited From:
-
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:
-
readonly isUnreachable :boolean
-
Returns whether or not this action is unreachable at runtime.
- Inherited From:
-
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:
-
name :string
-
The name of the action
- Inherited From:
-
readonly parentFlow :ArchBaseFlow
-
Returns the parent flow for this action.
- Inherited From:
-
readonly parentMenuChoice :ArchBaseMenuChoice
-
Returns the parent menu choice if this action is the action for a
menu choice. Otherwise, nothing is returned.- Inherited From:
-
readonly parentState :ArchState
-
Returns the parent state that contains this action if this action is in a
state. Otherwise, nothing is returned.- Inherited From:
-
readonly parentTask :ArchTask|ArchTaskLoop
-
Returns the parent task that contains this action if this action is in a
taskorlooping task. Otherwise, nothing is returned.- Inherited From:
-
playbackMode :string
-
The playback mode for the position in queue action. The string values in
ArchEnums#PLAY_POSITION_STYLESlists valid play position values. -
readonly positionInQueue :ArchValueInteger
-
The integer value that specifies the position for the caller in the queue that will be read back. Remember, if this value is a NOT_SET integer then no audio will be played back to the caller.
-
readonly positionInQueueAudio :ArchAudio
-
The audio expression for the audio that informs the external participant on the call of their position in queue based on the action settings. You cannot set the audio in this expression directly.
-
readonly trackingId :number
-
The integer tracking identifier for this action. This is the numeric identifier is displayed in the Architect user interface.
- Inherited From: