表示 FCM 旧版 API 通知消息载荷的接口。开发者可通过通知消息发送不超过 4KB 的预定义键值对。下面列出了可接受的键。
如需查看代码示例和详细文档,请参阅构建发送请求。
签名:
export interface NotificationMessagePayload
属性
属性 | 类型 | 说明 |
---|---|---|
徽章 | 字符串 | 主屏幕应用图标上标志的值。如果未指定,则此标志不会更改。如果设置为 0 ,则标志将被移除。**平台:** iOS |
正文 | 字符串 | 通知的正文。**平台:** iOS、Android、Web |
bodyLocArgs | 字符串 | 用于替换 body_loc_key 中的格式说明符的变量字符串值,用于将正文文字本地化为用户当前的本地化语言。该值应为字符串化 JSON 数组。**iOS** 对应于 APNs 载荷中的 loc-args 。如需了解详情,请参阅载荷键参考和本地化远程通知的内容。**Android**:如需了解详情,请参阅格式和样式设置。**平台:** iOS、Android |
bodyLocKey | 字符串 | 应用字符串资源中正文字符串的键,用于将正文文字本地化为用户当前的本地化设置语言。**iOS**:对应于 APNs 载荷中的 loc-key 。如需了解详情,请参阅载荷键参考和本地化远程通知的内容。**Android:如需了解详情,请参阅字符串资源。**平台:**iOS、Android |
clickAction | 字符串 | 与用户点击通知相关的操作。如果已指定,将在用户点击通知时启动具有匹配 intent 过滤器的 activity。***平台**:Android |
颜色 | 字符串 | 通知图标的颜色,以 #rrggbb 格式表示。**平台:** Android |
图标 | 字符串 | 通知的图标。**Android:** 将可绘制资源 myicon 的通知图标设置为 myicon 。如果您不在请求中发送此键,FCM 将会显示您的应用清单中指定的启动器图标。**网站:** 通知图标使用的网址。**平台:** Android、Web |
声音 | 字符串 | 设备收到通知时要播放的声音。支持“default”设备的默认通知提示音或应用中绑定的声音资源的文件名。声音文件必须位于 /res/raw/ 中。**平台:** Android |
代码 | 字符串 | 用于替换抽屉式通知栏中现有通知的标识符。如果未指定,每次请求都会创建新通知。如果已指定且已显示带有相同标签的通知,则新通知将替换抽屉式通知栏中的现有通知。**平台:** Android |
title | 字符串 | 通知的标题。**平台:** iOS、Android、Web |
titleLocArgs | 字符串 | 用于替换 title_loc_key 中的格式说明符的变量字符串值,用于将标题文字本地化为用户当前的本地化语言。该值应为字符串化 JSON 数组。**iOS** 对应于 APNs 载荷中的 title-loc-args 。如需了解详情,请参阅载荷键参考和本地化远程通知的内容。**Android**:如需了解详情,请参阅格式和样式设置。**平台:** iOS、Android |
titleLocKey | 字符串 | 应用的字符串资源中标题字符串的键,用于将标题文字本地化为用户当前的本地化设置语言。**iOS**:对应于 APNs 载荷中的 title-loc-key 。如需了解详情,请参阅载荷键参考和本地化远程通知的内容。**Android:如需了解详情,请参阅字符串资源。**平台:**iOS、Android |
NotificationMessagePayload.badge
主屏幕应用图标上的标志值。
如果未指定,则标志不会更改。
如果设为 0
,则会移除该徽章。
**平台**:iOS
签名:
badge?: string;
NotificationMessagePayload.body
通知的正文。
**平台:** iOS、Android、Web
签名:
body?: string;
NotificationMessagePayload.bodyLocArgs
将用于替换 body_loc_key
(用来将正文文字本地化为用户当前的本地化设置语言)中的格式说明符的变量字符串值。
该值应为字符串化 JSON 数组。
**iOS**:对应于 APNs 载荷中的 loc-args
。如需了解详情,请参阅载荷键参考和本地化远程通知的内容。
**Android:** 如需了解详情,请参阅格式和样式设置。
**平台**:iOS、Android
签名:
bodyLocArgs?: string;
NotificationMessagePayload.bodyLocKey
应用的字符串资源中正文字符串的键,用于将正文文字本地化为用户当前的本地化设置语言。
**iOS**:对应于 APNs 载荷中的 loc-key
。如需了解详情,请参阅载荷键参考和本地化远程通知的内容。
**Android**:如需了解详情,请参阅字符串资源。
**平台**:iOS、Android
签名:
bodyLocKey?: string;
NotificationMessagePayload.clickAction
与用户点击通知相关的操作。如果已指定,将在用户点击通知时启动具有匹配 Intent 过滤器的 Activity。
* **平台**:Android
签名:
clickAction?: string;
NotificationMessagePayload.color
通知图标的颜色,以 #rrggbb
格式表示。
**平台**:Android
签名:
color?: string;
NotificationMessagePayload.icon
通知的图标。
**Android:** 将可绘制资源 myicon
的通知图标设置为 myicon
。如果您不在请求中发送此键,FCM 将会显示您的应用清单中指定的启动器图标。
**网页**:用于通知图标的网址。
**平台:** Android、Web
签名:
icon?: string;
NotificationMessagePayload.sound
设备收到通知时要播放的声音。支持“default”设备的默认通知提示音或应用中绑定的声音资源的文件名。声音文件必须位于 /res/raw/
中。
**平台**:Android
签名:
sound?: string;
NotificationMessagePayload.tag
用于替换抽屉式通知栏中现有通知的标识符。
如果未指定,则每次请求都会创建一条新的通知。
如果已指定此参数,且已显示带有相同标记的通知,则新通知将替换抽屉式通知栏中的现有通知。
**平台**:Android
签名:
tag?: string;
通知消息载荷.title
通知的标题。
**平台:** iOS、Android、Web
签名:
title?: string;
NotificationMessagePayload.titleLocArgs
将用于替换 title_loc_key
(用来将标题文字本地化为用户当前的本地化设置语言)中的格式说明符的变量字符串值。
该值应为字符串化 JSON 数组。
**iOS**:对应于 APNs 载荷中的 title-loc-args
。如需了解详情,请参阅载荷键参考和本地化远程通知的内容。
**Android**:如需了解详情,请参阅格式和样式设置。
**平台:** iOS、Android
签名:
titleLocArgs?: string;
NotificationMessagePayload.titleLocKey
应用的字符串资源中标题字符串的键,用于将标题文字本地化为用户当前的本地化设置语言。
**iOS**:对应于 APNs 载荷中的 title-loc-key
。如需了解详情,请参阅载荷键参考和本地化远程通知的内容。
**Android**:如需了解详情,请参阅字符串资源。
**平台:** iOS、Android
签名:
titleLocKey?: string;