mir/pyrogram
2
0
Fork 0
mirror of https://github.com/pyrogram/pyrogram synced 2025-08-28 12:57:52 +00:00
Code Issues Releases Wiki Activity

Update docstrings to accommodate joinchat links

Browse Source
This commit is contained in:
Dan 2018-03-18 13:00:28 +01:00
parent cbd3b71b79
commit 5b5fb6cbec
1 changed files with 80 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

141
pyrogram/client/client.py
View File

@ -986,9 +986,10 @@ class Client:
Args: Args:
chat_id (:obj:`int` | :obj:`str`): chat_id (:obj:`int` | :obj:`str`):
Unique identifier for the target chat or username of the target channel/supergroup Unique identifier (int) or username (str) of the target chat.
(in the format @username). For your personal cloud storage (Saved Messages) you can For your personal cloud (Saved Messages) you can simply use "me" or "self".
simply use "me" or "self". Phone numbers that exist in your Telegram address book are also supported. For a contact that exists in your Telegram address book you can use his phone number (str).
For a private channel/supergroup you can use its *t.me/joinchat/* link.
text (:obj:`str`): text (:obj:`str`):
Text of the message to be sent. Text of the message to be sent.
@ -1036,15 +1037,16 @@ class Client:
Args: Args:
chat_id (:obj:`int` | :obj:`str`): chat_id (:obj:`int` | :obj:`str`):
Unique identifier for the target chat or username of the target channel/supergroup Unique identifier (int) or username (str) of the target chat.
(in the format @username). For your personal cloud storage (Saved Messages) you can For your personal cloud (Saved Messages) you can simply use "me" or "self".
simply use "me" or "self". Phone numbers that exist in your Telegram address book are also supported. For a contact that exists in your Telegram address book you can use his phone number (str).
For a private channel/supergroup you can use its *t.me/joinchat/* link.
from_chat_id (:obj:`int` | :obj:`str`): from_chat_id (:obj:`int` | :obj:`str`):
Unique identifier for the chat where the original message was sent Unique identifier (int) or username (str) of the source chat where the original message was sent.
(or channel/supergroup username in the format @username). For your personal cloud For your personal cloud (Saved Messages) you can simply use "me" or "self".
storage (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).
Phone numbers that exist in your Telegram address book are also supported. For a private channel/supergroup you can use its *t.me/joinchat/* link.
message_ids (:obj:`list`): message_ids (:obj:`list`):
A list of Message identifiers in the chat specified in *from_chat_id*. A list of Message identifiers in the chat specified in *from_chat_id*.
@ -1082,9 +1084,10 @@ class Client:
Args: Args:
chat_id (:obj:`int` | :obj:`str`): chat_id (:obj:`int` | :obj:`str`):
Unique identifier for the target chat or username of the target channel/supergroup Unique identifier (int) or username (str) of the target chat.
(in the format @username). For your personal cloud storage (Saved Messages) you can For your personal cloud (Saved Messages) you can simply use "me" or "self".
simply use "me" or "self". Phone numbers that exist in your Telegram address book are also supported. For a contact that exists in your Telegram address book you can use his phone number (str).
For a private channel/supergroup you can use its *t.me/joinchat/* link.
photo (:obj:`str`): photo (:obj:`str`):
Photo to send. Photo to send.
@ -1167,9 +1170,10 @@ class Client:
Args: Args:
chat_id (:obj:`int` | :obj:`str`): chat_id (:obj:`int` | :obj:`str`):
Unique identifier for the target chat or username of the target channel/supergroup Unique identifier (int) or username (str) of the target chat.
(in the format @username). For your personal cloud storage (Saved Messages) you can For your personal cloud (Saved Messages) you can simply use "me" or "self".
simply use "me" or "self". Phone numbers that exist in your Telegram address book are also supported. For a contact that exists in your Telegram address book you can use his phone number (str).
For a private channel/supergroup you can use its *t.me/joinchat/* link.
audio (:obj:`str`): audio (:obj:`str`):
Audio file to send. Audio file to send.
@ -1259,9 +1263,10 @@ class Client:
Args: Args:
chat_id (:obj:`int` | :obj:`str`): chat_id (:obj:`int` | :obj:`str`):
Unique identifier for the target chat or username of the target channel/supergroup Unique identifier (int) or username (str) of the target chat.
(in the format @username). For your personal cloud storage (Saved Messages) you can For your personal cloud (Saved Messages) you can simply use "me" or "self".
simply use "me" or "self". Phone numbers that exist in your Telegram address book are also supported. For a contact that exists in your Telegram address book you can use his phone number (str).
For a private channel/supergroup you can use its *t.me/joinchat/* link.
document (:obj:`str`): document (:obj:`str`):
File to send. File to send.
@ -1335,9 +1340,10 @@ class Client:
Args: Args:
chat_id (:obj:`int` | :obj:`str`): chat_id (:obj:`int` | :obj:`str`):
Unique identifier for the target chat or username of the target channel/supergroup Unique identifier (int) or username (str) of the target chat.
(in the format @username). For your personal cloud storage (Saved Messages) you can For your personal cloud (Saved Messages) you can simply use "me" or "self".
simply use "me" or "self". Phone numbers that exist in your Telegram address book are also supported. For a contact that exists in your Telegram address book you can use his phone number (str).
For a private channel/supergroup you can use its *t.me/joinchat/* link.
sticker (:obj:`str`): sticker (:obj:`str`):
Sticker to send. Sticker to send.
@ -1409,9 +1415,10 @@ class Client:
Args: Args:
chat_id (:obj:`int` | :obj:`str`): chat_id (:obj:`int` | :obj:`str`):
Unique identifier for the target chat or username of the target channel/supergroup Unique identifier (int) or username (str) of the target chat.
(in the format @username). For your personal cloud storage (Saved Messages) you can For your personal cloud (Saved Messages) you can simply use "me" or "self".
simply use "me" or "self". Phone numbers that exist in your Telegram address book are also supported. For a contact that exists in your Telegram address book you can use his phone number (str).
For a private channel/supergroup you can use its *t.me/joinchat/* link.
video (:obj:`str`): video (:obj:`str`):
Video to send. Video to send.
@ -1513,9 +1520,10 @@ class Client:
Args: Args:
chat_id (:obj:`int` | :obj:`str`): chat_id (:obj:`int` | :obj:`str`):
Unique identifier for the target chat or username of the target channel/supergroup Unique identifier (int) or username (str) of the target chat.
(in the format @username). For your personal cloud storage (Saved Messages) you can For your personal cloud (Saved Messages) you can simply use "me" or "self".
simply use "me" or "self". Phone numbers that exist in your Telegram address book are also supported. For a contact that exists in your Telegram address book you can use his phone number (str).
For a private channel/supergroup you can use its *t.me/joinchat/* link.
voice (:obj:`str`): voice (:obj:`str`):
Audio file to send. Audio file to send.
@ -1597,9 +1605,10 @@ class Client:
Args: Args:
chat_id (:obj:`int` | :obj:`str`): chat_id (:obj:`int` | :obj:`str`):
Unique identifier for the target chat or username of the target channel/supergroup Unique identifier (int) or username (str) of the target chat.
(in the format @username). For your personal cloud storage (Saved Messages) you can For your personal cloud (Saved Messages) you can simply use "me" or "self".
simply use "me" or "self". Phone numbers that exist in your Telegram address book are also supported. For a contact that exists in your Telegram address book you can use his phone number (str).
For a private channel/supergroup you can use its *t.me/joinchat/* link.
video_note (:obj:`str`): video_note (:obj:`str`):
Video note to send. Video note to send.
@ -1676,9 +1685,10 @@ class Client:
Args: Args:
chat_id (:obj:`int` | :obj:`str`): chat_id (:obj:`int` | :obj:`str`):
Unique identifier for the target chat or username of the target channel/supergroup Unique identifier (int) or username (str) of the target chat.
(in the format @username). For your personal cloud storage (Saved Messages) you can For your personal cloud (Saved Messages) you can simply use "me" or "self".
simply use "me" or "self". Phone numbers that exist in your Telegram address book are also supported. For a contact that exists in your Telegram address book you can use his phone number (str).
For a private channel/supergroup you can use its *t.me/joinchat/* link.
media (:obj:`list`): media (:obj:`list`):
A list containing either :obj:`pyrogram.InputMedia.Photo` or :obj:`pyrogram.InputMedia.Video` objects A list containing either :obj:`pyrogram.InputMedia.Photo` or :obj:`pyrogram.InputMedia.Video` objects
@ -1774,9 +1784,10 @@ class Client:
Args: Args:
chat_id (:obj:`int` | :obj:`str`): chat_id (:obj:`int` | :obj:`str`):
Unique identifier for the target chat or username of the target channel/supergroup Unique identifier (int) or username (str) of the target chat.
(in the format @username). For your personal cloud storage (Saved Messages) you can For your personal cloud (Saved Messages) you can simply use "me" or "self".
simply use "me" or "self". Phone numbers that exist in your Telegram address book are also supported. For a contact that exists in your Telegram address book you can use his phone number (str).
For a private channel/supergroup you can use its *t.me/joinchat/* link.
latitude (:obj:`float`): latitude (:obj:`float`):
Latitude of the location. Latitude of the location.
@ -1826,9 +1837,10 @@ class Client:
Args: Args:
chat_id (:obj:`int` | :obj:`str`): chat_id (:obj:`int` | :obj:`str`):
Unique identifier for the target chat or username of the target channel/supergroup Unique identifier (int) or username (str) of the target chat.
(in the format @username). For your personal cloud storage (Saved Messages) you can For your personal cloud (Saved Messages) you can simply use "me" or "self".
simply use "me" or "self". Phone numbers that exist in your Telegram address book are also supported. For a contact that exists in your Telegram address book you can use his phone number (str).
For a private channel/supergroup you can use its *t.me/joinchat/* link.
latitude (:obj:`float`): latitude (:obj:`float`):
Latitude of the venue. Latitude of the venue.
@ -1890,9 +1902,10 @@ class Client:
Args: Args:
chat_id (:obj:`int` | :obj:`str`): chat_id (:obj:`int` | :obj:`str`):
Unique identifier for the target chat or username of the target channel/supergroup Unique identifier (int) or username (str) of the target chat.
(in the format @username). For your personal cloud storage (Saved Messages) you can For your personal cloud (Saved Messages) you can simply use "me" or "self".
simply use "me" or "self". Phone numbers that exist in your Telegram address book are also supported. For a contact that exists in your Telegram address book you can use his phone number (str).
For a private channel/supergroup you can use its *t.me/joinchat/* link.
phone_number (:obj:`str`): phone_number (:obj:`str`):
Contact's phone number. Contact's phone number.
@ -1939,9 +1952,10 @@ class Client:
Args: Args:
chat_id (:obj:`int` | :obj:`str`): chat_id (:obj:`int` | :obj:`str`):
Unique identifier for the target chat or username of the target channel/supergroup Unique identifier (int) or username (str) of the target chat.
(in the format @username). For your personal cloud storage (Saved Messages) you can For your personal cloud (Saved Messages) you can simply use "me" or "self".
simply use "me" or "self". Phone numbers that exist in your Telegram address book are also supported. For a contact that exists in your Telegram address book you can use his phone number (str).
For a private channel/supergroup you can use its *t.me/joinchat/* link.
action (:obj:`callable`): action (:obj:`callable`):
Type of action to broadcast. Type of action to broadcast.
@ -2001,9 +2015,10 @@ class Client:
Args: Args:
chat_id (:obj:`int` | :obj:`str`): chat_id (:obj:`int` | :obj:`str`):
Unique identifier for the target chat or username of the target channel/supergroup Unique identifier (int) or username (str) of the target chat.
(in the format @username). For your personal cloud storage (Saved Messages) you can For your personal cloud (Saved Messages) you can simply use "me" or "self".
simply use "me" or "self". Phone numbers that exist in your Telegram address book are also supported. For a contact that exists in your Telegram address book you can use his phone number (str).
For a private channel/supergroup you can use its *t.me/joinchat/* link.
message_id (:obj:`int`): message_id (:obj:`int`):
Message identifier in the chat specified in chat_id. Message identifier in the chat specified in chat_id.
@ -2042,9 +2057,10 @@ class Client:
Args: Args:
chat_id (:obj:`int` | :obj:`str`): chat_id (:obj:`int` | :obj:`str`):
Unique identifier for the target chat or username of the target channel/supergroup Unique identifier (int) or username (str) of the target chat.
(in the format @username). For your personal cloud storage (Saved Messages) you can For your personal cloud (Saved Messages) you can simply use "me" or "self".
simply use "me" or "self". Phone numbers that exist in your Telegram address book are also supported. For a contact that exists in your Telegram address book you can use his phone number (str).
For a private channel/supergroup you can use its *t.me/joinchat/* link.
message_id (:obj:`int`): message_id (:obj:`int`):
Message identifier in the chat specified in chat_id. Message identifier in the chat specified in chat_id.
@ -2084,9 +2100,10 @@ class Client:
Args: Args:
chat_id (:obj:`int` | :obj:`str`): chat_id (:obj:`int` | :obj:`str`):
Unique identifier for the target chat or username of the target channel/supergroup Unique identifier (int) or username (str) of the target chat.
(in the format @username). For your personal cloud storage (Saved Messages) you can For your personal cloud (Saved Messages) you can simply use "me" or "self".
simply use "me" or "self". Phone numbers that exist in your Telegram address book are also supported. For a contact that exists in your Telegram address book you can use his phone number (str).
For a private channel/supergroup you can use its *t.me/joinchat/* link.
message_ids (:obj:`list`): message_ids (:obj:`list`):
List of identifiers of the messages to delete. List of identifiers of the messages to delete.
@ -2823,9 +2840,10 @@ class Client:
Args: Args:
chat_id (:obj:`int` | :obj:`str`): chat_id (:obj:`int` | :obj:`str`):
Unique identifier for the target chat or username of the target channel/supergroup Unique identifier (int) or username (str) of the target chat.
(in the format @username). For your personal cloud storage (Saved Messages) you can For your personal cloud (Saved Messages) you can simply use "me" or "self".
simply use "me" or "self". Phone numbers that exist in your Telegram address book are also supported. For a contact that exists in your Telegram address book you can use his phone number (str).
For a private channel/supergroup you can use its *t.me/joinchat/* link.
query_id (:obj:`int`): query_id (:obj:`int`):
Unique identifier for the answered query. Unique identifier for the answered query.
@ -2865,9 +2883,10 @@ class Client:
Args: Args:
chat_id (:obj:`int` | :obj:`str`): chat_id (:obj:`int` | :obj:`str`):
Unique identifier for the target chat or username of the target channel/supergroup Unique identifier (int) or username (str) of the target chat.
(in the format @username). For your personal cloud storage (Saved Messages) you can For your personal cloud (Saved Messages) you can simply use "me" or "self".
simply use "me" or "self". Phone numbers that exist in your Telegram address book are also supported. For a contact that exists in your Telegram address book you can use his phone number (str).
For a private channel/supergroup you can use its *t.me/joinchat/* link.
message_ids (:obj:`list`): message_ids (:obj:`list`):
A list of Message identifiers in the chat specified in *chat_id*. A list of Message identifiers in the chat specified in *chat_id*.