NotificationMessagePayload interface

Интерфейс, представляющий полезную нагрузку сообщения уведомления устаревшего API FCM. Уведомительные сообщения позволяют разработчикам отправлять до 4 КБ предопределенных пар ключ-значение. Принятые ключи указаны ниже.

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

Подпись:

export interface NotificationMessagePayload 

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

Свойство Тип Описание
значок нить Значение значка на значке приложения на главном экране. Если не указано, значок не изменяется. Если установлено значение 0 , значок удаляется. **Платформы:** iOS.
тело нить Текст уведомления. **Платформы:** iOS, Android, Интернет.
bodyLocArgs нить Значения переменных строк, которые будут использоваться вместо спецификаторов формата в body_loc_key и использоваться для локализации основного текста в соответствии с текущей локализацией пользователя. Значение должно представлять собой строковый массив JSON. **iOS:** Соответствует loc-args в полезных данных APN. Дополнительные сведения см. в разделе «Справочник по ключам полезной нагрузки» и «Локализация содержимого удаленных уведомлений» . **Android:** дополнительную информацию см. в разделе «Форматирование и оформление» . **Платформы:** iOS, Android.
bodyLocKey нить Ключ основной строки в строковых ресурсах приложения, используемый для локализации основного текста в соответствии с текущей локализацией пользователя. **iOS:** Соответствует loc-key в полезных данных APN. Дополнительные сведения см. в разделе «Справочник по ключам полезной нагрузки» и «Локализация содержимого удаленных уведомлений» . **Android:** дополнительную информацию см. в разделе «Строковые ресурсы» . **Платформы:** iOS, Android.
нажмитеДействие нить Действие, связанное с щелчком пользователя по уведомлению. Если указано, действие с соответствующим фильтром намерений запускается, когда пользователь нажимает на уведомление. * **Платформы:** Android
цвет нить Цвет значка уведомления, выраженный в формате #rrggbb . **Платформы:** Android
икона нить Значок уведомления. **Android:** устанавливает значок уведомления myicon для рисуемого ресурса myicon . Если вы не отправите этот ключ в запросе, FCM отобразит значок средства запуска, указанный в манифесте вашего приложения. **Интернет:** URL-адрес значка уведомления. **Платформы:** Android, Интернет.
звук нить Звук, который будет воспроизводиться при получении устройством уведомления. Поддерживает «по умолчанию» звук уведомления устройства по умолчанию или имя файла звукового ресурса, включенного в приложение. Звуковые файлы должны находиться в /res/raw/ . **Платформы:** Android
ярлык нить Идентификатор, используемый для замены существующих уведомлений в панели уведомлений. Если не указано, каждый запрос создает новое уведомление. Если указано и уведомление с таким же тегом уже отображается, новое уведомление заменяет существующее в панели уведомлений. **Платформы:** Android
заголовок нить Название уведомления. **Платформы:** iOS, Android, Интернет.
titleLocArgs нить Значения переменных строк, которые будут использоваться вместо спецификаторов формата в title_loc_key и использоваться для локализации текста заголовка в соответствии с текущей локализацией пользователя. Значение должно представлять собой строковый массив JSON. **iOS:** Соответствует title-loc-args в полезных данных APN. Дополнительные сведения см. в разделе «Справочник по ключам полезной нагрузки» и «Локализация содержимого удаленных уведомлений» . **Android:** дополнительную информацию см. в разделе «Форматирование и оформление» . **Платформы:** iOS, Android.
titleLocKey нить Ключ строки заголовка в строковых ресурсах приложения, используемый для локализации текста заголовка в соответствии с текущей локализацией пользователя. **iOS:** Соответствует title-loc-key в полезных данных APN. Дополнительные сведения см. в разделе «Справочник по ключам полезной нагрузки» и «Локализация содержимого удаленных уведомлений» . **Android:** дополнительную информацию см. в разделе «Строковые ресурсы» . **Платформы:** iOS, Android.

NotificationMessagePayload.badge

Значение значка на значке приложения на главном экране.

Если не указано, значок не изменяется.

Если установлено значение 0 , значок удаляется.

