Source code for pyrogram.methods.chats.unban_chat_member
# 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, utils
class UnbanChatMember:
async def unban_chat_member(
self: pyrogram.Client, chat_id: int | str, user_id: int | str
) -> bool:
"""Unban a previously banned user in a supergroup or channel.
The user will **not** return to the group or channel automatically, but will be able to join via link, etc.
You must be an administrator for this to work.
Basic groups keep no ban list: a member removed from one can be added back or rejoin via link at any
time, so unbanning there is a no-op that returns True.
.. include:: /_includes/usable-by/users-bots.rst
Parameters:
chat_id (``int`` | ``str``):
Unique identifier (int) or username (str) of the target chat.
user_id (``int`` | ``str``):
Unique identifier (int) or username (str) of the target user.
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
# Unban chat member right now
await app.unban_chat_member(chat_id, user_id)
"""
chat_peer = await self.resolve_peer(chat_id)
if isinstance(chat_peer, raw.types.InputPeerChat):
return True
await self.invoke(
raw.functions.channels.EditBanned(
channel=utils.get_input_channel(chat_peer),
participant=await self.resolve_peer(user_id),
banned_rights=raw.types.ChatBannedRights(until_date=0),
)
)
return True