MadelineProto/docs/API_docs/methods/channels_deleteUserHistory.md

71 lines
1.6 KiB
Markdown
Raw Normal View History

2016-12-20 13:15:22 +01:00
---
2017-01-19 23:02:27 +01:00
title: channels.deleteUserHistory
description: channels.deleteUserHistory parameters, return type and example
2016-12-20 13:15:22 +01:00
---
2017-01-19 23:02:27 +01:00
## Method: channels.deleteUserHistory
2016-12-20 13:15:22 +01:00
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
2017-08-20 11:05:56 +02:00
|----------|---------------|----------|
|channel|[InputChannel](../types/InputChannel.md) | Yes|
|user\_id|[InputUser](../types/InputUser.md) | Yes|
2016-12-19 18:35:27 +01:00
### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md)
2017-08-28 12:44:50 +02:00
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
2017-09-01 12:27:38 +02:00
|CHANNEL_INVALID|The provided channel is invalid|
|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this|
2017-08-28 12:44:50 +02:00
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
if (isset($number)) { // Login as a user
$sentCode = $MadelineProto->phone_login($number);
echo 'Enter the code you received: ';
$code = '';
for ($x = 0; $x < $sentCode['type']['length']; $x++) {
$code .= fgetc(STDIN);
}
$MadelineProto->complete_phone_login($code);
}
2016-12-21 10:40:30 +01:00
$messages_AffectedHistory = $MadelineProto->channels->deleteUserHistory(['channel' => InputChannel, 'user_id' => InputUser, ]);
2017-02-13 04:33:06 +01:00
```
2017-07-24 01:32:29 +02:00
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
2017-07-23 16:11:02 +02:00
2017-07-23 16:34:36 +02:00
2017-07-23 16:11:02 +02:00
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.deleteUserHistory`
Parameters:
channel - Json encoded InputChannel
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
user_id - Json encoded InputUser
2017-07-23 16:40:54 +02:00
2017-07-23 16:11:02 +02:00
2017-08-20 19:09:52 +02:00
Or, if you're into Lua:
```
messages_AffectedHistory = channels.deleteUserHistory({channel=InputChannel, user_id=InputUser, })
```