ee5f39374c
* Add new invite link export methods * Implement higher-level Invite type * Update Docstrings and rename Invite * Docstrings are now more consistent with other methods * Invite is now InviteLink to be less arbitrary * Add method to get exported links * `get_exported_chat_invites` * prepare `__init__` for the other InvitesV2 methods * Update returned type `str` -> `types.InviteLink` * Add method to edit invite link Since editing the link returns a slightly different type to exporting, I have made a small "hack" in the InviteLink type. * Move Invites V2 methods to their own namespace * Add get_chat_invite_importers and InviteImporter Method to fetch information on users that joined via a specific link and the type to display the information * Add methods to delete revoked links * delete_exported_chat_invite to delete a single revoked link * delete_revoked_exported_chat_invites to delete all revoked links of a specified admin * Renaming Invite(s) to InviteLink(s) As per @delivrance's request https://github.com/pyrogram/pyrogram/pull/630#issuecomment-791893890 Also sorted invites' __init__ alphabetically * Add Method to get admins with exported invite link Documentation needs an update and the respective type needs to be created. I cannot test this, as I lack Creator permissions. * Invite Links overhaul * Rearrange code Co-authored-by: Dan <14043624+delivrance@users.noreply.github.com>
170 lines
1.9 KiB
ReStructuredText
170 lines
1.9 KiB
ReStructuredText
Available Methods
|
|
=================
|
|
|
|
This page is about Pyrogram methods. All the methods listed here are bound to a :class:`~pyrogram.Client` instance,
|
|
except for :meth:`~pyrogram.idle()`, which is a special function that can be found in the main package directly.
|
|
|
|
.. code-block:: python
|
|
:emphasize-lines: 6
|
|
|
|
from pyrogram import Client
|
|
|
|
app = Client("my_account")
|
|
|
|
with app:
|
|
app.send_message("haskell", "hi")
|
|
|
|
.. contents:: Contents
|
|
:backlinks: none
|
|
:local:
|
|
|
|
-----
|
|
|
|
.. currentmodule:: pyrogram.Client
|
|
|
|
Utilities
|
|
---------
|
|
|
|
.. autosummary::
|
|
:nosignatures:
|
|
|
|
{utilities}
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
{utilities}
|
|
|
|
.. currentmodule:: pyrogram
|
|
|
|
.. autosummary::
|
|
:nosignatures:
|
|
|
|
idle
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
idle
|
|
|
|
.. currentmodule:: pyrogram.Client
|
|
|
|
Messages
|
|
--------
|
|
|
|
.. autosummary::
|
|
:nosignatures:
|
|
|
|
{messages}
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
{messages}
|
|
|
|
Chats
|
|
-----
|
|
|
|
.. autosummary::
|
|
:nosignatures:
|
|
|
|
{chats}
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
{chats}
|
|
|
|
Users
|
|
-----
|
|
|
|
.. autosummary::
|
|
:nosignatures:
|
|
|
|
{users}
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
{users}
|
|
|
|
Invite Links
|
|
------------
|
|
|
|
.. autosummary::
|
|
:nosignatures:
|
|
|
|
{invite_links}
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
{invite_links}
|
|
|
|
Contacts
|
|
--------
|
|
|
|
.. autosummary::
|
|
:nosignatures:
|
|
|
|
{contacts}
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
{contacts}
|
|
|
|
Password
|
|
--------
|
|
|
|
.. autosummary::
|
|
:nosignatures:
|
|
|
|
{password}
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
{password}
|
|
|
|
Bots
|
|
----
|
|
|
|
.. autosummary::
|
|
:nosignatures:
|
|
|
|
{bots}
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
{bots}
|
|
|
|
Authorization
|
|
-------------
|
|
|
|
.. autosummary::
|
|
:nosignatures:
|
|
|
|
{authorization}
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
{authorization}
|
|
|
|
Advanced
|
|
--------
|
|
|
|
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>`.
|
|
|
|
.. autosummary::
|
|
:nosignatures:
|
|
|
|
{advanced}
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
{advanced} |