# 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 SetChatUsername:

async def set_chat_username(

self: hydrogram.Client, chat_id: int | str, username: str | None

) -> bool:

"""Set a channel or a supergroup username.

To set your own username (for users only, not bots) you can use :meth:`~hydrogram.Client.set_username`.

.. include:: /_includes/usable-by/users.rst

Parameters:

chat_id (``int`` | ``str``)

Unique identifier (int) or username (str) of the target chat.

username (``str`` | ``None``):

Username to set. Pass "" (empty string) or None to remove the username.

Returns:

``bool``: True on success.

Raises:

ValueError: In case a chat id belongs to a user or chat.

Example:

.. code-block:: python

await app.set_chat_username(chat_id, "new_username")

"""

peer = await self.resolve_peer(chat_id)

if isinstance(peer, raw.types.InputPeerChannel):

return bool(

await self.invoke(

raw.functions.channels.UpdateUsername(channel=peer, username=username or "")

)

)

raise ValueError(f'The chat_id "{chat_id}" belongs to a user or chat')