StaticsApi. Запросы
API для получения базовой информации с вашего сервера и отправки на сервер возможных токенов.
Получение всех переводов
Получение переводов данного языка из конкретной версии.
Если запрос прошел успешно, вы получите объект VMSTranslationObject
.
@GET(DICTIONARY)
suspend fun getTranslations(
@Query(LANGUAGE) language: String,
@Query(REVISION) revision: Int
): VMSTranslations
VMSTranslationsRequest
Объект с необходимой информацией для получения переводов.
init(language: VMSLanguage, revision: Int)
language
— может быть ru
или en
.
revision
— номер ревизии, из которой вы получите изменения в переводах. Установите значение 0
, чтобы получить все переводы.
Статика
Получение базовой информации, необходимой для плеера.
Если запрос прошел успешно, вы получите объект VMSStatic
.
@GET(STATIC)
suspend fun getStatics(): VMSStatics
VMSStatic
Объект, который вы получаете с сервера, с информацией, необходимой для запуска некоторых функций.
camera_issues
— проблемы, по которым можно отправить отчет на сервер.
video_rates
— скорость видео, доступная плееру.
mark_types
— доступные типы пользовательских событий.
analytic_types
— типы событий аналитики, доступные пользователю.
analytic_cases
— типы кейсов аналитики, доступные пользователю.
analytic_events
— типы событий кейсов аналитики, доступные пользователю.
Базовая статика
Получение информации, необходимой для продолжения входа в систему.
Если запрос прошел успешно, вы получите объект VMSBasicStatic
.
@GET(STATIC_BASIC)
suspend fun getBasicStatic(): VMSBasicStatic
VMSBasicStatic
Объект, который вы получаете с сервера, с информацией, необходимой для правильного входа в систему.
is_captcha_available
— true
, если вам нужна информация о капче для входа в систему.
is_external_auth_enabled
— true
, если вы можете войти в систему с помощью внешнего сервиса.
version
— текущая версия backend.
Токены
FCM (для пушей Google)
Отправьте токен FCM на сервер, если у вас есть firebase.
@PUT(DEVICE)
suspend fun sendFcmToken(@Body fcmRequest: VMSFcmRequest): Response<ResponseBody>
HMS (для пушей Huawei)
Отправьте токен HMS на сервер, если вы его используете.
@PUT(DEVICE)
suspend fun sendHuaweiToken(@Body fcmRequest: VMSHuaweiRequest): Response<ResponseBody>