tgbot-cpp
Loading...
Searching...
No Matches
TgBot::Location Class Reference

This object represents a point on the map. More...

#include <Location.h>

Public Types

typedef std::shared_ptr< LocationPtr
 

Public Attributes

float latitude
 Latitude as defined by sender.
 
float longitude
 Longitude as defined by sender.
 
float horizontalAccuracy
 Optional. The radius of uncertainty for the location, measured in meters; 0-1500.
 
std::int32_t livePeriod
 Optional. Time relative to the message sending date, during which the location can be updated; in seconds.
 
std::int32_t heading
 Optional. The direction in which user is moving, in degrees; 1-360.
 
std::int32_t proximityAlertRadius
 Optional. The maximum distance for proximity alerts about approaching another chat member, in meters.
 

Detailed Description

This object represents a point on the map.

Definition at line 14 of file Location.h.

Member Typedef Documentation

◆ Ptr

typedef std::shared_ptr<Location> TgBot::Location::Ptr

Definition at line 17 of file Location.h.

Member Data Documentation

◆ heading

std::int32_t TgBot::Location::heading

Optional. The direction in which user is moving, in degrees; 1-360.

For active live locations only.

Definition at line 46 of file Location.h.

◆ horizontalAccuracy

float TgBot::Location::horizontalAccuracy

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

Definition at line 32 of file Location.h.

◆ latitude

float TgBot::Location::latitude

Latitude as defined by sender.

Definition at line 22 of file Location.h.

◆ livePeriod

std::int32_t TgBot::Location::livePeriod

Optional. Time relative to the message sending date, during which the location can be updated; in seconds.

For active live locations only.

Definition at line 39 of file Location.h.

◆ longitude

float TgBot::Location::longitude

Longitude as defined by sender.

Definition at line 27 of file Location.h.

◆ proximityAlertRadius

std::int32_t TgBot::Location::proximityAlertRadius

Optional. The maximum distance for proximity alerts about approaching another chat member, in meters.

For sent live locations only.

Definition at line 53 of file Location.h.


The documentation for this class was generated from the following file: