表示可以包含在AndroidConfig中的 Android 特定通知选项。
签名:
export interface AndroidNotification
特性
财产 | 类型 | 描述 |
---|---|---|
身体 | 细绳 | Android 通知的正文。提供后,将覆盖通过admin.messaging.Notification 设置的正文。 |
身体定位参数 | 细绳[] | 资源键数组,将用于代替bodyLocKey 中的格式说明符。 |
身体锁匙 | 细绳 | 应用程序字符串资源中正文字符串的键,用于本地化正文文本。 |
频道号 | 细绳 | Android 通知通道 ID(Android O 中的新增功能)。应用程序必须先创建具有此通道 ID 的通道,然后才能接收具有此通道 ID 的任何通知。如果您未在请求中发送此通道 ID,或者应用尚未创建提供的通道 ID,则 FCM 将使用应用清单中指定的通道 ID。 |
点击动作 | 细绳 | 与用户单击通知相关的操作。如果指定,当用户单击通知时,将启动具有匹配 Intent Filter 的活动。 |
颜色 | 细绳 | #rrggbb 格式的通知图标颜色。 |
默认灯光设置 | 布尔值 | 如果设置为true ,则使用 Android 框架的默认 LED 灯设置进行通知。默认值在config.xml中指定。如果default_light_settings 设置为true 并且light_settings 也被设置,则使用用户指定的light_settings 而不是默认值。 |
默认声音 | 布尔值 | 如果设置为true ,则使用 Android 框架的默认声音进行通知。默认值在config.xml中指定。 |
默认振动时间 | 布尔值 | 如果设置为true ,则使用 Android 框架的默认振动模式进行通知。默认值在config.xml中指定。如果default_vibrate_timings 设置为true 并且vibrate_timings 也设置了,则使用默认值而不是用户指定的vibrate_timings 。 |
事件时间戳 | 日期 | 对于通过绝对时间参考向用户通知事件的通知,设置通知中事件发生的时间。面板中的通知按时间排序。 |
图标 | 细绳 | Android 通知的图标资源。 |
图片网址 | 细绳 | 要在通知中显示的图像的 URL。 |
灯光设置 | 灯光设置 | 用于控制通知的 LED 闪烁频率和颜色(如果设备上有 LED)的设置。总闪烁时间由操作系统控制。 |
仅限本地 | 布尔值 | 设置此通知是否仅与当前设备相关。某些通知可以桥接到其他设备以进行远程显示,例如 Wear OS 手表。可以设置此提示以建议不要桥接此通知。请参阅Wear OS 指南。 |
通知计数 | 数字 | 设置此通知代表的项目数。对于支持徽章的启动器,可能会显示为徽章计数。请参阅通知徽章。例如,如果您仅使用一个通知来表示多条新消息,但您希望此处的计数表示新消息总数,则这可能会很有用。如果为零或未指定,支持徽章的系统将使用默认值,即每次新通知到达时增加长按菜单上显示的数字。 |
优先事项 | ('最小值' | '低' | '默认' | '高' | '最大值') | 设置此通知的相对优先级。在某些情况下,低优先级通知可能对用户隐藏。请注意,此优先级不同于AndroidMessagePriority 。该优先级由客户端在消息传送后处理。而AndroidMessagePriority 是一个 FCM 概念,用于控制消息的传递时间。 |
声音 | 细绳 | 设备收到通知时播放的声音的文件名。 |
黏 | 布尔值 | 当设置为false 或未设置时,当用户在面板中单击通知时,通知将自动关闭。当设置为true 时,即使用户单击通知,通知也会持续存在。 |
标签 | 细绳 | 通知标签。这是用于替换通知抽屉中现有通知的标识符。如果未指定,每个请求都会创建一个新通知。 |
股票行情 | 细绳 | 设置发送到辅助服务的“股票代码”文本。在 API 级别 21 (Lollipop) 之前,设置通知首次到达时状态栏中显示的文本。 |
标题 | 细绳 | Android 通知的标题。提供后,将覆盖通过admin.messaging.Notification 设置的标题。 |
标题定位参数 | 细绳[] | 将用于代替titleLocKey 中的格式说明符的资源键数组。 |
标题锁键 | 细绳 | 应用程序字符串资源中标题字符串的键,用于本地化标题文本。 |
振动计时毫秒 | 数字[] | 设置要使用的振动模式。传递一个毫秒数组来打开或关闭振动器。第一个值表示打开振动器之前等待的持续时间。下一个值表示保持振动器打开的持续时间。随后的值在关闭振动器和打开振动器的持续时间之间交替。如果设置了vibrate_timings 并且default_vibrate_timings 设置为true ,则使用默认值而不是用户指定的vibrate_timings 。 |
能见度 | ('私人' | '公开' | '秘密') | 设置通知的可见性。必须是private 、 public 或secret 。如果未指定,则默认为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 Filter 的活动。
签名:
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
要在通知中显示的图像的 URL。
签名:
imageUrl?: string;
AndroidNotification.lightSettings
用于控制通知的 LED 闪烁频率和颜色(如果设备上有 LED)的设置。总闪烁时间由操作系统控制。
签名:
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.vibrateTimingsMillis
设置要使用的振动模式。传递一个毫秒数组来打开或关闭振动器。第一个值表示打开振动器之前等待的持续时间。下一个值表示保持振动器打开的持续时间。随后的值在关闭振动器和打开振动器的持续时间之间交替。如果设置了vibrate_timings
并且default_vibrate_timings
设置为true
,使用默认值代替用户指定的vibrate_timings
。
签名:
vibrateTimingsMillis?: number[];
AndroidNotification.visibility
设置通知的可见性。必须是private
, public
,或secret
。如果未指定,则默认为private
。
签名:
visibility?: ('private' | 'public' | 'secret');