Source code for pyrogram.raw.functions.users.get_saved_music

#  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 GetSavedMusic(TLObject):  # type: ignore
    """Get songs `pinned to the user's profile, see here » <https://core.telegram.org/api/profile#music>`_ for more info.

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

    Details:
        - Layer: ``229``
        - ID: ``788D7FE3``

    Parameters:
        id (:obj:`InputUser <pyrogram.raw.base.InputUser>`):
            The ID of the user.

        offset (``int`` ``32-bit``):
            Offset for pagination.

        limit (``int`` ``32-bit``):
            Maximum number of results to return, `see pagination <https://core.telegram.org/api/offsets>`_

        hash (``int`` ``64-bit``):
            `Hash » <https://core.telegram.org/api/offsets#hash-generation>`_ of the IDs of previously added songs, to avoid returning any result if there was no change.

    Returns:
        :obj:`users.SavedMusic <pyrogram.raw.base.users.SavedMusic>`
    """

    __slots__: List[str] = ["id", "offset", "limit", "hash"]

    ID = 0x788d7fe3
    QUALNAME = "functions.users.GetSavedMusic"

    def __init__(self, *, id: "raw.base.InputUser", offset: int, limit: int, hash: int) -> None:
        self.id = id  # InputUser
        self.offset = offset  # int
        self.limit = limit  # int
        self.hash = hash  # long

    @staticmethod
    def read(b: BytesIO, *args: Any) -> "GetSavedMusic":
        # No flags
        
        id = TLObject.read(b)
        
        offset = Int.read(b)
        
        limit = Int.read(b)
        
        hash = Long.read(b)
        
        return GetSavedMusic(id=id, offset=offset, limit=limit, hash=hash)

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

        # No flags
        
        b.write(self.id.write())
        
        b.write(Int(self.offset))
        
        b.write(Int(self.limit))
        
        b.write(Long(self.hash))
        
        return b.getvalue()