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

117 lines
3.9 KiB
Python
Raw Normal View History

2020-03-21 14:43:32 +00:00
# Pyrogram - Telegram MTProto API Client Library for Python
# Copyright (C) 2017-2020 Dan <https://github.com/delivrance>
2019-09-07 15:08:30 +00:00
#
2020-03-21 14:43:32 +00:00
# This file is part of Pyrogram.
2019-09-07 15:08:30 +00:00
#
2020-03-21 14:43:32 +00:00
# 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.
2019-09-07 15:08:30 +00:00
#
2020-03-21 14:43:32 +00:00
# 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.
2019-09-07 15:08:30 +00:00
#
2020-03-21 14:43:32 +00:00
# You should have received a copy of the GNU Lesser General Public License
# along with Pyrogram. If not, see <http://www.gnu.org/licenses/>.
2019-09-07 15:08:30 +00:00
from typing import Union
from pyrogram.api import functions, types
from ...ext import BaseClient
class SetAdministratorTitle(BaseClient):
def set_administrator_title(
2019-09-07 15:08:30 +00:00
self,
chat_id: Union[int, str],
user_id: Union[int, str],
title: str,
) -> bool:
"""Set a custom title (rank) to an administrator of a supergroup.
If you are an administrator of a supergroup (i.e. not the owner), you can only set the title of other
administrators who have been promoted by you. If you are the owner, you can change every administrator's title.
2019-09-07 15:08:30 +00:00
Parameters:
chat_id (``int`` | ``str``):
Unique identifier (int) or username (str) of the target chat.
user_id (``int`` | ``str``):
Unique identifier (int) or username (str) of the target user.
For a contact that exists in your Telegram address book you can use his phone number (str).
title (``str``, *optional*):
A custom title that will be shown to all members instead of "Owner" or "Admin".
Pass None or "" (empty string) to remove the custom title.
Returns:
``bool``: True on success.
Example:
.. code-block:: python
app.set_administrator_title(chat_id, user_id, "ฅ^•ﻌ•^ฅ")
2019-09-07 15:08:30 +00:00
"""
chat_id = self.resolve_peer(chat_id)
user_id = self.resolve_peer(user_id)
r = self.send(
functions.channels.GetParticipant(
channel=chat_id,
user_id=user_id
)
).participant
if isinstance(r, types.ChannelParticipantCreator):
admin_rights = types.ChatAdminRights(
change_info=True,
post_messages=True,
edit_messages=True,
delete_messages=True,
ban_users=True,
invite_users=True,
pin_messages=True,
add_admins=True,
)
elif isinstance(r, types.ChannelParticipantAdmin):
admin_rights = r.admin_rights
else:
raise ValueError("Custom titles can only be applied to owners or administrators of supergroups")
if not admin_rights.change_info:
admin_rights.change_info = None
if not admin_rights.post_messages:
admin_rights.post_messages = None
if not admin_rights.edit_messages:
admin_rights.edit_messages = None
if not admin_rights.delete_messages:
admin_rights.delete_messages = None
if not admin_rights.ban_users:
admin_rights.ban_users = None
if not admin_rights.invite_users:
admin_rights.invite_users = None
if not admin_rights.pin_messages:
admin_rights.pin_messages = None
if not admin_rights.add_admins:
admin_rights.add_admins = None
2019-09-07 15:08:30 +00:00
self.send(
functions.channels.EditAdmin(
channel=chat_id,
user_id=user_id,
admin_rights=admin_rights,
rank=title
)
)
return True