表示 FCM 旧版 API 通知消息负载的接口。通知消息允许开发人员发送最多 4KB 的预定义键值对。接受的密钥概述如下。
请参阅构建发送请求以获取代码示例和详细文档。
签名:
export interface NotificationMessagePayload
特性
财产 | 类型 | 描述 |
---|---|---|
徽章 | 细绳 | 主屏幕应用程序图标上的徽章的值。如果未指定,则不会更改徽章。如果设置为0 ,则徽章将被删除。 **平台:** iOS |
身体 | 细绳 | 通知的正文。 **平台:** iOS、Android、Web |
身体定位参数 | 细绳 | 用于代替body_loc_key 中的格式说明符的变量字符串值,用于将正文文本本地化为用户当前的本地化。该值应该是字符串化的 JSON 数组。 **iOS:** 对应于 APNs 负载中的loc-args 。有关更多信息,请参阅有效负载密钥参考和本地化远程通知的内容。 **Android:** 请参阅格式和样式以获取更多信息。 **平台:** iOS、Android |
身体锁匙 | 细绳 | 应用程序字符串资源中正文字符串的键,用于将正文文本本地化为用户当前的本地化。 **iOS:** 对应于 APNs 负载中的loc-key 。有关更多信息,请参阅有效负载密钥参考和本地化远程通知的内容。 **Android:** 请参阅字符串资源以获取更多信息。 **平台:** iOS、Android |
点击动作 | 细绳 | 与用户单击通知相关的操作。如果指定,当用户单击通知时,将启动具有匹配 Intent Filter 的活动。 * **平台:** Android |
颜色 | 细绳 | 通知图标的颜色,以#rrggbb 格式表示。 **平台:** Android |
图标 | 细绳 | 通知的图标。 **Android:** 将可绘制资源myicon 的通知图标设置为myicon 。如果您不在请求中发送此密钥,FCM 将显示应用程序清单中指定的启动器图标。 **Web:** 用于通知图标的 URL。 **平台:** Android、Web |
声音 | 细绳 | 设备收到通知时播放的声音。支持设备的默认通知声音或应用程序中捆绑的声音资源的文件名“默认”。声音文件必须位于/res/raw/ 中。 **平台:** Android |
标签 | 细绳 | 用于替换通知抽屉中现有通知的标识符。如果未指定,每个请求都会创建一个新通知。如果指定并且已显示具有相同标签的通知,则新通知将替换通知抽屉中的现有通知。 **平台:** Android |
标题 | 细绳 | 通知的标题。 **平台:** iOS、Android、Web |
标题定位参数 | 细绳 | 用于代替title_loc_key 中的格式说明符的变量字符串值,用于将标题文本本地化为用户当前的本地化。该值应该是字符串化的 JSON 数组。 **iOS:** 对应于 APNs 负载中的title-loc-args 。有关更多信息,请参阅有效负载密钥参考和本地化远程通知的内容。 **Android:** 请参阅格式和样式以获取更多信息。 **平台:** iOS、Android |
标题锁键 | 细绳 | 应用程序字符串资源中标题字符串的键,用于将标题文本本地化为用户当前的本地化版本。 **iOS:** 对应于 APNs 负载中的title-loc-key 。有关更多信息,请参阅有效负载密钥参考和本地化远程通知的内容。 **Android:** 请参阅字符串资源以获取更多信息。 **平台:** iOS、Android |
通知消息有效负载.badge
主屏幕应用程序图标上的徽章的值。
如果未指定,则不会更改徽章。
如果设置为0
,徽章被移除。
**平台:** iOS
签名:
badge?: string;
通知消息有效负载.body
通知的正文。
**平台:** iOS、Android、Web
签名:
body?: string;
通知消息负载.bodyLocArgs
用于代替body_loc_key
中的格式说明符的变量字符串值,用于将正文文本本地化为用户当前的本地化。
该值应该是字符串化的 JSON 数组。
**iOS:** 对应于 APNs 负载中的loc-args
。有关更多信息,请参阅有效负载密钥参考和本地化远程通知的内容。
**Android:** 请参阅格式和样式以获取更多信息。
**平台:** iOS、Android
签名:
bodyLocArgs?: string;
通知消息有效负载.bodyLocKey
应用程序字符串资源中正文字符串的键,用于将正文文本本地化为用户当前的本地化。
**iOS:** 对应于 APNs 负载中的loc-key
。有关更多信息,请参阅有效负载密钥参考和本地化远程通知的内容。
**Android:** 请参阅字符串资源以获取更多信息。
**平台:** iOS、Android
签名:
bodyLocKey?: string;
通知消息有效负载.clickAction
与用户单击通知相关的操作。如果指定,当用户单击通知时,将启动具有匹配 Intent Filter 的活动。
* **平台:** Android
签名:
clickAction?: string;
通知消息有效负载.color
通知图标的颜色,以#rrggbb
格式表示。
**平台:** Android
签名:
color?: string;
通知消息有效负载.icon
通知的图标。
**Android:** 将可绘制资源myicon
的通知图标设置为myicon
。如果您不在请求中发送此密钥,FCM 将显示应用程序清单中指定的启动器图标。
**Web:** 用于通知图标的 URL。
**平台:** Android、网络
签名:
icon?: string;
通知消息有效负载.声音
设备收到通知时播放的声音。支持设备默认通知声音或应用程序中捆绑的声音资源的文件名“默认”。声音文件必须位于/res/raw/
中。
**平台:** Android
签名:
sound?: string;
通知消息有效负载.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;
通知消息有效负载.titleLocKey
应用程序字符串资源中标题字符串的键,用于将标题文本本地化为用户当前的本地化版本。
**iOS:** 对应于 APNs 负载中的title-loc-key
。有关更多信息,请参阅有效负载密钥参考和本地化远程通知的内容。
**Android:** 请参阅字符串资源以获取更多信息。
**平台:** iOS、Android
签名:
titleLocKey?: string;