Перейти к основному содержимому

API библиотеки Push SDK

Обновлено: 2 сентября 2026

В этой статье приведено описание основных классов, методов и структур данных Push SDK, используемых при интеграции приложения с платформой edna.

Класс PushBroadcastReceiver​

Класс PushBroadcastReceiver предназначен для обработки событий Push SDK и получения уведомлений о регистрации устройства, доставке сообщений и возникновении ошибок.

Методы класса PushBroadcastReceiver​

МетодНазначениеКодОсновные параметры
onShortPushReceivedВызывается при получении короткого push-уведомления из FCM. Метод используется для обработки и отображения локального уведомления.protected void onShortPushReceived(Context context, String messageId, String alert, Bundle bundle)Контекст приложения:
- context — контекст приложения;
- messageId — идентификатор сообщения;
- alert — текст уведомления;
- bundle — атрибуты push-сообщения.
onLongPushReceivedВызывается при получении полного сообщения с push-сервера. Возвращает результат сохранения сообщения.protected boolean onLongPushReceived(Context context, List<PushMessage> pushMessages)Параметры:
- context — контекст приложения;
- pushMessages — список полученных сообщений.
messagesWereReadВызывается после получения информации о прочтении сообщений пользователем.protected void messagesWereRead(List<String> messageIds)Параметр:
- messageIds — идентификаторы прочитанных сообщений.
onStatusChangedВызывается при изменении регистрационного идентификатора приложения в push-сети.protected abstract void onStatusChanged(Context context, String registrationId)Параметры:
- context — контекст приложения;
- registrationId — регистрационный идентификатор.
onDeviceAddressChangedВызывается после изменения значения deviceAddress. Новый адрес необходимо передать на сервер приложения.protected abstract void onDeviceAddressChanged(Context context, String newDeviceAddress)Параметры:
- context — контекст приложения;
- newDeviceAddress — новый адрес устройства.
onDeviceAddressProblemsВызывается при ошибках, препятствующих получению deviceAddress.protected abstract void onDeviceAddressProblems(Context context, String errorCode)Параметры:
- context — контекст приложения;
- errorCode — код или описание ошибки.
onErrorВызывается при ошибках взаимодействия библиотеки с сервером. Рекомендуется использовать для логирования и систем crash-аналитики.protected abstract void onError(Context context, String errorCode)Параметры:
- context — контекст приложения;
- errorCode — код или описание ошибки.
onHideByActionВызывается после открытия уведомления во внешнем приложении при использовании параметра catchDeepLink=true.protected void onHideByAction(PushAction pushAction)Параметр:
- pushAction — информация о выполненном действии.

При использовании параметра catchDeepLink=true библиотека вызывает метод onHideByAction(). В нём можно выполнить дополнительную обработку события, например сохранить информацию в журнале приложения или отправить данные в систему аналитики. Пример обработки onHideByAction:

protected void onHideByAction(@NonNull PushAction pushAction) {
super.onHideByAction(pushAction);
Log.d("tag", "hide by action");
}

Объект PushMessage​

Метод onLongPushReceived() получает список объектов PushMessage, содержащих данные полного push-сообщения.

Параметры объекта PushMessage​

ПараметрТипОписание
messageIdStringУникальный идентификатор сообщения.
sentAtLongДата и время формирования сообщения.
shortMessageStringКраткий текст уведомления, который передается через push-сеть и отображается в области уведомлений.
fullMessageStringПолный текст сообщения в формате base64-encoded HTML.
securedBooleanПризнак защищенного сообщения.
readBooleanСтатус прочтения сообщения пользователем.
sessionKeyStringСессионный ключ, используемый библиотекой для аутентификации устройства на push-сервере.
pushAttributesStringДополнительные атрибуты уведомления.
подсказка

При необходимости вместе с сообщением можно передавать собственные пары ключ–значение (key-value). Дополнительные параметры доступны через объект PushAction и могут использоваться приложением при обработке уведомления.

Пример объекта PushMessage​

{
messageId: "1:10",
sentAt: "24.10.2012 12:41:57",
shortMessage: "Уважаемый, ФИО! Изменились ...",
fullMessage: "0KPQstCw0LbQsNC10LzRi9C5INC60LvQuNC10L3RgiEg0JjQt",
secured: true,
read: true,
sessionKey: sessionKey
}

Класс PushController​

