Skip to content

decorators.rst

Latest commit

 

History

History
57 lines (41 loc) · 1.47 KB

decorators.rst

File metadata and controls

57 lines (41 loc) · 1.47 KB

Decorators

While still being methods bound to the :class:`~pyrogram.Client` class, decorators are of a special kind and thus deserve a dedicated page.

Decorators are able to register callback functions for handling updates in a much easier and cleaner way compared to :doc:`Handlers <handlers>`; they do so by instantiating the correct handler and calling :meth:`~pyrogram.Client.add_handler` automatically. All you need to do is adding the decorators on top of your functions.

from pyrogram import Client

app = Client("my_account")


@app.on_message()
def log(client, message):
    print(message)


app.run()
.. currentmodule:: pyrogram

Index

.. hlist::
    :columns: 3

    - :meth:`~Client.on_message`
    - :meth:`~Client.on_callback_query`
    - :meth:`~Client.on_inline_query`
    - :meth:`~Client.on_deleted_messages`
    - :meth:`~Client.on_user_status`
    - :meth:`~Client.on_poll`
    - :meth:`~Client.on_disconnect`
    - :meth:`~Client.on_raw_update`

Details

.. autodecorator:: pyrogram.Client.on_message()

.. autodecorator:: pyrogram.Client.on_callback_query()

.. autodecorator:: pyrogram.Client.on_inline_query()

.. autodecorator:: pyrogram.Client.on_deleted_messages()

.. autodecorator:: pyrogram.Client.on_user_status()

.. autodecorator:: pyrogram.Client.on_poll()

.. autodecorator:: pyrogram.Client.on_disconnect()

.. autodecorator:: pyrogram.Client.on_raw_update()