PHP Sigfox Client

Group extends Model

Defines the group's generic properties

Table of Contents

TYPE_BASIC  = 2
Basic
TYPE_CHANNEL  = 9
Channel
TYPE_DIST  = 8
DIST
TYPE_NIP  = 7
NIP
TYPE_PARTNER  = 11
Partner
TYPE_PARTNERS  = 6
Partners
TYPE_SO  = 0
SO
TYPE_STARTER  = 10
Starter
TYPE_SVNO  = 5
SVNO
$actions  : array<string|int, mixed>|null
$createdBy  : string|null
The user id of the group's creator
$creationTime  : int|null
The creation date of the group (timestamp in milliseconds since Unix Epoch)
$description  : string|null
The group's description
$id  : string|null
The group's identifier
$leaf  : bool|null
true if the group is leaf
$name  : string|null
The group's name
$nameCI  : string|null
The group's name to ascii and lowercase
$path  : array<string|int, mixed>|null
The group's path sorted by descending ancestor {id} (direct parent to farthest parent), restricted to the groups visible by the API user
$timezone  : string|null
The timezone (in Java TimeZone ID format, e.g."America/Costa_Rica").
$type  : int|null
Group's type
from()  : static
Initializing a model from an array
getActions()  : array<string|int, string>
Getter for actions
getCreatedBy()  : string
Getter for createdBy
getCreationTime()  : int
Getter for creationTime
getDescription()  : string
Getter for description
getId()  : string
Getter for id
getLeaf()  : bool
Getter for leaf
getName()  : string
Getter for name
getNameCI()  : string
Getter for nameCI
getPath()  : array<string|int, MinGroup>
Getter for path
getTimezone()  : string
Getter for timezone
getType()  : int
Getter for type
jsonSerialize()  : array<string|int, mixed>
setActions()  : static
Setter for actions
setCreatedBy()  : static
Setter for createdBy
setCreationTime()  : static
Setter for creationTime
setDescription()  : static
Setter for description
setId()  : static
Setter for id
setLeaf()  : static
Setter for leaf
setName()  : static
Setter for name
setNameCI()  : static
Setter for nameCI
setPath()  : static
Setter for path
setTimezone()  : static
Setter for timezone
setType()  : static
Setter for type

Constants

TYPE_BASIC

Basic

public mixed TYPE_BASIC = 2

TYPE_CHANNEL

Channel

public mixed TYPE_CHANNEL = 9

TYPE_DIST

DIST

public mixed TYPE_DIST = 8

TYPE_NIP

NIP

public mixed TYPE_NIP = 7

TYPE_PARTNER

Partner

public mixed TYPE_PARTNER = 11

TYPE_PARTNERS

Partners

public mixed TYPE_PARTNERS = 6

TYPE_SO

SO

public mixed TYPE_SO = 0

TYPE_STARTER

Starter

public mixed TYPE_STARTER = 10

TYPE_SVNO

SVNO

public mixed TYPE_SVNO = 5

Properties

$actions

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

$createdBy

The user id of the group's creator

protected string|null $createdBy = null

$creationTime

The creation date of the group (timestamp in milliseconds since Unix Epoch)

protected int|null $creationTime = null

$description

The group's description

protected string|null $description = null

$id

The group's identifier

protected string|null $id = null

$leaf

true if the group is leaf

protected bool|null $leaf = null

$name

The group's name

protected string|null $name = null

$nameCI

The group's name to ascii and lowercase

protected string|null $nameCI = null

$path

The group's path sorted by descending ancestor {id} (direct parent to farthest parent), restricted to the groups visible by the API user

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

$timezone

The timezone (in Java TimeZone ID format, e.g."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 —

getActions()

Getter for actions

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

getCreatedBy()

Getter for createdBy

public getCreatedBy() : string
Return values
string —

The user id of the group's creator

getCreationTime()

Getter for creationTime

public getCreationTime() : int
Return values
int —

The creation date of the group (timestamp in milliseconds since Unix Epoch)

getDescription()

Getter for description

public getDescription() : string
Return values
string —

The group's description

getId()

Getter for id

public getId() : string
Return values
string —

The group's identifier

getLeaf()

Getter for leaf

public getLeaf() : bool
Return values
bool —

true if the group is leaf

getName()

Getter for name

public getName() : string
Return values
string —

The group's name

getNameCI()

Getter for nameCI

public getNameCI() : string
Return values
string —

The group's name to ascii and lowercase

getPath()

Getter for path

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

The group's path sorted by descending ancestor {id} (direct parent to farthest parent), restricted to the groups visible by the API user

getTimezone()

Getter for timezone

public getTimezone() : string
Return values
string —

The timezone (in Java TimeZone ID format, e.g."America/Costa_Rica").

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

setCreatedBy()

Setter for createdBy

public setCreatedBy(string $createdBy) : static
Parameters
$createdBy : string

The user id of the group's creator

Return values
static —

To use in method chains

setCreationTime()

Setter for creationTime

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

The creation date of the group (timestamp in milliseconds since Unix Epoch)

Return values
static —

To use in method chains

setDescription()

Setter for description

public setDescription(string $description) : static
Parameters
$description : string

The group's description

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

setLeaf()

Setter for leaf

public setLeaf(bool $leaf) : static
Parameters
$leaf : bool

true if the group is leaf

Return values
static —

To use in method chains

setName()

Setter for name

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

The group's name

Return values
static —

To use in method chains

setNameCI()

Setter for nameCI

public setNameCI(string $nameCI) : static
Parameters
$nameCI : string

The group's name to ascii and lowercase

Return values
static —

To use in method chains

setPath()

Setter for path

public setPath(array<string|int, MinGroup> $path) : static
Parameters
$path : array<string|int, MinGroup>

The group's path sorted by descending ancestor {id} (direct parent to farthest parent), restricted to the groups visible by the API user

Return values
static —

To use in method chains

setTimezone()

Setter for timezone

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

The timezone (in Java TimeZone ID format, e.g."America/Costa_Rica").

Return values
static —

To use in method chains

Search results