From 6fba56de4f106ee4d08f7de1f55719e0aa835a7d Mon Sep 17 00:00:00 2001 From: fangJinliang1 Date: Thu, 1 Dec 2022 18:13:15 +0800 Subject: [PATCH] ans/ces docs modify Signed-off-by: fangJinliang1 --- .../application-models/common-event-overview.md | 6 +++--- .../application-models/common-event-publish.md | 4 ++-- .../application-models/common-event-subscription.md | 10 +++++----- zh-cn/application-dev/notification/Readme-CN.md | 2 +- .../notification/notification-enable.md | 6 +++--- .../notification/notification-overview.md | 2 +- .../notification/notification-subscription.md | 4 ++-- .../notification/notification-with-wantagent.md | 2 +- .../notification/progress-bar-notification.md | 4 ++-- .../application-dev/notification/text-notification.md | 2 +- 10 files changed, 21 insertions(+), 21 deletions(-) diff --git a/zh-cn/application-dev/application-models/common-event-overview.md b/zh-cn/application-dev/application-models/common-event-overview.md index 9b5537ce3..b02f240ca 100644 --- a/zh-cn/application-dev/application-models/common-event-overview.md +++ b/zh-cn/application-dev/application-models/common-event-overview.md @@ -7,7 +7,7 @@ OpenHarmony通过CES（Common Event Service，公共事件服务）为应用程 公共事件从系统角度可分为：系统公共事件和自定义公共事件。 -- 系统公共事件：CES内部定义的公共事件，只有系统应用和系统服务才能发布，例如HAP安装，更新，卸载等公共事件。目前支持的系统公共事件详见[系统公共事件列表](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-commonEvent.md#support)。 +- 系统公共事件：CES内部定义的公共事件，只有系统应用和系统服务才能发布，例如HAP安装，更新，卸载等公共事件。目前支持的系统公共事件详见[系统公共事件列表](../reference/apis/js-apis-commonEvent.md#support)。 - 自定义公共事件：应用自定义一些公共事件用来实现跨进程的事件通信能力。 @@ -19,11 +19,11 @@ OpenHarmony通过CES（Common Event Service，公共事件服务）为应用程 - 有序公共事件：CES转发公共事件时，按订阅者订阅先后顺序，在接收到前一个订阅者回复后，再转发下一个订阅者。 -- 粘性公共事件：能够让订阅者收到在订阅前已经发送的公共事件就是粘性公共事件。普通的公共事件只能在订阅后发送才能收到，而粘性公共事件的特殊性就是可以先发送后订阅。发送粘性事件必须是系统应用或系统服务，且需要申请“ohos.permission.COMMONEVENT_STICKY”权限，配置方式请参阅[访问控制授权申请指导](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/security/accesstoken-guidelines.md#stage%E6%A8%A1%E5%9E%8B)。 +- 粘性公共事件：能够让订阅者收到在订阅前已经发送的公共事件就是粘性公共事件。普通的公共事件只能在订阅后发送才能收到，而粘性公共事件的特殊性就是可以先发送后订阅。发送粘性事件必须是系统应用或系统服务，且需要申请“ohos.permission.COMMONEVENT_STICKY”权限，配置方式请参阅[访问控制授权申请指导](../security/accesstoken-guidelines.md#stage%E6%A8%A1%E5%9E%8B)。 每个应用都可以按需订阅公共事件，订阅成功，当公共事件发布时，系统会将其发送给对应的应用。这些公共事件可能来自系统、其他应用和应用自身。 - **图1** 公共事件示意图   + **图1** 公共事件示意图 ![common-event](figures/common-event.png) diff --git a/zh-cn/application-dev/application-models/common-event-publish.md b/zh-cn/application-dev/application-models/common-event-publish.md index 4988efb60..3fbce1fc7 100644 --- a/zh-cn/application-dev/application-models/common-event-publish.md +++ b/zh-cn/application-dev/application-models/common-event-publish.md @@ -16,7 +16,7 @@ | 接口名 | 接口描述 | | -------- | -------- | | publish(event: string, callback: AsyncCallback) | 发布公共事件。 | -| publish(event: string, options: [CommonEventPublishData](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-commonEvent.md#commoneventpublishdata), callback: AsyncCallback) | 指定发布信息并发布公共事件。 | +| publish(event: string, options: [CommonEventPublishData](../reference/apis/js-apis-commonEvent.md#commoneventpublishdata), callback: AsyncCallback) | 指定发布信息并发布公共事件。 | ## 发布不携带信息的公共事件 @@ -45,7 +45,7 @@ ## 发布携带信息的公共事件 -携带信息的公共事件，可以发布为无序公共事件、有序公共事件和粘性事件，可以通过参数[CommonEventPublishData](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-commonEvent.md#commoneventpublishdata)的isOrdered、isSticky的字段进行设置。 +携带信息的公共事件，可以发布为无序公共事件、有序公共事件和粘性事件，可以通过参数[CommonEventPublishData](../reference/apis/js-apis-commonEvent.md#commoneventpublishdata)的isOrdered、isSticky的字段进行设置。 1. 导入CommonEvent模块。 diff --git a/zh-cn/application-dev/application-models/common-event-subscription.md b/zh-cn/application-dev/application-models/common-event-subscription.md index be43de052..c4c8d2a4c 100644 --- a/zh-cn/application-dev/application-models/common-event-subscription.md +++ b/zh-cn/application-dev/application-models/common-event-subscription.md @@ -3,16 +3,16 @@ ## 场景介绍 -当需要订阅某个公共事件，获取该公共事件传递的参数时，需要创建一个订阅者对象，用于作为订阅公共事件的载体，订阅公共事件并获取公共事件传递而来的参数。订阅部分系统公共事件需要先[申请权限](https://docs.openharmony.cn/pages/v3.2Beta/zh-cn/application-dev/security/accesstoken-guidelines.md/)，订阅这些事件所需要的权限请见[公共事件权限列表](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-commonEvent.md#%E6%9D%83%E9%99%90%E5%88%97%E8%A1%A8)。 +当需要订阅某个公共事件，获取该公共事件传递的参数时，需要创建一个订阅者对象，用于作为订阅公共事件的载体，订阅公共事件并获取公共事件传递而来的参数。订阅部分系统公共事件需要先[申请权限](../security/accesstoken-guidelines.md)，订阅这些事件所需要的权限请见[公共事件权限列表](../reference/apis/js-apis-commonEvent.md#%E6%9D%83%E9%99%90%E5%88%97%E8%A1%A8)。 ## 接口说明 -详细接口见[接口文档](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-commonEvent.md#commoneventcreatesubscriber)。 +详细接口见[接口文档](../reference/apis/js-apis-commonEvent.md#commoneventcreatesubscriber)。 | 接口名 | 接口描述 | | -------- | -------- | -| createSubscriber(subscribeInfo: [CommonEventSubscribeInfo](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-commonEvent.md#commoneventsubscribeinfo), callback: AsyncCallback<[CommonEventData](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-commonEvent.md#commoneventdata)>): void | 创建订阅者对象(callback) | +| 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): Promise<CommonEventSubscriber> | 创建订阅者对象(promise) | | subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback): void | 订阅公共事件 | @@ -25,7 +25,7 @@ import commonEvent from '@ohos.commonEventManager'; ``` -2. 创建订阅者信息，详细的订阅者信息数据类型及包含的参数请见[CommonEventSubscribeInfo](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-commonEvent.md#commoneventsubscribeinfo)文档介绍。 +2. 创建订阅者信息，详细的订阅者信息数据类型及包含的参数请见[CommonEventSubscribeInfo](../reference/apis/js-apis-commonEvent.md#commoneventsubscribeinfo)文档介绍。 ```js // 用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作 @@ -51,7 +51,7 @@ }) ``` -4. 创建订阅回调函数，订阅回调函数会在接收到事件时触发。订阅回调函数返回的data内包含了公共事件的名称、发布者携带的数据等信息，公共事件数据的详细参数和数据类型请见[CommonEventData](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-commonEvent.md#commoneventdata)文档介绍。 +4. 创建订阅回调函数，订阅回调函数会在接收到事件时触发。订阅回调函数返回的data内包含了公共事件的名称、发布者携带的数据等信息，公共事件数据的详细参数和数据类型请见[CommonEventData](../reference/apis/js-apis-commonEvent.md#commoneventdata)文档介绍。 ```js // 订阅公共事件回调 diff --git a/zh-cn/application-dev/notification/Readme-CN.md b/zh-cn/application-dev/notification/Readme-CN.md index 453e6209d..df6f48307 100644 --- a/zh-cn/application-dev/notification/Readme-CN.md +++ b/zh-cn/application-dev/notification/Readme-CN.md @@ -1,4 +1,4 @@ -# 公共事件与通知 +# 通知 - [通知概述](notification-overview.md) - [订阅通知（仅对系统应用开放）](notification-subscription.md) diff --git a/zh-cn/application-dev/notification/notification-enable.md b/zh-cn/application-dev/notification/notification-enable.md index 5821f2257..326d8beb1 100644 --- a/zh-cn/application-dev/notification/notification-enable.md +++ b/zh-cn/application-dev/notification/notification-enable.md @@ -1,7 +1,7 @@ # 使能通知开关 -应用需要开启通知开关才能发送通知。开发者可以在通知发布前调用[requestEnableNotification()](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-notification.md#notificationrequestenablenotification8)方法，弹窗让用户选择是否开启使能开关，仅弹窗一次，后续调用该接口不再弹窗。 +应用需要开启通知开关才能发送通知。开发者可以在通知发布前调用[requestEnableNotification()](../reference/apis/js-apis-notification.md#notificationrequestenablenotification8)方法，弹窗让用户选择是否开启使能开关，仅弹窗一次，后续调用该接口不再弹窗。 **图1** 使能通知开关示意图   @@ -10,7 +10,7 @@ - 点击“允许”后，则表示允许应用发送通知。 -- 点击“取消”后，再次调用[requestEnableNotification()](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-notification.md#notificationrequestenablenotification8)方法，则不再弹窗。此时如需要手动使能通知开关，操作步骤如下所示。 +- 点击“取消”后，再次调用[requestEnableNotification()](../reference/apis/js-apis-notification.md#notificationrequestenablenotification8)方法，则不再弹窗。此时如需要手动使能通知开关，操作步骤如下所示。 1. 从设备左上方下拉，进入通知界面。 ![zh-cn_image_0000001417062434](figures/zh-cn_image_0000001417062434.png) @@ -24,7 +24,7 @@ ## 接口说明 -详细接口见[接口文档](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-notification.md#notificationrequestenablenotification8)。 +详细接口见[接口文档](../reference/apis/js-apis-notification.md#notificationrequestenablenotification8)。 **表1** 通知开关接口功能介绍 diff --git a/zh-cn/application-dev/notification/notification-overview.md b/zh-cn/application-dev/notification/notification-overview.md index 18c7c1cb3..52b4b5881 100644 --- a/zh-cn/application-dev/notification/notification-overview.md +++ b/zh-cn/application-dev/notification/notification-overview.md @@ -20,7 +20,7 @@ OpenHarmony通过ANS（Advanced Notification Service，通知系统服务）对 通知业务流程由通知子系统、通知发送端、通知订阅端组成。 -一条通知从通知发送端产生，通过[IPC通信](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/connectivity/ipc-rpc-overview.md)发送到通知子系统，再由通知子系统分发给通知订阅端。 +一条通知从通知发送端产生，通过[IPC通信](../connectivity/ipc-rpc-overview.md)发送到通知子系统，再由通知子系统分发给通知订阅端。 系统应用还支持通知相关配置，如使能开关、配置参数由系统配置发起请求，发送到通知子系统存储到内存和数据库。 diff --git a/zh-cn/application-dev/notification/notification-subscription.md b/zh-cn/application-dev/notification/notification-subscription.md index 1d4ef9312..3155dca71 100644 --- a/zh-cn/application-dev/notification/notification-subscription.md +++ b/zh-cn/application-dev/notification/notification-subscription.md @@ -9,7 +9,7 @@ ## 接口说明 -通知订阅主要接口如下。详细接口介绍请参见[API参考](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-notification.md#notification%E6%A8%A1%E5%9D%97)。 +通知订阅主要接口如下。详细接口介绍请参见[API参考](../reference/apis/js-apis-notification.md#notification%E6%A8%A1%E5%9D%97)。 **表1** 通知订阅接口介绍 @@ -36,7 +36,7 @@ ## 开发步骤 -1. 申请“ohos.permission.NOTIFICATION_CONTROLLER”权限，配置方式请参阅[访问控制授权申请指导](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/security/accesstoken-guidelines.md#stage%E6%A8%A1%E5%9E%8B)。 +1. 申请“ohos.permission.NOTIFICATION_CONTROLLER”权限，配置方式请参阅[访问控制授权申请指导](../security/accesstoken-guidelines.md#stage%E6%A8%A1%E5%9E%8B)。 2. 导入通知订阅模块。 diff --git a/zh-cn/application-dev/notification/notification-with-wantagent.md b/zh-cn/application-dev/notification/notification-with-wantagent.md index 98fbcf854..7f5be05df 100644 --- a/zh-cn/application-dev/notification/notification-with-wantagent.md +++ b/zh-cn/application-dev/notification/notification-with-wantagent.md @@ -13,7 +13,7 @@ WantAgent提供了封装行为意图的能力，这里所说的行为意图主 ## 接口说明 -具体接口描述，详见[WantAgent接口文档](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-wantAgent.md#wantagent%E6%A8%A1%E5%9D%97)。 +具体接口描述，详见[WantAgent接口文档](../reference/apis/js-apis-wantAgent.md#wantagent%E6%A8%A1%E5%9D%97)。 | | | | -------- | -------- | diff --git a/zh-cn/application-dev/notification/progress-bar-notification.md b/zh-cn/application-dev/notification/progress-bar-notification.md index 411ddb3fa..50889f877 100644 --- a/zh-cn/application-dev/notification/progress-bar-notification.md +++ b/zh-cn/application-dev/notification/progress-bar-notification.md @@ -4,7 +4,7 @@ 进度条通知也是常见的通知类型，主要应用于文件下载、事务处理进度显示。OpenHarmony提供了进度条模板，发布通知应用设置好进度条模板的属性值，如模板名、模板数据，通过通知子系统发送到通知栏显示。 -目前系统模板仅支持进度条模板，通知模板[NotificationTemplate](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-notification.md#notificationtemplate8)中的data参数为用户自定义数据，用于显示与模块相关的数据，效果示意如下图所示。 +目前系统模板仅支持进度条模板，通知模板[NotificationTemplate](../reference/apis/js-apis-notification.md#notificationtemplate8)中的data参数为用户自定义数据，用于显示与模块相关的数据，效果示意如下图所示。 ![zh-cn_image_0000001416903138](figures/zh-cn_image_0000001416903138.png) @@ -12,7 +12,7 @@ ## 接口说明 -[isSupportTemplate()](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-notification.md#notificationissupporttemplate8)是查询模板是否支持接口，目前仅支持进度条模板。 +[isSupportTemplate()](../reference/apis/js-apis-notification.md#notificationissupporttemplate8)是查询模板是否支持接口，目前仅支持进度条模板。 | | | | -------- | -------- | diff --git a/zh-cn/application-dev/notification/text-notification.md b/zh-cn/application-dev/notification/text-notification.md index 7f9ab98c0..9d6bbccd3 100644 --- a/zh-cn/application-dev/notification/text-notification.md +++ b/zh-cn/application-dev/notification/text-notification.md @@ -24,7 +24,7 @@ ## 接口说明 -通知发布接口如下表所示，不同发布类型通知由[NotificationRequest](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-notification.md#notificationrequest)的字段携带不同的信息。 +通知发布接口如下表所示，不同发布类型通知由[NotificationRequest](../reference/apis/js-apis-notification.md#notificationrequest)的字段携带不同的信息。 | | | | -------- | -------- | -- Gitee