Better organize Client's methods

This commit is contained in:
Dan 2018-07-24 20:43:49 +02:00
parent 73361fef47
commit df2f302c72

View File

@ -1,82 +1,135 @@
Client
======
.. currentmodule:::: pyrogram.Client
.. currentmodule:: pyrogram.Client
.. autoclass:: pyrogram.Client
Utilities
---------
.. autosummary::
:nosignatures:
start
stop
idle
run
add_handler
remove_handler
send
resolve_peer
download_media
Decorators
----------
.. autosummary::
:nosignatures:
on_message
on_callback_query
on_deleted_messages
on_disconnect
on_raw_update
.. _available-methods:
Messages
--------
.. autosummary::
:nosignatures:
send_message
forward_messages
send_photo
send_audio
send_document
send_sticker
send_video
send_gif
send_voice
send_video_note
send_media_group
send_location
send_venue
send_contact
send_chat_action
edit_message_text
edit_message_caption
edit_message_reply_markup
delete_messages
get_messages
get_history
get_dialogs
Chats
-----
.. autosummary::
:nosignatures:
join_chat
leave_chat
kick_chat_member
unban_chat_member
restrict_chat_member
promote_chat_member
export_chat_invite_link
set_chat_photo
delete_chat_photo
set_chat_title
set_chat_description
pin_chat_message
unpin_chat_message
get_chat
get_chat_member
get_chat_members
Users
-----
.. autosummary::
:nosignatures:
get_me
get_users
get_user_profile_photos
delete_profile_photos
Contacts
--------
.. autosummary::
:nosignatures:
add_contacts
get_contacts
delete_contacts
Password
--------
.. autosummary::
:nosignatures:
enable_cloud_password
change_cloud_password
remove_cloud_password
Bots
----
.. autosummary::
:nosignatures:
get_inline_bot_results
send_inline_bot_result
answer_callback_query
request_callback_answer
.. autoclass:: pyrogram.Client
:inherited-members:
:members:
.. _available-methods:
**Available methods**
.. autosummary::
:nosignatures:
start
stop
idle
run
on_message
on_callback_query
on_deleted_messages
on_disconnect
on_raw_update
add_handler
remove_handler
send
resolve_peer
get_me
send_message
forward_messages
send_photo
send_audio
send_document
send_gif
send_sticker
send_video
send_voice
send_video_note
send_media_group
send_location
send_venue
send_contact
send_chat_action
download_media
get_user_profile_photos
delete_profile_photos
edit_message_text
edit_message_caption
edit_message_reply_markup
delete_messages
join_chat
leave_chat
export_chat_invite_link
enable_cloud_password
change_cloud_password
remove_cloud_password
kick_chat_member
unban_chat_member
restrict_chat_member
promote_chat_member
add_contacts
get_contacts
delete_contacts
get_inline_bot_results
send_inline_bot_result
answer_callback_query
request_callback_answer
get_users
get_chat
get_messages
get_history
set_chat_photo
delete_chat_photo
set_chat_title
set_chat_description
pin_chat_message
unpin_chat_message
get_chat_member
get_chat_members
get_dialogs