PHP Sigfox Client

SatSubscription extends InternetSubscription

Information about satellite internet subscription

Table of Contents

CONNECTION_STATUS_CREDENTIALS_PROVIDED  = 1
CREDENTIALS PROVIDED
CONNECTION_STATUS_KIT_RECEIVED  = 2
KIT RECEIVED
CONNECTION_STATUS_REQUEST  = 0
REQUEST
PRIORITY_PRIMARY  = 0
PRIMARY
PRIORITY_SECONDARY  = 1
SECONDARY
PRIORITY_TERMINATED  = 2
TERMINATED
R_TYPE_HEATING  = 0
HEATING
R_TYPE_STANDARD  = 1
STANDARD
TYPE_ADSL  = 1
ADSL
TYPE_GSM  = 0
GSM
TYPE_LAN  = 3
LAN
TYPE_SATELLITE  = 2
SATELLITE
TYPE_WIFI  = 4
WIFI
$actions  : array<string|int, mixed>|null
$altitude  : float|null
The altitude of the satellite of this internet subscription
$azimuth  : float|null
The azimuth of the satellite of this internet subscription
$clusterCode  : string|null
The cluster code of this internet subscription. This field can be unset when updating.
$comments  : string|null
The comments about this internet subscription. This field can be unset when updating.
$connectionStatus  : int|null
Subscription connection status
$contacts  : array<string|int, mixed>|null
$endTime  : int|null
The end time this internet subscription. This field can be unset when updating.
$id  : string|null
The identifier of this internet subscription
$locationCode  : string|null
The location code of this internet subscription. This field can be unset when updating.
$login  : string|null
The login of this internet subscription. This field can be unset when updating.
$orderNumber  : string|null
The order number of this internet subscription
$password  : string|null
The password of this internet subscription. This field can be unset when updating.
$polarization  : float|null
The polarization of the satellite of this internet subscription
$priority  : int|null
Internet subscription priority.
$provider  : MinProvider|null
$resources  : array<string|int, mixed>|null
$rType  : int|null
Subscription receiver type
$startTime  : int|null
The start time of this internet subscription
$type  : int|null
Internet subscription type
from()  : static
Initializing a model from an array
getActions()  : array<string|int, string>
Getter for actions
getAltitude()  : float
Getter for altitude
getAzimuth()  : float
Getter for azimuth
getClusterCode()  : string
Getter for clusterCode
getComments()  : string
Getter for comments
getConnectionStatus()  : int
Getter for connectionStatus
getContacts()  : array<string|int, MinContact>
Getter for contacts
getEndTime()  : int
Getter for endTime
getId()  : string
Getter for id
getLocationCode()  : string
Getter for locationCode
getLogin()  : string
Getter for login
getOrderNumber()  : string
Getter for orderNumber
getPassword()  : string
Getter for password
getPolarization()  : float
Getter for polarization
getPriority()  : int
Getter for priority
getProvider()  : MinProvider
Getter for provider
getResources()  : array<string|int, string>
Getter for resources
getRType()  : int
Getter for rType
getStartTime()  : int
Getter for startTime
getType()  : int
Getter for type
jsonSerialize()  : array<string|int, mixed>
setActions()  : static
Setter for actions
setAltitude()  : static
Setter for altitude
setAzimuth()  : static
Setter for azimuth
setClusterCode()  : static
Setter for clusterCode
setComments()  : static
Setter for comments
setConnectionStatus()  : static
Setter for connectionStatus
setContacts()  : static
Setter for contacts
setEndTime()  : static
Setter for endTime
setId()  : static
Setter for id
setLocationCode()  : static
Setter for locationCode
setLogin()  : static
Setter for login
setOrderNumber()  : static
Setter for orderNumber
setPassword()  : static
Setter for password
setPolarization()  : static
Setter for polarization
setPriority()  : static
Setter for priority
setProvider()  : static
Setter for provider
setResources()  : static
Setter for resources
setRType()  : static
Setter for rType
setStartTime()  : static
Setter for startTime
setType()  : static
Setter for type

Constants

CONNECTION_STATUS_CREDENTIALS_PROVIDED

CREDENTIALS PROVIDED

public mixed CONNECTION_STATUS_CREDENTIALS_PROVIDED = 1

CONNECTION_STATUS_KIT_RECEIVED

KIT RECEIVED

public mixed CONNECTION_STATUS_KIT_RECEIVED = 2

CONNECTION_STATUS_REQUEST

REQUEST

public mixed CONNECTION_STATUS_REQUEST = 0

Properties

$altitude

The altitude of the satellite of this internet subscription

protected float|null $altitude = null

$azimuth

The azimuth of the satellite of this internet subscription

protected float|null $azimuth = null

$clusterCode

The cluster code of this internet subscription. This field can be unset when updating.

