mirror of
https://github.com/aiogram/aiogram.git
synced 2026-04-08 16:37:47 +00:00
Update docs
This commit is contained in:
parent
3d38577bb0
commit
e84b8b92e6
70 changed files with 203 additions and 264 deletions
|
|
@ -15,3 +15,4 @@ For example :code:`sendMessage` named :code:`send_message` and has the same spec
|
|||
:member-order: bysource
|
||||
:special-members: __init__
|
||||
:undoc-members: True
|
||||
:noindex:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
#####
|
||||
Types
|
||||
Enums
|
||||
#####
|
||||
|
||||
Here is list of all available enums:
|
||||
|
|
|
|||
|
|
@ -45,6 +45,6 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.callback_query.CallbackQuery.answer`
|
||||
|
|
|
|||
|
|
@ -45,6 +45,6 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.inline_query.InlineQuery.answer`
|
||||
|
|
|
|||
|
|
@ -45,6 +45,6 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.chat_join_request.ChatJoinRequest.approve`
|
||||
|
|
|
|||
|
|
@ -45,6 +45,6 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.ban`
|
||||
|
|
|
|||
|
|
@ -45,6 +45,6 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.ban_sender_chat`
|
||||
|
|
|
|||
|
|
@ -45,6 +45,6 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.copy_to`
|
||||
|
|
|
|||
|
|
@ -45,6 +45,6 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.create_invite_link`
|
||||
|
|
|
|||
|
|
@ -45,6 +45,6 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.chat_join_request.ChatJoinRequest.decline`
|
||||
|
|
|
|||
|
|
@ -45,6 +45,6 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.delete_photo`
|
||||
|
|
|
|||
|
|
@ -45,6 +45,6 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.delete_sticker_set`
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.delete`
|
||||
- :meth:`aiogram.types.chat.Chat.delete_message`
|
||||
|
|
|
|||
|
|
@ -45,6 +45,6 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.sticker.Sticker.delete_from_set`
|
||||
|
|
|
|||
|
|
@ -45,6 +45,6 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.edit_invite_link`
|
||||
|
|
|
|||
|
|
@ -45,6 +45,6 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.edit_caption`
|
||||
|
|
|
|||
|
|
@ -45,6 +45,6 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.edit_live_location`
|
||||
|
|
|
|||
|
|
@ -45,6 +45,6 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.edit_media`
|
||||
|
|
|
|||
|
|
@ -45,6 +45,6 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.edit_reply_markup`
|
||||
|
|
|
|||
|
|
@ -45,6 +45,6 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.edit_text`
|
||||
|
|
|
|||
|
|
@ -45,6 +45,6 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.export_invite_link`
|
||||
|
|
|
|||
|
|
@ -45,6 +45,6 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.forward`
|
||||
|
|
|
|||
|
|
@ -40,6 +40,6 @@ With specific bot
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.get_administrators`
|
||||
|
|
|
|||
|
|
@ -40,6 +40,6 @@ With specific bot
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.get_member`
|
||||
|
|
|
|||
|
|
@ -40,6 +40,6 @@ With specific bot
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.get_member_count`
|
||||
|
|
|
|||
|
|
@ -1,37 +0,0 @@
|
|||
###################
|
||||
getChatMembersCount
|
||||
###################
|
||||
|
||||
Returns: :obj:`int`
|
||||
|
||||
.. automodule:: aiogram.methods.get_chat_members_count
|
||||
:members:
|
||||
:member-order: bysource
|
||||
:undoc-members: True
|
||||
|
||||
|
||||
Usage
|
||||
=====
|
||||
|
||||
As bot method
|
||||
-------------
|
||||
|
||||
.. code-block::
|
||||
|
||||
result: int = await bot.get_chat_members_count(...)
|
||||
|
||||
|
||||
Method as object
|
||||
----------------
|
||||
|
||||
Imports:
|
||||
|
||||
- :code:`from aiogram.methods.get_chat_members_count import GetChatMembersCount`
|
||||
- alias: :code:`from aiogram.methods import GetChatMembersCount`
|
||||
|
||||
With specific bot
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
result: int = await bot(GetChatMembersCount(...))
|
||||
|
|
@ -40,6 +40,6 @@ With specific bot
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.user.User.get_profile_photos`
|
||||
|
|
|
|||
|
|
@ -1,44 +0,0 @@
|
|||
##############
|
||||
kickChatMember
|
||||
##############
|
||||
|
||||
Returns: :obj:`bool`
|
||||
|
||||
.. automodule:: aiogram.methods.kick_chat_member
|
||||
:members:
|
||||
:member-order: bysource
|
||||
:undoc-members: True
|
||||
|
||||
|
||||
Usage
|
||||
=====
|
||||
|
||||
As bot method
|
||||
-------------
|
||||
|
||||
.. code-block::
|
||||
|
||||
result: bool = await bot.kick_chat_member(...)
|
||||
|
||||
|
||||
Method as object
|
||||
----------------
|
||||
|
||||
Imports:
|
||||
|
||||
- :code:`from aiogram.methods.kick_chat_member import KickChatMember`
|
||||
- alias: :code:`from aiogram.methods import KickChatMember`
|
||||
|
||||
With specific bot
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
result: bool = await bot(KickChatMember(...))
|
||||
|
||||
As reply into Webhook in handler
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
return KickChatMember(...)
|
||||
|
|
@ -45,6 +45,6 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.leave`
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.pin`
|
||||
- :meth:`aiogram.types.chat.Chat.pin_message`
|
||||
|
|
|
|||
|
|
@ -45,6 +45,6 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.promote`
|
||||
|
|
|
|||
|
|
@ -45,6 +45,6 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.restrict`
|
||||
|
|
|
|||
|
|
@ -45,6 +45,6 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.revoke_invite_link`
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.answer_animation`
|
||||
- :meth:`aiogram.types.message.Message.reply_animation`
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.answer_audio`
|
||||
- :meth:`aiogram.types.message.Message.reply_audio`
|
||||
|
|
|
|||
|
|
@ -45,6 +45,6 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.do`
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.answer_contact`
|
||||
- :meth:`aiogram.types.message.Message.reply_contact`
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.answer_dice`
|
||||
- :meth:`aiogram.types.message.Message.reply_dice`
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.answer_document`
|
||||
- :meth:`aiogram.types.message.Message.reply_document`
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.answer_game`
|
||||
- :meth:`aiogram.types.message.Message.reply_game`
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.answer_invoice`
|
||||
- :meth:`aiogram.types.message.Message.reply_invoice`
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.answer_location`
|
||||
- :meth:`aiogram.types.message.Message.reply_location`
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.answer_media_group`
|
||||
- :meth:`aiogram.types.message.Message.reply_media_group`
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.answer`
|
||||
- :meth:`aiogram.types.message.Message.reply`
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.answer_photo`
|
||||
- :meth:`aiogram.types.message.Message.reply_photo`
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.answer_poll`
|
||||
- :meth:`aiogram.types.message.Message.reply_poll`
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.answer_sticker`
|
||||
- :meth:`aiogram.types.message.Message.reply_sticker`
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.answer_venue`
|
||||
- :meth:`aiogram.types.message.Message.reply_venue`
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.answer_video`
|
||||
- :meth:`aiogram.types.message.Message.reply_video`
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.answer_video_note`
|
||||
- :meth:`aiogram.types.message.Message.reply_video_note`
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.answer_voice`
|
||||
- :meth:`aiogram.types.message.Message.reply_voice`
|
||||
|
|
|
|||
|
|
@ -45,6 +45,6 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.set_administrator_custom_title`
|
||||
|
|
|
|||
|
|
@ -45,6 +45,6 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.set_description`
|
||||
|
|
|
|||
|
|
@ -45,6 +45,6 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.set_permissions`
|
||||
|
|
|
|||
|
|
@ -40,6 +40,6 @@ With specific bot
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.set_photo`
|
||||
|
|
|
|||
|
|
@ -45,6 +45,6 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.set_sticker_set`
|
||||
|
|
|
|||
|
|
@ -45,6 +45,6 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.set_title`
|
||||
|
|
|
|||
|
|
@ -45,6 +45,6 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.sticker.Sticker.set_position_in_set`
|
||||
|
|
|
|||
|
|
@ -45,6 +45,6 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.stop_live_location`
|
||||
|
|
|
|||
|
|
@ -45,6 +45,6 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.unban`
|
||||
|
|
|
|||
|
|
@ -45,6 +45,6 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.unban_sender_chat`
|
||||
|
|
|
|||
|
|
@ -45,6 +45,6 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.unpin_all_messages`
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ As reply into Webhook in handler
|
|||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
--------------------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.unpin`
|
||||
- :meth:`aiogram.types.chat.Chat.unpin_message`
|
||||
|
|
|
|||
|
|
@ -190,3 +190,11 @@ Games
|
|||
callback_game
|
||||
game
|
||||
game_high_score
|
||||
|
||||
Internals
|
||||
=========
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
error_event
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue