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:

    start <start>
    stop <stop>
    run <run>
    restart <restart>
    add_handler <add_handler>
    remove_handler <remove_handler>
    stop_transmission <stop_transmission>
    export_session_string <export_session_string>
    set_parse_mode <set_parse_mode>

.. toctree::
    :hidden:

    start <start>
    stop <stop>
    run <run>
    restart <restart>
    add_handler <add_handler>
    remove_handler <remove_handler>
    stop_transmission <stop_transmission>
    export_session_string <export_session_string>
    set_parse_mode <set_parse_mode>

.. currentmodule:: pyrogram

.. autosummary::
    :nosignatures:

    idle

.. toctree::
    :hidden:

    idle

.. currentmodule:: pyrogram.Client

Messages
--------

.. autosummary::
    :nosignatures:

    send_message <send_message>
    forward_messages <forward_messages>
    send_photo <send_photo>
    send_audio <send_audio>
    send_document <send_document>
    send_sticker <send_sticker>
    send_video <send_video>
    send_animation <send_animation>
    send_voice <send_voice>
    send_video_note <send_video_note>
    send_media_group <send_media_group>
    send_location <send_location>
    send_venue <send_venue>
    send_contact <send_contact>
    send_cached_media <send_cached_media>
    edit_message_text <edit_message_text>
    edit_message_caption <edit_message_caption>
    edit_message_media <edit_message_media>
    edit_message_reply_markup <edit_message_reply_markup>
    edit_inline_text <edit_inline_text>
    edit_inline_caption <edit_inline_caption>
    edit_inline_media <edit_inline_media>
    edit_inline_reply_markup <edit_inline_reply_markup>
    send_chat_action <send_chat_action>
    delete_messages <delete_messages>
    get_messages <get_messages>
    get_history <get_history>
    get_history_count <get_history_count>
    read_history <read_history>
    iter_history <iter_history>
    send_poll <send_poll>
    vote_poll <vote_poll>
    stop_poll <stop_poll>
    retract_vote <retract_vote>
    send_dice <send_dice>
    search_messages <search_messages>
    search_global <search_global>
    download_media <download_media>

.. toctree::
    :hidden:

    send_message <send_message>
    forward_messages <forward_messages>
    send_photo <send_photo>
    send_audio <send_audio>
    send_document <send_document>
    send_sticker <send_sticker>
    send_video <send_video>
    send_animation <send_animation>
    send_voice <send_voice>
    send_video_note <send_video_note>
    send_media_group <send_media_group>
    send_location <send_location>
    send_venue <send_venue>
    send_contact <send_contact>
    send_cached_media <send_cached_media>
    edit_message_text <edit_message_text>
    edit_message_caption <edit_message_caption>
    edit_message_media <edit_message_media>
    edit_message_reply_markup <edit_message_reply_markup>
    edit_inline_text <edit_inline_text>
    edit_inline_caption <edit_inline_caption>
    edit_inline_media <edit_inline_media>
    edit_inline_reply_markup <edit_inline_reply_markup>
    send_chat_action <send_chat_action>
    delete_messages <delete_messages>
    get_messages <get_messages>
    get_history <get_history>
    get_history_count <get_history_count>
    read_history <read_history>
    iter_history <iter_history>
    send_poll <send_poll>
    vote_poll <vote_poll>
    stop_poll <stop_poll>
    retract_vote <retract_vote>
    send_dice <send_dice>
    search_messages <search_messages>
    search_global <search_global>
    download_media <download_media>

Chats
-----

.. autosummary::
    :nosignatures:

    join_chat <join_chat>
    leave_chat <leave_chat>
    kick_chat_member <kick_chat_member>
    unban_chat_member <unban_chat_member>
    restrict_chat_member <restrict_chat_member>
    promote_chat_member <promote_chat_member>
    set_administrator_title <set_administrator_title>
    export_chat_invite_link <export_chat_invite_link>
    set_chat_photo <set_chat_photo>
    delete_chat_photo <delete_chat_photo>
    set_chat_title <set_chat_title>
    set_chat_description <set_chat_description>
    set_chat_permissions <set_chat_permissions>
    pin_chat_message <pin_chat_message>
    unpin_chat_message <unpin_chat_message>
    unpin_all_chat_messages <unpin_all_chat_messages>
    get_chat <get_chat>
    get_chat_member <get_chat_member>
    get_chat_members <get_chat_members>
    get_chat_members_count <get_chat_members_count>
    iter_chat_members <iter_chat_members>
    get_dialogs <get_dialogs>
    iter_dialogs <iter_dialogs>
    get_dialogs_count <get_dialogs_count>
    update_chat_username <update_chat_username>
    get_common_chats <get_common_chats>
    get_nearby_chats <get_nearby_chats>
    archive_chats <archive_chats>
    unarchive_chats <unarchive_chats>
    add_chat_members <add_chat_members>
    create_channel <create_channel>
    create_group <create_group>
    create_supergroup <create_supergroup>
    delete_channel <delete_channel>
    delete_supergroup <delete_supergroup>
    set_slow_mode <set_slow_mode>