**Платформы:** iOS.

Подпись:

badge?: string;

NotificationMessagePayload.body

Текст уведомления.

**Платформы:** iOS, Android, Интернет.

Подпись:

body?: string;

NotificationMessagePayload.bodyLocArgs

Значения переменных строк, которые будут использоваться вместо спецификаторов формата в body_loc_key и использоваться для локализации основного текста в соответствии с текущей локализацией пользователя.

Значение должно представлять собой строковый массив JSON.

**iOS:** Соответствует loc-args в полезных данных APN. Дополнительные сведения см. в разделе «Справочник по ключам полезной нагрузки» и «Локализация содержимого удаленных уведомлений» .

**Android:** дополнительную информацию см. в разделе «Форматирование и оформление» .

**Платформы:** iOS, Android.

Подпись:

bodyLocArgs?: string;

NotificationMessagePayload.bodyLocKey

Ключ основной строки в строковых ресурсах приложения, используемый для локализации основного текста в соответствии с текущей локализацией пользователя.

**iOS:** Соответствует loc-key в полезных данных APN. Дополнительные сведения см. в разделе «Справочник по ключам полезной нагрузки» и «Локализация содержимого удаленных уведомлений» .

**Android:** дополнительную информацию см. в разделе «Строковые ресурсы» .

**Платформы:** iOS, Android.

Подпись:

bodyLocKey?: string;

NotificationMessagePayload.clickAction

Действие, связанное с щелчком пользователя по уведомлению. Если указано, действие с соответствующим фильтром намерений запускается, когда пользователь нажимает на уведомление.

* **Платформы:** Android

Подпись:

clickAction?: string;

NotificationMessagePayload.color

Цвет значка уведомления, выраженный в формате #rrggbb .

**Платформы:** Android

Подпись:

color?: string;

NotificationMessagePayload.icon

Значок уведомления.

**Android:** устанавливает значок уведомления на myicon для рисуемого ресурса myicon . Если вы не отправите этот ключ в запросе, FCM отобразит значок средства запуска, указанный в манифесте вашего приложения.

**Интернет:** URL-адрес значка уведомления.

**Платформы:** Android, Интернет.

Подпись:

icon?: string;

NotificationMessagePayload.sound

Звук, который будет воспроизводиться при получении устройством уведомления. Поддерживает «по умолчанию» звук уведомления устройства по умолчанию или имя файла звукового ресурса, включенного в приложение. Звуковые файлы должны находиться в /res/raw/ .

**Платформы:** Android

Подпись:

sound?: string;

NotificationMessagePayload.tag

Идентификатор, используемый для замены существующих уведомлений в панели уведомлений.

Если не указано, каждый запрос создает новое уведомление.

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

**Платформы:** Android

Подпись:

tag?: string;

NotificationMessagePayload.title

Название уведомления.

**Платформы:** iOS, Android, Интернет.

Подпись:

title?: string;

NotificationMessagePayload.titleLocArgs

Значения переменных строк, которые будут использоваться вместо спецификаторов формата в title_loc_key и использоваться для локализации текста заголовка в соответствии с текущей локализацией пользователя.

Значение должно представлять собой строковый массив JSON.

**iOS:** Соответствует title-loc-args в полезных данных APN. Дополнительные сведения см. в разделе «Справочник по ключам полезной нагрузки» и «Локализация содержимого удаленных уведомлений» .

**Android:** дополнительную информацию см. в разделе «Форматирование и оформление» .

**Платформы:** iOS, Android.

Подпись:

titleLocArgs?: string;

NotificationMessagePayload.titleLocKey

Ключ строки заголовка в строковых ресурсах приложения, используемый для локализации текста заголовка в соответствии с текущей локализацией пользователя.

**iOS:** Соответствует title-loc-key в полезных данных APN. Дополнительные сведения см. в разделе «Справочник по ключам полезной нагрузки» и «Локализация содержимого удаленных уведомлений» .

**Android:** дополнительную информацию см. в разделе «Строковые ресурсы» .

**Платформы:** iOS, Android.

Подпись:

titleLocKey?: string;