MTPyroger/pyrogram/methods/chats/leave_chat.py

76 lines
2.5 KiB
Python
Raw Normal View History

2020-03-21 14:43:32 +00:00
# Pyrogram - Telegram MTProto API Client Library for Python
# Copyright (C) 2017-2020 Dan <https://github.com/delivrance>
#
2020-03-21 14:43:32 +00:00
# This file is part of Pyrogram.
#
2020-03-21 14:43:32 +00:00
# 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.
#
2020-03-21 14:43:32 +00:00
# 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.
#
2020-03-21 14:43:32 +00:00
# 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 import raw
from pyrogram.scaffold import Scaffold
class LeaveChat(Scaffold):
async def leave_chat(
2019-03-16 18:23:23 +00:00
self,
chat_id: Union[int, str],
delete: bool = False
):
"""Leave a group chat or channel.
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).
2019-07-25 09:22:14 +00:00
Defaults to False.
2019-07-25 09:22:14 +00:00
Example:
.. code-block:: python
# Leave chat or channel
app.leave_chat(chat_id)
# Leave basic chat and also delete the dialog
app.leave_chat(chat_id, delete=True)
"""
peer = await self.resolve_peer(chat_id)
if isinstance(peer, raw.types.InputPeerChannel):
return await self.send(
raw.functions.channels.LeaveChannel(
channel=await self.resolve_peer(chat_id)
)
)
elif isinstance(peer, raw.types.InputPeerChat):
r = await self.send(
raw.functions.messages.DeleteChatUser(
chat_id=peer.chat_id,
user_id=raw.types.InputUserSelf()
)
)
if delete:
await self.send(
raw.functions.messages.DeleteHistory(
peer=peer,
max_id=0
)
)
return r