MadelineProtoDocs/docs/API_docs/methods/messages_searchGlobal.md

57 lines
1.7 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
title: messages.searchGlobal
description: Global message search
2018-04-04 19:52:48 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2018-04-01 13:19:25 +02:00
---
2018-04-05 01:19:57 +02:00
# Method: messages.searchGlobal
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
Global message search
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2019-06-24 15:45:02 +02:00
|folder\_id|[int](../types/int.md) | Folder ID | Optional|
2018-08-29 11:18:25 +02:00
|q|[string](../types/string.md) | The query | Yes|
2019-06-23 13:07:51 +02:00
|offset\_rate|[int](../types/int.md) | Offset rate | Yes|
2018-08-29 11:18:25 +02:00
|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | 0 or the peer offset | Optional|
|offset\_id|[int](../types/int.md) | 0 or the message ID offset | Yes|
|limit|[int](../types/int.md) | The number of results to return | Yes|
2018-04-01 13:19:25 +02:00
### Return type: [messages\_Messages](../types/messages_Messages.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();
2019-06-24 15:45:02 +02:00
$messages_Messages = $MadelineProto->messages->searchGlobal(['folder_id' => int, 'q' => 'string', 'offset_rate' => int, 'offset_peer' => InputPeer, 'offset_id' => int, 'limit' => int, ]);
2018-04-01 13:19:25 +02:00
```
Or, if you're into Lua:
```lua
2019-06-24 15:45:02 +02:00
messages_Messages = messages.searchGlobal({folder_id=int, q='string', offset_rate=int, offset_peer=InputPeer, offset_id=int, limit=int, })
2018-04-01 13:19:25 +02:00
```
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|SEARCH_QUERY_EMPTY|The search query is empty|
2018-04-01 13:19:25 +02:00