2019-07-09 19:03:46 +02:00
|
|
|
Available Methods
|
|
|
|
=================
|
|
|
|
|
2022-04-24 11:56:07 +02:00
|
|
|
This page is about Pyrogram methods. All the methods listed here are bound to a :class:`~pyrogram.Client` instance,
|
|
|
|
except for :meth:`~pyrogram.idle()` and :meth:`~pyrogram.compose()`, which are special functions that can be found in
|
|
|
|
the main package directly.
|
2019-07-09 19:03:46 +02:00
|
|
|
|
|
|
|
.. code-block:: python
|
|
|
|
|
|
|
|
from pyrogram import Client
|
|
|
|
|
|
|
|
app = Client("my_account")
|
|
|
|
|
|
|
|
with app:
|
2022-01-07 10:18:51 +01:00
|
|
|
app.send_message("me", "hi")
|
2019-07-09 19:03:46 +02:00
|
|
|
|
2020-04-01 20:08:46 +02:00
|
|
|
-----
|
|
|
|
|
2019-07-09 19:03:46 +02:00
|
|
|
.. currentmodule:: pyrogram.Client
|
|
|
|
|
|
|
|
Utilities
|
|
|
|
---------
|
|
|
|
|
|
|
|
.. autosummary::
|
|
|
|
:nosignatures:
|
|
|
|
|
|
|
|
{utilities}
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:hidden:
|
|
|
|
|
|
|
|
{utilities}
|
|
|
|
|
2020-08-22 08:05:05 +02:00
|
|
|
.. currentmodule:: pyrogram
|
|
|
|
|
|
|
|
.. autosummary::
|
|
|
|
:nosignatures:
|
|
|
|
|
|
|
|
idle
|
2022-04-24 11:56:07 +02:00
|
|
|
compose
|
2020-08-22 08:05:05 +02:00
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:hidden:
|
|
|
|
|
|
|
|
idle
|
2022-04-24 11:56:07 +02:00
|
|
|
compose
|
2020-08-22 08:05:05 +02:00
|
|
|
|
|
|
|
.. currentmodule:: pyrogram.Client
|
|
|
|
|
2019-07-09 19:03:46 +02:00
|
|
|
Messages
|
|
|
|
--------
|
|
|
|
|
|
|
|
.. autosummary::
|
|
|
|
:nosignatures:
|
|
|
|
|
|
|
|
{messages}
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:hidden:
|
|
|
|
|
|
|
|
{messages}
|
|
|
|
|
|
|
|
Chats
|
|
|
|
-----
|
|
|
|
|
|
|
|
.. autosummary::
|
|
|
|
:nosignatures:
|
|
|
|
|
|
|
|
{chats}
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:hidden:
|
|
|
|
|
|
|
|
{chats}
|
|
|
|
|
|
|
|
Users
|
|
|
|
-----
|
|
|
|
|
|
|
|
.. autosummary::
|
|
|
|
:nosignatures:
|
|
|
|
|
|
|
|
{users}
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:hidden:
|
|
|
|
|
|
|
|
{users}
|
|
|
|
|
2021-03-17 12:40:36 +01:00
|
|
|
Invite Links
|
|
|
|
------------
|
|
|
|
|
|
|
|
.. autosummary::
|
|
|
|
:nosignatures:
|
|
|
|
|
|
|
|
{invite_links}
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:hidden:
|
|
|
|
|
|
|
|
{invite_links}
|
|
|
|
|
2019-07-09 19:03:46 +02:00
|
|
|
Contacts
|
|
|
|
--------
|
|
|
|
|
|
|
|
.. autosummary::
|
|
|
|
:nosignatures:
|
|
|
|
|
|
|
|
{contacts}
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:hidden:
|
|
|
|
|
|
|
|
{contacts}
|
|
|
|
|
|
|
|
Password
|
|
|
|
--------
|
|
|
|
|
|
|
|
.. autosummary::
|
|
|
|
:nosignatures:
|
|
|
|
|
|
|
|
{password}
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:hidden:
|
|
|
|
|
|
|
|
{password}
|
|
|
|
|
|
|
|
Bots
|
|
|
|
----
|
|
|
|
|
|
|
|
.. autosummary::
|
|
|
|
:nosignatures:
|
|
|
|
|
|
|
|
{bots}
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:hidden:
|
|
|
|
|
|
|
|
{bots}
|
|
|
|
|
2019-08-13 13:18:01 +02:00
|
|
|
Authorization
|
|
|
|
-------------
|
|
|
|
|
|
|
|
.. autosummary::
|
|
|
|
:nosignatures:
|
|
|
|
|
|
|
|
{authorization}
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:hidden:
|
|
|
|
|
|
|
|
{authorization}
|
|
|
|
|
2019-07-09 19:03:46 +02:00
|
|
|
Advanced
|
|
|
|
--------
|
|
|
|
|
2019-08-13 13:18:01 +02:00
|
|
|
Methods used only when dealing with the raw Telegram API.
|
|
|
|
Learn more about how to use the raw API at :doc:`Advanced Usage <../../topics/advanced-usage>`.
|
2019-07-09 19:03:46 +02:00
|
|
|
|
|
|
|
.. autosummary::
|
|
|
|
:nosignatures:
|
|
|
|
|
|
|
|
{advanced}
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:hidden:
|
|
|
|
|
|
|
|
{advanced}
|