mirror of
https://github.com/aiogram/aiogram.git
synced 2025-12-12 02:03:04 +00:00
6be0b36305
* AIOG-T-20 Bot API 4.8 * AIOG-T-20 Update aliases * AIOG-T-20 Add parse mode passing in sendPoll method * AIOG-T-20 Small changes in docs * AIOG-T-20 Revert overriding remove keyboard default value and add tests * AIOG-T-20 Bot API 4.8
60 lines
1.7 KiB
Markdown
60 lines
1.7 KiB
Markdown
# restrictChatMember
|
|
|
|
## Description
|
|
|
|
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 admin rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.
|
|
|
|
|
|
## Arguments
|
|
|
|
| Name | Type | Description |
|
|
| - | - | - |
|
|
| `chat_id` | `#!python3 Union[int, str]` | Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) |
|
|
| `user_id` | `#!python3 int` | Unique identifier of the target user |
|
|
| `permissions` | `#!python3 ChatPermissions` | New user permissions |
|
|
| `until_date` | `#!python3 Optional[Union[datetime.datetime, datetime.timedelta, int]]` | Optional. 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 |
|
|
|
|
|
|
|
|
## Response
|
|
|
|
Type: `#!python3 bool`
|
|
|
|
Description: Returns True on success.
|
|
|
|
|
|
## Usage
|
|
|
|
### As bot method
|
|
|
|
```python3
|
|
result: bool = await bot.restrict_chat_member(...)
|
|
```
|
|
|
|
### Method as object
|
|
|
|
Imports:
|
|
|
|
- `from aiogram.methods import RestrictChatMember`
|
|
- `from aiogram.api.methods import RestrictChatMember`
|
|
- `from aiogram.api.methods.restrict_chat_member import RestrictChatMember`
|
|
|
|
#### In handlers with current bot
|
|
```python3
|
|
result: bool = await RestrictChatMember(...)
|
|
```
|
|
|
|
#### With specific bot
|
|
```python3
|
|
result: bool = await bot(RestrictChatMember(...))
|
|
```
|
|
#### As reply into Webhook in handler
|
|
```python3
|
|
return RestrictChatMember(...)
|
|
```
|
|
|
|
|
|
## Related pages:
|
|
|
|
- [Official documentation](https://core.telegram.org/bots/api#restrictchatmember)
|
|
- [aiogram.types.ChatPermissions](../types/chat_permissions.md)
|