MadelineProtoDocs/old_docs/API_docs_v42/methods/help.setBotUpdatesStatus.md

54 lines
1.7 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
2020-09-12 12:47:38 +02:00
title: help.setBotUpdatesStatus
description: Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only
2018-04-04 19:52:48 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2020-09-12 12:47:38 +02:00
redirect_from: /API_docs/methods/help_setBotUpdatesStatus.html
2018-04-01 13:19:25 +02:00
---
2020-09-12 12:47:38 +02:00
# Method: help.setBotUpdatesStatus
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
2020-09-12 12:47:38 +02:00
Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only
2018-04-01 13:19:25 +02:00
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2020-09-12 12:47:38 +02:00
|pending\_updates\_count|[int](../types/int.md) | Number of pending updates | Yes|
|message|[string](../types/string.md) | Error message, if present | Yes|
2018-04-01 13:19:25 +02:00
### Return type: [Bool](../types/Bool.md)
2019-08-15 20:25:16 +02:00
### Can bots use this method: **YES**
2018-04-01 13:19:25 +02:00
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();
2020-09-12 12:47:38 +02:00
$Bool = $MadelineProto->help->setBotUpdatesStatus(['pending_updates_count' => int, 'message' => 'string', ]);
2018-04-01 13:19:25 +02:00
```
Or, if you're into Lua:
```lua
2020-09-12 12:47:38 +02:00
Bool = help.setBotUpdatesStatus({pending_updates_count=int, message='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.