class Location

This object represents a point on the map.

Methods

__construct(float $longitude, float $latitude, float|null $horizontal_accuracy = null, int|null $live_period = null, int|null $heading = null, int|null $proximity_alert_radius = null)

No description

float
getLongitude()

Longitude as defined by sender.

float
getLatitude()

Latitude as defined by sender.

float|null
getHorizontalAccuracy()

Optional. The radius of uncertainty for the location, measured in meters; 0-1500.

int|null
getLivePeriod()

Optional. Time relative to the message sending date, during which the location can be updated; in seconds. For active live locations only.

int|null
getHeading()

Optional. The direction in which user is moving, in degrees; 1-360. For active live locations only.

int|null
getProximityAlertRadius()

Optional. The maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only.

Details

at line 18
__construct(float $longitude, float $latitude, float|null $horizontal_accuracy = null, int|null $live_period = null, int|null $heading = null, int|null $proximity_alert_radius = null)

No description

Parameters

float $longitude
float $latitude
float|null $horizontal_accuracy
int|null $live_period
int|null $heading
int|null $proximity_alert_radius

at line 31
float getLongitude()

Longitude as defined by sender.

Return Value

float

at line 39
float getLatitude()

Latitude as defined by sender.

Return Value

float

at line 47
float|null getHorizontalAccuracy()

Optional. The radius of uncertainty for the location, measured in meters; 0-1500.

Return Value

float|null

at line 55
int|null getLivePeriod()

Optional. Time relative to the message sending date, during which the location can be updated; in seconds. For active live locations only.

Return Value

int|null

at line 63
int|null getHeading()

Optional. The direction in which user is moving, in degrees; 1-360. For active live locations only.

Return Value

int|null

at line 71
int|null getProximityAlertRadius()

Optional. The maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only.

Return Value

int|null