События ЕЛК (МП)
ShowELK
Описание: Отправляется, когда SDK успешно отобразил главный экран ELK, содержащий как минимум один виджет.
Условия отправки:
- SDK отобразил хотя бы один виджет на поверхности партнера.
- Включает даже случай, когда отображается только виджет с типом
UserInfoMiniпо умолчанию.
Пример:
| Платформа | Колбэк |
|---|---|
| Android | ShowELK |
| iOS | showELK |
Примечание: Это событие указывает на успешную инициализацию и отрисовку UI ELK.
HideELK
Описание: Отправляется, когда SDK не может отобразить ни один виджет, включая блок пользователя по умолчанию.
Условия отправки:
- SDK не может отобразить ни один виджет, и Партнер передал параметр
elkErrorTypeсо значениемNONEпри инициализации пользовательского интерфейса.
Пример:
| Платформа | Колбэк |
|---|---|
| Android | HideELK |
| iOS | hideELK |
Рекомендация для партнера: При получении этого колбэка партнер может реализовать отображение собственного экрана или виджетов вместо ELK.
ShowWidgetELK
Описание: Отправляется при отображении пользователю виджета.
Параметры:
widgetName: Название виджета, который отображен пользователю.
Алгоритм определения widgetName:
- Использует значение из параметра
widgetNameотображенного виджета. - Если параметр пуст или отсутствует, используется значение из параметра
typeвиджета.
Пример:
| Виджет | Платформа | Без widgetName | С widgetName |
|---|---|---|---|
| Блок пользователя | Android | ShowWidgetELK(widgetName: "UserInfoMini") | ShowWidgetELK(widgetName: "user_info") |
| iOS | showWidgetELK: widgetName-"UserInfoMini" | showWidgetELK: widgetName-"user_info" | |
| Выгоды (InfoCardLong) | Android | ShowWidgetELK(widgetName: "InfoCardLong") | ShowWidgetELK(widgetName: "spasibo") |
| iOS | showWidgetELK: widgetName-"InfoCardLong" | showWidgetELK: widgetName-"spasibo" |
ClickELK
Описание: Отправляется при нажатии пользователем на любой виджет в ELK.
Параметры:
widgetName: Название виджета, на который произошло нажатие.
Алгоритм определения widgetName:
- Использует значение из параметра
widgetNameвиджета, на который произошел клик. - Если параметр пуст или отсутствует, используется значение из параметра
typeвиджета.
Пример:
| Виджет | Платформа | Без widgetName | С widgetName |
|---|---|---|---|
| Блок пользователя | Android | ClickELK(widgetName: "UserInfoMini") | ClickELK(widgetName: "user_info") |
| iOS | clickELK: widgetName-"UserInfoMini" | clickELK: widgetName-"user_info" | |
| Выгоды (InfoCardLong) | Android | ClickELK(widgetName: "InfoCardLong") | ClickELK(widgetName: "spasibo") |
| iOS | clickELK: widgetName-"InfoCardLong" | clickELK: widgetName-"spasibo" |
ErrorELK
Описание: Отправляется при отображении экрана ошибки на главном экране ELK.
Условия отправки:
SDK не может отобразить ни один виджет (включая блок пользователя) и Партнер передал при инициализации параметр elkErrorType, отличный от NONE.
Пример:
| Платформа | Колбэк |
|---|---|
| Android | ErrorELK |
| iOS | errorELK |
ReloadELK
Описание: Отправляется после нажатия пользователем кнопки «Обновить» или аналогичной на виджете с ошибкой.
Условия отправки:
Пользователь нажал на кнопку перезагрузки/обновления на виджете с ошибкой.
Пример:
| Платформа | Колбэк |
|---|---|
| Android | ReloadELK |
| iOS | reloadELK |
Рекомендация для партнера: Используйте этот колбэк для регистрации действий пользователя по восстановлению работоспособности виджета.
WidgetErrorELK
Описание: Отправляется, когда SDK при запросе динамических данных для виджета получил ошибку от сервера партнера и не смог его отобразить.
Параметры:
widgetName: Название виджета, вызвавшего ошибку.httpStatusCode: HTTP-код статуса, полученный в ответе от партнера.partnerErrorCode: Код ошибки партнера, извлеченный из заголовка ответаx-elk-error-code. Если заголовок отсутствует, передаетсяnull(Android)/nil(iOS).
Пример:
| Платформа | Есть код от партнера | Нет кода от партнера |
|---|---|---|
| Android | WidgetErrorELK(widgetName: "user_info", httpStatusCode: 401, partnerErrorCode: "102") | WidgetErrorELK(widgetName: "ListSection", httpStatusCode: 401, partnerErrorCode: null) |
| iOS | widgetErrorELK: widgetName-"user_info", httpStatusCode-401, partnerErrorCode-"102" | widgetErrorELK: widgetName-"ListSection", httpStatusCode-401, partnerErrorCode-nil |
OpenWidgetELK
Описание: Сообщает партнеру о необходимости открытия указанного виджета из списка способов, заданных партнером.
Параметры:
widgetName: Имя виджета для открытия.clickCallback: Дополнительная строка для передачи партнеру.
Пример:
Android
OpenWidgetELK(widgetName: "Спасибо", clickCallback: "1 или любой другой текст")
Примечание: Этот колбэк пока применим только в Android, по вопросом отправки данного колбэка обращаться к Герасименко Никите