Messaging class

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

Подпись:

export declare class Messaging

Характеристики

Свойство Модификаторы Тип Описание
приложение Приложение Приложение, связанное с текущим экземпляром службы Messaging .

Методы

Метод Модификаторы Описание
включитьLegacyHttpTransport() Позволяет использовать устаревший транспорт HTTP/1.1 для sendEach() и sendEachForMulticast() .
отправить (сообщение, DryRun) Отправляет данное сообщение через FCM.
sendAll(сообщения, DryRun) Отправляет все сообщения в заданном массиве через Firebase Cloud Messaging. Использует пакетную обработку для отправки всего списка как один вызов RPC. По сравнению с методом send() этот метод является значительно более эффективным способом отправки нескольких сообщений. Список ответов, полученный из возвращаемого значения, соответствует порядку токенов в MulticastMessage . Ошибка этого метода указывает на полный сбой, то есть ни одно из сообщений в списке не может быть отправлено. Частичные сбои обозначаются возвращаемым значением BatchResponse .
sendEach (сообщения, DryRun) Отправляет каждое сообщение в заданном массиве через Firebase Cloud Messaging. В отличие от Messaging.sendAll() , этот метод выполняет один вызов RPC для каждого сообщения в данном массиве. Список ответов, полученный из возвращаемого значения, соответствует порядку messages . Ошибка этого метода или BatchResponse со всеми ошибками указывает на полный сбой, то есть ни одно из сообщений в списке не может быть отправлено. Частичные сбои или отсутствие сбоев обозначаются только возвращаемым значением BatchResponse .
sendEachForMulticast (сообщение, DryRun) Отправляет данное многоадресное сообщение всем указанным в нем регистрационным токенам FCM. Этот метод использует API Messaging.sendEach() для отправки данного сообщения всем целевым получателям. Список ответов, полученный из возвращаемого значения, соответствует порядку токенов в MulticastMessage . Ошибка этого метода или BatchResponse со всеми ошибками указывает на полный сбой, а это означает, что сообщения в списке могут быть отправлены. Частичные сбои или сбои обозначаются только возвращаемым значением BatchResponse .
sendMulticast (сообщение, DryRun) Отправляет данное многоадресное сообщение всем указанным в нем регистрационным токенам FCM. Этот метод использует API-интерфейс sendAll() для отправки данного сообщения всем целевым получателям. Список ответов, полученный из возвращаемого значения, соответствует порядку токенов в MulticastMessage . Ошибка этого метода указывает на полный сбой, то есть сообщение не было отправлено ни на один из токенов в списке. Частичные сбои обозначаются возвращаемым значением BatchResponse .
sendToCondition(условие, полезные данные, параметры) Отправляет сообщение FCM в условие. Примеры кода и подробную документацию см. в разделе Отправить по условию .
sendToDevice(registrationTokenOrTokens, полезная нагрузка, параметры) Отправляет сообщение FCM на одно устройство, соответствующее предоставленному регистрационному токену. См. раздел «Отправка на отдельные устройства» для получения примеров кода и подробной документации. Принимает либо registrationToken для отправки на одно устройство, либо параметр registrationTokens , содержащий массив токенов для отправки на несколько устройств.
sendToDeviceGroup (notificationKey, полезная нагрузка, параметры) Отправляет сообщение FCM группе устройств, соответствующей предоставленному ключу уведомления. См. раздел «Отправка в группу устройств», где приведены примеры кода и подробная документация.
sendToTopic(тема, полезная нагрузка, параметры) Отправляет сообщение FCM в тему. См. раздел «Отправить в тему» ​​для получения примеров кода и подробной документации.
subscribeToTopic(registrationTokenOrTokens, тема) Подписывает устройство на тему FCM. См. раздел «Подписка на тему» ​​для получения примеров кода и подробной документации. При желании вы можете предоставить массив токенов для подписки на несколько устройств.
отписаться от темы (регистрационный токенилитокены, тема) Отписывает устройство от темы FCM. См. Отказ от подписки на тему для получения примеров кода и подробной документации. При желании вы можете предоставить массив токенов для отмены подписки на несколько устройств.

Сообщения.приложение

Приложение, связанное с текущим экземпляром службы Messaging .

