AndroidNotification interface

表示可包含在 AndroidConfig 中的 Android 专用通知选项。

签名

export interface AndroidNotification 

属性

属性 类型 说明
正文 字符串 Android 通知的正文。如果提供了此参数,则会替换通过 admin.messaging.Notification 设置的正文。
bodyLocArgs 字符串[] 将用于代替 bodyLocKey 中的格式说明符的资源键数组。
bodyLocKey 字符串 应用的字符串资源中用于本地化正文文本的正文字符串的键。
channelId 字符串 Android 通知渠道 ID(Android O 中的新功能)。应用必须使用此频道 ID 创建一个频道,才能收到包含此频道 ID 的任何通知。如果您不在请求中发送此渠道 ID,或者应用尚未创建所提供的渠道 ID,FCM 将使用应用清单中指定的渠道 ID。
clickAction 字符串 与用户点击通知相关的操作。如果已指定,将在用户点击通知时启动具有匹配 Intent 过滤器的 Activity。
颜色 字符串 通知图标颜色(#rrggbb 格式)。
defaultLightSettings 布尔值 如果设置为 true,则针对通知使用 Android 框架的默认 LED 灯设置。默认值在 config.xml 中指定。如果 default_light_settings 设置为 true,并且也设置了 light_settings,则系统会使用用户指定的 light_settings(而不是默认值)。
defaultSound 布尔值 如果设置为 true,则使用 Android 框架的默认通知提示音。默认值在 config.xml 中指定。
defaultVibrateTimings 布尔值 如果设为 true,则会为通知使用 Android 框架的默认振动模式。默认值在 config.xml 中指定。如果 default_vibrate_timings 设置为 true,并且也设置了 vibrate_timings,则系统会使用默认值,而不是用户指定的 vibrate_timings
eventTimestamp 日期 对于使用绝对时间参考告知用户事件的通知,设置通知中事件发生的时间。面板中的通知按此时间排序。
图标 字符串 Android 通知的图标资源。
imageUrl 字符串 要在通知中显示的图片的网址。
lightSettings LightSettings 用于控制通知的 LED 指示灯闪烁频率和颜色(如果设备上有 LED 指示灯)的设置。总闪烁时间由操作系统控制。
localOnly 布尔值 设置此通知是否仅与当前设备相关。某些通知可以桥接到其他设备(例如 Wear OS 手表)进行远程显示。您可以设置此提示,建议不要桥接此通知。请参阅 Wear OS 指南
notificationCount 数字 设置此通知表示的项目数量。对于支持标志的启动器,可能会显示为标志数量。请参阅 NotificationBadge。例如,如果您仅使用一个通知来表示多条新消息,但希望此处的计数表示新消息的总数,上述做法可能会很有用。如果为零或未指定,支持标记的系统使用默认值,即每当收到新通知时,都会递增长按菜单上显示的数字。
优先级 ('min' | 'low' | 'default' | 'high' | 'max') 设置此通知的相对优先级。在某些情况下,系统可能会对用户隐藏优先级较低的通知。请注意,此优先级与 AndroidMessagePriority 不同。消息传送后,客户端会处理此优先级。而 AndroidMessagePriority 是一个 FCM 概念,用于控制何时传送消息。
声音 字符串 设备收到通知时要播放的声音的文件名。
粘性 布尔值 如果设置为 false 或未设置,则当用户在面板中点击通知时,通知会自动关闭。设置为 true 时,即使用户点击通知,通知仍会保留。
代码 字符串 通知标记。这是一个标识符,用于替换抽屉式通知栏中的现有通知。如果未指定,则每次请求都会创建一条新的通知。
证券代码 字符串 设置“证券代码”文本,发送到无障碍服务。在 API 级别 21 (Lollipop) 之前,设置通知首次到达时显示在状态栏中的文本。
title 字符串 Android 通知的标题。如果提供了此属性,则会替换通过 admin.messaging.Notification 设置的标题。
titleLocArgs 字符串[] 将用于代替 titleLocKey 中的格式说明符的资源键数组。
titleLocKey 字符串 应用的字符串资源中标题字符串的键,用于本地化标题文本。
vibrateTimingsMillis 数值 [] 设置要使用的振动模式。传入一组毫秒数以开启或关闭振动器。第一个值表示开启振动器之前等待的时间。下一个值表示振动器保持开启状态的时长。后续值会交替使用时长来关闭振动器和开启振动器。如果设置了 vibrate_timingsdefault_vibrate_timings 设置为 true,则系统会使用默认值,而不是用户指定的 vibrate_timings
可见性 ('private' | 'public' | 'secret') 设置通知的可见性。必须是 privatepublicsecret。如果未指定,则默认为 private

AndroidNotification.body

Android 通知的正文。如果提供了此参数,则会替换通过 admin.messaging.Notification 设置的正文。

签名

body?: string;

AndroidNotification.bodyLocArgs

将用于代替 bodyLocKey 中的格式说明符的资源键数组。

签名

bodyLocArgs?: string[];

AndroidNotification.bodyLocKey

应用的字符串资源中用于本地化正文文本的正文字符串的键。

签名

bodyLocKey?: string;

AndroidNotification.channelId

Android 通知渠道 ID(Android O 中的新功能)。应用必须使用此频道 ID 创建一个频道,才能收到包含此频道 ID 的任何通知。如果您不在请求中发送此渠道 ID,或者应用尚未创建所提供的渠道 ID,FCM 将使用应用清单中指定的渠道 ID。

签名

channelId?: string;

AndroidNotification.clickAction

与用户点击通知相关的操作。如果已指定,将在用户点击通知时启动具有匹配 Intent 过滤器的 Activity。

签名

clickAction?: string;

AndroidNotification.color

通知图标颜色(#rrggbb 格式)。

签名

color?: string;

AndroidNotification.defaultLightSettings

如果设置为 true,则针对通知使用 Android 框架的默认 LED 灯设置。默认值在 config.xml 中指定。如果 default_light_settings 设置为 true,并且也设置了 light_settings,则系统会使用用户指定的 light_settings(而不是默认值)。

签名

defaultLightSettings?: boolean;

AndroidNotification.defaultSound

如果设置为 true,则使用 Android 框架的默认通知提示音。默认值在 config.xml 中指定。

签名

defaultSound?: boolean;

AndroidNotification.defaultVibrateTimings

如果设为 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

要在通知中显示的图片的网址。

签名

imageUrl?: string;

AndroidNotification.lightSettings

用于控制通知的 LED 指示灯闪烁频率和颜色(如果设备上有 LED 指示灯)的设置。总闪烁时间由操作系统控制。

签名

lightSettings?: LightSettings;

AndroidNotification.localOnly

设置此通知是否仅与当前设备相关。某些通知可以桥接到其他设备(例如 Wear OS 手表)进行远程显示。您可以设置此提示,建议不要桥接此通知。请参阅 Wear OS 指南

签名

localOnly?: boolean;

AndroidNotification.notificationCount

设置此通知表示的项目数量。对于支持标志的启动器,可能会显示为标志数量。请参阅 NotificationBadge。例如,如果您仅使用一个通知来表示多条新消息,但希望此处的计数表示新消息的总数,上述做法可能会很有用。如果为零或未指定,支持标记的系统使用默认值,即每当收到新通知时,都会递增长按菜单上显示的数字。

签名

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.vibrateTimingsMillis

设置要使用的振动模式。传入一组毫秒数以开启或关闭振动器。第一个值表示开启振动器之前等待的时间。下一个值表示振动器保持开启状态的时长。后续值会交替使用时长来关闭振动器和开启振动器。如果设置了 vibrate_timingsdefault_vibrate_timings 设置为 true,则系统会使用默认值,而不是用户指定的 vibrate_timings

签名

vibrateTimingsMillis?: number[];

AndroidNotification.visibility

设置通知的可见性。必须是 privatepublicsecret。如果未指定,则默认为 private

签名

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