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

Arguments for Api::sendVenue. 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 venue.
double longitude { }
 Longitude of the venue.
std::string title { }
 Name of the venue.
std::string address { }
 Address of the venue.
std::string foursquareId = ""
 Foursquare identifier of the venue.
std::string foursquareType = ""
 Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.).
bool disableNotification = false
 Sends the message silently. Users will receive a notification with no sound.
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.
std::string googlePlaceId = ""
 Google Places identifier of the venue.
std::string googlePlaceType = ""
 Google Places type of the venue. (See supported types.).
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::sendVenue.

Definition at line 19730 of file Types.h.

Member Data Documentation

◆ address

std::string TgBot::SendVenueArgs::address { }

Address of the venue.

Definition at line 19755 of file Types.h.

◆ allowPaidBroadcast

bool TgBot::SendVenueArgs::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 19822 of file Types.h.

◆ businessConnectionId

std::string TgBot::SendVenueArgs::businessConnectionId = ""

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

Definition at line 19815 of file Types.h.

◆ callbackQueryId

std::string TgBot::SendVenueArgs::callbackQueryId = ""

Identifier of the callback query which triggered the ephemeral message.

Definition at line 19827 of file Types.h.

◆ chatId

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

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

Definition at line 19735 of file Types.h.

◆ directMessagesTopicId

std::int64_t TgBot::SendVenueArgs::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 19833 of file Types.h.

◆ disableNotification

bool TgBot::SendVenueArgs::disableNotification = false

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

Definition at line 19773 of file Types.h.

◆ ephemeralMessageParameters

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

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

Definition at line 19858 of file Types.h.

◆ foursquareId

std::string TgBot::SendVenueArgs::foursquareId = ""

Foursquare identifier of the venue.

Definition at line 19760 of file Types.h.

◆ foursquareType

std::string TgBot::SendVenueArgs::foursquareType = ""

Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.).

Definition at line 19767 of file Types.h.

◆ googlePlaceId

std::string TgBot::SendVenueArgs::googlePlaceId = ""

Google Places identifier of the venue.

Definition at line 19792 of file Types.h.

◆ googlePlaceType

std::string TgBot::SendVenueArgs::googlePlaceType = ""

Google Places type of the venue. (See supported types.).

Definition at line 19797 of file Types.h.

◆ latitude

double TgBot::SendVenueArgs::latitude { }

Latitude of the venue.

Definition at line 19740 of file Types.h.

◆ longitude

double TgBot::SendVenueArgs::longitude { }

Longitude of the venue.

Definition at line 19745 of file Types.h.

◆ messageEffectId

std::string TgBot::SendVenueArgs::messageEffectId = ""

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

Definition at line 19839 of file Types.h.

◆ messageThreadId

std::int32_t TgBot::SendVenueArgs::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 19804 of file Types.h.

◆ protectContent

bool TgBot::SendVenueArgs::protectContent = false

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

Definition at line 19809 of file Types.h.

◆ receiverUserId

std::int64_t TgBot::SendVenueArgs::receiverUserId = 0

Identifier of the user who will receive the ephemeral message.

Definition at line 19844 of file Types.h.

◆ replyMarkup

std::variant<std::shared_ptr<InlineKeyboardMarkup>, std::shared_ptr<ReplyKeyboardMarkup>, std::shared_ptr<ReplyKeyboardRemove>, std::shared_ptr<ForceReply> > TgBot::SendVenueArgs::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 19787 of file Types.h.

◆ replyParameters

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

Description of the message to reply to.

Definition at line 19778 of file Types.h.

◆ suggestedPostParameters

std::shared_ptr<SuggestedPostParameters> TgBot::SendVenueArgs::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 19852 of file Types.h.

◆ title

std::string TgBot::SendVenueArgs::title { }

Name of the venue.

Definition at line 19750 of file Types.h.


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