This object represents a custom keyboard with reply options (see https://core.telegram.org/bots/features#keyboards for details and examples). More...
#include <ReplyKeyboardMarkup.h>
Public Types | |
| typedef std::shared_ptr< ReplyKeyboardMarkup > | Ptr |
 Public Types inherited from TgBot::GenericReply | |
| typedef std::shared_ptr< GenericReply > | Ptr |
Public Attributes | |
| std::vector< std::vector< KeyboardButton::Ptr > > | keyboard |
| Array of button rows, each represented by an Array of KeyboardButton objects. | |
| bool | isPersistent |
| Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. | |
| bool | resizeKeyboard |
| Optional. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). | |
| bool | oneTimeKeyboard |
| Optional. Requests clients to hide the keyboard as soon as it's been used. | |
| std::string | inputFieldPlaceholder |
| Optional. The placeholder to be shown in the input field when the keyboard is active; 1-64 characters. | |
| bool | selective |
| Optional. Use this parameter if you want to show the keyboard to specific users only. | |
Additional Inherited Members | |
| Public Member Functions inherited from TgBot::GenericReply | |
| virtual | ~GenericReply () |
Detailed Description
This object represents a custom keyboard with reply options (see https://core.telegram.org/bots/features#keyboards for details and examples).
Definition at line 18 of file ReplyKeyboardMarkup.h.
Member Typedef Documentation
◆ Ptr
| typedef std::shared_ptr<ReplyKeyboardMarkup> TgBot::ReplyKeyboardMarkup::Ptr |
Definition at line 21 of file ReplyKeyboardMarkup.h.
Member Data Documentation
◆ inputFieldPlaceholder
| std::string TgBot::ReplyKeyboardMarkup::inputFieldPlaceholder |
Optional. The placeholder to be shown in the input field when the keyboard is active; 1-64 characters.
Definition at line 53 of file ReplyKeyboardMarkup.h.
◆ isPersistent
| bool TgBot::ReplyKeyboardMarkup::isPersistent |
Optional. Requests clients to always show the keyboard when the regular keyboard is hidden.
Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon.
Definition at line 33 of file ReplyKeyboardMarkup.h.
◆ keyboard
| std::vector<std::vector<KeyboardButton::Ptr> > TgBot::ReplyKeyboardMarkup::keyboard |
Array of button rows, each represented by an Array of KeyboardButton objects.
Definition at line 26 of file ReplyKeyboardMarkup.h.
◆ oneTimeKeyboard
| bool TgBot::ReplyKeyboardMarkup::oneTimeKeyboard |
Optional. Requests clients to hide the keyboard as soon as it's been used.
The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat - the user can press a special button in the input field to see the custom keyboard again. Defaults to false.
Definition at line 48 of file ReplyKeyboardMarkup.h.
◆ resizeKeyboard
| bool TgBot::ReplyKeyboardMarkup::resizeKeyboard |
Optional. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons).
Defaults to false, in which case the custom keyboard is always of the same height as the app's standard keyboard.
Definition at line 40 of file ReplyKeyboardMarkup.h.
◆ selective
| bool TgBot::ReplyKeyboardMarkup::selective |
Optional. Use this parameter if you want to show the keyboard to specific users only.
Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has replyToMessageId), sender of the original message.
Example: A user requests to change the bot's language, bot replies to the request with a keyboard to select the new language. Other users in the group don't see the keyboard.
Definition at line 63 of file ReplyKeyboardMarkup.h.
The documentation for this class was generated from the following file:
- include/tgbot/types/ReplyKeyboardMarkup.h
