105 lines
3.0 KiB
Markdown
105 lines
3.0 KiB
Markdown
|
---
|
||
|
|
title: messages.saveDraft
|
||
|
|
description: messages.saveDraft parameters, return type and example
|
||
|
|
---
|
||
|
|
## Method: messages.saveDraft
|
||
|
|
[Back to methods index](index.md)
|
||
|
|
|
||
|
|
|
||
|
|
### Parameters:
|
||
|
|
|
||
|
|
| Name | Type | Required |
|
||
|
|
|----------|---------------|----------|
|
||
|
|
|no\_webpage|[Bool](../types/Bool.md) | Optional|
|
||
|
|
|reply\_to\_msg\_id|[int](../types/int.md) | Optional|
|
||
|
|
|peer|[InputPeer](../types/InputPeer.md) | Optional|
|
||
|
|
|message|[string](../types/string.md) | Yes|
|
||
|
|
|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|
|
||
|
|
|parse\_mode| [string](../types/string.md) | Optional |
|
||
|
|
|
||
|
|
|
||
|
|
### Return type: [Bool](../types/Bool.md)
|
||
|
|
|
||
|
|
### Can bots use this method: **NO**
|
||
|
|
|
||
|
|
|
||
|
|
### Errors this method can return:
|
||
|
|
|
||
|
|
| Error | Description |
|
||
|
|
|----------|---------------|
|
||
|
|
|PEER_ID_INVALID|The provided peer id is invalid|
|
||
|
|
|
||
|
|
|
||
|
|
### Example:
|
||
|
|
|
||
|
|
|
||
|
|
```
|
||
|
|
$MadelineProto = new \danog\MadelineProto\API();
|
||
|
|
$MadelineProto->session = 'mySession.madeline';
|
||
|
|
if (isset($number)) { // Login as a user
|
||
|
|
$MadelineProto->phone_login($number);
|
||
|
|
$code = readline('Enter the code you received: '); // Or do this in two separate steps in an HTTP API
|
||
|
|
$MadelineProto->complete_phone_login($code);
|
||
|
|
}
|
||
|
|
|
||
|
|
$Bool = $MadelineProto->messages->saveDraft(['no_webpage' => Bool, 'reply_to_msg_id' => int, 'peer' => InputPeer, 'message' => 'string', 'entities' => [MessageEntity], 'parse_mode' => 'string', ]);
|
||
|
|
```
|
||
|
|
|
||
|
|
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
### As a user:
|
||
|
|
|
||
|
|
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.saveDraft`
|
||
|
|
|
||
|
|
Parameters:
|
||
|
|
|
||
|
|
parse_mode - string
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
Or, if you're into Lua:
|
||
|
|
|
||
|
|
```
|
||
|
|
Bool = messages.saveDraft({no_webpage=Bool, reply_to_msg_id=int, peer=InputPeer, message='string', entities={MessageEntity}, parse_mode='string', })
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## 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.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Usage of parse_mode:
|
||
|
|
|
||
|
|
Set parse_mode to html to enable HTML parsing of the message.
|
||
|
|
|
||
|
|
Set parse_mode to Markdown to enable markown AND html parsing of the message.
|
||
|
|
|
||
|
|
The following tags are currently supported:
|
||
|
|
|
||
|
|
```
|
||
|
|
<br>a newline
|
||
|
|
<b><i>bold works ok, internal tags are stripped</i> </b>
|
||
|
|
<strong>bold</strong>
|
||
|
|
<em>italic</em>
|
||
|
|
<i>italic</i>
|
||
|
|
<code>inline fixed-width code</code>
|
||
|
|
<pre>pre-formatted fixed-width code block</pre>
|
||
|
|
<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:
|
||
|
|
|
||
|
|
```
|
||
|
|
[Mention by username](mention:@danogentili)
|
||
|
|
[Mention by user id](mention:186785362)
|
||
|
|
```
|
||
|
|
|
||
|
|
MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php).
|