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

87 lines
3.5 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-03-13 13:48:55 +00:00
#
2020-03-21 14:43:32 +00:00
# This file is part of Pyrogram.
2019-03-13 13:48:55 +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-03-13 13:48:55 +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-03-13 13:48:55 +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-03-13 13:48:55 +00:00
from typing import Union
from pyrogram.api import functions, types
from ...ext import BaseClient
from ...types.user_and_chats import Chat, ChatPermissions
2019-03-13 13:48:55 +00:00
class SetChatPermissions(BaseClient):
async def set_chat_permissions(
2019-03-16 16:51:37 +00:00
self,
chat_id: Union[int, str],
permissions: ChatPermissions,
2019-03-13 13:48:55 +00:00
) -> Chat:
"""Set default chat permissions for all members.
You must be an administrator in the group or a supergroup for this to work and must have the
*can_restrict_members* admin rights.
2019-03-13 13:48:55 +00:00
Parameters:
2019-03-13 13:48:55 +00:00
chat_id (``int`` | ``str``):
Unique identifier (int) or username (str) of the target chat.
permissions (:obj:`ChatPermissions`):
New default chat permissions.
2019-03-13 13:48:55 +00:00
Returns:
:obj:`Chat`: On success, a chat object is returned.
2019-03-13 13:48:55 +00:00
2019-07-25 09:22:14 +00:00
Example:
.. code-block:: python
from pyrogram import ChatPermissions
2019-07-25 09:22:14 +00:00
# Completely restrict chat
app.set_chat_permissions(chat_id, ChatPermissions())
# Chat members can only send text messages, media, stickers and GIFs
app.set_chat_permissions(
chat_id,
ChatPermissions(
can_send_messages=True,
can_send_media_messages=True,
can_send_stickers=True,
can_send_animations=True
)
)
2019-03-13 13:48:55 +00:00
"""
r = await self.send(
2019-03-13 13:48:55 +00:00
functions.messages.EditChatDefaultBannedRights(
peer=await self.resolve_peer(chat_id),
2019-03-13 13:48:55 +00:00
banned_rights=types.ChatBannedRights(
until_date=0,
send_messages=True if not permissions.can_send_messages else None,
send_media=True if not permissions.can_send_media_messages else None,
send_stickers=True if not permissions.can_send_stickers else None,
send_gifs=True if not permissions.can_send_animations else None,
send_games=True if not permissions.can_send_games else None,
send_inline=True if not permissions.can_use_inline_bots else None,
embed_links=True if not permissions.can_add_web_page_previews else None,
send_polls=True if not permissions.can_send_polls else None,
change_info=True if not permissions.can_change_info else None,
invite_users=True if not permissions.can_invite_users else None,
pin_messages=True if not permissions.can_pin_messages else None,
2019-03-13 13:48:55 +00:00
)
)
)
return Chat._parse_chat(self, r.chats[0])