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

52 lines
No EOL
1.1 KiB
ReStructuredText

##################
setChatDescription
##################
Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.
Returns: :obj:`bool`
.. automodule:: aiogram.api.methods.set_chat_description
:members:
Usage
=====
As bot method
-------------
.. code-block::
result: bool = await bot.set_chat_description(...)
Method as object
----------------
Imports:
- :code:`from aiogram.methods import SetChatDescription`
- :code:`from aiogram.api.methods import SetChatDescription`
- :code:`from aiogram.api.methods.set_chat_description import SetChatDescription`
In handlers with current bot
----------------------------
.. code-block::
result: bool = await SetChatDescription(...)
With specific bot
~~~~~~~~~~~~~~~~~
.. code-block::
result: bool = await bot(SetChatDescription(...))
As reply into Webhook in handler
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block::
return SetChatDescription(...)