LonamiWebs/Telethon
1
1
Fork 0
mirror of https://github.com/LonamiWebs/Telethon.git synced 2024-11-13 04:56:35 +03:00
Code Issues Packages Projects Releases Wiki Activity

Document iteration order

Browse Source
This commit is contained in:
Lonami Exo 2019-06-28 20:44:06 +02:00
parent 84c4fcdec6
commit 9322c37a94
3 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
telethon/client/chats.py
View File

@ -359,6 +359,8 @@ class ChatMethods:
""" """
Iterator over the participants belonging to the specified chat. Iterator over the participants belonging to the specified chat.
The order is unspecified.
Arguments Arguments
entity (`entity`): entity (`entity`):
The entity from which to retrieve the participants list. The entity from which to retrieve the participants list.
@ -470,6 +472,8 @@ class ChatMethods:
""" """
Iterator over the admin log for the specified channel. Iterator over the admin log for the specified channel.
The default order is from the most recent event to to the oldest.
Note that you must be an administrator of it to use this method. Note that you must be an administrator of it to use this method.
If none of the filters are present (i.e. they all are ``None``), If none of the filters are present (i.e. they all are ``None``),
@ -613,6 +617,8 @@ class ChatMethods:
""" """
Iterator over a user's profile photos or a chat's photos. Iterator over a user's profile photos or a chat's photos.
The order is from the most recent photo to the oldest.
Arguments Arguments
entity (`entity`): entity (`entity`):
The entity from which to get the profile or chat photos. The entity from which to get the profile or chat photos.

6
telethon/client/dialogs.py
View File

@ -127,6 +127,10 @@ class DialogMethods:
""" """
Iterator over the dialogs (open conversations/subscribed channels). Iterator over the dialogs (open conversations/subscribed channels).
The order is the same as the one seen in official applications
(first pinned, them from those with the most recent message to
those with the oldest message).
Arguments Arguments
limit (`int` | `None`): limit (`int` | `None`):
How many dialogs to be retrieved as maximum. Can be set to How many dialogs to be retrieved as maximum. Can be set to
@ -227,6 +231,8 @@ class DialogMethods:
""" """
Iterator over all open draft messages. Iterator over all open draft messages.
The order is unspecified.
Yields Yields
Instances of `Draft <telethon.tl.custom.draft.Draft>`. Instances of `Draft <telethon.tl.custom.draft.Draft>`.

3
telethon/client/messages.py
View File

@ -315,6 +315,9 @@ class MessageMethods:
""" """
Iterator over the messages for the given chat. Iterator over the messages for the given chat.
The default order is from newest to oldest, but this
behaviour can be changed with the `reverse` parameter.
If either `search`, `filter` or `from_user` are provided, If either `search`, `filter` or `from_user` are provided,
:tl:`messages.Search` will be used instead of :tl:`messages.getHistory`. :tl:`messages.Search` will be used instead of :tl:`messages.getHistory`.