PHP Sigfox Client

ApiUser extends Model

Defines the API user properties

Table of Contents

$accessToken  : string|null
The API user access token (password)
$actions  : array<string|int, mixed>|null
$creationTime  : int|null
The creation time since epoch
$group  : MinGroup|null
$id  : string|null
The API user identifier
$profiles  : array<string|int, mixed>|null
$resources  : array<string|int, mixed>|null
from()  : static
Initializing a model from an array
getAccessToken()  : string
Getter for accessToken
getActions()  : array<string|int, string>
Getter for actions
getCreationTime()  : int
Getter for creationTime
getGroup()  : MinGroup
Getter for group
getId()  : string
Getter for id
getProfiles()  : array<string|int, MinProfile>
Getter for profiles
getResources()  : array<string|int, string>
Getter for resources
jsonSerialize()  : array<string|int, mixed>
setAccessToken()  : static
Setter for accessToken
setActions()  : static
Setter for actions
setCreationTime()  : static
Setter for creationTime
setGroup()  : static
Setter for group
setId()  : static
Setter for id
setProfiles()  : static
Setter for profiles
setResources()  : static
Setter for resources

Properties

$accessToken

The API user access token (password)

protected string|null $accessToken = null

$actions

protected array<string|int, mixed>|null $actions = null

$creationTime

The creation time since epoch

protected int|null $creationTime = null

$id

The API user identifier

protected string|null $id = null

$profiles

protected array<string|int, mixed>|null $profiles = null

$resources

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

getAccessToken()

Getter for accessToken

public getAccessToken() : string
Return values
string

The API user access token (password)

getActions()

Getter for actions

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

getCreationTime()

Getter for creationTime

public getCreationTime() : int
Return values
int

The creation time since epoch

getId()

Getter for id

public getId() : string
Return values
string

The API user identifier

getResources()

Getter for resources

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

jsonSerialize()

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

setAccessToken()

Setter for accessToken

public setAccessToken(string $accessToken) : static
Parameters
$accessToken : string

The API user access token (password)

Return values
static

To use in method chains

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

setCreationTime()

Setter for creationTime

public setCreationTime(int $creationTime) : static
Parameters
$creationTime : int

The creation time since epoch

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 API user identifier

Return values
static

To use in method chains

setProfiles()

Setter for profiles

public setProfiles(array<string|int, MinProfile$profiles) : static
Parameters
$profiles : array<string|int, MinProfile>
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

Search results