mirror of
https://github.com/aiogram/aiogram.git
synced 2026-04-08 16:37:47 +00:00
Render docs
This commit is contained in:
parent
c556290e3e
commit
964418f4f0
60 changed files with 385 additions and 1 deletions
|
|
@ -1 +1 @@
|
|||
Add missing shortcuts, added new enums, reworked old stuff
|
||||
Added missing shortcuts, new enums, reworked old stuff
|
||||
|
|
|
|||
|
|
@ -42,3 +42,9 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return AnswerCallbackQuery(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.callback_query.CallbackQuery.answer`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,9 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return AnswerInlineQuery(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.inline_query.InlineQuery.answer`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,9 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return ApproveChatJoinRequest(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.chat_join_request.ChatJoinRequest.approve`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,9 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return BanChatMember(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.ban`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,9 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return BanChatSenderChat(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.ban_sender_chat`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,9 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return CopyMessage(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.copy_to`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,9 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return CreateChatInviteLink(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.create_invite_link`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,9 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return DeclineChatJoinRequest(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.chat_join_request.ChatJoinRequest.decline`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,9 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return DeleteChatPhoto(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.delete_photo`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,9 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return DeleteChatStickerSet(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.delete_sticker_set`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,10 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return DeleteMessage(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.delete`
|
||||
- :meth:`aiogram.types.chat.Chat.delete_message`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,9 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return DeleteStickerFromSet(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.sticker.Sticker.delete_from_set`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,9 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return EditChatInviteLink(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.edit_invite_link`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,9 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return EditMessageCaption(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.edit_caption`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,9 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return EditMessageLiveLocation(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.edit_live_location`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,9 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return EditMessageMedia(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.edit_media`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,9 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return EditMessageReplyMarkup(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.edit_reply_markup`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,9 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return EditMessageText(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.edit_text`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,9 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return ExportChatInviteLink(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.export_invite_link`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,9 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return ForwardMessage(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.forward`
|
||||
|
|
|
|||
|
|
@ -35,3 +35,11 @@ With specific bot
|
|||
.. code-block:: python
|
||||
|
||||
result: List[Union[ChatMemberOwner, ChatMemberAdministrator, ChatMemberMember, ChatMemberRestricted, ChatMemberLeft, ChatMemberBanned]] = await bot(GetChatAdministrators(...))
|
||||
|
||||
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.get_administrators`
|
||||
|
|
|
|||
|
|
@ -35,3 +35,11 @@ With specific bot
|
|||
.. code-block:: python
|
||||
|
||||
result: Union[ChatMemberOwner, ChatMemberAdministrator, ChatMemberMember, ChatMemberRestricted, ChatMemberLeft, ChatMemberBanned] = await bot(GetChatMember(...))
|
||||
|
||||
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.get_member`
|
||||
|
|
|
|||
|
|
@ -35,3 +35,11 @@ With specific bot
|
|||
.. code-block:: python
|
||||
|
||||
result: int = await bot(GetChatMemberCount(...))
|
||||
|
||||
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.get_member_count`
|
||||
|
|
|
|||
|
|
@ -35,3 +35,11 @@ With specific bot
|
|||
.. code-block:: python
|
||||
|
||||
result: UserProfilePhotos = await bot(GetUserProfilePhotos(...))
|
||||
|
||||
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.user.User.get_profile_photos`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,9 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return LeaveChat(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.leave`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,10 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return PinChatMessage(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.pin`
|
||||
- :meth:`aiogram.types.chat.Chat.pin_message`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,9 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return PromoteChatMember(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.promote`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,9 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return RestrictChatMember(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.restrict`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,9 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return RevokeChatInviteLink(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.revoke_invite_link`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,10 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return SendAnimation(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.answer_animation`
|
||||
- :meth:`aiogram.types.message.Message.reply_animation`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,10 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return SendAudio(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.answer_audio`
|
||||
- :meth:`aiogram.types.message.Message.reply_audio`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,9 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return SendChatAction(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.do`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,10 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return SendContact(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.answer_contact`
|
||||
- :meth:`aiogram.types.message.Message.reply_contact`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,10 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return SendDice(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.answer_dice`
|
||||
- :meth:`aiogram.types.message.Message.reply_dice`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,10 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return SendDocument(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.answer_document`
|
||||
- :meth:`aiogram.types.message.Message.reply_document`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,10 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return SendGame(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.answer_game`
|
||||
- :meth:`aiogram.types.message.Message.reply_game`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,10 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return SendInvoice(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.answer_invoice`
|
||||
- :meth:`aiogram.types.message.Message.reply_invoice`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,10 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return SendLocation(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.answer_location`
|
||||
- :meth:`aiogram.types.message.Message.reply_location`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,10 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return SendMediaGroup(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.answer_media_group`
|
||||
- :meth:`aiogram.types.message.Message.reply_media_group`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,10 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return SendMessage(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.answer`
|
||||
- :meth:`aiogram.types.message.Message.reply`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,10 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return SendPhoto(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.answer_photo`
|
||||
- :meth:`aiogram.types.message.Message.reply_photo`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,10 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return SendPoll(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.answer_poll`
|
||||
- :meth:`aiogram.types.message.Message.reply_poll`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,10 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return SendSticker(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.answer_sticker`
|
||||
- :meth:`aiogram.types.message.Message.reply_sticker`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,10 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return SendVenue(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.answer_venue`
|
||||
- :meth:`aiogram.types.message.Message.reply_venue`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,10 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return SendVideo(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.answer_video`
|
||||
- :meth:`aiogram.types.message.Message.reply_video`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,10 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return SendVideoNote(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.answer_video_note`
|
||||
- :meth:`aiogram.types.message.Message.reply_video_note`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,10 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return SendVoice(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.answer_voice`
|
||||
- :meth:`aiogram.types.message.Message.reply_voice`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,9 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return SetChatAdministratorCustomTitle(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.set_administrator_custom_title`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,9 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return SetChatDescription(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.set_description`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,9 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return SetChatPermissions(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.set_permissions`
|
||||
|
|
|
|||
|
|
@ -35,3 +35,11 @@ With specific bot
|
|||
.. code-block:: python
|
||||
|
||||
result: bool = await bot(SetChatPhoto(...))
|
||||
|
||||
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.set_photo`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,9 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return SetChatStickerSet(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.set_sticker_set`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,9 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return SetChatTitle(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.set_title`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,9 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return SetStickerPositionInSet(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.sticker.Sticker.set_position_in_set`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,9 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return StopMessageLiveLocation(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.stop_live_location`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,9 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return UnbanChatMember(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.unban`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,9 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return UnbanChatSenderChat(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.unban_sender_chat`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,9 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return UnpinAllChatMessages(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.chat.Chat.unpin_all_messages`
|
||||
|
|
|
|||
|
|
@ -42,3 +42,10 @@ As reply into Webhook in handler
|
|||
.. code-block:: python
|
||||
|
||||
return UnpinChatMessage(...)
|
||||
|
||||
|
||||
As shortcut from received object
|
||||
-------------------
|
||||
|
||||
- :meth:`aiogram.types.message.Message.unpin`
|
||||
- :meth:`aiogram.types.chat.Chat.unpin_message`
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue