MTPyroger/pyrogram/handlers/message_handler.py

48 lines
1.9 KiB
Python
Raw Normal View History

2020-03-21 14:43:32 +00:00
# Pyrogram - Telegram MTProto API Client Library for Python
2022-01-07 09:23:45 +00:00
# Copyright (C) 2017-present Dan <https://github.com/delivrance>
2018-05-20 10:53:00 +00:00
#
2020-03-21 14:43:32 +00:00
# This file is part of Pyrogram.
2018-05-20 10:53:00 +00:00
#
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.
2018-05-20 10:53:00 +00:00
#
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.
2018-05-20 10:53:00 +00:00
#
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/>.
2018-05-20 10:53:00 +00:00
from .handler import Handler
class MessageHandler(Handler):
"""The Message handler class. Used to handle text, media and service messages coming from
any chat (private, group, channel). It is intended to be used with :meth:`~pyrogram.Client.add_handler`
2018-05-20 10:53:00 +00:00
For a nicer way to register this handler, have a look at the
:meth:`~pyrogram.Client.on_message` decorator.
Parameters:
2018-05-20 10:53:00 +00:00
callback (``callable``):
Pass a function that will be called when a new Message arrives. It takes *(client, message)*
as positional arguments (look at the section below for a detailed description).
filters (:obj:`Filters`):
2018-05-20 10:53:00 +00:00
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`):
2018-05-20 10:53:00 +00:00
The Client itself, useful when you want to call other API methods inside the message handler.
message (:obj:`~pyrogram.types.Message`):
2018-05-20 10:53:00 +00:00
The received message.
"""
def __init__(self, callback: callable, filters=None):
super().__init__(callback, filters)