# searchContact

Версия: 4.2.0

Описание: поиск контактов на сервере.

Результаты поиска кешируются. Время жизни записи кеша - 5 минут. Также есть ограничение на частоту запросов. Доступен один запрос на поиск в 20 секунд. Если в этот период таймаута будет сделан запрос с новой строкой поиска, вернется соответствующая ошибка, если со строкой, которая уже запрашивалась - закешированный результат.

Пример запроса:

{
    "method" : "searchContact",
    "searchingString" : "us",
    "searchingMask" : 7,
    "searchingTimeoutMsec" : 2000
}

Пример ответа:

{
    "method": "searchContact",
    "requestId": "",
    "searchingResult": 0,
    "foundContacts": [{
        "peerId": "user1@some.server",
        "displayName": "U1"
    }, {
        "peerId": "user2@some.server",
        "displayName": "U2"
    }, {
        "peerId": "user3@some.server",
        "displayName": "U3"
    }],
    "result": true
}

Описание параметров:

searchingResult - строка, по которой будет произведен поиск
searchingTimeoutMsec - таймаут для поиска и выдачи ответа, в миллисекундах. Доступный диапазон значений - 1..20000
searchingMask - маска, обозначающее места поиска. Доступные места:
- 1 - поиск по уникальному идентификатору пользователя
- 2 - поиск по отображаемому имени пользователя
- 4 - поиск по e-mail пользователя
searchingResult - результат поиска. Возможные значения:
- 0 - запрос успешно выполнен, таймауты не достигнуты, найден как минимум один контакт
- 1 - запрос успешно выполнен, таймауты не достигнуты, ни один контакт не найден
- 2 - запрос успешно выполнен, найден как минимум один контакт, но поиск прерван таймаутом
- 3 - запрос успешно выполнен, ни один контакт не найден, поиск прерван таймаутом
- 4 - запрос не выполнен из-за некорректных переданных параметров
- 5 - запрос не выполнен, т.к. не прошел таймаут для нового поиска на сервере
requestId - уникальный идентификатор запроса
foundContacts - список найденных контактов
peerId - уникальный идентификатор найденного контакта
displayName - отображаемое имя найденного контакта

См. также: