PHP Sigfox Client

DeviceTypesList extends Request

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

Table of Contents

PAYLOAD_TYPE_CUSTOM_GRAMMAR  = 3
Custom grammar
PAYLOAD_TYPE_DISPLAY_IN_ASCII  = 5
Display in ASCII
PAYLOAD_TYPE_GEOLOCATION  = 4
Geolocation
PAYLOAD_TYPE_RADIO_PLANNING_FRAME  = 6
Radio planning frame
PAYLOAD_TYPE_REGULAR  = 2
Regular (raw payload)
PAYLOAD_TYPE_SENSITV2  = 9
Sensitv2
$authorizations  : bool|null
if true, we return the list of actions and resources the user has access
$contractId  : string|null
Searches for device types which are attached to the given contract.
$deep  : bool|null
If a group identifier is specified, also includes its subgroups.
$fields  : string|null
Defines the other available API user's fields to be returned in the response.
$groupIds  : array<string|int, mixed>|null
Search for device types which are attached to a Group. Example: ?groupIds=57309674171c857460043087,57309674171c857460043088
$limit  : int|null
Defines the maximum number of items to return
$name  : string|null
Search returns all Device Type names containing the value. Example: ?name=sig
$offset  : int|null
Defines the number of items to skip
$pageId  : string|null
Token representing the page to retrieve
$payloadType  : int|null
Searches device types by payload type
$sort  : string|null
The field on which the list will be sorted. (field to sort ascending or -field to sort descending).
from()  : static
Initializing a model from an array
jsonSerialize()  : array<string|int, mixed>
setAuthorizations()  : static
Setter for authorizations
setContractId()  : static
Setter for contractId
setDeep()  : static
Setter for deep
setFields()  : static
Setter for fields
setGroupIds()  : static
Setter for groupIds
setLimit()  : static
Setter for limit
setName()  : static
Setter for name
setOffset()  : static
Setter for offset
setPageId()  : static
Setter for pageId
setPayloadType()  : static
Setter for payloadType
setSort()  : static
Setter for sort

Constants

PAYLOAD_TYPE_CUSTOM_GRAMMAR

Custom grammar

public mixed PAYLOAD_TYPE_CUSTOM_GRAMMAR = 3

PAYLOAD_TYPE_DISPLAY_IN_ASCII

Display in ASCII

public mixed PAYLOAD_TYPE_DISPLAY_IN_ASCII = 5

PAYLOAD_TYPE_GEOLOCATION

Geolocation

public mixed PAYLOAD_TYPE_GEOLOCATION = 4

PAYLOAD_TYPE_RADIO_PLANNING_FRAME

Radio planning frame

public mixed PAYLOAD_TYPE_RADIO_PLANNING_FRAME = 6

PAYLOAD_TYPE_REGULAR

Regular (raw payload)

public mixed PAYLOAD_TYPE_REGULAR = 2

PAYLOAD_TYPE_SENSITV2

Sensitv2

public mixed PAYLOAD_TYPE_SENSITV2 = 9

Properties

$authorizations

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

protected bool|null $authorizations = null

$contractId

Searches for device types which are attached to the given contract.

protected string|null $contractId = null

$deep

If a group identifier is specified, also includes its subgroups.

protected bool|null $deep = null

$fields

Defines the other available API user's fields to be returned in the response.

protected string|null $fields = null

$groupIds

Search for device types which are attached to a Group. Example: ?groupIds=57309674171c857460043087,57309674171c857460043088

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

$limit

Defines the maximum number of items to return

protected int|null $limit = null

$name

Search returns all Device Type names containing the value. Example: ?name=sig

protected string|null $name = null

$offset

Defines the number of items to skip

protected int|null $offset = null

$pageId

Token representing the page to retrieve

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

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

setContractId()

Setter for contractId

public setContractId(string $contractId) : static
Parameters
$contractId : string

Searches for device types which are attached to the given contract.

Return values
static

To use in method chains

setDeep()

Setter for deep

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

If a group identifier is specified, also includes its subgroups.

Return values
static

To use in method chains

setFields()

Setter for fields

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

Defines the other available API user's fields to be returned in the response.

Return values
static

To use in method chains

setGroupIds()

Setter for groupIds

public setGroupIds(array<string|int, string> $groupIds) : static
Parameters
$groupIds : array<string|int, string>

Search for device types which are attached to a Group. Example: ?groupIds=57309674171c857460043087,57309674171c857460043088

Return values
static

To use in method chains

setLimit()

Setter for limit

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

Defines 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

Search returns all Device Type names containing the value. Example: ?name=sig

Return values
static

To use in method chains

setOffset()

Setter for offset

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

Defines 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

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