Класс PushController предоставляет доступ к основным функциям библиотеки: регистрации устройства, работе с сообщениями, получению информации об устройстве и настройке поведения SDK.

Методы класса PushController​

МетодНазначение
getDeviceUid()Возвращает текущий идентификатор deviceUid.
setDeviceUid(String deviceUuid)Устанавливает пользовательское значение deviceUid. Используется, если требуется заменить встроенный механизм генерации идентификатора.
resetCounterSync()Сбрасывает счетчик непрочитанных сообщений. При сетевой ошибке или ошибке push-сервера генерирует исключение PushServerErrorException.
notifyMessageUpdateNeeded()Принудительно запускает загрузку новых сообщений с push-сервера.
notifyMessageRead(List<String> messageIds)Отмечает указанные сообщения как прочитанные. В качестве идентификаторов можно использовать messageId, полученный в onShortPushReceived(), PushMessage.messageId из onLongPushReceived() или Id, полученный при запросе истории сообщений через edna Connect.
getDeviceAddress()Возвращает текущее значение deviceAddress.
getVersion()Возвращает текущую версию библиотеки.
setLogPrefix(String logPrefix)Добавляет пользовательский префикс к сообщениям журнала библиотеки.
sendMessage(String context, boolean isSystem)Синхронно отправляет входящее сообщение на push-сервер. Для системных сообщений (например, typing) установите isSystem=true. При ошибке генерирует исключение PushServerErrorException.
sendMessageAsync(String context, boolean isSystem)Асинхронно отправляет входящее сообщение на push-сервер. Для системных сообщений установите isSystem=true.
getDeviceInfo()Возвращает объект PushDeviceInfoExternal с информацией об устройстве, используемой при регистрации на платформе edna.

Объект PushDeviceInfoExternal​

Метод getDeviceInfo() возвращает объект PushDeviceInfoExternal, содержащий сведения об устройстве, используемые при его регистрации на платформе edna.

Структура объекта PushDeviceInfoExternal​

class PushDeviceInfoExternal(
deviceAddress: String,
deviceUID: String,
deviceName: String,
systemName: String,
appPackage: String,
locale: String,
timezone: String,
notificationAlertAllowed: Boolean
)

Параметры объекта PushDeviceInfoExternal​

ПараметрТипОписание
deviceAddressStringУникальный адрес устройства на платформе edna.
deviceUIDStringУникальный идентификатор устройства.
deviceNameStringНаименование устройства.
systemNameStringНазвание операционной системы устройства.
appPackageStringИмя пакета мобильного приложения.
localeStringТекущая локаль устройства.
timezoneStringЧасовой пояс устройства.
notificationAlertAllowedBooleanПризнак, разрешено ли отображение push-уведомлений на устройстве.

Класс PushAction​

Класс PushAction предназначен для обработки действий пользователя с уведомлением. Класс является изолированным и имеет двух наследников: DeeplinkAction и ButtonAction.

Получить объект PushAction из данных, переданных в Intent, можно следующим образом:

PushAction action = intent.getExtras().getParcelable("action");
подсказка

В зависимости от типа действия пользователя объект action содержит экземпляр DeeplinkAction или ButtonAction.

Дополнительные параметры действия​

С помощью PushAction можно получить дополнительные параметры сообщения в формате key-value, переданные вместе с действием.

В примере ниже someKey — пользовательский ключ, для которого извлекается соответствующее значение:

intent?.extras?.getParcelable<PushAction>("action")?.let {
val extraParams = intent.extras?.getBundle("action_params")
val value = extraParams?.getString("someKey")
}

Методы класса PushAction​

МетодОписание
public String getAction()Возвращает действие, выполненное пользователем. При переходе по deeplink возвращает значение параметра deeplink. При нажатии кнопки возвращает значение параметра action, заданного для этой кнопки.
public String getTitle()Возвращает название кнопки, по которой пользователь выполнил действие. Для перехода по deeplink возвращает null.
public String getMessageId()Возвращает messageId — идентификатор уведомления, с которым связано действие пользователя.

Класс VoicePushController​

Класс VoicePushController предназначен для настройки внешнего вида и поведения интерфейса голосовых вызовов. С помощью класса можно настроить содержимое экранов входящего и активного вызова, стили элементов интерфейса, уведомления о вызове, мелодию звонка и параметры загрузки аудиофайлов.

