The Device object represents a Device within xMatters, and is used as a method of retrieving information about a Device. This object does not allow modification of the underlying recipient, and is not shared between processes.
Creation Method: Device objects are created through a factory method call on the Event Script Object, where targetName is the name of the Device:
@event::getRecipient(String targetName)
Reference Name: User-defined reference name for static content delivery.
Device target names are represented as (<userId>|<deviceName>). For example, Bob Smith’s Home Phone would display as (bsmith|HomePhone).
Variable |
Type |
Description |
Notes |
address |
String |
Email or IM address of the Device |
Applies only to email and instant-messaging Devices |
areaCode |
String |
Area code of the Device |
Applies only to numeric pagers (that do not have a PIN specified) and voice phones |
countryCode |
String |
Country code of the Device |
Prior to version 4.1 patch 006, this applies only to numeric pagers (that do not have a PIN specified) and voice phones. For text phone Devices, this variable should be empty. For deployments with text phones that were all created after 4.1 patch 006 (or later) was applied, this applies to numeric pagers (that do not have a PIN specified), voice phones, and text phones. |
countryDialCode |
String |
Country dialing code for the Device |
Applies only to numeric pagers (that do not have a PIN specified) and voice phones |
description |
String |
Description of the Device |
|
extension |
String |
Dialing extension of the Device |
Applies only to voice phones |
id |
String |
ID that uniquely identifies this Device |
|
name |
String |
Name of this Device |
|
owner |
String |
Target name of the User to whom this Device belongs |
|
ownerId | String | User ID of the Device's owner. | Available in xMatters 4.1 patch 009 and later. |
phoneNumber |
String |
Phone number of the Device |
Prior to version 4.1 patch 006, this applies only to voice phones. For deployments with text phones that were all created after 4.1 patch 006 (or later) was applied, this applies to both voice phones and text phones. |
pin |
String |
Personal identification number for the Device |
Prior to version 4.1 patch 006, this applies only to generic Devices, text phones (this variable matches phoneNumber and includes the country and area codes for the Device), and numeric pagers with PIN enabled. For deployments with text phones that were all created after 4.1 patch 006 (or later) was applied, this applies only to generic Devices and numeric pagers with PIN enabled. |
provider |
String |
Service Provider for the Device |
|
targetName |
String |
Target name of the Device |
See note above for an explanation of target name. |
timeZone |
String |
Time zone of the Device owner |
|
The following methods are available for the Device object: