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

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

#include <Types.h>

Public Types

using Ptr = std::shared_ptr<Location>

Public Attributes

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

Detailed Description

This object represents a point on the map.

Definition at line 8618 of file Types.h.

Member Typedef Documentation

◆ Ptr

using TgBot::Location::Ptr = std::shared_ptr<Location>

Definition at line 8619 of file Types.h.

Member Data Documentation

◆ heading

std::optional<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 8646 of file Types.h.

◆ horizontalAccuracy

std::optional<double> TgBot::Location::horizontalAccuracy { }

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

Definition at line 8634 of file Types.h.

◆ latitude

double TgBot::Location::latitude { }

Latitude as defined by the sender.

Definition at line 8624 of file Types.h.

◆ livePeriod

std::optional<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 8640 of file Types.h.

◆ longitude

double TgBot::Location::longitude { }

Longitude as defined by the sender.

Definition at line 8629 of file Types.h.

◆ proximityAlertRadius

std::optional<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 8652 of file Types.h.


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