PHP Sigfox Client

CellularConnectivityForBs extends CellularConnectivityBase

Cellular connectivity configuration for a base station.

Table of Contents

LAST_SETCONF_ERROR_STATUS_BAD_FORMAT  = 1
BAD_FORMAT
LAST_SETCONF_ERROR_STATUS_CONFIG_ID_CONFLICT  = 4
CONFIG_ID_CONFLICT
LAST_SETCONF_ERROR_STATUS_EXISTING_CONFIG  = 2
EXISTING_CONFIG
LAST_SETCONF_ERROR_STATUS_SUCCESS  = 0
SUCCESS
LAST_SETCONF_ERROR_STATUS_TOO_MANY_CONFIG  = 3
TOO_MANY_CONFIG
LAST_SETCONF_ERROR_STATUS_UNKNOWN  = 5
UNKNOWN
LAST_SWITCH_ERROR_STATUS_BAD_GSM_PIN  = 1
BAD_GSM_PIN
LAST_SWITCH_ERROR_STATUS_NETWORK_REJECTED  = 4
NETWORK_REJECTED
LAST_SWITCH_ERROR_STATUS_SUCCESS  = 0
SUCCESS
LAST_SWITCH_ERROR_STATUS_TOO_MANY_PIN_TRIES  = 2
TOO_MANY_PIN_TRIES
LAST_SWITCH_ERROR_STATUS_UNKNOWN  = 5
UNKNOWN
LAST_SWITCH_ERROR_STATUS_VPN_ESTABLISHMENT_IMPOSSIBLE  = 3
VPN_ESTABLISHMENT_IMPOSSIBLE
SOURCE_DEFAULT  = 2
DEFAULT (Auto-Generated)
SOURCE_OTHERS  = 1
OTHERS (From shell console and other origins)
SOURCE_REMOTE  = 0
REMOTE (Configuration provided by Cloud)
SOURCE_TOOLS  = 3
TOOLS (Factory, AAT or secure-control)
STATE_ACTIVE  = 0
ACTIVE
STATE_DELETING  = 4
DELETING
STATE_PASSIVE  = 1
PASSIVE
STATE_PENDING  = 2
PENDING (new configuration to synchronize with the base station)
STATE_REJECTED  = 3
REJECTED
SYNC_STATUS_OK  = 0
OK (the conf is synchronized)
SYNC_STATUS_SENT  = 2
SENT (the conf is currently send to the base station)
SYNC_STATUS_TO_BE_SENT  = 1
TO_BE_SENT (the conf has to be synchronized)
$actions  : array<string|int, mixed>|null
$apn  : string|null
The APN used to connect to the base station with this cellular connectivity configuration
$baseStation  : MinBaseStation|null
$group  : MinGroup|null
$id  : string|null
The group's identifier
$lastSetconfErrorStatus  : int|null
Error status returned after a connectivity config creation/edition
$lastSwitchErrorStatus  : int|null
Error status returned after a connectivity config switch
$name  : string|null
The name of the configuration
$password  : string|null
The password used to connect to the base station with this cellular connectivity configuration. This field can be unset by setting the value as an empty string.
$pin  : string|null
The PIN used to connect to the base station with this cellular connectivity configuration. This field can be unset by setting the value as an empty string.
$resources  : array<string|int, mixed>|null
$roaming  : bool|null
Indicates if the cellular connectivity is registered on a roaming network.
$source  : int|null
Configuration origin of the connectivity
$state  : int|null
State of a cellular connectivity configuration
$syncStatus  : int|null
Synchronisation status of a cellular connectivity configuration
$username  : string|null
The username used to connect to the base station with this cellular connectivity configuration. This field can be unset by setting the value as an empty string.
from()  : static
Initializing a model from an array
getActions()  : array<string|int, string>
Getter for actions
getApn()  : string
Getter for apn
getBaseStation()  : MinBaseStation
Getter for baseStation
getGroup()  : MinGroup
Getter for group
getId()  : string
Getter for id
getLastSetconfErrorStatus()  : int
Getter for lastSetconfErrorStatus
getLastSwitchErrorStatus()  : int
Getter for lastSwitchErrorStatus
getName()  : string
Getter for name
getPassword()  : string
Getter for password
getPin()  : string
Getter for pin
getResources()  : array<string|int, string>
Getter for resources
getRoaming()  : bool
Getter for roaming
getSource()  : int
Getter for source
getState()  : int
Getter for state
getSyncStatus()  : int
Getter for syncStatus
getUsername()  : string
Getter for username
jsonSerialize()  : array<string|int, mixed>
setActions()  : static
Setter for actions
setApn()  : static
Setter for apn
setBaseStation()  : static
Setter for baseStation
setGroup()  : static
Setter for group
setId()  : static
Setter for id
setLastSetconfErrorStatus()  : static
Setter for lastSetconfErrorStatus
setLastSwitchErrorStatus()  : static
Setter for lastSwitchErrorStatus
setName()  : static
Setter for name
setPassword()  : static
Setter for password
setPin()  : static
Setter for pin
setResources()  : static
Setter for resources
setRoaming()  : static
Setter for roaming
setSource()  : static
Setter for source
setState()  : static
Setter for state
setSyncStatus()  : static
Setter for syncStatus
setUsername()  : static
Setter for username

Constants

LAST_SETCONF_ERROR_STATUS_CONFIG_ID_CONFLICT

