mirror of
https://github.com/aiogram/aiogram.git
synced 2026-04-08 16:37:47 +00:00
36 lines
1.4 KiB
Python
36 lines
1.4 KiB
Python
from __future__ import annotations
|
|
|
|
import datetime
|
|
from typing import TYPE_CHECKING, Any, Dict, Optional, Union
|
|
|
|
from .base import Request, TelegramMethod
|
|
|
|
if TYPE_CHECKING: # pragma: no cover
|
|
from ..client.bot import Bot
|
|
|
|
|
|
class KickChatMember(TelegramMethod[bool]):
|
|
"""
|
|
Use this method to kick a user from a group, a supergroup or a channel. In the case of
|
|
supergroups and channels, the user will not be able to return to the group on their own using
|
|
invite links, etc., unless unbanned first. The bot must be an administrator in the chat for
|
|
this to work and must have the appropriate admin rights. Returns True on success.
|
|
|
|
Source: https://core.telegram.org/bots/api#kickchatmember
|
|
"""
|
|
|
|
__returning__ = bool
|
|
|
|
chat_id: Union[int, str]
|
|
"""Unique identifier for the target group or username of the target supergroup or channel (in
|
|
the format @channelusername)"""
|
|
user_id: int
|
|
"""Unique identifier of the target user"""
|
|
until_date: Optional[Union[datetime.datetime, datetime.timedelta, int]] = None
|
|
"""Date when the user will be unbanned, unix time. If user is banned for more than 366 days or
|
|
less than 30 seconds from the current time they are considered to be banned forever"""
|
|
|
|
def build_request(self, bot: Bot) -> Request:
|
|
data: Dict[str, Any] = self.dict()
|
|
|
|
return Request(method="kickChatMember", data=data)
|