MadelineProtoDocs/old_docs/API_docs_v38/methods/channels_kickFromChannel.md

48 lines
1.3 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
2018-04-01 13:24:46 +02:00
title: channels.kickFromChannel
description: Kick user from channel
2018-04-04 19:52:48 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2018-04-01 13:19:25 +02:00
---
2018-04-05 01:19:57 +02:00
# Method: channels.kickFromChannel
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
2018-04-01 13:24:46 +02:00
Kick user from channel
2018-04-01 13:19:25 +02:00
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel | Optional|
|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to kick | Optional|
|kicked|[Bool](../types/Bool.md) | Kick or unkick? | Yes|
2018-04-01 13:19:25 +02:00
### Return type: [Updates](../types/Updates.md)
### Can bots use this method: **YES**
2019-05-04 12:15:39 +02:00
### MadelineProto Example ([now async!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
2018-04-01 13:19:25 +02:00
```php
2018-04-01 13:19:25 +02:00
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
2019-03-12 13:25:41 +01:00
define('MADELINE_BRANCH', '');
2018-04-01 13:19:25 +02:00
include 'madeline.php';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
2018-04-01 13:24:46 +02:00
$Updates = $MadelineProto->channels->kickFromChannel(['channel' => InputChannel, 'user_id' => InputUser, 'kicked' => Bool, ]);
2018-04-01 13:19:25 +02:00
```
Or, if you're into Lua:
```lua
2018-04-01 13:24:46 +02:00
Updates = channels.kickFromChannel({channel=InputChannel, user_id=InputUser, kicked=Bool, })
2018-04-01 13:19:25 +02:00
```