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

Arguments for Api::sendContact. 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.
std::string phoneNumber { }
 Contact's phone number.
std::string firstName { }
 Contact's first name.
std::string lastName = ""
 Contact's last name.
std::string vcard = ""
 Additional data about the contact in the form of a vCard, 0-2048 bytes.
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::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::sendContact.

Definition at line 17851 of file Types.h.

Member Data Documentation

◆ allowPaidBroadcast

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

◆ businessConnectionId

std::string TgBot::SendContactArgs::businessConnectionId = ""

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

Definition at line 17914 of file Types.h.

◆ callbackQueryId

std::string TgBot::SendContactArgs::callbackQueryId = ""

Identifier of the callback query which triggered the ephemeral message.

Definition at line 17926 of file Types.h.

◆ chatId

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

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

Definition at line 17856 of file Types.h.

◆ directMessagesTopicId

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

◆ disableNotification

bool TgBot::SendContactArgs::disableNotification = false

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

Definition at line 17882 of file Types.h.

◆ ephemeralMessageParameters

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

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

Definition at line 17957 of file Types.h.

◆ firstName

std::string TgBot::SendContactArgs::firstName { }

Contact's first name.

Definition at line 17866 of file Types.h.

◆ lastName

std::string TgBot::SendContactArgs::lastName = ""

Contact's last name.

Definition at line 17871 of file Types.h.

◆ messageEffectId

std::string TgBot::SendContactArgs::messageEffectId = ""

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

Definition at line 17938 of file Types.h.

◆ messageThreadId

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

◆ phoneNumber

std::string TgBot::SendContactArgs::phoneNumber { }

Contact's phone number.

Definition at line 17861 of file Types.h.

◆ protectContent

bool TgBot::SendContactArgs::protectContent = false

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

Definition at line 17908 of file Types.h.

◆ receiverUserId

std::int64_t TgBot::SendContactArgs::receiverUserId = 0

Identifier of the user who will receive the ephemeral message.

Definition at line 17943 of file Types.h.

◆ replyMarkup

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

◆ replyParameters

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

Description of the message to reply to.

Definition at line 17887 of file Types.h.

◆ suggestedPostParameters

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

◆ vcard

std::string TgBot::SendContactArgs::vcard = ""

Additional data about the contact in the form of a vCard, 0-2048 bytes.

Definition at line 17876 of file Types.h.


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