mirror of
https://github.com/pyrogram/pyrogram
synced 2025-08-29 05:18:10 +00:00
Add get_chat_member documentation
This commit is contained in:
parent
1eaafb8e41
commit
215f54f32b
@ -24,7 +24,25 @@ class GetChatMember(BaseClient):
|
|||||||
def get_chat_member(self,
|
def get_chat_member(self,
|
||||||
chat_id: int or str,
|
chat_id: int or str,
|
||||||
user_id: int or str):
|
user_id: int or str):
|
||||||
# TODO: docstrings
|
"""Use this method to get information about a single member of a chat.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
chat_id (``int`` | ``str``):
|
||||||
|
Unique identifier (int) or username (str) of the target chat.
|
||||||
|
For a private channel/supergroup you can use its *t.me/joinchat/* link.
|
||||||
|
|
||||||
|
user_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).
|
||||||
|
For a private channel/supergroup you can use its *t.me/joinchat/* link.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
On success, a :obj:`ChatMember <pyrogram.ChatMember>` object is returned.
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
:class:`Error <pyrogram.Error>`
|
||||||
|
"""
|
||||||
chat_id = self.resolve_peer(chat_id)
|
chat_id = self.resolve_peer(chat_id)
|
||||||
user_id = self.resolve_peer(user_id)
|
user_id = self.resolve_peer(user_id)
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user