firebase-admin.messaging package

Облачный обмен сообщениями Firebase (FCM).

Функции

Функция Описание
getMessaging (приложение) Получает службу обмена сообщениями для приложения по умолчанию или заданного приложения. admin.messaging() можно вызвать без аргументов для доступа к службе Messaging приложения по умолчанию или как admin.messaging(app) для доступа к службе Messaging , связанной с конкретным приложением.

Классы

Сорт Описание
Обмен сообщениями Служба обмена сообщениями, привязанная к предоставленному приложению.

Интерфейсы

Интерфейс Описание
AndroidConfig Представляет параметры, специфичные для Android, которые можно включить в сообщение. .
AndroidFcmOptions Представляет параметры функций, предоставляемых FCM SDK для Android.
AndroidУведомление Представляет параметры уведомлений, специфичные для Android, которые можно включить в AndroidConfig. .
ApnsConfig Представляет параметры, специфичные для APN, которые можно включить в сообщение. . Обратитесь к документации Apple, чтобы узнать о различных заголовках и полях полезной нагрузки, поддерживаемых APN.
ApnsFcmOptions Представляет параметры функций, предоставляемых FCM SDK для iOS.
ApnsПолезная нагрузка Представляет полезную нагрузку сообщения APNs. В основном состоит из словаря aps . Но может также содержать другие произвольные пользовательские ключи.
Апс Представляет словарь aps , который является частью сообщений APN.
АпсАлерт
Базовое сообщение
Пакетный ответ Интерфейс, представляющий ответ сервера от методов Messaging.sendAll() и Messaging.sendMulticast() .
СостояниеСообщение
Критическийзвук Представляет критическую звуковую конфигурацию, которую можно включить в словарь aps полезной нагрузки APNs.
DataMessageПолезная нагрузка Интерфейс, представляющий полезную нагрузку сообщения данных устаревшего API FCM. Сообщения данных позволяют разработчикам отправлять до 4 КБ пользовательских пар ключ-значение. И ключи, и значения должны быть строками. Ключами могут быть любые пользовательские строки, за исключением следующих зарезервированных строк:
  • from
  • Все, что начинается с google.
Примеры кода и подробную документацию см. в разделе Создание запросов на отправку .
FcmOptions Представляет независимые от платформы параметры функций, предоставляемых пакетами SDK FCM.
Настройки света Представляет настройки для управления индикатором уведомлений, которые можно включить в AndroidNotification. .
Условие обмена сообщениямиОтвет Интерфейс, представляющий ответ сервера от устаревшего метода Messaging.sendToCondition() . Примеры кода и подробную документацию см. в разделе Отправить по условию .
Ответ на сообщениеDeviceGroupResponse Интерфейс, представляющий ответ сервера от метода Messaging.sendToDeviceGroup() . Примеры кода и подробную документацию см. в разделе Отправка сообщений группам устройств .
Результат MessagingDeviceResult Индивидуальная полезная нагрузка ответа о состоянии от отдельных устройств
Ответ устройств обмена сообщениями Интерфейс, представляющий статус сообщения, отправленного на отдельное устройство через устаревшие API FCM. См. раздел «Отправка на отдельные устройства» для получения примеров кода и подробной документации.
Параметры обмена сообщениями Интерфейс, представляющий параметры, которые могут быть предоставлены при отправке сообщения через устаревшие API FCM. Примеры кода и подробную документацию см. в разделе Создание запросов на отправку .
Полезная нагрузка обмена сообщениями Интерфейс, представляющий полезную нагрузку сообщения Firebase Cloud Messaging. Требуется один или оба ключа data и notification . Примеры кода и подробную документацию см. в разделе Создание запросов на отправку .
СообщенияТемаУправлениеОтвет Интерфейс, представляющий ответ сервера от методов Messaging.subscribeToTopic() и Messaging.unsubscribeFromTopic() . Примеры кода и подробную документацию см. в разделе Управление темами с сервера .
СообщенияТемаОтвет Интерфейс, представляющий ответ сервера от устаревшего метода Messaging.sendToTopic() . См. раздел «Отправить в тему» ​​для получения примеров кода и подробной документации.
Многоадресное сообщение Полезная нагрузка для метода Messaging.sendMulticast() . Полезная нагрузка содержит все поля типа BaseMessage и список токенов.
Уведомление Уведомление, которое можно включить в сообщение .
УведомлениеСообщениеПолезная нагрузка Интерфейс, представляющий полезную нагрузку сообщения уведомления устаревшего API FCM. Уведомительные сообщения позволяют разработчикам отправлять до 4 КБ предопределенных пар ключ-значение. Принятые ключи указаны ниже. Примеры кода и подробную документацию см. в разделе Создание запросов на отправку .
ОтправитьОтвет Интерфейс, представляющий статус отдельного сообщения, отправленного как часть пакетного запроса.
ТокенСообщение
ТемаСообщение
WebpushConfig Представляет параметры протокола WebPush, которые можно включить в сообщение. .
WebpushFcmOptions Представляет параметры функций, предоставляемых FCM SDK для Интернета (которые не являются частью стандарта Webpush).
Вебпуш-уведомление Представляет параметры уведомлений, специфичные для WebPush, которые можно включить в WebpushConfig. . Это поддерживает большинство стандартных опций, определенных в спецификации веб-уведомлений. .

Введите псевдонимы

Введите псевдоним Описание
Сообщение Полезная нагрузка для операции Messaging.send() . Полезная нагрузка содержит все поля типа BaseMessage и ровно одно из полей токена, темы или условия.

getMessaging()

Получает службу обмена сообщениями для приложения по умолчанию или заданного приложения.

admin.messaging() можно вызвать без аргументов для доступа к службе Messaging приложения по умолчанию или как admin.messaging(app) для доступа к службе Messaging , связанной с конкретным приложением.

Подпись:

export declare function getMessaging(app?: App): Messaging;

Параметры

Параметр Тип Описание
приложение Приложение Дополнительное приложение, службу Messaging которого нужно вернуть. Если не указано, будет возвращена служба Messaging по умолчанию.

Возврат:

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

Служба Messaging по умолчанию, если приложение не предоставлено, или служба Messaging , связанная с предоставленным приложением.

Пример 1

// Get the Messaging service for the default app
const defaultMessaging = getMessaging();

Пример 2

// Get the Messaging service for a given app
const otherMessaging = getMessaging(otherApp);

Сообщение

Полезная нагрузка для операции Messaging.send() . Полезная нагрузка содержит все поля типа BaseMessage и ровно одно из полей токена, темы или условия.

Подпись:

export type Message = TokenMessage | TopicMessage | ConditionMessage;