ReplyKeyboardMarkup¶
class telegram. ReplyKeyboardMarkup ( keyboard , resize_keyboard = None , one_time_keyboard = None , selective = None , input_field_placeholder = None , is_persistent = None , * , api_kwargs = None ) [source] ¶ Bases: telegram.TelegramObject This object represents a custom keyboard with reply options. Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their size of keyboard and all the buttons are equal.
- telegram.Bot.copy_message()
- telegram.Bot.send_animation()
- telegram.Bot.send_audio()
- telegram.Bot.send_contact()
- telegram.Bot.send_dice()
- telegram.Bot.send_document()
- telegram.Bot.send_location()
- telegram.Bot.send_message()
- telegram.Bot.send_photo()
- telegram.Bot.send_poll()
- telegram.Bot.send_sticker()
- telegram.Bot.send_venue()
- telegram.Bot.send_video_note()
- telegram.Bot.send_video()
- telegram.Bot.send_voice()
An another kind of keyboard would be the telegram.InlineKeyboardMarkup .
- Example usage: 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.
- Conversation Bot
- Conversation Bot 2
- keyboard (Sequence[Sequence[ str | telegram.KeyboardButton ]]) – Array of button rows, each represented by an Array of telegram.KeyboardButton objects.
- resize_keyboard ( 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). Defaults to False , in which case the custom keyboard is always of the same height as the app’s standard keyboard.
- one_time_keyboard ( 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. Defaults to False .
- selective ( bool , optional) – Use this parameter if you want to show the keyboard to specific users only. Targets:
- Users that are @mentioned in the text of the telegram.Message object.
- If the bot’s message is a reply (has reply_to_message_id ), sender of the original message.
Array of button rows, each represented by an Array of telegram.KeyboardButton objects.
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.
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 .
Optional. Show the keyboard to specific users only. Targets:
- Users that are @mentioned in the text of the telegram.Message object.
- If the bot’s message is a reply (has reply_to_message_id ), sender of the original message.
Optional. The placeholder to be shown in the input field when the keyboard is active; 1 — 64 characters.
Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. If False , the custom keyboard can be hidden and opened with a keyboard icon.
classmethod from_button ( button , resize_keyboard = False , one_time_keyboard = False , selective = False , input_field_placeholder = None , is_persistent = None , ** kwargs ) [source] ¶
ReplyKeyboardMarkup([[button]], **kwargs)
Return a ReplyKeyboardMarkup from a single KeyboardButton.
- button ( telegram.KeyboardButton | str ) – The button to use in the markup.
- resize_keyboard ( 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). Defaults to False , in which case the custom keyboard is always of the same height as the app’s standard keyboard.
- one_time_keyboard ( 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. Defaults to False .
- selective ( bool , optional) – Use this parameter if you want to show the keyboard to specific users only. Targets:
- Users that are @mentioned in the text of the Message object.
- If the bot’s message is a reply (has reply_to_message_id ), sender of the original message.
ReplyKeyboardMarkup([[button] for button in button_column], **kwargs)
Return a ReplyKeyboardMarkup from a single column of KeyboardButtons.
- Users that are @mentioned in the text of the Message object.
- If the bot’s message is a reply (has reply_to_message_id ), sender of the original message.
ReplyKeyboardMarkup([button_row], **kwargs)
Return a ReplyKeyboardMarkup from a single row of KeyboardButtons.
- Users that are @mentioned in the text of the Message object.
- If the bot’s message is a reply (has reply_to_message_id ), sender of the original message.
telegram.ReplyKeyboardMarkup¶
class telegram. ReplyKeyboardMarkup ( keyboard: List[List[Union[str, telegram.keyboardbutton.KeyboardButton]]], resize_keyboard: bool = False, one_time_keyboard: bool = False, selective: bool = False, **_kwargs ) ¶
This object represents a custom keyboard with reply options.
Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their the size of keyboard and all the buttons are equal.
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.
| Type: | List[List[ telegram.KeyboardButton | str ]] |
|---|
resize_keyboard ¶
Optional. Requests clients to resize the keyboard.
| Type: | bool |
|---|
one_time_keyboard ¶
Optional. Requests clients to hide the keyboard as soon as it’s been used.
Optional. Show the keyboard to specific users only.
| Type: | bool |
|---|
classmethod from_button ( button: Union[telegram.keyboardbutton.KeyboardButton, str], resize_keyboard: bool = False, one_time_keyboard: bool = False, selective: bool = False, **kwargs ) → telegram.replykeyboardmarkup.ReplyKeyboardMarkup¶
ReplyKeyboardMarkup([[button]], **kwargs)
Return a ReplyKeyboardMarkup from a single KeyboardButton.
- button ( telegram.KeyboardButton | str ) – The button to use in the markup.
- resize_keyboard ( 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). Defaults to False , in which case the custom keyboard is always of the same height as the app’s standard keyboard.
- one_time_keyboard ( 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. Defaults to False .
- selective ( bool , optional) – Use this parameter if you want to show the keyboard to specific users only. Targets:
- Users that are @mentioned in the text of the Message object.
- If the bot’s message is a reply (has reply_to_message_id), sender of the original message.
ReplyKeyboardMarkup([[button] for button in button_column], **kwargs)
Return a ReplyKeyboardMarkup from a single column of KeyboardButtons.
- button_column (List[ telegram.KeyboardButton | str ]) – The button to use in the markup.
- resize_keyboard ( 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). Defaults to False , in which case the custom keyboard is always of the same height as the app’s standard keyboard.
- one_time_keyboard ( 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. Defaults to False .
- selective ( bool , optional) – Use this parameter if you want to show the keyboard to specific users only. Targets:
- Users that are @mentioned in the text of the Message object.
- If the bot’s message is a reply (has reply_to_message_id), sender of the original message.
ReplyKeyboardMarkup([button_row], **kwargs)
Return a ReplyKeyboardMarkup from a single row of KeyboardButtons.
- button_row (List[ telegram.KeyboardButton | str ]) – The button to use in the markup.
- resize_keyboard ( 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). Defaults to False , in which case the custom keyboard is always of the same height as the app’s standard keyboard.
- one_time_keyboard ( 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. Defaults to False .
- selective ( bool , optional) – Use this parameter if you want to show the keyboard to specific users only. Targets:
- Users that are @mentioned in the text of the Message object.
- If the bot’s message is a reply (has reply_to_message_id), sender of the original message.
© Copyright 2015-2021, Leandro Toledo Revision e9c01c77 .