DevicesList extends Request
Retrieve a list of devices according to visibility permissions and request filters.
Table of Contents
- $authorizations : bool|null
- if true, we return the list of actions and resources the user has access
- $deep : bool|null
- if true, we search by groups and subgroups through the parameter 'groupIds'
- $deviceTypeId : string|null
- Returns all devices of the given device type
- $fields : string|null
- Defines the other available fields to be returned in the response.
- $groupIds : array<string|int, mixed>|null
- Returns all devices under the given groups (included sub-groups if the parameter deep is equals to true)
- $id : string|null
- The device's identifier (hexadecimal format)
- $limit : int|null
- The maximum number of items to return
- $maxId : string|null
- The maximal id of the filtered range, only availble when sort parameter is set to "id" or "-id"
- $minId : string|null
- The minimal id of the filtered range, only availble when sort parameter is set to "id" or "-id"
- $offset : int|null
- The number of items to skip
- $operatorId : string|null
- Returns all devices under the given operator
- $pageId : string|null
- Token representing the page to retrieve
- $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
- setDeep() : static
- Setter for deep
- setDeviceTypeId() : static
- Setter for deviceTypeId
- setFields() : static
- Setter for fields
- setGroupIds() : static
- Setter for groupIds
- setId() : static
- Setter for id
- setLimit() : static
- Setter for limit
- setMaxId() : static
- Setter for maxId
- setMinId() : static
- Setter for minId
- setOffset() : static
- Setter for offset
- setOperatorId() : static
- Setter for operatorId
- setPageId() : static
- Setter for pageId
- setSort() : static
- Setter for sort
Properties
$authorizations
if true, we return the list of actions and resources the user has access
protected
bool|null
$authorizations
= null
$deep
if true, we search by groups and subgroups through the parameter 'groupIds'
protected
bool|null
$deep
= null
$deviceTypeId
Returns all devices of the given device type
protected
string|null
$deviceTypeId
= null
$fields
Defines the other available fields to be returned in the response.
protected
string|null
$fields
= null
$groupIds
Returns all devices under the given groups (included sub-groups if the parameter deep is equals to true)
protected
array<string|int, mixed>|null
$groupIds
= null
$id
The device's identifier (hexadecimal format)
protected
string|null
$id
= null
$limit
The maximum number of items to return
protected
int|null
$limit
= null
$maxId
The maximal id of the filtered range, only availble when sort parameter is set to "id" or "-id"
protected
string|null
$maxId
= null
$minId
The minimal id of the filtered range, only availble when sort parameter is set to "id" or "-id"
protected
string|null
$minId
= null
$offset
The number of items to skip
protected
int|null
$offset
= null
$operatorId
Returns all devices under the given operator
protected
string|null
$operatorId
= 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
Return values
static —jsonSerialize()
public
jsonSerialize() : array<string|int, mixed>
Tags
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
setDeep()
Setter for deep
public
setDeep(bool $deep) : static
Parameters
- $deep : bool
-
if true, we search by groups and subgroups through the parameter 'groupIds'
Return values
static —To use in method chains
setDeviceTypeId()
Setter for deviceTypeId
public
setDeviceTypeId(string $deviceTypeId) : static
Parameters
- $deviceTypeId : string
-
Returns all devices of the given device type
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
setGroupIds()
Setter for groupIds
public
setGroupIds(array<string|int, string> $groupIds) : static
Parameters
- $groupIds : array<string|int, string>
-
Returns all devices under the given groups (included sub-groups if the parameter deep is equals to true)
Return values
static —To use in method chains
setId()
Setter for id
public
setId(string $id) : static
Parameters
- $id : string
-
The device's identifier (hexadecimal format)
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
setMaxId()
Setter for maxId
public
setMaxId(string $maxId) : static
Parameters
- $maxId : string
-
The maximal id of the filtered range, only availble when sort parameter is set to "id" or "-id"
Return values
static —To use in method chains
setMinId()
Setter for minId
public
setMinId(string $minId) : static
Parameters
- $minId : string
-
The minimal id of the filtered range, only availble when sort parameter is set to "id" or "-id"
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
setOperatorId()
Setter for operatorId
public
setOperatorId(string $operatorId) : static
Parameters
- $operatorId : string
-
Returns all devices under the given operator
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