mirror of
https://github.com/pyrogram/pyrogram
synced 2025-08-23 10:28:00 +00:00
Document get_dialogs() method
This commit is contained in:
parent
088a4c35c9
commit
9c0f8b2f3b
@ -22,19 +22,41 @@ from ...ext import BaseClient, utils
|
|||||||
|
|
||||||
|
|
||||||
class GetDialogs(BaseClient):
|
class GetDialogs(BaseClient):
|
||||||
# TODO docstrings
|
|
||||||
|
|
||||||
def get_dialogs(self,
|
def get_dialogs(self,
|
||||||
|
offset_dialogs=None,
|
||||||
limit: int = 100,
|
limit: int = 100,
|
||||||
pinned_only: bool = False,
|
pinned_only: bool = False):
|
||||||
last_chunk=None):
|
"""Use this method to get the user's dialogs
|
||||||
|
|
||||||
|
You can get up to 100 dialogs at once.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
limit (``str``, *optional*):
|
||||||
|
Limits the number of dialogs to be retrieved.
|
||||||
|
Defaults to 100
|
||||||
|
|
||||||
|
pinned_only (``bool``, *optional*):
|
||||||
|
Pass True if you want to get only pinned dialogs.
|
||||||
|
Defaults to False.
|
||||||
|
|
||||||
|
offset_dialogs (:obj:`Dialogs`):
|
||||||
|
Pass the previous dialogs object to retrieve the next dialogs chunk starting from the last dialog.
|
||||||
|
Defaults to None (start from the beginning).
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
On success, a :obj:`Dialogs` object is returned.
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
:class:`Error`
|
||||||
|
"""
|
||||||
|
|
||||||
if pinned_only:
|
if pinned_only:
|
||||||
r = self.send(functions.messages.GetPinnedDialogs())
|
r = self.send(functions.messages.GetPinnedDialogs())
|
||||||
else:
|
else:
|
||||||
offset_date = 0
|
offset_date = 0
|
||||||
|
|
||||||
if last_chunk:
|
if offset_dialogs:
|
||||||
for dialog in reversed(last_chunk.dialogs):
|
for dialog in reversed(offset_dialogs.dialogs):
|
||||||
top_message = dialog.top_message
|
top_message = dialog.top_message
|
||||||
|
|
||||||
if top_message:
|
if top_message:
|
||||||
|
Loading…
x
Reference in New Issue
Block a user