MadelineProto/old_docs/API_docs_v71/methods/messages_searchGlobal.md

78 lines
1.8 KiB
Markdown
Raw Normal View History

2017-10-14 11:50:46 +02:00
---
title: messages.searchGlobal
2018-03-23 16:23:49 +01:00
description: Global message search
2017-10-14 11:50:46 +02:00
---
## Method: messages.searchGlobal
[Back to methods index](index.md)
2018-03-23 16:23:49 +01:00
Global message search
2017-10-14 11:50:46 +02:00
### Parameters:
2018-03-23 16:23:49 +01:00
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
2018-03-27 14:41:50 +02:00
|q|[string](../types/string.md) | Yes|The query|
|offset\_date|[int](../types/int.md) | Yes|0 or the date offset|
2018-03-23 16:23:49 +01:00
|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset|
2018-03-27 14:41:50 +02:00
|offset\_id|[int](../types/int.md) | Yes|0 or the message ID offset|
|limit|[int](../types/int.md) | Yes|The number of results to return|
2017-10-14 11:50:46 +02:00
### Return type: [messages\_Messages](../types/messages_Messages.md)
### Can bots use this method: **NO**
2018-03-20 19:57:36 +01:00
### MadelineProto Example:
2017-10-14 11:50:46 +02:00
```
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
2017-10-14 11:50:46 +02:00
}
include 'madeline.php';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
2017-10-14 11:50:46 +02:00
$messages_Messages = $MadelineProto->messages->searchGlobal(['q' => 'string', 'offset_date' => int, 'offset_peer' => InputPeer, 'offset_id' => int, 'limit' => int, ]);
```
2018-03-20 19:57:36 +01:00
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
2017-10-14 11:50:46 +02:00
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.searchGlobal`
Parameters:
q - Json encoded string
offset_date - Json encoded int
offset_peer - Json encoded InputPeer
offset_id - Json encoded int
limit - Json encoded int
Or, if you're into Lua:
```
messages_Messages = messages.searchGlobal({q='string', offset_date=int, offset_peer=InputPeer, offset_id=int, limit=int, })
```
2018-03-27 14:41:50 +02:00
### Errors this method can return:
| Error | Description |
|----------|---------------|
|SEARCH_QUERY_EMPTY|The search query is empty|