MTPyroger/pyrogram/client/methods/chats/set_chat_title.py

73 lines
2.4 KiB
Python
Raw Normal View History

2018-07-08 08:24:39 +00:00
# Pyrogram - Telegram MTProto API Client Library for Python
2019-01-01 11:36:16 +00:00
# Copyright (C) 2017-2019 Dan Tès <https://github.com/delivrance>
2018-07-08 08:24:39 +00:00
#
# 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 <http://www.gnu.org/licenses/>.
from typing import Union
2018-07-08 08:24:39 +00:00
from pyrogram.api import functions, types
from ...ext import BaseClient
class SetChatTitle(BaseClient):
2019-03-16 18:23:23 +00:00
def set_chat_title(
self,
chat_id: Union[int, str],
title: str
) -> bool:
2018-07-15 14:34:47 +00:00
"""Use this method to 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:
2018-07-15 14:34:47 +00:00
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.
2018-07-15 14:34:47 +00:00
Raises:
RPCError: In case of a Telegram RPC error.
ValueError: In case a chat id belongs to user.
2018-07-15 14:34:47 +00:00
"""
2018-07-08 08:24:39 +00:00
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