PHP Sigfox Client

DeviceType 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
$contract  : MinContractInfo|null
$contracts  : array<string|int, mixed>|null
The list of the contracts associated with the device type
$createdBy  : string|null
Identifier of the user who created this device type
$creationTime  : int|null
Date of the creation of this device type (in milliseconds)
$description  : string|null
The device type's description
$detachedContracts  : array<string|int, mixed>|null
The list of the contracts that were associated with the device type at some point, but are not anymore.
$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.
$geolocPayloadConfig  : GeolocPayloadConfig|null
$group  : MinGroup|null
$id  : string|null
The device type's identifier
$keepAlive  : int|null
Keep alive period in seconds (0 to not keep alive else 1800 second minimum)
$lastEditedBy  : string|null
Identifier of the user who last edited this device type
$lastEditionTime  : int|null
Date of the last edition of this device type (in milliseconds)
$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
getContract()  : MinContractInfo
Getter for contract
getContracts()  : array<string|int, MinContractInfo>
Getter for contracts
getCreatedBy()  : string
Getter for createdBy
getCreationTime()  : int
Getter for creationTime
getDescription()  : string
Getter for description
getDetachedContracts()  : array<string|int, MinContractInfo>
Getter for detachedContracts
getDownlinkDataString()  : string
Getter for downlinkDataString
getDownlinkMode()  : int
Getter for downlinkMode
getGeolocPayloadConfig()  : GeolocPayloadConfig
Getter for geolocPayloadConfig
getGroup()  : MinGroup
Getter for group
getId()  : string
Getter for id
getKeepAlive()  : int
Getter for keepAlive
getLastEditedBy()  : string
Getter for lastEditedBy
getLastEditionTime()  : int
Getter for lastEditionTime
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
setContract()  : static
Setter for contract
setContracts()  : static
Setter for contracts
setCreatedBy()  : static
Setter for createdBy
setCreationTime()  : static
Setter for creationTime
setDescription()  : static
Setter for description
setDetachedContracts()  : static
Setter for detachedContracts
setDownlinkDataString()  : static
Setter for downlinkDataString
setDownlinkMode()  : static
Setter for downlinkMode
setGeolocPayloadConfig()  : static
Setter for geolocPayloadConfig
setGroup()  : static
Setter for group
setId()  : static
Setter for id
setKeepAlive()  : static
Setter for keepAlive
setLastEditedBy()  : static
Setter for lastEditedBy
setLastEditionTime()  : static
Setter for lastEditionTime
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

$contracts

The list of the contracts associated with the device type

protected array<string|int, mixed>|null $contracts = null

$createdBy

Identifier of the user who created this device type

protected string|null $createdBy = null

$creationTime

Date of the creation of this device type (in milliseconds)

protected int|null $creationTime = null

$description

The device type's description

protected string|null $description = null

$detachedContracts

The list of the contracts that were associated with the device type at some point, but are not anymore.

protected array<string|int, mixed>|null $detachedContracts = 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.

$id

The device type's identifier

protected string|null $id = null

$keepAlive

Keep alive period in seconds (0 to not keep alive else 1800 second minimum)

protected int|null $keepAlive = null

$lastEditedBy

Identifier of the user who last edited this device type

protected string|null $lastEditedBy = null

$lastEditionTime

Date of the last edition of this device type (in milliseconds)

protected int|null $lastEditionTime = null

$payloadConfig

The payload configuration. Required if the payload type is Custom, else ignored.

protected string|null $payloadConfig = 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
throws
DeserializeException

If provided an invalid type to a property

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

getContracts()

Getter for contracts

public getContracts() : array<string|int, MinContractInfo>
Return values
array<string|int, MinContractInfo> —

The list of the contracts associated with the device type

getCreatedBy()

Getter for createdBy

public getCreatedBy() : string
Return values
string —

Identifier of the user who created this device type

getCreationTime()

Getter for creationTime

public getCreationTime() : int
Return values
int —

Date of the creation of this device type (in milliseconds)

getDescription()

Getter for description

public getDescription() : string
Return values
string —

The device type's description

getDetachedContracts()

Getter for detachedContracts

public getDetachedContracts() : array<string|int, MinContractInfo>
Return values
array<string|int, MinContractInfo> —

The list of the contracts that were associated with the device type at some point, but are not anymore.

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.

getId()

Getter for id

public getId() : string
Return values
string —

The device type's identifier

getKeepAlive()

Getter for keepAlive

public getKeepAlive() : int
Return values
int —

Keep alive period in seconds (0 to not keep alive else 1800 second minimum)

getLastEditedBy()

Getter for lastEditedBy

public getLastEditedBy() : string
Return values
string —

Identifier of the user who last edited this device type

getLastEditionTime()

Getter for lastEditionTime

public getLastEditionTime() : int
Return values
int —

Date of the last edition of this device type (in milliseconds)

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.

jsonSerialize()

public jsonSerialize() : array<string|int, mixed>
Tags
inheritdoc
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

setContracts()

Setter for contracts

public setContracts(array<string|int, MinContractInfo> $contracts) : static
Parameters
$contracts : array<string|int, MinContractInfo>

The list of the contracts associated with the device type

Return values
static —

To use in method chains

setCreatedBy()

Setter for createdBy

public setCreatedBy(string $createdBy) : static
Parameters
$createdBy : string

Identifier of the user who created this device type

Return values
static —

To use in method chains

setCreationTime()

Setter for creationTime

public setCreationTime(int $creationTime) : static
Parameters
$creationTime : int

Date of the creation of this device type (in milliseconds)

Return values
static —

To use in method chains

setDescription()

Setter for description

public setDescription(string $description) : static
Parameters
$description : string

The device type's description

Return values
static —

To use in method chains

setDetachedContracts()

Setter for detachedContracts

public setDetachedContracts(array<string|int, MinContractInfo> $detachedContracts) : static
Parameters
$detachedContracts : array<string|int, MinContractInfo>

The list of the contracts that were associated with the device type at some point, but are not anymore.

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

setGeolocPayloadConfig()

Setter for geolocPayloadConfig

public setGeolocPayloadConfig(GeolocPayloadConfig $geolocPayloadConfig) : static
Parameters
$geolocPayloadConfig : GeolocPayloadConfig
Return values
static —

To use in method chains

setGroup()

Setter for group

public setGroup(MinGroup $group) : static
Parameters
$group : MinGroup
Return values
static —

To use in method chains

setId()

Setter for id

public setId(string $id) : static
Parameters
$id : string

The device type's identifier

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

setLastEditedBy()

Setter for lastEditedBy

public setLastEditedBy(string $lastEditedBy) : static
Parameters
$lastEditedBy : string

Identifier of the user who last edited this device type

Return values
static —

To use in method chains

setLastEditionTime()

Setter for lastEditionTime

public setLastEditionTime(int $lastEditionTime) : static
Parameters
$lastEditionTime : int

Date of the last edition of this device type (in milliseconds)

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

Search results