Source code for pyrogram.methods.chats.leave_chat
# 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 LeaveChat:
async def leave_chat(self: pyrogram.Client, chat_id: int | str, delete: bool = False):
"""Leave a group chat or channel.
.. include:: /_includes/usable-by/users-bots.rst
Parameters:
chat_id (``int`` | ``str``):
Unique identifier for the target chat or username of the target channel/supergroup
(in the format @username).
delete (``bool``, *optional*):
Deletes the group chat dialog after leaving (for simple group chats, not supergroups).
Defaults to False.
Returns:
``RawType``: On success, the raw result of the underlying request is returned.
Example:
.. code-block:: python
# Leave chat or channel
await app.leave_chat(chat_id)
# Leave basic chat and also delete the dialog
await app.leave_chat(chat_id, delete=True)
"""
peer = await self.resolve_peer(chat_id)
if isinstance(peer, (raw.types.InputPeerChannel, raw.types.InputPeerChannelFromMessage)):
return await self.invoke(
raw.functions.channels.LeaveChannel(channel=utils.get_input_channel(peer))
)
elif isinstance(peer, raw.types.InputPeerChat):
r = await self.invoke(
raw.functions.messages.DeleteChatUser(
chat_id=peer.chat_id, user_id=raw.types.InputUserSelf()
)
)
if delete:
rpc = raw.functions.messages.DeleteHistory(peer=peer, max_id=0)
while (await self.invoke(rpc)).offset:
pass
return r