MadelineProtoDocs/docs/API_docs/constructors/replyKeyboardMarkup.md
2024-05-01 14:53:46 +02:00

2.1 KiB
Raw Blame History

title description nav_exclude image
replyKeyboardMarkup Bot keyboard true https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png

Constructor: replyKeyboardMarkup

Back to constructors index

Bot keyboard

Attributes:

Name Type Required Description
resize Bool 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). If not set, the custom keyboard is always of the same height as the app's standard keyboard.
single_use Bool 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.
selective Bool 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.
persistent Bool Optional Requests clients to always show the keyboard when the regular keyboard is hidden.
rows Array of KeyboardButtonRow Yes Button row
placeholder string Optional The placeholder to be shown in the input field when the keyboard is active; 1-64 characters.

Type: ReplyMarkup

Example:

$replyKeyboardMarkup = ['_' => 'replyKeyboardMarkup', 'resize' => Bool, 'single_use' => Bool, 'selective' => Bool, 'persistent' => Bool, 'rows' => [KeyboardButtonRow, KeyboardButtonRow], 'placeholder' => 'string'];