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

Интеграция библиотеки

Обновлено: 2 сентября 2026
к сведению

Библиотека поддерживает приложения на базе ОС Android версии 6.0 и выше (minSdk 21) и работает с PNS-сервисом Firebase Cloud Messaging (FCM) версии 22.0.0. Рекомендуемые версии: compileSdk — 36; targetSdk — 36.

Порядок интеграции библиотеки:

  1. Обновление файла AndroidManifest.xml.
  2. Добавление зависимостей в файлы build.gradle.
  3. Создание класса-наследника PushBroadcastReceiver.
  4. Инициализация Firebase.
  5. Добавление кода инициализации библиотеки.
  6. Настройка сборки приложения в консоли администрирования.

Обновление файла AndroidManifest.xml​

Для настройки интеграции библиотеки в приложение скопируйте разрешения ниже и добавьте их в файл AndroidManifest.xml. Также зарегистрируйте класс-наследник PushBroadcastReceiver.

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android">

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

<permission
android:name="[APP_PACKAGE_NAME].permission.pushserver.RECEIVE"
android:protectionLevel="signature" />

<uses-permission android:name="[APP_PACKAGE_NAME].permission.pushserver.RECEIVE" />

<application>

<!-- Setting up Push Lib -->
<receiver
android:name="[PUSH_BROADCAST_RECEIVER]"
android:exported="false"
android:permission="[APP_PACKAGE_NAME].permission.pushserver.RECEIVE">
<intent-filter>
<action android:name="com.pushserver.android.NEW_PUSH_MESSAGE_EVENT" />
<action android:name="com.pushserver.android.LONG_MESSAGES_RECEIVED" />
<action android:name="com.pushserver.android.MESSAGES_WERE_READ" />
<action android:name="com.pushserver.android.RECEIVER_CHANGED_EVENT" />
<action android:name="com.pushserver.android.DEVICE_ADDRESS_CHANGED_EVENT" />
<action android:name="com.pushserver.android.HIDE_PUSH_MESSAGE_EVENT" />
<action android:name="com.pushserver.android.ERROR_EVENT" />
</intent-filter>
</receiver>

</application>
</manifest>

Используйте следующие значения параметров:

  • PUSH_BROADCAST_RECEIVER — путь к классу-наследнику PushBroadcastReceiver, который обрабатывает события библиотеки;
  • APP_PACKAGE_NAME — полное имя пакета приложения.

Добавление зависимостей в Gradle​

Добавьте зависимости в корневой файл build.gradle и файл build.gradle приложения.

warning

Начиная с версии 3.6.4 рекомендуется использовать интеграцию с BOM, особенно если приложение использует облака Huawei и RuStore.

Дополнение в корневой файл build.gradle​

buildscript {
ext.kotlin_version = "2.2.20"

dependencies {
classpath 'com.google.gms:google-services:4.4.4'
}
}

allprojects {
repositories {
google()
jcenter()

maven {
url 'https://maven-pub.edna.ru/repository/maven-public'
}
}
}

Дополнение в файл app/build.gradle с использованием BOM Рекомендуемый вариант​

apply plugin: 'com.google.gms.google-services'

android {
compileSdkVersion 36

defaultConfig {
minSdkVersion 21
targetSdkVersion 36
}
}

compileOptions {
sourceCompatibility JavaVersion.VERSION_17
targetCompatibility JavaVersion.VERSION_17
}

kotlinOptions {
jvmTarget = '17'
}

dependencies {
releaseImplementation platform('com.edna.android:push-lite-bom-release:3.19.0')
debugImplementation platform('com.edna.android:push-lite-bom-debug:3.19.0')
}

Дополнение в файл app/build.gradle без использования BOM​

apply plugin: 'com.google.gms.google-services'

android {
compileSdkVersion 36

defaultConfig {
minSdkVersion 26
targetSdkVersion 36
}
}

compileOptions {
sourceCompatibility JavaVersion.VERSION_17
targetCompatibility JavaVersion.VERSION_17
}

kotlinOptions {
jvmTarget = '17'
}

dependencies {
roomVersion = '2.5.0' // или выше, если ранее использовался

debugImplementation 'com.edna.android:push-lite-debug:3.19.0'
releaseImplementation 'com.edna.android:push-lite-release:3.19.0'
}
warning

Debug- и release-версии библиотеки работают с разными серверами. Для сборок приложений, которые публикуются в Google Play, используйте только push-lite-release.

подсказка

Начиная с версии 3.8.0 для тестирования используйте Gradle 8.1.1 или выше. Если используется устаревший Transform API, добавьте в файл gradle.properties следующую строку:

android.experimental.legacyTransform.forceNonIncremental=true

Интеграция библиотеки в приложение​

Для интеграции используются следующие основные классы:

  • PushController — предоставляет доступ к функциям библиотеки;
  • PushBroadcastReceiver — используется для получения событий библиотеки.

Инициализация библиотеки​

Для инициализации библиотеки вызовите метод PushController.getInstance(this).init().

подсказка

Выполняйте инициализацию в методе Application.onCreate при запуске приложения.

После инициализации библиотека вызывает callback-метод onDeviceAddressChanged. После этого deviceAddress можно использовать для отправки push-сообщений на мобильное устройство.

Обработка событий библиотеки​

Создайте класс-наследник PushBroadcastReceiver и реализуйте в нём обработку событий библиотеки. Основные методы:

  • onDeviceAddressChanged — вызывается при изменении deviceAddress, уникального идентификатора приложения на push-сервере. По этому идентификатору push-уведомления отправляются в приложение через push-сервис edna. После авторизации пользователя в приложении передайте deviceAddress на бэкенд и свяжите его с пользователем для последующей отправки сообщений;
  • onShortPushRecieved — вызывается для обработки и отображения уведомления приложением.
подсказка

Описание остальных методов PushBroadcastReceiver доступно в статье:

File IconAPI библиотеки Push SDK

Автоматическое отображение коротких уведомлений​

Начиная с версии 3.3.0 метод onShortPushRecieved выполняется по умолчанию. Если метод не переопределён в классе-наследнике или в нём вызывается super, библиотека автоматически отображает уведомление.

Для настройки отображения уведомлений библиотека поддерживает дополнительные параметры, передаваемые вместе с сообщением. Например, библиотека автоматически отображает логотипы, передаваемые сервисом «Красивый чек».

File IconОбзор модуля «Красивый чек»

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

ПараметрОписание
titleЗаголовок уведомления.
logoURL

URL иконки для отображения в уведомлении. Можно передать URL изображения или имя ресурса приложения из res/drawable без указания расширения. Для URL поддерживаются форматы jpg и png, для ресурсов приложения — jpg, png и XML. Рекомендуемое соотношение сторон — 1:1.

bigContentText

Альтернативный текст для расширенного уведомления. На некоторых устройствах отображается вместо основного текста для обоих видов уведомлений.

bigContentTitle

Альтернативный заголовок для расширенного уведомления. На некоторых устройствах отображается вместо основного заголовка для обоих видов уведомлений.

bigContentLogoURL

Изображение для расширенного уведомления. Рекомендуемое соотношение сторон — 2:1. При другом соотношении изображение может быть обрезано. При использовании кнопок изображение дополнительно обрезается по высоте. Можно передать URL изображения или имя ресурса приложения из res/drawable без указания расширения.

thumbnailIconURL

Иконка для отображения в строке состояния устройства. По умолчанию используется основная иконка приложения. Рекомендуемое соотношение сторон — 1:1. Можно передать URL изображения или имя ресурса приложения из res/drawable без указания расширения.

NotificationChannel

Канал уведомлений Android, в котором отображается уведомление. Если канал с указанным идентификатором отсутствует, он будет создан автоматически. Если параметр не указан, используется канал по умолчанию — Default channel.

deeplink

Строка, передаваемая в Intent при переходе по уведомлению.

actions

JSON-массив с названиями кнопок уведомления и действиями, выполняемыми при их нажатии. Передается в виде строки.

sound

Звуковой файл уведомления или канала уведомлений. Файл должен находиться в каталоге res/raw. Имя файла передается без расширения.

vibrate

Шаблон вибрации. Целочисленный массив с длительностью включения и выключения вибромотора в миллисекундах. Первое значение соответствует начальному выключенному состоянию.

lights

Цвет светового индикатора в формате RGB (HEX). Если устройство поддерживает ограниченную палитру, будет выбран ближайший доступный цвет. Если световой индикатор отсутствует, параметр игнорируется.

thumbnailIconColor

