PHP Sigfox Client

StarterCreate extends CommonGroupCreate

Defines the Starter group's create properties

Table of Contents

TYPE_CHANNEL  = 9
Channel
TYPE_DIST  = 8
DIST
TYPE_NIP  = 7
NIP
TYPE_OTHER  = 2
Other
TYPE_PARTNER  = 11
Partner
TYPE_PARTNERS  = 6
Partners
TYPE_SO  = 0
SO
TYPE_STARTER  = 10
Starter
TYPE_SVNO  = 5
SVNO
$description  : string|null
The group's description
$name  : string|null
The group's name
$parentId  : string|null
The parent group id
$timezone  : string|null
The group's 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
getDescription()  : string
Getter for description
getName()  : string
Getter for name
getParentId()  : string
Getter for parentId
getTimezone()  : string
Getter for timezone
getType()  : int
Getter for type
jsonSerialize()  : array<string|int, mixed>
setDescription()  : static
Setter for description
setName()  : static
Setter for name
setParentId()  : static
Setter for parentId
setTimezone()  : static
Setter for timezone
setType()  : static
Setter for type

Constants

Properties

$description

The group's description

protected string|null $description = null

$timezone

The group's 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

getDescription()

Getter for description

public getDescription() : string
Return values
string

The group's description

getName()

Getter for name

public getName() : string
Return values
string

The group's name

getParentId()

Getter for parentId

public getParentId() : string
Return values
string

The parent group id

getTimezone()

Getter for timezone

public getTimezone() : string
Return values
string

The group's 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>

setDescription()

Setter for description

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

The group's description

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

setParentId()

Setter for parentId

public setParentId(string $parentId) : static
Parameters
$parentId : string

The parent group id

Return values
static

To use in method chains

setTimezone()

Setter for timezone

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

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

Return values
static

To use in method chains

Search results