CONFIG_ID_CONFLICT

public mixed LAST_SETCONF_ERROR_STATUS_CONFIG_ID_CONFLICT = 4

LAST_SETCONF_ERROR_STATUS_EXISTING_CONFIG

EXISTING_CONFIG

public mixed LAST_SETCONF_ERROR_STATUS_EXISTING_CONFIG = 2

LAST_SETCONF_ERROR_STATUS_TOO_MANY_CONFIG

TOO_MANY_CONFIG

public mixed LAST_SETCONF_ERROR_STATUS_TOO_MANY_CONFIG = 3

LAST_SWITCH_ERROR_STATUS_NETWORK_REJECTED

NETWORK_REJECTED

public mixed LAST_SWITCH_ERROR_STATUS_NETWORK_REJECTED = 4

LAST_SWITCH_ERROR_STATUS_TOO_MANY_PIN_TRIES

TOO_MANY_PIN_TRIES

public mixed LAST_SWITCH_ERROR_STATUS_TOO_MANY_PIN_TRIES = 2

LAST_SWITCH_ERROR_STATUS_VPN_ESTABLISHMENT_IMPOSSIBLE

VPN_ESTABLISHMENT_IMPOSSIBLE

public mixed LAST_SWITCH_ERROR_STATUS_VPN_ESTABLISHMENT_IMPOSSIBLE = 3

STATE_PENDING

PENDING (new configuration to synchronize with the base station)

public mixed STATE_PENDING = 2

Properties

$apn

The APN used to connect to the base station with this cellular connectivity configuration

protected string|null $apn = null

$lastSetconfErrorStatus

Error status returned after a connectivity config creation/edition

protected int|null $lastSetconfErrorStatus = null

$lastSwitchErrorStatus

Error status returned after a connectivity config switch

protected int|null $lastSwitchErrorStatus = null

$password

The password used to connect to the base station with this cellular connectivity configuration. This field can be unset by setting the value as an empty string.

protected string|null $password = null

$pin

The PIN used to connect to the base station with this cellular connectivity configuration. This field can be unset by setting the value as an empty string.

protected string|null $pin = null

$roaming

Indicates if the cellular connectivity is registered on a roaming network.

protected bool|null $roaming = null

$username

The username used to connect to the base station with this cellular connectivity configuration. This field can be unset by setting the value as an empty string.

protected string|null $username = 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> —

getApn()

Getter for apn

public getApn() : string
Return values
string —

The APN used to connect to the base station with this cellular connectivity configuration

getLastSetconfErrorStatus()

Getter for lastSetconfErrorStatus

public getLastSetconfErrorStatus() : int
Return values
int —

Error status returned after a connectivity config creation/edition

getLastSwitchErrorStatus()

Getter for lastSwitchErrorStatus

public getLastSwitchErrorStatus() : int
Return values
int —

Error status returned after a connectivity config switch

getName()

Getter for name

public getName() : string
Return values
string —

The name of the configuration

getPassword()

Getter for password

public getPassword() : string
Return values
string —

The password used to connect to the base station with this cellular connectivity configuration. This field can be unset by setting the value as an empty string.

getPin()

Getter for pin

public getPin() : string
Return values
string —

The PIN used to connect to the base station with this cellular connectivity configuration. This field can be unset by setting the value as an empty string.

getResources()

Getter for resources

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

getRoaming()

Getter for roaming

public getRoaming() : bool
Return values
bool —

Indicates if the cellular connectivity is registered on a roaming network.

getUsername()

Getter for username

public getUsername() : string
Return values
string —

The username used to connect to the base station with this cellular connectivity configuration. This field can be unset by setting the value as an empty string.

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

setApn()

Setter for apn

public setApn(string $apn) : static
Parameters
$apn : string

The APN used to connect to the base station with this cellular connectivity configuration

Return values
static —

To use in method chains

setId()

Setter for id

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

The group's identifier

Return values
static —

To use in method chains

setLastSetconfErrorStatus()

Setter for lastSetconfErrorStatus

public setLastSetconfErrorStatus(int $lastSetconfErrorStatus) : static
Parameters
$lastSetconfErrorStatus : int

Error status returned after a connectivity config creation/edition

Return values
static —

To use in method chains

setLastSwitchErrorStatus()

Setter for lastSwitchErrorStatus

public setLastSwitchErrorStatus(int $lastSwitchErrorStatus) : static
Parameters
$lastSwitchErrorStatus : int

Error status returned after a connectivity config switch

Return values
static —

To use in method chains

setName()

Setter for name

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

The name of the configuration

Return values
static —

To use in method chains

setPassword()

Setter for password

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

The password used to connect to the base station with this cellular connectivity configuration. This field can be unset by setting the value as an empty string.

Return values
static —

To use in method chains

setPin()

Setter for pin

public setPin(string $pin) : static
Parameters
$pin : string

The PIN used to connect to the base station with this cellular connectivity configuration. This field can be unset by setting the value as an empty string.

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

setRoaming()

Setter for roaming

public setRoaming(bool $roaming) : static
Parameters
$roaming : bool

Indicates if the cellular connectivity is registered on a roaming network.

Return values
static —

To use in method chains

setUsername()

Setter for username

public setUsername(string $username) : static
Parameters
$username : string

The username used to connect to the base station with this cellular connectivity configuration. This field can be unset by setting the value as an empty string.

Return values
static —

To use in method chains

Search results