Source code for pyrogram.raw.types.auth.authorization
# 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 Authorization(TLObject): # type: ignore
"""Contains user authorization info.
Constructor of :obj:`~pyrogram.raw.base.auth.Authorization`.
Details:
- Layer: ``229``
- ID: ``2EA2C0D4``
Parameters:
user (:obj:`User <pyrogram.raw.base.User>`):
Info on authorized user
setup_password_required (``bool``, *optional*):
Suggests the user to set up a 2-step verification password to be able to log in again
otherwise_relogin_days (``int`` ``32-bit``, *optional*):
If and only if setup_password_required is set and the user declines to set a 2-step verification password, they will be able to log into their account via SMS again only after this many days pass.
tmp_sessions (``int`` ``32-bit``, *optional*):
Number of `parallel sessions <https://core.telegram.org/api/datacenter#parallel-sessions>`_ the client may open to the main connection of its home DC to increase throughput; if absent or ``≤ 1``, a single main session must be used
future_auth_token (``bytes``, *optional*):
A `future auth token <https://core.telegram.org/api/auth#future-auth-tokens>`_
Functions:
This object can be returned by 10 functions.
.. currentmodule:: pyrogram.raw.functions
.. autosummary::
:nosignatures:
auth.SignUp
auth.SignIn
auth.ImportAuthorization
auth.ImportBotAuthorization
auth.CheckPassword
auth.RecoverPassword
auth.ImportWebTokenAuthorization
auth.FinishPasskeyLogin
auth.FinishFirebasePnvLogin
auth.FirebasePnvSignUp
"""
__slots__: List[str] = ["user", "setup_password_required", "otherwise_relogin_days", "tmp_sessions", "future_auth_token"]
ID = 0x2ea2c0d4
QUALNAME = "types.auth.Authorization"
def __init__(self, *, user: "raw.base.User", setup_password_required: Optional[bool] = None, otherwise_relogin_days: Optional[int] = None, tmp_sessions: Optional[int] = None, future_auth_token: Optional[bytes] = None) -> None:
self.user = user # User
self.setup_password_required = setup_password_required # flags.1?true
self.otherwise_relogin_days = otherwise_relogin_days # flags.1?int
self.tmp_sessions = tmp_sessions # flags.0?int
self.future_auth_token = future_auth_token # flags.2?bytes
@staticmethod
def read(b: BytesIO, *args: Any) -> "Authorization":
flags = Int.read(b)
setup_password_required = True if flags & (1 << 1) else False
otherwise_relogin_days = Int.read(b) if flags & (1 << 1) else None
tmp_sessions = Int.read(b) if flags & (1 << 0) else None
future_auth_token = Bytes.read(b) if flags & (1 << 2) else None
user = TLObject.read(b)
return Authorization(user=user, setup_password_required=setup_password_required, otherwise_relogin_days=otherwise_relogin_days, tmp_sessions=tmp_sessions, future_auth_token=future_auth_token)
def write(self, *args) -> bytes:
b = BytesIO()
b.write(Int(self.ID, False))
flags = 0
flags |= (1 << 1) if self.setup_password_required else 0
flags |= (1 << 1) if self.otherwise_relogin_days is not None else 0
flags |= (1 << 0) if self.tmp_sessions is not None else 0
flags |= (1 << 2) if self.future_auth_token is not None else 0
b.write(Int(flags))
if self.otherwise_relogin_days is not None:
b.write(Int(self.otherwise_relogin_days))
if self.tmp_sessions is not None:
b.write(Int(self.tmp_sessions))
if self.future_auth_token is not None:
b.write(Bytes(self.future_auth_token))
b.write(self.user.write())
return b.getvalue()