MadelineProtoDocs/old_docs/API_docs_v72/methods/messages.saveDraft.md

100 lines
3.5 KiB
Markdown
Raw Permalink Normal View History

2018-04-01 13:19:25 +02:00
---
title: messages.saveDraft
2019-12-27 17:48:04 +01:00
description: Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat.
2018-04-04 19:52:48 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2019-12-27 18:46:25 +01:00
redirect_from: /API_docs/methods/messages_saveDraft.html
2018-04-01 13:19:25 +02:00
---
2018-04-05 01:19:57 +02:00
# Method: messages.saveDraft
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
2019-12-27 17:48:04 +01:00
Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat.
2018-04-01 13:19:25 +02:00
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2019-12-27 17:48:04 +01:00
|no\_webpage|[Bool](../types/Bool.md) | Disable generation of the webpage preview | Optional|
|reply\_to\_msg\_id|[int](../types/int.md) | Message ID the message should reply to | Optional|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Destination of the message that should be sent | Optional|
|message|[string](../types/string.md) | The draft | Yes|
2018-08-29 11:18:25 +02:00
|entities|Array of [MessageEntity](../types/MessageEntity.md) | The entities (for styled text) | Optional|
2018-08-29 11:22:58 +02:00
|parse\_mode| [string](../types/string.md) | Whether to parse HTML or Markdown markup in the message| Optional |
2018-04-01 13:19:25 +02:00
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **NO**
2019-06-02 13:49:54 +02:00
### MadelineProto Example ([now async for huge speed and parallelism!](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');
}
include 'madeline.php';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
$Bool = $MadelineProto->messages->saveDraft(['no_webpage' => Bool, 'reply_to_msg_id' => int, 'peer' => InputPeer, 'message' => 'string', 'entities' => [MessageEntity, MessageEntity], 'parse_mode' => 'string', ]);
```
Or, if you're into Lua:
```lua
2019-12-27 17:48:04 +01:00
Bool = messages.saveDraft({no_webpage=Bool, reply_to_msg_id=int, peer=InputPeer, message='string', entities={MessageEntity}, parseMode='string', })
2018-04-01 13:19:25 +02:00
```
## Return value
If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead.
2019-12-27 17:48:04 +01:00
## Usage of parseMode:
2018-04-01 13:19:25 +02:00
2019-12-27 17:48:04 +01:00
Set parseMode to html to enable HTML parsing of the message.
2018-04-01 13:19:25 +02:00
2019-12-27 17:48:04 +01:00
Set parseMode to Markdown to enable markown AND html parsing of the message.
2018-04-01 13:19:25 +02:00
The following tags are currently supported:
2018-12-26 02:56:50 +01:00
```html
2018-04-01 13:19:25 +02:00
<br>a newline
<b><i>bold works ok, internal tags are stripped</i> </b>
<strong>bold</strong>
<em>italic</em>
<i>italic</i>
2019-06-24 15:45:02 +02:00
<u>underline</u>
<s>strikethrough</s>
<del>strikethrough</del>
<strike>strikethrough</strike>
2018-04-01 13:19:25 +02:00
<code>inline fixed-width code</code>
<pre>pre-formatted fixed-width code block</pre>
2019-06-24 15:45:02 +02:00
<blockquote>pre-formatted fixed-width code block</blockquote>
2018-04-01 13:19:25 +02:00
<a href="https://github.com">URL</a>
<a href="mention:@danogentili">Mention by username</a>
<a href="mention:186785362">Mention by user id</a>
<pre language="json">Pre tags can have a language attribute</pre>
```
You can also use normal markdown, note that to create mentions you must use the `mention:` syntax like in html:
2018-12-26 02:56:50 +01:00
```markdown
2018-04-01 13:19:25 +02:00
[Mention by username](mention:@danogentili)
[Mention by user id](mention:186785362)
```
2019-12-27 17:48:04 +01:00
MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php).
2019-09-02 17:41:28 +02:00
### Errors
2018-04-01 13:19:25 +02:00
2019-09-02 17:41:28 +02:00
| Code | Type | Description |
|------|----------|---------------|
|400|PEER_ID_INVALID|The provided peer id is invalid|
2018-04-01 13:19:25 +02:00