Update docs

This commit is contained in:
Daniil Gentili 2018-03-20 22:18:19 +01:00
parent b04f5065e5
commit dcec2787ed
63 changed files with 333 additions and 180 deletions

View File

@ -129,6 +129,7 @@ Tip: if you receive an error (or nothing), [send us](https://t.me/pwrtelegramgro
* [Translation](https://docs.madelineproto.xyz/docs/CONTRIBUTING.html#translation)
* [Contribution guide](https://docs.madelineproto.xyz/docs/CONTRIBUTING.html#contribution-guide)
* [Credits](https://docs.madelineproto.xyz/docs/CONTRIBUTING.html#credits)
* [Web templates for `$MadelineProto->start()`](https://docs.madelineproto.xyz/docs/TEMPLATES.html)
## Very complex and complete examples

View File

@ -45,8 +45,8 @@ foreach ($files as $file) {
$orderedfiles[19] = $file;
} else if ($base === 'CONTRIBUTING') {
$orderedfiles[20] = $file;
} else {
$orderedfiles[] = $file;
} else if ($base === 'TEMPLATES') {
$orderedfiles[21] = $file;
}
ksort($orderedfiles);
}

View File

@ -1,17 +1,19 @@
---
title: contacts.resetTopPeerRating
description: contacts.resetTopPeerRating parameters, return type and example
description: Reset top peer rating for a certain category/peer
---
## Method: contacts.resetTopPeerRating
[Back to methods index](index.md)
Reset top peer rating for a certain category/peer
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|category|[CLICK ME TopPeerCategory](../types/TopPeerCategory.md) | Yes|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|category|[CLICK ME TopPeerCategory](../types/TopPeerCategory.md) | Yes|The category |
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer|
### Return type: [Bool](../types/Bool.md)

View File

@ -1,16 +1,18 @@
---
title: messages.getMessages
description: messages.getMessages parameters, return type and example
description: Get messages
---
## Method: messages.getMessages
[Back to methods index](index.md)
Get messages
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|id|Array of [Message ID or InputMessage](../types/InputMessage.md) | Yes|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|id|Array of [Message ID or InputMessage](../types/InputMessage.md) | Yes|The IDs of messages to fetch (only for users and normal groups)|
### Return type: [messages\_Messages](../types/messages_Messages.md)

View File

@ -118,4 +118,6 @@ foreach ($updates as $update) {
<form action="https://docs.madelineproto.xyz/docs/SECRET_CHATS.html"><input type="submit" value="Next section" /></form>

View File

@ -43,4 +43,6 @@ You can also use `get_info` to get chat info, see [here for the parameters and t
* Caching: full
<form action="https://docs.madelineproto.xyz/docs/DIALOGS.html"><input type="submit" value="Next section" /></form>

View File

@ -27,7 +27,7 @@ Then create a pull request from branch `localization-yourlanguage`
You can use this scheme of the structure of this project to help yourself:
```php
```
build_docs.php - Builds API docs from TL scheme file
src/danog/MadelineProto/
MTProtoTools/
@ -90,4 +90,6 @@ Thanks to the devs that contributed to these projects, MadelineProto is now an e
<form action="https://docs.madelineproto.xyz/#very-complex-and-complete-examples"><input type="submit" value="Next section" /></form>
<form action="https://docs.madelineproto.xyz/docs/TEMPLATES.html"><input type="submit" value="Next section" /></form>

View File

@ -21,4 +21,6 @@ $MadelineProto->session = 'newsession.madeline';
```
<form action="https://docs.madelineproto.xyz/docs/LOGIN.html"><input type="submit" value="Next section" /></form>

View File

@ -32,4 +32,6 @@ Since bots cannot run `get_dialogs`, you must make use of the internal MadelineP
<form action="https://docs.madelineproto.xyz/docs/INLINE_BUTTONS.html"><input type="submit" value="Next section" /></form>

View File

@ -107,4 +107,6 @@ try {
<form action="https://docs.madelineproto.xyz/docs/FLOOD_WAIT.html"><input type="submit" value="Next section" /></form>

View File

@ -43,4 +43,6 @@
<form action="https://docs.madelineproto.xyz/docs/REQUIREMENTS.html"><input type="submit" value="Next section" /></form>

View File

@ -428,4 +428,6 @@ $output_file_name = $MadelineProto->download_to_file(
<form action="https://docs.madelineproto.xyz/docs/CHAT_INFO.html"><input type="submit" value="Next section" /></form>

View File

@ -14,4 +14,6 @@ Use sleep to execute max N calls in `floodwaitrate` seconds, this way you won't
<form action="https://docs.madelineproto.xyz/docs/LOGGING.html"><input type="submit" value="Next section" /></form>

View File

@ -53,4 +53,6 @@ $button->click();
<form action="https://docs.madelineproto.xyz/docs/CALLS.html"><input type="submit" value="Next section" /></form>

View File

@ -122,4 +122,6 @@ Now open `.env` and edit its values as needed.
<form action="https://docs.madelineproto.xyz/docs/UPDATES.html"><input type="submit" value="Next section" /></form>

View File

@ -19,4 +19,6 @@ By default, `$level` is `\danog\MadelineProto\Logger:NOTICE`.
<form action="https://docs.madelineproto.xyz/docs/USING_METHODS.html"><input type="submit" value="Next section" /></form>

View File

@ -60,4 +60,6 @@ Use `logout` to logout, see [here for the parameters and the result](https://doc
<form action="https://docs.madelineproto.xyz/docs/FEATURES.html"><input type="submit" value="Next section" /></form>

View File

@ -18,4 +18,6 @@ td-cli wrappers are also present: you can use the tdcli_function in lua and pass
<form action="https://docs.madelineproto.xyz/docs/PROXY.html"><input type="submit" value="Next section" /></form>

View File

@ -122,4 +122,6 @@ Can return additional HTTP headers to use when the HTTP protocol is being used.
<form action="https://docs.madelineproto.xyz/docs/CONTRIBUTING.html"><input type="submit" value="Next section" /></form>

View File

@ -15,4 +15,6 @@ Next, follow the instructions on voip.madelineproto.xyz and prime.madelineproto.
<form action="https://docs.madelineproto.xyz/docs/INSTALLATION.html"><input type="submit" value="Next section" /></form>

View File

@ -70,4 +70,6 @@ This method gets info about a certain chat.
<form action="https://docs.madelineproto.xyz/docs/LUA.html"><input type="submit" value="Next section" /></form>

View File

@ -10,4 +10,6 @@ $me = $MadelineProto->get_self();
<form action="https://docs.madelineproto.xyz/docs/EXCEPTIONS.html"><input type="submit" value="Next section" /></form>

View File

@ -365,7 +365,7 @@ Description: Should I handle old updates on startup?
Default: -1
Description: If positive and bigger than zero, no requests will be sent to the socket to request updates in N seconds, passive update listening will be used instead
### `$settings['updates']['calback']`
### `$settings['updates']['callback']`
Default: `'get_updates_update_handler'`
Description: A callable function that will be called every time an update is received, must accept an array (for the update) as the only parameter.
@ -399,4 +399,6 @@ $MadelineProto->settings['updates']['handle_updates'] = true; // reenable update
<form action="https://docs.madelineproto.xyz/docs/SELF.html"><input type="submit" value="Next section" /></form>

35
docs/docs/TEMPLATES.md Normal file
View File

@ -0,0 +1,35 @@
# Web templates for `$MadelineProto->start()`
You get the web template used for the `$MadelineProto->start()` web UI thusly:
```php
$template = $MadelineProto->get_web_template();
```
By default, it is equal to:
```html
<!DOCTYPE html>
<html>
<head>
<title>MadelineProto</title>
</head>
<body>
<h1>MadelineProto</h1>
<form method="POST">
%s
<button type="submit"/>Go</button>
</form>
<p>%s</p>
</body>
</html>
```
To modify the web template, use:
```php
$MadelineProto->set_web_template($new_template);
```
The new template must have a structure similar the the default template.
<form action="https://docs.madelineproto.xyz/#very-complex-and-complete-examples"><input type="submit" value="Next section" /></form>

View File

@ -200,4 +200,6 @@ Note that multiprocessing is not the same as multithreading, and should be avoid
<form action="https://docs.madelineproto.xyz/docs/SETTINGS.html"><input type="submit" value="Next section" /></form>

View File

@ -99,4 +99,6 @@ $MadelineProto->messages->sendMessage(['peer' => '@danogentili', 'message' => 'l
If the queue if the specified queue name does not exist, it will be created.
<form action="https://docs.madelineproto.xyz/docs/FILES.html"><input type="submit" value="Next section" /></form>

View File

@ -43,7 +43,7 @@ $MadelineProto->messages->sendMessage(['peer' => 'https://t.me/joinchat/Bgrajz6K
echo 'OK, done!'.PHP_EOL;
```
Run this code in a browser or in a console.
Run this code in a browser or in a console.
Tip: if you receive an error (or nothing), [send us](https://t.me/pwrtelegramgroup) the error message and the `MadelineProto.log` file that was created in the same directory (if running from a browser).
@ -111,7 +111,7 @@ Tip: if you receive an error (or nothing), [send us](https://t.me/pwrtelegramgro
* [Full chat info with full list of participants](https://docs.madelineproto.xyz/docs/CHAT_INFO.html#get_pwr_chat)
* [Full chat info](https://docs.madelineproto.xyz/docs/CHAT_INFO.html#get_full_info)
* [Reduced chat info (very fast)](https://docs.madelineproto.xyz/docs/CHAT_INFO.html#get_info)
* [Getting all chats](https://docs.madelineproto.xyz/docs/DIALOGS.html)
* [Getting all chats (dialogs)](https://docs.madelineproto.xyz/docs/DIALOGS.html)
* [As user](https://docs.madelineproto.xyz/docs/DIALOGS.html#user-get_dialogs)
* [As bot](https://docs.madelineproto.xyz/docs/DIALOGS.html#bot-internal-peer-database)
* [Inline buttons](https://docs.madelineproto.xyz/docs/INLINE_BUTTONS.html)
@ -133,6 +133,7 @@ Tip: if you receive an error (or nothing), [send us](https://t.me/pwrtelegramgro
* [Translation](https://docs.madelineproto.xyz/docs/CONTRIBUTING.html#translation)
* [Contribution guide](https://docs.madelineproto.xyz/docs/CONTRIBUTING.html#contribution-guide)
* [Credits](https://docs.madelineproto.xyz/docs/CONTRIBUTING.html#credits)
* [Web templates for `$MadelineProto->start()`](https://docs.madelineproto.xyz/docs/TEMPLATES.html)
## Very complex and complete examples

View File

@ -1,16 +1,18 @@
---
title: messages.getMessages
description: messages.getMessages parameters, return type and example
description: Get messages
---
## Method: messages.getMessages
[Back to methods index](index.md)
Get messages
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)|
### Return type: [messages\_Messages](../types/messages_Messages.md)

View File

@ -1,16 +1,18 @@
---
title: messages.getMessages
description: messages.getMessages parameters, return type and example
description: Get messages
---
## Method: messages.getMessages
[Back to methods index](index.md)
Get messages
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)|
### Return type: [messages\_Messages](../types/messages_Messages.md)

View File

@ -1,16 +1,18 @@
---
title: messages.getMessages
description: messages.getMessages parameters, return type and example
description: Get messages
---
## Method: messages.getMessages
[Back to methods index](index.md)
Get messages
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)|
### Return type: [messages\_Messages](../types/messages_Messages.md)

View File

@ -1,16 +1,18 @@
---
title: messages.getMessages
description: messages.getMessages parameters, return type and example
description: Get messages
---
## Method: messages.getMessages
[Back to methods index](index.md)
Get messages
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)|
### Return type: [messages\_Messages](../types/messages_Messages.md)

View File

@ -1,16 +1,18 @@
---
title: messages.getMessages
description: messages.getMessages parameters, return type and example
description: Get messages
---
## Method: messages.getMessages
[Back to methods index](index.md)
Get messages
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)|
### Return type: [messages\_Messages](../types/messages_Messages.md)

View File

@ -1,16 +1,18 @@
---
title: messages.getMessages
description: messages.getMessages parameters, return type and example
description: Get messages
---
## Method: messages.getMessages
[Back to methods index](index.md)
Get messages
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)|
### Return type: [messages\_Messages](../types/messages_Messages.md)

View File

@ -1,16 +1,18 @@
---
title: messages.getMessages
description: messages.getMessages parameters, return type and example
description: Get messages
---
## Method: messages.getMessages
[Back to methods index](index.md)
Get messages
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)|
### Return type: [messages\_Messages](../types/messages_Messages.md)

View File

@ -1,16 +1,18 @@
---
title: messages.getMessages
description: messages.getMessages parameters, return type and example
description: Get messages
---
## Method: messages.getMessages
[Back to methods index](index.md)
Get messages
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)|
### Return type: [messages\_Messages](../types/messages_Messages.md)

View File

@ -1,16 +1,18 @@
---
title: messages.getMessages
description: messages.getMessages parameters, return type and example
description: Get messages
---
## Method: messages.getMessages
[Back to methods index](index.md)
Get messages
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)|
### Return type: [messages\_Messages](../types/messages_Messages.md)

View File

@ -1,16 +1,18 @@
---
title: messages.getMessages
description: messages.getMessages parameters, return type and example
description: Get messages
---
## Method: messages.getMessages
[Back to methods index](index.md)
Get messages
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)|
### Return type: [messages\_Messages](../types/messages_Messages.md)

View File

@ -1,16 +1,18 @@
---
title: messages.getMessages
description: messages.getMessages parameters, return type and example
description: Get messages
---
## Method: messages.getMessages
[Back to methods index](index.md)
Get messages
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)|
### Return type: [messages\_Messages](../types/messages_Messages.md)

View File

@ -1,16 +1,18 @@
---
title: messages.getMessages
description: messages.getMessages parameters, return type and example
description: Get messages
---
## Method: messages.getMessages
[Back to methods index](index.md)
Get messages
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)|
### Return type: [messages\_Messages](../types/messages_Messages.md)

View File

@ -1,16 +1,18 @@
---
title: messages.getMessages
description: messages.getMessages parameters, return type and example
description: Get messages
---
## Method: messages.getMessages
[Back to methods index](index.md)
Get messages
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)|
### Return type: [messages\_Messages](../types/messages_Messages.md)

View File

@ -1,17 +1,19 @@
---
title: contacts.resetTopPeerRating
description: contacts.resetTopPeerRating parameters, return type and example
description: Reset top peer rating for a certain category/peer
---
## Method: contacts.resetTopPeerRating
[Back to methods index](index.md)
Reset top peer rating for a certain category/peer
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|category|[CLICK ME TopPeerCategory](../types/TopPeerCategory.md) | Yes|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|category|[CLICK ME TopPeerCategory](../types/TopPeerCategory.md) | Yes|The category |
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer|
### Return type: [Bool](../types/Bool.md)

View File

@ -1,16 +1,18 @@
---
title: messages.getMessages
description: messages.getMessages parameters, return type and example
description: Get messages
---
## Method: messages.getMessages
[Back to methods index](index.md)
Get messages
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)|
### Return type: [messages\_Messages](../types/messages_Messages.md)

View File

@ -1,17 +1,19 @@
---
title: contacts.resetTopPeerRating
description: contacts.resetTopPeerRating parameters, return type and example
description: Reset top peer rating for a certain category/peer
---
## Method: contacts.resetTopPeerRating
[Back to methods index](index.md)
Reset top peer rating for a certain category/peer
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|category|[CLICK ME TopPeerCategory](../types/TopPeerCategory.md) | Yes|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|category|[CLICK ME TopPeerCategory](../types/TopPeerCategory.md) | Yes|The category |
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer|
### Return type: [Bool](../types/Bool.md)

View File

@ -1,16 +1,18 @@
---
title: messages.getMessages
description: messages.getMessages parameters, return type and example
description: Get messages
---
## Method: messages.getMessages
[Back to methods index](index.md)
Get messages
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)|
### Return type: [messages\_Messages](../types/messages_Messages.md)

View File

@ -1,17 +1,19 @@
---
title: contacts.resetTopPeerRating
description: contacts.resetTopPeerRating parameters, return type and example
description: Reset top peer rating for a certain category/peer
---
## Method: contacts.resetTopPeerRating
[Back to methods index](index.md)
Reset top peer rating for a certain category/peer
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|category|[CLICK ME TopPeerCategory](../types/TopPeerCategory.md) | Yes|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|category|[CLICK ME TopPeerCategory](../types/TopPeerCategory.md) | Yes|The category |
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer|
### Return type: [Bool](../types/Bool.md)

View File

@ -1,16 +1,18 @@
---
title: messages.getMessages
description: messages.getMessages parameters, return type and example
description: Get messages
---
## Method: messages.getMessages
[Back to methods index](index.md)
Get messages
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)|
### Return type: [messages\_Messages](../types/messages_Messages.md)

View File

@ -1,17 +1,19 @@
---
title: contacts.resetTopPeerRating
description: contacts.resetTopPeerRating parameters, return type and example
description: Reset top peer rating for a certain category/peer
---
## Method: contacts.resetTopPeerRating
[Back to methods index](index.md)
Reset top peer rating for a certain category/peer
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|category|[CLICK ME TopPeerCategory](../types/TopPeerCategory.md) | Yes|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|category|[CLICK ME TopPeerCategory](../types/TopPeerCategory.md) | Yes|The category |
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer|
### Return type: [Bool](../types/Bool.md)

View File

@ -1,16 +1,18 @@
---
title: messages.getMessages
description: messages.getMessages parameters, return type and example
description: Get messages
---
## Method: messages.getMessages
[Back to methods index](index.md)
Get messages
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)|
### Return type: [messages\_Messages](../types/messages_Messages.md)

View File

@ -1,17 +1,19 @@
---
title: contacts.resetTopPeerRating
description: contacts.resetTopPeerRating parameters, return type and example
description: Reset top peer rating for a certain category/peer
---
## Method: contacts.resetTopPeerRating
[Back to methods index](index.md)
Reset top peer rating for a certain category/peer
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|category|[CLICK ME TopPeerCategory](../types/TopPeerCategory.md) | Yes|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|category|[CLICK ME TopPeerCategory](../types/TopPeerCategory.md) | Yes|The category |
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer|
### Return type: [Bool](../types/Bool.md)

View File

@ -1,16 +1,18 @@
---
title: messages.getMessages
description: messages.getMessages parameters, return type and example
description: Get messages
---
## Method: messages.getMessages
[Back to methods index](index.md)
Get messages
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)|
### Return type: [messages\_Messages](../types/messages_Messages.md)

View File

@ -1,17 +1,19 @@
---
title: contacts.resetTopPeerRating
description: contacts.resetTopPeerRating parameters, return type and example
description: Reset top peer rating for a certain category/peer
---
## Method: contacts.resetTopPeerRating
[Back to methods index](index.md)
Reset top peer rating for a certain category/peer
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|category|[CLICK ME TopPeerCategory](../types/TopPeerCategory.md) | Yes|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|category|[CLICK ME TopPeerCategory](../types/TopPeerCategory.md) | Yes|The category |
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer|
### Return type: [Bool](../types/Bool.md)

View File

@ -1,16 +1,18 @@
---
title: messages.getMessages
description: messages.getMessages parameters, return type and example
description: Get messages
---
## Method: messages.getMessages
[Back to methods index](index.md)
Get messages
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)|
### Return type: [messages\_Messages](../types/messages_Messages.md)

View File

@ -1,17 +1,19 @@
---
title: contacts.resetTopPeerRating
description: contacts.resetTopPeerRating parameters, return type and example
description: Reset top peer rating for a certain category/peer
---
## Method: contacts.resetTopPeerRating
[Back to methods index](index.md)
Reset top peer rating for a certain category/peer
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|category|[CLICK ME TopPeerCategory](../types/TopPeerCategory.md) | Yes|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|category|[CLICK ME TopPeerCategory](../types/TopPeerCategory.md) | Yes|The category |
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer|
### Return type: [Bool](../types/Bool.md)

View File

@ -1,16 +1,18 @@
---
title: messages.getMessages
description: messages.getMessages parameters, return type and example
description: Get messages
---
## Method: messages.getMessages
[Back to methods index](index.md)
Get messages
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)|
### Return type: [messages\_Messages](../types/messages_Messages.md)

View File

@ -1,17 +1,19 @@
---
title: contacts.resetTopPeerRating
description: contacts.resetTopPeerRating parameters, return type and example
description: Reset top peer rating for a certain category/peer
---
## Method: contacts.resetTopPeerRating
[Back to methods index](index.md)
Reset top peer rating for a certain category/peer
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|category|[CLICK ME TopPeerCategory](../types/TopPeerCategory.md) | Yes|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|category|[CLICK ME TopPeerCategory](../types/TopPeerCategory.md) | Yes|The category |
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer|
### Return type: [Bool](../types/Bool.md)

View File

@ -1,16 +1,18 @@
---
title: messages.getMessages
description: messages.getMessages parameters, return type and example
description: Get messages
---
## Method: messages.getMessages
[Back to methods index](index.md)
Get messages
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)|
### Return type: [messages\_Messages](../types/messages_Messages.md)

View File

@ -1,17 +1,19 @@
---
title: contacts.resetTopPeerRating
description: contacts.resetTopPeerRating parameters, return type and example
description: Reset top peer rating for a certain category/peer
---
## Method: contacts.resetTopPeerRating
[Back to methods index](index.md)
Reset top peer rating for a certain category/peer
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|category|[CLICK ME TopPeerCategory](../types/TopPeerCategory.md) | Yes|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|category|[CLICK ME TopPeerCategory](../types/TopPeerCategory.md) | Yes|The category |
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer|
### Return type: [Bool](../types/Bool.md)

View File

@ -1,16 +1,18 @@
---
title: messages.getMessages
description: messages.getMessages parameters, return type and example
description: Get messages
---
## Method: messages.getMessages
[Back to methods index](index.md)
Get messages
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)|
### Return type: [messages\_Messages](../types/messages_Messages.md)

View File

@ -1,17 +1,19 @@
---
title: contacts.resetTopPeerRating
description: contacts.resetTopPeerRating parameters, return type and example
description: Reset top peer rating for a certain category/peer
---
## Method: contacts.resetTopPeerRating
[Back to methods index](index.md)
Reset top peer rating for a certain category/peer
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|category|[CLICK ME TopPeerCategory](../types/TopPeerCategory.md) | Yes|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|category|[CLICK ME TopPeerCategory](../types/TopPeerCategory.md) | Yes|The category |
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer|
### Return type: [Bool](../types/Bool.md)

