PHP Sigfox Client

SiteConvention extends BaseSiteConvention

information about convention

Table of Contents

STATUS_AT_HOST  = 1
AT HOST
STATUS_AT_SIGFOX  = 0
AT SIGFOX
STATUS_SIGNED_BOTH  = 4
SIGNED BOTH
STATUS_SIGNED_HOST  = 3
SIGNED HOST
STATUS_SIGNED_SIGFOX  = 2
SIGNED SIGFOX
TYPE_ASSOCIATION  = 3
ASSOCIATION
TYPE_COMPANY  = 4
COMPANY
TYPE_CONDOMINIUM  = 0
CONDOMINIUM
TYPE_INDIVIDUAL  = 1
INDIVIDUAL
TYPE_SOCIAL_HOUSING_AUTHORITY  = 2
SOCIAL HOUSING AUTHORITY
$annualCost  : float|null
The annual cost of this convention
$comments  : string|null
The comments of this convention
$contractReference  : string|null
The bss contract reference of this convention
$endTime  : int|null
The end time of this convention
$group  : MinGroup|null
$id  : string|null
The convention's identifier
$maintenance  : bool|null
is this convention in maintenance
$maintenanceAnnualCost  : float|null
The annual cost of the maintenance of this convention
$site  : MinSite|null
$startTime  : int|null
The start time of this convention
$status  : int|null
Convention status.
$type  : int|null
Convention status.
from()  : static
Initializing a model from an array
getAnnualCost()  : float
Getter for annualCost
getComments()  : string
Getter for comments
getContractReference()  : string
Getter for contractReference
getEndTime()  : int
Getter for endTime
getGroup()  : MinGroup
Getter for group
getId()  : string
Getter for id
getMaintenance()  : bool
Getter for maintenance
getMaintenanceAnnualCost()  : float
Getter for maintenanceAnnualCost
getSite()  : MinSite
Getter for site
getStartTime()  : int
Getter for startTime
getStatus()  : int
Getter for status
getType()  : int
Getter for type
jsonSerialize()  : array<string|int, mixed>
setAnnualCost()  : static
Setter for annualCost
setComments()  : static
Setter for comments
setContractReference()  : static
Setter for contractReference
setEndTime()  : static
Setter for endTime
setGroup()  : static
Setter for group
setId()  : static
Setter for id
setMaintenance()  : static
Setter for maintenance
setMaintenanceAnnualCost()  : static
Setter for maintenanceAnnualCost
setSite()  : static
Setter for site
setStartTime()  : static
Setter for startTime
setStatus()  : static
Setter for status
setType()  : static
Setter for type

Constants

TYPE_SOCIAL_HOUSING_AUTHORITY

SOCIAL HOUSING AUTHORITY

public mixed TYPE_SOCIAL_HOUSING_AUTHORITY = 2

Properties

$annualCost

The annual cost of this convention

protected float|null $annualCost = null

$comments

The comments of this convention

protected string|null $comments = null

$contractReference

The bss contract reference of this convention

protected string|null $contractReference = null

$id

The convention's identifier

protected string|null $id = null

$maintenance

is this convention in maintenance

protected bool|null $maintenance = null

$maintenanceAnnualCost

The annual cost of the maintenance of this convention

protected float|null $maintenanceAnnualCost = null

$startTime

The start time of this convention

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

getAnnualCost()

Getter for annualCost

public getAnnualCost() : float
Return values
float —

The annual cost of this convention

getComments()

Getter for comments

public getComments() : string
Return values
string —

The comments of this convention

getContractReference()

Getter for contractReference

public getContractReference() : string
Return values
string —

The bss contract reference of this convention

getEndTime()

Getter for endTime

public getEndTime() : int
Return values
int —

The end time of this convention

getId()

Getter for id

public getId() : string
Return values
string —

The convention's identifier

getMaintenance()

Getter for maintenance

public getMaintenance() : bool
Return values
bool —

is this convention in maintenance

getMaintenanceAnnualCost()

Getter for maintenanceAnnualCost

public getMaintenanceAnnualCost() : float
Return values
float —

The annual cost of the maintenance of this convention

getStartTime()

Getter for startTime

public getStartTime() : int
Return values
int —

The start time of this convention

jsonSerialize()

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

setAnnualCost()

Setter for annualCost

public setAnnualCost(float $annualCost) : static
Parameters
$annualCost : float

The annual cost of this convention

Return values
static —

To use in method chains

setComments()

Setter for comments

public setComments(string $comments) : static
Parameters
$comments : string

The comments of this convention

Return values
static —

To use in method chains

setContractReference()

Setter for contractReference

public setContractReference(string $contractReference) : static
Parameters
$contractReference : string

The bss contract reference of this convention

Return values
static —

To use in method chains

setEndTime()

Setter for endTime

public setEndTime(int $endTime) : static
Parameters
$endTime : int

The end time of this convention

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 convention's identifier

Return values
static —

To use in method chains

setMaintenance()

Setter for maintenance

public setMaintenance(bool $maintenance) : static
Parameters
$maintenance : bool

is this convention in maintenance

Return values
static —

To use in method chains

setMaintenanceAnnualCost()

Setter for maintenanceAnnualCost

public setMaintenanceAnnualCost(float $maintenanceAnnualCost) : static
Parameters
$maintenanceAnnualCost : float

The annual cost of the maintenance of this convention

Return values
static —

To use in method chains

setSite()

Setter for site

public setSite(MinSite $site) : static
Parameters
$site : MinSite
Return values
static —

To use in method chains

setStartTime()

Setter for startTime

public setStartTime(int $startTime) : static
Parameters
$startTime : int

The start time of this convention

Return values
static —

To use in method chains

Search results