MadelineProto/docs/API_docs/methods/channels_deleteHistory.md

72 lines
1.5 KiB
Markdown
Raw Normal View History

2017-10-14 11:50:46 +02:00
---
title: channels.deleteHistory
description: channels.deleteHistory parameters, return type and example
---
## Method: channels.deleteHistory
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|channel|[InputChannel](../types/InputChannel.md) | Yes|
|max\_id|[int](../types/int.md) | Yes|
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **YES**
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
2017-12-11 12:12:38 +01:00
$MadelineProto->session = 'mySession.madeline';
2017-10-14 11:50:46 +02:00
if (isset($token)) { // Login as a bot
$MadelineProto->bot_login($token);
}
if (isset($number)) { // Login as a user
2017-12-11 12:12:38 +01:00
$MadelineProto->phone_login($number);
$code = readline('Enter the code you received: '); // Or do this in two separate steps in an HTTP API
2017-10-14 11:50:46 +02:00
$MadelineProto->complete_phone_login($code);
}
$Bool = $MadelineProto->channels->deleteHistory(['channel' => InputChannel, 'max_id' => int, ]);
```
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
### As a bot:
POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline`
Parameters:
* method - channels.deleteHistory
* params - `{"channel": InputChannel, "max_id": int, }`
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.deleteHistory`
Parameters:
channel - Json encoded InputChannel
max_id - Json encoded int
Or, if you're into Lua:
```
Bool = channels.deleteHistory({channel=InputChannel, max_id=int, })
```