# Pyrogram - Telegram MTProto API Client Library for Python # Copyright (C) 2017-2021 Dan # # This file is part of Pyrogram. # # Pyrogram 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. # # Pyrogram 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 Pyrogram. If not, see . from typing import Union, Optional from pyrogram import raw from pyrogram.scaffold import Scaffold class UpdateChatUsername(Scaffold): async def update_chat_username( self, chat_id: Union[int, str], username: Optional[str] ) -> bool: """Update a channel or a supergroup username. To update your own username (for users only, not bots) you can use :meth:`~pyrogram.Client.update_username`. 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 app.update_chat_username(chat_id, "new_username") """ peer = await self.resolve_peer(chat_id) if isinstance(peer, raw.types.InputPeerChannel): return bool( await self.send( raw.functions.channels.UpdateUsername( channel=peer, username=username or "" ) ) ) else: raise ValueError(f'The chat_id "{chat_id}" belongs to a user or chat')