@notification::setEmergencyDeviceUsage

Controls whether the notification uses the recipients’ emergency Devices.

This forces the use of emergency Devices as part of the Device resolution processing. Emergency Devices are Devices that will be notified even if they are not scheduled at the time of an Event.

Note: In the xMatters web user interface, emergency Devices are referred to as "Default Devices".

For example, if a Group has the "Use Default Devices" check box selected, passing false into this method would override that setting, and the notification would not use the Team members’ Default Devices.

This needs to be set before a performNotification is performed or the default value will be used. This is disabled by default.

Syntax:

@notification::setEmergencyDeviceUsage(boolean state)

Parameters:

(Boolean) state: the state to which you want to set the Use Emergency Devices parameter.

Returns:

None

Example:

The following script illustrates using setEmergencyDeviceUsage() to override a Group’s Use Default Devices setting, and permit the notification to use Team members’ Default Devices:

# Allow the use of emergency/default Devices

@Notification::setEmergencyDeviceUsage(true)

 

@Notification::performNotification ()