Source code for pyrogram.methods.auth.cancel_code
# 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 CancelCode:
async def cancel_code(
self: pyrogram.Client,
phone_number: str,
phone_code_hash: str,
) -> bool:
"""Cancel the login verification code.
.. include:: /_includes/usable-by/users.rst
Parameters:
phone_number (``str``):
Phone number where the code was sent.
phone_code_hash (``str``):
Phone code hash from send_code.
Returns:
``bool``: On success, True is returned.
Example:
.. code-block:: python
await app.cancel_code("+1234567890", code_hash)
"""
return await self.invoke(
raw.functions.auth.CancelCode(
phone_number=phone_number,
phone_code_hash=phone_code_hash,
)
)