Add method delete_user_history (pyrogram#282)

kalmengr · delivrance · delivrance · commit c5cc85f00761 · 2019-12-23T19:05:30.000+01:00
* Add method delete_all_user_messages

* Update delete_all_user_messages.py

* Rename delete_all_user_messages.py to delete_user_history.py

Co-authored-by: Dan &lt;14043624+delivrance@users.noreply.github.com&gt;
diff --git a/pyrogram/client/methods/chats/delete_user_history.py b/pyrogram/client/methods/chats/delete_user_history.py
@@ -0,0 +1,53 @@
+# Pyrogram - Telegram MTProto API Client Library for Python
+# Copyright (C) 2017-2019 Dan Tès <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, types
+from pyrogram.client.ext import BaseClient
+
+
+class DeleteUserHistory(BaseClient):
+    def delete_user_history(
+        self,
+        chat_id: Union[int, str],
+        user_id: Union[int, str],
+    ) -> bool:
+        """Delete all messages sent by a certain user in a supergroup.
+
+        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 user whose messages will be deleted.
+
+        Returns:
+            ``bool``: True on success, False otherwise.
+        """
+
+        r = self.send(
+            functions.channels.DeleteUserHistory(
+                channel=self.resolve_peer(chat_id),
+                user_id=self.resolve_peer(user_id)
+                )
+            )
+
+        # Deleting messages you don't have right onto won't raise any error.
+        # Check for pts_count, which is 0 in case deletes fail.
+        return bool(r.pts_count)
