mirror of
https://github.com/aiogram/aiogram.git
synced 2025-12-12 02:03:04 +00:00
Bot API 6.3 (#1063)
* Added API changes * Added changelog * Oops. Move changelog * Update tests * Remove experimental * Added message content type * Update message aliases * Update changes * Update texts * Bump version * Remove versionadded badge
This commit is contained in:
parent
3ae5d904c9
commit
b287551590
275 changed files with 5821 additions and 1133 deletions
44
docs/api/methods/close_forum_topic.rst
Normal file
44
docs/api/methods/close_forum_topic.rst
Normal file
|
|
@ -0,0 +1,44 @@
|
|||
###############
|
||||
closeForumTopic
|
||||
###############
|
||||
|
||||
Returns: :obj:`bool`
|
||||
|
||||
.. automodule:: aiogram.methods.close_forum_topic
|
||||
:members:
|
||||
:member-order: bysource
|
||||
:undoc-members: True
|
||||
|
||||
|
||||
Usage
|
||||
=====
|
||||
|
||||
As bot method
|
||||
-------------
|
||||
|
||||
.. code-block::
|
||||
|
||||
result: bool = await bot.close_forum_topic(...)
|
||||
|
||||
|
||||
Method as object
|
||||
----------------
|
||||
|
||||
Imports:
|
||||
|
||||
- :code:`from aiogram.methods.close_forum_topic import CloseForumTopic`
|
||||
- alias: :code:`from aiogram.methods import CloseForumTopic`
|
||||
|
||||
With specific bot
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
result: bool = await bot(CloseForumTopic(...))
|
||||
|
||||
As reply into Webhook in handler
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
return CloseForumTopic(...)
|
||||
44
docs/api/methods/create_forum_topic.rst
Normal file
44
docs/api/methods/create_forum_topic.rst
Normal file
|
|
@ -0,0 +1,44 @@
|
|||
################
|
||||
createForumTopic
|
||||
################
|
||||
|
||||
Returns: :obj:`ForumTopic`
|
||||
|
||||
.. automodule:: aiogram.methods.create_forum_topic
|
||||
:members:
|
||||
:member-order: bysource
|
||||
:undoc-members: True
|
||||
|
||||
|
||||
Usage
|
||||
=====
|
||||
|
||||
As bot method
|
||||
-------------
|
||||
|
||||
.. code-block::
|
||||
|
||||
result: ForumTopic = await bot.create_forum_topic(...)
|
||||
|
||||
|
||||
Method as object
|
||||
----------------
|
||||
|
||||
Imports:
|
||||
|
||||
- :code:`from aiogram.methods.create_forum_topic import CreateForumTopic`
|
||||
- alias: :code:`from aiogram.methods import CreateForumTopic`
|
||||
|
||||
With specific bot
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
result: ForumTopic = await bot(CreateForumTopic(...))
|
||||
|
||||
As reply into Webhook in handler
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
return CreateForumTopic(...)
|
||||
44
docs/api/methods/delete_forum_topic.rst
Normal file
44
docs/api/methods/delete_forum_topic.rst
Normal file
|
|
@ -0,0 +1,44 @@
|
|||
################
|
||||
deleteForumTopic
|
||||
################
|
||||
|
||||
Returns: :obj:`bool`
|
||||
|
||||
.. automodule:: aiogram.methods.delete_forum_topic
|
||||
:members:
|
||||
:member-order: bysource
|
||||
:undoc-members: True
|
||||
|
||||
|
||||
Usage
|
||||
=====
|
||||
|
||||
As bot method
|
||||
-------------
|
||||
|
||||
.. code-block::
|
||||
|
||||
result: bool = await bot.delete_forum_topic(...)
|
||||
|
||||
|
||||
Method as object
|
||||
----------------
|
||||
|
||||
Imports:
|
||||
|
||||
- :code:`from aiogram.methods.delete_forum_topic import DeleteForumTopic`
|
||||
- alias: :code:`from aiogram.methods import DeleteForumTopic`
|
||||
|
||||
With specific bot
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
result: bool = await bot(DeleteForumTopic(...))
|
||||
|
||||
As reply into Webhook in handler
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
return DeleteForumTopic(...)
|
||||
44
docs/api/methods/edit_forum_topic.rst
Normal file
44
docs/api/methods/edit_forum_topic.rst
Normal file
|
|
@ -0,0 +1,44 @@
|
|||
##############
|
||||
editForumTopic
|
||||
##############
|
||||
|
||||
Returns: :obj:`bool`
|
||||
|
||||
.. automodule:: aiogram.methods.edit_forum_topic
|
||||
:members:
|
||||
:member-order: bysource
|
||||
:undoc-members: True
|
||||
|
||||
|
||||
Usage
|
||||
=====
|
||||
|
||||
As bot method
|
||||
-------------
|
||||
|
||||
.. code-block::
|
||||
|
||||
result: bool = await bot.edit_forum_topic(...)
|
||||
|
||||
|
||||
Method as object
|
||||
----------------
|
||||
|
||||
Imports:
|
||||
|
||||
- :code:`from aiogram.methods.edit_forum_topic import EditForumTopic`
|
||||
- alias: :code:`from aiogram.methods import EditForumTopic`
|
||||
|
||||
With specific bot
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
result: bool = await bot(EditForumTopic(...))
|
||||
|
||||
As reply into Webhook in handler
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
return EditForumTopic(...)
|
||||
|
|
@ -21,14 +21,6 @@ As bot method
|
|||
result: Union[Message, bool] = await bot.edit_message_live_location(...)
|
||||
|
||||
|
||||
As message method
|
||||
-----------------
|
||||
|
||||
.. code-block::
|
||||
|
||||
result: Union[Message, bool] = await message.edit_live_location(...)
|
||||
|
||||
|
||||
Method as object
|
||||
----------------
|
||||
|
||||
|
|
|
|||
|
|
@ -21,14 +21,6 @@ As bot method
|
|||
result: Union[Message, bool] = await bot.edit_message_media(...)
|
||||
|
||||
|
||||
As message method
|
||||
-----------------
|
||||
|
||||
.. code-block::
|
||||
|
||||
result: Union[Message, bool] = await message.edit_media(...)
|
||||
|
||||
|
||||
Method as object
|
||||
----------------
|
||||
|
||||
|
|
|
|||
|
|
@ -21,14 +21,6 @@ As bot method
|
|||
result: Message = await bot.forward_message(...)
|
||||
|
||||
|
||||
As message method
|
||||
-------------
|
||||
|
||||
.. code-block::
|
||||
|
||||
result: Message = await message.forward(...)
|
||||
|
||||
|
||||
Method as object
|
||||
----------------
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
getChatMenuButton
|
||||
#################
|
||||
|
||||
Returns: :obj:`MenuButton`
|
||||
Returns: :obj:`Union[MenuButtonDefault, MenuButtonWebApp, MenuButtonCommands]`
|
||||
|
||||
.. automodule:: aiogram.methods.get_chat_menu_button
|
||||
:members:
|
||||
|
|
@ -18,7 +18,7 @@ As bot method
|
|||
|
||||
.. code-block::
|
||||
|
||||
result: MenuButton = await bot.get_chat_menu_button(...)
|
||||
result: Union[MenuButtonDefault, MenuButtonWebApp, MenuButtonCommands] = await bot.get_chat_menu_button(...)
|
||||
|
||||
|
||||
Method as object
|
||||
|
|
@ -34,4 +34,4 @@ With specific bot
|
|||
|
||||
.. code-block:: python
|
||||
|
||||
result: MenuButton = await bot(GetChatMenuButton(...))
|
||||
result: Union[MenuButtonDefault, MenuButtonWebApp, MenuButtonCommands] = await bot(GetChatMenuButton(...))
|
||||
|
|
|
|||
37
docs/api/methods/get_forum_topic_icon_stickers.rst
Normal file
37
docs/api/methods/get_forum_topic_icon_stickers.rst
Normal file
|
|
@ -0,0 +1,37 @@
|
|||
#########################
|
||||
getForumTopicIconStickers
|
||||
#########################
|
||||
|
||||
Returns: :obj:`List[Sticker]`
|
||||
|
||||
.. automodule:: aiogram.methods.get_forum_topic_icon_stickers
|
||||
:members:
|
||||
:member-order: bysource
|
||||
:undoc-members: True
|
||||
|
||||
|
||||
Usage
|
||||
=====
|
||||
|
||||
As bot method
|
||||
-------------
|
||||
|
||||
.. code-block::
|
||||
|
||||
result: List[Sticker] = await bot.get_forum_topic_icon_stickers(...)
|
||||
|
||||
|
||||
Method as object
|
||||
----------------
|
||||
|
||||
Imports:
|
||||
|
||||
- :code:`from aiogram.methods.get_forum_topic_icon_stickers import GetForumTopicIconStickers`
|
||||
- alias: :code:`from aiogram.methods import GetForumTopicIconStickers`
|
||||
|
||||
With specific bot
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
result: List[Sticker] = await bot(GetForumTopicIconStickers(...))
|
||||
|
|
@ -78,6 +78,13 @@ Available methods
|
|||
get_chat_member
|
||||
set_chat_sticker_set
|
||||
delete_chat_sticker_set
|
||||
get_forum_topic_icon_stickers
|
||||
create_forum_topic
|
||||
edit_forum_topic
|
||||
close_forum_topic
|
||||
reopen_forum_topic
|
||||
delete_forum_topic
|
||||
unpin_all_forum_topic_messages
|
||||
answer_callback_query
|
||||
set_my_commands
|
||||
delete_my_commands
|
||||
|
|
|
|||
|
|
@ -21,14 +21,6 @@ As bot method
|
|||
result: bool = await bot.pin_chat_message(...)
|
||||
|
||||
|
||||
As message method
|
||||
-----------------
|
||||
|
||||
.. code-block::
|
||||
|
||||
result: bool = await message.pin(...)
|
||||
|
||||
|
||||
Method as object
|
||||
----------------
|
||||
|
||||
|
|
|
|||
44
docs/api/methods/reopen_forum_topic.rst
Normal file
44
docs/api/methods/reopen_forum_topic.rst
Normal file
|
|
@ -0,0 +1,44 @@
|
|||
################
|
||||
reopenForumTopic
|
||||
################
|
||||
|
||||
Returns: :obj:`bool`
|
||||
|
||||
.. automodule:: aiogram.methods.reopen_forum_topic
|
||||
:members:
|
||||
:member-order: bysource
|
||||
:undoc-members: True
|
||||
|
||||
|
||||
Usage
|
||||
=====
|
||||
|
||||
As bot method
|
||||
-------------
|
||||
|
||||
.. code-block::
|
||||
|
||||
result: bool = await bot.reopen_forum_topic(...)
|
||||
|
||||
|
||||
Method as object
|
||||
----------------
|
||||
|
||||
Imports:
|
||||
|
||||
- :code:`from aiogram.methods.reopen_forum_topic import ReopenForumTopic`
|
||||
- alias: :code:`from aiogram.methods import ReopenForumTopic`
|
||||
|
||||
With specific bot
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
result: bool = await bot(ReopenForumTopic(...))
|
||||
|
||||
As reply into Webhook in handler
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
return ReopenForumTopic(...)
|
||||
|
|
@ -21,14 +21,6 @@ As bot method
|
|||
result: Union[Message, bool] = await bot.stop_message_live_location(...)
|
||||
|
||||
|
||||
As message method
|
||||
-----------------
|
||||
|
||||
.. code-block::
|
||||
|
||||
result: Union[Message, bool] = await message.stop_live_location(...)
|
||||
|
||||
|
||||
Method as object
|
||||
----------------
|
||||
|
||||
|
|
|
|||
44
docs/api/methods/unpin_all_forum_topic_messages.rst
Normal file
44
docs/api/methods/unpin_all_forum_topic_messages.rst
Normal file
|
|
@ -0,0 +1,44 @@
|
|||
##########################
|
||||
unpinAllForumTopicMessages
|
||||
##########################
|
||||
|
||||
Returns: :obj:`bool`
|
||||
|
||||
.. automodule:: aiogram.methods.unpin_all_forum_topic_messages
|
||||
:members:
|
||||
:member-order: bysource
|
||||
:undoc-members: True
|
||||
|
||||
|
||||
Usage
|
||||
=====
|
||||
|
||||
As bot method
|
||||
-------------
|
||||
|
||||
.. code-block::
|
||||
|
||||
result: bool = await bot.unpin_all_forum_topic_messages(...)
|
||||
|
||||
|
||||
Method as object
|
||||
----------------
|
||||
|
||||
Imports:
|
||||
|
||||
- :code:`from aiogram.methods.unpin_all_forum_topic_messages import UnpinAllForumTopicMessages`
|
||||
- alias: :code:`from aiogram.methods import UnpinAllForumTopicMessages`
|
||||
|
||||
With specific bot
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
result: bool = await bot(UnpinAllForumTopicMessages(...))
|
||||
|
||||
As reply into Webhook in handler
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
return UnpinAllForumTopicMessages(...)
|
||||
|
|
@ -21,14 +21,6 @@ As bot method
|
|||
result: bool = await bot.unpin_chat_message(...)
|
||||
|
||||
|
||||
As message method
|
||||
-----------------
|
||||
|
||||
.. code-block::
|
||||
|
||||
result: bool = await message.unpin()
|
||||
|
||||
|
||||
Method as object
|
||||
----------------
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue