mirror of
https://github.com/Mayuri-Chan/pyrofork.git
synced 2025-12-29 12:04:51 +00:00
156 lines
6.6 KiB
Python
156 lines
6.6 KiB
Python
# Pyrofork - Telegram MTProto API Client Library for Python
|
|
# Copyright (C) 2017-present Dan <https://github.com/delivrance>
|
|
# Copyright (C) 2022-present Mayuri-Chan <https://github.com/Mayuri-Chan>
|
|
#
|
|
# This file is part of Pyrofork.
|
|
#
|
|
# Pyrofork 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.
|
|
#
|
|
# Pyrofork 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 Pyrofork. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
from datetime import datetime
|
|
from typing import Union, List, Optional
|
|
|
|
import pyrogram
|
|
from pyrogram import raw, enums
|
|
from pyrogram import types
|
|
from pyrogram import utils
|
|
|
|
|
|
class SendCachedMedia:
|
|
async def send_cached_media(
|
|
self: "pyrogram.Client",
|
|
chat_id: Union[int, str],
|
|
file_id: str,
|
|
caption: str = "",
|
|
parse_mode: Optional["enums.ParseMode"] = None,
|
|
caption_entities: List["types.MessageEntity"] = None,
|
|
has_spoiler: bool = None,
|
|
disable_notification: bool = None,
|
|
message_thread_id: int = None,
|
|
reply_to_message_id: int = None,
|
|
reply_to_story_id: int = None,
|
|
quote_text: str = None,
|
|
schedule_date: datetime = None,
|
|
protect_content: bool = None,
|
|
reply_markup: Union[
|
|
"types.InlineKeyboardMarkup",
|
|
"types.ReplyKeyboardMarkup",
|
|
"types.ReplyKeyboardRemove",
|
|
"types.ForceReply"
|
|
] = None
|
|
) -> Optional["types.Message"]:
|
|
"""Send any media stored on the Telegram servers using a file_id.
|
|
|
|
This convenience method works with any valid file_id only.
|
|
It does the same as calling the relevant method for sending media using a file_id, thus saving you from the
|
|
hassle of using the correct method for the media the file_id is pointing to.
|
|
|
|
.. 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).
|
|
|
|
file_id (``str``):
|
|
Media to send.
|
|
Pass a file_id as string to send a media that exists on the Telegram servers.
|
|
|
|
caption (``str``, *optional*):
|
|
Media caption, 0-1024 characters.
|
|
|
|
parse_mode (:obj:`~pyrogram.enums.ParseMode`, *optional*):
|
|
By default, texts are parsed using both Markdown and HTML styles.
|
|
You can combine both syntaxes together.
|
|
|
|
caption_entities (List of :obj:`~pyrogram.types.MessageEntity`):
|
|
List of special entities that appear in the caption, which can be specified instead of *parse_mode*.
|
|
|
|
has_spoiler (``bool``, *optional*):
|
|
Pass True if the photo needs to be covered with a spoiler animation.
|
|
|
|
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 forum supergroups only.
|
|
|
|
reply_to_message_id (``int``, *optional*):
|
|
If the message is a reply, ID of the original message.
|
|
|
|
reply_to_story_id (``int``, *optional*):
|
|
Unique identifier for the target story.
|
|
|
|
quote_text (``str``, *optional*):
|
|
Text to quote.
|
|
for reply_to_message only.
|
|
|
|
schedule_date (:py:obj:`~datetime.datetime`, *optional*):
|
|
Date when the message will be automatically sent.
|
|
|
|
protect_content (``bool``, *optional*):
|
|
Protects the contents of the sent message from forwarding and saving.
|
|
|
|
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 media message is returned.
|
|
|
|
Example:
|
|
.. code-block:: python
|
|
|
|
await app.send_cached_media("me", file_id)
|
|
"""
|
|
|
|
reply_to = None
|
|
if reply_to_message_id or message_thread_id:
|
|
reply_to = types.InputReplyToMessage(reply_to_message_id=reply_to_message_id, message_thread_id=message_thread_id, quote_text=quote_text)
|
|
if reply_to_story_id:
|
|
user_id = await self.resolve_peer(chat_id)
|
|
reply_to = types.InputReplyToStory(user_id=user_id, story_id=reply_to_story_id)
|
|
|
|
media = utils.get_input_media_from_file_id(file_id)
|
|
media.spoiler = has_spoiler
|
|
|
|
media = utils.get_input_media_from_file_id(file_id)
|
|
media.spoiler = has_spoiler
|
|
|
|
r = await self.invoke(
|
|
raw.functions.messages.SendMedia(
|
|
peer=await self.resolve_peer(chat_id),
|
|
media=media,
|
|
silent=disable_notification or None,
|
|
reply_to=reply_to,
|
|
random_id=self.rnd_id(),
|
|
schedule_date=utils.datetime_to_timestamp(schedule_date),
|
|
noforwards=protect_content,
|
|
reply_markup=await reply_markup.write(self) if reply_markup else None,
|
|
**await utils.parse_text_entities(self, caption, parse_mode, caption_entities)
|
|
)
|
|
)
|
|
|
|
for i in r.updates:
|
|
if isinstance(i, (raw.types.UpdateNewMessage,
|
|
raw.types.UpdateNewChannelMessage,
|
|
raw.types.UpdateNewScheduledMessage)):
|
|
return await types.Message._parse(
|
|
self, i.message,
|
|
{i.id: i for i in r.users},
|
|
{i.id: i for i in r.chats},
|
|
is_scheduled=isinstance(i, raw.types.UpdateNewScheduledMessage)
|
|
)
|