aiogram.api.types.reply_keyboard_markup

aiogram/api/types/reply_keyboard_markup.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
from __future__ import annotations

from typing import TYPE_CHECKING, List, Optional

from .base import MutableTelegramObject

if TYPE_CHECKING:  # pragma: no cover
    from .keyboard_button import KeyboardButton


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

    Source: https://core.telegram.org/bots/api#replykeyboardmarkup
    """

    keyboard: List[List[KeyboardButton]]
    """Array of button rows, each represented by an Array of KeyboardButton objects"""
    resize_keyboard: Optional[bool] = None
    """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: Optional[bool] = None
    """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: Optional[bool] = None
    """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."""