mirror of
https://github.com/aiogram/aiogram.git
synced 2026-04-08 16:37:47 +00:00
fea1b7b0a3
* Reworked request builder * Added more default values * Update tests * Fixed timestamp * Fixed Py3.8 support * Describe changes
29 lines
1.7 KiB
Python
29 lines
1.7 KiB
Python
from __future__ import annotations
|
|
|
|
import datetime
|
|
from typing import TYPE_CHECKING, Optional, Union
|
|
|
|
from ..types import ChatPermissions
|
|
from .base import TelegramMethod
|
|
|
|
|
|
class RestrictChatMember(TelegramMethod[bool]):
|
|
"""
|
|
Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate administrator rights. Pass :code:`True` for all permissions to lift restrictions from a user. Returns :code:`True` on success.
|
|
|
|
Source: https://core.telegram.org/bots/api#restrictchatmember
|
|
"""
|
|
|
|
__returning__ = bool
|
|
__api_method__ = "restrictChatMember"
|
|
|
|
chat_id: Union[int, str]
|
|
"""Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)"""
|
|
user_id: int
|
|
"""Unique identifier of the target user"""
|
|
permissions: ChatPermissions
|
|
"""A JSON-serialized object for new user permissions"""
|
|
use_independent_chat_permissions: Optional[bool] = None
|
|
"""Pass :code:`True` if chat permissions are set independently. Otherwise, the *can_send_other_messages* and *can_add_web_page_previews* permissions will imply the *can_send_messages*, *can_send_audios*, *can_send_documents*, *can_send_photos*, *can_send_videos*, *can_send_video_notes*, and *can_send_voice_notes* permissions; the *can_send_polls* permission will imply the *can_send_messages* permission."""
|
|
until_date: Optional[Union[datetime.datetime, datetime.timedelta, int]] = None
|
|
"""Date when restrictions will be lifted for the user, unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever"""
|