Source code for pyrogram.raw.functions.messages.get_saved_dialogs
# Pyrogram - Telegram MTProto API Client Library for Python
# Copyright (C) 2017-present Dan <https://github.com/delivrance>
#
# This file is part of Pyrogram.
#
# Pyrogram is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Pyrogram is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with Pyrogram. If not, see <http://www.gnu.org/licenses/>.
from io import BytesIO
from pyrogram.raw.core.primitives import Int, Long, Int128, Int256, Bool, Bytes, String, Double, Vector
from pyrogram.raw.core import TLObject
from pyrogram import raw
from typing import List, Optional, Any
# # # # # # # # # # # # # # # # # # # # # # # #
# !!! WARNING !!! #
# This is a generated file! #
# All changes made in this file will be lost! #
# # # # # # # # # # # # # # # # # # # # # # # #
[docs]
class GetSavedDialogs(TLObject): # type: ignore
"""Returns the current `saved dialog list » <https://core.telegram.org/api/saved-messages>`_ or `monoforum topic list » <https://core.telegram.org/api/monoforum>`_.
.. include:: /_includes/usable-by/users.rst
Details:
- Layer: ``229``
- ID: ``1E91FC99``
Parameters:
offset_date (``int`` ``32-bit``):
`Offsets for pagination, for more info click here <https://core.telegram.org/api/offsets>`_
offset_id (``int`` ``32-bit``):
`Offsets for pagination, for more info click here <https://core.telegram.org/api/offsets>`_ ( ``top_message`` ID used for pagination)
offset_peer (:obj:`InputPeer <pyrogram.raw.base.InputPeer>`):
`Offset peer for pagination <https://core.telegram.org/api/offsets>`_
limit (``int`` ``32-bit``):
Number of list elements to be returned
hash (``int`` ``64-bit``):
`Hash used for caching, for more info click here <https://core.telegram.org/api/offsets#hash-generation>`_
exclude_pinned (``bool``, *optional*):
Exclude pinned dialogs
parent_peer (:obj:`InputPeer <pyrogram.raw.base.InputPeer>`, *optional*):
If set, fetches the topic list of the passed monoforum, otherwise fetches the saved dialog list.
Returns:
:obj:`messages.SavedDialogs <pyrogram.raw.base.messages.SavedDialogs>`
"""
__slots__: List[str] = ["offset_date", "offset_id", "offset_peer", "limit", "hash", "exclude_pinned", "parent_peer"]
ID = 0x1e91fc99
QUALNAME = "functions.messages.GetSavedDialogs"
def __init__(self, *, offset_date: int, offset_id: int, offset_peer: "raw.base.InputPeer", limit: int, hash: int, exclude_pinned: Optional[bool] = None, parent_peer: "raw.base.InputPeer" = None) -> None:
self.offset_date = offset_date # int
self.offset_id = offset_id # int
self.offset_peer = offset_peer # InputPeer
self.limit = limit # int
self.hash = hash # long
self.exclude_pinned = exclude_pinned # flags.0?true
self.parent_peer = parent_peer # flags.1?InputPeer
@staticmethod
def read(b: BytesIO, *args: Any) -> "GetSavedDialogs":
flags = Int.read(b)
exclude_pinned = True if flags & (1 << 0) else False
parent_peer = TLObject.read(b) if flags & (1 << 1) else None
offset_date = Int.read(b)
offset_id = Int.read(b)
offset_peer = TLObject.read(b)
limit = Int.read(b)
hash = Long.read(b)
return GetSavedDialogs(offset_date=offset_date, offset_id=offset_id, offset_peer=offset_peer, limit=limit, hash=hash, exclude_pinned=exclude_pinned, parent_peer=parent_peer)
def write(self, *args) -> bytes:
b = BytesIO()
b.write(Int(self.ID, False))
flags = 0
flags |= (1 << 0) if self.exclude_pinned else 0
flags |= (1 << 1) if self.parent_peer is not None else 0
b.write(Int(flags))
if self.parent_peer is not None:
b.write(self.parent_peer.write())
b.write(Int(self.offset_date))
b.write(Int(self.offset_id))
b.write(self.offset_peer.write())
b.write(Int(self.limit))
b.write(Long(self.hash))
return b.getvalue()