Методы класса VoicePushController​

Метод/КлассОписание
setDefaultData()Настраивает содержимое и параметры отображения экранов голосового вызова.
Параметры:
- IncomingCallData — данные экрана входящего вызова.
- ActiveCallData — данные экрана активного вызова.
- NotificationData — данные уведомления о вызове.
- FileDownloadingSettings — параметры загрузки аудиофайлов.
- val callRingtone: String? — мелодия входящего вызова.
IncomingCallDataОпределяет содержимое экрана входящего вызова.
Параметры:
- val headerText: String — текст заголовка.
- val mainText: String — основной текст.
- val image: String — логотип. Может загружаться из ресурсов приложения или скачиваться при каждом вызове.
ActiveCallDataОпределяет содержимое экрана активного вызова.
Параметры:
- val headerText: String — текст заголовка.
- val mainText: String — основной текст.
- val image: String — логотип. Может загружаться из ресурсов приложения или скачиваться при каждом вызове.
NotificationDataОпределяет содержимое уведомления о голосовом вызове.
Параметры:
- val headerText: String — текст заголовка.
- val mainText: String — основной текст.
- val image: String — логотип. Может загружаться из ресурсов приложения или скачиваться при каждом вызове.
FileDownloadingSettingsОпределяет параметры загрузки аудиофайлов.
Параметры:
- val downloadingAttemptsCellular: Int — количество попыток загрузки файла при использовании мобильного интернета.
- val downloadingAttemptsWifi: Int — количество попыток загрузки файла при использовании Wi-Fi.
setDefaultStyle()Настраивает стили элементов интерфейса экранов голосового вызова.
Параметры:
- incomingCallStyles — стили экрана входящего вызова.
- activeCallStyles — стили экрана активного вызова.
incomingCallStylesОпределяет стили элементов экрана входящего вызова.
Параметры:
- val background: String? — фон экрана.
- val headerText: TextStyle — стиль заголовка.
- val mainText: TextStyle — стиль основного текста.
- val image: String? — изображение.
- val acceptButton: ButtonStyle? — стиль кнопки принятия вызова.
- val declineButton: ButtonStyle? — стиль кнопки отклонения вызова.
activeCallStylesОпределяет стили элементов экрана активного вызова.
Параметры:
- val background: String? — фон экрана.
- val headerText: TextStyle — стиль заголовка.
- val mainText: TextStyle — стиль основного текста.
- val image: String? — изображение.
- val speakerButton: ButtonStyle? — стиль кнопки выбора аудиоустройства.
- val endCallButton: ButtonStyle? — стиль кнопки завершения вызова.
- val isCallDecoratorEnabled: Boolean — включает или отключает декоративное оформление экрана вызова.
ButtonStyleОпределяет стиль кнопок на экранах голосового вызова.
Параметры:
- val size: Int? — размер кнопки. Рекомендуется использовать значение TypedValue.
- val src: String? — ссылка на изображение кнопки.
- val buttonText: TextStyle? — стиль текста кнопки.
TextStyleОпределяет стиль текста на экранах голосового вызова.
Параметры:
- val color: Int? — цвет текста.
- val size: Float? — размер текста.
- val font: FontStyle? — шрифт текста.

Класс VoicePushBroadcastReceiver​

Класс VoicePushBroadcastReceiver предназначен для обработки событий, возникающих при работе библиотеки с голосовыми уведомлениями. С его помощью можно обработать получение нового голосового уведомления и ошибки, возникшие при его обработке.

Методы класса VoicePushBroadcastReceiver​

МетодКогда вызываетсяКодПараметры
onVoicePushActionПри получении нового голосового уведомления.protected open fun onVoicePushAction(context: Context, voicePushEvent: VoicePushData): {}context — контекст приложения.
voicePushData — данные голосового уведомления.
Содержит:
- val voiceMessageId: String — идентификатор сообщения.
- val audioFullLength: String — длительность аудиофайла.
- val audioListenLength: String — длительность прослушанной части аудиофайла.
- val reactionKey: Int? — идентификатор кнопки, выбранной пользователем в качестве реакции.
onVoicePushErrorПри возникновении ошибки при обработке голосового уведомления.protected open fun onVoicePushError(context: Context, voicePushError: VoicePushError): {}context — контекст приложения.
voicePushError — данные об ошибке.
Содержит val errorMessage: String — текст ошибки.