Source code for pyrogram.methods.account.register_device

#  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 __future__ import annotations

import pyrogram
from pyrogram import raw


class RegisterDevice:
    async def register_device(
        self: pyrogram.Client,
        token_type: int,
        token: str,
        app_sandbox: bool = False,
        secret: bytes = b"",
        other_uids: list[int] | None = None,
        no_muted: bool | None = None,
    ) -> bool:
        """Register device to receive PUSH notifications.

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

        Parameters:
            token_type (``int``):
                Device token type.

            token (``str``):
                Device token.

            app_sandbox (``bool``, *optional*):
                Whether a sandbox-certificate will be used. Defaults to False.

            secret (``bytes``, *optional*):
                Optional encryption key used to encrypt push notifications. Defaults to b"".

            other_uids (List of ``int``, *optional*):
                List of user identifiers of other users currently using the client.

            no_muted (``bool``, *optional*):
                Avoid receiving silent background notifications.

        Returns:
            ``bool``: On success, True is returned.
        """
        return await self.invoke(
            raw.functions.account.RegisterDevice(
                token_type=token_type,
                token=token,
                app_sandbox=app_sandbox,
                secret=secret,
                other_uids=other_uids or [],
                no_muted=no_muted,
            )
        )