# Pyrogram - Telegram MTProto API Client Library for Python # Copyright (C) 2017-2020 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 from pyrogram.api import functions, types from ...ext import BaseClient class SetChatTitle(BaseClient): def set_chat_title( self, chat_id: Union[int, str], title: str ) -> bool: """Change the title of a chat. Titles can't be changed for private chats. You must be an administrator in the chat for this to work and must have the appropriate admin rights. Note: In regular groups (non-supergroups), this method will only work if the "All Members Are Admins" setting is off. Parameters: chat_id (``int`` | ``str``): Unique identifier (int) or username (str) of the target chat. title (``str``): New chat title, 1-255 characters. Returns: ``bool``: True on success. Raises: ValueError: In case a chat id belongs to user. Example: .. code-block:: python app.set_chat_title(chat_id, "New Title") """ peer = self.resolve_peer(chat_id) if isinstance(peer, types.InputPeerChat): self.send( functions.messages.EditChatTitle( chat_id=peer.chat_id, title=title ) ) elif isinstance(peer, types.InputPeerChannel): self.send( functions.channels.EditTitle( channel=peer, title=title ) ) else: raise ValueError("The chat_id \"{}\" belongs to a user".format(chat_id)) return True