@firebase/messaging/sw

Функции

Функция	Описание
функция (приложение, ...)
getMessaging (приложение)	Получает экземпляр Firebase Cloud Messaging.
функция (обмен сообщениями, ...)
экспериментальныйSetDeliveryMetricsExportedToBigQueryEnabled (обмен сообщениями, включение)	Включает или отключает экспорт показателей доставки сообщений Firebase Cloud Messaging в BigQuery. По умолчанию показатели доставки сообщений не экспортируются в BigQuery. Используйте этот метод, чтобы включить или отключить экспорт во время выполнения.
onBackgroundMessage (обмен сообщениями, nextOrObserver)	Вызывается при получении сообщения, когда приложение находится в фоновом режиме. Приложение считается работающим в фоновом режиме, если не отображается активное окно.
функция()
isSupported()	Проверяет, существуют ли все необходимые API в контексте ПО.

Интерфейсы

Интерфейс	Описание
FcmOptions	Параметры функций, предоставляемых FCM SDK для Интернета. См. WebpushFcmOptions. .
GetTokenOptions	Параметры getToken() .
Полезная нагрузка сообщения	Полезная нагрузка сообщения, содержащая полезную нагрузку уведомления, представленную NotificationPayload , и полезную нагрузку данных, содержащую произвольное количество пар ключ-значение, отправленных разработчиками через API отправки. .
Обмен сообщениями	Открытый интерфейс Firebase Cloud Messaging SDK.
УведомлениеПолезная нагрузка	Отобразить детали уведомления. Подробности отправляются через API отправки. .

функция (приложение, ...)

getMessaging (приложение)

Получает экземпляр Firebase Cloud Messaging.

Подпись:

export declare function getMessagingInSw(app?: FirebaseApp): Messaging;

Параметры

Параметр	Тип	Описание
приложение	FirebaseApp

Возврат:

Обмен сообщениями

Экземпляр Firebase Cloud Messaging, связанный с предоставленным приложением Firebase.

функция (обмен сообщениями, ...)

экспериментальныйSetDeliveryMetricsExportedToBigQueryEnabled (обмен сообщениями, включение)

Включает или отключает экспорт показателей доставки сообщений Firebase Cloud Messaging в BigQuery. По умолчанию показатели доставки сообщений не экспортируются в BigQuery. Используйте этот метод, чтобы включить или отключить экспорт во время выполнения.

Подпись:

export declare function experimentalSetDeliveryMetricsExportedToBigQueryEnabled(messaging: Messaging, enable: boolean): void;

Параметры

Параметр	Тип	Описание
обмен сообщениями	Обмен сообщениями	Экземпляр FirebaseMessaging .
давать возможность	логическое значение	Должен ли Firebase Cloud Messaging экспортировать показатели доставки сообщений в BigQuery.

Возврат:

пустота

onBackgroundMessage (обмен сообщениями, nextOrObserver)

Вызывается при получении сообщения, когда приложение находится в фоновом режиме. Приложение считается работающим в фоновом режиме, если не отображается активное окно.

Подпись:

export declare function onBackgroundMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;

Параметры

Параметр	Тип	Описание
обмен сообщениями	Обмен сообщениями	Экземпляр обмена сообщениями .
СледующийОрОбсервер	ДалееFn < Полезная нагрузка сообщения > | наблюдатель < Полезная нагрузка сообщения >	Эта функция или объект-наблюдатель с определением next вызывается, когда получено сообщение и приложение в данный момент находится в фоновом режиме.

Возврат:

Отписаться

Чтобы прекратить прослушивание сообщений, выполните эту возвращаемую функцию

функция()

isSupported()

Проверяет, существуют ли все необходимые API в контексте ПО.

Подпись:

export declare function isSwSupported(): Promise<boolean>;

Возврат:

Обещание <логическое значение>

Обещание, которое преобразуется в логическое значение.