# 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 RequestWebView(TLObject): # type: ignore
"""Open a `bot mini app <https://core.telegram.org/bots/webapps>`_, sending over user information after user confirmation.
.. include:: /_includes/usable-by/users.rst
Details:
- Layer: ``229``
- ID: ``269DC2C1``
Parameters:
peer (:obj:`InputPeer <pyrogram.raw.base.InputPeer>`):
Dialog where the web app is being opened, and where the resulting message will be sent (see the `docs for more info » <https://core.telegram.org/api/bots/webapps>`_ ).
bot (:obj:`InputUser <pyrogram.raw.base.InputUser>`):
Bot that owns the `web app <https://core.telegram.org/api/bots/webapps>`_
platform (``str``):
Short name of the application; 0-64 English letters, digits, and underscores
from_bot_menu (``bool``, *optional*):
Whether the webview was opened by clicking on the bot's `menu button » <https://core.telegram.org/api/bots/menu>`_.
silent (``bool``, *optional*):
Whether the inline message that will be sent by the bot on behalf of the user once the web app interaction is `terminated <https://core.telegram.org/method/messages.sendWebViewResultMessage>`_ should be sent silently (no notifications for the receivers).
compact (``bool``, *optional*):
If set, requests to open the mini app in compact mode (as opposed to normal or fullscreen mode). Must be set if the ``mode`` parameter of the `attachment menu deep link <https://core.telegram.org/api/links#bot-attachment-or-side-menu-links>`_ is equal to ``compact``.
fullscreen (``bool``, *optional*):
If set, requests to open the mini app in fullscreen mode (as opposed to normal or compact mode). Must be set if the ``mode`` parameter of the `attachment menu deep link <https://core.telegram.org/api/links#bot-attachment-or-side-menu-links>`_ is equal to ``fullscreen``.
url (``str``, *optional*):
`Web app URL <https://core.telegram.org/api/bots/webapps>`_
start_param (``str``, *optional*):
If the web app was opened from the attachment menu using a `attachment menu deep link <https://core.telegram.org/api/links#bot-attachment-or-side-menu-links>`_, ``start_param`` should contain the ``data`` from the ``startattach`` parameter.
theme_params (:obj:`DataJSON <pyrogram.raw.base.DataJSON>`, *optional*):
`Theme parameters » <https://core.telegram.org/api/bots/webapps#theme-parameters>`_
reply_to (:obj:`InputReplyTo <pyrogram.raw.base.InputReplyTo>`, *optional*):
If set, indicates that the inline message that will be sent by the bot on behalf of the user once the web app interaction is `terminated <https://core.telegram.org/method/messages.sendWebViewResultMessage>`_ should be sent in reply to the specified message or story.
send_as (:obj:`InputPeer <pyrogram.raw.base.InputPeer>`, *optional*):
Open the web app as the specified peer, sending the resulting the message as the specified peer.
Returns:
:obj:`WebViewResult <pyrogram.raw.base.WebViewResult>`
"""
__slots__: List[str] = ["peer", "bot", "platform", "from_bot_menu", "silent", "compact", "fullscreen", "url", "start_param", "theme_params", "reply_to", "send_as"]
ID = 0x269dc2c1
QUALNAME = "functions.messages.RequestWebView"
def __init__(self, *, peer: "raw.base.InputPeer", bot: "raw.base.InputUser", platform: str, from_bot_menu: Optional[bool] = None, silent: Optional[bool] = None, compact: Optional[bool] = None, fullscreen: Optional[bool] = None, url: Optional[str] = None, start_param: Optional[str] = None, theme_params: "raw.base.DataJSON" = None, reply_to: "raw.base.InputReplyTo" = None, send_as: "raw.base.InputPeer" = None) -> None:
self.peer = peer # InputPeer
self.bot = bot # InputUser
self.platform = platform # string
self.from_bot_menu = from_bot_menu # flags.4?true
self.silent = silent # flags.5?true
self.compact = compact # flags.7?true
self.fullscreen = fullscreen # flags.8?true
self.url = url # flags.1?string
self.start_param = start_param # flags.3?string
self.theme_params = theme_params # flags.2?DataJSON
self.reply_to = reply_to # flags.0?InputReplyTo
self.send_as = send_as # flags.13?InputPeer
@staticmethod
def read(b: BytesIO, *args: Any) -> "RequestWebView":
flags = Int.read(b)
from_bot_menu = True if flags & (1 << 4) else False
silent = True if flags & (1 << 5) else False
compact = True if flags & (1 << 7) else False
fullscreen = True if flags & (1 << 8) else False
peer = TLObject.read(b)
bot = TLObject.read(b)
url = String.read(b) if flags & (1 << 1) else None
start_param = String.read(b) if flags & (1 << 3) else None
theme_params = TLObject.read(b) if flags & (1 << 2) else None
platform = String.read(b)
reply_to = TLObject.read(b) if flags & (1 << 0) else None
send_as = TLObject.read(b) if flags & (1 << 13) else None
return RequestWebView(peer=peer, bot=bot, platform=platform, from_bot_menu=from_bot_menu, silent=silent, compact=compact, fullscreen=fullscreen, url=url, start_param=start_param, theme_params=theme_params, reply_to=reply_to, send_as=send_as)
def write(self, *args) -> bytes:
b = BytesIO()
b.write(Int(self.ID, False))
flags = 0
flags |= (1 << 4) if self.from_bot_menu else 0
flags |= (1 << 5) if self.silent else 0
flags |= (1 << 7) if self.compact else 0
flags |= (1 << 8) if self.fullscreen else 0
flags |= (1 << 1) if self.url is not None else 0
flags |= (1 << 3) if self.start_param is not None else 0
flags |= (1 << 2) if self.theme_params is not None else 0
flags |= (1 << 0) if self.reply_to is not None else 0
flags |= (1 << 13) if self.send_as is not None else 0
b.write(Int(flags))
b.write(self.peer.write())
b.write(self.bot.write())
if self.url is not None:
b.write(String(self.url))
if self.start_param is not None:
b.write(String(self.start_param))
if self.theme_params is not None:
b.write(self.theme_params.write())
b.write(String(self.platform))
if self.reply_to is not None:
b.write(self.reply_to.write())
if self.send_as is not None:
b.write(self.send_as.write())
return b.getvalue()