showRoutingMessageAlert
Syntax
StudioPreference.showRoutingMessageAlert;
Access
read/write
Parameters
Return value ShowRoutingMessageOptions
An ShowRoutingMessageOptions enum value (see below).
Description
The showRoutingMessageAlert property defines if a message is shown on screen for a user when an object is routed to that user or any user groups of which the user is part.
Use one of the following options:
| Value | Description |
|---|---|
| ShowRoutingMessageOptions.DO_NOT_SHOW | No message is shown. |
| ShowRoutingMessageOptions.SHOW_SENT_TO_ME | A message is shown when an object is routed to the user only. |
| ShowRoutingMessageOptions.SHOW_SENT_TO_ME_OR_GROUP | A message is shown when an object is routed to the user or any of the groups the user is part. |
The default value is ShowRoutingMessageOptions.DO_NOT_SHOW.
Examples
Read the current routing message alert preference
// Read the current routing message alert preference.
var pref = app.studioPreferences.showRoutingMessageAlert;
alert("Routing message alert: " + pref);
Do not show any routing message
// Disable routing message alerts entirely.
app.studioPreferences.showRoutingMessageAlert =
ShowRoutingMessageOptions.DO_NOT_SHOW;
Show a message when an object is routed to the current user
// Show a routing message alert only when an object is routed directly to the current user.
app.studioPreferences.showRoutingMessageAlert =
ShowRoutingMessageOptions.SHOW_SENT_TO_ME;
Show a message when an object is routed to the user or any of their groups
// Show a routing message alert when an object is routed to the user or any of their user groups.
app.studioPreferences.showRoutingMessageAlert =
ShowRoutingMessageOptions.SHOW_SENT_TO_ME_OR_GROUP;
Supported versions
| Adobe Version | Supported |
|---|---|
| 2023 | ✔ |
| 2024 | ✔ |
| 2025 | ✔ |
| 2026 | ✔ |