56 lines
2.3 KiB
Python
56 lines
2.3 KiB
Python
# Pyrogram - Telegram MTProto API Client Library for Python
|
|
# Copyright (C) 2017-2021 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 List, Callable
|
|
|
|
import pyrogram
|
|
from pyrogram.filters import Filter
|
|
from pyrogram.types import Message
|
|
from .handler import Handler
|
|
|
|
|
|
class DeletedMessagesHandler(Handler):
|
|
"""The deleted messages handler class. Used to handle deleted messages coming from any chat
|
|
(private, group, channel). It is intended to be used with :meth:`~pyrogram.Client.add_handler`
|
|
|
|
For a nicer way to register this handler, have a look at the
|
|
:meth:`~pyrogram.Client.on_deleted_messages` decorator.
|
|
|
|
Parameters:
|
|
callback (``callable``):
|
|
Pass a function that will be called when one or more messages have been deleted.
|
|
It takes *(client, messages)* as positional arguments (look at the section below for a detailed description).
|
|
|
|
filters (:obj:`Filters`):
|
|
Pass one or more filters to allow only a subset of messages to be passed
|
|
in your callback function.
|
|
|
|
Other parameters:
|
|
client (:obj:`~pyrogram.Client`):
|
|
The Client itself, useful when you want to call other API methods inside the message handler.
|
|
|
|
messages (List of :obj:`~pyrogram.types.Message`):
|
|
The deleted messages, as list.
|
|
"""
|
|
|
|
def __init__(self, callback: Callable, filters: Filter = None):
|
|
super().__init__(callback, filters)
|
|
|
|
async def check(self, client: "pyrogram.Client", messages: List[Message]):
|
|
return await super().check(client, messages[0]) if messages else False # The messages list can be empty
|