# Pyrogram - Telegram MTProto API Client Library for Python # Copyright (C) 2017-present Dan # # 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 . import logging from datetime import datetime from typing import List, Optional, Union import pyrogram from pyrogram import enums, types log = logging.getLogger(__name__) class SendWebPage: async def send_web_page( self: "pyrogram.Client", chat_id: Union[int, str], text: str = "", url: str = None, prefer_large_media: bool = None, prefer_small_media: bool = None, parse_mode: Optional["enums.ParseMode"] = None, entities: List["types.MessageEntity"] = None, link_preview_options: "types.LinkPreviewOptions" = None, disable_notification: bool = None, message_thread_id: int = None, direct_messages_topic_id: int = None, effect_id: int = None, show_caption_above_media: bool = None, reply_parameters: "types.ReplyParameters" = None, schedule_date: datetime = None, repeat_period: int = None, protect_content: bool = None, business_connection_id: str = None, allow_paid_broadcast: bool = None, paid_message_star_count: int = None, reply_markup: Union[ "types.InlineKeyboardMarkup", "types.ReplyKeyboardMarkup", "types.ReplyKeyboardRemove", "types.ForceReply" ] = None, reply_to_message_id: int = None, reply_to_chat_id: Union[int, str] = None, reply_to_story_id: int = None, quote_text: str = None, quote_entities: List["types.MessageEntity"] = None, quote_offset: int = None, ) -> "types.Message": """Send Web Page Preview. .. include:: /_includes/usable-by/users-bots.rst Parameters: chat_id (``int`` | ``str``): Unique identifier (int) or username (str) of the target chat. For your personal cloud (Saved Messages) you can simply use "me" or "self". For a contact that exists in your Telegram address book you can use his phone number (str). text (``str``, *optional*): Text of the message to be sent. url (``str``, *optional*): Link that will be previewed. If url not specified, the first URL found in the text will be used. parse_mode (:obj:`~pyrogram.enums.ParseMode`, *optional*): By default, texts are parsed using both Markdown and HTML styles. You can combine both syntaxes together. entities (List of :obj:`~pyrogram.types.MessageEntity`): List of special entities that appear in message text, which can be specified instead of *parse_mode*. link_preview_options (:obj:`~pyrogram.types.LinkPreviewOptions`, *optional*): Options used for link preview generation for the message. disable_notification (``bool``, *optional*): Sends the message silently. Users will receive a notification with no sound. message_thread_id (``int``, *optional*): Unique identifier for the target message thread (topic) of the forum. For forums only. direct_messages_topic_id (``int``, *optional*): Unique identifier of the topic in a channel direct messages chat administered by the current user. For directs only only. effect_id (``int``, *optional*): Unique identifier of the message effect. For private chats only. reply_parameters (:obj:`~pyrogram.types.ReplyParameters`, *optional*): Describes reply parameters for the message that is being sent. quote_offset (``int``, *optional*): Offset for quote in original message. schedule_date (:py:obj:`~datetime.datetime`, *optional*): Date when the message will be automatically sent. repeat_period (``int``, *optional*): Period after which the message will be sent again in seconds. protect_content (``bool``, *optional*): Protects the contents of the sent message from forwarding and saving. business_connection_id (``str``, *optional*): Unique identifier of the business connection on behalf of which the message will be sent. allow_paid_broadcast (``bool``, *optional*): If True, you will be allowed to send up to 1000 messages per second. Ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. For bots only. paid_message_star_count (``int``, *optional*): The number of Telegram Stars the user agreed to pay to send the messages. reply_markup (:obj:`~pyrogram.types.InlineKeyboardMarkup` | :obj:`~pyrogram.types.ReplyKeyboardMarkup` | :obj:`~pyrogram.types.ReplyKeyboardRemove` | :obj:`~pyrogram.types.ForceReply`, *optional*): Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. Returns: :obj:`~pyrogram.types.Message`: On success, the sent message is returned. Example: .. code-block:: python # Simple example await app.send_web_page("me", "https://docs.pyrogram.org") # Make web preview image larger await app.send_web_page("me", "https://docs.pyrogram.org", link_preview_options=types.LinkPreviewOptions( prefer_large_media=True )) """ log.warning("`send_web_page` is deprecated and will be removed in future updates. Use `send_message` instead.") if any( ( url is not None, prefer_large_media is not None, prefer_small_media is not None, show_caption_above_media is not None, ) ): link_preview_options = types.LinkPreviewOptions( url=url, prefer_large_media=prefer_large_media, prefer_small_media=prefer_small_media, show_above_text=show_caption_above_media, ) return await self.send_message( chat_id=chat_id, text=text, parse_mode=parse_mode, entities=entities, link_preview_options=link_preview_options, disable_notification=disable_notification, message_thread_id=message_thread_id, direct_messages_topic_id=direct_messages_topic_id, effect_id=effect_id, reply_parameters=reply_parameters, quote_text=quote_text, quote_entities=quote_entities, quote_offset=quote_offset, schedule_date=schedule_date, repeat_period=repeat_period, protect_content=protect_content, business_connection_id=business_connection_id, allow_paid_broadcast=allow_paid_broadcast, paid_message_star_count=paid_message_star_count, reply_markup=reply_markup, reply_to_message_id=reply_to_message_id, reply_to_chat_id=reply_to_chat_id, reply_to_story_id=reply_to_story_id, )