AndroidNotification interface

Представляет параметры уведомлений, специфичные для Android, которые можно включить в AndroidConfig. .

Подпись:

export interface AndroidNotification 

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

AndroidNotification.body

Текст уведомления Android. Если это предусмотрено, переопределяет тело, установленное через admin.messaging.Notification .

Подпись:

body?: string;

AndroidNotification.bodyLocArgs

Массив ключей ресурсов, которые будут использоваться вместо спецификаторов формата в bodyLocKey .

Подпись:

bodyLocArgs?: string[];

AndroidNotification.bodyLocKey

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

Подпись:

bodyLocKey?: string;

AndroidNotification.channelId

Идентификатор канала уведомлений Android (новое в Android O). Приложение должно создать канал с этим идентификатором канала, прежде чем можно будет получить какое-либо уведомление с этим идентификатором канала. Если вы не отправляете этот идентификатор канала в запросе или если предоставленный идентификатор канала еще не создан приложением, FCM использует идентификатор канала, указанный в манифесте приложения.

Подпись:

channelId?: string;

AndroidNotification.clickAction

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

Подпись:

clickAction?: string;

AndroidNotification.color

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

Подпись:

color?: string;

AndroidNotification.defaultLightSettings

Если установлено значение true , используйте для уведомления настройки светодиодной подсветки платформы Android по умолчанию. Значения по умолчанию указаны в config.xml. . Если default_light_settings установлено значение true и light_settings также установлено значение, вместо значения по умолчанию используется указанное пользователем light_settings .

Подпись:

defaultLightSettings?: boolean;

AndroidNotification.defaultSound

Если установлено значение true , используйте для уведомления звук платформы Android по умолчанию. Значения по умолчанию указаны в config.xml. .

Подпись:

defaultSound?: boolean;

AndroidNotification.defaultVibrateTimes

Если установлено значение true , используйте для уведомления стандартный шаблон вибрации платформы Android. Значения по умолчанию указаны в config.xml. . Если default_vibrate_timings установлено значение true и также установлен vibrate_timings , вместо заданного пользователем vibrate_timings используется значение по умолчанию. .

Подпись:

defaultVibrateTimings?: boolean;

AndroidNotification.eventTimestamp

Для уведомлений, которые информируют пользователей о событиях с привязкой к абсолютному времени, задается время, когда произошло событие в уведомлении. Уведомления в панели отсортированы по этому времени.

Подпись:

eventTimestamp?: Date;

AndroidNotification.icon

Ресурс значка для уведомления Android.

Подпись:

icon?: string;

AndroidNotification.imageUrl

URL-адрес изображения, которое будет отображаться в уведомлении.

Подпись:

imageUrl?: string;

AndroidNotification.lightSettings

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

Подпись:

lightSettings?: LightSettings;

AndroidNotification.localOnly

Определяет, актуально ли это уведомление только для текущего устройства. Некоторые уведомления можно перенаправить на другие устройства для удаленного отображения, например на часы Wear OS. Эту подсказку можно настроить так, чтобы рекомендовать не перекрывать это уведомление. См. руководства по Wear OS .

Подпись:

localOnly?: boolean;

AndroidNotification.notificationCount

Устанавливает количество элементов, которые представляет это уведомление. Может отображаться как количество значков для программ запуска, поддерживающих значки. См. значок уведомления. . Например, это может быть полезно, если вы используете только одно уведомление для представления нескольких новых сообщений, но хотите, чтобы здесь отображалось общее количество новых сообщений. Если значение равно нулю или не указано, системы, поддерживающие бейджи, используют значение по умолчанию, которое увеличивает число, отображаемое в меню длительного нажатия, каждый раз при поступлении нового уведомления.

Подпись:

notificationCount?: number;

AndroidNotification.priority

Устанавливает относительный приоритет для этого уведомления. Уведомления с низким приоритетом могут быть скрыты от пользователя в определенных ситуациях. Обратите внимание, что этот приоритет отличается от AndroidMessagePriority . Этот приоритет обрабатывается клиентом после доставки сообщения. Принимая во внимание, что AndroidMessagePriority — это концепция FCM, которая контролирует время доставки сообщения.

Подпись:

priority?: ('min' | 'low' | 'default' | 'high' | 'max');

AndroidNotification.sound

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

Подпись:

sound?: string;

AndroidNotification.sticky

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

Подпись:

sticky?: boolean;

AndroidNotification.tag

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

Подпись:

tag?: string;

AndroidNotification.ticker

Устанавливает текст «тикера», который отправляется службам доступности. До уровня API 21 (Lollipop) задает текст, который отображается в строке состояния при первом поступлении уведомления.

Подпись:

ticker?: string;

AndroidNotification.title

Название уведомления Android. Если он предоставлен, переопределяет заголовок, установленный через admin.messaging.Notification .

Подпись:

title?: string;

AndroidNotification.titleLocArgs

Массив ключей ресурсов, которые будут использоваться вместо спецификаторов формата в titleLocKey .

Подпись:

titleLocArgs?: string[];

AndroidNotification.titleLocKey

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

Подпись:

titleLocKey?: string;

AndroidNotification.vibrateTimemsMillis

Устанавливает используемый шаблон вибрации. Введите массив миллисекунд, чтобы включить или выключить вибратор. Первое значение указывает продолжительность ожидания перед включением вибратора. Следующее значение указывает продолжительность включения вибратора. Последующие значения чередуются между длительностью выключения и включения вибратора. Если установлен vibrate_timings , а для default_vibrate_timings установлено значение true , вместо заданного пользователем vibrate_timings используется значение по умолчанию. .

Подпись:

vibrateTimingsMillis?: number[];

AndroidNotification.visibility

Устанавливает видимость уведомления. Должен быть либо private , public , или secret . Если не указано, по умолчанию используется private .

Подпись:

visibility?: ('private' | 'public' | 'secret');