peyk.platforms.telegram.types.reply_keyboard_remove

Classes

ReplyKeyboardRemove([remove_keyboard, selective])

Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard.

class peyk.platforms.telegram.types.reply_keyboard_remove.ReplyKeyboardRemove(remove_keyboard: bool = True, selective: bool | None = None)

Bases: object

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). Not supported in channels and for messages sent on behalf of a business account.

Variables:

• remove_keyboard (bool) – 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 (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 to a message in the same chat and forum topic, sender of the original message.

Example: A user votes in a poll, bot returns confirmation message in reply to the vote and removes the keyboard for that user, while still showing the keyboard with poll options to users who haven’t voted yet.

remove_keyboard: bool = True

selective: bool | None = None

classmethod from_dict(data: dict | None) → ReplyKeyboardRemove | None

Provides the from dict operation for the Telegram integration.

Parameters:

data – Value used by this operation.

Returns:

Result produced by the operation.

to_dict() → Dict[str, object]

Provides the to dict operation for the Telegram integration.

Returns:

Result produced by the operation.