aiogram.api.types.reply_keyboard_remove

aiogram/api/types/reply_keyboard_remove.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
from __future__ import annotations

from typing import Optional

from .base import MutableTelegramObject


class ReplyKeyboardRemove(MutableTelegramObject):
    """
    Upon receiving a message with this object, Telegram clients will remove the current custom
    keyboard and display the default letter-keyboard. By default, custom keyboards are displayed
    until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are
    hidden immediately after the user presses a button (see ReplyKeyboardMarkup).

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

    remove_keyboard: bool = True
    """Requests clients to remove the custom keyboard (user will not be able to summon this
    keyboard; if you want to hide the keyboard from sight but keep it accessible, use
    one_time_keyboard in ReplyKeyboardMarkup)"""
    selective: Optional[bool] = None
    """Use this parameter if you want to remove the keyboard for 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."""