diff --git a/README_zh.md b/README_zh.md index 0add1ca75ee7fb41dd56d1a180b3abf30098ea76..27ad5abed9665603e2bf925f5e59b5dcf221f658 100644 --- a/README_zh.md +++ b/README_zh.md @@ -33,7 +33,14 @@ OpenHarmony_v1.x_release：OpenHarmony 1.1.4 LTS稳定版本，[了解版本详 [了解更多版本详情](zh-cn/release-notes/)。 +## 第三方开源软件及许可说明 +3rd-Party-License：[第三方开源软件及许可证说明](zh-cn/contribute/第三方开源软件及许可证说明.md) +## 贡献 +非常欢迎您参与[贡献](zh-cn/contribute/参与贡献.md)，我们鼓励开发者以各种方式参与文档反馈和贡献。 +您可以对现有文档进行评价、简单更改、反馈文档质量问题、贡献您的原创内容，详细请参考[贡献文档](zh-cn/contribute/贡献文档.md)。 + +卓越贡献者将会在开发者社区文档贡献专栏表彰公示。 \ No newline at end of file diff --git a/zh-cn/OpenHarmony-Overview_zh.md b/zh-cn/OpenHarmony-Overview_zh.md index f7e698c5051ce34b1848af423eb8c80805284e07..a20a54b234aa6cc76ec2c62464fbe831d22b96ac 100644 --- a/zh-cn/OpenHarmony-Overview_zh.md +++ b/zh-cn/OpenHarmony-Overview_zh.md @@ -1,4 +1,4 @@ -# OpenHarmony开源项目 +# OpenHarmony开源项目 - [项目介绍](#section1270210396435) - [技术架构](#section2502124574318) @@ -346,7 +346,10 @@ OpenHarmony支持如下几种系统类型： ## 快速入门 -入口：[device-dev/quick-start/Readme-CN.md](device-dev/quick-start/Readme-CN.md) +- 设备开发快速入门：[device-dev/quick-start/Readme-CN.md](device-dev/quick-start/Readme-CN.md) +- 应用开发快速入门：[application-dev/quick-start/Readme-CN.md](application-dev/quick-start/Readme-CN.md) + + ## 代码仓地址 diff --git a/zh-cn/application-dev/ability/fa-pageability.md b/zh-cn/application-dev/ability/fa-pageability.md index 47db1b8792b47b81abf0e492529c9d3f337ceea4..0c8426bcc7ff3e2badadc7437ad76b9dc052c5dd 100644 --- a/zh-cn/application-dev/ability/fa-pageability.md +++ b/zh-cn/application-dev/ability/fa-pageability.md @@ -1,14 +1,14 @@ # PageAbility开发指导 -## PageAbility介绍 +## 概述 +### 功能简介 +PageAbility是具备ArkUI的Ability，是用户具体可见并可以交互的Ability实例，开发者通过IDE创建Ability时，IDE会自动创建相关模板代码。PageAbility相关能力通过单例featureAbility暴露，生命周期相关回调通过app.js/app.ets中回调函数暴露。 -Page模板（以下简称“Page”）是FA唯一支持的模板，用于提供与用户交互的能力。 - -## PageAbility的生命周期 +### PageAbility的生命周期 **Ability生命周期介绍**（Ability Life Cycle）是Ability被调度到INACTIVE、ACTIVE、BACKGROUND等各个状态的统称（主要涉及PageAbility类型和ServiceAbility类型的Ability）。 - - **PageAbility类型的Ability生命周期流转如下图所示** +**PageAbility生命周期流转如下图所示** ![PageAbility-Lifecycle](figures/page-ability-lifecycle.png) @@ -25,76 +25,32 @@ Page模板（以下简称“Page”）是FA唯一支持的模板，用于提供 - **BACKGROUND**: 后台状态，表示当前Ability退到后台，Ability在被销毁后由BACKGROUND状态进入INITIAL状态，或者重新被激活后由BACKGROUND状态进入ACTIVE状态。 -**PageAbility类型Ability生命周期回调如下图所示：** +**PageAbility生命周期回调如下图所示：** ![fa-pageAbility-lifecycle](figures/fa-pageAbility-lifecycle.png) -PageAbility提供如下生命周期回调，开发者可以在 app.js/app.ets 中重写生相关命周期函数 。 - -* onShow() - - Ability由后台不可见状态切换到前台可见状态调用onShow方法，此时用户在屏幕可以看到该Ability。 - -* onHide() - - Ability由前台切换到后台不可见状态时调用onHide方法，此时用户在屏幕看不到该Ability。 - -* onDestroy() - - 应用退出，销毁Ability对象前调用onDestroy方法，开发者可以在该方法里做一些回收资源、清空缓存等应用退出前的准备工作。 - -* onCreate() - - Ability第一次启动创建Ability时调用onCreate方法，开发者可以在该方法里做一些应用初始化工作。 +PageAbility提供命周期回调，开发者可以在 app.js/app.ets 中重写生相关命周期函数 。 -* onInactive() +## 开发指导 +### featureAbility接口说明 - Ability失去焦点时调用onInactive方法，Ability在进入后台状态时会先失去焦点，再进入后台。 +**表1** featureAbility接口介绍 -* onActive() +| 接口名 | 描述 | +| --------------------------------------------------- | --------------- | +| void startAbility(parameter: StartAbilityParameter) | 启动Ability | +| Context getContext(): | 获取应用Context | +| void terminateSelf() | 结束Ability | +| bool hasWindowFocus() | 是否获取焦点 | - Ability切换到前台，并且已经获取焦点时调用onActive方法。 - -* 示例 - -```javascript -export default { - onCreate() { - console.info('Application onCreate') - }, - onDestroy() { - console.info('Application onDestroy') - }, - onShow(){ - console.info('Application onShow') - }, - onHide(){ - console.info('Application onHide') - }, - onInactive(){ - console.info('Application onInactive') - }, - onActive(){ - console.info('Application onActive') - }, -} -``` -## 启动本地PageAbility +### 启动本地PageAbility - * 导入模块 +* 导入模块 ``` import featureAbility from '@ohos.ability.featureAbility' ``` -``` - featureAbility.startAbility(parameter: StartAbilityParameter, callback: AsyncCallback) -``` - -* 接口说明 - - 启动新的ability(callback形式) - * 示例 ```javascript @@ -158,7 +114,7 @@ featureAbility.startAbility({ }, ); ``` -## 启动远程PageAbility +### 启动远程PageAbility * 导入模块 @@ -166,14 +122,6 @@ featureAbility.startAbility({ import featureAbility from '@ohos.ability.featureAbility' ``` -``` -featureAbility.startAbility(parameter: StartAbilityParameter) -``` -* 接口说明 - - 启动远程的ability(promise形式) - 前提：通过deviceManager获取远程deviceid - * 示例 ```javascript @@ -187,7 +135,43 @@ var promise = await featureAbility.startAbility({ } ); ``` -## 开发实例 +### 生命周期接口说明 +**表2** 生命周期回调函数介绍 + +| 接口名 | 描述 | +| ------------ | ------------------------------------------------------------ | +| onShow() | Ability由后台不可见状态切换到前台可见状态调用onShow方法，此时用户在屏幕可以看到该Ability | +| onHide() | Ability由前台切换到后台不可见状态时调用onHide方法，此时用户在屏幕看不到该Ability。 | +| onDestroy() | 应用退出，销毁Ability对象前调用onDestroy方法，开发者可以在该方法里做一些回收资源、清空缓存等应用退出前的准备工作。 | +| onCreate() | Ability第一次启动创建Ability时调用onCreate方法，开发者可以在该方法里做一些应用初始化工作。 | +| onInactive() | Ability失去焦点时调用onInactive方法，Ability在进入后台状态时会先失去焦点，再进入后台。 | +| onActive() | Ability切换到前台，并且已经获取焦点时调用onActive方法。 | + +* 示例 +开发者需要重写app.js/app.ets 中相关生命周期回调函数，IDE模板默认生成onCreate()和onDestroy()方法，其他方法需要开发者自行实现。 +```javascript +export default { + onCreate() { + console.info('Application onCreate') + }, + onDestroy() { + console.info('Application onDestroy') + }, + onShow(){ + console.info('Application onShow') + }, + onHide(){ + console.info('Application onHide') + }, + onInactive(){ + console.info('Application onInactive') + }, + onActive(){ + console.info('Application onActive') + }, +} +``` +### 开发实例 针对pageAbility开发，有以下示例工程可供参考： - [DMS](https://gitee.com/openharmony/app_samples/tree/master/ability/DMS) diff --git a/zh-cn/application-dev/reference/apis/js-apis-appmanager.md b/zh-cn/application-dev/reference/apis/js-apis-appmanager.md index 7d82b8f41587422950d4f35724dd839add1c06a8..86c762a4e1347e01f77480f7df31c095f5787640 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-appmanager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-appmanager.md @@ -82,13 +82,11 @@ isRamConstrainedDevice(): Promise\; **示例：** ```js - IsRamConstrainedDevicePromise(){ app.isRamConstrainedDevicePromise().then((data) => { console.log('success:' + JSON.stringify(data)); }).catch((error) => { console.log('failed:' + JSON.stringify(error)); }); - } ``` ## appManager.isRamConstrainedDevice @@ -108,12 +106,10 @@ isRamConstrainedDevice(callback: AsyncCallback\): void; **示例：** ```js - IsRamConstrainedDeviceCallBack(){ app.isRamConstrainedDevicePromise((err, data) => { console.log('startAbility result failed:' + JSON.stringify(err)); console.log('startAbility result success:' + JSON.stringify(data)); }) - } ``` ## appManager.getAppMemorySize @@ -133,13 +129,11 @@ getAppMemorySize(): Promise\; **示例：** ```js - GetAppMemorySize(){ app.getAppMemorySize().then((data) => { console.log('success:' + JSON.stringify(data)); }).catch((error) => { console.log('failed:' + JSON.stringify(error)); }); - } ``` ## appManager.getAppMemorySize @@ -159,12 +153,10 @@ getAppMemorySize(callback: AsyncCallback\): void; **示例：** ```js - GetAppMemorySizeCallBack(){ app.getAppMemorySize((err, data) => { console.log('startAbility result failed :' + JSON.stringify(err)); console.log('startAbility result success:' + JSON.stringify(data)); }) - } ``` ## appManager.getProcessRunningInfos8+ @@ -183,13 +175,11 @@ getProcessRunningInfos(): Promise>; **示例：** ```js - GetProcessRunningInfos(){ app.GetProcessRunningInfos().then((data) => { console.log('success:' + JSON.stringify(data)); }).catch((error) => { console.log('failed:' + JSON.stringify(error)); }); - } ``` ## appManager.getProcessRunningInfos8+ @@ -209,12 +199,10 @@ getProcessRunningInfos(callback: AsyncCallback>): void **示例：** ```js - GetProcessRunningInfosCallBack(){ app.GetProcessRunningInfos((err, data) => { console.log('startAbility result failed :' + JSON.stringify(err)); console.log('startAbility result success:' + JSON.stringify(data)); }) - } ``` ## ProcessRunningInfo diff --git a/zh-cn/application-dev/reference/apis/js-apis-commonEventData.md b/zh-cn/application-dev/reference/apis/js-apis-commonEventData.md index 189cc038db96416207b161bd174dd753215d04a3..bbead21038153a0d76f90f9d4ddfe8cb7a2a1b9c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-commonEventData.md +++ b/zh-cn/application-dev/reference/apis/js-apis-commonEventData.md @@ -5,12 +5,12 @@ ## CommonEventData -**系统能力：**以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent +**系统能力：** 以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent | 名称 | 读写属性 | 类型 | 必填 | 描述 | | ---------- | -------- | -------------------- | ---- | ------------------------------------------------------- | -| event | 只读 | string | 是 | 表示当前接收的公共事件名称 | -| bundleName | 只读 | string | 否 | 表示包名称 | -| code | 只读 | number | 否 | 表示公共事件的结果代码，用于传递int类型的数据 | -| data | 只读 | string | 否 | 表示公共事件的自定义结果数据，用于传递string类型的数据< | -| parameters | 只读 | {[key: string]: any} | 否 | 表示公共事件的附加信息 | \ No newline at end of file +| event | 只读 | string | 是 | 表示当前接收的公共事件名称。 | +| bundleName | 只读 | string | 否 | 表示包名称。 | +| code | 只读 | number | 否 | 表示公共事件的结果代码，用于传递int类型的数据。 | +| data | 只读 | string | 否 | 表示公共事件的自定义结果数据，用于传递string类型的数据。 | +| parameters | 只读 | {[key: string]: any} | 否 | 表示公共事件的附加信息。 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-commonEventPublishData.md b/zh-cn/application-dev/reference/apis/js-apis-commonEventPublishData.md index 8f9a240fa4cf05cb1e65b5136a0e46b9a69d07b5..ee39ba0876019444183614f241490531217f6f6b 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-commonEventPublishData.md +++ b/zh-cn/application-dev/reference/apis/js-apis-commonEventPublishData.md @@ -5,15 +5,15 @@ ## CommonEventPublishData -**系统能力：**以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent +**系统能力：** 以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent | 名称 | 读写属性 | 类型 | 必填 | 描述 | | --------------------- | -------- | -------------------- | ---- | ---------------------------- | -| bundleName | 只读 | string | 否 | 表示包名称 | -| code | 只读 | number | 否 | 表示公共事件的结果代码 | -| data | 只读 | string | 否 | 表示公共事件的自定义结果数据 | -| subscriberPermissions | 只读 | Array\ | 否 | 表示订阅者的权限 | -| isOrdered | 只读 | boolean | 否 | 表示是否是有序事件 | -| isSticky | 只读 | boolean | 否 | 表示是否是粘性事件 | -| parameters | 只读 | {[key: string]: any} | 否 | 表示公共事件的附加信息 | +| bundleName | 只读 | string | 否 | 表示包名称。 | +| code | 只读 | number | 否 | 表示公共事件的结果代码。 | +| data | 只读 | string | 否 | 表示公共事件的自定义结果数据。 | +| subscriberPermissions | 只读 | Array\ | 否 | 表示订阅者的权限。 | +| isOrdered | 只读 | boolean | 否 | 表示是否是有序事件。 | +| isSticky | 只读 | boolean | 否 | 表示是否是粘性事件。 | +| parameters | 只读 | {[key: string]: any} | 否 | 表示公共事件的附加信息。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-commonEventSubscribeInfo.md b/zh-cn/application-dev/reference/apis/js-apis-commonEventSubscribeInfo.md index 546a275e7be103559b8369ce14d65f906c5a15ba..45fa02c374125ae5ab7b2b8ebff9f9c5cdbb2d09 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-commonEventSubscribeInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-commonEventSubscribeInfo.md @@ -5,12 +5,12 @@ ## CommonEventSubscribeInfo -**系统能力：**以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent +**系统能力：** 以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent | 名称 | 读写属性 | 类型 | 必填 | 描述 | | ------------------- | -------- | -------------- | ---- | ------------------------------------------------------------ | -| events | 只读 | Array\ | 是 | 表示要发送的公共事件 | -| publisherPermission | 只读 | string | 否 | 表示发布者的权限 | -| publisherDeviceId | 只读 | string | 否 | 表示设备ID，该值必须是同一ohos网络上的现有设备ID | +| events | 只读 | Array\ | 是 | 表示要发送的公共事件。 | +| publisherPermission | 只读 | string | 否 | 表示发布者的权限。 | +| publisherDeviceId | 只读 | string | 否 | 表示设备ID，该值必须是同一ohos网络上的现有设备ID。 | | userId | 只读 | number | 否 | 表示用户ID。此参数是可选的，默认值当前用户的ID。如果指定了此参数，则该值必须是系统中现有的用户ID。 | -| priority | 只读 | number | 否 | 表示订阅者的优先级。值的范围是-100到1000 | \ No newline at end of file +| priority | 只读 | number | 否 | 表示订阅者的优先级。值的范围是-100到1000。 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-commonEventSubscriber.md b/zh-cn/application-dev/reference/apis/js-apis-commonEventSubscriber.md index f2e9d685920e39137a7e3bcf3a9bc30b9beca8f0..bd9fa5fa8d68e66047faade516617e3ac0668bfa 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-commonEventSubscriber.md +++ b/zh-cn/application-dev/reference/apis/js-apis-commonEventSubscriber.md @@ -17,7 +17,7 @@ getCode(callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 描述 | | -------- | ---------------------- | ---- | ------------------ | -| callback | AsyncCallback\ | 是 | 公共事件的结果代码 | +| callback | AsyncCallback\ | 是 | 公共事件的结果代码。 | **示例：** @@ -104,7 +104,7 @@ setCode(code: number): Promise\ | 参数名 | 类型 | 必填 | 描述 | | ------ | ------ | ---- | ------------------ | -| code | number | 是 | 公共事件的结果代码 | +| code | number | 是 | 公共事件的结果代码。 | **示例：** @@ -160,7 +160,7 @@ getData(): Promise\ | 类型 | 说明 | | ---------------- | ------------------ | -| Promise\ | 公共事件的结果数据 | +| Promise\ | 公共事件的结果数据。 | **示例：** @@ -186,8 +186,8 @@ setData(data: string, callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 描述 | | -------- | -------------------- | ---- | -------------------- | -| data | string | 是 | 公共事件的结果数据 | -| callback | AsyncCallback\ | 是 | 表示被指定的回调方法 | +| data | string | 是 | 公共事件的结果数据。 | +| callback | AsyncCallback\ | 是 | 表示被指定的回调方法。 | **示例：** @@ -472,7 +472,7 @@ clearAbortCommonEvent(callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 描述 | | -------- | -------------------- | ---- | -------------------- | -| callback | AsyncCallback\ | 是 | 表示被指定的回调方法 | +| callback | AsyncCallback\ | 是 | 表示被指定的回调方法。 | **示例：** @@ -522,7 +522,7 @@ getAbortCommonEvent(callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 描述 | | -------- | ----------------------- | ---- | ---------------------------------- | -| callback | AsyncCallback\ | 是 | 表示当前有序公共事件是否取消的状态 | +| callback | AsyncCallback\ | 是 | 表示当前有序公共事件是否取消的状态。 | **示例：** @@ -552,7 +552,7 @@ getAbortCommonEvent(): Promise\ | 类型 | 说明 | | ----------------- | ---------------------------------- | -| Promise\ | 表示当前有序公共事件是否取消的状态 | +| Promise\ | 表示当前有序公共事件是否取消的状态。 | **示例：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-featureAbility.md b/zh-cn/application-dev/reference/apis/js-apis-featureAbility.md index 6fd72b7c6d229271bd1ac8450929823ac1689184..785a7a075ea7c9a9c047835aa2c300135d7a9c96 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-featureAbility.md +++ b/zh-cn/application-dev/reference/apis/js-apis-featureAbility.md @@ -665,7 +665,11 @@ getWindow(callback: AsyncCallback\): void **示例：** ```javascript +<<<<<<< HEAD featureAbility.getWindow() +======= + featureAbility.getWindow() +>>>>>>> 45a0d5bbd5a373948e44b76b9e7eeb3239fe94e7 ``` ## featureAbility.getWindow7+ @@ -685,9 +689,15 @@ getWindow(): Promise\; **示例：** ```javascript +<<<<<<< HEAD featureAbility.getWindow().then((data) => { console.info("=============getWindowPromise========== " + JSON.stringify(data)); }); +======= + featureAbility.getWindow().then((data) => { + console.info("=============getWindowPromise========== " + JSON.stringify(data)); + }); +>>>>>>> 45a0d5bbd5a373948e44b76b9e7eeb3239fe94e7 ``` ## ConnectOptions.onConnect7+ diff --git a/zh-cn/application-dev/reference/apis/js-apis-notification.md b/zh-cn/application-dev/reference/apis/js-apis-notification.md index 220b08370f7f8076732e6d49d4ea438d43fcad38..8f8b24a06499afe935dbdb6e9161e52ff9f93942 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-notification.md +++ b/zh-cn/application-dev/reference/apis/js-apis-notification.md @@ -186,7 +186,7 @@ Notification.cancel(0, "label", cancelCallback) ## Notification.cancel -cancel(id：number, label? ：string): Promise\ +cancel(id：number, label?：string): Promise\ 取消与指定id相匹配的已发布通知,label可以指定也可以不指定（Promise形式)。 @@ -2562,7 +2562,7 @@ Notification.getDeviceRemindType() | 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | | ----- | ---- | --- | ------ | ---- | -------- | | id | 是 | 是 | number | 是 | 通知ID。 | -| label | 是 | 是 | string | 否 | 通知标签。< | +| label | 是 | 是 | string | 否 | 通知标签。 | ## SlotType diff --git a/zh-cn/application-dev/reference/apis/js-apis-notificationFlags.md b/zh-cn/application-dev/reference/apis/js-apis-notificationFlags.md index 847757f753b58327aa054f220778dbffc352a1e1..5bec0139381265b8e27a6f585253d7c47c91fcc0 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-notificationFlags.md +++ b/zh-cn/application-dev/reference/apis/js-apis-notificationFlags.md @@ -13,7 +13,7 @@ | -------------- | --- | --------------------------------- | | TYPE_NONE | 0 | 默认标志。 | | TYPE_OPEN | 1 | 通知标志打开。 | -| TYPE_CLOSE | 2 | 通知标志打开。 | +| TYPE_CLOSE | 2 | 通知标志关闭。 | ## NotificationFlags diff --git a/zh-cn/application-dev/reference/apis/js-apis-notificationSubscriber.md b/zh-cn/application-dev/reference/apis/js-apis-notificationSubscriber.md index 01a8ad8549a5f780c5d9d8c69eb3368b86191bc9..f92fc60d9518e7847c3cf64f81517f9d2d27e318 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-notificationSubscriber.md +++ b/zh-cn/application-dev/reference/apis/js-apis-notificationSubscriber.md @@ -101,7 +101,7 @@ onUpdate?:(data: [NotificationSortingMap](#notificationsortingmap)) | 参数名 | 类型 | 必填 | 说明 | | ------------ | ------------------------ | ---- | -------------------------- | -| data | [NotificationSortingMap](#notificationsortingmap) | 是 | | +| data | [NotificationSortingMap](#notificationsortingmap) | 是 | 回调返回接收到的通知信息。 | **示例：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-system-notification.md b/zh-cn/application-dev/reference/apis/js-apis-system-notification.md index e0fac1ec7e40cf7d7f7256648e9003f05cbefc9a..dd4b4c6c9cde639d8cf66f92d4b77b1deab7f5c9 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-system-notification.md +++ b/zh-cn/application-dev/reference/apis/js-apis-system-notification.md @@ -13,10 +13,31 @@ import notification from '@system.notification'; ``` +## ActionResult + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification + +| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | +| ----------- | --- | ---- | ---------------------------------------------- | ---- | ------------------------- | +| bundleName | 是 | 是 | string | 是 | 单击通知后要重定向到的应用程序的Bundle名。 | +| abilityName | 是 | 是 | string | 是 | 单击通知后要重定向到的应用程序的Ability名称。 | +| uri | 是 | 是 | string | 否 | 要重定向到的页面的uri。 | + + +## ShowNotificationOptions + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification + +| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | +| ------------- | --- | ---- | ---------------------------------------------- | ---- | ------------------------- | +| contentTitle | 是 | 是 | string | 否 | 通知标题。 | +| contentText | 是 | 是 | string | 否 | 通知内容。 | +| clickAction | 是 | 是 | ActionResult | 否 | 通知被点击后触发的行为。 | + ## notification.show -show(contentTitle: string, contentText: string, clickAction: ActionInfo): void +show(options?: ShowNotificationOptions): void 显示通知。 @@ -26,21 +47,10 @@ show(contentTitle: string, contentText: string, clickAction: ActionInfo): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| contentTitle | string | 否 | 通知标题。 | -| contentText | string | 否 | 通知内容。 | -| clickAction | ActionInfo | 否 | 通知点击后触发的动作。 | - - **表1** ActionInfo - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| bundleName | string | 是 | 点击通知后要跳转到的应用的bundleName | -| abilityName | string | 是 | 点击通知后要跳转到的应用的abilityName | -| uri | string | 是 | 要跳转到的uri，可以是下面的两种格式：
- 页面绝对路径，由配置文件中pages列表提供，例如：
  - pages/index/index
  - pages/detail/detail
- 特殊的，如果uri的值是"/"，则跳转到首页。 | +| options | ShowNotificationOptions | 否 | 通知标题。 | **示例：** - -``` +```javascript export default { show() { notification.show({ diff --git a/zh-cn/readme.md b/zh-cn/readme.md index 7a39becf661e51d0bb40da5324cdbdbbed28cc50..2b604a6f15bc7a976219139892cfae6f5f238bfa 100644 --- a/zh-cn/readme.md +++ b/zh-cn/readme.md @@ -1,90 +1,9 @@ -# 导读 +# OpenHarmony开发者文档 -此工程存放OpenHarmony提供的快速入门、开发指南、API参考等开发者文档，欢迎参与OpenHarmony开发者文档开源项目，与我们一起完善开发者文档。 - -## **文档目录结构** - -- [Openharmony概述](OpenHarmony-Overview_zh.md) -- 设备开发 - - 轻量和小型系统开发指导（参考内存<128MB） - - overview：[设备开发导读](device-dev/Readme-CN.md) - - quick-start：[快速入门](device-dev/quick-start/Readme-CN.md)（搭建环境、获取源码、编译、烧录等） - - Basic Capability：开发基础能力 - - Kernel：[轻量系统内核](device-dev/kernel/kernel-mini.md) - - Kernel：[小型系统内核](device-dev/kernel/kernel-small.md) - - Drivers：[驱动](device-dev/driver/Readme-CN.md) - - Subsystems：[子系统](device-dev/subsystems/Readme-CN.md)（编译构建、图形图像、DFX、XTS等子系统） - - Security：[隐私与安全](device-dev/security/Readme-CN.md) - - - guide：开发示例 - - [WLAN连接类产品](device-dev/guide/device-wlan.md)（LED外设控制、集成三方SDK） - - [无屏摄像头类产品](device-dev/guide/device-iotcamera-control.md)（摄像头控制） - - [带屏摄像头类产品](device-dev/guide/device-camera.md)（屏幕和摄像头控制、视觉应用开发） - - - porting：移植适配 - - [轻量和小型系统三方库移植指导](device-dev/porting/porting-thirdparty.md) - - [轻量系统芯片移植指导](device-dev/porting/porting-minichip.md) - - [轻量系统芯片移植案例](device-dev/porting/porting-minichip-cases.md) - - [小型系统芯片移植指导](device-dev/porting/porting-smallchip.md) - - - bundles：HPM Bundle开发 - - [HPM Bundle开发规范](device-dev/bundles/bundles-standard-rules.md) - - [HPM Bundle开发指南](device-dev/bundles/bundles-guide.md) - - [HPM Bundle开发示例](device-dev/bundles/bundles-demo.md) - - - 标准系统开发指导（参考内存≥128MB） - - overview：[设备开发导读](device-dev/Readme-CN.md) - - quick-start：[快速入门](device-dev/quick-start/quickstart-standard.md)（搭建环境、获取源码、编译、烧录等） - - Basic Capability：开发基础能力 - - Kernel：[标准系统内核](device-dev/kernel/kernel-standard.md) - - Drivers：[驱动](device-dev/driver/Readme-CN.md) - - Subsystems：[子系统](device-dev/subsystems/Readme-CN.md)（编译构建、图形图像、DFX、XTS等子系统） - - Security：[隐私与安全](device-dev/security/Readme-CN.md) - - - guide：开发示例 - - [时钟应用](device-dev/guide/device-clock-guide.md) - - [平台驱动](device-dev/guide/device-driver-demo.md) - - [外设驱动](device-dev/guide/device-outerdriver-demo.md) - - - porting：移植适配 - - [标准系统芯片移植指导](device-dev/porting/standard-system-porting-guide.md) - - [一种快速移植OpenHarmony Linux内核的方法](device-dev/porting/porting-linux-kernel.md) - - - bundles：HPM Bundle开发 - - [HPM Bundle开发规范](device-dev/bundles/bundles-standard-rules.md) - - [HPM Bundle开发指南](device-dev/bundles/bundles-guide.md) - - [HPM Bundle开发示例](device-dev/bundles/bundles-demo.md) - - [常见问题](device-dev/faqs/Readme-CN.md) - - -- 应用开发 - - overview：[应用开发导读](application-dev/application-dev-guide.md) - - quick-start：[入门](application-dev/quick-start/Readme-CN.md) - - ability：[Ability框架](application-dev/ability/Readme-CN.md) - - ui：[UI](application-dev/ui/Readme-CN.md) - - media：[媒体](application-dev/media/Readme-CN.md) - - security：[安全](application-dev/security/Readme-CN.md) - - connectivity：[网络与连接](application-dev/connectivity/Readme-CN.md) - - database：[分布式数据服务](application-dev/database/Readme-CN.md) - - usb：[USB服务](application-dev//usb/Readme-CN.md) - - dfx：[DFX](application-dev/dfx/Readme-CN.md) - - reference：[开发参考](application-dev/reference/Readme-CN.md) -- 许可证及版权信息检查工具：[开源合规审查工具](https://gitee.com/openharmony-sig/tools_oat) -- glossary：[术语](device-dev/glossary/glossary.md) - -## **版本更新** - -参考[Release Notes](release-notes/Readme.md)。 - -## **第三方开源软件及许可说明** - -3rd-Party-License：[第三方开源软件及许可证说明](contribute/第三方开源软件及许可证说明.md) - -## **贡献** - -非常欢迎您参与[贡献](contribute/参与贡献.md)，我们鼓励开发者以各种方式参与文档反馈和贡献。 - -您可以对现有文档进行评价、简单更改、反馈文档质量问题、贡献您的原创内容，详细请参考[贡献文档](contribute/贡献文档.md)。 - -卓越贡献者将会在开发者社区文档贡献专栏表彰公示。 +本目录是OpenHarmony开发者文档的中文目录。目录内容包括： +- [设备开发文档](device-dev/Readme-CN.md) +- [应用开发文档](application-dev/Readme-CN.md) +- [版本说明](release-notes/Readme.md) +- [子系统介绍](./readme) +- [项目贡献指南](contribute/贡献指南.md) \ No newline at end of file