CellularConnectivityBase extends Model
Table of Contents
- 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)
- $apn : string|null
- The APN used to connect to the base station with this cellular connectivity configuration
- $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.
- $roaming : bool|null
- Indicates if the cellular connectivity is registered on a roaming network.
- $source : int|null
- Configuration origin of the connectivity
- $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
- getApn() : string
- Getter for apn
- getName() : string
- Getter for name
- getPassword() : string
- Getter for password
- getPin() : string
- Getter for pin
- getRoaming() : bool
- Getter for roaming
- getSource() : int
- Getter for source
- getUsername() : string
- Getter for username
- jsonSerialize() : array<string|int, mixed>
- setApn() : static
- Setter for apn
- setName() : static
- Setter for name
- setPassword() : static
- Setter for password
- setPin() : static
- Setter for pin
- setRoaming() : static
- Setter for roaming
- setSource() : static
- Setter for source
- setUsername() : static
- Setter for username
Constants
SOURCE_DEFAULT
DEFAULT (Auto-Generated)
public
mixed
SOURCE_DEFAULT
= 2
SOURCE_OTHERS
OTHERS (From shell console and other origins)
public
mixed
SOURCE_OTHERS
= 1
SOURCE_REMOTE
REMOTE (Configuration provided by Cloud)
public
mixed
SOURCE_REMOTE
= 0
SOURCE_TOOLS
TOOLS (Factory, AAT or secure-control)
public
mixed
SOURCE_TOOLS
= 3
Properties
$apn
The APN used to connect to the base station with this cellular connectivity configuration
protected
string|null
$apn
= null
$name
The name of the configuration
protected
string|null
$name
= 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
$source
Configuration origin of the connectivity
protected
int|null
$source
= 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
Return values
static —getApn()
Getter for apn
public
getApn() : string
Return values
string —The APN used to connect to the base station with this cellular connectivity configuration
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.
getRoaming()
Getter for roaming
public
getRoaming() : bool
Return values
bool —Indicates if the cellular connectivity is registered on a roaming network.
getSource()
Getter for source
public
getSource() : int
Return values
int —Configuration origin of the connectivity
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
Return values
array<string|int, mixed> —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
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
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
setSource()
Setter for source
public
setSource(int $source) : static
Parameters
- $source : int
-
Configuration origin of the connectivity
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