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

This object represents one button of an inline keyboard. Exactly one of the fields other than text, icon_custom_emoji_id, and style must be used to specify the type of the button. More...

#include <Types.h>

Public Types

using Ptr = std::shared_ptr<InlineKeyboardButton>

Public Attributes

std::string text { }
 Label text on the button.
std::optional< std::string > iconCustomEmojiId { }
 Optional. Unique identifier of the custom emoji shown before the text of the button. Can only be used by bots that purchased additional usernames on Fragment or in the messages directly sent by the bot to private, group and supergroup chats if the owner of the bot has a Telegram Premium subscription.
std::optional< std::string > style { }
 Optional. Style of the button. Must be one of “danger” (red), “success” (green) or “primary” (blue). If omitted, then an app-specific style is used.
std::optional< 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 identifier without using a username, if this is allowed by their privacy settings.
std::optional< std::string > callbackData { }
 Optional. Data to be sent in a callback query to the bot when the button is pressed, 1-64 bytes.
std::shared_ptr< WebAppInfowebApp { }
 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 answerWebAppQuery. Available only in private chats between a user and the bot. Not supported for messages sent on behalf of a business account.
std::shared_ptr< LoginUrlloginUrl { }
 Optional. An HTTPS URL used to automatically authorize the user. Can be used as a replacement for the Telegram Login Widget.
std::optional< 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. Not supported for messages sent in channel direct messages chats and on behalf of a business account.
std::optional< 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.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. Not supported in channels and for messages sent in channel direct messages chats and on behalf of a business account.
std::shared_ptr< SwitchInlineQueryChosenChatswitchInlineQueryChosenChat { }
 Optional. If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field. Not supported for messages sent in channel direct messages chats and on behalf of a business account.
std::shared_ptr< CopyTextButtoncopyText { }
 Optional. Description of the button that copies the specified text to the clipboard.
std::shared_ptr< CallbackGamecallbackGame { }
 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.
std::optional< bool > pay { }
 Optional. Specify True, to send a Pay button. Substrings “” and “XTR” in the buttons's text will be replaced with a Telegram Star icon.NOTE: This type of button must always be the first button in the first row and can only be used in invoice messages.

Detailed Description

This object represents one button of an inline keyboard. Exactly one of the fields other than text, icon_custom_emoji_id, and style must be used to specify the type of the button.

Definition at line 4324 of file Types.h.

Member Typedef Documentation

◆ Ptr

Definition at line 4325 of file Types.h.

Member Data Documentation

◆ callbackData

std::optional<std::string> TgBot::InlineKeyboardButton::callbackData { }

Optional. Data to be sent in a callback query to the bot when the button is pressed, 1-64 bytes.

Definition at line 4357 of file Types.h.

◆ callbackGame

std::shared_ptr<CallbackGame> 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 4409 of file Types.h.

◆ copyText

std::shared_ptr<CopyTextButton> TgBot::InlineKeyboardButton::copyText { }

Optional. Description of the button that copies the specified text to the clipboard.

Definition at line 4403 of file Types.h.

◆ iconCustomEmojiId

std::optional<std::string> TgBot::InlineKeyboardButton::iconCustomEmojiId { }

Optional. Unique identifier of the custom emoji shown before the text of the button. Can only be used by bots that purchased additional usernames on Fragment or in the messages directly sent by the bot to private, group and supergroup chats if the owner of the bot has a Telegram Premium subscription.

Definition at line 4338 of file Types.h.

◆ loginUrl

std::shared_ptr<LoginUrl> 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 4371 of file Types.h.

◆ pay

std::optional<bool> TgBot::InlineKeyboardButton::pay { }

Optional. Specify True, to send a Pay button. Substrings “” and “XTR” in the buttons's text will be replaced with a Telegram Star icon.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 4416 of file Types.h.

◆ style

std::optional<std::string> TgBot::InlineKeyboardButton::style { }

Optional. Style of the button. Must be one of “danger” (red), “success” (green) or “primary” (blue). If omitted, then an app-specific style is used.

Definition at line 4344 of file Types.h.

◆ switchInlineQuery

std::optional<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. Not supported for messages sent in channel direct messages chats and on behalf of a business account.

Definition at line 4380 of file Types.h.

◆ switchInlineQueryChosenChat

std::shared_ptr<SwitchInlineQueryChosenChat> TgBot::InlineKeyboardButton::switchInlineQueryChosenChat { }

Optional. If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field. Not supported for messages sent in channel direct messages chats and on behalf of a business account.

Definition at line 4398 of file Types.h.

◆ switchInlineQueryCurrentChat

std::optional<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. Not supported in channels and for messages sent in channel direct messages chats and on behalf of a business account.

Definition at line 4390 of file Types.h.

◆ text

std::string TgBot::InlineKeyboardButton::text { }

Label text on the button.

Definition at line 4330 of file Types.h.

◆ url

std::optional<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 identifier without using a username, if this is allowed by their privacy settings.

Definition at line 4351 of file Types.h.

◆ webApp

std::shared_ptr<WebAppInfo> 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 answerWebAppQuery. Available only in private chats between a user and the bot. Not supported for messages sent on behalf of a business account.

Definition at line 4365 of file Types.h.


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