Source code for pyrogram.raw.functions.messages.get_forum_topics

#  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! #
# # # # # # # # # # # # # # # # # # # # # # # #




class GetForumTopics(TLObject):  # type: ignore
    """Get `topics of a forum <https://core.telegram.org/api/forum>`_

    .. include:: /_includes/usable-by/users.rst

    Details:
        - Layer: ``229``
        - ID: ``3BA47BFF``

    Parameters:
        peer (:obj:`InputPeer <pyrogram.raw.base.InputPeer>`):
            The supergroup forum, private chat (for forum-enabled bots) or bot forum (for users) where the topic is located.

        offset_date (``int`` ``32-bit``):
            `Offsets for pagination, for more info click here <https://core.telegram.org/api/offsets>`_, date of the last message of the last found topic. Use 0 or any date in the future to get results from the last topic.

        offset_id (``int`` ``32-bit``):
            `Offsets for pagination, for more info click here <https://core.telegram.org/api/offsets>`_, ID of the last message of the last found topic (or initially ``0`` ).

        offset_topic (``int`` ``32-bit``):
            `Offsets for pagination, for more info click here <https://core.telegram.org/api/offsets>`_, ID of the last found topic (or initially ``0`` ).

        limit (``int`` ``32-bit``):
            Maximum number of results to return, `see pagination <https://core.telegram.org/api/offsets>`_. For optimal performance, the number of returned topics is chosen by the server and can be smaller than the specified limit.

        q (``str``, *optional*):
            Search query

    Returns:
        :obj:`messages.ForumTopics <pyrogram.raw.base.messages.ForumTopics>`
    """

    __slots__: List[str] = ["peer", "offset_date", "offset_id", "offset_topic", "limit", "q"]

    ID = 0x3ba47bff
    QUALNAME = "functions.messages.GetForumTopics"

    def __init__(self, *, peer: "raw.base.InputPeer", offset_date: int, offset_id: int, offset_topic: int, limit: int, q: Optional[str] = None) -> None:
        self.peer = peer  # InputPeer
        self.offset_date = offset_date  # int
        self.offset_id = offset_id  # int
        self.offset_topic = offset_topic  # int
        self.limit = limit  # int
        self.q = q  # flags.0?string

    @staticmethod
    def read(b: BytesIO, *args: Any) -> "GetForumTopics":
        
        flags = Int.read(b)
        
        peer = TLObject.read(b)
        
        q = String.read(b) if flags & (1 << 0) else None
        offset_date = Int.read(b)
        
        offset_id = Int.read(b)
        
        offset_topic = Int.read(b)
        
        limit = Int.read(b)
        
        return GetForumTopics(peer=peer, offset_date=offset_date, offset_id=offset_id, offset_topic=offset_topic, limit=limit, q=q)

    def write(self, *args) -> bytes:
        b = BytesIO()
        b.write(Int(self.ID, False))

        flags = 0
        flags |= (1 << 0) if self.q is not None else 0
        b.write(Int(flags))
        
        b.write(self.peer.write())
        
        if self.q is not None:
            b.write(String(self.q))
        
        b.write(Int(self.offset_date))
        
        b.write(Int(self.offset_id))
        
        b.write(Int(self.offset_topic))
        
        b.write(Int(self.limit))
        
        return b.getvalue()