View File

@ -1,16 +1,18 @@
---
title: messages.getMessages
description: messages.getMessages parameters, return type and example
description: Get messages
---
## Method: messages.getMessages
[Back to methods index](index.md)
Get messages
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)|
### Return type: [messages\_Messages](../types/messages_Messages.md)

View File

@ -1,17 +1,19 @@
---
title: contacts.resetTopPeerRating
description: contacts.resetTopPeerRating parameters, return type and example
description: Reset top peer rating for a certain category/peer
---
## Method: contacts.resetTopPeerRating
[Back to methods index](index.md)
Reset top peer rating for a certain category/peer
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|category|[CLICK ME TopPeerCategory](../types/TopPeerCategory.md) | Yes|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|category|[CLICK ME TopPeerCategory](../types/TopPeerCategory.md) | Yes|The category |
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer|
### Return type: [Bool](../types/Bool.md)

View File

@ -1,16 +1,18 @@
---
title: messages.getMessages
description: messages.getMessages parameters, return type and example
description: Get messages
---
## Method: messages.getMessages
[Back to methods index](index.md)
Get messages
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)|
### Return type: [messages\_Messages](../types/messages_Messages.md)

View File

@ -508,12 +508,12 @@ class Lang
'method_contacts.getTopPeers_param_offset_type_int' => 'Initially 0, then `$offset += $contacts_TopPeers[\'categories\'][\'count\'];`',
'method_contacts.getTopPeers_param_limit_type_int' => 'How many results to fetch',
'method_contacts.getTopPeers_param_hash_type_int' => '',
'method_contacts.resetTopPeerRating' => '',
'method_contacts.resetTopPeerRating_param_category_type_TopPeerCategory' => '',
'method_contacts.resetTopPeerRating_param_peer_type_InputPeer' => '',
'method_contacts.resetTopPeerRating' => 'Reset top peer rating for a certain category/peer',
'method_contacts.resetTopPeerRating_param_category_type_TopPeerCategory' => 'The category ',
'method_contacts.resetTopPeerRating_param_peer_type_InputPeer' => 'The peer',
'method_contacts.resetSaved' => '',
'method_messages.getMessages' => '',
'method_messages.getMessages_param_id_type_Vector t' => '',
'method_messages.getMessages' => 'Get messages',
'method_messages.getMessages_param_id_type_Vector t' => 'The IDs of messages to fetch (only for users and normal groups)',
'method_messages.getDialogs' => '',
'method_messages.getDialogs_param_exclude_pinned_type_true' => '',
'method_messages.getDialogs_param_offset_date_type_int' => '',
@ -4459,15 +4459,15 @@ class Lang
'method_contacts.getTopPeers_param_phone_calls_type_true' => 'Fetch phone calls?',
'method_contacts.getTopPeers_param_groups_type_true' => 'Fetch groups?',
'method_contacts.getTopPeers_param_channels_type_true' => 'Fetch channels and supergroups?',
'method_contacts.getTopPeers_param_offset_type_int' => 'Initially 0, then $offset += count(',
'method_contacts.getTopPeers_param_limit_type_int' => '',
'method_contacts.getTopPeers_param_offset_type_int' => 'Initially 0, then `$offset += $contacts_TopPeers[\'categories\'][\'count\'];`',
'method_contacts.getTopPeers_param_limit_type_int' => 'How many results to fetch',
'method_contacts.getTopPeers_param_hash_type_int' => '',
'method_contacts.resetTopPeerRating' => '',
'method_contacts.resetTopPeerRating_param_category_type_TopPeerCategory' => '',
'method_contacts.resetTopPeerRating_param_peer_type_InputPeer' => '',
'method_contacts.resetTopPeerRating' => 'Reset top peer rating for a certain category/peer',
'method_contacts.resetTopPeerRating_param_category_type_TopPeerCategory' => 'The category ',
'method_contacts.resetTopPeerRating_param_peer_type_InputPeer' => 'The peer',
'method_contacts.resetSaved' => '',
'method_messages.getMessages' => '',
'method_messages.getMessages_param_id_type_Vector t' => '',
'method_messages.getMessages' => 'Get messages',
'method_messages.getMessages_param_id_type_Vector t' => 'The IDs of messages to fetch (only for users and normal groups)',
'method_messages.getDialogs' => '',
'method_messages.getDialogs_param_exclude_pinned_type_true' => '',
'method_messages.getDialogs_param_offset_date_type_int' => '',
@ -8063,4 +8063,4 @@ class Lang
'object_help.configSimple_param_ip_port_list_type_Vector t' => '',
'object_inputMessagesFilterMyMentionsUnread' => '',
);
}
}