Подпись:

get app(): App;

Пример 

var app = messaging.app;

Messaging.enableLegacyHttpTransport()

Это будет удалено, когда реализация транспорта HTTP/2 достигнет той же стабильности, что и устаревшая реализация HTTP/1.1.

Позволяет использовать устаревший транспорт HTTP/1.1 для sendEach() и sendEachForMulticast() .

Подпись:

enableLegacyHttpTransport(): void;

Возврат:

пустота

Пример 

const messaging = getMessaging(app);
messaging.enableLegacyTransport();
messaging.sendEach(messages);

Сообщения.send()

Отправляет данное сообщение через FCM.

Подпись:

send(message: Message, dryRun?: boolean): Promise<string>;

Параметры

Параметр Тип Описание
сообщение Сообщение Полезная нагрузка сообщения.
сухой ход логическое значение Следует ли отправлять сообщение в режиме пробного запуска (только проверка).

Возврат:

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

Обещание, выполняемое с помощью уникальной строки идентификатора сообщения после того, как сообщение было успешно передано службе FCM для доставки.

Сообщения.sendAll()

Вместо этого используйте Messaging.sendEach() .

Отправляет все сообщения в заданном массиве через Firebase Cloud Messaging. Использует пакетную обработку для отправки всего списка как один вызов RPC. По сравнению с методом send() этот метод является значительно более эффективным способом отправки нескольких сообщений.

Список ответов, полученный из возвращаемого значения, соответствует порядку токенов в MulticastMessage . Ошибка этого метода указывает на полный сбой, то есть ни одно из сообщений в списке не может быть отправлено. Частичные сбои обозначаются возвращаемым значением BatchResponse .

Подпись:

