Класс YandexMetricaPush

com.yandex.metrica.push

public final class YandexMetricaPush

Методы класса используются для работы с AppMetrica Push SDK.

Методы


void	init(@NonNull final Context ctx) Инициализирует библиотеку в приложении. Метод должен быть вызван после инициализации AppMetrica SDK.
void	init(@NonNull Context ctx, PushServiceControllerProvider... providers) Инициализирует библиотеку в приложении со списком push-транспортов. Метод должен быть вызван после инициализации AppMetrica SDK.
String	getToken() Внимание. Метод устарел. Используйте вместо него getTokens(). Возвращает используемый push-токен.
Map<String, String>	getTokens() Возвращает список токенов для push-провайдеров, с которыми была инициализирована AppMetrica Push SDK. Ключи могут принимать значения `firebase` , `hms`.
NotificationChannel	getDefaultNotificationChannel() Возвращает канал push-уведомлений `NotificationChannel`, который используется по умолчанию. Для него можно задать настройки c помощью методов NotificationChannel до получения первого push-уведомления.
void	setTokenUpdateListener(@NonNull TokenUpdateListener listener) Подписывает на изменения токена.


void	init(@NonNull final Context ctx) Инициализирует библиотеку в приложении. Метод должен быть вызван после инициализации AppMetrica SDK.
void	init(@NonNull Context ctx, PushServiceControllerProvider... providers) Инициализирует библиотеку в приложении со списком push-транспортов. Метод должен быть вызван после инициализации AppMetrica SDK.
String	getToken() Внимание. Метод устарел. Используйте вместо него getTokens(). Возвращает используемый push-токен.
Map<String, String>	getTokens() Возвращает список токенов для push-провайдеров, с которыми была инициализирована AppMetrica Push SDK. Ключи могут принимать значения `firebase` , `hms`.
NotificationChannel	getDefaultNotificationChannel() Возвращает канал push-уведомлений `NotificationChannel`, который используется по умолчанию. Для него можно задать настройки c помощью методов NotificationChannel до получения первого push-уведомления.
void	setTokenUpdateListener(@NonNull TokenUpdateListener listener) Подписывает на изменения токена.

Поля


String	OPEN_DEFAULT_ACTIVITY_ACTION	Intent action для выполнения Activity по умолчанию. Его можно использовать для обнаружения запуска приложения с помощью push-уведомления AppMetrica.
String	EXTRA_PAYLOAD	Произвольная строка данных, которая передается в push-уведомлении: В поле Дополнительные данные при отправке из интерфейса AppMetrica. В поле `data` при отправке с помощью Push API.


String	OPEN_DEFAULT_ACTIVITY_ACTION	Intent action для выполнения Activity по умолчанию. Его можно использовать для обнаружения запуска приложения с помощью push-уведомления AppMetrica.
String	EXTRA_PAYLOAD	Произвольная строка данных, которая передается в push-уведомлении: В поле Дополнительные данные при отправке из интерфейса AppMetrica. В поле `data` при отправке с помощью Push API.

Описание методов

init

void init(@NonNull final Context ctx)

Инициализирует библиотеку в приложении. Метод должен быть вызван после инициализации AppMetrica SDK.

Параметры:


ctx	Объект класса `Context`.

init

void init(@NonNull Context ctx, PushServiceControllerProvider... providers)

Инициализирует библиотеку в приложении со списком push-транспортов. Метод должен быть вызван после инициализации AppMetrica SDK.

Параметры:


ctx	Объект класса `Context`.
providers	Объекты классов `FirebasePushServiceControllerProvider`, `HmsPushServiceControllerProvider`.

Пример

YandexMetricaPush.init(
    getApplicationContext(),
    new FirebasePushServiceControllerProvider(this),
    new HmsPushServiceControllerProvider(this)
);
Скопировано

YandexMetricaPush.init(
    applicationContext,
    FirebasePushServiceControllerProvider(this),
    HmsPushServiceControllerProvider(this)
)
Скопировано

getToken

String getToken()

Внимание. Метод устарел. Используйте вместо него getTokens().

Возвращает используемый push-токен.

Возвращает:

Используемый push-токен или null, если токен еще не доступен.

getTokens

Map<String, String> getTokens()

Возвращает список токенов для push-провайдеров, с которыми была инициализирована AppMetrica Push SDK. Ключи могут принимать значения firebase , hms.

Возвращает:

Cписок токенов для push-провайдеров, с которыми была инициализирована AppMetrica Push SDK.

getDefaultNotificationChannel

NotificationChannel getDefaultNotificationChannel()

Возвращает канал push-уведомлений NotificationChannel, который используется по умолчанию. Для него можно задать настройки c помощью методов NotificationChannel до получения первого push-уведомления.

Возвращает:

Объект класса NotificationChannel, который используется по умолчанию.

setTokenUpdateListener

void setTokenUpdateListener(@NonNull TokenUpdateListener listener)

Подписывает на изменения токена.

Параметры:


listener	Объект класса TokenUpdateListener. Он будет вызван при получении первого токена или при его обновлении.

Описание полей

OPEN_DEFAULT_ACTIVITY_ACTION

public final String OPEN_DEFAULT_ACTIVITY_ACTION = "com.yandex.metrica.push.action.OPEN"

Intent action для выполнения Activity по умолчанию. Его можно использовать для обнаружения запуска приложения с помощью push-уведомления AppMetrica.

public class LaunchActivity extends Activity {

   @Override
   protected void onCreate(Bundle savedInstanceState) {
       super.onCreate(saveInstanceState);
       Intent intent = getIntent();
       String action = intent.getAction();
       if (YandexMetricaPush.OPEN_DEFAULT_ACTIVITY_ACTION.equals(action)) {
           // Handle the app start via AppMetrica push notification.
           ...
       }
   }

}
Скопировано

EXTRA_PAYLOAD

public final String EXTRA_PAYLOAD = ".extra.payload"

Произвольная строка данных, которая передается в push-уведомлении:

В поле Дополнительные данные при отправке из интерфейса AppMetrica.
В поле data при отправке с помощью Push API.