PHP Sigfox Client

CoveragesGlobalPredictionsGetOne extends Request

Get coverage margins for a selected latitude and longitude, for each redundancy level.

For more information please refer to the Global Coverage API article.

Table of Contents

$groupId  : string|null
the id of a group to include its operator in the global coverage
$lat  : float|null
the latitude
$lng  : float|null
the longitude
$radius  : int|null
The radius of the area in which the coverage results are averaged and returned for a selected location, in meters.
from()  : static
Initializing a model from an array
jsonSerialize()  : array<string|int, mixed>
setGroupId()  : static
Setter for groupId
setLat()  : static
Setter for lat
setLng()  : static
Setter for lng
setRadius()  : static
Setter for radius

Properties

$radius

The radius of the area in which the coverage results are averaged and returned for a selected location, in meters.

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

setGroupId()

Setter for groupId

public setGroupId(string $groupId) : static
Parameters
$groupId : string

the id of a group to include its operator in the global coverage

Return values
static

To use in method chains

setLat()

Setter for lat

public setLat(float $lat) : static
Parameters
$lat : float

the latitude

Return values
static

To use in method chains

setLng()

Setter for lng

public setLng(float $lng) : static
Parameters
$lng : float

the longitude

Return values
static

To use in method chains

setRadius()

Setter for radius

public setRadius(int $radius) : static
Parameters
$radius : int

The radius of the area in which the coverage results are averaged and returned for a selected location, in meters.

Return values
static

To use in method chains

Search results