53 lines
1.7 KiB
Python
53 lines
1.7 KiB
Python
# Pyrogram - Telegram MTProto API Client Library for Python
|
|
# Copyright (C) 2017-2020 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 typing import Union
|
|
|
|
from pyrogram.api import functions
|
|
from ...ext import BaseClient
|
|
|
|
|
|
class BlockUser(BaseClient):
|
|
async def block_user(
|
|
self,
|
|
user_id: Union[int, str]
|
|
) -> bool:
|
|
"""Block a user.
|
|
|
|
Parameters:
|
|
user_id (``int`` | ``str``)::
|
|
Unique identifier (int) or username (str) of the target user.
|
|
For you yourself you can simply use "me" or "self".
|
|
For a contact that exists in your Telegram address book you can use his phone number (str).
|
|
|
|
Returns:
|
|
``bool``: True on success
|
|
|
|
Example:
|
|
.. code-block:: python
|
|
|
|
app.block_user(user_id)
|
|
"""
|
|
return bool(
|
|
await self.send(
|
|
functions.contacts.Block(
|
|
id=await self.resolve_peer(user_id)
|
|
)
|
|
)
|
|
)
|