!11411 API参考内容优化改进

Merge pull request !11411 from mingxihua/master

!11411 API参考内容优化改进
Merge pull request !11411 from mingxihua/master
06d257b2 · openharmony_ci · Gitee · 85593757 · d1aac949 · 06d257b2
5 changed file
--- a/zh-cn/application-dev/reference/apis/js-apis-ability-Want.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-ability-Want.md
+# Want<sup>6+</sup>
+
+Want是对象间信息传递的载体, 可以用于应用组件间的信息传递。 Want的使用场景之一是作为startAbility的参数, 其包含了指定的启动目标, 以及启动时需携带的相关数据, 如bundleName和abilityName字段分别指明目标Ability所在应用的包名以及对应包内的Ability名称。当Ability A需要启动Ability B并传入一些数据时, 可使用Want作为载体将这些数据传递给Ability B。
+
+**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
+
+| 名称        | 读写属性 | 类型                 | 必填 | 描述                                                         |
+| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
+| deviceId    | 只读     | string               | 否   | 表示运行指定Ability的设备ID。                                |
+| bundleName   | 只读     | string               | 否   | 表示包名。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 |
+| abilityName  | 只读     | string               | 否   | 表示待启动的Ability名称。如果在Want中该字段同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。AbilityName需要在一个应用的范围内保证唯一。 |
+| uri          | 只读     | string               | 否   | 表示Uri。如果在Want中指定了Uri，则Want将匹配指定的Uri信息，包括scheme, schemeSpecificPart, authority和path信息。 |
+| type         | 只读     | string               | 否   | 表示MIME type类型，打开文件的类型，主要用于文管打开文件。比如："text/xml" 、 "image/*"等，MIME定义参考：https://www.iana.org/assignments/media-types/media-types.xhtml?utm_source=ld246.com。   |
+| flags        | 只读     | number               | 否   | 表示处理Want的方式。默认传数字，具体参考：[flags说明](js-apis-featureAbility.md#flags说明)。 |
+| action      | 只读     | string               | 否   | 表示要执行的通用操作（如：查看、分享、应用详情）。在隐式Want中，您可以定义该字段，配合uri或parameters来表示对数据要执行的操作。                           |
+| parameters   | 只读     | {[key: string]: any} | 否   | 表示WantParams，由开发者自行决定传入的键值对。默认会携带以下key值：<br>ohos.aafwk.callerPid 表示拉起方的pid。<br>ohos.aafwk.param.callerToken 表示拉起方的token。<br>ohos.aafwk.param.callerUid 表示[bundleInfo](js-apis-bundle-BundleInfo.md#bundleinfo-1)中的uid，应用包里应用程序的uid。                                       |
+| entities    | 只读     | Array\<string>       | 否   | 表示目标Ability额外的类别信息（如：浏览器、视频播放器），在隐式Want中是对action字段的补充。在隐式Want中，您可以定义该字段，来过滤匹配Ability类型。                                    |
+| moduleName<sup>9+</sup> | 只读   | string | 否    | 表示待启动的Ability所属的模块（module）。 |
+
+具体字段描述参考ability/want.d.ts文件
+
+**示例：**
+
+- 基础用法
+
+  ```  ts
+    var want = {
+        "deviceId": "", // deviceId为空表示本设备
+        "bundleName": "com.extreme.test",
+        "abilityName": "MainAbility",
+        "moduleName": "entry" // moduleName非必选
+    };
+    this.context.startAbility(want, (error) => {
+        // 显式拉起Ability，通过bundleName、abilityName和moduleName可以唯一确定一个Ability
+        console.log("error.code = " + error.code)
+    })
+  ```
+
+- 传递FD数据，FD表示文件描述符(FileDescriptor)
+
+  ```  ts
+    import fileio from '@ohos.fileio';
+    var fd;
+    try {
+        fd = fileio.openSync("/data/storage/el2/base/haps/pic.png");
+    } catch(e) {
+        console.log("openSync fail:" + JSON.stringify(e));
+    }
+    var want = {
+        "deviceId": "", // deviceId为空表示本设备
+        "bundleName": "com.extreme.test",
+        "abilityName": "MainAbility",
+        "moduleName": "entry", // moduleName非必选
+        "parameters": {
+            "keyFd":{"type":"FD", "value":fd}
+        }
+    };
+    this.context.startAbility(want, (error) => {
+        // 显式拉起Ability，通过bundleName、abilityName和moduleName可以唯一确定一个Ability
+        console.log("error.code = " + error.code)
+    })
+  ```
+  <!--no_check-->
+
+
--- a/zh-cn/application-dev/reference/apis/js-apis-ability-ability.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-ability-ability.md
+# Ability
+
+Ability模块将二级模块API组织在一起方便开发者进行导出。
+
+> **说明：**
+> 
+> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
+> 本模块接口仅可在FA模型下使用
+
+## 导入模块
+
+```ts
+import ability from '@ohos.ability.ability'
+```
+
+**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
+
+| 名称        | 读写属性 | 类型                 | 必填 | 描述                                                         |
+| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
+| DataAbilityHelper    | 只读     | number               | 否   | DataAbilityHelper二级模块。                                |
+| PacMap   | 只读     | Want               | 否   | PacMap二级模块。 |
+| DataAbilityOperation   | 只读     | Want               | 否   | DataAbilityOperation二级模块。 |
+| DataAbilityResult   | 只读     | Want               | 否   | DataAbilityResult二级模块。 |
+| AbilityResult   | 只读     | Want               | 否   | AbilityResult二级模块。 |
+| ConnectOptions   | 只读     | Want               | 否   | ConnectOptions二级模块。 |
+| StartAbilityParameter   | 只读     | Want               | 否   | StartAbilityParameter二级模块。 |
+
+**示例：**
+
+  ```ts
+  let dataAbilityHelper: ability.DataAbilityHelper;
+  let pacMap: ability.PacMap;
+  let dataAbilityOperation: ability.DataAbilityOperation;
+  let dataAbilityResult: ability.DataAbilityResult;
+  let abilityResult: ability.AbilityResult;
+  let connectOptions: ability.ConnectOptions;  
+  let startAbilityParameter: ability.StartAbilityParameter;
+  ```
\ No newline at end of file
--- a/zh-cn/application-dev/reference/apis/js-apis-ability-abilityResult.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-ability-abilityResult.md
+# AbilityResult<sup>7+</sup>
+
+定义ability拉起、销毁之后返回的结果码和数据。
+
+**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
+
+| 名称        | 读写属性 | 类型                 | 必填 | 描述                                                         |
+| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
+| resultCode    | 只读     | number               | 否   | 表示ability拉起、销毁之后返回的结果码。                                |
+| want   | 只读     | [Want](js-apis-ability-Want.md)               | 否   | 表示ability销毁之后返回的数据。 |
+
+**示例：**
+  ```ts
+  let want = {
+    bundleName: 'com.example.mydocapplication',
+    abilityName: 'MainAbility',
+  };
+  this.context.startAbilityForResult(want, (error, data) => {
+      let resultCode = data.resultCode;
+      let want = data.want;
+  });
+  ```
\ No newline at end of file
--- a/zh-cn/application-dev/reference/apis/js-apis-application-configuration.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-application-configuration.md
+# Configuration
+
+定义环境变化信息。
+
+**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
+
+  | 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| language<sup>8+</sup> | string | 是 | 是 | 表示应用程序的当前语言。 |
+| colorMode<sup>8+</sup> | [ColorMode](js-apis-configurationconstant.md#configurationconstantcolormode) | 是 | 是 | 表示深浅色模式，取值范围：浅色模式（COLOR_MODE_LIGHT），深色模式（COLOR_MODE_DARK）。默认为浅色。 |
+| direction<sup>9+</sup> | Direction | 是 | 否 | 表示屏幕方向，取值范围：水平方向（DIRECTION_HORIZONTAL），垂直方向（DIRECTION_VERTICAL）。 |
+| screenDensity<sup>9+</sup>  | ScreenDensity | 是 | 否 | 表示屏幕分辨率，取值范围：SCREEN_DENSITY_SDPI（120）、SCREEN_DENSITY_MDPI（160）、SCREEN_DENSITY_LDPI（240）、SCREEN_DENSITY_XLDPI（320）、SCREEN_DENSITY_XXLDPI（480）、SCREEN_DENSITY_XXXLDPI（640）。 |
+| displayId<sup>9+</sup>  | number | 是 | 否 | 表示应用所在的物理屏幕Id。 |
+| hasPointerDevice<sup>9+</sup>  | boolean | 是 | 否 | 指示指针类型设备是否已连接，如键鼠、触控板等。 |
+
+具体字段描述参考ohos.application.Configuration.d.ts文件
+
+**示例：**
+    
+  ```ts
+  let envCallback = {
+     onConfigurationUpdated(config) {
+       console.info(`envCallback onConfigurationUpdated success: ${JSON.stringify(config)}`)
+       let language = config.language;
+       let colorMode = config.colorMode;
+       let direction = config.direction;
+       let screenDensity = config.screenDensity;
+       let displayId = config.displayId;
+       let hasPointerDevice = config.hasPointerDevice;
+    }
+  };
+  var callbackId = applicationContext.registerEnvironmentCallback(envCallback);
+  ```
+
--- a/zh-cn/application-dev/reference/apis/js-apis-application-configurationConstant.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-application-configurationConstant.md
+# ConfigurationConstant
+
+ConfigurationConstant模块提供配置信息枚举值定义的能力。
+
+> **说明：**
+> 
+> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
+
+## 导入模块
+
+```ts
+import ConfigurationConstant from '@ohos.application.ConfigurationConstant';
+```
+
+## ConfigurationConstant.ColorMode
+
+使用时通过ConfigurationConstant.ColorMode获取。
+
+**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
+
+| 名称 | 值 | 说明 | 
+| -------- | -------- | -------- |
+| COLOR_MODE_NOT_SET | -1 | 未设置颜色模式。 | 
+| COLOR_MODE_DARK | 0 | 深色模式。 | 
+| COLOR_MODE_LIGHT | 1 | 浅色模式。 | 
+
+
+## ConfigurationConstant.Direction<sup>9+</sup>
+
+使用时通过ConfigurationConstant.Direction获取。
+
+**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
+
+| 名称 | 值 | 说明 | 
+| -------- | -------- | -------- |
+| DIRECTION_NOT_SET | -1 | 未设置方向。 | 
+| DIRECTION_VERTICAL | 0 | 垂直方向。 | 
+| DIRECTION_HORIZONTAL | 1 | 水平方向。 | 
+
+
+## ConfigurationConstant.ScreenDensity<sup>9+</sup>
+
+使用时通过ConfigurationConstant.ScreenDensity获取。
+
+**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
+
+| 名称 | 值 | 说明 | 
+| -------- | -------- | -------- |
+| SCREEN_DENSITY_NOT_SET | 0 | 未设置屏幕分辨率。 | 
+| SCREEN_DENSITY_SDPI | 120 | 屏幕分辨率为"sdpi"。 | 
+| SCREEN_DENSITY_MDPI | 160 | 屏幕分辨率为"mdpi"。 | 
+| SCREEN_DENSITY_LDPI | 240 | 屏幕分辨率为"ldpi"。 | 
+| SCREEN_DENSITY_XLDPI | 320 | 屏幕分辨率为"xldpi"。 | 
+| SCREEN_DENSITY_XXLDPI | 480 | 屏幕分辨率为"xxldpi"。 | 
+| SCREEN_DENSITY_XXXLDPI | 640 | 屏幕分辨率为"xxxldpi"。 |