aiogram/docs2/source/api/methods/index.rst
2020-06-15 02:22:24 +03:00

138 lines
2.4 KiB
ReStructuredText

#######
Methods
#######
All API methods is wrapped as `pydantic <https://pydantic-docs.helpmanual.io/>`_ models
and placed in :mod:`aiogram.api.methods` package so that's mean all values which you pass
as arguments to the methods will be validated.
Here is all methods is classes and in due to Python standards all classes named in
upper camel case, for example methods :code:`sendMessage` has the name :code:`SendMessage`
Getting updates
===============
.. toctree::
:maxdepth: 1
get_updates
set_webhook
delete_webhook
get_webhook_info
Available methods
=================
.. toctree::
:maxdepth: 1
get_me
send_message
forward_message
send_photo
send_audio
send_document
send_video
send_animation
send_voice
send_video_note
send_media_group
send_location
edit_message_live_location
stop_message_live_location
send_venue
send_contact
send_poll
send_dice
send_chat_action
get_user_profile_photos
get_file
kick_chat_member
unban_chat_member
restrict_chat_member
promote_chat_member
set_chat_administrator_custom_title
set_chat_permissions
export_chat_invite_link
set_chat_photo
delete_chat_photo
set_chat_title
set_chat_description
pin_chat_message
unpin_chat_message
leave_chat
get_chat
get_chat_administrators
get_chat_members_count
get_chat_member
set_chat_sticker_set
delete_chat_sticker_set
answer_callback_query
set_my_commands
get_my_commands
Updating messages
=================
.. toctree::
:maxdepth: 1
edit_message_text
edit_message_caption
edit_message_media
edit_message_reply_markup
stop_poll
delete_message
Stickers
========
.. toctree::
:maxdepth: 1
send_sticker
get_sticker_set
upload_sticker_file
create_new_sticker_set
add_sticker_to_set
set_sticker_position_in_set
delete_sticker_from_set
set_sticker_set_thumb
Inline mode
===========
.. toctree::
:maxdepth: 1
answer_inline_query
Payments
========
.. toctree::
:maxdepth: 1
send_invoice
answer_shipping_query
answer_pre_checkout_query
Telegram Passport
=================
.. toctree::
:maxdepth: 1
set_passport_data_errors
Games
=====
.. toctree::
:maxdepth: 1
send_game
set_game_score
get_game_high_scores