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

Arguments for Api::sendLocation. More...

#include <Types.h>

Public Attributes

std::variant< std::int64_t, std::string > chatId { }
 Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username.
double latitude { }
 Latitude of the location.
double longitude { }
 Longitude of the location.
std::int32_t livePeriod = 0
 Period in seconds during which the location will be updated (see Live Locations), must be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely. Must be 0 for ephemeral messages.
std::shared_ptr< ReplyParameters > replyParameters = nullptr
 Description of the message to reply to.
std::variant< std::shared_ptr< InlineKeyboardMarkup >, std::shared_ptr< ReplyKeyboardMarkup >, std::shared_ptr< ReplyKeyboardRemove >, std::shared_ptr< ForceReply > > replyMarkup = { }
 Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
bool disableNotification = false
 Sends the message silently. Users will receive a notification with no sound.
double horizontalAccuracy = 0
 The radius of uncertainty for the location, measured in meters; 0-1500.
std::int32_t heading = 0
 For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.
std::int32_t proximityAlertRadius = 0
 For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.
std::int32_t messageThreadId = 0
 Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only.
bool protectContent = false
 Protects the contents of the sent message from forwarding and saving.
std::string businessConnectionId = ""
 Unique identifier of the business connection on behalf of which the message will be sent.
bool allowPaidBroadcast = false
 Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
std::string callbackQueryId = ""
 Identifier of the callback query which triggered the ephemeral message.
std::int64_t directMessagesTopicId = 0
 Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat.
std::string messageEffectId = ""
 Unique identifier of the message effect to be added to the message; for private chats only.
std::int64_t receiverUserId = 0
 Identifier of the user who will receive the ephemeral message.
std::shared_ptr< SuggestedPostParameters > suggestedPostParameters = nullptr
 A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
std::shared_ptr< EphemeralMessageParameters > ephemeralMessageParameters = nullptr
 A JSON-serialized object containing the parameters of the ephemeral message to send.

Detailed Description

Arguments for Api::sendLocation.

Definition at line 18645 of file Types.h.

Member Data Documentation

◆ allowPaidBroadcast

bool TgBot::SendLocationArgs::allowPaidBroadcast = false

Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.

Definition at line 18731 of file Types.h.

◆ businessConnectionId

std::string TgBot::SendLocationArgs::businessConnectionId = ""

Unique identifier of the business connection on behalf of which the message will be sent.

Definition at line 18724 of file Types.h.

◆ callbackQueryId

std::string TgBot::SendLocationArgs::callbackQueryId = ""

Identifier of the callback query which triggered the ephemeral message.

Definition at line 18736 of file Types.h.

◆ chatId

std::variant<std::int64_t, std::string> TgBot::SendLocationArgs::chatId { }

Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username.

Definition at line 18650 of file Types.h.

◆ directMessagesTopicId

std::int64_t TgBot::SendLocationArgs::directMessagesTopicId = 0

Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat.

Definition at line 18742 of file Types.h.

◆ disableNotification

bool TgBot::SendLocationArgs::disableNotification = false

Sends the message silently. Users will receive a notification with no sound.

Definition at line 18688 of file Types.h.

◆ ephemeralMessageParameters

std::shared_ptr<EphemeralMessageParameters> TgBot::SendLocationArgs::ephemeralMessageParameters = nullptr

A JSON-serialized object containing the parameters of the ephemeral message to send.

Definition at line 18767 of file Types.h.

◆ heading

std::int32_t TgBot::SendLocationArgs::heading = 0

For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.

Definition at line 18699 of file Types.h.

◆ horizontalAccuracy

double TgBot::SendLocationArgs::horizontalAccuracy = 0

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

Definition at line 18693 of file Types.h.

◆ latitude

double TgBot::SendLocationArgs::latitude { }

Latitude of the location.

Definition at line 18655 of file Types.h.

◆ livePeriod

std::int32_t TgBot::SendLocationArgs::livePeriod = 0

Period in seconds during which the location will be updated (see Live Locations), must be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely. Must be 0 for ephemeral messages.

Definition at line 18668 of file Types.h.

◆ longitude

double TgBot::SendLocationArgs::longitude { }

Longitude of the location.

Definition at line 18660 of file Types.h.

◆ messageEffectId

std::string TgBot::SendLocationArgs::messageEffectId = ""

Unique identifier of the message effect to be added to the message; for private chats only.

Definition at line 18748 of file Types.h.

◆ messageThreadId

std::int32_t TgBot::SendLocationArgs::messageThreadId = 0

Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only.

Definition at line 18713 of file Types.h.

◆ protectContent

bool TgBot::SendLocationArgs::protectContent = false

Protects the contents of the sent message from forwarding and saving.

Definition at line 18718 of file Types.h.

◆ proximityAlertRadius

std::int32_t TgBot::SendLocationArgs::proximityAlertRadius = 0

For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.

Definition at line 18706 of file Types.h.

◆ receiverUserId

std::int64_t TgBot::SendLocationArgs::receiverUserId = 0

Identifier of the user who will receive the ephemeral message.

Definition at line 18753 of file Types.h.

◆ replyMarkup

std::variant<std::shared_ptr<InlineKeyboardMarkup>, std::shared_ptr<ReplyKeyboardMarkup>, std::shared_ptr<ReplyKeyboardRemove>, std::shared_ptr<ForceReply> > TgBot::SendLocationArgs::replyMarkup = { }

Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.

Definition at line 18682 of file Types.h.

◆ replyParameters

std::shared_ptr<ReplyParameters> TgBot::SendLocationArgs::replyParameters = nullptr

Description of the message to reply to.

Definition at line 18673 of file Types.h.

◆ suggestedPostParameters

std::shared_ptr<SuggestedPostParameters> TgBot::SendLocationArgs::suggestedPostParameters = nullptr

A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

Definition at line 18761 of file Types.h.


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