# Pyrogram - Telegram MTProto API Client Library for Python
# Copyright (C) 2017-present Dan <https://github.com/delivrance>
#
# This file is part of Pyrogram.
#
# Pyrogram is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Pyrogram is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with Pyrogram. If not, see <http://www.gnu.org/licenses/>.
from io import BytesIO
from pyrogram.raw.core.primitives import Int, Long, Int128, Int256, Bool, Bytes, String, Double, Vector
from pyrogram.raw.core import TLObject
from pyrogram import raw
from typing import List, Optional, Any
# # # # # # # # # # # # # # # # # # # # # # # #
# !!! WARNING !!! #
# This is a generated file! #
# All changes made in this file will be lost! #
# # # # # # # # # # # # # # # # # # # # # # # #
[docs]
class ReplyKeyboardMarkup(TLObject): # type: ignore
"""Represents a reply keyboard
Constructor of :obj:`~pyrogram.raw.base.ReplyMarkup`.
Details:
- Layer: ``229``
- ID: ``85DD99D1``
Parameters:
rows (List of :obj:`KeyboardButtonRow <pyrogram.raw.base.KeyboardButtonRow>`):
Button row
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.
force_reply (``bool``, *optional*):
N/A
placeholder (``str``, *optional*):
The placeholder to be shown in the input field when the keyboard is active; 1-64 characters.
"""
__slots__: List[str] = ["rows", "resize", "single_use", "selective", "persistent", "force_reply", "placeholder"]
ID = 0x85dd99d1
QUALNAME = "types.ReplyKeyboardMarkup"
def __init__(self, *, rows: List["raw.base.KeyboardButtonRow"], resize: Optional[bool] = None, single_use: Optional[bool] = None, selective: Optional[bool] = None, persistent: Optional[bool] = None, force_reply: Optional[bool] = None, placeholder: Optional[str] = None) -> None:
self.rows = rows # Vector<KeyboardButtonRow>
self.resize = resize # flags.0?true
self.single_use = single_use # flags.1?true
self.selective = selective # flags.2?true
self.persistent = persistent # flags.4?true
self.force_reply = force_reply # flags.5?true
self.placeholder = placeholder # flags.3?string
@staticmethod
def read(b: BytesIO, *args: Any) -> "ReplyKeyboardMarkup":
flags = Int.read(b)
resize = True if flags & (1 << 0) else False
single_use = True if flags & (1 << 1) else False
selective = True if flags & (1 << 2) else False
persistent = True if flags & (1 << 4) else False
force_reply = True if flags & (1 << 5) else False
rows = TLObject.read(b)
placeholder = String.read(b) if flags & (1 << 3) else None
return ReplyKeyboardMarkup(rows=rows, resize=resize, single_use=single_use, selective=selective, persistent=persistent, force_reply=force_reply, placeholder=placeholder)
def write(self, *args) -> bytes:
b = BytesIO()
b.write(Int(self.ID, False))
flags = 0
flags |= (1 << 0) if self.resize else 0
flags |= (1 << 1) if self.single_use else 0
flags |= (1 << 2) if self.selective else 0
flags |= (1 << 4) if self.persistent else 0
flags |= (1 << 5) if self.force_reply else 0
flags |= (1 << 3) if self.placeholder is not None else 0
b.write(Int(flags))
b.write(Vector(self.rows))
if self.placeholder is not None:
b.write(String(self.placeholder))
return b.getvalue()