未验证 提交 cfb29608 编写于 作者: O openharmony_ci 提交者: Gitee

!12269 事件通知开发指南链接修改

Merge pull request !12269 from FangJinliang/pr_1207
...@@ -7,7 +7,7 @@ OpenHarmony通过CES(Common Event Service,公共事件服务)为应用程 ...@@ -7,7 +7,7 @@ OpenHarmony通过CES(Common Event Service,公共事件服务)为应用程
公共事件从系统角度可分为:系统公共事件和自定义公共事件。 公共事件从系统角度可分为:系统公共事件和自定义公共事件。
- 系统公共事件:CES内部定义的公共事件,只有系统应用和系统服务才能发布,例如HAP安装,更新,卸载等公共事件。目前支持的系统公共事件详见[系统公共事件列表](../reference/apis/js-apis-commonEvent.md#support) - 系统公共事件:CES内部定义的公共事件,只有系统应用和系统服务才能发布,例如HAP安装,更新,卸载等公共事件。目前支持的系统公共事件详见[系统公共事件列表](../reference/apis/js-apis-commonEventManager.md#support)
- 自定义公共事件:应用自定义一些公共事件用来实现跨进程的事件通信能力。 - 自定义公共事件:应用自定义一些公共事件用来实现跨进程的事件通信能力。
......
...@@ -16,7 +16,7 @@ ...@@ -16,7 +16,7 @@
| 接口名 | 接口描述 | | 接口名 | 接口描述 |
| -------- | -------- | | -------- | -------- |
| publish(event: string, callback: AsyncCallback) | 发布公共事件。 | | publish(event: string, callback: AsyncCallback) | 发布公共事件。 |
| publish(event: string, options: [CommonEventPublishData](../reference/apis/js-apis-commonEvent.md#commoneventpublishdata), callback: AsyncCallback) | 指定发布信息并发布公共事件。 | | publish(event: string, options: [CommonEventPublishData](../reference/apis/js-apis-commonEventManager.md#commoneventpublishdata), callback: AsyncCallback) | 指定发布信息并发布公共事件。 |
## 发布不携带信息的公共事件 ## 发布不携带信息的公共事件
...@@ -45,7 +45,7 @@ ...@@ -45,7 +45,7 @@
## 发布携带信息的公共事件 ## 发布携带信息的公共事件
携带信息的公共事件,可以发布为无序公共事件、有序公共事件和粘性事件,可以通过参数[CommonEventPublishData](../reference/apis/js-apis-commonEvent.md#commoneventpublishdata)的isOrdered、isSticky的字段进行设置。 携带信息的公共事件,可以发布为无序公共事件、有序公共事件和粘性事件,可以通过参数[CommonEventPublishData](../reference/apis/js-apis-commonEventManager.md#commoneventpublishdata)的isOrdered、isSticky的字段进行设置。
1. 导入CommonEvent模块。 1. 导入CommonEvent模块。
......
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
## 场景介绍 ## 场景介绍
当需要订阅某个公共事件,获取该公共事件传递的参数时,需要创建一个订阅者对象,用于作为订阅公共事件的载体,订阅公共事件并获取公共事件传递而来的参数。订阅部分系统公共事件需要先[申请权限](../security/accesstoken-guidelines.md),订阅这些事件所需要的权限请见[公共事件权限列表](../reference/apis/js-apis-commonEvent.md#support) 当需要订阅某个公共事件,获取该公共事件传递的参数时,需要创建一个订阅者对象,用于作为订阅公共事件的载体,订阅公共事件并获取公共事件传递而来的参数。订阅部分系统公共事件需要先[申请权限](../security/accesstoken-guidelines.md),订阅这些事件所需要的权限请见[公共事件权限列表](../reference/apis/js-apis-commonEventManager.md#support)
## 接口说明 ## 接口说明
...@@ -12,7 +12,7 @@ ...@@ -12,7 +12,7 @@
| 接口名 | 接口描述 | | 接口名 | 接口描述 |
| -------- | -------- | | -------- | -------- |
| createSubscriber(subscribeInfo: [CommonEventSubscribeInfo](../reference/apis/js-apis-commonEvent.md#commoneventsubscribeinfo), callback: AsyncCallback<[CommonEventData](../reference/apis/js-apis-commonEvent.md#commoneventdata)>): void | 创建订阅者对象(callback) | | createSubscriber(subscribeInfo: [CommonEventSubscribeInfo](../reference/apis/js-apis-commonEventManager.md#commoneventsubscribeinfo), callback: AsyncCallback<[CommonEventData](../reference/apis/js-apis-commonEventManager.md#commoneventdata)>): void | 创建订阅者对象(callback) |
| createSubscriber(subscribeInfo: CommonEventSubscribeInfo): Promise<CommonEventSubscriber> | 创建订阅者对象(promise) | | createSubscriber(subscribeInfo: CommonEventSubscribeInfo): Promise<CommonEventSubscriber> | 创建订阅者对象(promise) |
| subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback): void | 订阅公共事件 | | subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback): void | 订阅公共事件 |
...@@ -25,7 +25,7 @@ ...@@ -25,7 +25,7 @@
import commonEvent from '@ohos.commonEventManager'; import commonEvent from '@ohos.commonEventManager';
``` ```
2. 创建订阅者信息,详细的订阅者信息数据类型及包含的参数请见[CommonEventSubscribeInfo](../reference/apis/js-apis-commonEvent.md#commoneventsubscribeinfo)文档介绍。 2. 创建订阅者信息,详细的订阅者信息数据类型及包含的参数请见[CommonEventSubscribeInfo](../reference/apis/js-apis-commonEventManager.md#commoneventsubscribeinfo)文档介绍。
```ts ```ts
// 用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作 // 用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
...@@ -51,7 +51,7 @@ ...@@ -51,7 +51,7 @@
}) })
``` ```
4. 创建订阅回调函数,订阅回调函数会在接收到事件时触发。订阅回调函数返回的data内包含了公共事件的名称、发布者携带的数据等信息,公共事件数据的详细参数和数据类型请见[CommonEventData](../reference/apis/js-apis-commonEvent.md#commoneventdata)文档介绍。 4. 创建订阅回调函数,订阅回调函数会在接收到事件时触发。订阅回调函数返回的data内包含了公共事件的名称、发布者携带的数据等信息,公共事件数据的详细参数和数据类型请见[CommonEventData](../reference/apis/js-apis-commonEventManager.md#commoneventdata)文档介绍。
```ts ```ts
// 订阅公共事件回调 // 订阅公共事件回调
......
# 使能通知开关 # 使能通知开关
应用需要开启通知开关才能发送通知。开发者可以在通知发布前调用[requestEnableNotification()](../reference/apis/js-apis-notification.md#notificationrequestenablenotification8)方法,弹窗让用户选择是否开启使能开关,仅弹窗一次,后续调用该接口不再弹窗。 应用需要开启通知开关才能发送通知。开发者可以在通知发布前调用[requestEnableNotification()](../reference/apis/js-apis-notificationManager.md#notificationrequestenablenotification)方法,弹窗让用户选择是否开启使能开关,仅弹窗一次,后续调用该接口不再弹窗。
**图1** 使能通知开关示意图 **图1** 使能通知开关示意图
![zh-cn_image_0000001416585590](figures/zh-cn_image_0000001416585590.png) ![zh-cn_image_0000001416585590](figures/zh-cn_image_0000001416585590.png)
...@@ -9,7 +9,7 @@ ...@@ -9,7 +9,7 @@
- 点击“允许”后,则表示允许应用发送通知。 - 点击“允许”后,则表示允许应用发送通知。
- 点击“取消”后,再次调用[requestEnableNotification()](../reference/apis/js-apis-notification.md#notificationrequestenablenotification8)方法,则不再弹窗。此时如需要手动使能通知开关,操作步骤如下所示。 - 点击“取消”后,再次调用[requestEnableNotification()](../reference/apis/js-apis-notificationManager.md#notificationrequestenablenotification)方法,则不再弹窗。此时如需要手动使能通知开关,操作步骤如下所示。
| ①从设备左上方下拉,进入通知界面 | ②点击右上角“设置”图标,进入通知界面,找到需要打开通知开关的应用 | ③打开“允许通知”开关 | | ①从设备左上方下拉,进入通知界面 | ②点击右上角“设置”图标,进入通知界面,找到需要打开通知开关的应用 | ③打开“允许通知”开关 |
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
...@@ -18,14 +18,14 @@ ...@@ -18,14 +18,14 @@
## 接口说明 ## 接口说明
详细接口见[接口文档](../reference/apis/js-apis-notification.md#notificationrequestenablenotification8) 详细接口见[接口文档](../reference/apis/js-apis-notificationManager.md#notificationrequestenablenotification)
**表1** 通知开关接口功能介绍 **表1** 通知开关接口功能介绍
| **接口名** | **描述** | | **接口名** | **描述** |
| -------- | -------- | | -------- | -------- |
| isNotificationEnabled(bundle:&nbsp;BundleOption,&nbsp;callback:&nbsp;AsyncCallback&lt;boolean&gt;):&nbsp;void | 查询通知开关。<br/>**说明:**<br/>仅支持系统应用调用。 | | isNotificationEnabled(bundle:&nbsp;BundleOption,&nbsp;callback:&nbsp;AsyncCallback&lt;boolean&gt;):&nbsp;void | 查询通知开关。<br/>**说明:**<br/>仅支持系统应用调用。 |
| enableNotification(bundle:&nbsp;BundleOption,&nbsp;enable:&nbsp;boolean,&nbsp;callback:&nbsp;AsyncCallback&lt;void&gt;):&nbsp;void | 设置通知开关。例如在“设置&nbsp;&gt;&nbsp;应用和服务&nbsp;&gt;&nbsp;应用管理”,进入对应应用信息的“通知管理”中设置通知开关状态。<br/>**说明:**<br/>仅支持系统应用调用。 | | setNotificationEnable(bundle:&nbsp;BundleOption,&nbsp;enable:&nbsp;boolean,&nbsp;callback:&nbsp;AsyncCallback&lt;void&gt;):&nbsp;void | 设置通知开关。例如在“设置&nbsp;&gt;&nbsp;应用和服务&nbsp;&gt;&nbsp;应用管理”,进入对应应用信息的“通知管理”中设置通知开关状态。<br/>**说明:**<br/>仅支持系统应用调用。 |
| requestEnableNotification(callback:&nbsp;AsyncCallback&lt;void&gt;):&nbsp;void | 请求发送通知的许可,第一次调用弹窗供用户选择允许或禁止。 | | requestEnableNotification(callback:&nbsp;AsyncCallback&lt;void&gt;):&nbsp;void | 请求发送通知的许可,第一次调用弹窗供用户选择允许或禁止。 |
......
...@@ -9,7 +9,7 @@ ...@@ -9,7 +9,7 @@
## 接口说明 ## 接口说明
通知订阅主要接口如下。详细接口介绍请参见[API参考](../reference/apis/js-apis-notification.md#notification%E6%A8%A1%E5%9D%97) 通知订阅主要接口如下。详细接口介绍请参见[API参考](../reference/apis/js-apis-notificationSubscribe.md)
**表1** 通知订阅接口介绍 **表1** 通知订阅接口介绍
...@@ -35,7 +35,7 @@ ...@@ -35,7 +35,7 @@
## 开发步骤 ## 开发步骤
1. 申请`ohos.permission.NOTIFICATION_CONTROLLER`权限,配置方式请参阅[访问控制授权申请指导](../security/accesstoken-guidelines.md#stage%E6%A8%A1%E5%9E%8B) 1. 申请`ohos.permission.NOTIFICATION_CONTROLLER`权限,配置方式请参阅[访问控制授权申请指导](../security/accesstoken-guidelines.md)
2. 导入通知订阅模块。 2. 导入通知订阅模块。
......
...@@ -3,14 +3,14 @@ ...@@ -3,14 +3,14 @@
进度条通知也是常见的通知类型,主要应用于文件下载、事务处理进度显示。OpenHarmony提供了进度条模板,发布通知应用设置好进度条模板的属性值,如模板名、模板数据,通过通知子系统发送到通知栏显示。 进度条通知也是常见的通知类型,主要应用于文件下载、事务处理进度显示。OpenHarmony提供了进度条模板,发布通知应用设置好进度条模板的属性值,如模板名、模板数据,通过通知子系统发送到通知栏显示。
目前系统模板仅支持进度条模板,通知模板[NotificationTemplate](../reference/apis/js-apis-notification.md#notificationtemplate8)中的data参数为用户自定义数据,用于显示与模块相关的数据,效果示意如下图所示。 目前系统模板仅支持进度条模板,通知模板[NotificationTemplate](../reference/apis/js-apis-notificationManager.md#notificationtemplate)中的data参数为用户自定义数据,用于显示与模块相关的数据,效果示意如下图所示。
![zh-cn_image_0000001416903138](figures/zh-cn_image_0000001416903138.png) ![zh-cn_image_0000001416903138](figures/zh-cn_image_0000001416903138.png)
## 接口说明 ## 接口说明
[isSupportTemplate()](../reference/apis/js-apis-notification.md#notificationissupporttemplate8)是查询模板是否支持接口,目前仅支持进度条模板。 [isSupportTemplate()](../reference/apis/js-apis-notificationManager.md#notificationissupporttemplate)是查询模板是否支持接口,目前仅支持进度条模板。
| | | | | |
| -------- | -------- | | -------- | -------- |
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册