.. toctree::
    :hidden:

    join_chat <join_chat>
    leave_chat <leave_chat>
    kick_chat_member <kick_chat_member>
    unban_chat_member <unban_chat_member>
    restrict_chat_member <restrict_chat_member>
    promote_chat_member <promote_chat_member>
    set_administrator_title <set_administrator_title>
    export_chat_invite_link <export_chat_invite_link>
    set_chat_photo <set_chat_photo>
    delete_chat_photo <delete_chat_photo>
    set_chat_title <set_chat_title>
    set_chat_description <set_chat_description>
    set_chat_permissions <set_chat_permissions>
    pin_chat_message <pin_chat_message>
    unpin_chat_message <unpin_chat_message>
    unpin_all_chat_messages <unpin_all_chat_messages>
    get_chat <get_chat>
    get_chat_member <get_chat_member>
    get_chat_members <get_chat_members>
    get_chat_members_count <get_chat_members_count>
    iter_chat_members <iter_chat_members>
    get_dialogs <get_dialogs>
    iter_dialogs <iter_dialogs>
    get_dialogs_count <get_dialogs_count>
    update_chat_username <update_chat_username>
    get_common_chats <get_common_chats>
    get_nearby_chats <get_nearby_chats>
    archive_chats <archive_chats>
    unarchive_chats <unarchive_chats>
    add_chat_members <add_chat_members>
    create_channel <create_channel>
    create_group <create_group>
    create_supergroup <create_supergroup>
    delete_channel <delete_channel>
    delete_supergroup <delete_supergroup>
    set_slow_mode <set_slow_mode>

Users
-----

.. autosummary::
    :nosignatures:

    get_me <get_me>
    get_users <get_users>
    get_profile_photos <get_profile_photos>
    get_profile_photos_count <get_profile_photos_count>
    iter_profile_photos <iter_profile_photos>
    set_profile_photo <set_profile_photo>
    delete_profile_photos <delete_profile_photos>
    update_username <update_username>
    update_profile <update_profile>
    block_user <block_user>
    unblock_user <unblock_user>

.. toctree::
    :hidden:

    get_me <get_me>
    get_users <get_users>
    get_profile_photos <get_profile_photos>
    get_profile_photos_count <get_profile_photos_count>
    iter_profile_photos <iter_profile_photos>
    set_profile_photo <set_profile_photo>
    delete_profile_photos <delete_profile_photos>
    update_username <update_username>
    update_profile <update_profile>
    block_user <block_user>
    unblock_user <unblock_user>

Contacts
--------

.. autosummary::
    :nosignatures:

    add_contacts <add_contacts>
    get_contacts <get_contacts>
    get_contacts_count <get_contacts_count>
    delete_contacts <delete_contacts>

.. toctree::
    :hidden:

    add_contacts <add_contacts>
    get_contacts <get_contacts>
    get_contacts_count <get_contacts_count>
    delete_contacts <delete_contacts>

Password
--------

.. autosummary::
    :nosignatures:

    enable_cloud_password <enable_cloud_password>
    change_cloud_password <change_cloud_password>
    remove_cloud_password <remove_cloud_password>

.. toctree::
    :hidden:

    enable_cloud_password <enable_cloud_password>
    change_cloud_password <change_cloud_password>
    remove_cloud_password <remove_cloud_password>

Bots
----

.. autosummary::
    :nosignatures:

    get_inline_bot_results <get_inline_bot_results>
    send_inline_bot_result <send_inline_bot_result>
    answer_callback_query <answer_callback_query>
    answer_inline_query <answer_inline_query>
    request_callback_answer <request_callback_answer>
    send_game <send_game>
    set_game_score <set_game_score>
    get_game_high_scores <get_game_high_scores>

.. toctree::
    :hidden:

    get_inline_bot_results <get_inline_bot_results>
    send_inline_bot_result <send_inline_bot_result>
    answer_callback_query <answer_callback_query>
    answer_inline_query <answer_inline_query>
    request_callback_answer <request_callback_answer>
    send_game <send_game>
    set_game_score <set_game_score>
    get_game_high_scores <get_game_high_scores>

Authorization
-------------

.. autosummary::
    :nosignatures:

    connect <connect>
    disconnect <disconnect>
    initialize <initialize>
    terminate <terminate>
    send_code <send_code>
    resend_code <resend_code>
    sign_in <sign_in>
    sign_in_bot <sign_in_bot>
    sign_up <sign_up>
    get_password_hint <get_password_hint>
    check_password <check_password>
    send_recovery_code <send_recovery_code>
    recover_password <recover_password>
    accept_terms_of_service <accept_terms_of_service>
    log_out <log_out>

.. toctree::
    :hidden:

    connect <connect>
    disconnect <disconnect>
    initialize <initialize>
    terminate <terminate>
    send_code <send_code>
    resend_code <resend_code>
    sign_in <sign_in>
    sign_in_bot <sign_in_bot>
    sign_up <sign_up>
    get_password_hint <get_password_hint>
    check_password <check_password>
    send_recovery_code <send_recovery_code>
    recover_password <recover_password>
    accept_terms_of_service <accept_terms_of_service>
    log_out <log_out>

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:

    send <send>
    resolve_peer <resolve_peer>
    save_file <save_file>

.. toctree::
    :hidden:

    send <send>
    resolve_peer <resolve_peer>
    save_file <save_file>