PHP Sigfox Client

RegistrationJob extends Model

information about a multiple registrations job

Table of Contents

$description  : string|null
the description of the registration job
$jobDone  : bool|null
If the job is finished or not
$name  : string|null
the name of the registration job
$operatorId  : string|null
the operator's idenfier (hexadecimal format)
$status  : Status|null
the informations about the base stations already treated
$total  : int|null
the total number of base stations given to be created
from()  : static
Initializing a model from an array
getDescription()  : string
Getter for description
getJobDone()  : bool
Getter for jobDone
getName()  : string
Getter for name
getOperatorId()  : string
Getter for operatorId
getStatus()  : Status
Getter for status
getTotal()  : int
Getter for total
jsonSerialize()  : array<string|int, mixed>
setDescription()  : static
Setter for description
setJobDone()  : static
Setter for jobDone
setName()  : static
Setter for name
setOperatorId()  : static
Setter for operatorId
setStatus()  : static
Setter for status
setTotal()  : static
Setter for total

Properties

$description

the description of the registration job

protected string|null $description = null

$jobDone

If the job is finished or not

protected bool|null $jobDone = null

$name

the name of the registration job

protected string|null $name = null

$operatorId

the operator's idenfier (hexadecimal format)

protected string|null $operatorId = null

$status

the informations about the base stations already treated

protected Status|null $status = null

$total

the total number of base stations given to be created

protected int|null $total = 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

getDescription()

Getter for description

public getDescription() : string
Return values
string

the description of the registration job

getJobDone()

Getter for jobDone

public getJobDone() : bool
Return values
bool

If the job is finished or not

getName()

Getter for name

public getName() : string
Return values
string

the name of the registration job

getOperatorId()

Getter for operatorId

public getOperatorId() : string
Return values
string

the operator's idenfier (hexadecimal format)

getStatus()

Getter for status

public getStatus() : Status
Return values
Status

the informations about the base stations already treated

getTotal()

Getter for total

public getTotal() : int
Return values
int

the total number of base stations given to be created

jsonSerialize()

public jsonSerialize() : array<string|int, mixed>
Tags
inheritdoc
Return values
array<string|int, mixed>

setDescription()

Setter for description

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

the description of the registration job

Return values
static

To use in method chains

setJobDone()

Setter for jobDone

public setJobDone(bool $jobDone) : static
Parameters
$jobDone : bool

If the job is finished or not

Return values
static

To use in method chains

setName()

Setter for name

public setName(string $name) : static
Parameters
$name : string

the name of the registration job

Return values
static

To use in method chains

setOperatorId()

Setter for operatorId

public setOperatorId(string $operatorId) : static
Parameters
$operatorId : string

the operator's idenfier (hexadecimal format)

Return values
static

To use in method chains

setStatus()

Setter for status

public setStatus(Status $status) : static
Parameters
$status : Status

the informations about the base stations already treated

Return values
static

To use in method chains

setTotal()

Setter for total

public setTotal(int $total) : static
Parameters
$total : int

the total number of base stations given to be created

Return values
static

To use in method chains

Search results