PHP Sigfox Client

GroupsList extends Request

Retrieve a list of groups according to visibility permissions and request filters.

If parentIds is provided, retrieve all direct sub-groups under the given parents. If parentIds is not provided, retrieve all direct sub-groups under the API user's group. If deep is true, retrieve all sub-groups under either given parent groups or the API user group.

Table of Contents

TYPES_CHANNEL  = 9
Channel
TYPES_DIST  = 8
DIST
TYPES_NIP  = 7
NIP
TYPES_OTHER  = 2
Other
TYPES_PARTNER  = 11
Partner
TYPES_PARTNERS  = 6
Partners
TYPES_SO  = 0
SO
TYPES_STARTER  = 10
Starter
TYPES_SVNO  = 5
SVNO
$action  : string|null
Defines a resource:action pair the user has access on groups.
$authorizations  : bool|null
if true, we return the list of actions and resources the user has access
$deep  : bool|null
Retrieve all sub-groups
$fields  : string|null
Defines the other available fields to be returned in the response.
$limit  : int|null
The maximum number of items to return
$name  : string|null
Searches for groups containing the given text in their name
$offset  : int|null
The number of items to skip
$pageId  : string|null
Token representing the page to retrieve
$parentIds  : array<string|int, mixed>|null
The parent group's identifiers from which the children will be fetched
$sort  : string|null
The field on which the list will be sorted. (field to sort ascending or -field to sort descending)
$types  : array<string|int, mixed>|null
Group's type
from()  : static
Initializing a model from an array
jsonSerialize()  : array<string|int, mixed>
setAction()  : static
Setter for action
setAuthorizations()  : static
Setter for authorizations
setDeep()  : static
Setter for deep
setFields()  : static
Setter for fields
setLimit()  : static
Setter for limit
setName()  : static
Setter for name
setOffset()  : static
Setter for offset
setPageId()  : static
Setter for pageId
setParentIds()  : static
Setter for parentIds
setSort()  : static
Setter for sort
setTypes()  : static
Setter for types

Constants

TYPES_CHANNEL

Channel

public mixed TYPES_CHANNEL = 9

TYPES_PARTNER

Partner

public mixed TYPES_PARTNER = 11

TYPES_PARTNERS

Partners

public mixed TYPES_PARTNERS = 6

TYPES_STARTER

Starter

public mixed TYPES_STARTER = 10

Properties

$action

Defines a resource:action pair the user has access on groups.

protected string|null $action = null

$authorizations

if true, we return the list of actions and resources the user has access

protected bool|null $authorizations = null

$deep

Retrieve all sub-groups

protected bool|null $deep = null

$fields

Defines the other available fields to be returned in the response.

protected string|null $fields = null

$limit

The maximum number of items to return

protected int|null $limit = null

$name

Searches for groups containing the given text in their name

protected string|null $name = null

$offset

The number of items to skip

protected int|null $offset = null

$pageId

Token representing the page to retrieve

protected string|null $pageId = null

$parentIds

The parent group's identifiers from which the children will be fetched

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

$sort

The field on which the list will be sorted. (field to sort ascending or -field to sort descending)

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

jsonSerialize()

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

setAction()

Setter for action

public setAction(string $action) : static
Parameters
$action : string

Defines a resource:action pair the user has access on groups.

Return values
static —

To use in method chains

setAuthorizations()

Setter for authorizations

public setAuthorizations(bool $authorizations) : static
Parameters
$authorizations : bool

if true, we return the list of actions and resources the user has access

Return values
static —

To use in method chains

setDeep()

Setter for deep

public setDeep(bool $deep) : static
Parameters
$deep : bool

Retrieve all sub-groups

Return values
static —

To use in method chains

setFields()

Setter for fields

public setFields(string $fields) : static
Parameters
$fields : string

Defines the other available fields to be returned in the response.

Return values
static —

To use in method chains

setLimit()

Setter for limit

public setLimit(int $limit) : static
Parameters
$limit : int

The maximum number of items to return

Return values
static —

To use in method chains

setName()

Setter for name

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

Searches for groups containing the given text in their name

Return values
static —

To use in method chains

setOffset()

Setter for offset

public setOffset(int $offset) : static
Parameters
$offset : int

The number of items to skip

Return values
static —

To use in method chains

setPageId()

Setter for pageId

public setPageId(string $pageId) : static
Parameters
$pageId : string

Token representing the page to retrieve

Return values
static —

To use in method chains

setParentIds()

Setter for parentIds

public setParentIds(array<string|int, string> $parentIds) : static
Parameters
$parentIds : array<string|int, string>

The parent group's identifiers from which the children will be fetched

Return values
static —

To use in method chains

setSort()

Setter for sort

public setSort(string $sort) : static
Parameters
$sort : string

The field on which the list will be sorted. (field to sort ascending or -field to sort descending)

Return values
static —

To use in method chains

Search results