118 lines
5.0 KiB
Python
118 lines
5.0 KiB
Python
# Pyrogram - Telegram MTProto API Client Library for Python
|
|
# Copyright (C) 2017-2020 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.api import functions, types
|
|
from pyrogram.client.ext import BaseClient, utils
|
|
|
|
|
|
class SendCachedMedia(BaseClient):
|
|
def send_cached_media(
|
|
self,
|
|
chat_id: Union[int, str],
|
|
file_id: str,
|
|
file_ref: str = None,
|
|
caption: str = "",
|
|
parse_mode: Union[str, None] = object,
|
|
disable_notification: bool = None,
|
|
reply_to_message_id: int = None,
|
|
schedule_date: int = None,
|
|
reply_markup: Union[
|
|
"pyrogram.InlineKeyboardMarkup",
|
|
"pyrogram.ReplyKeyboardMarkup",
|
|
"pyrogram.ReplyKeyboardRemove",
|
|
"pyrogram.ForceReply"
|
|
] = None
|
|
) -> Union["pyrogram.Message", None]:
|
|
"""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.
|
|
|
|
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.
|
|
|
|
file_ref (``str``, *optional*):
|
|
A valid file reference obtained by a recently fetched media message.
|
|
To be used in combination with a file id in case a file reference is needed.
|
|
|
|
caption (``bool``, *optional*):
|
|
Media caption, 0-1024 characters.
|
|
|
|
parse_mode (``str``, *optional*):
|
|
By default, texts are parsed using both Markdown and HTML styles.
|
|
You can combine both syntaxes together.
|
|
Pass "markdown" or "md" to enable Markdown-style parsing only.
|
|
Pass "html" to enable HTML-style parsing only.
|
|
Pass None to completely disable style parsing.
|
|
|
|
disable_notification (``bool``, *optional*):
|
|
Sends the message silently.
|
|
Users will receive a notification with no sound.
|
|
|
|
reply_to_message_id (``int``, *optional*):
|
|
If the message is a reply, ID of the original message.
|
|
|
|
schedule_date (``int``, *optional*):
|
|
Date when the message will be automatically sent. Unix time.
|
|
|
|
reply_markup (:obj:`InlineKeyboardMarkup` | :obj:`ReplyKeyboardMarkup` | :obj:`ReplyKeyboardRemove` | :obj:`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:`Message`: On success, the sent media message is returned.
|
|
|
|
Example:
|
|
.. code-block:: python
|
|
|
|
app.send_cached_media("me", "CAADBAADyg4AAvLQYAEYD4F7vcZ43AI")
|
|
"""
|
|
|
|
r = self.send(
|
|
functions.messages.SendMedia(
|
|
peer=self.resolve_peer(chat_id),
|
|
media=utils.get_input_media_from_file_id(file_id, file_ref),
|
|
silent=disable_notification or None,
|
|
reply_to_msg_id=reply_to_message_id,
|
|
random_id=self.rnd_id(),
|
|
schedule_date=schedule_date,
|
|
reply_markup=reply_markup.write() if reply_markup else None,
|
|
**self.parser.parse(caption, parse_mode)
|
|
)
|
|
)
|
|
|
|
for i in r.updates:
|
|
if isinstance(i, (types.UpdateNewMessage, types.UpdateNewChannelMessage, types.UpdateNewScheduledMessage)):
|
|
return pyrogram.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, types.UpdateNewScheduledMessage)
|
|
)
|