Интерфейс, представляющий параметры, которые могут быть предоставлены при отправке сообщения через устаревшие API FCM.
Примеры кода и подробную документацию см. в разделе Создание запросов на отправку .
Подпись:
export interface MessagingOptions
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
| свернутьКлюч | нить | Строка, определяющая группу сообщений (например, «Доступны обновления»), которые можно свернуть, чтобы при возобновлении доставки отправлялось только последнее сообщение. Это используется, чтобы избежать отправки слишком большого количества одних и тех же сообщений, когда устройство снова подключается к сети или становится активным. Нет никакой гарантии порядка отправки сообщений. В любой момент времени допускается максимум четыре разных ключа свертывания. Это означает, что сервер FCM может одновременно хранить четыре разных сообщения для синхронизации для каждого клиентского приложения. Если вы превысите это число, нет никакой гарантии, какие четыре ключа свертывания сохранит сервер FCM. **Значение по умолчанию:** Нет |
| контентДоступен | логическое значение | В iOS используйте это поле для представления content-available в полезной нагрузке APN. Когда отправляется уведомление или сообщение с данными, и для этого параметра установлено значение true , неактивное клиентское приложение просыпается. На Android сообщения с данными пробуждают приложение по умолчанию. В Chrome этот флаг в настоящее время не поддерживается. **Значение по умолчанию:** false |
| сухой ход | логическое значение | Следует ли действительно отправлять сообщение. Если установлено значение true , разработчикам разрешается тестировать запрос без фактической отправки сообщения. Если установлено значение false , сообщение будет отправлено. **Значение по умолчанию:** false |
| mutableContent | логическое значение | В iOS используйте это поле для представления mutable-content в полезной нагрузке APN. Если уведомление отправлено и для него установлено значение true , содержимое уведомления можно изменить перед его отображением с помощью расширения приложения службы уведомлений. . В Android и Интернете этот параметр будет игнорироваться. **Значение по умолчанию:** false |
| приоритет | нить | Приоритет сообщения. Допустимые значения: "normal" и "high". В iOS они соответствуют приоритетам APN 5 и 10 . По умолчанию сообщения уведомлений отправляются с высоким приоритетом, а сообщения с данными отправляются с обычным приоритетом. Обычный приоритет оптимизирует расход заряда батареи клиентского приложения, и его следует использовать, если не требуется немедленная доставка. Для сообщений с обычным приоритетом приложение может получить сообщение с неопределенной задержкой. Когда сообщение отправляется с высоким приоритетом, оно отправляется немедленно, и приложение может разбудить спящее устройство и открыть сетевое соединение с вашим сервером. Дополнительную информацию см. в разделе Установка приоритета сообщения. . **Значение по умолчанию:** "high" для уведомлений, "normal" для сообщений с данными. |
| ограниченное имя_пакета | нить | Имя пакета приложения, которому должны соответствовать регистрационные токены, чтобы получить сообщение. **Значение по умолчанию:** Нет |
| ВремяЖить | число | Как долго (в секундах) сообщение должно храниться в хранилище FCM, если устройство находится в автономном режиме. Максимальное время поддержки составляет четыре недели, значение по умолчанию также равно четырем неделям. Дополнительную информацию см. в разделе «Настройка срока жизни сообщения». . **Значение по умолчанию:** 2419200 (что соответствует четырем неделям в секундах). |
MessagingOptions.collapseKey
Строка, определяющая группу сообщений (например, «Доступны обновления»), которые можно свернуть, чтобы при возобновлении доставки отправлялось только последнее сообщение. Это используется, чтобы избежать отправки слишком большого количества одних и тех же сообщений, когда устройство снова подключается к сети или становится активным.
Нет никакой гарантии порядка отправки сообщений.
В любой момент времени допускается максимум четыре разных ключа свертывания. Это означает, что сервер FCM может одновременно хранить четыре разных сообщения для синхронизации для каждого клиентского приложения. Если вы превысите это число, нет никакой гарантии, какие четыре ключа свертывания сохранит сервер FCM.
**Значение по умолчанию:** Нет
Подпись:
collapseKey?: string;
MessagingOptions.contentAvailable
В iOS используйте это поле для представления content-available в полезной нагрузке APN. Когда отправляется уведомление или сообщение с данными, и для этого параметра установлено значение true , просыпается неактивное клиентское приложение. На Android сообщения с данными пробуждают приложение по умолчанию. В Chrome этот флаг в настоящее время не поддерживается.
**Значение по умолчанию:** false
Подпись:
contentAvailable?: boolean;
MessagingOptions.dryRun
Следует ли действительно отправлять сообщение. Когда установлено true , позволяет разработчикам тестировать запрос без фактической отправки сообщения. Когда установлено значение false , сообщение будет отправлено.
**Значение по умолчанию:** false
Подпись:
dryRun?: boolean;
MessagingOptions.mutableContent
В iOS используйте это поле для представления mutable-content в полезной нагрузке APN. Когда уведомление отправлено и для этого параметра установлено значение true содержимое уведомления можно изменить перед его отображением с помощью расширения приложения службы уведомлений. .
В Android и Интернете этот параметр будет игнорироваться.
**Значение по умолчанию:** false
Подпись:
mutableContent?: boolean;
MessagingOptions.priority
Приоритет сообщения. Допустимые значения: "normal" и "high". В iOS они соответствуют приоритетам APN 5 и 10 .
По умолчанию сообщения уведомлений отправляются с высоким приоритетом, а сообщения с данными отправляются с обычным приоритетом. Обычный приоритет оптимизирует расход заряда батареи клиентского приложения, и его следует использовать, если не требуется немедленная доставка. Для сообщений с обычным приоритетом приложение может получить сообщение с неопределенной задержкой.
Когда сообщение отправляется с высоким приоритетом, оно отправляется немедленно, и приложение может разбудить спящее устройство и открыть сетевое соединение с вашим сервером.
Дополнительную информацию см. в разделе Установка приоритета сообщения. .
**Значение по умолчанию:** "high" для уведомлений, "normal" для сообщений с данными.
Подпись:
priority?: string;
MessagingOptions.restrictedPackageName
Имя пакета приложения, которому должны соответствовать регистрационные токены, чтобы получить сообщение.
**Значение по умолчанию:** Нет
Подпись:
restrictedPackageName?: string;
MessagingOptions.timeToLive
Как долго (в секундах) сообщение должно храниться в хранилище FCM, если устройство находится в автономном режиме. Максимальное время поддержки составляет четыре недели, значение по умолчанию также равно четырем неделям. Дополнительную информацию см. в разделе «Настройка срока жизни сообщения». .
**Значение по умолчанию:** 2419200 (что соответствует четырем неделям в секундах).
Подпись:
timeToLive?: number;