class ReplyKeyboardMarkup

This object represents a custom keyboard with reply options (see Introduction to bots for details and examples).

Methods

__construct(KeyboardButton[][] $keyboard, bool|null $resize_keyboard = null, bool|null $one_time_keyboard = null, string|null $input_field_placeholder = null, bool|null $selective = null)

No description

array
getKeyboard()

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

bool|null
getResizeKeyboard()

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.

bool|null
getOneTimeKeyboard()

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.

string|null
getInputFieldPlaceholder()

Optional. The placeholder to be shown in the input field when the keyboard is active; 1-64 characters.

bool|null
getSelective()

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 reply_to_message_id), 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.

Details

at line 17
__construct(KeyboardButton[][] $keyboard, bool|null $resize_keyboard = null, bool|null $one_time_keyboard = null, string|null $input_field_placeholder = null, bool|null $selective = null)

No description

Parameters

KeyboardButton[][] $keyboard
bool|null $resize_keyboard
bool|null $one_time_keyboard
string|null $input_field_placeholder
bool|null $selective

at line 31
array getKeyboard()

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

Return Value

array

at line 39
bool|null getResizeKeyboard()

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.

Return Value

bool|null

at line 47
bool|null getOneTimeKeyboard()

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.

Return Value

bool|null

at line 55
string|null getInputFieldPlaceholder()

Optional. The placeholder to be shown in the input field when the keyboard is active; 1-64 characters.

Return Value

string|null

at line 63
bool|null getSelective()

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 reply_to_message_id), 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.

Return Value

bool|null