tgbot-cpp
|
This object represents one button of an inline keyboard. You must use exactly one of the optional fields. More...
#include <InlineKeyboardButton.h>
Public Types | |
typedef std::shared_ptr< InlineKeyboardButton > | Ptr |
Public Attributes | |
std::string | text |
Label text on the button. | |
std::string | url |
Optional. HTTP or tg:// URL to be opened when the button is pressed. Links tg://user?id=<user_id> can be used to mention a user by their ID without using a username, if this is allowed by their privacy settings. | |
std::string | callbackData |
Optional. Data to be sent in a callback query to the bot when button is pressed, 1-64 bytes. | |
WebAppInfo::Ptr | webApp |
Optional. Description of the Web App that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method Api::answerWebAppQuery. Available only in private chats between a user and the bot. | |
LoginUrl::Ptr | loginUrl |
Optional. An HTTPS URL used to automatically authorize the user. Can be used as a replacement for the Telegram Login Widget. | |
std::string | switchInlineQuery |
Optional. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted. | |
std::string | switchInlineQueryCurrentChat |
Optional. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted. | |
CallbackGame::Ptr | callbackGame |
Optional. Description of the game that will be launched when the user presses the button. | |
bool | pay |
Optional. Specify True, to send a Pay button. | |
This object represents one button of an inline keyboard. You must use exactly one of the optional fields.
Definition at line 19 of file InlineKeyboardButton.h.
typedef std::shared_ptr<InlineKeyboardButton> TgBot::InlineKeyboardButton::Ptr |
Definition at line 21 of file InlineKeyboardButton.h.
std::string TgBot::InlineKeyboardButton::callbackData |
Optional. Data to be sent in a callback query to the bot when button is pressed, 1-64 bytes.
Definition at line 37 of file InlineKeyboardButton.h.
CallbackGame::Ptr TgBot::InlineKeyboardButton::callbackGame |
Optional. Description of the game that will be launched when the user presses the button.
NOTE: This type of button must always be the first button in the first row.
Definition at line 74 of file InlineKeyboardButton.h.
LoginUrl::Ptr TgBot::InlineKeyboardButton::loginUrl |
Optional. An HTTPS URL used to automatically authorize the user. Can be used as a replacement for the Telegram Login Widget.
Definition at line 50 of file InlineKeyboardButton.h.
bool TgBot::InlineKeyboardButton::pay |
Optional. Specify True, to send a Pay button.
NOTE: This type of button must always be the first button in the first row and can only be used in invoice messages.
Definition at line 81 of file InlineKeyboardButton.h.
std::string TgBot::InlineKeyboardButton::switchInlineQuery |
Optional. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted.
Note: This offers an easy way for users to start using your bot in inline mode when they are currently in a private chat with it. Especially useful when combined with switch_pm… actions - in this case the user will be automatically returned to the chat they switched from, skipping the chat selection screen.
Definition at line 59 of file InlineKeyboardButton.h.
std::string TgBot::InlineKeyboardButton::switchInlineQueryCurrentChat |
Optional. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.
This offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options.
Definition at line 67 of file InlineKeyboardButton.h.
std::string TgBot::InlineKeyboardButton::text |
Label text on the button.
Definition at line 26 of file InlineKeyboardButton.h.
std::string TgBot::InlineKeyboardButton::url |
Optional. HTTP or tg:// URL to be opened when the button is pressed. Links tg://user?id=<user_id> can be used to mention a user by their ID without using a username, if this is allowed by their privacy settings.
Definition at line 32 of file InlineKeyboardButton.h.
WebAppInfo::Ptr TgBot::InlineKeyboardButton::webApp |
Optional. Description of the Web App that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method Api::answerWebAppQuery. Available only in private chats between a user and the bot.
Definition at line 44 of file InlineKeyboardButton.h.