playSoundWhenRoutingMessageArrives

Syntax

StudioPreference.playSoundWhenRoutingMessageArrives;

Access

read/write

Parameters

Return value boolean

true if a sound is played when a routing message arrives, false if no sound is played.

Description

The playSoundWhenRoutingMessageArrives property defines if a sound should play when a user receives a message when a file is routed to that user.

The default value is false.

Examples

Read the current sound preference

// Read whether sound is enabled for routing messages.
var soundEnabled = app.studioPreferences.playSoundWhenRoutingMessageArrives;
alert("Play sound: " + soundEnabled);

Enable sound on routing message arrival

// Play a sound when a routing message arrives.
app.studioPreferences.playSoundWhenRoutingMessageArrives = true;

Disable sound on routing message arrival

// Do not play a sound when a routing message arrives.
app.studioPreferences.playSoundWhenRoutingMessageArrives = false;

Supported versions