Показаны различия между двумя версиями страницы.
Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия | ||
ru:airlay:api:air-lay-web-socket [2024/04/01 11:07] Рыков Павел |
ru:airlay:api:air-lay-web-socket [2024/04/29 18:05] (текущий) Рыков Павел [Типы событий] |
||
---|---|---|---|
Строка 4: | Строка 4: | ||
Для получения уведомлений о наступление события фронтенд должен подключиться к сервису и отправить запрос на подписку на событий, | Для получения уведомлений о наступление события фронтенд должен подключиться к сервису и отправить запрос на подписку на событий, | ||
+ | |||
+ | ====== Адрес веб сокета ====== | ||
+ | < | ||
+ | wss:// | ||
+ | </ | ||
+ | |||
+ | ====== Запуск ====== | ||
+ | Для запуска сервера выполнить команду на сервере: | ||
+ | <code bach> | ||
+ | airlay-cli web_socket server | ||
+ | </ | ||
+ | |||
+ | ====== Настройки ====== | ||
+ | В файле '' | ||
+ | <code bach> | ||
+ | [webSocketEvents] | ||
+ | address = 0.0.0.0 | ||
+ | port = 8081 | ||
+ | </ | ||
+ | |||
====== Запрос ====== | ====== Запрос ====== | ||
Строка 30: | Строка 50: | ||
- notification - оповещение об уведомление(ид не обязателен) | - notification - оповещение об уведомление(ид не обязателен) | ||
- datasetUpdate - обновление набора данных | - datasetUpdate - обновление набора данных | ||
+ | - uploadFile - завершение загрузки в набор данных | ||
+ | - downloadFile - завершение скачивания объектов или отчетов | ||
==== Пример запроса ==== | ==== Пример запроса ==== | ||
Строка 56: | Строка 78: | ||
* message - сообщение " | * message - сообщение " | ||
* code - код ошибки | * code - код ошибки | ||
- | ==== Пример ==== | + | |
+ | ==== Статусы ответа ==== | ||
+ | |||
+ | * 200 - запрос выполнен корректно | ||
+ | * 400 - возникла ошибка при обработке запроса | ||
+ | |||
+ | ==== Коды ошибок ==== | ||
+ | |||
+ | * 1 - Token not set | ||
+ | * 2 - Invalid token | ||
+ | * 3 - User not exists | ||
+ | * 4 - Not access for dataset | ||
+ | * 5 - Inavlid request | ||
+ | ==== Пример | ||
< | < | ||
Строка 72: | Строка 107: | ||
} | } | ||
</ | </ | ||
- | ==== Статусы ответа ==== | ||
- | |||
- | * 200 - запрос выполнен корректно | ||
- | * 400 - возникла ошибка при обработке запроса | ||
- | |||
- | ==== Коды ошибок ==== | ||
- | |||
- | * 1 - Token not set | ||
- | * 2 - Invalid token | ||
- | * 3 - User not exists | ||
- | * 4 - Not access for dataset | ||
- | * 5 - Inavlid request | ||
- | |||
====== Сообщения от сервера ====== | ====== Сообщения от сервера ====== | ||