ArchActionSetWhisperAudio(coreSetWhisperAudioActionViewModel)

new ArchActionSetWhisperAudio(coreSetWhisperAudioActionViewModel)

The Architect Scripting class that represents the Set Whisper Audio action. Instances of this action should be created by calling ArchFactoryActions#addActionSetWhisperAudio

Parameters:
Name Type Description
coreSetWhisperAudioActionViewModel Object

( Internal ) an Architect core Set Whisper Audio action view model.
See:

Extends

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchActionSetWhisperAudio'.

readonly isArchActionSetWhisperAudio :boolean

Returns true indicating that this is an ArchActionSetWhisperAudio instance.

readonly outputSuccess :ArchActionOutput

The success output for this action

Inherited From:

readonly whisperAudio :ArchValueAudio

Whisper audio that will be played to the agent

Methods

setUseDefaultWhisper()

This is a helper function to set no value mode on the ArchActionSetWhisperAudio#whisperAudio property. If whisper is to be played to an agent, this will use the queue's configured whisper prompt or the default set of beeps if no queue prompt is configured.