DeviceTypeUpdate extends BaseDeviceType
Defines the device type's properties
Table of Contents
- DOWNLINK_MODE_CALLBACK = 1
- CALLBACK
- DOWNLINK_MODE_DIRECT = 0
- DIRECT
- DOWNLINK_MODE_MANAGED = 3
- MANAGED
- DOWNLINK_MODE_NONE = 2
- NONE
- PAYLOAD_TYPE_CUSTOM_GRAMMAR = 3
- Custom grammar
- PAYLOAD_TYPE_DISPLAY_IN_ASCII = 5
- Display in ASCII
- PAYLOAD_TYPE_GEOLOCATION = 4
- Geolocation
- PAYLOAD_TYPE_RADIO_PLANNING_FRAME = 6
- Radio planning frame
- PAYLOAD_TYPE_REGULAR = 2
- Regular (raw payload)
- PAYLOAD_TYPE_SENSITV2 = 9
- Sensitv2
- $alertEmail : string|null
- Email address to contact in case of problems occurring while executing a callback. This field can be unset when updating.
- $automaticRenewal : bool|null
- Allows the automatic renewal of devices attached to this device type
- $contractId : string|null
- The device type's contract identifier (must be on the same group than the device type)
- $contracts : array<string|int, mixed>|null
- The device type's contract identifiers (must be on the same group than the device type)
- $description : string|null
- The device types's description
- $downlinkDataString : string|null
- Downlink data to be sent to the devices of this device type if downlinkMode is equal to 0.
- $downlinkMode : int|null
- The downlink mode to use for the devices of this device type.
- $geolocPayloadConfigId : string|null
- The geoloc payload configuration identifier. Required if the payload type is Geolocation, else ignored.
- $keepAlive : int|null
- Keep alive period in seconds (0 to not keep alive else 1800 second minimum)
- $name : string|null
- The device type's name
- $payloadConfig : string|null
- The payload configuration. Required if the payload type is Custom, else ignored.
- $payloadType : int|null
- The payload type
- from() : static
- Initializing a model from an array
- getAlertEmail() : string
- Getter for alertEmail
- getAutomaticRenewal() : bool
- Getter for automaticRenewal
- getContractId() : string
- Getter for contractId
- getContracts() : array<string|int, ContractId>
- Getter for contracts
- getDescription() : string
- Getter for description
- getDownlinkDataString() : string
- Getter for downlinkDataString
- getDownlinkMode() : int
- Getter for downlinkMode
- getGeolocPayloadConfigId() : string
- Getter for geolocPayloadConfigId
- getKeepAlive() : int
- Getter for keepAlive
- getName() : string
- Getter for name
- getPayloadConfig() : string
- Getter for payloadConfig
- getPayloadType() : int
- Getter for payloadType
- jsonSerialize() : array<string|int, mixed>
- setAlertEmail() : static
- Setter for alertEmail
- setAutomaticRenewal() : static
- Setter for automaticRenewal
- setContractId() : static
- Setter for contractId
- setContracts() : static
- Setter for contracts
- setDescription() : static
- Setter for description
- setDownlinkDataString() : static
- Setter for downlinkDataString
- setDownlinkMode() : static
- Setter for downlinkMode
- setGeolocPayloadConfigId() : static
- Setter for geolocPayloadConfigId
- setKeepAlive() : static
- Setter for keepAlive
- setName() : static
- Setter for name
- setPayloadConfig() : static
- Setter for payloadConfig
- setPayloadType() : static
- Setter for payloadType
Constants
DOWNLINK_MODE_CALLBACK
CALLBACK
public
mixed
DOWNLINK_MODE_CALLBACK
= 1
DOWNLINK_MODE_DIRECT
DIRECT
public
mixed
DOWNLINK_MODE_DIRECT
= 0
DOWNLINK_MODE_MANAGED
MANAGED
public
mixed
DOWNLINK_MODE_MANAGED
= 3
DOWNLINK_MODE_NONE
NONE
public
mixed
DOWNLINK_MODE_NONE
= 2
PAYLOAD_TYPE_CUSTOM_GRAMMAR
Custom grammar
public
mixed
PAYLOAD_TYPE_CUSTOM_GRAMMAR
= 3
PAYLOAD_TYPE_DISPLAY_IN_ASCII
Display in ASCII
public
mixed
PAYLOAD_TYPE_DISPLAY_IN_ASCII
= 5
PAYLOAD_TYPE_GEOLOCATION
Geolocation
public
mixed
PAYLOAD_TYPE_GEOLOCATION
= 4
PAYLOAD_TYPE_RADIO_PLANNING_FRAME
Radio planning frame
public
mixed
PAYLOAD_TYPE_RADIO_PLANNING_FRAME
= 6
PAYLOAD_TYPE_REGULAR
Regular (raw payload)
public
mixed
PAYLOAD_TYPE_REGULAR
= 2
PAYLOAD_TYPE_SENSITV2
Sensitv2
public
mixed
PAYLOAD_TYPE_SENSITV2
= 9
Properties
$alertEmail
Email address to contact in case of problems occurring while executing a callback. This field can be unset when updating.
protected
string|null
$alertEmail
= null
$automaticRenewal
Allows the automatic renewal of devices attached to this device type
protected
bool|null
$automaticRenewal
= null
$contractId
The device type's contract identifier (must be on the same group than the device type)
protected
string|null
$contractId
= null
$contracts
The device type's contract identifiers (must be on the same group than the device type)
protected
array<string|int, mixed>|null
$contracts
= null
$description
The device types's description
protected
string|null
$description
= null
$downlinkDataString
Downlink data to be sent to the devices of this device type if downlinkMode is equal to 0.
protected
string|null
$downlinkDataString
= null
It must be an 8 byte length message given in hexadecimal string format.
$downlinkMode
The downlink mode to use for the devices of this device type.
protected
int|null
$downlinkMode
= null
$geolocPayloadConfigId
The geoloc payload configuration identifier. Required if the payload type is Geolocation, else ignored.
protected
string|null
$geolocPayloadConfigId
= null
$keepAlive
Keep alive period in seconds (0 to not keep alive else 1800 second minimum)
protected
int|null
$keepAlive
= null
$name
The device type's name
protected
string|null
$name
= null
$payloadConfig
The payload configuration. Required if the payload type is Custom, else ignored.
protected
string|null
$payloadConfig
= null
$payloadType
The payload type
protected
int|null
$payloadType
= null
Methods
from()
Initializing a model from an array
public
static from(array<string|int, mixed> $params) : static
Parameters
- $params : array<string|int, mixed>
-
Pass this parameter if you want to initial property value from an array. See API reference for all property names and types
Tags
Return values
static —getAlertEmail()
Getter for alertEmail
public
getAlertEmail() : string
Return values
string —Email address to contact in case of problems occurring while executing a callback. This field can be unset when updating.
getAutomaticRenewal()
Getter for automaticRenewal
public
getAutomaticRenewal() : bool
Return values
bool —Allows the automatic renewal of devices attached to this device type
getContractId()
Getter for contractId
public
getContractId() : string
Return values
string —The device type's contract identifier (must be on the same group than the device type)
getContracts()
Getter for contracts
public
getContracts() : array<string|int, ContractId>
Return values
array<string|int, ContractId> —The device type's contract identifiers (must be on the same group than the device type)
getDescription()
Getter for description
public
getDescription() : string
Return values
string —The device types's description
getDownlinkDataString()
Getter for downlinkDataString
public
getDownlinkDataString() : string
Return values
string —Downlink data to be sent to the devices of this device type if downlinkMode is equal to 0. It must be an 8 byte length message given in hexadecimal string format.
getDownlinkMode()
Getter for downlinkMode
public
getDownlinkMode() : int
Return values
int —The downlink mode to use for the devices of this device type.
getGeolocPayloadConfigId()
Getter for geolocPayloadConfigId
public
getGeolocPayloadConfigId() : string
Return values
string —The geoloc payload configuration identifier. Required if the payload type is Geolocation, else ignored.
getKeepAlive()
Getter for keepAlive
public
getKeepAlive() : int
Return values
int —Keep alive period in seconds (0 to not keep alive else 1800 second minimum)
getName()
Getter for name
public
getName() : string
Return values
string —The device type's name
getPayloadConfig()
Getter for payloadConfig
public
getPayloadConfig() : string
Return values
string —The payload configuration. Required if the payload type is Custom, else ignored.
getPayloadType()
Getter for payloadType
public
getPayloadType() : int
Return values
int —The payload type
jsonSerialize()
public
jsonSerialize() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —setAlertEmail()
Setter for alertEmail
public
setAlertEmail(string $alertEmail) : static
Parameters
- $alertEmail : string
-
Email address to contact in case of problems occurring while executing a callback. This field can be unset when updating.
Return values
static —To use in method chains
setAutomaticRenewal()
Setter for automaticRenewal
public
setAutomaticRenewal(bool $automaticRenewal) : static
Parameters
- $automaticRenewal : bool
-
Allows the automatic renewal of devices attached to this device type
Return values
static —To use in method chains
setContractId()
Setter for contractId
public
setContractId(string $contractId) : static
Parameters
- $contractId : string
-
The device type's contract identifier (must be on the same group than the device type)
Return values
static —To use in method chains
setContracts()
Setter for contracts
public
setContracts(array<string|int, ContractId> $contracts) : static
Parameters
- $contracts : array<string|int, ContractId>
-
The device type's contract identifiers (must be on the same group than the device type)
Return values
static —To use in method chains
setDescription()
Setter for description
public
setDescription(string $description) : static
Parameters
- $description : string
-
The device types's description
Return values
static —To use in method chains
setDownlinkDataString()
Setter for downlinkDataString
public
setDownlinkDataString(string $downlinkDataString) : static
Parameters
- $downlinkDataString : string
-
Downlink data to be sent to the devices of this device type if downlinkMode is equal to 0. It must be an 8 byte length message given in hexadecimal string format.
Return values
static —To use in method chains
setDownlinkMode()
Setter for downlinkMode
public
setDownlinkMode(int $downlinkMode) : static
Parameters
- $downlinkMode : int
-
The downlink mode to use for the devices of this device type.
Return values
static —To use in method chains
setGeolocPayloadConfigId()
Setter for geolocPayloadConfigId
public
setGeolocPayloadConfigId(string $geolocPayloadConfigId) : static
Parameters
- $geolocPayloadConfigId : string
-
The geoloc payload configuration identifier. Required if the payload type is Geolocation, else ignored.
Return values
static —To use in method chains
setKeepAlive()
Setter for keepAlive
public
setKeepAlive(int $keepAlive) : static
Parameters
- $keepAlive : int
-
Keep alive period in seconds (0 to not keep alive else 1800 second minimum)
Return values
static —To use in method chains
setName()
Setter for name
public
setName(string $name) : static
Parameters
- $name : string
-
The device type's name
Return values
static —To use in method chains
setPayloadConfig()
Setter for payloadConfig
public
setPayloadConfig(string $payloadConfig) : static
Parameters
- $payloadConfig : string
-
The payload configuration. Required if the payload type is Custom, else ignored.
Return values
static —To use in method chains
setPayloadType()
Setter for payloadType
public
setPayloadType(int $payloadType) : static
Parameters
- $payloadType : int
-
The payload type
Return values
static —To use in method chains