TeamPGM/pyrogram
2
0
Fork 0
mirror of https://github.com/TeamPGM/pyrogram.git synced 2024-11-16 12:51:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clearer documentation for get_chat_members

Browse Source
This commit is contained in:
Dan 2018-07-21 14:09:34 +02:00
parent 418740a3e6
commit 1eaafb8e41
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
pyrogram/client/methods/chats/get_chat_members.py
View File

@ -60,12 +60,18 @@ class GetChatMembers(BaseClient):
filter (``str``, *optional*):
Filter used to select the kind of members you want to retrieve. Only applicable for supergroups
and channels. It can be any of "all", "kicked", "restricted", "bots", "recent" and "administrators".
Defaults to "all".
and channels. It can be any of the followings:
*"all"* - all kind of members,
*"kicked"* - kicked (banned) members only,
*"restricted"* - restricted members only,
*"bots"* - bots only,
*"recent"* - recent members only,
*"administrators"* - chat administrators only.
Defaults to *"all"*.
.. [1] On supergroups and channels you can get up to 10,000 members for a single query string.
.. [2] A query string is applicable only for "all", "kicked" and "restricted" filters only.
.. [2] A query string is applicable only for *"all"*, *"kicked"* and *"restricted"* filters only.
"""
peer = self.resolve_peer(chat_id)