PHP Sigfox Client

UserCreation extends UserUpdate

User information for creation

Table of Contents

$baseStations  : string|null
list of base station ids (Comma-separated values in hexadecimal format) corresponding to the userRoles with tap limited access granted
$email  : string|null
The user's email
$firstName  : string|null
The user's first name
$lastName  : string|null
The user's last name
$maintenances  : string|null
list of maintenance ids corresponding to the userRoles with site limited access granted
$sendWelcomeEmail  : bool|null
Send an email to the user to create/change is password
$timezone  : string|null
The user's timezone
$userRoles  : array<string|int, mixed>|null
Defines the rights of the user
from()  : static
Initializing a model from an array
getBaseStations()  : string
Getter for baseStations
getEmail()  : string
Getter for email
getFirstName()  : string
Getter for firstName
getLastName()  : string
Getter for lastName
getMaintenances()  : string
Getter for maintenances
getSendWelcomeEmail()  : bool
Getter for sendWelcomeEmail
getTimezone()  : string
Getter for timezone
getUserRoles()  : array<string|int, UserRolesItem>
Getter for userRoles
jsonSerialize()  : array<string|int, mixed>
setBaseStations()  : static
Setter for baseStations
setEmail()  : static
Setter for email
setFirstName()  : static
Setter for firstName
setLastName()  : static
Setter for lastName
setMaintenances()  : static
Setter for maintenances
setSendWelcomeEmail()  : static
Setter for sendWelcomeEmail
setTimezone()  : static
Setter for timezone
setUserRoles()  : static
Setter for userRoles

Properties

$baseStations

list of base station ids (Comma-separated values in hexadecimal format) corresponding to the userRoles with tap limited access granted

protected string|null $baseStations = null

$email

The user's email

protected string|null $email = null

$firstName

The user's first name

protected string|null $firstName = null

$lastName

The user's last name

protected string|null $lastName = null

$maintenances

list of maintenance ids corresponding to the userRoles with site limited access granted

protected string|null $maintenances = null

$sendWelcomeEmail

Send an email to the user to create/change is password

protected bool|null $sendWelcomeEmail = null

$timezone

The user's timezone

protected string|null $timezone = null

$userRoles

Defines the rights of the user

protected array<string|int, mixed>|null $userRoles = 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

getBaseStations()

Getter for baseStations

public getBaseStations() : string
Return values
string

list of base station ids (Comma-separated values in hexadecimal format) corresponding to the userRoles with tap limited access granted

getEmail()

Getter for email

public getEmail() : string
Return values
string

The user's email

getFirstName()

Getter for firstName

public getFirstName() : string
Return values
string

The user's first name

getLastName()

Getter for lastName

public getLastName() : string
Return values
string

The user's last name

getMaintenances()

Getter for maintenances

public getMaintenances() : string
Return values
string

list of maintenance ids corresponding to the userRoles with site limited access granted

getSendWelcomeEmail()

Getter for sendWelcomeEmail

public getSendWelcomeEmail() : bool
Return values
bool

Send an email to the user to create/change is password

getTimezone()

Getter for timezone

public getTimezone() : string
Return values
string

The user's timezone

jsonSerialize()

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

setBaseStations()

Setter for baseStations

public setBaseStations(string $baseStations) : static
Parameters
$baseStations : string

list of base station ids (Comma-separated values in hexadecimal format) corresponding to the userRoles with tap limited access granted

Return values
static

To use in method chains

setEmail()

Setter for email

public setEmail(string $email) : static
Parameters
$email : string

The user's email

Return values
static

To use in method chains

setFirstName()

Setter for firstName

public setFirstName(string $firstName) : static
Parameters
$firstName : string

The user's first name

Return values
static

To use in method chains

setLastName()

Setter for lastName

public setLastName(string $lastName) : static
Parameters
$lastName : string

The user's last name

Return values
static

To use in method chains

setMaintenances()

Setter for maintenances

public setMaintenances(string $maintenances) : static
Parameters
$maintenances : string

list of maintenance ids corresponding to the userRoles with site limited access granted

Return values
static

To use in method chains

setSendWelcomeEmail()

Setter for sendWelcomeEmail

public setSendWelcomeEmail(bool $sendWelcomeEmail) : static
Parameters
$sendWelcomeEmail : bool

Send an email to the user to create/change is password

Return values
static

To use in method chains

setTimezone()

Setter for timezone

public setTimezone(string $timezone) : static
Parameters
$timezone : string

The user's timezone

Return values
static

To use in method chains

setUserRoles()

Setter for userRoles

public setUserRoles(array<string|int, UserRolesItem$userRoles) : static
Parameters
$userRoles : array<string|int, UserRolesItem>

Defines the rights of the user

Return values
static

To use in method chains

Search results