PHP Sigfox Client

ApiUserCreation extends Model

Defines the API user properties for creation

Table of Contents

$groupId  : string|null
The group identifer
$name  : string|null
The API user name
$profileIds  : array<string|int, mixed>|null
The API user profiles
$timezone  : string|null
The API user timezone as a Java TimeZone ID ("full name" version only, like "America/Costa_Rica")
from()  : static
Initializing a model from an array
getGroupId()  : string
Getter for groupId
getName()  : string
Getter for name
getProfileIds()  : array<string|int, string>
Getter for profileIds
getTimezone()  : string
Getter for timezone
jsonSerialize()  : array<string|int, mixed>
setGroupId()  : static
Setter for groupId
setName()  : static
Setter for name
setProfileIds()  : static
Setter for profileIds
setTimezone()  : static
Setter for timezone

Properties

$profileIds

The API user profiles

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

$timezone

The API user timezone as a Java TimeZone ID ("full name" version only, like "America/Costa_Rica")

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

getGroupId()

Getter for groupId

public getGroupId() : string
Return values
string

The group identifer

getName()

Getter for name

public getName() : string
Return values
string

The API user name

getProfileIds()

Getter for profileIds

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

The API user profiles

getTimezone()

Getter for timezone

public getTimezone() : string
Return values
string

The API user timezone as a Java TimeZone ID ("full name" version only, like "America/Costa_Rica")

jsonSerialize()

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

setGroupId()

Setter for groupId

public setGroupId(string $groupId) : static
Parameters
$groupId : string

The group identifer

Return values
static

To use in method chains

setName()

Setter for name

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

The API user name

Return values
static

To use in method chains

setProfileIds()

Setter for profileIds

public setProfileIds(array<string|int, string> $profileIds) : static
Parameters
$profileIds : array<string|int, string>

The API user profiles

Return values
static

To use in method chains

setTimezone()

Setter for timezone

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

The API user timezone as a Java TimeZone ID ("full name" version only, like "America/Costa_Rica")

Return values
static

To use in method chains

Search results