-
-
Notifications
You must be signed in to change notification settings - Fork 48
Expand file tree
/
Copy pathset_chat_description.py
More file actions
60 lines (47 loc) · 2.16 KB
/
set_chat_description.py
File metadata and controls
60 lines (47 loc) · 2.16 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
# Hydrogram - Telegram MTProto API Client Library for Python
# Copyright (C) 2017-2023 Dan <https://github.com/delivrance>
# Copyright (C) 2023-present Hydrogram <https://hydrogram.org>
#
# This file is part of Hydrogram.
#
# Hydrogram is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Hydrogram is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with Hydrogram. If not, see <http://www.gnu.org/licenses/>.
from __future__ import annotations
import hydrogram
from hydrogram import raw
class SetChatDescription:
async def set_chat_description(
self: hydrogram.Client, chat_id: int | str, description: str
) -> bool:
"""Change the description of a supergroup or a channel.
You must be an administrator in the chat for this to work and must have the appropriate admin rights.
.. include:: /_includes/usable-by/users-bots.rst
Parameters:
chat_id (``int`` | ``str``):
Unique identifier (int) or username (str) of the target chat.
description (``str``):
New chat description, 0-255 characters.
Returns:
``bool``: True on success.
Raises:
ValueError: if a chat_id doesn't belong to a supergroup or a channel.
Example:
.. code-block:: python
await app.set_chat_description(chat_id, "New Description")
"""
peer = await self.resolve_peer(chat_id)
if isinstance(peer, (raw.types.InputPeerChannel, raw.types.InputPeerChat)):
await self.invoke(raw.functions.messages.EditChatAbout(peer=peer, about=description))
else:
raise ValueError(f'The chat_id "{chat_id}" belongs to a user')
return True