MadelineProto/docs/API_docs/methods/messages_readEncryptedHistory.md

78 lines
1.7 KiB
Markdown
Raw Normal View History

2016-12-20 13:15:22 +01:00
---
2017-01-19 23:02:27 +01:00
title: messages.readEncryptedHistory
2018-03-23 16:23:49 +01:00
description: Mark messages as read in secret chats
2016-12-20 13:15:22 +01:00
---
2017-01-19 23:02:27 +01:00
## Method: messages.readEncryptedHistory
2016-12-20 13:15:22 +01:00
[Back to methods index](index.md)
2018-03-23 16:23:49 +01:00
Mark messages as read in secret chats
### Parameters:
2018-03-23 16:23:49 +01:00
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read|
2018-03-27 14:41:50 +02:00
|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark|
### Return type: [Bool](../types/Bool.md)
2017-08-28 12:44:50 +02:00
### Can bots use this method: **YES**
2018-03-20 19:57:36 +01:00
### MadelineProto Example:
```
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
include 'madeline.php';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
2016-12-21 10:40:30 +01:00
$Bool = $MadelineProto->messages->readEncryptedHistory(['peer' => InputEncryptedChat, 'max_date' => int, ]);
2017-02-13 04:33:06 +01:00
```
2018-03-20 19:57:36 +01:00
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
2017-07-23 16:11:02 +02:00
### As a bot:
POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline`
Parameters:
* method - messages.readEncryptedHistory
2017-07-23 16:40:54 +02:00
* params - `{"peer": InputEncryptedChat, "max_date": int, }`
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/messages.readEncryptedHistory`
Parameters:
peer - Json encoded InputEncryptedChat
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
max_date - Json encoded int
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:
```
Bool = messages.readEncryptedHistory({peer=InputEncryptedChat, max_date=int, })
```
2018-03-27 14:41:50 +02:00
### Errors this method can return:
| Error | Description |
|----------|---------------|
|MSG_WAIT_FAILED|A waiting call returned an error|