This object represents a custom keyboard with reply options (see Introduction to bots for details and examples). Not supported in channels and for messages sent on behalf of a business account. More...

#include <Types.h>

Public Types
using	Ptr = std::shared_ptr<ReplyKeyboardMarkup>

Public Attributes
std::vector< std::vector< std::shared_ptr< KeyboardButton > > >	keyboard { }
	Array of button rows, each represented by an Array of KeyboardButton objects.
std::optional< bool >	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.
std::optional< 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). Defaults to False, in which case the custom keyboard is always of the same height as the app's standard keyboard.
std::optional< bool >	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.
std::optional< std::string >	inputFieldPlaceholder { }
	Optional. The placeholder to be shown in the input field when the keyboard is active; 1-64 characters.
std::optional< bool >	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 to a message in the same chat and forum topic, 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.

Detailed Description

This object represents a custom keyboard with reply options (see Introduction to bots for details and examples). Not supported in channels and for messages sent on behalf of a business account.

Definition at line 11387 of file Types.h.

Member Typedef Documentation

◆ Ptr

using TgBot::ReplyKeyboardMarkup::Ptr = std::shared_ptr<ReplyKeyboardMarkup>

Definition at line 11388 of file Types.h.

Member Data Documentation

◆ inputFieldPlaceholder

std::optional<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 11421 of file Types.h.

◆ isPersistent

std::optional<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 11400 of file Types.h.

◆ keyboard

std::vector<std::vector<std::shared_ptr<KeyboardButton> > > TgBot::ReplyKeyboardMarkup::keyboard { }

Array of button rows, each represented by an Array of KeyboardButton objects.

Definition at line 11393 of file Types.h.

◆ oneTimeKeyboard

std::optional<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 11415 of file Types.h.

◆ resizeKeyboard

std::optional<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 11407 of file Types.h.

◆ selective

std::optional<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 to a message in the same chat and forum topic, 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 11431 of file Types.h.

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

include/tgbot/Types.h

Public Types

Public Attributes