消息通知
更新时间：
接口声明
{ "name": "blueos.app.notification.notificationManager" }复制代码
导入模块
import notification from '@blueos.app.notification.notificationManager' 或 const notification = require('@blueos.app.notification.notificationManager')复制代码
接口定义
notification.publish(OBJECT)
发布通知
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| request | Notification | 是 | 消息通知对象 |
| success | Function | 是 | 成功的回调 |
| fail | Function | 是 | 失败的回调 |
| complete | Function | 是 | 执行结束后的回调 |
Notification
说明如下：
| 参数名 | 类型 | 必填 | 默认 | 说明 | |
|---|---|---|---|---|---|
| icon | String | 是 | - | 通知小图标，应用下的图片的绝对路径 | |
| id | number | 否 | - | 应用通知的唯一 id | |
| appName | String | 否 | - | 应用名称 | |
| contentType | Number | 是 | - | 正文类型。 1：普通文本通知类型。 2：图片通知类型 | |
| content | Content | 是 | - | 通知内容 与 contentType 对应 | |
| channel | Number | 是 | - | 通知来源 , 1：PHONE；2：WATCH_APP | |
| platform | String | 否 | - | 消息渠道来源 (PHONE 时) iOS | Andriod | |
| deliveryTime | Number | 是 | - | 通知发送时间 | |
| actionButtons | Array<ActionButton> | 否 | - | 通知按钮，最多两个按钮 | |
| largeIcon | String | 否 | - | 通知大图标，应用下的图片的绝对路径 | |
| isUnremovable | Boolean | 否 | false | 是否不可清除 | |
| badge | Number | 否 | - | 数字角标(消息合并情况下) | |
| appBundleName | String | 否 | - | 应用包名 ，格式 com.xxx.xxx，该字段的值应由 native 填充 | |
| group | String | 否 | - | 消息分组 | |
| extraInfo | {[key: String]: any} | 否 | - | 扩展参数 |
Content
普通文本通知类型
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| title | String | 是 | 普通文本通知标题 |
| text | String | 是 | 普通文本通知内容 |
| additionalText | String | 否 | 可选参数，普通文本通知附加信息 |
图片通知类型
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| title | String | 是 | 通知标题 |
| text | String | 是 | 通知内容 |
| additionalText | String | 否 | 可选参数，通知附加信息 |
| briefText | String | 是 | 图片文本通知简略内容 |
| expandedTitle | String | 是 | 图片通知扩展标题 |
| picture | String | 是 | 图片通知的图片，，应用下的图片的绝对路径 |
ActionButton
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| label | String | 是 | 按钮标题 |
| action | Action | 是 | 点击按钮时触发的动作 |
| extras | {[key: String]: any} | 否 | 扩展参数 |
Action
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| triggerMethod | String | 否 | 定义按钮点击触发的回调函数, 需要在 app.ux 中定义 |
| prameters | {[key: String]: any} | 否 | 自定义参数，供回调函数使用 |
示例：
notification.publish({
request: {
icon: './icon.png',
contentType: 1,
content: {
title: '收件通知',
text: '门口xx收件，收件码：XXX',
},
channel: 1,
deliveryTime: Date.now(),
},
success: function () {},
fail: function () {},
complete: function () {},
})复制代码
notification.remove(OBJECT)
清除消息通知
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| query | Query | 是 | 清除的查询条件，如果条件为空则全部清除 |
| success | Function | 是 | 成功的回调 |
| fail | Function | 是 | 失败的回调 |
| complete | Function | 是 | 执行结束后的回调 |
Query 参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id | Number | 否 | 应用通知的唯一 id |
| group | String | 否 | 通知的分组 |
示例：
notification.remove({
query: {
group: 'group1',
},
success: function () {},
fail: function () {},
complete: function () {},
})复制代码