mirror of
https://github.com/pyrogram/pyrogram
synced 2025-08-29 13:27:47 +00:00
Add download() bound method to Message
This commit is contained in:
parent
bee8d1340b
commit
fa512a690d
@ -571,3 +571,39 @@ class Message(Object):
|
|||||||
raise ValueError("This button is not supported yet")
|
raise ValueError("This button is not supported yet")
|
||||||
else:
|
else:
|
||||||
raise ValueError("The message doesn't contain any keyboard")
|
raise ValueError("The message doesn't contain any keyboard")
|
||||||
|
|
||||||
|
def download(self, file_name: str = "", block: bool = True):
|
||||||
|
"""Use this method as a shortcut for:
|
||||||
|
|
||||||
|
.. code-block:: python
|
||||||
|
|
||||||
|
client.download_media(message)
|
||||||
|
|
||||||
|
Example:
|
||||||
|
.. code-block:: python
|
||||||
|
|
||||||
|
message.download()
|
||||||
|
|
||||||
|
Args:
|
||||||
|
file_name (``str``, *optional*):
|
||||||
|
A custom *file_name* to be used instead of the one provided by Telegram.
|
||||||
|
By default, all files are downloaded in the *downloads* folder in your working directory.
|
||||||
|
You can also specify a path for downloading files in a custom location: paths that end with "/"
|
||||||
|
are considered directories. All non-existent folders will be created automatically.
|
||||||
|
|
||||||
|
block (``bool``, *optional*):
|
||||||
|
Blocks the code execution until the file has been downloaded.
|
||||||
|
Defaults to True.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
On success, the absolute path of the downloaded file as string is returned, None otherwise.
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
:class:`Error <pyrogram.Error>`
|
||||||
|
``ValueError``: If the message doesn't contain any downloadable media
|
||||||
|
"""
|
||||||
|
return self._client.download_media(
|
||||||
|
message=self,
|
||||||
|
file_name=file_name,
|
||||||
|
block=block
|
||||||
|
)
|
||||||
|
Loading…
x
Reference in New Issue
Block a user