DeviceCreationJob extends CommonDevice
Defines the device's common properties for reading or creation (not update)
Table of Contents
- $activable : bool|null
- The device is activable and can take a token
- $automaticRenewal : bool|null
- Subscribtion to automatic token renewal
- $deviceTypeId : string|null
- The device type's identifier this device is affected
- $id : string|null
- The device's identifier (hexadecimal format)
- $lat : float|null
- The device's provided latitude
- $lng : float|null
- The device's provided longitude
- $name : string|null
- The device's name
- $pac : string|null
- The device's PAC (Porting Access Code)
- $prototype : bool|null
- Set to true if the device is a prototype
- from() : static
- Initializing a model from an array
- getActivable() : bool
- Getter for activable
- getAutomaticRenewal() : bool
- Getter for automaticRenewal
- getDeviceTypeId() : string
- Getter for deviceTypeId
- getId() : string
- Getter for id
- getLat() : float
- Getter for lat
- getLng() : float
- Getter for lng
- getName() : string
- Getter for name
- getPac() : string
- Getter for pac
- getPrototype() : bool
- Getter for prototype
- jsonSerialize() : array<string|int, mixed>
- setActivable() : static
- Setter for activable
- setAutomaticRenewal() : static
- Setter for automaticRenewal
- setDeviceTypeId() : static
- Setter for deviceTypeId
- setId() : static
- Setter for id
- setLat() : static
- Setter for lat
- setLng() : static
- Setter for lng
- setName() : static
- Setter for name
- setPac() : static
- Setter for pac
- setPrototype() : static
- Setter for prototype
Properties
$activable
The device is activable and can take a token
protected
bool|null
$activable
= null
$automaticRenewal
Subscribtion to automatic token renewal
protected
bool|null
$automaticRenewal
= null
$deviceTypeId
The device type's identifier this device is affected
protected
string|null
$deviceTypeId
= null
$id
The device's identifier (hexadecimal format)
protected
string|null
$id
= null
$lat
The device's provided latitude
protected
float|null
$lat
= null
$lng
The device's provided longitude
protected
float|null
$lng
= null
$name
The device's name
protected
string|null
$name
= null
$pac
The device's PAC (Porting Access Code)
protected
string|null
$pac
= null
$prototype
Set to true if the device is a prototype
protected
bool|null
$prototype
= 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 —getActivable()
Getter for activable
public
getActivable() : bool
Return values
bool —The device is activable and can take a token
getAutomaticRenewal()
Getter for automaticRenewal
public
getAutomaticRenewal() : bool
Return values
bool —Subscribtion to automatic token renewal
getDeviceTypeId()
Getter for deviceTypeId
public
getDeviceTypeId() : string
Return values
string —The device type's identifier this device is affected
getId()
Getter for id
public
getId() : string
Return values
string —The device's identifier (hexadecimal format)
getLat()
Getter for lat
public
getLat() : float
Return values
float —The device's provided latitude
getLng()
Getter for lng
public
getLng() : float
Return values
float —The device's provided longitude
getName()
Getter for name
public
getName() : string
Return values
string —The device's name
getPac()
Getter for pac
public
getPac() : string
Return values
string —The device's PAC (Porting Access Code)
getPrototype()
Getter for prototype
public
getPrototype() : bool
Return values
bool —Set to true if the device is a prototype
jsonSerialize()
public
jsonSerialize() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —setActivable()
Setter for activable
public
setActivable(bool $activable) : static
Parameters
- $activable : bool
-
The device is activable and can take a token
Return values
static —To use in method chains
setAutomaticRenewal()
Setter for automaticRenewal
public
setAutomaticRenewal(bool $automaticRenewal) : static
Parameters
- $automaticRenewal : bool
-
Subscribtion to automatic token renewal
Return values
static —To use in method chains
setDeviceTypeId()
Setter for deviceTypeId
public
setDeviceTypeId(string $deviceTypeId) : static
Parameters
- $deviceTypeId : string
-
The device type's identifier this device is affected
Return values
static —To use in method chains
setId()
Setter for id
public
setId(string $id) : static
Parameters
- $id : string
-
The device's identifier (hexadecimal format)
Return values
static —To use in method chains
setLat()
Setter for lat
public
setLat(float $lat) : static
Parameters
- $lat : float
-
The device's provided latitude
Return values
static —To use in method chains
setLng()
Setter for lng
public
setLng(float $lng) : static
Parameters
- $lng : float
-
The device's provided longitude
Return values
static —To use in method chains
setName()
Setter for name
public
setName(string $name) : static
Parameters
- $name : string
-
The device's name
Return values
static —To use in method chains
setPac()
Setter for pac
public
setPac(string $pac) : static
Parameters
- $pac : string
-
The device's PAC (Porting Access Code)
Return values
static —To use in method chains
setPrototype()
Setter for prototype
public
setPrototype(bool $prototype) : static
Parameters
- $prototype : bool
-
Set to true if the device is a prototype
Return values
static —To use in method chains