sendAll(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;

Параметры

Параметр Тип Описание
сообщения Сообщение [] Непустой массив, содержащий до 500 сообщений.
сухой ход логическое значение Отправлять ли сообщения в режиме пробного запуска (только проверка).

Возврат:

Обещание< Пакетный ответ >

Обещание, выполненное с объектом, представляющим результат операции отправки.

Сообщения.sendEach()

Отправляет каждое сообщение в заданном массиве через Firebase Cloud Messaging.

В отличие от Messaging.sendAll() , этот метод выполняет один вызов RPC для каждого сообщения в данном массиве.

Список ответов, полученный из возвращаемого значения, соответствует порядку messages . Ошибка этого метода или BatchResponse со всеми ошибками указывает на полный сбой, то есть ни одно из сообщений в списке не может быть отправлено. Частичные сбои или отсутствие сбоев обозначаются только возвращаемым значением BatchResponse .

Подпись:

sendEach(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;

Параметры

Параметр Тип Описание
сообщения Сообщение [] Непустой массив, содержащий до 500 сообщений.
сухой ход логическое значение Отправлять ли сообщения в режиме пробного запуска (только проверка).

Возврат:

Обещание< Пакетный ответ >

Обещание, выполненное с объектом, представляющим результат операции отправки.

Сообщения.sendEachForMulticast()

Отправляет данное многоадресное сообщение всем указанным в нем регистрационным токенам FCM.

Этот метод использует API Messaging.sendEach() для отправки данного сообщения всем целевым получателям. Список ответов, полученный из возвращаемого значения, соответствует порядку токенов в MulticastMessage . Ошибка этого метода или BatchResponse со всеми ошибками указывает на полный сбой, а это означает, что сообщения в списке могут быть отправлены. Частичные сбои или сбои обозначаются только возвращаемым значением BatchResponse .

Подпись:

sendEachForMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;

Параметры

Параметр Тип Описание
сообщение Многоадресное сообщение Многоадресное сообщение, содержащее до 500 токенов.
сухой ход логическое значение Отправлять ли сообщение в режиме пробного запуска (только проверка).

Возврат:

Обещание< Пакетный ответ >

Обещание, выполненное с объектом, представляющим результат операции отправки.

Сообщения.sendMulticast()

Вместо этого используйте Messaging.sendEachForMulticast() .

Отправляет данное многоадресное сообщение всем указанным в нем регистрационным токенам FCM.

Этот метод использует API-интерфейс sendAll() для отправки данного сообщения всем целевым получателям. Список ответов, полученный из возвращаемого значения, соответствует порядку токенов в MulticastMessage . Ошибка этого метода указывает на полный сбой, то есть сообщение не было отправлено ни на один из токенов в списке. Частичные сбои обозначаются возвращаемым значением BatchResponse .

Подпись: 

sendMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;

Параметры

Параметр Тип Описание
сообщение Многоадресное сообщение Многоадресное сообщение, содержащее до 500 токенов.
сухой ход логическое значение Отправлять ли сообщение в режиме пробного запуска (только проверка).

Возврат:

Обещание< Пакетный ответ >

Обещание, выполненное с объектом, представляющим результат операции отправки.

Сообщения.sendToCondition()

Вместо этого используйте Messaging.send() .

Отправляет сообщение FCM в условие.

Примеры кода и подробную документацию см. в разделе Отправить по условию .

Подпись: 

sendToCondition(condition: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingConditionResponse>;

Параметры

Параметр Тип Описание
состояние нить Условие, определяющее, в какие темы отправлять сообщение.
полезная нагрузка Полезная нагрузка обмена сообщениями Полезная нагрузка сообщения.
параметры Параметры обмена сообщениями Дополнительные параметры для изменения сообщения.

Возврат:

Обещание < MessagingConditionResponse >

Обещание, выполненное с ответом сервера после отправки сообщения.

Сообщения.sendToDevice()

Вместо этого используйте Messaging.send() .

Отправляет сообщение FCM на одно устройство, соответствующее предоставленному регистрационному токену.

См. раздел «Отправка на отдельные устройства» для получения примеров кода и подробной документации. Принимает либо registrationToken для отправки на одно устройство, либо параметр registrationTokens , содержащий массив токенов для отправки на несколько устройств.

Подпись: 

sendToDevice(registrationTokenOrTokens: string | string[], payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDevicesResponse>;

Параметры

Параметр Тип Описание
регистрацияTokenOrTokens строка | нить[]
полезная нагрузка Полезная нагрузка обмена сообщениями Полезная нагрузка сообщения.
параметры Параметры обмена сообщениями Дополнительные параметры для изменения сообщения.

Возврат:

Обещание < MessagingDevicesResponse >

Обещание, выполненное с ответом сервера после отправки сообщения.

Сообщения.sendToDeviceGroup()

Вместо этого используйте Messaging.send() .

Отправляет сообщение FCM группе устройств, соответствующей предоставленному ключу уведомления.

См. раздел «Отправка в группу устройств», где приведены примеры кода и подробная документация.

Подпись: 

sendToDeviceGroup(notificationKey: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDeviceGroupResponse>;

Параметры

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

Возврат:

Обещание < MessagingDeviceGroupResponse >

Обещание, выполненное с ответом сервера после отправки сообщения.

Сообщения.sendToTopic()

Вместо этого используйте Messaging.send() .

Отправляет сообщение FCM в тему.

См. раздел «Отправить в тему» ​​для получения примеров кода и подробной документации.

Подпись: 

sendToTopic(topic: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingTopicResponse>;

Параметры

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

Возврат:

Обещание< MessagingTopicResponse >

Обещание, выполненное с ответом сервера после отправки сообщения.

Сообщения.subscribeToTopic()

Подписывает устройство на тему FCM.

См. раздел «Подписка на тему» ​​для получения примеров кода и подробной документации. При желании вы можете предоставить массив токенов для подписки на несколько устройств.

Подпись: 

subscribeToTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;

Параметры

Параметр Тип Описание
регистрацияTokenOrTokens строка | нить[]
тема нить Тема, на которую подписаться.

Возврат:

Обещание< MessagingTopicManagementResponse >

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

Сообщения.unsubscribeFromTopic()

Отписывает устройство от темы FCM.

См. Отказ от подписки на тему для получения примеров кода и подробной документации. При желании вы можете предоставить массив токенов для отмены подписки на несколько устройств.

Подпись: 

unsubscribeFromTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;

Параметры

Параметр Тип Описание
регистрацияTokenOrTokens строка | нить[]
тема нить Тема, от которой можно отписаться.

Возврат:

Обещание< MessagingTopicManagementResponse >

Обещание выполняется с ответом сервера после отписки устройства от темы.