mirror of
https://github.com/pyrogram/pyrogram
synced 2025-09-01 14:55:12 +00:00
Document the progress parameter
This commit is contained in:
@@ -1048,6 +1048,17 @@ class Client:
|
|||||||
reply_to_message_id (:obj:`int`, optional):
|
reply_to_message_id (:obj:`int`, optional):
|
||||||
If the message is a reply, ID of the original message.
|
If the message is a reply, ID of the original message.
|
||||||
|
|
||||||
|
progress (:obj:`callable`):
|
||||||
|
Pass a callback function to view the upload progress.
|
||||||
|
The function must accept two arguments (progress, total).
|
||||||
|
|
||||||
|
Other Parameters:
|
||||||
|
progress (:obj:`int`):
|
||||||
|
The amount of bytes uploaded so far.
|
||||||
|
|
||||||
|
total (:obj:`int`):
|
||||||
|
The size of the file.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
On success, the sent Message is returned.
|
On success, the sent Message is returned.
|
||||||
|
|
||||||
@@ -1126,6 +1137,17 @@ class Client:
|
|||||||
reply_to_message_id (:obj:`int`, optional):
|
reply_to_message_id (:obj:`int`, optional):
|
||||||
If the message is a reply, ID of the original message.
|
If the message is a reply, ID of the original message.
|
||||||
|
|
||||||
|
progress (:obj:`callable`):
|
||||||
|
Pass a callback function to view the upload progress.
|
||||||
|
The function must accept two arguments (progress, total).
|
||||||
|
|
||||||
|
Other Parameters:
|
||||||
|
progress (:obj:`int`):
|
||||||
|
The amount of bytes uploaded so far.
|
||||||
|
|
||||||
|
total (:obj:`int`):
|
||||||
|
The size of the file.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
On success, the sent Message is returned.
|
On success, the sent Message is returned.
|
||||||
|
|
||||||
@@ -1198,6 +1220,17 @@ class Client:
|
|||||||
reply_to_message_id (:obj:`int`, optional):
|
reply_to_message_id (:obj:`int`, optional):
|
||||||
If the message is a reply, ID of the original message.
|
If the message is a reply, ID of the original message.
|
||||||
|
|
||||||
|
progress (:obj:`callable`):
|
||||||
|
Pass a callback function to view the upload progress.
|
||||||
|
The function must accept two arguments (progress, total).
|
||||||
|
|
||||||
|
Other Parameters:
|
||||||
|
progress (:obj:`int`):
|
||||||
|
The amount of bytes uploaded so far.
|
||||||
|
|
||||||
|
total (:obj:`int`):
|
||||||
|
The size of the file.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
On success, the sent Message is returned.
|
On success, the sent Message is returned.
|
||||||
|
|
||||||
@@ -1255,6 +1288,17 @@ class Client:
|
|||||||
reply_to_message_id (:obj:`int`, optional):
|
reply_to_message_id (:obj:`int`, optional):
|
||||||
If the message is a reply, ID of the original message.
|
If the message is a reply, ID of the original message.
|
||||||
|
|
||||||
|
progress (:obj:`callable`):
|
||||||
|
Pass a callback function to view the upload progress.
|
||||||
|
The function must accept two arguments (progress, total).
|
||||||
|
|
||||||
|
Other Parameters:
|
||||||
|
progress (:obj:`int`):
|
||||||
|
The amount of bytes uploaded so far.
|
||||||
|
|
||||||
|
total (:obj:`int`):
|
||||||
|
The size of the file.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
On success, the sent Message is returned.
|
On success, the sent Message is returned.
|
||||||
|
|
||||||
@@ -1343,6 +1387,17 @@ class Client:
|
|||||||
reply_to_message_id (:obj:`int`, optional):
|
reply_to_message_id (:obj:`int`, optional):
|
||||||
If the message is a reply, ID of the original message.
|
If the message is a reply, ID of the original message.
|
||||||
|
|
||||||
|
progress (:obj:`callable`):
|
||||||
|
Pass a callback function to view the upload progress.
|
||||||
|
The function must accept two arguments (progress, total).
|
||||||
|
|
||||||
|
Other Parameters:
|
||||||
|
progress (:obj:`int`):
|
||||||
|
The amount of bytes uploaded so far.
|
||||||
|
|
||||||
|
total (:obj:`int`):
|
||||||
|
The size of the file.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
On success, the sent Message is returned.
|
On success, the sent Message is returned.
|
||||||
|
|
||||||
@@ -1422,6 +1477,17 @@ class Client:
|
|||||||
reply_to_message_id (:obj:`int`, optional):
|
reply_to_message_id (:obj:`int`, optional):
|
||||||
If the message is a reply, ID of the original message
|
If the message is a reply, ID of the original message
|
||||||
|
|
||||||
|
progress (:obj:`callable`):
|
||||||
|
Pass a callback function to view the upload progress.
|
||||||
|
The function must accept two arguments (progress, total).
|
||||||
|
|
||||||
|
Other Parameters:
|
||||||
|
progress (:obj:`int`):
|
||||||
|
The amount of bytes uploaded so far.
|
||||||
|
|
||||||
|
total (:obj:`int`):
|
||||||
|
The size of the file.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
On success, the sent Message is returned.
|
On success, the sent Message is returned.
|
||||||
|
|
||||||
@@ -1490,6 +1556,17 @@ class Client:
|
|||||||
reply_to_message_id (:obj:`int`, optional):
|
reply_to_message_id (:obj:`int`, optional):
|
||||||
If the message is a reply, ID of the original message
|
If the message is a reply, ID of the original message
|
||||||
|
|
||||||
|
progress (:obj:`callable`):
|
||||||
|
Pass a callback function to view the upload progress.
|
||||||
|
The function must accept two arguments (progress, total).
|
||||||
|
|
||||||
|
Other Parameters:
|
||||||
|
progress (:obj:`int`):
|
||||||
|
The amount of bytes uploaded so far.
|
||||||
|
|
||||||
|
total (:obj:`int`):
|
||||||
|
The size of the file.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
On success, the sent Message is returned.
|
On success, the sent Message is returned.
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user