protected string|null $clusterCode = null

$comments

The comments about this internet subscription. This field can be unset when updating.

protected string|null $comments = null

$endTime

The end time this internet subscription. This field can be unset when updating.

protected int|null $endTime = null

$locationCode

The location code of this internet subscription. This field can be unset when updating.

protected string|null $locationCode = null

$login

The login of this internet subscription. This field can be unset when updating.

protected string|null $login = null

$orderNumber

The order number of this internet subscription

protected string|null $orderNumber = null

$password

The password of this internet subscription. This field can be unset when updating.

protected string|null $password = null

$polarization

The polarization of the satellite of this internet subscription

protected float|null $polarization = null

$startTime

The start time of this internet subscription

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

getActions()

Getter for actions

public getActions() : array<string|int, string>
Return values
array<string|int, string>

getAltitude()

Getter for altitude

public getAltitude() : float
Return values
float

The altitude of the satellite of this internet subscription

getAzimuth()

Getter for azimuth

public getAzimuth() : float
Return values
float

The azimuth of the satellite of this internet subscription

getClusterCode()

Getter for clusterCode

public getClusterCode() : string
Return values
string

The cluster code of this internet subscription. This field can be unset when updating.

getComments()

Getter for comments

public getComments() : string
Return values
string

The comments about this internet subscription. This field can be unset when updating.

getEndTime()

Getter for endTime

public getEndTime() : int
Return values
int

The end time this internet subscription. This field can be unset when updating.

getId()

Getter for id

public getId() : string
Return values
string

The identifier of this internet subscription

getLocationCode()

Getter for locationCode

public getLocationCode() : string
Return values
string

The location code of this internet subscription. This field can be unset when updating.

getLogin()

Getter for login

public getLogin() : string
Return values
string

The login of this internet subscription. This field can be unset when updating.

getOrderNumber()

Getter for orderNumber

public getOrderNumber() : string
Return values
string

The order number of this internet subscription

getPassword()

Getter for password

public getPassword() : string
Return values
string

The password of this internet subscription. This field can be unset when updating.

getPolarization()

Getter for polarization

public getPolarization() : float
Return values
float

The polarization of the satellite of this internet subscription

getResources()

Getter for resources

public getResources() : array<string|int, string>
Return values
array<string|int, string>

getStartTime()

Getter for startTime

public getStartTime() : int
Return values
int

The start time of this internet subscription

jsonSerialize()

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

setActions()

Setter for actions

public setActions(array<string|int, string> $actions) : static
Parameters
$actions : array<string|int, string>
Return values
static

To use in method chains

setAltitude()

Setter for altitude

public setAltitude(float $altitude) : static
Parameters
$altitude : float

The altitude of the satellite of this internet subscription

Return values
static

To use in method chains

setAzimuth()

Setter for azimuth

public setAzimuth(float $azimuth) : static
Parameters
$azimuth : float

The azimuth of the satellite of this internet subscription

Return values
static

To use in method chains

setClusterCode()

Setter for clusterCode

public setClusterCode(string $clusterCode) : static
Parameters
$clusterCode : string

The cluster code of this internet subscription. This field can be unset when updating.

Return values
static

To use in method chains

setComments()

Setter for comments

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

The comments about this internet subscription. This field can be unset when updating.

Return values
static

To use in method chains

setContacts()

Setter for contacts

public setContacts(array<string|int, MinContact$contacts) : static
Parameters
$contacts : array<string|int, MinContact>
Return values
static

To use in method chains

setEndTime()

Setter for endTime

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

The end time this internet subscription. This field can be unset when updating.

Return values
static

To use in method chains

setId()

Setter for id

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

The identifier of this internet subscription

Return values
static

To use in method chains

setLocationCode()

Setter for locationCode

public setLocationCode(string $locationCode) : static
Parameters
$locationCode : string

The location code of this internet subscription. This field can be unset when updating.

Return values
static

To use in method chains

setLogin()

Setter for login

public setLogin(string $login) : static
Parameters
$login : string

The login of this internet subscription. This field can be unset when updating.

Return values
static

To use in method chains

setOrderNumber()

Setter for orderNumber

public setOrderNumber(string $orderNumber) : static
Parameters
$orderNumber : string

The order number of this internet subscription

Return values
static

To use in method chains

setPassword()

Setter for password

public setPassword(string $password) : static
Parameters
$password : string

The password of this internet subscription. This field can be unset when updating.

Return values
static

To use in method chains

setPolarization()

Setter for polarization

public setPolarization(float $polarization) : static
Parameters
$polarization : float

The polarization of the satellite of this internet subscription

Return values
static

To use in method chains

setResources()

Setter for resources

public setResources(array<string|int, string> $resources) : static
Parameters
$resources : array<string|int, string>
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 internet subscription

Return values
static

To use in method chains

Search results