Add delete_chat_history

Co-authored-by: KurimuzonAkuma <[email protected]>

Author: SpEcHiDe

docs/source/releases/changes-in-this-fork.rst

@@ -33,6 +33,7 @@ Changes in this Fork
 | Scheme layer used: 200 |
 +------------------------+
 
+- Added :meth:`~pyrogram.Client.delete_chat_history`.
 - Rename ``UserGift`` to :obj:`~pyrogram.types.ReceivedGift`, ``get_user_gifts`` to :meth:`~pyrogram.Client.get_received_gifts` and the corresponding fields appropriately.
 - Added the field ``paid_message_star_count`` to the classes :obj:`~pyrogram.types.Chat`, :obj:`~pyrogram.types.Message` and :obj:`~pyrogram.types.User`.
 - Added the parameter ``paid_message_star_count`` to the methods :meth:`~pyrogram.Client.copy_media_group`, :meth:`~pyrogram.Client.send_game`, :meth:`~pyrogram.Client.send_invoice`, :meth:`~pyrogram.Client.forward_messages`, :meth:`~pyrogram.Client.send_animation`, :meth:`~pyrogram.Client.send_audio`, :meth:`~pyrogram.Client.send_cached_media`, :meth:`~pyrogram.Client.send_contact`, :meth:`~pyrogram.Client.send_dice`, :meth:`~pyrogram.Client.send_document`, :meth:`~pyrogram.Client.send_location`, :meth:`~pyrogram.Client.send_media_group`, :meth:`~pyrogram.Client.send_message`, :meth:`~pyrogram.Client.send_paid_media`, :meth:`~pyrogram.Client.send_photo`, :meth:`~pyrogram.Client.send_poll`, :meth:`~pyrogram.Client.send_sticker`, :meth:`~pyrogram.Client.send_venue`, :meth:`~pyrogram.Client.send_video_note`, :meth:`~pyrogram.Client.send_video`, :meth:`~pyrogram.Client.send_voice` and the bound methods :meth:`~pyrogram.types.Message.forward` and :meth:`~pyrogram.types.Message.copy`.

pyrogram/methods/messages/__init__.py

@@ -18,6 +18,7 @@
 
 from .copy_media_group import CopyMediaGroup
 from .copy_message import CopyMessage
+from .delete_chat_history import DeleteChatHistory
 from .delete_messages import DeleteMessages
 from .download_media import DownloadMedia
 from .edit_cached_media import EditCachedMedia
@@ -76,6 +77,7 @@
 class Messages(
     CopyMediaGroup,
     CopyMessage,
+    DeleteChatHistory,
     DeleteMessages,
     DownloadMedia,
     EditCachedMedia,

pyrogram/methods/messages/delete_chat_history.py

@@ -0,0 +1,105 @@
+#  Pyrogram - Telegram MTProto API Client Library for Python
+#  Copyright (C) 2017-present <https://github.com/TelegramPlayGround>
+#
+#  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 datetime import datetime
+import logging
+from typing import Optional, Union
+
+import pyrogram
+from pyrogram import raw, utils
+
+log = logging.getLogger(__name__)
+
+
+class DeleteChatHistory:
+    async def delete_chat_history(
+        self: "pyrogram.Client",
+        chat_id: Union[int, str],
+        max_id: Optional[int] = 0,
+        # TODO
+        revoke: Optional[bool] = None,
+        just_clear: Optional[bool] = None,
+        min_date: Optional[datetime] = None,
+        max_date: Optional[datetime] = None
+    ) -> int:
+        """Deletes all messages in the chat. For group chats this will release the usernames and remove all members.
+
+        .. include:: /_includes/usable-by/users.rst
+
+        Parameters:
+            chat_id (``int`` | ``str``):
+                Unique identifier (int) or username (str) of the target chat.
+
+            max_id (``int``, *optional*):
+                Maximum ID of message to delete.
+                Defaults to 0.
+
+            revoke (``bool``, *optional*):
+                Pass True to delete messages for all chat members.
+                Always True if using in :obj:`~pyrogram.enums.ChatType.CHANNEL` and :obj:`~pyrogram.enums.ChatType.SUPERGROUP` chats.
+
+            just_clear (``bool``, *optional*):
+                Pass True to clear history for the current user, without actually removing chat.
+                For :obj:`~pyrogram.enums.ChatType.PRIVATE` and :obj:`~pyrogram.enums.ChatType.GROUP` chats only.
+
+            min_date (:py:obj:`~datetime.datetime`, *optional*):
+                The minimum date of the messages to delete.
+                Delete all messages newer than this time.
+                For :obj:`~pyrogram.enums.ChatType.PRIVATE` and :obj:`~pyrogram.enums.ChatType.GROUP` chats only.
+
+            max_date (:py:obj:`~datetime.datetime`, *optional*):
+                The maximum date of the messages to delete.
+                Delete all messages older than this time.
+                For :obj:`~pyrogram.enums.ChatType.PRIVATE` and :obj:`~pyrogram.enums.ChatType.GROUP` chats only.
+
+        Returns:
+            ``int``: Amount of affected messages
+
+        Example:
+            .. code-block:: python
+
+                # Delete all messages in channel
+                await app.delete_chat_history(chat_id, revoke=True)
+
+        """
+        peer = await self.resolve_peer(chat_id)
+
+        if isinstance(peer, raw.types.InputPeerChannel):
+            r = await self.invoke(
+                raw.functions.channels.DeleteHistory(
+                    channel=raw.types.InputChannel(
+                        channel_id=peer.channel_id,
+                        access_hash=peer.access_hash
+                    ),
+                    max_id=max_id,
+                    for_everyone=revoke
+                )
+            )
+        else:
+            r = await self.invoke(
+                raw.functions.messages.DeleteHistory(
+                    peer=peer,
+                    max_id=max_id,
+                    just_clear=just_clear,
+                    revoke=revoke,
+                    min_date=utils.datetime_to_timestamp(min_date),
+                    max_date=utils.datetime_to_timestamp(max_date)
+                )
+            )
+
+        return len(r.updates[0].messages) if isinstance(peer, raw.types.InputPeerChannel) else r.pts_count