|
| 1 | +# Pyrogram - Telegram MTProto API Client Library for Python |
| 2 | +# Copyright (C) 2017-present Dan <https://github.com/delivrance> |
| 3 | +# |
| 4 | +# This file is part of Pyrogram. |
| 5 | +# |
| 6 | +# Pyrogram is free software: you can redistribute it and/or modify |
| 7 | +# it under the terms of the GNU Lesser General Public License as published |
| 8 | +# by the Free Software Foundation, either version 3 of the License, or |
| 9 | +# (at your option) any later version. |
| 10 | +# |
| 11 | +# Pyrogram is distributed in the hope that it will be useful, |
| 12 | +# but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 | +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 14 | +# GNU Lesser General Public License for more details. |
| 15 | +# |
| 16 | +# You should have received a copy of the GNU Lesser General Public License |
| 17 | +# along with Pyrogram. If not, see <http://www.gnu.org/licenses/>. |
| 18 | + |
| 19 | +from typing import Optional, Union |
| 20 | + |
| 21 | +import pyrogram |
| 22 | +from pyrogram import raw |
| 23 | + |
| 24 | + |
| 25 | +class SetChatMemberTag: |
| 26 | + async def set_chat_member_tag( |
| 27 | + self: "pyrogram.Client", |
| 28 | + chat_id: Union[int, str], |
| 29 | + user_id: Union[int, str], |
| 30 | + tag: Optional[str] = None, |
| 31 | + ) -> bool: |
| 32 | + """Use this method to set a tag for a regular member in a group or a supergroup. |
| 33 | +
|
| 34 | + .. note:: |
| 35 | +
|
| 36 | + The bot must be an administrator in the chat for this to work and must have the ``can_manage_tags`` administrator right. |
| 37 | +
|
| 38 | + .. include:: /_includes/usable-by/users-bots.rst |
| 39 | +
|
| 40 | + Parameters: |
| 41 | + chat_id (``int`` | ``str``): |
| 42 | + Unique identifier (int) or username (str) of the target chat. |
| 43 | +
|
| 44 | + user_id (``int`` | ``str``): |
| 45 | + Unique identifier (int) or username (str) of the target user. |
| 46 | + For a contact that exists in your Telegram address book you can use his phone number (str). |
| 47 | +
|
| 48 | + tag (``str``, *optional*): |
| 49 | + New tag for the member, 0-16 characters, emoji are not allowed. |
| 50 | +
|
| 51 | + Returns: |
| 52 | + ``bool``: True on success. |
| 53 | +
|
| 54 | + Example: |
| 55 | + .. code-block:: python |
| 56 | +
|
| 57 | + await app.set_chat_member_tag(chat_id, user_id, "Cool guy") |
| 58 | + """ |
| 59 | + chat_id = await self.resolve_peer(chat_id) |
| 60 | + user_id = await self.resolve_peer(user_id) |
| 61 | + |
| 62 | + await self.invoke( |
| 63 | + raw.functions.messages.EditChatParticipantRank( |
| 64 | + peer=chat_id, participant=user_id, rank=tag or "" |
| 65 | + ) |
| 66 | + ) |
| 67 | + |
| 68 | + return True |
0 commit comments