mirror of
https://github.com/Mayuri-Chan/pyrofork.git
synced 2025-12-30 04:24:50 +00:00
6e1425ada3
* delete_messages: Drop support for generators Since we used a list there anyway, this approach will lead to more localized errors and can reduce function overhead. Signed-off-by: devops117 <55235206+devops117@users.noreply.github.com> * delete_messages: Return pts_count:int An example usecase would be for a normal bot which uses range based on message ids instead of keeping a track of messages and using the DeletedMessagesHandler. Signed-off-by: devops117 <55235206+devops117@users.noreply.github.com> * Drop support for Iterators and update docstrings and some cleanups. Signed-off-by: devops117 <55235206+devops117@users.noreply.github.com> * Update get_users.py * Update get_messages.py * Update delete_messages.py * Update forward_messages.py * Update get_messages.py Co-authored-by: Dan <14043624+delivrance@users.noreply.github.com>
86 lines
3.2 KiB
Python
86 lines
3.2 KiB
Python
# 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 typing import Union, List
|
|
|
|
import pyrogram
|
|
from pyrogram import raw
|
|
|
|
|
|
class DeleteMessages:
|
|
async def delete_messages(
|
|
self: "pyrogram.Client",
|
|
chat_id: Union[int, str],
|
|
message_ids: Union[int, List[int]],
|
|
revoke: bool = True
|
|
) -> int:
|
|
"""Delete messages, including service messages.
|
|
|
|
Parameters:
|
|
chat_id (``int`` | ``str``):
|
|
Unique identifier (int) or username (str) of the target chat.
|
|
For your personal cloud (Saved Messages) you can simply use "me" or "self".
|
|
For a contact that exists in your Telegram address book you can use his phone number (str).
|
|
|
|
message_ids (``int`` | List of ``int``):
|
|
A list of Message identifiers to delete (integers) or a single message id.
|
|
|
|
revoke (``bool``, *optional*):
|
|
Deletes messages on both parts.
|
|
This is only for private cloud chats and normal groups, messages on
|
|
channels and supergroups are always revoked (i.e.: deleted for everyone).
|
|
Defaults to True.
|
|
|
|
Returns:
|
|
``int``: Amount of affected messages
|
|
|
|
Example:
|
|
.. code-block:: python
|
|
|
|
# Delete one message
|
|
await app.delete_messages(chat_id, message_id)
|
|
|
|
# Delete multiple messages at once
|
|
await app.delete_messages(chat_id, list_of_message_ids)
|
|
|
|
# Delete messages only on your side (without revoking)
|
|
await app.delete_messages(chat_id, message_id, revoke=False)
|
|
"""
|
|
peer = await self.resolve_peer(chat_id)
|
|
# Follow type annotation of the raw function "DeleteMessage".
|
|
if not isinstance(message_ids, list):
|
|
message_ids = [message_ids]
|
|
|
|
if isinstance(peer, raw.types.InputPeerChannel):
|
|
r = await self.invoke(
|
|
raw.functions.channels.DeleteMessages(
|
|
channel=peer,
|
|
id=message_ids
|
|
)
|
|
)
|
|
else:
|
|
r = await self.invoke(
|
|
raw.functions.messages.DeleteMessages(
|
|
id=message_ids,
|
|
revoke=revoke or None # Follow the type annotation.
|
|
)
|
|
)
|
|
|
|
# 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 r.pts_count
|