Add get_web_app_link_url and get_web_app_url method

Author: KurimuzonAkuma

compiler/docs/compiler.py

@@ -260,6 +260,8 @@ def get_title_list(s: str) -> list:
             get_messages
             get_scheduled_messages
             get_stickers
+            get_web_app_link_url
+            get_web_app_url
             mark_checklist_tasks_as_done
             get_media_group
             get_chat_history

pyrogram/methods/messages/__init__.py

@@ -49,6 +49,8 @@
 from .get_messages import GetMessages
 from .get_scheduled_messages import GetScheduledMessages
 from .get_stickers import GetStickers
+from .get_web_app_link_url import GetWebAppLinkUrl
+from .get_web_app_url import GetWebAppUrl
 from .mark_checklist_tasks_as_done import MarkChecklistTasksAsDone
 from .read_chat_history import ReadChatHistory
 from .read_mentions import ReadMentions
@@ -111,6 +113,8 @@ class Messages(
     GetMessages,
     GetScheduledMessages,
     GetStickers,
+    GetWebAppLinkUrl,
+    GetWebAppUrl,
     MarkChecklistTasksAsDone,
     SendAudio,
     SendChatAction,

pyrogram/methods/messages/get_web_app_link_url.py

@@ -0,0 +1,83 @@
+#  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 typing import Union
+
+import pyrogram
+from pyrogram import raw, enums
+
+
+class GetWebAppLinkUrl:
+    async def get_web_app_link_url(
+        self: "pyrogram.Client",
+        chat_id: Union[int, str],
+        bot_user_id: Union[int, str],
+        web_app_short_name: str,
+        start_parameter: str = "",
+        allow_write_access: bool = False,
+        platform: "enums.ClientPlatform" = None
+    ) -> str:
+        """Returns an HTTPS URL of a Web App to open.
+
+        .. include:: /_includes/usable-by/users.rst
+
+        Parameters:
+            chat_id (``int`` | ``str``):
+                Unique identifier (int) or username (str) of the target chat.
+
+            bot_user_id (``int`` | ``str``):
+                Unique identifier (int) or username (str) of the target bot.
+
+            web_app_short_name (``str``):
+                Short name of the Web App.
+
+            start_parameter (``str``, *optional*):
+                Start parameter.
+
+            allow_write_access (``bool``, *optional*):
+                Pass True if the current user allowed the bot to send them messages.
+
+            platform (:obj:`~pyrogram.enums.ClientPlatform`, *optional*):
+                The platform on which the link will be opened.
+
+        Returns:
+            ``str``: On success, returns the url of a Web App.
+
+        Example:
+            .. code-block:: python
+
+                link = await app.get_web_app_link_url(chat_id, bot_user_id, web_app_short_name)
+        """
+        if platform is None:
+            platform = self.client_platform
+
+        r = await self.invoke(
+            raw.functions.messages.RequestAppWebView(
+                peer=await self.resolve_peer(chat_id),
+                app=raw.types.InputBotAppShortName(
+                    bot_id=await self.resolve_peer(bot_user_id),
+                    short_name=web_app_short_name
+                ),
+                platform=platform.value,
+                write_allowed=allow_write_access,
+                start_param=start_parameter,
+
+            )
+        )
+
+        return r.url

pyrogram/methods/messages/get_web_app_url.py

@@ -0,0 +1,70 @@
+#  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 typing import Union
+
+import pyrogram
+from pyrogram import raw, enums
+
+
+class GetWebAppUrl:
+    async def get_web_app_url(
+        self: "pyrogram.Client",
+        bot_user_id: Union[int, str],
+        url: str = None,
+        platform: "enums.ClientPlatform" = None
+    ) -> str:
+        """Returns an HTTPS URL of a Web App to open from the side menu,
+        a :obj:`~pyrogram.types.KeyboardButton` button with web app type,
+        or an :obj:`~pyrogram.types.InlineKeyboardButton` button with web app type.
+
+        .. include:: /_includes/usable-by/users.rst
+
+        Parameters:
+            bot_user_id (``int`` | ``str``):
+                Unique identifier (int) or username (str) of the target bot.
+
+            url (``str``, *optional*):
+                The URL from :obj:`~pyrogram.types.KeyboardButton` button with web app type,
+                or an :obj:`~pyrogram.types.InlineKeyboardButton` button with web app type,
+                or an None when the bot is opened from the side menu.
+
+            platform (:obj:`~pyrogram.enums.ClientPlatform`, *optional*):
+                The platform on which the link will be opened.
+
+        Returns:
+            ``str``: On success, returns the url of a Web App.
+
+        Example:
+            .. code-block:: python
+
+                link = await client.get_web_app_url(bot_user_id)
+        """
+        if platform is None:
+            platform = self.client_platform
+
+        r = await self.invoke(
+            raw.functions.messages.RequestSimpleWebView(
+                bot=await self.resolve_peer(bot_user_id),
+                platform=platform.value,
+                from_side_menu=True if url is None else None,
+                url=url
+            )
+        )
+
+        return r.url