Цвет иконки, кнопок и вспомогательного текста уведомления в формате RGB (HEX). По умолчанию используется цвет из текущей темы устройства.

warning

На Android 7 и ниже параметры sound, vibrate и lights устанавливаются для каждого сообщения. На Android 8 и выше эти параметры задаются при создании канала уведомлений NotificationChannel. После создания канала изменить его настройки невозможно. Чтобы использовать новый набор параметров, создайте новый канал.

Все параметры опциональны. Если параметр не передан, соответствующая возможность уведомления не используется. Пример передачи всех доступных параметров:

{
"title" : "Заголовок",
"thumbnailIconURL" : "https://.../icon.png",
"logoURL" : "https://.../logo.png",
"bigContentText" : "Альтернативный текст уведомления",
"bigContentTitle" : "Альтернативный заголовок уведомления",
"bigContentLogoURL" : "https://.../picture.png",
"NotificationChannel" : "Имя канала уведомлений",
"deeplink" : "test://deeplink_action",
"actions" : "[{\"title\":\"Кнопка 1\", \"action\":\"test://button1_action\"}, {\"title\":\"Кнопка 2\", \"action\":\"test://button2_action\"}]",
"sound" : "ring",
"vibrate" : "[200,500,200,500,200]",
"lights" : "#00ff00",
"thumbnailIconColor" : "#006060"
}

Автоматическое отображение длинных уведомлений​

Начиная с версии 3.7.0 библиотека поддерживает автоматическое отображение уведомлений в методе onLongPushRecieved. Для длинных уведомлений используется тот же набор параметров, что и для onShortPushRecieved. Текст уведомления передается в параметре pushNotificationText.

ПараметрОписание
pushNotificationTextТекст уведомления, отображаемый методом onLongPushRecieved. Если параметр не указан, используется значение alert, полученное в onShortPushRecieved.

Для формирования сообщения в fullMessage передайте параметры в виде строки с JSON-объектом.

Пример значения fullMessage:

{"pushNotificationText":"Оплата 999.00р Карта*9999 SHOP Баланс 9999.99р 13:00"}

Чтобы включить отображение содержимого полного сообщения, добавьте в манифест приложения следующий параметр:

<meta-data
android:name="com.pushserver.android.useFullContentForAutodraw"
android:value="true" />

Если useFullContentForAutodraw = true, сообщение содержит дополнительный контент, а для автоотрисовки используются методы по умолчанию, уведомление отображается в onLongPushRecieved.

warning

При отображении уведомления данные из pushAttributes имеют более высокий приоритет, чем данные из fullMessage.

Обработка действий пользователя с уведомлением​

к сведению

Начиная с версии 3.5.0 изменена обработка нажатий на уведомления и кнопки уведомлений в связи с ограничениями Android 12 (API level 31).

Чтобы обрабатывать действия пользователя, добавьте в intent-filter класса-наследника PushBroadcastReceiver действие HIDE_PUSH_MESSAGE_EVENT.

<receiver
android:name=".push.CustomPushBroadcastReceiver"
android:exported="false"
android:permission="com.edna.push.demo_lite.permission.pushserver.RECEIVE">

<intent-filter>
<action android:name="com.pushserver.android.NEW_PUSH_MESSAGE_EVENT" />
<action android:name="com.pushserver.android.LONG_MESSAGES_RECEIVED" />
<action android:name="com.pushserver.android.MESSAGES_WERE_READ" />
<action android:name="com.pushserver.android.RECEIVER_CHANGED_EVENT" />
<action android:name="com.pushserver.android.DEVICE_ADDRESS_CHANGED_EVENT" />
<action android:name="com.pushserver.android.HIDE_PUSH_MESSAGE_EVENT" />
<action android:name="com.pushserver.android.ERROR_EVENT" />
</intent-filter>

</receiver>

При нажатии на уведомление или кнопку пользователь будет перенаправлен в приложение. В стартовый Activity приложения передается Intent с данными уведомления. Приложение может обработать эти данные и открыть соответствующий экран. Для получения информации о выполненном действии используйте класс PushAction.

Пример обработки перехода пользователя по уведомлению в методах onCreate и onNewIntent стартового Activity:

PushAction action = intent.getExtras().getParcelable("action");

if (action != null) {
String destinationActivity = action.getAction();

// TODO: Выполнить навигацию пользователя с учётом значения action
}