tgbot-cpp
Loading...
Searching...
No Matches
Public Types | Public Attributes | List of all members
TgBot::InlineKeyboardButton Class Reference
Types

This object represents one button of an inline keyboard. 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.
 
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.
 
LoginUrl::Ptr loginUrl
 Optional. An HTTPS URL used to automatically authorize the user.
 
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.
 
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.
 
SwitchInlineQueryChosenChat::Ptr 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.
 
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.
 

Detailed Description

This object represents one button of an inline keyboard.

You must use exactly one of the optional fields.

Definition at line 21 of file InlineKeyboardButton.h.

Member Typedef Documentation

◆ Ptr

typedef std::shared_ptr<InlineKeyboardButton> TgBot::InlineKeyboardButton::Ptr

Definition at line 24 of file InlineKeyboardButton.h.

Member Data Documentation

◆ callbackData

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 41 of file InlineKeyboardButton.h.

◆ callbackGame

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 83 of file InlineKeyboardButton.h.

◆ loginUrl

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 56 of file InlineKeyboardButton.h.

◆ pay

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 90 of file InlineKeyboardButton.h.

◆ switchInlineQuery

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.

Definition at line 63 of file InlineKeyboardButton.h.

◆ switchInlineQueryChosenChat

SwitchInlineQueryChosenChat::Ptr 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.

Definition at line 76 of file InlineKeyboardButton.h.

◆ switchInlineQueryCurrentChat

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 71 of file InlineKeyboardButton.h.

◆ text

std::string TgBot::InlineKeyboardButton::text

Label text on the button.

Definition at line 29 of file InlineKeyboardButton.h.

◆ url

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 36 of file InlineKeyboardButton.h.

◆ webApp

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 49 of file InlineKeyboardButton.h.

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