@firebase/messaging

Функции

Функция	Описание
функция (приложение, ...)
getMessaging (приложение)	Получает экземпляр Firebase Cloud Messaging.
функция (обмен сообщениями, ...)
deleteToken (обмен сообщениями)	Удаляет регистрационный токен, связанный с этим экземпляром Messaging , и отписывает экземпляр Messaging от принудительной подписки.
getToken(обмен сообщениями, параметры)	Подписывает экземпляр Messaging на push-уведомления. Возвращает регистрационный токен Firebase Cloud Messaging, который можно использовать для отправки push-сообщений в этот экземпляр Messaging . Если разрешение на уведомление еще не предоставлено, этот метод запрашивает разрешение у пользователя. Возвращенное обещание отклоняется, если пользователь не разрешает приложению отображать уведомления.
onMessage(обмен сообщениями, nextOrObserver)	Когда получено push-сообщение и пользователь в данный момент находится на странице вашего источника, сообщение передается на страницу, и событие onMessage() отправляется с полезными данными push-сообщения.
функция()
isSupported()	Проверяет, существуют ли в браузере все необходимые API.

Интерфейсы

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

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

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

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

Подпись:

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

Параметры

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

Возврат:

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

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

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

deleteToken (обмен сообщениями)

Удаляет регистрационный токен, связанный с этим экземпляром Messaging , и отписывает экземпляр Messaging от принудительной подписки.

Подпись:

export declare function deleteToken(messaging: Messaging): Promise<boolean>;

Параметры

Параметр	Тип	Описание
обмен сообщениями	Обмен сообщениями	Экземпляр обмена сообщениями .

Возврат:

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

Обещание выполняется, когда токен успешно удален.

getToken(обмен сообщениями, параметры)

Подписывает экземпляр Messaging на push-уведомления. Возвращает регистрационный токен Firebase Cloud Messaging, который можно использовать для отправки push-сообщений в этот экземпляр Messaging .

Если разрешение на уведомление еще не предоставлено, этот метод запрашивает разрешение у пользователя. Возвращенное обещание отклоняется, если пользователь не разрешает приложению отображать уведомления.

Подпись:

export declare function getToken(messaging: Messaging, options?: GetTokenOptions): Promise<string>;

Параметры

Параметр	Тип	Описание
обмен сообщениями	Обмен сообщениями	Экземпляр обмена сообщениями .
параметры	GetTokenOptions	Предоставляет дополнительный пустой ключ и дополнительную регистрацию сервисного работника.

Возврат:

Обещание<строка>

Промис разрешается с помощью регистрационного токена FCM.

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

Когда получено push-сообщение и пользователь в данный момент находится на странице вашего источника, сообщение передается на страницу, и событие onMessage() отправляется с полезными данными push-сообщения.

Подпись:

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

Параметры

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

Возврат:

Отписаться

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

функция()

isSupported()

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

Подпись:

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

Возврат:

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

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