PHP Sigfox Client

DevicesIdLocations extends Request

Retrieve a list of location data of a device according to request filters.

Table of Contents

$before  : int|null
Ending timestamp (in milliseconds since the Unix Epoch)
$limit  : int|null
The maximum number of items to return
$offset  : int|null
The number of items to skip
$oob  : bool|null
if true, the method return also the location from out of band Messages
$since  : int|null
Starting timestamp (in milliseconds since the Unix Epoch)
from()  : static
Initializing a model from an array
jsonSerialize()  : array<string|int, mixed>
setBefore()  : static
Setter for before
setLimit()  : static
Setter for limit
setOffset()  : static
Setter for offset
setOob()  : static
Setter for oob
setSince()  : static
Setter for since

Properties

$before

Ending timestamp (in milliseconds since the Unix Epoch)

protected int|null $before = null

$oob

if true, the method return also the location from out of band Messages

protected bool|null $oob = null

$since

Starting timestamp (in milliseconds since the Unix Epoch)

protected int|null $since = 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>

setBefore()

Setter for before

public setBefore(int $before) : static
Parameters
$before : int

Ending timestamp (in milliseconds since the Unix Epoch)

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

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

setOob()

Setter for oob

public setOob(bool $oob) : static
Parameters
$oob : bool

if true, the method return also the location from out of band Messages

Return values
static

To use in method chains

setSince()

Setter for since

public setSince(int $since) : static
Parameters
$since : int

Starting timestamp (in milliseconds since the Unix Epoch)

Return values
static

To use in method chains

Search results