LonamiWebs/Telethon
1
1
Fork 0
mirror of https://github.com/LonamiWebs/Telethon.git synced 2024-11-29 12:53:44 +03:00
Code Issues Packages Projects Releases Wiki Activity

Document default behaviour of limit

Browse Source
This commit is contained in:
Lonami Exo 2021-09-17 20:19:23 +02:00
parent 6e9ad9e31c
commit 40ff7c6bdf
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
telethon/_client/telegramclient.py
View File

@ -735,6 +735,10 @@ class TelegramClient:
limit (`int`): limit (`int`):
Limits amount of participants fetched. Limits amount of participants fetched.
By default, there is no limit set when using the result as
an iterator. When using ``await``, the default limit is 1,
so the method returns a single user.
search (`str`, optional): search (`str`, optional):
Look for participants with this string in name/username. Look for participants with this string in name/username.
@ -822,6 +826,10 @@ class TelegramClient:
The limit may also be `None`, which would eventually return The limit may also be `None`, which would eventually return
the whole history. the whole history.
By default, there is no limit set when using the result as
an iterator. When using ``await``, the default limit is 1,
so the method returns the last event.
max_id (`int`): max_id (`int`):
All the events with a higher (newer) ID or equal to this will All the events with a higher (newer) ID or equal to this will
be excluded. be excluded.
@ -930,6 +938,10 @@ class TelegramClient:
The limit may also be `None`, which would eventually all The limit may also be `None`, which would eventually all
the photos that are still available. the photos that are still available.
By default, there is no limit set when using the result as
an iterator. When using ``await``, the default limit is 1,
so the method returns the last profile photo.
offset (`int`): offset (`int`):
How many photos should be skipped before returning the first one. How many photos should be skipped before returning the first one.
@ -1407,6 +1419,10 @@ class TelegramClient:
will tell the library to slow down through a will tell the library to slow down through a
``FloodWaitError``. ``FloodWaitError``.
By default, there is no limit set when using the result as
an iterator. When using ``await``, the default limit is 1,
so the method returns the most-recent dialog.
offset_date (`datetime`, optional): offset_date (`datetime`, optional):
The offset date to be used. The offset date to be used.
@ -2001,6 +2017,10 @@ class TelegramClient:
The limit may also be `None`, which would eventually return The limit may also be `None`, which would eventually return
the whole history. the whole history.
By default, there is no limit set when using the result as
an iterator. When using ``await``, the default limit is 1,
so the method returns the last message.
offset_date (`datetime`): offset_date (`datetime`):
Offset date (messages *previous* to this date will be Offset date (messages *previous* to this date will be
retrieved). Exclusive. retrieved). Exclusive.