-
-
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | options | Object | 是 | 表示待创建Animator对象的属性，详情见下表options说明。 |
+
+- options说明
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | duration | number | 否 | 动画播放的时长，单位毫秒，默认为0。 |
+ | easing | string | 否 | 动画插值曲线，默认为' ease '。 |
+ | delay | number | 否 | 动画延时播放时长，单位毫秒，默认为0，即不延时。 |
+ | fill | string | 否 | 动画启停模式，默认值none，详情见：[animation-fill-mode](../arkui-js/js-components-common-animation.md) |
+ | direction | string | 否 | 动画播放模式，默认值normal，详情见：[animation-direction](../arkui-js/js-components-common-animation.md) |
+ | iterations | number | 否 | 动画播放次数，默认值1，设置为0时不播放，设置为-1时无限次播放。 |
+ | begin | number | 否 | 动画插值起点，不设置时默认为0。 |
+ | end | number | 否 | 动画插值终点，不设置时默认为1。 |
+
+- animator支持的接口
+ | 参数名 | 类型 | 说明 |
+ | -------- | -------- | -------- |
+ | update | options | 过程中可以使用这个接口更新动画参数，入参与createAnimator一致。 |
+ | play | - | 开始动画。 |
+ | finish | - | 结束动画。 |
+ | pause | - | 暂停动画。 |
+ | cancel | - | 取消动画。 |
+ | reverse | - | 倒播动画。 |
+
+- animator支持的事件：
+ | 参数名 | 类型 | 说明 |
+ | -------- | -------- | -------- |
+ | frame | number | 逐帧插值回调事件，入参为当前帧的插值 |
+ | cancel | - | 动画被强制取消 |
+ | finish | - | 动画播放完成 |
+ | repeat | - | 动画重新播放 |
+
+- 示例
+ ```
+
+
+
- ```
-
- ```
- // js
- export default {
- data : {
- divWidth: 200,
- divHeight: 200,
- animator: null
- },
- onInit() {
- var options = {
- duration: 1500,
- easing: 'friction',
- fill: 'forwards',
- iterations: 2,
- begin: 200.0,
- end: 400.0
- };
- this.animator = animator.createAnimator(options);
- },
- Show() {
- var options1 = {
- duration: 2000,
- easing: 'friction',
- fill: 'forwards',
- iterations: 1,
- begin: 200.0,
- end: 400.0
- };
- this.animator.update(options1);
- var _this = this;
- this.animator.onframe = function(value) {
- _this.divWidth = value;
- _this.divHeight = value;
- };
- this.animator.play();
- }
+
+ ```
+
+ ```
+ // js
+ export default {
+ data : {
+ divWidth: 200,
+ divHeight: 200,
+ animator: null
+ },
+ onInit() {
+ var options = {
+ duration: 1500,
+ easing: 'friction',
+ fill: 'forwards',
+ iterations: 2,
+ begin: 200.0,
+ end: 400.0
+ };
+ this.animator = animator.createAnimator(options);
+ },
+ Show() {
+ var options1 = {
+ duration: 2000,
+ easing: 'friction',
+ fill: 'forwards',
+ iterations: 1,
+ begin: 200.0,
+ end: 400.0
+ };
+ this.animator.update(options1);
+ var _this = this;
+ this.animator.onframe = function(value) {
+ _this.divWidth = value;
+ _this.divHeight = value;
+ };
+ this.animator.play();
}
- ```
-
-
+ }
+ ```
diff --git a/zh-cn/application-dev/reference/apis/js-apis-basic-features-app-context.md b/zh-cn/application-dev/reference/apis/js-apis-basic-features-app-context.md
index 65a177cbc072f349b6395d11ae53a5fd7d4659b1..be16b12372a636aa23a991b595c4a800f1c4261f 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-basic-features-app-context.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-basic-features-app-context.md
@@ -1,89 +1,79 @@
-# 应用上下文
+# 应用上下文
-## 导入模块
+
+## 导入模块
```
import app from '@system.app';
```
-## 权限列表
+## 权限列表
无
-## app.getInfo
-getInfo\(\): <[AppResponse](#t3e93239d9b134b80957bcdd4acb05291)\>
+## app.getInfo
+
+getInfo(): <AppResponse>
获取当前应用配置文件中声明的信息。
-- 返回值
-
- **表 1** AppResponse
-
-
-
参数名
- |
- 类型
- |
- 说明
- |
-
- appID6+
- |
- string
- |
- 表示应用的包名，用于标识应用的唯一性。
- |
-
- appName
- |
- string
- |
- 表示应用的名称。
- |
-
- versionName
- |
- string
- |
- 表示应用的版本名称。
- |
-
- versionCode
- |
- number
- |
- 表示应用的版本号。
- |
-
-
-
-
-- 示例
-
- ```
- export default {
- getInfo(){
- var info = app.getInfo();
- console.log(JSON.stringify(info));
- }
- }
- ```
+- 返回值
+ **表1** AppResponse
+
+ | | | |
+ | -------- | -------- | -------- |
+ | 参数名 | 类型 | 说明 |
+ | appID
6+ | string | 表示应用的包名，用于标识应用的唯一性。 |
+ | appName | string | 表示应用的名称。 |
+ | versionName | string | 表示应用的版本名称。 |
+ | versionCode | number | 表示应用的版本号。 |
+
+- 示例
+ ```
+ export default {
+ getInfo(){
+ var info = app.getInfo();
+ console.log(JSON.stringify(info));
+ }
+ }
+ ```
-## app.terminate
+## app.terminate
-terminate\(\): void
+terminate(): void
退出当前Ability
-- 示例
+>  **说明：**
+> 从API Version 7 开始，推荐使用新接口['@ohos.ability.featureAbility'](js-apis-featureAbility.md)。
- ```
- export default {
- terminate(){
- app.terminate();
- }}
- ```
+- 示例
+ ```
+ export default {
+ terminate(){
+ app.terminate();
+ }}
+ ```
+## app.requestFullWindow
+requestFullWindow(duration: number): void
+
+请求应用以全窗口运行，FA在某些场景下（如半模态FA）会以非全窗口运行，调用该接口会从非全窗口切换为全窗口运行，如果已经以全窗口运行则该接口调用无效。
+
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | duration | number | 否 | 请求全屏时，设定非全屏到全屏的过渡时间，单位为毫秒，默认时间与非全屏到全屏的距离成正比。 |
+
+- 示例
+ ```
+ export default {
+ requestFullWindow(){
+ app.requestFullWindow({
+ duration: 200});
+ }
+ }
+ ```
diff --git a/zh-cn/application-dev/reference/apis/js-apis-basic-features-configuration.md b/zh-cn/application-dev/reference/apis/js-apis-basic-features-configuration.md
index 8f590bf1a2ca171aa3080c3ce4fa7d2aaad72438..4682b4f4e1935fae65997c76756c3abdc386ddd6 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-basic-features-configuration.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-basic-features-configuration.md
@@ -1,76 +1,50 @@
-# 应用配置
+# 应用配置
-## 导入模块
+- [导入模块](#导入模块)
+- [权限列表](#权限列表)
+- [configuration.getLocale](#configurationgetLocale)
+
+
+>  **说明：**
+> - 从API Version 7 开始，该接口不再维护，推荐使用新接口['@ohos.i18n'](js-apis-i18n.md)和['@ohos.intl'](js-apis-intl.md)。
+>
+>
+>
+
+
+## 导入模块
```
import configuration from '@system.configuration';
```
-## 权限列表
+## 权限列表
无
-## configuration.getLocale
-
-getLocale\(\): <[LocaleResponse](#table1544853546)\>
-获取应用当前的语言和地区。默认与系统的语言和地区同步。
+## configuration.getLocale
-- 返回值
+getLocale(): <LocaleResponse>
- **表 1** LocaleResponse
-
-
-
参数名
- |
- 类型
- |
- 说明
- |
-
|---|
-
- language
- |
- string
- |
- 语言。例如：zh。
- |
-
- countryOrRegion
- |
- string
- |
- 国家或地区。例如：CN。
- |
-
- dir
- |
- string
- |
- 文字布局方向。取值范围：
-
- |
-
- unicodeSetting5+
- |
- string
- |
- 语言环境定义的Unicode语言环境键集，如果此语言环境没有特定键集，则返回空集。
- 例如：{"nu":"arab"}，表示当前环境下的数字采用阿拉伯语的数字。
- |
-
-
-
-
-- 示例
+获取应用当前的语言和地区。默认与系统的语言和地区同步。
- ```
- export default {
- getLocale() {
- const localeInfo = configuration.getLocale();
- console.info(localeInfo.language);
- }
+- 返回值
+ **表1** LocaleResponse
+
+ | 参数名 | 类型 | 说明 |
+ | -------- | -------- | -------- |
+ | language | string | 语言。例如：zh。 |
+ | countryOrRegion | string | 国家或地区。例如：CN。 |
+ | dir | string | 文字布局方向。取值范围：
- ltr：从左到右；
- rtl：从右到左。 |
+ | $unicodeSetting^{5+}$ | string | 语言环境定义的Unicode语言环境键集，如果此语言环境没有特定键集，则返回空集。
例如：{"nu":"arab"}，表示当前环境下的数字采用阿拉伯语的数字。 |
+
+- 示例
+ ```
+ export default {
+ getLocale() {
+ const localeInfo = configuration.getLocale();
+ console.info(localeInfo.language);
}
- ```
-
-
+ }
+ ```
diff --git a/zh-cn/application-dev/reference/apis/js-apis-basic-features-logs.md b/zh-cn/application-dev/reference/apis/js-apis-basic-features-logs.md
index 1b26f76e3b16fe85acf4b609d7f69acd6dfcedcb..0c6afae60d9aed4e0b2e8873510279255bb25928 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-basic-features-logs.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-basic-features-logs.md
@@ -1,174 +1,76 @@
-# 日志打印
+# 日志打印
-## 导入模块
+
+## 导入模块
无需导入。
-## 权限列表
+## 权限列表
无
-## console.debug
-debug\(message: string\): void
+## console.debug
+
+debug(message: string): void
打印debug级别的日志信息。
-- 参数
-
-
-
参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- message
- |
- string
- |
- 是
- |
- 表示要打印的文本信息。
- |
-
-
-
-
-
-## console.log
-
-log\(message: string\): void
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | message | string | 是 | 表示要打印的文本信息。 |
+
+
+## console.log
+
+log(message: string): void
打印debug级别的日志信息。
-- 参数
-
-
-
参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- message
- |
- string
- |
- 是
- |
- 表示要打印的文本信息。
- |
-
-
-
-
-
-## console.info
-
-info\(message: string\): void
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | message | string | 是 | 表示要打印的文本信息。 |
+
+
+## console.info
+
+info(message: string): void
打印info级别的日志信息。
-- 参数
-
-
-
参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- message
- |
- string
- |
- 是
- |
- 表示要打印的文本信息。
- |
-
-
-
-
-
-## console.warn
-
-warn\(message: string\): void
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | message | string | 是 | 表示要打印的文本信息。 |
+
+
+## console.warn
+
+warn(message: string): void
打印warn级别的日志信息。
-- 参数
-
-
-
参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- message
- |
- string
- |
- 是
- |
- 表示要打印的文本信息。
- |
-
-
-
-
-
-## console.error
-
-error\(message: string\): void
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | message | string | 是 | 表示要打印的文本信息。 |
+
+
+## console.error
+
+error(message: string): void
打印error级别的日志信息。
-- 参数
-
-
-
参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- message
- |
- string
- |
- 是
- |
- 表示要打印的文本信息。
- |
-
-
-
-
-
-## 示例
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | message | string | 是 | 表示要打印的文本信息。 |
+
+
+## 示例
```
export default {
@@ -176,13 +78,11 @@ export default {
var versionCode = 1;
console.info('Hello World. The current version code is ' + versionCode);
console.log(`versionCode: ${versionCode}`);
- // 以下写法从API Version 6开始支持
- console.log('versionCode:%d.', versionCode);
+ // 以下写法从API Version 6开始支持console.log('versionCode:%d.', versionCode);
}
}
```
在DevEco Studio的底部，切换到“HiLog”窗口。选择当前的设备及进程，日志级别选择Info，搜索内容设置为“Hello World”。此时窗口仅显示符合条件的日志，效果如图所示：
-
-
+
diff --git a/zh-cn/application-dev/reference/apis/js-apis-basic-features-pop-up.md b/zh-cn/application-dev/reference/apis/js-apis-basic-features-pop-up.md
index 4ac34ca0b8a6348ba58752a14643f5bb8644751c..ead1fbc6eefe3ab15987b788e64baaaaad602184 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-basic-features-pop-up.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-basic-features-pop-up.md
@@ -1,319 +1,133 @@
-# 弹窗
+# 弹窗
-## 导入模块
+
+## 导入模块
```
import prompt from '@system.prompt';
```
-## 权限列表
+
+## 权限列表
无
-## prompt.showToast
+## prompt.showToast
-showToast\(Object\): void
+showToast(Object): void
显示文本弹窗。
-- 参数
-
-
-
参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- message
- |
- string
- |
- 是
- |
- 显示的文本信息。
- |
-
- duration
- |
- number
- |
- 否
- |
- 默认值1500ms，建议区间：1500ms-10000ms。
- 说明： 若小于1500ms则取默认值，最大取值为10000ms。
-
- |
-
- [bottom]5+
- |
- <length>
- |
- 否
- |
- 设置弹窗边框距离屏幕底部的位置。
-
- |
-
-
-
-
-- 示例
-
- ```
- export default {
- showToast() {
- prompt.showToast({
- message: 'Message Info',
- duration: 2000,
- });
- }
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | message | string | 是 | 显示的文本信息。 |
+ | duration | number | 否 | 默认值1500ms，建议区间：1500ms-10000ms。
>  **说明：**
> 若小于1500ms则取默认值，最大取值为10000ms。 |
+ | $[bottom]^{5+}$ | <length> | 否 | 设置弹窗边框距离屏幕底部的位置。
>  **说明：**
> 仅手机和平板设备支持。 |
+
+- 示例
+ ```
+ export default {
+ showToast() {
+ prompt.showToast({
+ message: 'Message Info',
+ duration: 2000,
+ });
}
- ```
+ }
+ ```
-## prompt.showDialog
+## prompt.showDialog
-showDialog\(\): void
+showDialog(): void
在页面内显示对话框。
-- 参数
-
-
-
参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- title
- |
- string
- |
- 否
- |
- 标题文本。
- |
-
- message
- |
- string
- |
- 否
- |
- 内容文本。
- |
-
- buttons
- |
- Array
- |
- 否
- |
- 对话框中按钮的数组，结构为：{text:'button', color: '#666666'}，支持1-3个按钮。其中第一个为positiveButton；第二个为negativeButton；第三个为neutralButton。
- |
-
- success
- |
- Function
- |
- 否
- |
- 接口调用成功的回调函数，返回值如success返回值所示。
- |
-
- cancel
- |
- Function
- |
- 否
- |
- 取消调用此接口的回调函数。
- |
-
- complete
- |
- Function
- |
- 否
- |
- 弹框退出时的回调函数。
- |
-
-
-
-
- success返回值：
-
-
-
参数名
- |
- 类型
- |
- 说明
- |
-
|---|
-
- index
- |
- number
- |
- 选中按钮在buttons数组中的索引。
- |
-
-
-
-
-- 示例
-
- ```
- export default {
- showDialog() {
- prompt.showDialog({
- title: 'Title Info',
- message: 'Message Info',
- buttons: [
- {
- text: 'button',
- color: '#666666',
- },
- ],
- success: function(data) {
- console.log('dialog success callback，click button : ' + data.index);
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | title | string | 否 | 标题文本。 |
+ | message | string | 否 | 内容文本。 |
+ | buttons | Array | 否 | 对话框中按钮的数组，结构为：{text:'button', color: '\#666666'}，支持1-3个按钮。其中第一个为positiveButton；第二个为negativeButton；第三个为neutralButton。 |
+ | success | Function | 否 | 接口调用成功的回调函数，返回值如success返回值所示。 |
+ | cancel | Function | 否 | 取消调用此接口的回调函数。 |
+ | complete | Function | 否 | 弹框退出时的回调函数。 |
+
+ success返回值：
+
+ | 参数名 | 类型 | 说明 |
+ | -------- | -------- | -------- |
+ | index | number | 选中按钮在buttons数组中的索引。 |
+
+- 示例
+ ```
+ export default {
+ showDialog() {
+ prompt.showDialog({
+ title: 'Title Info',
+ message: 'Message Info',
+ buttons: [
+ {
+ text: 'button',
+ color: '#666666',
},
- cancel: function() {
- console.log('dialog cancel callback');
- },
- });
- }
+ ],
+ success: function(data) {
+ console.log('dialog success callback，click button : ' + data.index);
+ },
+ cancel: function() {
+ console.log('dialog cancel callback');
+ },
+ });
}
- ```
-
+ }
+ ```
-## prompt.showActionMenu
6+
+## prompt.showActionMenu
6+
-showActionMenu\(Object\): void
+showActionMenu(Object): void
显示操作菜单。
-- 参数
-
-
-
参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- title
- |
- string
- |
- 否
- |
- 标题文本。
- |
-
- buttons
- |
- Array
- |
- 是
- |
- 对话框中按钮的数组，结构为：{text:'button', color: '#666666'}，支持1-6个按钮。大于6个按钮时弹窗不显示。
- |
-
- success
- |
- (data: TapIndex) => void
- |
- 否
- |
- 接口调用成功的回调函数。
- |
-
- cancel
- |
- () => void
- |
- 否
- |
- 接口调用失败的回调函数。
- |
-
- complete
- |
- () => void
- |
- 否
- |
- 接口调用结束的回调函数。
- |
-
-
-
-
- **表 1** TapIndex
-
-
-
参数名
- |
- 类型
- |
- 说明
- |
-
|---|
-
- tapIndex
- |
- number
- |
- 选中按钮在buttons数组中的索引，从0开始。
- |
-
-
-
-
-- 示例
-
- ```
- export default {
- showActionMenu() {
- prompt.showActionMenu({
- title: 'Title Info',
- buttons: [
- {
- text: 'item1',
- color: '#666666',
- },
- {
- text: 'item2',
- color: '#000000',
- },
- ],
- success: function(data) {
- console.log('dialog success callback，click button : ' + data.tapIndex);
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | title | string | 否 | 标题文本。 |
+ | buttons | Array | 是 | 对话框中按钮的数组，结构为：{text:'button', color: '\#666666'}，支持1-6个按钮。大于6个按钮时弹窗不显示。 |
+ | success | (data: TapIndex) => void | 否 | 接口调用成功的回调函数。 |
+ | cancel | () => void | 否 | 接口调用失败的回调函数。 |
+ | complete | () => void | 否 | 接口调用结束的回调函数。 |
+
+ **表1** TapIndex
+
+ | 参数名 | 类型 | 说明 |
+ | -------- | -------- | -------- |
+ | tapIndex | number | 选中按钮在buttons数组中的索引，从0开始。 |
+
+- 示例
+ ```
+ export default {
+ showActionMenu() {
+ prompt.showActionMenu({
+ title: 'Title Info',
+ buttons: [
+ {
+ text: 'item1',
+ color: '#666666',
+ },
+ {
+ text: 'item2',
+ color: '#000000',
},
- fail: function(data) {
- console.log('dialog fail callback' + data.errMsg);
- },
- });
- }
+ ],
+ success: function(data) {
+ console.log('dialog success callback，click button : ' + data.tapIndex);
+ },
+ fail: function(data) {
+ console.log('dialog fail callback' + data.errMsg);
+ },
+ });
}
- ```
-
-
+ }
+ ```
diff --git a/zh-cn/application-dev/reference/apis/js-apis-basic-features-routes.md b/zh-cn/application-dev/reference/apis/js-apis-basic-features-routes.md
index bf73f7235583eba894a521780785cf98a7ef3f15..105beaef3114128c854d0e484dce779a2d31542f 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-basic-features-routes.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-basic-features-routes.md
@@ -1,492 +1,323 @@
-# 页面路由
+# 页面路由
-> **须知：**
->页面路由需要在页面渲染完成之后才能调用，在onInit和onReady生命周期中页面还处于渲染阶段，禁止调用页面路由方法。
+>  **须知：**
+> 页面路由需要在页面渲染完成之后才能调用，在onInit和onReady生命周期中页面还处于渲染阶段，禁止调用页面路由方法。
-## 导入模块
+
+## 导入模块
```
import router from '@system.router';
```
-## 权限列表
+## 权限列表
无
-## router.push
+## router.push
-push\(Object\): void
+push(Object): void
跳转到应用内的指定页面。
-- 参数
-
-
-
参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- uri
- |
- string
- |
- 是
- |
- 表示目标页面的uri，可以用以下两种格式：
- - 页面绝对路径，由配置文件中pages列表提供，例如：
- pages/index/index
- pages/detail/detail
- - 特殊值，如果uri的值是"/"，则跳转到首页。
- |
-
- params
- |
- Object
- |
- 否
- |
- 跳转时要同时传递到目标页面的数据，跳转到目标页面后，参数可以在页面中直接使用，如this.data1(data1为跳转时params参数中的key值)。如果目标页面中已有该字段，则其值会被传入的字段值覆盖。
- |
-
-
-
-
-- 示例
-
- ```
- // 在当前页面中
- export default {
- pushPage() {
- router.push({
- uri: 'pages/routerpage2/routerpage2',
- params: {
- data1: 'message',
- data2: {
- data3: [123, 456, 789]
- },
- },
- });
- }
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | uri | string | 是 | 表示目标页面的uri，可以用以下两种格式：
- 页面绝对路径，由配置文件中pages列表提供，例如：
- pages/index/index
- pages/detail/detail
- 特殊值，如果uri的值是"/"，则跳转到首页。 |
+ | params | Object | 否 | 跳转时要同时传递到目标页面的数据，跳转到目标页面后，参数可以在页面中直接使用，如this.data1(data1为跳转时params参数中的key值)。如果目标页面中已有该字段，则其值会被传入的字段值覆盖。 |
+
+- 示例
+ ```
+ // 在当前页面中
+ export default {
+ pushPage() {
+ router.push({
+ uri: 'pages/routerpage2/routerpage2',
+ params: {
+ data1: 'message',
+ data2: {
+ data3: [123, 456, 789]
+ },
+ },
+ });
}
- // 在routerpage2页面中
- export default {
- data: {
- data1: 'default',
- data2: {
- data3: [1, 2, 3]
- }
- },
- onInit() {
- console.info('showData1:' + this.data1);
- console.info('showData3:' + this.data2.data3);
+ }
+ ```
+
+ ```
+ // 在routerpage2页面中
+ export default {
+ data: {
+ data1: 'default',
+ data2: {
+ data3: [1, 2, 3]
}
+ },
+ onInit() {
+ console.info('showData1:' + this.data1);
+ console.info('showData3:' + this.data2.data3);
}
- ```
+ }
+ ```
- > **说明：**
- >页面路由栈支持的最大Page数量为32。
+ >  **说明：**
+ > 页面路由栈支持的最大Page数量为32。
-## router.replace
+## router.replace
-replace\(Object\): void
+replace(Object): void
用应用内的某个页面替换当前页面，并销毁被替换的页面。
-- 参数
-
-
-
参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- uri
- |
- string
- |
- 是
- |
- 目标页面的uri，可以是以下的两种格式：
- - 页面绝对路径，由配置文件中pages列表提供，例如：
- pages/index/index
- pages/detail/detail
- - 特殊值，如果uri的值是"/"，则跳转到首页。
- |
-
- params
- |
- Object
- |
- 否
- |
- 跳转时要同时传递到目标页面的数据，跳转到目标页面后，参数可以在页面中直接使用，如this.data1(data1为跳转时params参数中的key值)。如果目标页面中已有该字段，则其值会被传入的字段值覆盖。
- |
-
-
-
-
-- 示例
-
- ```
- // 在当前页面中
- export default {
- replacePage() {
- router.replace({
- uri: 'pages/detail/detail',
- params: {
- data1: 'message',
- },
- });
- }
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | uri | string | 是 | 目标页面的uri，可以是以下的两种格式：
- 页面绝对路径，由配置文件中pages列表提供，例如：
- pages/index/index
- pages/detail/detail
- 特殊值，如果uri的值是"/"，则跳转到首页。 |
+ | params | Object | 否 | 跳转时要同时传递到目标页面的数据，跳转到目标页面后，参数可以在页面中直接使用，如this.data1(data1为跳转时params参数中的key值)。如果目标页面中已有该字段，则其值会被传入的字段值覆盖。 |
+
+- 示例
+ ```
+ // 在当前页面中
+ export default {
+ replacePage() {
+ router.replace({
+ uri: 'pages/detail/detail',
+ params: {
+ data1: 'message',
+ },
+ });
}
- // 在detail页面中
- export default {
- data: {
- data1: 'default'
- },
- onInit() {
- console.info('showData1:' + this.data1)
- }
+ }
+ ```
+
+ ```
+ // 在detail页面中
+ export default {
+ data: {
+ data1: 'default'
+ },
+ onInit() {
+ console.info('showData1:' + this.data1)
}
- ```
+ }
+ ```
+## router.back
-## router.back
-
-back\(Object\): void
+back(Object): void
返回上一页面或指定的页面。
-- 参数
-
-
-
参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- uri
- |
- string
- |
- 否
- |
- 返回到指定uri的界面，如果页面栈上没有uri页面，则不响应该情况。如果uri未设置，则返回上一页。
- |
-
-
-
-
-- 示例
-
- ```
- // index页面
- export default {
- indexPushPage() {
- router.push({
- uri: 'pages/detail/detail',
- });
- }
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | uri | string | 否 | 返回到指定uri的界面，如果页面栈上没有uri页面，则不响应该情况。如果uri未设置，则返回上一页。 |
+
+- 示例
+ ```
+ // index页面
+ export default {
+ indexPushPage() {
+ router.push({
+ uri: 'pages/detail/detail',
+ });
}
-
- // detail页面
- export default {
- detailPushPage() {
- router.push({
- uri: 'pages/mall/mall',
- });
- }
+ }
+ ```
+
+ ```
+ // detail页面
+ export default {
+ detailPushPage() {
+ router.push({
+ uri: 'pages/mall/mall',
+ });
}
-
- // mall页面通过back，将返回detail页面
- export default {
- mallBackPage() {
- router.back();
- }
+ }
+ ```
+
+ ```
+ // mall页面通过back，将返回detail页面
+ export default {
+ mallBackPage() {
+ router.back();
}
- // detail页面通过back，将返回index页面
- export default {
- defaultBack() {
- router.back();
- }
+ }
+ ```
+
+ ```
+ // detail页面通过back，将返回index页面
+ export default {
+ defaultBack() {
+ router.back();
}
- // 通过back，返回到detail页面
- export default {
- backToDetail() {
- router.back({uri:'pages/detail/detail'});
- }
+ }
+ ```
+
+ ```
+ // 通过back，返回到detail页面
+ export default {
+ backToDetail() {
+ router.back({uri:'pages/detail/detail'});
}
- ```
+ }
+ ```
- > **说明：**
- >示例中的uri字段是页面路由，由配置文件中的pages列表指定。
+ >  **说明：**
+ > 示例中的uri字段是页面路由，由配置文件中的pages列表指定。
+## router.clear
-## router.clear
-
-clear\(\): void
+clear(): void
清空页面栈中的所有历史页面，仅保留当前页面作为栈顶页面。
-- 示例
-
- ```
- export default {
- clearPage() {
- router.clear();
- }
+- 示例
+ ```
+ export default {
+ clearPage() {
+ router.clear();
}
- ```
+ }
+ ```
+## router.getLength
-## router.getLength
-
-getLength\(\): string
+getLength(): string
获取当前在页面栈内的页面数量。
-- 返回值
-
-
-
类型
- |
- 说明
- |
-
|---|
-
- string
- |
- 页面数量，页面栈支持最大数值是32。
- |
-
-
-
-
-- 示例
-
- ```
- export default {
- getLength() {
- var size = router.getLength();
- console.log('pages stack size = ' + size);
- }
+- 返回值
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | string | 页面数量，页面栈支持最大数值是32。 |
+
+- 示例
+ ```
+ export default {
+ getLength() {
+ var size = router.getLength();
+ console.log('pages stack size = ' + size);
}
- ```
-
+ }
+ ```
-## router.getState
+## router.getState
-getState\(\): <[RouterState](#tf9e3eb9ef0aa4d9880f996fe6afa6d1b)\>
+getState(): <RouterState>
获取当前页面的状态信息。
-- 返回值
-
- **表 1** RouterState
-
-
-
参数名
- |
- 类型
- |
- 说明
- |
-
|---|
-
- index
- |
- number
- |
- 表示当前页面在页面栈中的索引。
-
- |
-
- name
- |
- string
- |
- 表示当前页面的名称，即对应文件名。
- |
-
- path
- |
- string
- |
- 表示当前页面的路径。
- |
-
-
-
-
-- 示例
-
- ```
- export default {
- getState() {
- var page = router.getState();
- console.log('current index = ' + page.index);
- console.log('current name = ' + page.name);
- console.log('current path = ' + page.path);
- }
+- 返回值
+ **表1** RouterState
+
+ | 参数名 | 类型 | 说明 |
+ | -------- | -------- | -------- |
+ | index | number | 表示当前页面在页面栈中的索引。
>  **说明：**
> 从栈底到栈顶，index从1开始递增。 |
+ | name | string | 表示当前页面的名称，即对应文件名。 |
+ | path | string | 表示当前页面的路径。 |
+
+- 示例
+ ```
+ export default {
+ getState() {
+ var page = router.getState();
+ console.log('current index = ' + page.index);
+ console.log('current name = ' + page.name);
+ console.log('current path = ' + page.path);
}
- ```
-
+ }
+ ```
-## router.enableAlertBeforeBackPage
6+
+## router.enableAlertBeforeBackPage
6+
-enableAlertBeforeBackPage\(Object\): void
+enableAlertBeforeBackPage(Object): void
开启页面返回询问对话框。
-- 参数
-
-
-
参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- message
- |
- string
- |
- 是
- |
- 询问对话框内容。
- |
-
- success
- |
- () => void
- |
- 否
- |
- 接口调用成功的回调函数。
- |
-
- fail
- |
- () => void
- |
- 否
- |
- 接口调用失败的回调函数。
- |
-
- complete
- |
- () => void
- |
- 否
- |
- 接口调用结束的回调函数。
- |
-
-
-
-
-- 示例
-
- ```
- export default {
- enableAlertBeforeBackPage() {
- router.enableAlertBeforeBackPage({
- message: 'Message Info',
- success: function() {
- console.log('success');
- },
- fail: function() {
- console.log('fail');
- },
- });
- }
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | message | string | 是 | 询问对话框内容。 |
+ | success | () => void | 否 | 接口调用成功的回调函数。 |
+ | fail | () => void | 否 | 接口调用失败的回调函数。 |
+ | complete | () => void | 否 | 接口调用结束的回调函数。 |
+
+- 示例
+ ```
+ export default {
+ enableAlertBeforeBackPage() {
+ router.enableAlertBeforeBackPage({
+ message: 'Message Info',
+ success: function() {
+ console.log('success');
+ },
+ fail: function() {
+ console.log('fail');
+ },
+ });
}
- ```
+ }
+ ```
+## router.disableAlertBeforeBackPage
6+
-## router.disableAlertBeforeBackPage
6+
-
-disableAlertBeforeBackPage\(Object\): void
+disableAlertBeforeBackPage(Object): void
禁用页面返回询问对话框。
-- 参数：
-
-
-
参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- success
- |
- () => void
- |
- 否
- |
- 接口调用成功的回调函数。
- |
-
- fail
- |
- () => void
- |
- 否
- |
- 接口调用失败的回调函数。
- |
-
- complete
- |
- () => void
- |
- 否
- |
- 接口调用结束的回调函数。
- |
-
-
-
-
-- 示例
-
- ```
- export default {
- disableAlertBeforeBackPage() {
- router.disableAlertBeforeBackPage({
- success: function() {
- console.log('success');
- },
- fail: function() {
- console.log('fail');
- },
- });
- }
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | success | () => void | 否 | 接口调用成功的回调函数。 |
+ | fail | () => void | 否 | 接口调用失败的回调函数。 |
+ | complete | () => void | 否 | 接口调用结束的回调函数。 |
+
+- 示例
+ ```
+ export default {
+ disableAlertBeforeBackPage() {
+ router.disableAlertBeforeBackPage({
+ success: function() {
+ console.log('success');
+ },
+ fail: function() {
+ console.log('fail');
+ },
+ });
}
- ```
-
-
+ }
+ ```
+
+## router.getParams
7+
+
+getParams(): Object
+
+获取发起跳转的页面往当前页传入的参数。
+
+- 返回值
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Object | 发起跳转的页面往当前页传入的参数。 |
+
+- 示例
+ ```
+ // 在当前页面中
+ export default {
+ pushPage() {
+ router.push({
+ uri: 'pages/detail/detail',
+ params: {
+ data1: 'message',
+ },
+ });
+ }
+ }
+ // 在detail页面中
+ export default {
+ onInit() {
+ console.info('showData1:' + router.getParams().data1);
+ }
+ }
+ ```
diff --git a/zh-cn/application-dev/reference/apis/js-apis-basic-features-timer.md b/zh-cn/application-dev/reference/apis/js-apis-basic-features-timer.md
index 9a1375fc02533067d50250c5db602a069c88afb8..6336f2f39d5b5c4a2f229df1d330c0925f9d4fe2 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-basic-features-timer.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-basic-features-timer.md
@@ -1,258 +1,119 @@
-# 定时器
+# 定时器
-## 导入模块
+
+## 导入模块
无需导入。
-## 权限列表
+
+## 权限列表
无
-## setTimeout
-setTimeout\(handler\[,delay\[,…args\]\]\): number
+## setTimeout
+
+setTimeout(handler[,delay[,…args]]): number
设置一个定时器，该定时器在定时器到期后执行一个函数。
-- 参数
-
-
-
参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- handler
- |
- Function
- |
- 是
- |
- 定时器到期后执行函数。
- |
-
- delay
- |
- number
- |
- 否
- |
- 延迟的毫秒数，函数的调用会在该延迟之后发生。如果省略该参数，delay取默认值0，意味着“马上”执行，或尽快执行。
- |
-
- ...args
- |
- Array<any>
- |
- 否
- |
- 附加参数，一旦定时器到期，它们会作为参数传递给handler。
- |
-
-
-
-
-- 返回值
-
-
-
类型
- |
- 说明
- |
-
|---|
-
- number
- |
- timeout定时器的ID。
- |
-
-
-
-
-- 示例
-
- ```
- export default {
- setTimeOut() {
- var timeoutID = setTimeout(function() {
- console.log('delay 1s');
- }, 1000);
- }
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | handler | Function | 是 | 定时器到期后执行函数。 |
+ | delay | number | 否 | 延迟的毫秒数，函数的调用会在该延迟之后发生。如果省略该参数，delay取默认值0，意味着“马上”执行，或尽快执行。 |
+ | ...args | Array<any> | 否 | 附加参数，一旦定时器到期，它们会作为参数传递给handler。 |
+
+- 返回值
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | number | timeout定时器的ID。 |
+
+- 示例
+ ```
+ export default {
+ setTimeOut() {
+ var timeoutID = setTimeout(function() {
+ console.log('delay 1s');
+ }, 1000);
}
- ```
-
-
-## clearTimeout
-
-clearTimeout\(timeoutID: number\): void
-
-取消了先前通过调用setTimeout\(\)建立的定时器。
-
-- 参数
-
-
-
参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- timeoutID
- |
- number
- |
- 是
- |
- 要取消定时器的ID， 是由setTimeout()返回的。
- |
-
-
-
-
-- 示例
-
- ```
- export default {
- clearTimeOut() {
- var timeoutID = setTimeout(function() {
- console.log('do after 1s delay.');
- }, 1000);
- clearTimeout(timeoutID);
- }
+ }
+ ```
+
+
+## clearTimeout
+
+clearTimeout(timeoutID: number): void
+
+取消了先前通过调用setTimeout()建立的定时器。
+
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | timeoutID | number | 是 | 要取消定时器的ID， 是由setTimeout()返回的。 |
+
+- 示例
+ ```
+ export default {
+ clearTimeOut() {
+ var timeoutID = setTimeout(function() {
+ console.log('do after 1s delay.');
+ }, 1000);
+ clearTimeout(timeoutID);
}
- ```
+ }
+ ```
-## setInterval
+## setInterval
-setInterval\(handler\[, delay\[, ...args\]\]\): number
+setInterval(handler[, delay[, ...args]]): number
重复调用一个函数，在每次调用之间具有固定的时间延迟。
-- 参数
-
-
-
参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- handler
- |
- Function
- |
- 是
- |
- 要重复调用的函数。
- |
-
- delay
- |
- number
- |
- 否
- |
- 延迟的毫秒数（一秒等于1000毫秒），函数的调用会在该延迟之后发生。
- |
-
- ...args
- |
- Array<any>
- |
- 否
- |
- 附加参数，一旦定时器到期，他们会作为参数传递给handler。
- |
-
-
-
-
-- 返回值
-
-
-
类型
- |
- 说明
- |
-
|---|
-
- number
- |
- intervallID重复定时器的ID。
- |
-
-
-
-
-- 示例
-
- ```
- export default {
- setInterval() {
- var intervalID = setInterval(function() {
- console.log('do very 1s.');
- }, 1000);
- }
- }
- ```
-
-
-## clearInterval
-
-clearInterval\(intervalID: number\): void
-
-可取消先前通过 setInterval\(\) 设置的重复定时任务。
-
-- 参数
-
-
-
参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- intervalID
- |
- number
- |
- 是
- |
- 要取消的重复定时器的ID，是由 setInterval() 返回的。
- |
-
-
-
-
-- 示例
-
- ```
- export default {
- clearInterval() {
- var intervalID = setInterval(function() {
- console.log('do very 1s.');
- }, 1000);
- clearInterval(intervalID);
- }
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | handler | Function | 是 | 要重复调用的函数。 |
+ | delay | number | 否 | 延迟的毫秒数（一秒等于1000毫秒），函数的调用会在该延迟之后发生。 |
+ | ...args | Array<any> | 否 | 附加参数，一旦定时器到期，他们会作为参数传递给handler。 |
+
+- 返回值
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | number | intervallID重复定时器的ID。 |
+
+- 示例
+ ```
+ export default {
+ setInterval() {
+ var intervalID = setInterval(function() {
+ console.log('do very 1s.');
+ }, 1000);
}
- ```
+ }
+ ```
+
+
+## clearInterval
+clearInterval(intervalID: number): void
+可取消先前通过 setInterval() 设置的重复定时任务。
+
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | intervalID | number | 是 | 要取消的重复定时器的ID，是由 setInterval() 返回的。 |
+
+- 示例
+ ```
+ export default {
+ clearInterval() {
+ var intervalID = setInterval(function() {
+ console.log('do very 1s.');
+ }, 1000);
+ clearInterval(intervalID);
+ }
+ }
+ ```
diff --git a/zh-cn/application-dev/reference/apis/js-apis-basic-features.md b/zh-cn/application-dev/reference/apis/js-apis-basic-features.md
index 58d82e38f171849cb607ca3e77aa243b8f9f21f0..d41efd0d1810c8b5f39bd86b952a92d87f0226b3 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-basic-features.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-basic-features.md
@@ -1,23 +1,23 @@
-# 基本功能
+# 基本功能
-- **[应用上下文](js-apis-basic-features-app-context.md)**
-- **[日志打印](js-apis-basic-features-logs.md)**
-- **[页面路由](js-apis-basic-features-routes.md)**
+- **[应用上下文](js-apis-basic-features-app-context.md)**
-- **[弹窗](js-apis-basic-features-pop-up.md)**
+- **[日志打印](js-apis-basic-features-logs.md)**
-- **[应用配置](js-apis-basic-features-configuration.md)**
+- **[页面路由](js-apis-basic-features-routes.md)**
-- **[定时器](js-apis-basic-features-timer.md)**
+- **[弹窗](js-apis-basic-features-pop-up.md)**
-- **[设置系统时间](js-apis-system-time.md)**
+- **[应用配置](js-apis-basic-features-configuration.md)**
-- **[动画](js-apis-basic-features-animator.md)**
+- **[定时器](js-apis-basic-features-timer.md)**
-- **[应用打点](js-apis-hiappevent.md)**
+- **[设置系统时间](js-apis-system-time.md)**
-- **[性能打点](js-apis-bytrace.md)**
+- **[动画](js-apis-basic-features-animator.md)**
+- **[应用打点](js-apis-hiappevent.md)**
+- **[性能打点](js-apis-bytrace.md)**
\ No newline at end of file
diff --git a/zh-cn/application-dev/reference/apis/js-apis-battery-info.md b/zh-cn/application-dev/reference/apis/js-apis-battery-info.md
index ce90dd03f8e7035a7a6f6ea304c12f644e3b95d2..57a8070f4f4d702331a2c2fbb1868f0f44e30fdd 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-battery-info.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-battery-info.md
@@ -1,273 +1,74 @@
-# 电量信息
+# 电量信息
-> **说明：**
->从 API Version 6 开始支持。
+>  **说明：**
+> 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
-## 导入模块
+
+## 导入模块
```
import batteryInfo from '@ohos.batteryInfo';
```
-## 属性
-描述电池信息。
+## 属性
-
-
名称
- |
-类型
- |
-可读
- |
-可写
- |
-描述
- |
-
|---|
-
-batterySOC
- |
-number
- |
-是
- |
-否
- |
-表示当前设备剩余电池容量。
- |
-
-chargingStatus
- |
-BatteryChargeState
- |
-是
- |
-否
- |
-表示当前设备电池的充电状态。
- |
-
-healthStatus
- |
-BatteryHealthState
- |
-是
- |
-否
- |
-表示当前设备电池的健康状态。
- |
-
-pluggedType
- |
-BatteryPluggedType
- |
-是
- |
-否
- |
-表示当前设备连接的充电器类型。
- |
-
-voltage
- |
-number
- |
-是
- |
-否
- |
-表示当前设备电池的电压。
- |
-
-technology
- |
-string
- |
-是
- |
-否
- |
-表示当前设备电池的技术型号。
- |
-
-batteryTemperature
- |
-number
- |
-是
- |
-否
- |
-表示当前设备电池的温度。
- |
-
-isBatteryPresent7+
- |
-boolean
- |
-是
- |
-否
- |
-表示当前设备是否支持电池或者电池是否在位。
- |
-
-
-
+描述电池信息。
-- 示例：
+| 名称 | 类型 | 可读 | 可写 | 描述 |
+| -------- | -------- | -------- | -------- | -------- |
+| batterySOC | number | 是 | 否 | 表示当前设备剩余电池容量。 |
+| chargingStatus | [BatteryChargeState](#batterychargestate) | 是 | 否 | 表示当前设备电池的充电状态。 |
+| healthStatus | [BatteryHealthState](#batteryhealthstate) | 是 | 否 | 表示当前设备电池的健康状态。 |
+| pluggedType | [BatteryPluggedType](#batterypluggedtype) | 是 | 否 | 表示当前设备连接的充电器类型。 |
+| voltage | number | 是 | 否 | 表示当前设备电池的电压。 |
+| technology | string | 是 | 否 | 表示当前设备电池的技术型号。 |
+| batteryTemperature | number | 是 | 否 | 表示当前设备电池的温度。 |
+| isBatteryPresent
7+ | boolean | 是 | 否 | 表示当前设备是否支持电池或者电池是否在位。 |
- ```
- import batteryInfo from '@ohos.batteryInfo';
- var batterySoc = batteryInfo.batterySOC;
- ```
+- 示例：
+ ```
+ import batteryInfo from '@ohos.batteryInfo';
+ var batterySoc = batteryInfo.batterySOC;
+ ```
-## BatteryPluggedType
+## BatteryPluggedType
表示连接的充电器类型的枚举。
-
-
名称
- |
-默认值
- |
-描述
- |
-
|---|
-
-NONE
- |
-0
- |
-表示连接充电器类型未知。
- |
-
-AC
- |
-1
- |
-表示连接的充电器类型为交流充电器。
- |
-
-USB
- |
-2
- |
-表示连接的充电器类型为USB。
- |
-
-WIRELESS
- |
-3
- |
-表示连接的充电器类型为无线充电器。
- |
-
-
-
-## BatteryChargeState
+| 名称 | 默认值 | 描述 |
+| -------- | -------- | -------- |
+| NONE | 0 | 表示连接充电器类型未知。 |
+| AC | 1 | 表示连接的充电器类型为交流充电器。 |
+| USB | 2 | 表示连接的充电器类型为USB。 |
+| WIRELESS | 3 | 表示连接的充电器类型为无线充电器。 |
+
+
+## BatteryChargeState
表示电池充电状态的枚举。
-
-
名称
- |
-默认值
- |
-描述
- |
-
|---|
-
-NONE
- |
-0
- |
-表示电池充电状态未知。
- |
-
-ENABLE
- |
-1
- |
-表示电池充电状态为使能状态。
- |
-
-DISABLE
- |
-2
- |
-表示电池充电状态为停止状态。
- |
-
-FULL
- |
-3
- |
-表示电池充电状态为已充满状态。
- |
-
-
-
-## BatteryHealthState
+| 名称 | 默认值 | 描述 |
+| -------- | -------- | -------- |
+| NONE | 0 | 表示电池充电状态未知。 |
+| ENABLE | 1 | 表示电池充电状态为使能状态。 |
+| DISABLE | 2 | 表示电池充电状态为停止状态。 |
+| FULL | 3 | 表示电池充电状态为已充满状态。 |
+
+
+## BatteryHealthState
表示电池的健康状态的枚举。
-
-
名称
- |
-默认值
- |
-描述
- |
-
|---|
-
-UNKNOWN
- |
-0
- |
-表示电池健康状态未知。
- |
-
-GOOD
- |
-1
- |
-表示电池健康状态为正常。
- |
-
-OVERHEAT
- |
-2
- |
-表示电池健康状态为过热。
- |
-
-OVERVOLTAGE
- |
-3
- |
-表示电池健康状态为过压。
- |
-
-COLD
- |
-4
- |
-表示电池健康状态为低温。
- |
-
-DEAD
- |
-5
- |
-表示电池健康状态为僵死状态。
- |
-
-
-
+| 名称 | 默认值 | 描述 |
+| -------- | -------- | -------- |
+| UNKNOWN | 0 | 表示电池健康状态未知。 |
+| GOOD | 1 | 表示电池健康状态为正常。 |
+| OVERHEAT | 2 | 表示电池健康状态为过热。 |
+| OVERVOLTAGE | 3 | 表示电池健康状态为过压。 |
+| COLD | 4 | 表示电池健康状态为低温。 |
+| DEAD | 5 | 表示电池健康状态为僵死状态。 |
diff --git a/zh-cn/application-dev/reference/apis/js-apis-brightness.md b/zh-cn/application-dev/reference/apis/js-apis-brightness.md
index fb8f8bd696127f5727c98e9d371c55c5ee160614..1825ff78c9b0b02223f4aecd41ddafe9575fde44 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-brightness.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-brightness.md
@@ -1,50 +1,29 @@
-# 屏幕亮度
+# 屏幕亮度
-> **说明：**
->从 API Version 7 开始支持。
+>  **说明：**
+> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
-## 导入模块
+
+## 导入模块
```
import brightness from '@ohos.brightness';
```
-## brightness.setValue
-setValue\(value: number\)
+## brightness.setValue
-设置系统的屏幕亮度。
+setValue(value: number)
-- 参数：
-
-
-
参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- value
- |
- number
- |
- 是
- |
- 亮度的值（0~255）
- |
-
-
-
-
-- 示例：
-
- ```
- import brightness from '@ohos.brightness.d.ts';
- brightness.setValue(128);
- ```
+设置系统的屏幕亮度。
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | value | number | 是 | 亮度的值（0~255） |
+- 示例：
+ ```
+ import brightness from '@ohos.brightness.d.ts';
+ brightness.setValue(128);
+ ```
diff --git a/zh-cn/application-dev/reference/apis/js-apis-bytrace.md b/zh-cn/application-dev/reference/apis/js-apis-bytrace.md
index 26b64d588e2d201948d2ae28ff9df9076317debd..39b89054b0aaa58f87f962e655bf33abf1b88407 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-bytrace.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-bytrace.md
@@ -1,198 +1,107 @@
-# 性能打点
+# 性能打点
-> **说明：**
->从 API Version 7 开始支持。
+>  **说明：**
+> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
-## 导入模块
+
+## 导入模块
```
import bytrace from '@ohos.bytrace';
```
-## 权限
+
+## 权限
无
-## bytrace.startTrace
-startTrace\(name: string, taskId: number, expectedTime?: number\): void
+## bytrace.startTrace
+
+startTrace(name: string, taskId: number, expectedTime?: number): void
标记一个预追踪耗时任务的开始，expectedTime是可选参数，标识该任务的期望耗时。
-- 参数：
-
-
-
参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- name
- |
- string
- |
- 是
- |
- 要追踪的任务名称
- |
-
- taskId
- |
- number
- |
- 是
- |
- 任务id
- |
-
- expectedTime
- |
- number
- |
- 否
- |
- 期望的耗时时间，单位：ms
- |
-
-
-
-
- > **说明：**
- >如果有多个相同name的任务需要追踪或者对同一个任务要追踪多次，并且这些会同时被执行，则每次调用startTrace的taskId必须不一致。如果具有相同name的任务是串行执行的，则taskId可以相同。在下面bytrace.finishTrace的示例中会举例说明。
-
-- 示例：
-
- ```
- bytrace.startTrace("myTestFunc", 1);
- bytrace.startTrace("myTestFunc", 1, 5); //从startTrace到finishTrace流程的耗时期望为5ms
- ```
-
-
-## bytrace.finishTrace
-
-finishTrace\(name: string, taskId: number\): void
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | name | string | 是 | 要追踪的任务名称 |
+ | taskId | number | 是 | 任务id |
+ | expectedTime | number | 否 | 期望的耗时时间，单位：ms |
+
+ >  **说明：**
+ > 如果有多个相同name的任务需要追踪或者对同一个任务要追踪多次，并且这些会同时被执行，则每次调用startTrace的taskId必须不一致。如果具有相同name的任务是串行执行的，则taskId可以相同。在下面bytrace.finishTrace的示例中会举例说明。
+
+- 示例：
+ ```
+ bytrace.startTrace("myTestFunc", 1);
+ bytrace.startTrace("myTestFunc", 1, 5); //从startTrace到finishTrace流程的耗时期望为5ms
+ ```
+
+
+## bytrace.finishTrace
+
+finishTrace(name: string, taskId: number): void
标记一个预追踪耗时任务的结束。
-- 参数：
-
-
-
参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- name
- |
- string
- |
- 是
- |
- 要追踪的任务名称
- |
-
- taskId
- |
- number
- |
- 是
- |
- 任务id
- |
-
-
-
-
- > **说明：**
- >finishTrace的name和taskId必须与流程开始的startTrace对应参数值一致。
-
-- 示例：
-
- ```
- bytrace.finishTrace("myTestFunc", 1);
- ```
-
- ```
- //追踪并行执行的同名任务
- bytrace.startTrace("myTestFunc", 1);
- ...... //业务流程
- bytrace.startTrace("myTestFunc", 2); //第二个追踪的任务开始，同时第一个追踪的同名任务还没结束，出现了并行执行，对应接口的taskId需要不同。
- ...... //业务流程
- bytrace.finishTrace("myTestFunc", 1);
- ...... //业务流程
- bytrace.finishTrace("myTestFunc", 2);
- ```
-
- ```
- //追踪串行执行的同名任务
- bytrace.startTrace("myTestFunc", 1);
- ...... //业务流程
- bytrace.finishTrace("myTestFunc", 1); //第一个追踪的任务结束
- ...... //业务流程
- bytrace.startTrace("myTestFunc", 1); //第二个追踪的同名任务开始，同名的待追踪任务串行执行。
- ...... //业务流程
- bytrace.finishTrace("myTestFunc", 1);
- ```
-
-
-## bytrace.traceByValue
-
-traceByValue\(name: string, value: number\): void
-用来标记一个预追踪的数值变量，该变量的数值会不断变化。
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | name | string | 是 | 要追踪的任务名称 |
+ | taskId | number | 是 | 任务id |
+
+ >  **说明：**
+ > finishTrace的name和taskId必须与流程开始的startTrace对应参数值一致。
+
+- 示例：
+ ```
+ bytrace.finishTrace("myTestFunc", 1);
+ ```
+
+ ```
+ //追踪并行执行的同名任务
+ bytrace.startTrace("myTestFunc", 1);
+ ...... //业务流程
+ bytrace.startTrace("myTestFunc", 2); //第二个追踪的任务开始，同时第一个追踪的同名任务还没结束，出现了并行执行，对应接口的taskId需要不同。
+ ...... //业务流程
+ bytrace.finishTrace("myTestFunc", 1);
+ ...... //业务流程
+ bytrace.finishTrace("myTestFunc", 2);
+ ```
+
+ ```
+ //追踪串行执行的同名任务
+ bytrace.startTrace("myTestFunc", 1);
+ ...... //业务流程
+ bytrace.finishTrace("myTestFunc", 1); //第一个追踪的任务结束
+ ...... //业务流程
+ bytrace.startTrace("myTestFunc", 1); //第二个追踪的同名任务开始，同名的待追踪任务串行执行。
+ ...... //业务流程
+ bytrace.finishTrace("myTestFunc", 1);
+ ```
-- 参数：
-
-
-
参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- name
- |
- string
- |
- 是
- |
- 要追踪的数值变量名称
- |
-
- value
- |
- number
- |
- 是
- |
- 变量的值
- |
-
-
-
-
-- 示例：
-
- ```
- let traceCount = 3;
- bytrace.traceByValue("myTestCount", traceCount);
- ......
- traceCount = 5;
- bytrace.traceByValue("myTestCount", traceCount);
- ```
+
+## bytrace.traceByValue
+
+traceByValue(name: string, value: number): void
+
+用来标记一个预追踪的数值变量，该变量的数值会不断变化。
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | name | string | 是 | 要追踪的数值变量名称 |
+ | value | number | 是 | 变量的值 |
+
+- 示例：
+ ```
+ let traceCount = 3;
+ bytrace.traceByValue("myTestCount", traceCount);
+ ......
+ traceCount = 5;
+ bytrace.traceByValue("myTestCount", traceCount);
+ ```
diff --git a/zh-cn/application-dev/reference/apis/js-apis-call.md b/zh-cn/application-dev/reference/apis/js-apis-call.md
index ebc03287ad8161a21f3385992137568e7baeb163..06b0787b6a5d0e42d7a1054ce757621b8893489b 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-call.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-call.md
@@ -2,9 +2,7 @@
>**说明：**
>
->- 从 API Version 6 开始支持。
->
->- 标记
7+的接口从API Version 7开始支持。
+>本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
@@ -23,10 +21,10 @@ dial\(phoneNumber: string, callback: AsyncCallback
\): void
- 参数
- | 参数 | 类型 | 必填 | 说明 |
- | -------- | -------- | -------- | -------- |
- | phoneNumber | string | 是 |电话号码。|
- | callback |AsyncCallback<boolean>|是|回调函数：
- true：成功。
- false：失败。|
+ | 参数 | 类型 | 必填 | 说明 |
+ | ----------- | ---------------------------- | ---- | ------------------------------------------------- |
+ | phoneNumber | string | 是 | 电话号码。 |
+ | callback | AsyncCallback<boolean> | 是 | 回调函数：
- true：成功。
- false：失败。 |
- 示例
@@ -410,30 +408,30 @@ formatPhoneNumberToE164\(phoneNumber: string, countryCode: string\): Promise
拨打电话的可选参数。
-| 参数 | 类型 | 必填 | 说明 |
-| -------- | -------- | -------- | -------- |
-| extras | boolean | 否 |根据extras的值判断是否为视频通话，默认为语音通话。
- true：视频通话。
- fasle：语音通话。|
+| 参数 | 类型 | 必填 | 说明 |
+| ------ | ------- | ---- | ------------------------------------------------------------ |
+| extras | boolean | 否 | 根据extras的值判断是否为视频通话，默认为语音通话。
- true：视频通话。
- fasle：语音通话。 |
## CallState
通话状态码。
-| 变量 | 值 | 说明 |
-| -------- | -------- | -------- |
-| CALL_STATE_UNKNOWN | -1 | 无效状态，当获取呼叫状态失败时返回。 |
-| CALL_STATE_IDLE | 0 | 表示没有正在进行的呼叫。 |
-| CALL_STATE_RINGING | 1 | 表示来电正在振铃或等待。 |
-| CALL_STATE_OFFHOOK | 2 | 表示至少有一个呼叫处于拨号、通话中或呼叫保持状态，并且没有新的来电振铃或等待。 |
+| 变量 | 值 | 说明 |
+| ------------------ | ---- | ------------------------------------------------------------ |
+| CALL_STATE_UNKNOWN | -1 | 无效状态，当获取呼叫状态失败时返回。 |
+| CALL_STATE_IDLE | 0 | 表示没有正在进行的呼叫。 |
+| CALL_STATE_RINGING | 1 | 表示来电正在振铃或等待。 |
+| CALL_STATE_OFFHOOK | 2 | 表示至少有一个呼叫处于拨号、通话中或呼叫保持状态，并且没有新的来电振铃或等待。 |
## EmergencyNumberOptions7+
判断是否是紧急电话号码的可选参数。
-| 参数 | 类型 | 必填 | 说明 |
-| -------- | -------- | -------- | -------- |
-| slotId | number | 否 |卡槽ID：
- 0：卡槽1。
- 1：卡槽2。|
+| 参数 | 类型 | 必填 | 说明 |
+| ------ | ------ | ---- | ------------------------------------------ |
+| slotId | number | 否 | 卡槽ID：
- 0：卡槽1。
- 1：卡槽2。 |
## NumberFormatOptions7+
格式化号码的可选参数。
-| 参数 | 类型 | 必填 | 说明 |
-| -------- | -------- | -------- | -------- |
-| countryCode | string | 否 |国家码，支持所有国家的国家码，如：中国（CN）。默认为：CN。|
+| 参数 | 类型 | 必填 | 说明 |
+| ----------- | ------ | ---- | ---------------------------------------------------------- |
+| countryCode | string | 否 | 国家码，支持所有国家的国家码，如：中国（CN）。默认为：CN。 |
\ No newline at end of file
diff --git a/zh-cn/application-dev/reference/apis/js-apis-data-ability.md b/zh-cn/application-dev/reference/apis/js-apis-data-ability.md
index b19e3f579ea243989999ed1529cac5b42be2e3d3..7b82a0b98d1008b2badae7cdbdf58305cdad6481 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-data-ability.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-data-ability.md
@@ -1,1698 +1,787 @@
-# DataAbility 谓词
+# DataAbility 谓词
-> **说明：**
->从 API Version 7 开始支持。
+>  **说明：**
+> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
-## 导入模块
+
+## 导入模块
```
import dataAbility from '@ohos.data.dataAbility'
```
-## 权限
+
+## 权限
无
-## dataAbility.createRdbPredicates
-createRdbPredicates\(name: string, dataAbilityPredicates: DataAbilityPredicates\): rdb.RdbPredicates
+## dataAbility.createRdbPredicates
+
+
+createRdbPredicates(name: string, dataAbilityPredicates: DataAbilityPredicates): rdb.RdbPredicates
+
从DataAabilityPredicates对象创建RdbPredicates对象。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- name
- |
- string
- |
- 是
- |
- 数据库表中表名。
- |
-
- dataAbilityPredicates
- |
- DataAbilityPredicates
- |
- 是
- |
- dataAbility谓词。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- rdb.RdbPredicates
- |
- 返回RdbPredicates对象。
- |
-
-
-
-
-- 示例：
-
- ```
- let dataAbilityPredicates = new dataAbility.DataAbilityPredicates()
- dataAbilityPredicates.equalTo("NAME", "Rose").between("AGE", 16, 30)
- let predicates = dataAbility.createRdbPredicates("EMPLOYEE", dataAbilityPredicates)
- ```
-
-
-## DataAbilityPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | name | string | 是 | 数据库表中表名。 |
+ | dataAbilityPredicates | [DataAbilityPredicates](#dataabilitypredicates) | 是 | dataAbility谓词。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | rdb.[RdbPredicates](js-apis-data-rdb.md#rdbpredicates) | 返回RdbPredicates对象。 |
+
+- 示例：
+ ```
+ let dataAbilityPredicates = new dataAbility.DataAbilityPredicates()
+ dataAbilityPredicates.equalTo("NAME", "Rose").between("AGE", 16, 30)
+ let predicates = dataAbility.createRdbPredicates("EMPLOYEE", dataAbilityPredicates)
+ ```
+
+
+## DataAbilityPredicates
提供用于实现不同查询方法的谓词。
-### equalTo
-equalTo\(field: string, value: ValueType\): DataAbilityPredicates
+### equalTo
+
+
+equalTo(field: string, value: ValueType): DataAbilityPredicates
+
配置谓词以匹配数据类型为ValueType且值等于指定值的字段。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- field
- |
- string
- |
- 是
- |
- 数据库表中的列名。
- |
-
- value
- |
- ValueType
- |
- 是
- |
- 指示要与谓词匹配的值。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
- predicates.equalTo("NAME", "lisi")
- ```
-
-
-### notEqualTo
-
-notEqualTo\(field: string, value: ValueType\): DataAbilityPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | field | string | 是 | 数据库表中的列名。 |
+ | value | [ValueType](js-apis-data-rdb.md#valuetype) | 是 | 指示要与谓词匹配的值。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
+ predicates.equalTo("NAME", "lisi")
+ ```
+
+
+### notEqualTo
+
+
+notEqualTo(field: string, value: ValueType): DataAbilityPredicates
+
配置谓词以匹配数据类型为ValueType且值不等于指定值的字段。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- field
- |
- string
- |
- 是
- |
- 数据库表中的列名。
- |
-
- value
- |
- ValueType
- |
- 是
- |
- 指示要与谓词匹配的值。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
- predicates.notEqualTo("NAME", "lisi")
- ```
-
-
-### beginWrap
-
-beginWrap\(\): DataAbilityPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | field | string | 是 | 数据库表中的列名。 |
+ | value | [ValueType](js-apis-data-rdb.md#valuetype) | 是 | 指示要与谓词匹配的值。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
+ predicates.notEqualTo("NAME", "lisi")
+ ```
+
+
+### beginWrap
+
+
+beginWrap(): DataAbilityPredicates
+
向谓词添加左括号。
-- 返回值：
-
-
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [DataAbilityPredicates](#dataabilitypredicates) | 返回带有左括号的DataAbility谓词。 |
-- 示例：
+- 示例：
+ ```
+ let predicates = new dataAbilitylity.DataAbilityPredicates("EMPLOYEE")
+ predicates.equalTo("NAME", "lisi")
+ .beginWrap()
+ .equalTo("AGE", 18)
+ .or()
+ .equalTo("SALARY", 200.5)
+ .endWrap()
+ ```
- ```
- let predicates = new dataAbilitylity.DataAbilityPredicates("EMPLOYEE")
- predicates.equalTo("NAME", "lisi")
- .beginWrap()
- .equalTo("AGE", 18)
- .or()
- .equalTo("SALARY", 200.5)
- .endWrap()
- ```
+### endWrap
-### endWrap
-endWrap\(\): DataAbilityPredicates
+endWrap(): DataAbilityPredicates
+
向谓词添加右括号。
-- 返回值：
-
-
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [DataAbilityPredicates](#dataabilitypredicates) | 返回带有右括号的DataAbility谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
+ predicates.equalTo("NAME", "lisi")
+ .beginWrap()
+ .equalTo("AGE", 18)
+ .or()
+ .equalTo("SALARY", 200.5)
+ .endWrap()
+ ```
-- 示例：
- ```
- let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
- predicates.equalTo("NAME", "lisi")
- .beginWrap()
- .equalTo("AGE", 18)
- .or()
- .equalTo("SALARY", 200.5)
- .endWrap()
- ```
+### or
-### or
+or(): DataAbilityPredicates
-or\(\): DataAbilityPredicates
将或条件添加到谓词中。
-- 返回值：
-
-
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [DataAbilityPredicates](#dataabilitypredicates) | 返回带有或条件的DataAbility谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
+ predicates.equalTo("NAME", "Lisa")
+ .or()
+ .equalTo("NAME", "Rose")
+ ```
-- 示例：
- ```
- let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
- predicates.equalTo("NAME", "Lisa")
- .or()
- .equalTo("NAME", "Rose")
- ```
+### and
-### and
+and(): DataAbilityPredicates
-and\(\): DataAbilityPredicates
向谓词添加和条件。
-- 返回值：
-
-
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [DataAbilityPredicates](#dataabilitypredicates) | 返回带有和条件的DataAbility谓词。 |
-- 示例：
+- 示例：
+ ```
+ let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
+ predicates.equalTo("NAME", "Lisa")
+ .and()
+ .equalTo("SALARY", 200.5)
+ ```
- ```
- let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
- predicates.equalTo("NAME", "Lisa")
- .and()
- .equalTo("SALARY", 200.5)
- ```
+### contains
-### contains
-contains\(field: string, value: string\): DataAbilityPredicates
+contains(field: string, value: string): DataAbilityPredicates
+
配置谓词以匹配数据类型为String且value包含指定值的字段。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- field
- |
- string
- |
- 是
- |
- 数据库表中的列名。
- |
-
- value
- |
- string
- |
- 是
- |
- 指示要与谓词匹配的值。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
- predicates.contains("NAME", "os")
- ```
-
-
-### beginsWith
-
-beginsWith\(field: string, value: string\): DataAbilityPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | field | string | 是 | 数据库表中的列名。 |
+ | value | string | 是 | 指示要与谓词匹配的值。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
+ predicates.contains("NAME", "os")
+ ```
+
+
+### beginsWith
+
+
+beginsWith(field: string, value: string): DataAbilityPredicates
+
配置谓词以匹配数据类型为String且值以指定字符串开头的字段。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- field
- |
- string
- |
- 是
- |
- 数据库表中的列名。
- |
-
- value
- |
- string
- |
- 是
- |
- 指示要与谓词匹配的值。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
- predicates.beginsWith("NAME", "os")
- ```
-
-
-### endsWith
-
-endsWith\(field: string, value: string\): DataAbilityPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | field | string | 是 | 数据库表中的列名。 |
+ | value | string | 是 | 指示要与谓词匹配的值。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
+ predicates.beginsWith("NAME", "os")
+ ```
+
+
+### endsWith
+
+
+endsWith(field: string, value: string): DataAbilityPredicates
+
配置谓词以匹配数据类型为String且值以指定字符串结尾的字段。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- field
- |
- string
- |
- 是
- |
- 数据库表中的列名。
- |
-
- value
- |
- string
- |
- 是
- |
- 指示要与谓词匹配的值。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
- predicates.endsWith("NAME", "se")
- ```
-
-
-### isNull
-
-isNull\(field: string\): DataAbilityPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | field | string | 是 | 数据库表中的列名。 |
+ | value | string | 是 | 指示要与谓词匹配的值。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
+ predicates.endsWith("NAME", "se")
+ ```
+
+
+### isNull
+
+
+isNull(field: string): DataAbilityPredicates
+
配置谓词以匹配值为null的字段。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- field
- |
- string
- |
- 是
- |
- 数据库表中的列名。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
- predicates.isNull("NAME")
- ```
-
-
-### isNotNull
-
-isNotNull\(field: string\): DataAbilityPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | field | string | 是 | 数据库表中的列名。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
+ predicates.isNull("NAME")
+ ```
+
+
+### isNotNull
+
+
+isNotNull(field: string): DataAbilityPredicates
+
配置谓词以匹配值不为null的指定字段。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- field
- |
- string
- |
- 是
- |
- 数据库表中的列名。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
- predicates.isNotNull("NAME")
- ```
-
-
-### like
-
-like\(field: string, value: string\): DataAbilityPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | field | string | 是 | 数据库表中的列名。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
+ predicates.isNotNull("NAME")
+ ```
+
+
+### like
+
+
+like(field: string, value: string): DataAbilityPredicates
+
配置谓词以匹配数据类型为string且值类似于指定字符串的字段。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- field
- |
- string
- |
- 是
- |
- 数据库表中的列名。
- |
-
- value
- |
- string
- |
- 是
- |
- 指示要与谓词匹配的值。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
- predicates.like("NAME", "%os%")
- ```
-
-
-### glob
-
-glob\(field: string, value: string\): DataAbilityPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | field | string | 是 | 数据库表中的列名。 |
+ | value | string | 是 | 指示要与谓词匹配的值。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
+ predicates.like("NAME", "%os%")
+ ```
+
+
+### glob
+
+
+glob(field: string, value: string): DataAbilityPredicates
+
配置谓词匹配数据类型为string的指定字段。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- field
- |
- string
- |
- 是
- |
- 数据库表中的列名。
- |
-
- value
- |
- string
- |
- 是
- |
- 指示要与谓词匹配的值。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
- predicates.glob("NAME", "?h*g")
- ```
-
-
-### between
-
-between\(field: string, low: ValueType, high: ValueType\): DataAbilityPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | field | string | 是 | 数据库表中的列名。 |
+ | value | string | 是 | 指示要与谓词匹配的值。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
+ predicates.glob("NAME", "?h*g")
+ ```
+
+
+### between
+
+
+between(field: string, low: ValueType, high: ValueType): DataAbilityPredicates
+
将谓词配置为匹配数据类型为ValueType且value在指定范围内的指定字段。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- field
- |
- string
- |
- 是
- |
- 数据库表中的列名。
- |
-
- low
- |
- ValueType
- |
- 是
- |
- 指示与谓词匹配的最小值。
- |
-
- high
- |
- ValueType
- |
- 是
- |
- 指示与谓词匹配的最大值。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
- predicates.between("AGE", 10, 50)
- ```
-
-
-### notBetween
-
-notBetween\(field: string, low: ValueType, high: ValueType\): DataAbilityPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | field | string | 是 | 数据库表中的列名。 |
+ | low | [ValueType](js-apis-data-rdb.md#valuetype) | 是 | 指示与谓词匹配的最小值。 |
+ | high | [ValueType](js-apis-data-rdb.md#valuetype) | 是 | 指示与谓词匹配的最大值。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
+ predicates.between("AGE", 10, 50)
+ ```
+
+
+### notBetween
+
+
+notBetween(field: string, low: ValueType, high: ValueType): DataAbilityPredicates
+
配置谓词以匹配数据类型为ValueType且value超出给定范围的指定字段。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- field
- |
- string
- |
- 是
- |
- 数据库表中的列名。
- |
-
- low
- |
- ValueType
- |
- 是
- |
- 指示与谓词匹配的最小值。
- |
-
- high
- |
- ValueType
- |
- 是
- |
- 指示与谓词匹配的最大值。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
- predicates.notBetween("AGE", 10, 50)
- ```
-
-
-### greaterThan
-
-greaterThan\(field: string, value: ValueType\): DataAbilityPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | field | string | 是 | 数据库表中的列名。 |
+ | low | [ValueType](js-apis-data-rdb.md#valuetype) | 是 | 指示与谓词匹配的最小值。 |
+ | high | [ValueType](js-apis-data-rdb.md#valuetype) | 是 | 指示与谓词匹配的最大值。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
+ predicates.notBetween("AGE", 10, 50)
+ ```
+
+
+### greaterThan
+
+
+greaterThan(field: string, value: ValueType): DataAbilityPredicates
+
配置谓词以匹配数据类型为ValueType且值大于指定值的字段。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- field
- |
- string
- |
- 是
- |
- 数据库表中的列名。
- |
-
- value
- |
- ValueType
- |
- 是
- |
- 指示要与谓词匹配的值。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
- predicates.greaterThan("AGE", 18)
- ```
-
-
-### lessThan
-
-lessThan\(field: string, value: ValueType\): DataAbilityPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | field | string | 是 | 数据库表中的列名。 |
+ | value | [ValueType](js-apis-data-rdb.md#valuetype) | 是 | 指示要与谓词匹配的值。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
+ predicates.greaterThan("AGE", 18)
+ ```
+
+
+### lessThan
+
+
+lessThan(field: string, value: ValueType): DataAbilityPredicates
+
配置谓词以匹配数据类型为valueType且value小于指定值的字段。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- field
- |
- string
- |
- 是
- |
- 数据库表中的列名。
- |
-
- value
- |
- ValueType
- |
- 是
- |
- 指示要与谓词匹配的值。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
- predicates.lessThan("AGE", 20)
- ```
-
-
-### greaterThanOrEqualTo
-
-greaterThanOrEqualTo\(field: string, value: ValueType\): DataAbilityPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | field | string | 是 | 数据库表中的列名。 |
+ | value | [ValueType](js-apis-data-rdb.md#valuetype) | 是 | 指示要与谓词匹配的值。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
+ predicates.lessThan("AGE", 20)
+ ```
+
+
+### greaterThanOrEqualTo
+
+
+greaterThanOrEqualTo(field: string, value: ValueType): DataAbilityPredicates
+
配置谓词以匹配数据类型为ValueType且value大于或等于指定值的字段。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- field
- |
- string
- |
- 是
- |
- 数据库表中的列名。
- |
-
- value
- |
- ValueType
- |
- 是
- |
- 指示要与谓词匹配的值。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
- predicates.greaterThanOrEqualTo("AGE", 18)
- ```
-
-
-### lessThanOrEqualTo
-
-lessThanOrEqualTo\(field: string, value: ValueType\): DataAbilityPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | field | string | 是 | 数据库表中的列名。 |
+ | value | [ValueType](js-apis-data-rdb.md#valuetype) | 是 | 指示要与谓词匹配的值。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
+ predicates.greaterThanOrEqualTo("AGE", 18)
+ ```
+
+
+### lessThanOrEqualTo
+
+
+lessThanOrEqualTo(field: string, value: ValueType): DataAbilityPredicates
+
配置谓词以匹配数据类型为ValueType且value小于或等于指定值的字段。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- field
- |
- string
- |
- 是
- |
- 数据库表中的列名。
- |
-
- value
- |
- ValueType
- |
- 是
- |
- 指示要与谓词匹配的值。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
- predicates.lessThanOrEqualTo("AGE", 20)
- ```
-
-
-### orderByAsc
-
-orderByAsc\(field: string\): DataAbilityPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | field | string | 是 | 数据库表中的列名。 |
+ | value | [ValueType](js-apis-data-rdb.md#valuetype) | 是 | 指示要与谓词匹配的值。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
+ predicates.lessThanOrEqualTo("AGE", 20)
+ ```
+
+
+### orderByAsc
+
+
+orderByAsc(field: string): DataAbilityPredicates
+
配置谓词以匹配其值按升序排序的列。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- field
- |
- string
- |
- 是
- |
- 数据库表中的列名。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
- predicates.orderByAsc("NAME")
- ```
-
-
-### orderByDesc
-
-orderByDesc\(field: string\): DataAbilityPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | field | string | 是 | 数据库表中的列名。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
+ predicates.orderByAsc("NAME")
+ ```
+
+
+### orderByDesc
+
+
+orderByDesc(field: string): DataAbilityPredicates
+
配置谓词以匹配其值按降序排序的列。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- field
- |
- string
- |
- 是
- |
- 数据库表中的列名。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
- predicates.orderByDesc("AGE")
- ```
-
-
-### distinct
-
-distinct\(\): DataAbilityPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | field | string | 是 | 数据库表中的列名。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
+ predicates.orderByDesc("AGE")
+ ```
+
+
+### distinct
+
+
+distinct(): DataAbilityPredicates
+
配置谓词以过滤重复记录并仅保留其中一个。
-- 返回值：
-
-
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [DataAbilityPredicates](#dataabilitypredicates) | 返回可用于过滤重复记录的谓词。 |
-- 示例：
+- 示例：
+ ```
+ let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
+ predicates.equalTo("NAME", "Rose").distinct("NAME")
+ let resultSet = await rdbStore.query(predicates, ["NAME"])
+ ```
- ```
- let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
- predicates.equalTo("NAME", "Rose").distinct("NAME")
- let resultSet = await rdbStore.query(predicates, ["NAME"])
- ```
+### limitAs
-### limitAs
-limitAs\(value: number\): DataAbilityPredicates
+limitAs(value: number): DataAbilityPredicates
+
设置最大数据记录数的谓词。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- value
- |
- number
- |
- 是
- |
- 最大数据记录数。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
- predicates.equalTo("NAME", "Rose").limitAs(3)
- ```
-
-
-### offsetAs
-
-offsetAs\(rowOffset: number\): DataAbilityPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | value | number | 是 | 最大数据记录数。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [DataAbilityPredicates](#dataabilitypredicates) | 返回可用于设置最大数据记录数的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
+ predicates.equalTo("NAME", "Rose").limitAs(3)
+ ```
+
+
+### offsetAs
+
+
+offsetAs(rowOffset: number): DataAbilityPredicates
+
配置谓词以指定返回结果的起始位置。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- rowOffset
- |
- number
- |
- 是
- |
- 返回结果的起始位置，取值为正整数。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
- predicates.equalTo("NAME", "Rose").offsetAs(3)
- ```
-
-
-### groupBy
-
-groupBy\(fields: Array\): DataAbilityPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | rowOffset | number | 是 | 返回结果的起始位置，取值为正整数。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [DataAbilityPredicates](#dataabilitypredicates) | 返回具有指定返回结果起始位置的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
+ predicates.equalTo("NAME", "Rose").offsetAs(3)
+ ```
+
+
+### groupBy
+
+
+groupBy(fields: Array<string>): DataAbilityPredicates
+
配置谓词按指定列分组查询结果。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- fields
- |
- Array<string>
- |
- 是
- |
- 指定分组依赖的列名。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
- predicates.groupBy(["AGE", "NAME"])
- ```
-
-
-### indexedBy
-
-indexedBy\(indexName: string\): DataAbilityPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | fields | Array<string> | 是 | 指定分组依赖的列名。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [DataAbilityPredicates](#dataabilitypredicates) | 返回分组查询列的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
+ predicates.groupBy(["AGE", "NAME"])
+ ```
+
+
+### indexedBy
+
+
+indexedBy(indexName: string): DataAbilityPredicates
+
配置谓词以指定索引列。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- indexName
- |
- string
- |
- 是
- |
- 索引列的名称。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
- predicates.indexedBy("SALARY_INDEX")
- ```
-
-
-### in
-
-in\(field: string, value: Array\): DataAbilityPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | indexName | string | 是 | 索引列的名称。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [DataAbilityPredicates](#dataabilitypredicates) | 返回具有指定索引列的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
+ predicates.indexedBy("SALARY_INDEX")
+ ```
+
+
+### in
+
+
+in(field: string, value: Array<ValueType>): DataAbilityPredicates
+
配置谓词以匹配数据类型为ValueType数组且值在给定范围内的指定字段。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- field
- |
- string
- |
- 是
- |
- 数据库表中的列名。
- |
-
- value
- |
- Array<ValueType>
- |
- 是
- |
- 以ValueType型数组形式指定的要匹配的值。
- |
-
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
- predicates.in("AGE", [18, 20])
- ```
-
-
-### notIn
-
-notIn\(field: string, value: Array\): DataAbilityPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | field | string | 是 | 数据库表中的列名。 |
+ | value | Array<[ValueType](js-apis-data-rdb.md#valuetype)> | 是 | 以ValueType型数组形式指定的要匹配的值。 |
+
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
+ predicates.in("AGE", [18, 20])
+ ```
+
+
+### notIn
+
+
+notIn(field: string, value: Array<ValueType>): DataAbilityPredicates
+
配置谓词以匹配数据类型为ValueType数组且值不在给定范围内的指定字段。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- field
- |
- string
- |
- 是
- |
- 数据库表中的列名。
- |
-
- value
- |
- Array<ValueType>
- |
- 是
- |
- 以ValueType型数组形式指定的要匹配的值。
- |
-
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
- predicates.notIn("NAME", ["Lisa", "Rose"])
- ```
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | field | string | 是 | 数据库表中的列名。 |
+ | value | Array<[ValueType](js-apis-data-rdb.md#valuetype)> | 是 | 以ValueType型数组形式指定的要匹配的值。 |
+
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
+ predicates.notIn("NAME", ["Lisa", "Rose"])
+ ```
diff --git a/zh-cn/application-dev/reference/apis/js-apis-data-rdb.md b/zh-cn/application-dev/reference/apis/js-apis-data-rdb.md
index 4c86eb19b634875cd7ca1c54880166c7045187e6..35320c16f06518332a5cb19eebd3fffc54195cda 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-data-rdb.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-data-rdb.md
@@ -1,2642 +1,1158 @@
-# 关系型数据库
+# 关系型数据库
-> **说明：**
->从 API Version 7 开始支持。
+>  **说明：**
+> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
-## 导入模块
+
+## 导入模块
```
import dataRdb from '@ohos.data.rdb'
```
-## 权限
+
+## 权限
无
-## dataRdb.getRdbStore
-getRdbStore\(config: StoreConfig, version: number, callback: AsyncCallback\): void
+## dataRdb.getRdbStore
+
+getRdbStore(config: StoreConfig, version: number, callback: AsyncCallback<RdbStore>): void
获得一个相关的RdbStore，操作关系型数据库，用户可以根据自己的需求配置RdbStore的参数，然后通过RdbStore调用相关接口可以执行相关的数据操作，结果以callback形式返回。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- config
- |
- StoreConfig
- |
- 是
- |
- 与此RDB存储相关的数据库配置。
- |
-
- version
- |
- number
- |
- 是
- |
- 数据库版本。
- |
-
- callback
- |
- AsyncCallback<RdbStore>
- |
- 是
- |
- 指定callback回调函数。返回一个RdbStore。
- |
-
-
-
-
-- 示例：
-
- ```
- import dataRdb from '@ohos.data.rdb'
- const STORE_CONFIG = { name: "RdbTest.db" }
- const SQL_CREATE_TABLE = "CREATE TABLE IF NOT EXISTS EMPLOYEE (ID INTEGER PRIMARY KEY AUTOINCREMENT, NAME TEXT NOT NULL, AGE INTEGER, SALARY REAL, CODES BLOB)"
- dataRdb.getRdbStore(STORE_CONFIG, 1, function (err, rdbStore) {
- rdbStore.executeSql(SQL_CREATE_TABLE)
- console.info(TAG + 'create table done.')
- })
- ```
-
-
-## dataRdb.getRdbStore
-
-getRdbStore\(config: StoreConfig, version: number\): Promise
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | config | [StoreConfig](#storeconfig) | 是 | 与此RDB存储相关的数据库配置。 |
+ | version | number | 是 | 数据库版本。 |
+ | callback | AsyncCallback<[RdbStore](#rdbstore)> | 是 | 指定callback回调函数。返回一个RdbStore。 |
+
+- 示例：
+ ```
+ import dataRdb from '@ohos.data.rdb'
+ const STORE_CONFIG = { name: "RdbTest.db" }
+ const SQL_CREATE_TABLE = "CREATE TABLE IF NOT EXISTS EMPLOYEE (ID INTEGER PRIMARY KEY AUTOINCREMENT, NAME TEXT NOT NULL, AGE INTEGER, SALARY REAL, CODES BLOB)"
+ dataRdb.getRdbStore(STORE_CONFIG, 1, function (err, rdbStore) {
+ rdbStore.executeSql(SQL_CREATE_TABLE)
+ console.info(TAG + 'create table done.')
+ })
+ ```
+
+
+## dataRdb.getRdbStore
+
+getRdbStore(config: StoreConfig, version: number): Promise<RdbStore>
获得一个相关的RdbStore，操作关系型数据库，用户可以根据自己的需求配置RdbStore的参数，然后通过RdbStore调用相关接口可以执行相关的数据操作，结果以Promise形式返回。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- config
- |
- StoreConfig
- |
- 是
- |
- 与此RDB存储相关的数据库配置。
- |
-
- version
- |
- number
- |
- 是
- |
- 数据库版本。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<RdbStore>
- |
- 指定Promise回调函数。返回一个RdbStore。
- |
-
-
-
-
-- 示例：
-
- ```
- import dataRdb from '@ohos.data.rdb'
- const STORE_CONFIG = { name: "RdbTest.db" }
- const SQL_CREATE_TABLE = "CREATE TABLE IF NOT EXISTS EMPLOYEE (ID INTEGER PRIMARY KEY AUTOINCREMENT, NAME TEXT NOT NULL, AGE INTEGER, SALARY REAL, CODES BLOB)"
- let promise = dataRdb.getRdbStore(STORE_CONFIG, 1);
- promise.then(async (rdbStore) => {
- await rdbStore.executeSql(SQL_CREATE_TABLE, null)
- }).catch((err) => {
- expect(null).assertFail();
- })
- ```
-
-
-## dataRdb.deleteRdbStore
-
-deleteRdbStore\(name: string, callback: AsyncCallback\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | config | [StoreConfig](#storeconfig) | 是 | 与此RDB存储相关的数据库配置。 |
+ | version | number | 是 | 数据库版本。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<[RdbStore](#rdbstore)> | 指定Promise回调函数。返回一个RdbStore。 |
+
+- 示例：
+ ```
+ import dataRdb from '@ohos.data.rdb'
+ const STORE_CONFIG = { name: "RdbTest.db" }
+ const SQL_CREATE_TABLE = "CREATE TABLE IF NOT EXISTS EMPLOYEE (ID INTEGER PRIMARY KEY AUTOINCREMENT, NAME TEXT NOT NULL, AGE INTEGER, SALARY REAL, CODES BLOB)"
+ let promise = dataRdb.getRdbStore(STORE_CONFIG, 1);
+ promise.then(async (rdbStore) => {
+ await rdbStore.executeSql(SQL_CREATE_TABLE, null)
+ }).catch((err) => {
+ expect(null).assertFail();
+ })
+ ```
+
+
+## dataRdb.deleteRdbStore
+
+deleteRdbStore(name: string, callback: AsyncCallback<void>): void
删除数据库，结果以callback形式返回。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- name
- |
- string
- |
- 是
- |
- 数据库名称。
- |
-
- callback
- |
- AsyncCallback<void>
- |
- 是
- |
- 指定callback回调函数。如果数据库已删除，则为true；否则返回false。
- |
-
-
-
-
-- 示例：
-
- ```
- import dataRdb from '@ohos.data.rdb'
- dataRdb.deleteRdbStore("RdbTest.db", function (err, rdbStore) {
- console.info(TAG + 'delete store done.')})
- ```
-
-
-## dataRdb.deleteRdbStore
-
-deleteRdbStore\(name: string\): Promise
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | name | string | 是 | 数据库名称。 |
+ | callback | AsyncCallback<void> | 是 | 指定callback回调函数。如果数据库已删除，则为true；否则返回false。 |
+
+- 示例：
+ ```
+ import dataRdb from '@ohos.data.rdb'
+ dataRdb.deleteRdbStore("RdbTest.db", function (err, rdbStore) {
+ console.info(TAG + 'delete store done.')})
+ ```
+
+
+## dataRdb.deleteRdbStore
+
+deleteRdbStore(name: string): Promise<void>
使用指定的数据库文件配置删除数据库，结果以Promise形式返回。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- name
- |
- string
- |
- 是
- |
- 数据库名称。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<void>
- |
- 指定Promise回调函数。如果数据库已删除，则为true；否则返回false。
- |
-
-
-
-
-- 示例：
-
- ```
- import dataRdb from '@ohos.data.rdb'
- let promise = dataRdb.deleteRdbStore("RdbTest.db")
- promise.then(()=>{
- console.info(TAG + 'delete store done.')
- })
- ```
-
-
-## RdbPredicates
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | name | string | 是 | 数据库名称。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<void> | 指定Promise回调函数。如果数据库已删除，则为true；否则返回false。 |
+
+- 示例：
+ ```
+ import dataRdb from '@ohos.data.rdb'
+ let promise = dataRdb.deleteRdbStore("RdbTest.db")
+ promise.then(()=>{
+ console.info(TAG + 'delete store done.')
+ })
+ ```
+
+
+## RdbPredicates
表示关系型数据库（RDB）的谓词。该类确定RDB中条件表达式的值是true还是false。
-### constructor
-constructor\(name: string\)
+### constructor
+
+constructor(name: string)
+
构造函数。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- name
- |
- string
- |
- 是
- |
- 数据库表名。
- |
-
-
-
-
-- 示例：
-
- ```
- import dataRdb from '@ohos.data.rdb'
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- ```
-
-
-### equalTo
-
-equalTo\(field: string, value: ValueType\): RdbPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | name | string | 是 | 数据库表名。 |
+
+- 示例：
+ ```
+ import dataRdb from '@ohos.data.rdb'
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ ```
+
+
+### equalTo
+
+equalTo(field: string, value: ValueType): RdbPredicates
+
配置谓词以匹配数据字段为ValueType且值等于指定值的字段。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- field
- |
- string
- |
- 是
- |
- 数据库表中的列名。
- |
-
- value
- |
- ValueType
- |
- 是
- |
- 指示要与谓词匹配的值。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- predicates.equalTo("NAME", "lisi")
- ```
-
-
-### notEqualTo
-
-notEqualTo\(field: string, value: ValueType\): RdbPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | field | string | 是 | 数据库表中的列名。 |
+ | value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ predicates.equalTo("NAME", "lisi")
+ ```
+
+
+### notEqualTo
+
+notEqualTo(field: string, value: ValueType): RdbPredicates
+
配置谓词以匹配数据字段为ValueType且值不等于指定值的字段。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- field
- |
- string
- |
- 是
- |
- 数据库表中的列名。
- |
-
- value
- |
- ValueType
- |
- 是
- |
- 指示要与谓词匹配的值。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- predicates.notEqualTo("NAME", "lisi")
- ```
-
-
-### beginWrap
-
-beginWrap\(\): RdbPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | field | string | 是 | 数据库表中的列名。 |
+ | value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ predicates.notEqualTo("NAME", "lisi")
+ ```
+
+
+### beginWrap
+
+beginWrap(): RdbPredicates
+
向谓词添加左括号。
-- 返回值：
-
-
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [RdbPredicates](#rdbpredicates) | 返回带有左括号的Rdb谓词。 |
-- 示例：
+- 示例：
+ ```
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ predicates.equalTo("NAME", "lisi")
+ .beginWrap()
+ .equalTo("AGE", 18)
+ .or()
+ .equalTo("SALARY", 200.5)
+ .endWrap()
+ ```
- ```
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- predicates.equalTo("NAME", "lisi")
- .beginWrap()
- .equalTo("AGE", 18)
- .or()
- .equalTo("SALARY", 200.5)
- .endWrap()
- ```
+### endWrap
-### endWrap
+endWrap(): RdbPredicates
-endWrap\(\): RdbPredicates
向谓词添加右括号。
-- 返回值：
-
-
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [RdbPredicates](#rdbpredicates) | 返回带有右括号的Rdb谓词。 |
-- 示例：
+- 示例：
+ ```
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ predicates.equalTo("NAME", "lisi")
+ .beginWrap()
+ .equalTo("AGE", 18)
+ .or()
+ .equalTo("SALARY", 200.5)
+ .endWrap()
+ ```
- ```
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- predicates.equalTo("NAME", "lisi")
- .beginWrap()
- .equalTo("AGE", 18)
- .or()
- .equalTo("SALARY", 200.5)
- .endWrap()
- ```
+### or
-### or
+or(): RdbPredicates
-or\(\): RdbPredicates
将或条件添加到谓词中。
-- 返回值：
-
-
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [RdbPredicates](#rdbpredicates) | 返回带有或条件的Rdb谓词。 |
-- 示例：
+- 示例：
+ ```
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ predicates.equalTo("NAME", "Lisa")
+ .or()
+ .equalTo("NAME", "Rose")
+ ```
- ```
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- predicates.equalTo("NAME", "Lisa")
- .or()
- .equalTo("NAME", "Rose")
- ```
+### and
-### and
+and(): RdbPredicates
-and\(\): RdbPredicates
向谓词添加和条件。
-- 返回值：
-
-
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [RdbPredicates](#rdbpredicates) | 返回带有和条件的Rdb谓词。 |
-- 示例：
+- 示例：
+ ```
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ predicates.equalTo("NAME", "Lisa")
+ .and()
+ .equalTo("SALARY", 200.5)
+ ```
- ```
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- predicates.equalTo("NAME", "Lisa")
- .and()
- .equalTo("SALARY", 200.5)
- ```
+### contains
-### contains
+contains(field: string, value: string): RdbPredicat
-contains\(field: string, value: string\): RdbPredicat
配置谓词以匹配数据字段为String且value包含指定值的字段。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- field
- |
- string
- |
- 是
- |
- 数据库表中的列名。
- |
-
- value
- |
- string
- |
- 是
- |
- 指示要与谓词匹配的值。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- predicates.contains("NAME", "os")
- ```
-
-
-### beginsWith
-
-beginsWith\(field: string, value: string\): RdbPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | field | string | 是 | 数据库表中的列名。 |
+ | value | string | 是 | 指示要与谓词匹配的值。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ predicates.contains("NAME", "os")
+ ```
+
+
+### beginsWith
+
+beginsWith(field: string, value: string): RdbPredicates
+
配置谓词以匹配数据字段为String且值以指定字符串开头的字段。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- field
- |
- string
- |
- 是
- |
- 数据库表中的列名。
- |
-
- value
- |
- string
- |
- 是
- |
- 指示要与谓词匹配的值。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- predicates.beginsWith("NAME", "os")
- ```
-
-
-### endsWith
-
-endsWith\(field: string, value: string\): RdbPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | field | string | 是 | 数据库表中的列名。 |
+ | value | string | 是 | 指示要与谓词匹配的值。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ predicates.beginsWith("NAME", "os")
+ ```
+
+
+### endsWith
+
+endsWith(field: string, value: string): RdbPredicates
+
配置谓词以匹配数据字段为String且值以指定字符串结尾的字段。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- field
- |
- string
- |
- 是
- |
- 数据库表中的列名。
- |
-
- value
- |
- string
- |
- 是
- |
- 指示要与谓词匹配的值。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- predicates.endsWith("NAME", "se")
- ```
-
-
-### isNull
-
-isNull\(field: string\): RdbPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | field | string | 是 | 数据库表中的列名。 |
+ | value | string | 是 | 指示要与谓词匹配的值。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ predicates.endsWith("NAME", "se")
+ ```
+
+
+### isNull
+
+isNull(field: string): RdbPredicates
+
配置谓词以匹配值为null的字段。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- field
- |
- string
- |
- 是
- |
- 数据库表中的列名。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例
-
- ```
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- predicates.isNull("NAME")
- ```
-
-
-### isNotNull
-
-isNotNull\(field: string\): RdbPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | field | string | 是 | 数据库表中的列名。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
+
+- 示例
+ ```
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ predicates.isNull("NAME")
+ ```
+
+
+### isNotNull
+
+isNotNull(field: string): RdbPredicates
+
配置谓词以匹配值不为null的指定字段。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- field
- |
- string
- |
- 是
- |
- 数据库表中的列名。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- predicates.isNotNull("NAME")
- ```
-
-
-### like
-
-like\(field: string, value: string\): RdbPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | field | string | 是 | 数据库表中的列名。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ predicates.isNotNull("NAME")
+ ```
+
+
+### like
+
+like(field: string, value: string): RdbPredicates
+
配置谓词以匹配数据字段为String且值类似于指定字符串的字段。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- field
- |
- string
- |
- 是
- |
- 数据库表中的列名。
- |
-
- value
- |
- string
- |
- 是
- |
- 指示要与谓词匹配的值。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- predicates.like("NAME", "%os%")
- ```
-
-
-### glob
-
-glob\(field: string, value: string\): RdbPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | field | string | 是 | 数据库表中的列名。 |
+ | value | string | 是 | 指示要与谓词匹配的值。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ predicates.like("NAME", "%os%")
+ ```
+
+
+### glob
+
+glob(field: string, value: string): RdbPredicates
+
配置RdbPredicates匹配数据字段为String的指定字段。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- field
- |
- string
- |
- 是
- |
- 数据库表中的列名。
- |
-
- value
- |
- string
- |
- 是
- |
- 指示要与谓词匹配的值。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- predicates.glob("NAME", "?h*g")
- ```
-
-
-### between
-
-between\(field: string, low: ValueType, high: ValueType\): RdbPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | field | string | 是 | 数据库表中的列名。 |
+ | value | string | 是 | 指示要与谓词匹配的值。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [RdbPredicates](#rdbpredicates) | 返回指定的Rdb谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ predicates.glob("NAME", "?h*g")
+ ```
+
+
+### between
+
+between(field: string, low: ValueType, high: ValueType): RdbPredicates
+
将谓词配置为匹配数据字段为ValueType且value在给定范围内的指定字段。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- field
- |
- string
- |
- 是
- |
- 数据库表中的列名。
- |
-
- low
- |
- ValueType
- |
- 是
- |
- 指示与谓词匹配的最小值。
- |
-
- high
- |
- ValueType
- |
- 是
- |
- 指示要与谓词匹配的最大值。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- predicates.between("AGE", 10, 50)
- ```
-
-
-### notBetween
-
-notBetween\(field: string, low: ValueType, high: ValueType\): RdbPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | field | string | 是 | 数据库表中的列名。 |
+ | low | [ValueType](#valuetype) | 是 | 指示与谓词匹配的最小值。 |
+ | high | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的最大值。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ predicates.between("AGE", 10, 50)
+ ```
+
+
+### notBetween
+
+notBetween(field: string, low: ValueType, high: ValueType): RdbPredicates
+
配置RdbPredicates以匹配数据字段为ValueType且value超出给定范围的指定字段。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- field
- |
- string
- |
- 是
- |
- 数据库表中的列名。
- |
-
- low
- |
- ValueType
- |
- 是
- |
- 指示与谓词匹配的最小值。
- |
-
- high
- |
- ValueType
- |
- 是
- |
- 指示要与谓词匹配的最大值。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- predicates.notBetween("AGE", 10, 50)
- ```
-
-
-### greaterThan
-
-greaterThan\(field: string, value: ValueType\): RdbPredicatesgr
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | field | string | 是 | 数据库表中的列名。 |
+ | low | [ValueType](#valuetype) | 是 | 指示与谓词匹配的最小值。 |
+ | high | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的最大值。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ predicates.notBetween("AGE", 10, 50)
+ ```
+
+
+### greaterThan
+
+greaterThan(field: string, value: ValueType): RdbPredicatesgr
+
配置谓词以匹配数据字段为ValueType且值大于指定值的字段。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- field
- |
- string
- |
- 是
- |
- 数据库表中的列名。
- |
-
- value
- |
- ValueType
- |
- 是
- |
- 指示要与谓词匹配的值。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- predicates.greaterThan("AGE", 18)
- ```
-
-
-### lessThan
-
-lessThan\(field: string, value: ValueType\): RdbPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | field | string | 是 | 数据库表中的列名。 |
+ | value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ predicates.greaterThan("AGE", 18)
+ ```
+
+
+### lessThan
+
+lessThan(field: string, value: ValueType): RdbPredicates
+
配置谓词以匹配数据字段为valueType且value小于指定值的字段。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- field
- |
- string
- |
- 是
- |
- 数据库表中的列名。
- |
-
- value
- |
- ValueType
- |
- 是
- |
- 指示要与谓词匹配的值。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- predicates.lessThan("AGE", 20)
- ```
-
-
-### greaterThanOrEqualTo
-
-greaterThanOrEqualTo\(field: string, value: ValueType\): RdbPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | field | string | 是 | 数据库表中的列名。 |
+ | value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ predicates.lessThan("AGE", 20)
+ ```
+
+
+### greaterThanOrEqualTo
+
+
+greaterThanOrEqualTo(field: string, value: ValueType): RdbPredicates
+
配置谓词以匹配数据字段为ValueType且value大于或等于指定值的字段。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- field
- |
- string
- |
- 是
- |
- 数据库表中的列名。
- |
-
- value
- |
- ValueType
- |
- 是
- |
- 指示要与谓词匹配的值。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- predicates.greaterThanOrEqualTo("AGE", 18)
- ```
-
-
-### lessThanOrEqualTo
-
-lessThanOrEqualTo\(field: string, value: ValueType\): RdbPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | field | string | 是 | 数据库表中的列名。 |
+ | value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ predicates.greaterThanOrEqualTo("AGE", 18)
+ ```
+
+
+### lessThanOrEqualTo
+
+
+lessThanOrEqualTo(field: string, value: ValueType): RdbPredicates
+
配置谓词以匹配数据字段为ValueType且value小于或等于指定值的字段。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- field
- |
- string
- |
- 是
- |
- 数据库表中的列名。
- |
-
- value
- |
- ValueType
- |
- 是
- |
- 指示要与谓词匹配的值。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- predicates.lessThanOrEqualTo("AGE", 20)
- ```
-
-
-### orderByAsc
-
-orderByAsc\(field: string\): RdbPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | field | string | 是 | 数据库表中的列名。 |
+ | value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ predicates.lessThanOrEqualTo("AGE", 20)
+ ```
+
+
+### orderByAsc
+
+
+orderByAsc(field: string): RdbPredicates
+
配置谓词以匹配其值按升序排序的列。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- field
- |
- string
- |
- 是
- |
- 数据库表中的列名。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- predicates.orderByAsc("NAME")
- ```
-
-
-### orderByDesc
-
-orderByDesc\(field: string\): RdbPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | field | string | 是 | 数据库表中的列名。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ predicates.orderByAsc("NAME")
+ ```
+
+
+### orderByDesc
+
+
+orderByDesc(field: string): RdbPredicates
+
配置谓词以匹配其值按降序排序的列。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- field
- |
- string
- |
- 是
- |
- 数据库表中的列名。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- predicates.orderByDesc("AGE")
- ```
-
-
-### distinct
-
-distinct\(\): RdbPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | field | string | 是 | 数据库表中的列名。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ predicates.orderByDesc("AGE")
+ ```
+
+
+### distinct
+
+distinct(): RdbPredicates
+
配置谓词以过滤重复记录并仅保留其中一个。
-- 返回值：
-
-
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [RdbPredicates](#rdbpredicates) | 返回可用于过滤重复记录的谓词。 |
-- 示例：
+- 示例：
+ ```
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ predicates.equalTo("NAME", "Rose").distinct("NAME")
+ let resultSet = await rdbStore.query(predicates, ["NAME"])
+ ```
- ```
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- predicates.equalTo("NAME", "Rose").distinct("NAME")
- let resultSet = await rdbStore.query(predicates, ["NAME"])
- ```
+### limitAs
-### limitAs
+limitAs(value: number): RdbPredicates
-limitAs\(value: number\): RdbPredicates
设置最大数据记录数的谓词。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- value
- |
- number
- |
- 是
- |
- 最大数据记录数。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- predicates.equalTo("NAME", "Rose").limitAs(3)
- ```
-
-
-### offsetAs
-
-offsetAs\(rowOffset: number\): RdbPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | value | number | 是 | 最大数据记录数。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [RdbPredicates](#rdbpredicates) | 返回可用于设置最大数据记录数的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ predicates.equalTo("NAME", "Rose").limitAs(3)
+ ```
+
+
+### offsetAs
+
+offsetAs(rowOffset: number): RdbPredicates
+
配置RdbPredicates以指定返回结果的起始位置。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- rowOffset
- |
- number
- |
- 是
- |
- 返回结果的起始位置，取值为正整数。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- predicates.equalTo("NAME", "Rose").offsetAs(3)
- ```
-
-
-### groupBy
-
-groupBy\(fields: Array\): RdbPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | rowOffset | number | 是 | 返回结果的起始位置，取值为正整数。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [RdbPredicates](#rdbpredicates) | 返回具有指定返回结果起始位置的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ predicates.equalTo("NAME", "Rose").offsetAs(3)
+ ```
+
+
+### groupBy
+
+groupBy(fields: Array<string>): RdbPredicates
+
配置RdbPredicates按指定列分组查询结果。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- fields
- |
- Array<string>
- |
- 是
- |
- 指定分组依赖的列名。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- predicates.groupBy(["AGE", "NAME"])
- ```
-
-
-### indexedBy
-
-indexedBy\(indexName: string\): RdbPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | fields | Array<string> | 是 | 指定分组依赖的列名。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [RdbPredicates](#rdbpredicates) | 返回分组查询列的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ predicates.groupBy(["AGE", "NAME"])
+ ```
+
+
+### indexedBy
+
+indexedBy(indexName: string): RdbPredicates
+
配置RdbPredicates以指定索引列。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- indexName
- |
- string
- |
- 是
- |
- 索引列的名称。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- RdbPredicates
- |
- 返回具有指定索引列的RdbPredicates。
- |
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- predicates.indexedBy("SALARY_INDEX")
- ```
-
-
-### in
-
-in\(field: string, value: Array\): RdbPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | indexName | string | 是 | 索引列的名称。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [RdbPredicates](#rdbpredicates) | 返回具有指定索引列的RdbPredicates。 |
+
+- 示例：
+ ```
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ predicates.indexedBy("SALARY_INDEX")
+ ```
+
+
+### in
+
+in(field: string, value: Array<ValueType>): RdbPredicates
+
配置RdbPredicates以匹配数据字段为ValueType数组且值在给定范围内的指定字段。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- field
- |
- string
- |
- 是
- |
- 数据库表中的列名。
- |
-
- value
- |
- Array<ValueType>
- |
- 是
- |
- 以ValueType型数组形式指定的要匹配的值。
- |
-
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- predicates.in("AGE", [18, 20])
- ```
-
-
-### notIn
-
-notIn\(field: string, value: Array\): RdbPredicates
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | field | string | 是 | 数据库表中的列名。 |
+ | value | Array<[ValueType](#valuetype)> | 是 | 以ValueType型数组形式指定的要匹配的值。 |
+
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ predicates.in("AGE", [18, 20])
+ ```
+
+
+### notIn
+
+notIn(field: string, value: Array<ValueType>): RdbPredicates
+
将RdbPredicates配置为匹配数据字段为ValueType且值超出给定范围的指定字段。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- field
- |
- string
- |
- 是
- |
- 数据库表中的列名。
- |
-
- value
- |
- Array<ValueType>
- |
- 是
- |
- 以ValueType数组形式指定的要匹配的值。
- |
-
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- predicates.notIn("NAME", ["Lisa", "Rose"])
- ```
-
-
-## RdbStore
-
-提供管理关系数据库\(RDB\)方法的接口。
-
-### insert
-
-insert\(name: string, values: ValuesBucket, callback: AsyncCallback\):void
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | field | string | 是 | 数据库表中的列名。 |
+ | value | Array<[ValueType](#valuetype)> | 是 | 以ValueType数组形式指定的要匹配的值。 |
+
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
+
+- 示例：
+ ```
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ predicates.notIn("NAME", ["Lisa", "Rose"])
+ ```
+
+
+## RdbStore
+
+提供管理关系数据库(RDB)方法的接口。
+
+
+### insert
+
+insert(name: string, values: ValuesBucket, callback: AsyncCallback<number>):void
向目标表中插入一行数据，结果以callback形式返回。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- name
- |
- string
- |
- 是
- |
- 指定的目标表名。
- |
-
- values
- |
- ValuesBucket
- |
- 是
- |
- 表示要插入到表中的数据行。
- |
-
- callback
- |
- AsyncCallback<number>
- |
- 是
- |
- 指定callback回调函数。如果操作成功，返回行ID；否则返回-1。
- |
-
-
-
-
-- 示例：
-
- ```
- const valueBucket = {
- "NAME": "Lisa",
- "AGE": 18,
- "SALARY": 100.5,
- "CODES": new Uint8Array([1, 2, 3, 4, 5]),
- }
- rdbStore.insert("EMPLOYEE", valueBucket, function (err, ret) {
- expect(1).assertEqual(ret)
- console.log(TAG + "insert first done: " + ret)})
- ```
-
-
-### insert
-
-insert\(name: string, values: ValuesBucket\):Promise
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | name | string | 是 | 指定的目标表名。 |
+ | values | [ValuesBucket](#valuesbucket) | 是 | 表示要插入到表中的数据行。 |
+ | callback | AsyncCallback<number> | 是 | 指定callback回调函数。如果操作成功，返回行ID；否则返回-1。 |
+
+- 示例：
+ ```
+ const valueBucket = {
+ "NAME": "Lisa",
+ "AGE": 18,
+ "SALARY": 100.5,
+ "CODES": new Uint8Array([1, 2, 3, 4, 5]),
+ }
+ rdbStore.insert("EMPLOYEE", valueBucket, function (err, ret) {
+ expect(1).assertEqual(ret)
+ console.log(TAG + "insert first done: " + ret)})
+ ```
+
+
+### insert
+
+insert(name: string, values: ValuesBucket):Promise<number>
向目标表中插入一行数据，结果以Promise形式返回。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- name
- |
- string
- |
- 是
- |
- 指定的目标表名。
- |
-
- values
- |
- ValuesBucket
- |
- 是
- |
- 表示要插入到表中的数据行。
- |
-
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<number>
- |
- 指定Promise回调函数。如果操作成功，返回行ID；否则返回-1。
- |
-
-
-
-
-- 示例：
-
- ```
- const valueBucket = {
- "NAME": "Lisa",
- "AGE": 18,
- "SALARY": 100.5,
- "CODES": new Uint8Array([1, 2, 3, 4, 5]),
- }
- let promise = rdbStore.insert("EMPLOYEE", valueBucket)
- promise.then(async (ret) => {
- await console.log(TAG + "insert first done: " + ret)
- }).catch((err) => {})
- ```
-
-
-### update
-
-update\(values: ValuesBucket, rdbPredicates: RdbPredicates, callback: AsyncCallback\):void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | name | string | 是 | 指定的目标表名。 |
+ | values | [ValuesBucket](#valuesbucket) | 是 | 表示要插入到表中的数据行。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<number> | 指定Promise回调函数。如果操作成功，返回行ID；否则返回-1。 |
+
+- 示例：
+ ```
+ const valueBucket = {
+ "NAME": "Lisa",
+ "AGE": 18,
+ "SALARY": 100.5,
+ "CODES": new Uint8Array([1, 2, 3, 4, 5]),
+ }
+ let promise = rdbStore.insert("EMPLOYEE", valueBucket)
+ promise.then(async (ret) => {
+ await console.log(TAG + "insert first done: " + ret)
+ }).catch((err) => {})
+ ```
+
+
+### update
+
+update(values: ValuesBucket, rdbPredicates: RdbPredicates, callback: AsyncCallback<number>):void
根据RdbPredicates的指定实例对象更新数据库中的数据，结果以callback形式返回。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- values
- |
- ValuesBucket
- |
- 是
- |
- value指示数据库中要更新的数据行。键值对与数据库表的列名相关联
- |
-
- rdbPredicates
- |
- RdbPredicates
- |
- 是
- |
- 表示要插入到表中的数据行。
- |
-
- callback
- |
- AsyncCallback<number>
- |
- 是
- |
- 指定的callback回调方法。返回受影响的行数。
- |
-
-
-
-
-- 示例：
-
- ```
- const valueBucket = {
- "NAME": "Rose",
- "AGE": 22,
- "SALARY": 200.5,
- "CODES": new Uint8Array([1, 2, 3, 4, 5]),
- }
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- predicates.equalTo("NAME", "Lisa")
- rdbStore.update(valueBucket, predicates, function (err, ret) {
- console.log(TAG + "updated row count: " + changedRows)})
- ```
-
-
-### update
-
-update\(values: ValuesBucket, rdbPredicates: RdbPredicates\):Promise
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | values | [ValuesBucket](#valuesbucket) | 是 | value指示数据库中要更新的数据行。键值对与数据库表的列名相关联 |
+ | rdbPredicates | [RdbPredicates](#rdbpredicates) | 是 | 表示要插入到表中的数据行。 |
+ | callback | AsyncCallback<number> | 是 | 指定的callback回调方法。返回受影响的行数。 |
+
+- 示例：
+ ```
+ const valueBucket = {
+ "NAME": "Rose",
+ "AGE": 22,
+ "SALARY": 200.5,
+ "CODES": new Uint8Array([1, 2, 3, 4, 5]),
+ }
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ predicates.equalTo("NAME", "Lisa")
+ rdbStore.update(valueBucket, predicates, function (err, ret) {
+ console.log(TAG + "updated row count: " + changedRows)})
+ ```
+
+
+### update
+
+update(values: ValuesBucket, rdbPredicates: RdbPredicates):Promise<number>
根据RdbPredicates的指定实例对象更新数据库中的数据，结果以Promise形式返回。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- values
- |
- ValuesBucket
- |
- 是
- |
- value指示数据库中要更新的数据行。键值对与数据库表的列名相关联
- |
-
- rdbPredicates
- |
- RdbPredicates
- |
- 是
- |
- 表示要插入到表中的数据行。
- |
-
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<number>
- |
- 指定的Promise回调方法。返回受影响的行数。
- |
-
-
-
-
-- 示例：
-
- ```
- const valueBucket = {
- "NAME": "Rose",
- "AGE": 22,
- "SALARY": 200.5,
- "CODES": new Uint8Array([1, 2, 3, 4, 5]),
- }
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- predicates.equalTo("NAME", "Lisa")
- let promise = rdbStore.update(valueBucket, predicates)
- promise.then(async (ret) => {
- await console.log(TAG + "updated row count: " + changedRows)
- }).catch((err) => {})
- ```
-
-
-### delete
-
-delete\(rdbPredicates: RdbPredicates, callback: AsyncCallback\):void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | values | [ValuesBucket](#valuesbucket) | 是 | value指示数据库中要更新的数据行。键值对与数据库表的列名相关联 |
+ | rdbPredicates | [RdbPredicates](#rdbpredicates) | 是 | 表示要插入到表中的数据行。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<number> | 指定的Promise回调方法。返回受影响的行数。 |
+
+- 示例：
+ ```
+ const valueBucket = {
+ "NAME": "Rose",
+ "AGE": 22,
+ "SALARY": 200.5,
+ "CODES": new Uint8Array([1, 2, 3, 4, 5]),
+ }
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ predicates.equalTo("NAME", "Lisa")
+ let promise = rdbStore.update(valueBucket, predicates)
+ promise.then(async (ret) => {
+ await console.log(TAG + "updated row count: " + changedRows)
+ }).catch((err) => {})
+ ```
+
+
+### delete
+
+delete(rdbPredicates: RdbPredicates, callback: AsyncCallback<number>):void
+
根据rdbPredicates的指定实例对象从数据库中删除数据，结果以callback形式返回。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- rdbPredicates
- |
- RdbPredicates
- |
- 是
- |
- RdbPredicates的实例对象指定的删除条件。
- |
-
- callback
- |
- AsyncCallback<number>
- |
- 是
- |
- 指定callback回调函数。返回受影响的行数。
- |
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- predicates.equalTo("NAME", "Lisa")
- rdbStore.delete(predicates, function (err, rows) {
- console.log(TAG + "delete rows: " + rows)})
- ```
-
-
-### delete
-
-delete\(rdbPredicates: RdbPredicates\):Promise
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | rdbPredicates | [RdbPredicates](#rdbpredicates) | 是 | RdbPredicates的实例对象指定的删除条件。 |
+ | callback | AsyncCallback<number> | 是 | 指定callback回调函数。返回受影响的行数。 |
+
+- 示例：
+ ```
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ predicates.equalTo("NAME", "Lisa")
+ rdbStore.delete(predicates, function (err, rows) {
+ console.log(TAG + "delete rows: " + rows)})
+ ```
+
+
+### delete
+
+delete(rdbPredicates: RdbPredicates):Promise<number>
根据rdbPredicates的指定实例对象从数据库中删除数据，结果以Promise形式返回。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- rdbPredicates
- |
- RdbPredicates
- |
- 是
- |
- RdbPredicates的实例对象指定的删除条件。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<number>
- |
- 指定Promise回调函数。返回受影响的行数。
- |
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- predicates.equalTo("NAME", "Lisa")
- let promise = rdbStore.delete(predicates)
- promise.then((rows) => {
- console.log(TAG + "delete rows: " + rows)
- }).catch((err) => {})
- ```
-
-
-### query
-
-query\(rdbPredicates: RdbPredicates, columns: Array, callback: AsyncCallback\):void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | rdbPredicates | [RdbPredicates](#rdbpredicates) | 是 | RdbPredicates的实例对象指定的删除条件。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<number> | 指定Promise回调函数。返回受影响的行数。 |
+
+- 示例：
+ ```
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ predicates.equalTo("NAME", "Lisa")
+ let promise = rdbStore.delete(predicates)
+ promise.then((rows) => {
+ console.log(TAG + "delete rows: " + rows)
+ }).catch((err) => {})
+ ```
+
+
+### query
+
+query(rdbPredicates: RdbPredicates, columns: Array<string>, callback: AsyncCallback<ResultSet>):void
根据指定条件查询数据库中的数据，结果以callback形式返回。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- rdbPredicates
- |
- RdbPredicates
- |
- 是
- |
- 表示rdbPredicates的实例对象指定的查询条件。
- |
-
- columns
- |
- Array<string>
- |
- 是
- |
- 表示要查询的列。如果值为空，则查询应用于所有列。
- |
-
- callback
- |
- AsyncCallback<ResultSet>
- |
- 是
- |
- 指定callback回调函数。如果操作成功，则返回ResultSet对象。
- |
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- predicates.equalTo("NAME", "Rose")
- rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"], function (err, resultSet) {
- console.log(TAG + "resultSet column names:" + resultSet.columnNames)
- console.log(TAG + "resultSet column count:" + resultSet.columnCount)})
- ```
-
-
-### query
-
-query\(rdbPredicates: RdbPredicates, columns: Array\):Promise
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | rdbPredicates | [RdbPredicates](#rdbpredicates) | 是 | 表示rdbPredicates的实例对象指定的查询条件。 |
+ | columns | Array<string> | 是 | 表示要查询的列。如果值为空，则查询应用于所有列。 |
+ | callback | AsyncCallback<[ResultSet](../reference/apis/js-apis-data-resultset.md#resultset)> | 是 | 指定callback回调函数。如果操作成功，则返回ResultSet对象。 |
+
+- 示例：
+ ```
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ predicates.equalTo("NAME", "Rose")
+ rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"], function (err, resultSet) {
+ console.log(TAG + "resultSet column names:" + resultSet.columnNames)
+ console.log(TAG + "resultSet column count:" + resultSet.columnCount)})
+ ```
+
+
+### query
+
+query(rdbPredicates: RdbPredicates, columns: Array<string>):Promise<ResultSet>
根据指定条件查询数据库中的数据，结果以Promise形式返回。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- rdbPredicates
- |
- RdbPredicates
- |
- 是
- |
- 表示rdbPredicates的实例对象指定的查询条件。
- |
-
- columns
- |
- Array<string>
- |
- 是
- |
- 表示要查询的列。如果值为空，则查询应用于所有列。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<ResultSet>
- |
- 指定Promise回调函数。如果操作成功，则返回ResultSet对象。
- |
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- predicates.equalTo("NAME", "Rose")
- let promise = rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"])
- promise.then((resultSet) => {
- console.log(TAG + "resultSet column names:" + resultSet.columnNames)
- console.log(TAG + "resultSet column count:" + resultSet.columnCount)})
- ```
-
-
-### executeSql
-
-executeSql\(sql: string, bindArgs: Array, callback: AsyncCallback\):void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | rdbPredicates | [RdbPredicates](#rdbpredicates) | 是 | 表示rdbPredicates的实例对象指定的查询条件。 |
+ | columns | Array<string> | 是 | 表示要查询的列。如果值为空，则查询应用于所有列。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<[ResultSet](../reference/apis/js-apis-data-resultset.md#resultset)> | 指定Promise回调函数。如果操作成功，则返回ResultSet对象。 |
+
+- 示例：
+ ```
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ predicates.equalTo("NAME", "Rose")
+ let promise = rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"])
+ promise.then((resultSet) => {
+ console.log(TAG + "resultSet column names:" + resultSet.columnNames)
+ console.log(TAG + "resultSet column count:" + resultSet.columnCount)})
+ ```
+
+
+### executeSql
+
+executeSql(sql: string, bindArgs: Array<ValueType>, callback: AsyncCallback<void>):void
执行包含指定参数但不返回值的SQL语句，结果以callbck形式返回。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- sql
- |
- string
- |
- 是
- |
- 指定要执行的SQL语句。
- |
-
- bindArgs
- |
- Array<ValueType>
- |
- 是
- |
- SQL语句中参数的值。
- |
-
- callback
- |
- AsyncCallback<void>
- |
- 是
- |
- 指定callback回调函数。
- |
-
-
-
-
-
-- 示例：
-
- ```
- rdbStore.executeSql("DELETE FROM EMPLOYEE", function () {
- console.info(TAG + 'delete done.')})
- ```
-
-
-### executeSql
-
-executeSql\(sql: string, bindArgs: Array\):Promise
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | sql | string | 是 | 指定要执行的SQL语句。 |
+ | bindArgs | Array<[ValueType](#valuetype)> | 是 | SQL语句中参数的值。 |
+ | callback | AsyncCallback<void> | 是 | 指定callback回调函数。 |
+
+- 示例：
+ ```
+ rdbStore.executeSql("DELETE FROM EMPLOYEE", function () {
+ console.info(TAG + 'delete done.')})
+ ```
+
+
+### executeSql
+
+executeSql(sql: string, bindArgs: Array<ValueType>):Promise<void>
执行包含指定参数但不返回值的SQL语句，结果以Promise形式返回。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- sql
- |
- string
- |
- 是
- |
- 指定要执行的SQL语句。
- |
-
- bindArgs
- |
- Array<ValueType>
- |
- 是
- |
- SQL语句中参数的值。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<void>
- |
- 指定Promise回调函数。
- |
-
-
-
-
-- 示例：
-
- ```
- let promise = rdbStore.executeSql("DELETE FROM EMPLOYEE")
- promise.then(() => {
- console.info(TAG + 'delete done.')})
- ```
-
-
-## StoreConfig
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | sql | string | 是 | 指定要执行的SQL语句。 |
+ | bindArgs | Array<[ValueType](#valuetype)> | 是 | SQL语句中参数的值。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<void> | 指定Promise回调函数。 |
+
+- 示例：
+ ```
+ let promise = rdbStore.executeSql("DELETE FROM EMPLOYEE")
+ promise.then(() => {
+ console.info(TAG + 'delete done.')})
+ ```
+
+
+## StoreConfig
管理关系数据库配置。
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-name
- |
-string
- |
-是
- |
-数据库文件名。
- |
-
-
-
-
-## ValueType
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | -------- | -------- | -------- |
+| name | string | 是 | 数据库文件名。 |
+
+
+## ValueType
用于表示允许的数据字段类型。
-
-名称
- |
-说明
- |
-
|---|
-
-number
- |
-表示值类型为数字。
- |
-
-string
- |
-表示值类型为字符。
- |
-
-boolean
- |
-表示值类型为布尔值。
- |
-
-
-
-
-## ValuesBucket
+| 名称 | 说明 |
+| -------- | -------- |
+| number | 表示值类型为数字。 |
+| string | 表示值类型为字符。 |
+| boolean | 表示值类型为布尔值。 |
+
+
+## ValuesBucket
用于存储键值对。
-
-名称
- |
-参数类型
- |
-必填
- |
-说明
- |
-
|---|
-
-[key: string]
- |
-ValueType| Uint8Array | null
- |
-是
- |
-用于存储键值对。
- |
-
-
-
+| 名称 | 参数类型 | 必填 | 说明 |
+| -------- | -------- | -------- | -------- |
+| [key: string] | [ValueType](#valuetype)\| Uint8Array \| null | 是 | 用于存储键值对。 |
diff --git a/zh-cn/application-dev/reference/apis/js-apis-data-resultset.md b/zh-cn/application-dev/reference/apis/js-apis-data-resultset.md
index a1900a06c456a84390b177de12d6263ed8e4e38a..b2bd32db35fd9af1347a6abd2f1539e5b82d8fb2 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-data-resultset.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-data-resultset.md
@@ -1,11 +1,12 @@
-# 结果集
+# 结果集
-> **说明：**
->从 API Version 7 开始支持。
+>  **说明：**
+> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
-## 使用说明
-需要通过[RdbStore.query\(\)](js-apis-data-rdb.md#section6231155031814)获取resultSet对象。
+## 使用说明
+
+需要通过[RdbStore.query()](js-apis-data-rdb.md#query)获取resultSet对象。
```
import dataRdb from '@ohos.data.rdb';
@@ -17,772 +18,342 @@ promise.then((resultSet) => {
await console.log(TAG + "resultSet columnCount:" + resultSet.columnCount);})
```
-## 权限
+
+## 权限
无
-## ResultSet
+
+## ResultSet
提供通过查询数据库生成的数据库结果集的访问方法。
-### 属性
-
-
-名称
- |
-参数类型
- |
-必填
- |
-说明
- |
-
|---|
-
-columnNames
- |
-Array<string>
- |
-是
- |
-获取结果集中所有列的名称。
- |
-
-columnCount
- |
-number
- |
-是
- |
-获取结果集中的列数。
- |
-
-rowCount
- |
-number
- |
-是
- |
-获取结果集中的行数。
- |
-
-rowIndex
- |
-number
- |
-是
- |
-获取结果集当前行的索引。
- |
-
-isAtFirstRow
- |
-boolean
- |
-是
- |
-检查结果集是否位于第一行。
- |
-
-isAtLastRow
- |
-boolean
- |
-是
- |
-检查结果集是否位于最后一行。
- |
-
-isEnded
- |
-boolean
- |
-是
- |
-检查结果集是否位于最后一行之后。
- |
-
-isStarted
- |
-boolean
- |
-是
- |
-检查指针是否移动过。
- |
-
-isClosed
- |
-boolean
- |
-是
- |
-检查当前结果集是否关闭。
- |
-
-
-
-
-### getColumnIndex
-
-getColumnIndex\(columnName: string\): number
+
+### 属性
+
+
+| 名称 | 参数类型 | 必填 | 说明 |
+| -------- | -------- | -------- | -------- |
+| columnNames | Array<string> | 是 | 获取结果集中所有列的名称。 |
+| columnCount | number | 是 | 获取结果集中的列数。 |
+| rowCount | number | 是 | 获取结果集中的行数。 |
+| rowIndex | number | 是 | 获取结果集当前行的索引。 |
+| isAtFirstRow | boolean | 是 | 检查结果集是否位于第一行。 |
+| isAtLastRow | boolean | 是 | 检查结果集是否位于最后一行。 |
+| isEnded | boolean | 是 | 检查结果集是否位于最后一行之后。 |
+| isStarted | boolean | 是 | 检查指针是否移动过。 |
+| isClosed | boolean | 是 | 检查当前结果集是否关闭。 |
+
+
+### getColumnIndex
+
+getColumnIndex(columnName: string): number
根据指定的列名获取列索引。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- columnName
- |
- string
- |
- 是
- |
- 表示结果集中指定列的名称。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- number
- |
- 返回指定列的索引。
- |
-
-
-
-
-- 示例：
-
- ```
- resultSet.goToFirstRow()
- const id = resultSet.getLong(resultSet.getColumnIndex("ID"))
- const name = resultSet.getString(resultSet.getColumnIndex("NAME"))
- const age = resultSet.getLong(resultSet.getColumnIndex("AGE"))
- const salary = resultSet.getDouble(resultSet.getColumnIndex("SALARY"))
- ```
-
-
-### getColumnName
-
-getColumnName\(columnIndex: number\): string
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | columnName | string | 是 | 表示结果集中指定列的名称。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | number | 返回指定列的索引。 |
+
+- 示例：
+ ```
+ resultSet.goToFirstRow()
+ const id = resultSet.getLong(resultSet.getColumnIndex("ID"))
+ const name = resultSet.getString(resultSet.getColumnIndex("NAME"))
+ const age = resultSet.getLong(resultSet.getColumnIndex("AGE"))
+ const salary = resultSet.getDouble(resultSet.getColumnIndex("SALARY"))
+ ```
+
+
+### getColumnName
+
+getColumnName(columnIndex: number): string
根据指定的列索引获取列名。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- columnIndex
- |
- number
- |
- 是
- |
- 表示结果集中指定列的索引。
- |
-
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- string
- |
- 返回指定列的名称。
- |
-
-
-
-
-- 示例：
-
- ```
- const id = resultSet.getColumnName(0)
- const name = resultSet.getColumnName(1)
- const age = resultSet.getColumnName(2)
- ```
-
-
-### goTo
-
-goTo\(offset:number\): boolean
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | columnIndex | number | 是 | 表示结果集中指定列的索引。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | string | 返回指定列的名称。 |
+
+- 示例：
+ ```
+ const id = resultSet.getColumnName(0)
+ const name = resultSet.getColumnName(1)
+ const age = resultSet.getColumnName(2)
+ ```
+
+
+### goTo
+
+goTo(offset:number): boolean
向前或向后转至结果集的指定行，相对于其当前位置偏移。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- offset
- |
- number
- |
- 是
- |
- 表示相对于当前位置的偏移量。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- boolean
- |
- 如果成功移动结果集，则为true；否则返回false。
- |
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- let resultSet = await rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"])
- resultSet.goTo(1)
- resultSet.close()
- resultSet = null
- ```
-
-
-### goToRow
-
-goToRow\(position: number\): boolean
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | offset | number | 是 | 表示相对于当前位置的偏移量。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | boolean | 如果成功移动结果集，则为true；否则返回false。 |
+
+- 示例：
+ ```
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ let resultSet = await rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"])
+ resultSet.goTo(1)
+ resultSet.close()
+ resultSet = null
+ ```
+
+
+### goToRow
+
+goToRow(position: number): boolean
转到结果集的指定行。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- position
- |
- number
- |
- 是
- |
- 表示要移动到的指定位置。
- |
-
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- boolean
- |
- 如果成功移动结果集，则为true；否则返回false。
- |
-
-
-
-
-- 示例：
-
- ```
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- let resultSet = await rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"])
- resultSet.goToRow(1)
- resultSet.close()
- resultSet = null
- ```
-
-
-### goToFirstRow
-
-goToFirstRow\(\): boolean
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | position | number | 是 | 表示要移动到的指定位置。 |
-转到结果集的第一行。
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | boolean | 如果成功移动结果集，则为true；否则返回false。 |
-- 返回值：
+- 示例：
+ ```
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ let resultSet = await rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"])
+ resultSet.goToRow(1)
+ resultSet.close()
+ resultSet = null
+ ```
-
- 类型
- |
- 说明
- |
-
|---|
-
- boolean
- |
- 如果成功移动结果集，则为true；否则返回false。
- |
-
-
-
-- 示例：
+### goToFirstRow
- ```
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- let resultSet = await rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"])
- resultSet.goToFirstRow()
- resultSet.close()
- resultSet = null;
- ```
+goToFirstRow(): boolean
-### goToLastRow
+转到结果集的第一行。
-goToLastRow\(\): boolean
-转到结果集的最后一行。
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | boolean | 如果成功移动结果集，则为true；否则返回false。 |
+
+- 示例：
+ ```
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ let resultSet = await rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"])
+ resultSet.goToFirstRow()
+ resultSet.close()
+ resultSet = null;
+ ```
-- 返回值：
-
- 类型
- |
- 说明
- |
-
|---|
-
- boolean
- |
- 如果成功移动结果集，则为true；否则返回false。
- |
-
-
-
+### goToLastRow
-- 示例：
+goToLastRow(): boolean
- ```
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- let resultSet = await rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"])
- resultSet.goToLastRow()
- resultSet.close()
- resultSet = null;
- ```
+转到结果集的最后一行。
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | boolean | 如果成功移动结果集，则为true；否则返回false。 |
-### goToNextRow
+- 示例：
+ ```
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ let resultSet = await rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"])
+ resultSet.goToLastRow()
+ resultSet.close()
+ resultSet = null;
+ ```
-goToNextRow\(\): boolean
-转到结果集的下一行。
+### goToNextRow
-- 返回值：
+goToNextRow(): boolean
-
- 类型
- |
- 说明
- |
-
|---|
-
- boolean
- |
- 如果成功移动结果集，则为true；否则返回false。
- |
-
-
-
+转到结果集的下一行。
-- 示例：
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | boolean | 如果成功移动结果集，则为true；否则返回false。 |
- ```
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- let resultSet = await rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"])
- resultSet.goToNextRow()
- resultSet.close()
- resultSet = null;
- ```
+- 示例：
+ ```
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ let resultSet = await rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"])
+ resultSet.goToNextRow()
+ resultSet.close()
+ resultSet = null;
+ ```
-### goToPreviousRow
+### goToPreviousRow
-goToPreviousRow\(\): boolean
+goToPreviousRow(): boolean
转到结果集的上一行。
-- 返回值：
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | boolean | 如果成功移动结果集，则为true；否则返回false。 |
-
- 类型
- |
- 说明
- |
-
|---|
-
- boolean
- |
- 如果成功移动结果集，则为true；否则返回false。
- |
-
-
-
+- 示例：
+ ```
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ let resultSet = await rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"])
+ resultSet.goToPreviousRow()
+ resultSet.close()
+ resultSet = null
+ ```
-- 示例：
- ```
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- let resultSet = await rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"])
- resultSet.goToPreviousRow()
- resultSet.close()
- resultSet = null
- ```
+### getBlob
+getBlob(columnIndex: number): Uint8Array
-### getBlob
+以字节数组的形式获取当前行中指定列的值。
-getBlob\(columnIndex: number\): Uint8Array
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | columnIndex | number | 是 | 指定的列索引，从0开始。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Uint8Array | 以字节数组的形式返回指定列的值。 |
+
+- 示例：
+ ```
+ const codes = resultSet.getBlob(resultSet.getColumnIndex("CODES"))
+ ```
-以字节数组的形式获取当前行中指定列的值。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- columnIndex
- |
- number
- |
- 是
- |
- 指定的列索引，从0开始。
- |
-
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Uint8Array
- |
- 以字节数组的形式返回指定列的值。
- |
-
-
-
-
-- 示例：
-
- ```
- const codes = resultSet.getBlob(resultSet.getColumnIndex("CODES"))
- ```
-
-
-### getString
-
-getString\(columnIndex: number\): string
+### getString
+
+getString(columnIndex: number): string
以字符串形式获取当前行中指定列的值。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- columnIndex
- |
- number
- |
- 是
- |
- 指定的列索引，从0开始。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- string
- |
- 以字符串形式返回指定列的值。
- |
-
-
-
-
-- 示例：
-
- ```
- const name = resultSet.getString(resultSet.getColumnIndex("NAME"))
- ```
-
-
-### getLong
-
-getLong\(columnIndex: number\): number
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | columnIndex | number | 是 | 指定的列索引，从0开始。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | string | 以字符串形式返回指定列的值。 |
+
+- 示例：
+ ```
+ const name = resultSet.getString(resultSet.getColumnIndex("NAME"))
+ ```
+
+
+### getLong
+
+getLong(columnIndex: number): number
以Long形式获取当前行中指定列的值。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- columnIndex
- |
- number
- |
- 是
- |
- 指定的列索引，从0开始。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- number
- |
- 以Long形式返回指定列的值。
- |
-
-
-
-
-- 示例：
-
- ```
- const age = resultSet.getLong(resultSet.getColumnIndex("AGE"))
- ```
-
-
-### getDouble
-
-getDouble\(columnIndex: number\): number
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | columnIndex | number | 是 | 指定的列索引，从0开始。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | number | 以Long形式返回指定列的值。 |
+
+- 示例：
+ ```
+ const age = resultSet.getLong(resultSet.getColumnIndex("AGE"))
+ ```
+
+
+### getDouble
+
+getDouble(columnIndex: number): number
以double形式获取当前行中指定列的值。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- columnIndex
- |
- number
- |
- 是
- |
- 指定的列索引，从0开始。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- number
- |
- 以double形式返回指定列的值。
- |
-
-
-
-
-- 示例：
-
- ```
- const salary = resultSet.getDouble(resultSet.getColumnIndex("SALARY"))
- ```
-
-
-### isColumnNull
-
-isColumnNull\(columnIndex: number\): boolean
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | columnIndex | number | 是 | 指定的列索引，从0开始。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | number | 以double形式返回指定列的值。 |
+
+- 示例：
+ ```
+ const salary = resultSet.getDouble(resultSet.getColumnIndex("SALARY"))
+ ```
+
+
+### isColumnNull
+
+isColumnNull(columnIndex: number): boolean
检查当前行中指定列的值是否为null。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- columnIndex
- |
- number
- |
- 是
- |
- 指定的列索引，从0开始。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- boolean
- |
- 如果当前行中指定列的值为null，则返回true，否则返回false。
- |
-
-
-
-
-- 示例：
-
- ```
- const isColumnNull = resultSet.isColumnNull(resultSet.getColumnIndex("CODES"))
- ```
-
-
-### close
-
-close\(\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | columnIndex | number | 是 | 指定的列索引，从0开始。 |
-关闭结果集。
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | boolean | 如果当前行中指定列的值为null，则返回true，否则返回false。 |
+
+- 示例：
+ ```
+ const isColumnNull = resultSet.isColumnNull(resultSet.getColumnIndex("CODES"))
+ ```
-- 示例：
- ```
- let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
- let resultSet = await rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"])
- resultSet.close()
- resultSet = null
- ```
+### close
+
+close(): void
+
+关闭结果集。
+- 示例：
+ ```
+ let predicates = new dataRdb.RdbPredicates("EMPLOYEE")
+ let resultSet = await rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"])
+ resultSet.close()
+ resultSet = null
+ ```
diff --git a/zh-cn/application-dev/reference/apis/js-apis-data-storage.md b/zh-cn/application-dev/reference/apis/js-apis-data-storage.md
index 87a4530e6e5a34aaf813c021dfc7acdd1d2163c2..37f09d0cbf171c0ec304b5934d8be0c23ac3a91f 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-data-storage.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-data-storage.md
@@ -1,1523 +1,768 @@
-# 轻量级存储
+# 轻量级存储
轻量级存储为应用提供key-value键值型的文件数据处理能力，支持应用对数据进行轻量级存储及查询。数据存储形式为键值对，键的类型为字符串型，值的存储数据类型包括数字型、字符型、布尔型。
-> **说明：**
->从 API Version 6 开始支持。
-## 导入模块
+>  **说明：**
+> 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
+
+
+## 导入模块
```
-import dataStorage from '@ohos.data.storage';
+import dataStorage from '@ohos.data.storage'
```
-## 权限
+
+## 权限
无
-## 属性
-
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-MAX_KEY_LENGTH
- |
-string
- |
-是
- |
-否
- |
-key的最大长度限制，大小为80字节。
- |
-
-MAX_VALUE_LENGTH
- |
-string
- |
-是
- |
-否
- |
-string类型value的最大长度限制，大小为8192字节。
- |
-
-
-
-
-## dataStorage.getStorageSync
-
-getStorageSync\(path: string\): Storage
+
+## 属性
+
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| MAX_KEY_LENGTH | string | 是 | 否 | key的最大长度限制，大小为80字节。 |
+| MAX_VALUE_LENGTH | string | 是 | 否 | string类型value的最大长度限制，大小为8192字节。 |
+
+
+## dataStorage.getStorageSync
+
+getStorageSync(path: string): Storage
读取指定文件，将数据加载到Storage实例，用于数据操作，此方法为同步方法。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- path
- |
- string
- |
- 是
- |
- 应用程序内部数据存储路径。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Storage
- |
- 获取到要操作的Storage实例，用于进行数据存储操作。
- |
-
-
-
-
-- 示例：
-
- ```
- const PATH = '{storage_path_name_in_working_folder}';
- let store = dataStorage.getStorageSync(PATH);
- ```
-
-
-## dataStorage.getStorage
-
-getStorage\(path: string, callback: AsyncCallback\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | path | string | 是 | 应用程序内部数据存储路径。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [Storage](#storage) | 获取到要操作的Storage实例，用于进行数据存储操作。 |
+
+- 示例：
+ ```
+ import dataStorage from '@ohos.data.storage'
+ import featureAbility from '@ohos.ability.featureAbility'
+
+ var context = featureAbility.getContext()
+ var path = await context.getFilesDir()
+ let storage = dataStorage.getStorageSync(path + '/mystore')
+ storage.putSync('startup', 'auto')
+ storage.flushSync()
+ ```
+
+
+## dataStorage.getStorage
+
+getStorage(path: string, callback: AsyncCallback<Storage>): void
读取指定文件，将数据加载到Storage实例，用于数据操作，使用callback形式返回结果。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- path
- |
- string
- |
- 是
- |
- 应用程序内部数据存储路径。
- |
-
- callback
- |
- AsyncCallback<Storage>
- |
- 是
- |
- 回调函数。
- |
-
-
-
-
-- 示例：
-
- ```
- dataStorage.getStorage(PATH, function(err, data) {
- store = data;
- });
- ```
-
-
-## dataStorage.getStorage
-
-getStorage\(path: string\): Promise
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | path | string | 是 | 应用程序内部数据存储路径。 |
+ | callback | AsyncCallback<[Storage](#storage)> | 是 | 回调函数。 |
+
+- 示例：
+ ```
+ import dataStorage from '@ohos.data.storage'
+ import featureAbility from '@ohos.ability.featureAbility'
+
+ var context = featureAbility.getContext()
+ var path = await context.getFilesDir()
+ dataStorage.getStorage(path + '/mystore', function (err, storage) {
+ if (err) {
+ console.info("Get the storage failed, path: " + path + '/mystore')
+ return;
+ }
+ storage.putSync('startup', 'auto')
+ storage.flushSync()
+ })
+ ```
+
+
+## dataStorage.getStorage
+
+getStorage(path: string): Promise<Storage>
读取指定文件，将数据加载到Storage实例，用于数据操作，使用Promise方式作为异步方法。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- path
- |
- string
- |
- 是
- |
- 应用程序内部数据存储路径。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<Storage>
- |
- Promise实例，用于异步获取结果。
- |
-
-
-
-
-- 示例：
-
- ```
- const promise = dataStorage.getStorage(PATH);
- promise.then((data) => {
- data.clearSync();
- }).catch((err) => {
- });
- ```
-
-
-## dataStorage.deleteStorageSync
-
-deleteStorageSync\(path: string\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | path | string | 是 | 应用程序内部数据存储路径。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<[Storage](#storage)> | Promise实例，用于异步获取结果。 |
+
+- 示例：
+ ```
+ import dataStorage from '@ohos.data.storage'
+ import featureAbility from '@ohos.ability.featureAbility'
+
+ var context = featureAbility.getContext()
+ var path = await context.getFilesDir()
+ let promise = dataStorage.getStorage(path + '/mystore')
+ promise.then((storage) => {
+ storage.putSync('startup', 'auto')
+ storage.flushSync()
+ }).catch((err) => {
+ console.info("Get the storage failed, path: " + path + '/mystore')
+ })
+ ```
+
+
+## dataStorage.deleteStorageSync
+
+deleteStorageSync(path: string): void
从内存中移除指定文件对应的Storage单实例，并删除指定文件及其备份文件、损坏文件。删除指定文件时，应用不允许再使用该实例进行数据操作，否则会出现数据一致性问题，此方法为同步方法。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- path
- |
- string
- |
- 是
- |
- 应用程序内部数据存储路径。
- |
-
-
-
-
-- 示例：
-
- ```
- dataStorage.deleteStorageSync(PATH);
- ```
-
-
-## dataStorage.deleteStorage
-
-deleteStorage\(path: string, callback: AsyncCallback\)
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | path | string | 是 | 应用程序内部数据存储路径。 |
+
+- 示例：
+ ```
+ dataStorage.deleteStorageSync(path + '/mystore')
+ ```
+
+
+## dataStorage.deleteStorage
+
+deleteStorage(path: string, callback: AsyncCallback<void>)
从内存中移除指定文件对应的Storage单实例，并删除指定文件及其备份文件、损坏文件。删除指定文件时，应用不允许再使用该实例进行数据操作，否则会出现数据一致性问题，使用callback方式作为异步方法。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- path
- |
- string
- |
- 是
- |
- 应用程序内部数据存储路径。
- |
-
- callback
- |
- AsyncCallback<Storage>
- |
- 是
- |
- 回调函数。
- |
-
-
-
-
-- 示例：
-
- ```
- dataStorage.deleteStorage(PATH, function(err, data) {
- });
- ```
-
-
-## dataStorage.deleteStorage
-
-deleteStorage\(path: string\): Promise
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | path | string | 是 | 应用程序内部数据存储路径。 |
+ | callback | AsyncCallback<void> | 是 | 回调函数。 |
+
+- 示例：
+ ```
+ dataStorage.deleteStorage(path + '/mystore', function (err) {
+ if (err) {
+ console.info("Deleted failed with err: " + err)
+ return
+ }
+ console.info("Deleted successfully.")
+ })
+ ```
+
+
+## dataStorage.deleteStorage
+
+deleteStorage(path: string): Promise<void>
从内存中移除指定文件对应的Storage单实例，并删除指定文件及其备份文件、损坏文件。删除指定文件时，应用不允许再使用该实例进行数据操作，否则会出现数据一致性问题，使用promise方式作为异步方法。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- path
- |
- string
- |
- 是
- |
- 应用程序内部数据存储路径。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<void>
- |
- Promise实例，用于异步获取结果。
- |
-
-
-
-
-- 示例：
-
- ```
- const promise = dataStorage.deleteStorage(PATH);
- promise.then((data) => {
- }).catch((err) => {
- });
- ```
-
-
-## dataStorage.removeStorageFromCacheSync
-
-removeStorageFromCacheSync\(path: string\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | path | string | 是 | 应用程序内部数据存储路径。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<void> | Promise实例，用于异步获取结果。 |
+
+- 示例：
+ ```
+ let promise = dataStorage.deleteStorage(path + '/mystore')
+ promise.then(() => {
+ console.info("Deleted successfully.")
+ }).catch((err) => {
+ console.info("Deleted failed with err: " + err)
+ })
+ ```
+
+
+## dataStorage.removeStorageFromCacheSync
+
+removeStorageFromCacheSync(path: string): void
从内存中移除指定文件对应的Storage单实例。移除Storage单实例时，应用不允许再使用该实例进行数据操作，否则会出现数据一致性问题。
此方法为同步方法。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- path
- |
- string
- |
- 是
- |
- 应用程序内部数据存储路径。
- |
-
-
-
-
-- 示例：
-
- ```
- dataStorage.removeStorageFromCacheSync(PATH);
- ```
-
-
-## dataStorage.removeStorageFromCache
-
-removeStorageFromCache\(path: string, callback: AsyncCallback\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | path | string | 是 | 应用程序内部数据存储路径。 |
+
+- 示例：
+ ```
+ dataStorage.removeStorageFromCacheSync(path + '/mystore')
+ ```
+
+
+## dataStorage.removeStorageFromCache
+
+removeStorageFromCache(path: string, callback: AsyncCallback<Storage>): void
从内存中移除指定文件对应的Storage单实例。移除Storage单实例时，应用不允许再使用该实例进行数据操作，否则会出现数据一致性问题。
此方法为异步方法。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- path
- |
- string
- |
- 是
- |
- 应用程序内部数据存储路径。
- |
-
- callback
- |
- AsyncCallback<Storage>
- |
- 是
- |
- 回调函数。
- |
-
-
-
-
-- 示例：
-
- ```
- dataStorage.removeStorageFromCache(PATH, function(err, data) {
- });
- ```
-
-
-## dataStorage.removeStorageFromCache
-
-removeStorageFromCache\(path: string\): Promise
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | path | string | 是 | 应用程序内部数据存储路径。 |
+ | callback | AsyncCallback<[Storage](#storage)> | 是 | 回调函数。 |
+
+- 示例：
+ ```
+ dataStorage.removeStorageFromCache(path + '/mystore', function (err) {
+ if (err) {
+ console.info("Removed storage from cache failed with err: " + err)
+ return
+ }
+ console.info("Removed storage from cache successfully.")
+ })
+ ```
+
+
+## dataStorage.removeStorageFromCache
+
+removeStorageFromCache(path: string): Promise<void>
从内存中移除指定文件对应的Storage单实例。移除Storage单实例时，应用不允许再使用该实例进行数据操作，否则会出现数据一致性问题。
此方法为异步方法。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- path
- |
- string
- |
- 是
- |
- 应用程序内部数据存储路径。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<void>
- |
- Promise实例，用于异步获取结果。
- |
-
-
-
-
-- 示例：
-
- ```
- const promise = dataStorage.removeStorageFromCache(PATH);
- promise.then((data) => {
- }).catch((err) => {
- });
- ```
-
-
-## Storage
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | path | string | 是 | 应用程序内部数据存储路径。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<void> | Promise实例，用于异步获取结果。 |
+
+- 示例：
+ ```
+ let promise = dataStorage.removeStorageFromCache(path + '/mystore')
+ promise.then(() => {
+ console.info("Removed storage from cache successfully.")
+ }).catch((err) => {
+ console.info("Removed storage from cache failed with err: " + err)
+ })
+ ```
+
+
+## Storage
提供获取和修改存储数据的接口。
-### getSync
-getSync\(key: string, defValue: ValueType\): ValueType
+### getSync
+
+getSync(key: string, defValue: ValueType): ValueType
获取键对应的值，如果值为null或者非默认值类型，返回默认数据。
此方法为同步方法。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- key
- |
- string
- |
- 是
- |
- 要获取的存储key名称。它不能为空。
- |
-
- defValue
- |
- ValueType
- |
- 是
- |
- 给定key的存储不存在，则要返回的默认值。支持number、string、boolean。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- ValueType
- |
- 键对应的值，如果值为null或者非默认值类型，返回默认数据。
- |
-
-
-
-
-- 示例：
-
- ```
- let ret = store.getSync(key, 'defValue');
- ```
-
-
-### get
-
-get\(key: string, defValue: ValueType, callback: AsyncCallback\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | key | string | 是 | 要获取的存储key名称。它不能为空。 |
+ | defValue | ValueType | 是 | 给定key的存储不存在，则要返回的默认值。支持number、string、boolean。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | ValueType | 键对应的值，如果值为null或者非默认值类型，返回默认数据。 |
+
+- 示例：
+ ```
+ let value = storage.getSync('startup', 'default')
+ console.info("The value of startup is " + value)
+ ```
+
+
+### get
+
+get(key: string, defValue: ValueType, callback: AsyncCallback<ValueType>): void
获取键对应的值，如果值为null或者非默认值类型，返回默认数据。
此方法为异步方法。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- key
- |
- string
- |
- 是
- |
- 要获取的存储key名称。它不能为空。
- |
-
- defValue
- |
- ValueType
- |
- 是
- |
- 默认返回值。支持number、string、boolean。
- |
-
- callback
- |
- AsyncCallback<ValueType>
- |
- 是
- |
- 回调函数。
- |
-
-
-
-
-- 示例：
-
- ```
- store.get(key, 'test', function(err, data) {
- console.info(data);
- });
- ```
-
-
-### get
-
-get\(key: string, defValue: ValueType\): Promise
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | key | string | 是 | 要获取的存储key名称。它不能为空。 |
+ | defValue | ValueType | 是 | 默认返回值。支持number、string、boolean。 |
+ | callback | AsyncCallback<ValueType> | 是 | 回调函数。 |
+
+- 示例：
+ ```
+ storage.get('startup', 'default', function(err, value) {
+ if (err) {
+ console.info("Get the value of startup failed with err: " + err)
+ return
+ }
+ console.info("The value of startup is " + value)
+ })
+ ```
+
+
+### get
+
+get(key: string, defValue: ValueType): Promise<ValueType>
获取键对应的值，如果值为null或者非默认值类型，返默认数据。
此方法为异步方法。
-- **参数：**
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- key
- |
- string
- |
- 是
- |
- 要获取的存储key名称。它不能为空。
- |
-
- defValue
- |
- ValueType
- |
- 是
- |
- 默认返回值。支持number、string、boolean。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<ValueType>
- |
- Promise实例，用于异步获取结果。
- |
-
-
-
-
-- 示例：
-
- ```
- const promise = store.get(key, 'test');
- promise.then((data) => {
- console.info(data);
- }).catch((err) => {
- });
- ```
-
-
-### putSync
-
-putSync\(key: string, value: ValueType\): void
+- **参数：**
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | key | string | 是 | 要获取的存储key名称。它不能为空。 |
+ | defValue | ValueType | 是 | 默认返回值。支持number、string、boolean。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<ValueType> | Promise实例，用于异步获取结果。 |
+
+- 示例：
+ ```
+ let promise = storage.get('startup', 'default')
+ promise.then((value) => {
+ console.info("The value of startup is " + value)
+ }).catch((err) => {
+ console.info("Get the value of startup failed with err: " + err)
+ })
+ ```
+
+
+### putSync
+
+putSync(key: string, value: ValueType): void
首先获取指定文件对应的Storage实例，然后借助Storage API将数据写入Storage实例，通过flush或者flushSync将Storage实例持久化。
此方法为同步方法。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- key
- |
- string
- |
- 是
- |
- 要修改的存储的key。它不能为空。
- |
-
- value
- |
- ValueType
- |
- 是
- |
- 存储的新值。支持number、string、boolean。
- |
-
-
-
-
-- 示例：
-
- ```
- let data = store.putSync(key, 'defValue');
- ```
-
-
-### put
-
-put\(key: string, value: ValueType, callback: AsyncCallback\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | key | string | 是 | 要修改的存储的key。它不能为空。 |
+ | value | ValueType | 是 | 存储的新值。支持number、string、boolean。 |
+
+- 示例：
+ ```
+ storage.putSync('startup', 'auto')
+ ```
+
+
+### put
+
+put(key: string, value: ValueType, callback: AsyncCallback<void>): void
首先获取指定文件对应的Storage实例，然后借助Storage API将数据写入Storage实例，通过flush或者flushSync将Storage实例持久化。
此方法为异步方法。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- key
- |
- string
- |
- 是
- |
- 要修改的存储的key。它不能为空。
- |
-
- value
- |
- ValueType
- |
- 是
- |
- 存储的新值。支持number、string、boolean。
- |
-
- callback
- |
- AsyncCallback<void>
- |
- 是
- |
- 回调函数。
- |
-
-
-
-
-- 示例：
-
- ```
- store.put(key, 'test', function(err, data) {
- });
- ```
-
-
-### put
-
-put\(key: string, value: ValueType\): Promise
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | key | string | 是 | 要修改的存储的key。它不能为空。 |
+ | value | ValueType | 是 | 存储的新值。支持number、string、boolean。 |
+ | callback | AsyncCallback<void> | 是 | 回调函数。 |
+
+- 示例：
+ ```
+ storage.put('startup', 'auto', function (err) {
+ if (err) {
+ console.info("Put the value of startup failed with err: " + err)
+ return
+ }
+ console.info("Put the value of startup successfully.")
+ })
+ ```
+
+
+### put
+
+put(key: string, value: ValueType): Promise<void>
首先获取指定文件对应的Storage实例，然后借助Storage API将数据写入Storage实例，通过flush或者flushSync将Storage实例持久化。
此方法为异步方法。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- key
- |
- string
- |
- 是
- |
- 要修改的存储的key。它不能为空。
- |
-
- value
- |
- ValueType
- |
- 是
- |
- 存储的新值。支持number、string、boolean。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<void>
- |
- Promise实例，用于异步处理。
- |
-
-
-
-
-- 示例：
-
- ```
- const promise = store.put(key, 'test');
- promise.then((data) => {
- }).catch((err) => {
- });
- ```
-
-
-### hasSync
-
-hasSync\(key: string\): boolean
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | key | string | 是 | 要修改的存储的key。它不能为空。 |
+ | value | ValueType | 是 | 存储的新值。支持number、string、boolean。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<void> | Promise实例，用于异步处理。 |
+
+- 示例：
+ ```
+ let promise = storage.put('startup', 'auto')
+ promise.then(() => {
+ console.info("Put the value of startup successfully.")
+ }).catch((err) => {
+ console.info("Put the value of startup failed with err: " + err)
+ })
+ ```
+
+
+### hasSync
+
+hasSync(key: string): boolean
检查存储对象是否包含名为给定key的存储。
此方法为同步方法。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- key
- |
- string
- |
- 是
- |
- 要获取的存储key名称。它不能为空。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- boolean
- |
- true 表示存在，false表示不存在。
- |
-
-
-
-
-- 示例：
-
- ```
- let ret = store.hasSync(key);
- ```
-
-
-### has
-
-has\(key: string, callback: AsyncCallback\): boolean
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | key | string | 是 | 要获取的存储key名称。它不能为空。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | boolean | true 表示存在，false表示不存在。 |
+
+- 示例：
+ ```
+ let isExist = storage.hasSync('startup')
+ if (isExist) {
+ console.info("The key of startup is contained.")
+ }
+ ```
+
+
+### has
+
+has(key: string, callback: AsyncCallback<boolean>): boolean
检查存储对象是否包含名为给定key的存储。
此方法为异步方法。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- key
- |
- string
- |
- 是
- |
- 要获取的存储key名称，不能为空。
- |
-
- callback
- |
- AsyncCallback<boolean>
- |
- 是
- |
- 回调函数。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- boolean
- |
- true表示存在，false表示不存在。
- |
-
-
-
-
-- 示例：
-
- ```
- store.has(key, function(err, data) {
- console.info(data);
- });
- ```
-
-
-### has
-
-has\(key: string\): Promise
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | key | string | 是 | 要获取的存储key名称，不能为空。 |
+ | callback | AsyncCallback<boolean> | 是 | 回调函数。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | boolean | true表示存在，false表示不存在。 |
+
+- 示例：
+ ```
+ storage.has('startup', function (err, isExist) {
+ if (err) {
+ console.info("Check the key of startup failed with err: " + err)
+ return
+ }
+ if (isExist) {
+ console.info("The key of startup is contained.")
+ }
+ })
+ ```
+
+
+### has
+
+has(key: string): Promise<boolean>
检查存储对象是否包含名为给定key的存储。
此方法为异步方法。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- key
- |
- string
- |
- 是
- |
- 要获取的存储key名称。它不能为空。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<boolean>
- |
- Promise实例，用于异步处理。
- |
-
-
-
-
-- 示例：
-
- ```
- const promise = store.has(key);
- promise.then((data) => {
- console.info(data);
- }).catch((err) => {
- });
- ```
-
-
-### deleteSync
-
-deleteSync\(key: string\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | key | string | 是 | 要获取的存储key名称。它不能为空。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<boolean> | Promise实例，用于异步处理。 |
+
+- 示例：
+ ```
+ let promise = storage.has('startup')
+ promise.then((isExist) => {
+ if (isExist) {
+ console.info("The key of startup is contained.")
+ }
+ }).catch((err) => {
+ console.info("Check the key of startup failed with err: " + err)
+ })
+ ```
+
+
+### deleteSync
+
+deleteSync(key: string): void
从存储对象中删除名为给定key的存储。
此方法为同步方法。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- key
- |
- string
- |
- 是
- |
- 要获取的存储key名称。它不能为空。
- |
-
-
-
-
-- 示例：
-
- ```
- store.deleteSync(key);
- ```
-
-
-### delete
-
-delete\(key: string, callback: AsyncCallback\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | key | string | 是 | 要获取的存储key名称。它不能为空。 |
+
+- 示例：
+ ```
+ storage.deleteSync('startup')
+ ```
+
+
+### delete
+
+delete(key: string, callback: AsyncCallback<void>): void
从存储对象中删除名为给定key的存储。
此方法为异步方法。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- key
- |
- string
- |
- 是
- |
- 要获取的存储key名称，不能为空。
- |
-
- callback
- |
- AsyncCallback<void>
- |
- 是
- |
- 回调函数。
- |
-
-
-
-
-- 示例：
-
- ```
- store.delete(key, function(err, data) {
- });
- ```
-
-
-### delete
-
-delete\(key: string\): Promise
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | key | string | 是 | 要获取的存储key名称，不能为空。 |
+ | callback | AsyncCallback<void> | 是 | 回调函数。 |
+
+- 示例：
+ ```
+ storage.delete('startup', function (err) {
+ if (err) {
+ console.info("Delete startup key failed with err: " + err)
+ return
+ }
+ console.info("Deleted startup key successfully.")
+ })
+ ```
+
+
+### delete
+
+delete(key: string): Promise<void>
从存储对象删除名为给定key的存储。
此方法为异步方法。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- key
- |
- string
- |
- 是
- |
- 要获取的存储key名称。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<void>
- |
- Promise实例，用于异步处理。
- |
-
-
-
-
-- 示例：
-
- ```
- const promise = store.delete(key);
- promise.then((data) => {
- }).catch((err) => {
- });
- ```
-
-
-### flushSync
-
-flushSync\(\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | key | string | 是 | 要获取的存储key名称。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<void> | Promise实例，用于异步处理。 |
+
+- 示例：
+ ```
+ let promise = storage.delete('startup')
+ promise.then(() => {
+ console.info("Deleted startup key successfully.")
+ }).catch((err) => {
+ console.info("Delete startup key failed with err: " + err)
+ })
+ ```
+
+
+### flushSync
+
+flushSync(): void
将当前storage对象中的修改保存到当前的storage，并同步存储到文件中。
此方法为同步方法。
-- 示例：
-
- ```
- store.flushSync();
- ```
+- 示例：
+ ```
+ storage.flushSync()
+ ```
-### flush
+### flush
-flush\(callback: AsyncCallback\): void
+flush(callback: AsyncCallback<void>): void
将当前storage对象中的修改保存到当前的storage，并异步存储到文件中。
此方法为异步方法。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- callback
- |
- AsyncCallback<void>
- |
- 是
- |
- 回调函数。
- |
-
-
-
-
-- 示例：
-
- ```
- store.flush(function(err, data) {
- });
- ```
-
-
-### flush
-
-flush\(\): Promise
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | callback | AsyncCallback<void> | 是 | 回调函数。 |
-将当前storage对象中的修改保存到当前的storage，并异步存储到文件中。
+- 示例：
+ ```
+ storage.flush(function (err) {
+ if (err) {
+ console.info("Flush to file failed with err: " + err)
+ return
+ }
+ console.info("Flushed to file successfully.")
+ })
+ ```
-此方法为异步方法。
-- 返回值：
+### flush
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<void>
- |
- Promise实例，用于异步处理。
- |
-
-
-
+flush(): Promise<void>
-- 示例：
+将当前storage对象中的修改保存到当前的storage，并异步存储到文件中。
- ```
- const promise = store.flush();
- promise.then((data) => {
- }).catch((err) => {
- });
- ```
+此方法为异步方法。
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<void> | Promise实例，用于异步处理。 |
-### clearSync
+- 示例：
+ ```
+ let promise = storage.flush()
+ promise.then(() => {
+ console.info("Flushed to file successfully.")
+ }).catch((err) => {
+ console.info("Flush to file failed with err: " + err)
+ })
+ ```
-clearSync\(\): void
+
+### clearSync
+
+clearSync(): void
清除此存储对象中的所有存储。
此方法为同步方法。
-- 示例：
+- 示例：
+ ```
+ storage.clearSync()
+ ```
- ```
- store.clearSync();
- ```
+### clear
-### clear
-
-clear\(callback: AsyncCallback\): void
+clear(callback: AsyncCallback<void>): void
清除此存储对象中的所有存储。
此方法为异步方法。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- callback
- |
- AsyncCallback<void>
- |
- 是
- |
- 回调函数。
- |
-
-
-
-
-- 示例：
-
- ```
- store.clear(function(err, data) {
- });
- ```
-
-
-### clear
-
-clear\(\): Promise
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | callback | AsyncCallback<void> | 是 | 回调函数。 |
+
+- 示例：
+ ```
+ storage.clear(function (err) {
+ if (err) {
+ console.info("Clear to file failed with err: " + err)
+ return
+ }
+ console.info("Cleared to file successfully.")
+ })
+ ```
+
+
+### clear
+
+clear(): Promise<void>
清除此存储对象中的所有存储。
此方法为异步方法。
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<void>
- |
- Promise实例，用于异步处理。
- |
-
-
-
-
-- 示例：
-
- ```
- const promise = store.clear();
- promise.then((data) => {
- }).catch((err) => {
- });
- ```
-
-
-### on（'change'）
-
-on\(type: 'change', callback: Callback\): void
-
-监听者类需要实现StorageObserver接口，当数据发生改变时，监听者的 StorageObserver\#onChange会被回调。
-
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 说明
- |
-
|---|
-
- type
- |
- string
- |
- 事件类型，固定值'change'，表示数据变更。
- |
-
- callback
- |
- Callback<StorageObserver>
- |
- 需要监听的回调对象实例。
- |
-
-
-
-
-- 示例：
-
- ```
- var observer = function (data) {
- console.info(data);
- };
- store.on('change', observer);
- ```
-
-
-### off（'change'）
-
-off\(type: 'change', callback: Callback\): void
-
-监听者类需要实现StorageObserver接口，当不再进行数据监听时，使用此接口取消监听。
-
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 说明
- |
-
|---|
-
- type
- |
- string
- |
- 事件类型，固定值'change'，表示数据变更。
- |
-
- callback
- |
- Callback<StorageObserver>
- |
- 需要取消的回调对象实例。
- |
-
-
-
-
-- 示例：
-
- ```
- var observer = function (data) {
- console.info(data);
- };
- store.off('change', observer);
- ```
-
-
-## StorageObserver
-
-
-名称
- |
-参数类型
- |
-必填
- |
-说明
- |
-
|---|
-
-key
- |
-string
- |
-否
- |
-变更的数据内容。
- |
-
-
-
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<void> | Promise实例，用于异步处理。 |
+
+- 示例：
+ ```
+ let promise = storage.clear()
+ promise.then(() => {
+ console.info("Cleared to file successfully.")
+ }).catch((err) => {
+ console.info("Clear to file failed with err: " + err)
+ })
+ ```
+
+
+### on('change')
+
+on(type: 'change', callback: Callback<StorageObserver>): void
+
+订阅数据变更者类需要实现StorageObserver接口，订阅的key的值发生变更后，在执行flush/flushSync方法后，callback方法会被回调。
+
+- 参数：
+ | 参数名 | 类型 | 说明 |
+ | -------- | -------- | -------- |
+ | type | string | 事件类型，固定值'change'，表示数据变更。 |
+ | callback | Callback<[StorageObserver](#storageobserver)> | 回调对象实例。 |
+
+- 示例：
+ ```
+ var observer = function (key) {
+ console.info("The key of " + key + " changed.")
+ }
+ storage.on('change', observer)
+ storage.putSync('startup', 'auto')
+ storage.flushSync() // observer will be called.
+ ```
+
+
+### off('change')
+
+off(type: 'change', callback: Callback<StorageObserver>): void
+
+当不再进行订阅数据变更时，使用此接口取消订阅。
+
+- 参数：
+ | 参数名 | 类型 | 说明 |
+ | -------- | -------- | -------- |
+ | type | string | 事件类型，固定值'change'，表示数据变更。 |
+ | callback | Callback<[StorageObserver](#storageobserver)> | 需要取消的回调对象实例。 |
+
+- 示例：
+ ```
+ var observer = function (key) {
+ console.info("The key of " + key + " changed.")
+ }
+ storage.off('change', observer)
+ ```
+
+
+## StorageObserver
+| 名称 | 参数类型 | 必填 | 说明 |
+| -------- | -------- | -------- | -------- |
+| key | string | 否 | 变更的数据内容。 |
diff --git a/zh-cn/application-dev/reference/apis/js-apis-data.md b/zh-cn/application-dev/reference/apis/js-apis-data.md
index 5e4c1885631f653cca13e7a173d7489d2a6117b9..977343bc8587fce5200d1ac805cdca3ae6adc79e 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-data.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-data.md
@@ -1,15 +1,15 @@
-# 数据管理
+# 数据管理
-- **[文件管理](js-apis-fileio.md)**
-- **[轻量级存储](js-apis-data-storage.md)**
-- **[分布式数据管理](js-apis-distributed-data.md)**
+- **[文件管理](js-apis-fileio.md)**
-- **[关系型数据库](js-apis-data-rdb.md)**
+- **[轻量级存储](js-apis-data-storage.md)**
-- **[结果集](js-apis-data-resultset.md)**
+- **[分布式数据管理](js-apis-distributed-data.md)**
-- **[DataAbility 谓词](js-apis-data-ability.md)**
+- **[关系型数据库](js-apis-data-rdb.md)**
+- **[结果集](js-apis-data-resultset.md)**
+- **[DataAbility 谓词](js-apis-data-ability.md)**
\ No newline at end of file
diff --git a/zh-cn/application-dev/reference/apis/js-apis-device-info.md b/zh-cn/application-dev/reference/apis/js-apis-device-info.md
index 903f0fb6c007f118e49d11c82be516b95c37338b..0cf6c7b048bf627926aa36419937098031c8e5ca 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-device-info.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-device-info.md
@@ -1,350 +1,47 @@
-# 设备信息
+# 设备信息
-## 导入模块
+## 导入模块
```
import deviceInfo from '@ohos.deviceInfo'
```
-## 权限列表
+
+## 权限列表
无
-## 属性
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-描述
- |
-
|---|
-
-deviceType
- |
-string
- |
-是
- |
-否
- |
-设备类型。
- |
-
-manufacture
- |
-string
- |
-是
- |
-否
- |
-设备厂家名称。
- |
-
-brand
- |
-string
- |
-是
- |
-否
- |
-设备品牌名称。
- |
-
-marketName
- |
-string
- |
-是
- |
-否
- |
-外部产品系列。
- |
-
-productSeries
- |
-string
- |
-是
- |
-否
- |
-产品系列。
- |
-
-productModel
- |
-string
- |
-是
- |
-否
- |
-认证型号。
- |
-
-softwareModel
- |
-string
- |
-是
- |
-否
- |
-内部软件子型号。
- |
-
-hardwareModel
- |
-string
- |
-是
- |
-否
- |
-硬件版本号。
- |
-
-hardwareProfile
- |
-string
- |
-是
- |
-否
- |
-硬件Profile。
- |
-
-serial
- |
-string
- |
-是
- |
-否
- |
-设备序列号。
- |
-
-bootloaderVersion
- |
-string
- |
-是
- |
-否
- |
-Bootloader版本号。
- |
-
-abiList
- |
-string
- |
-是
- |
-否
- |
-应用二进制接口（Abi）列表。
- |
-
-securityPatchTag
- |
-string
- |
-是
- |
-否
- |
-安全补丁级别。
- |
-
-displayVersion
- |
-string
- |
-是
- |
-否
- |
-产品版本。
- |
-
-incrementalVersion
- |
-string
- |
-是
- |
-否
- |
-差异版本号。
- |
-
-osReleaseType
- |
-string
- |
-是
- |
-否
- |
-系统的发布类型，取值为：
-- Canary：面向特定开发者发布的早期预览版本，不承诺API稳定性。
- Beta：面向开发者公开发布的Beta版本，不承诺API稳定性。
- Release：面向开发者公开发布的正式版本，承诺API稳定性。
- |
-
-osFullName
- |
-string
- |
-是
- |
-否
- |
-系统版本。
- |
-
-majorVersion
- |
-number
- |
-是
- |
-否
- |
-Major版本号，随主版本更新增加。
- |
-
-seniorVersion
- |
-number
- |
-是
- |
-否
- |
-Senior版本号，随局部架构、重大特性增加。
- |
-
-featureVersion
- |
-number
- |
-是
- |
-否
- |
-Feature版本号，标识规划的新特性版本。
- |
-
-buildVersion
- |
-number
- |
-是
- |
-否
- |
-Build版本号，标识编译构建的版本号。
- |
-
-sdkApiVersion
- |
-number
- |
-是
- |
-否
- |
-系统软件API版本。
- |
-
-firstApiVersion
- |
-number
- |
-是
- |
-否
- |
-首个版本系统软件API版本。
- |
-
-versionId
- |
-string
- |
-是
- |
-否
- |
-版本ID。
- |
-
-buildType
- |
-string
- |
-是
- |
-否
- |
-构建类型。
- |
-
-buildUser
- |
-string
- |
-是
- |
-否
- |
-构建用户。
- |
-
-buildHost
- |
-string
- |
-是
- |
-否
- |
-构建主机。
- |
-
-buildTime
- |
-string
- |
-是
- |
-否
- |
-构建时间。
- |
-
-buildRootHash
- |
-string
- |
-是
- |
-否
- |
-构建版本Hash。
- |
-
-
-
+## 属性
+| 名称 | 参数类型 | 可读 | 可写 | 描述 |
+| -------- | -------- | -------- | -------- | -------- |
+| deviceType | string | 是 | 否 | 设备类型。 |
+| manufacture | string | 是 | 否 | 设备厂家名称。 |
+| brand | string | 是 | 否 | 设备品牌名称。 |
+| marketName | string | 是 | 否 | 外部产品系列。 |
+| productSeries | string | 是 | 否 | 产品系列。 |
+| productModel | string | 是 | 否 | 认证型号。 |
+| softwareModel | string | 是 | 否 | 内部软件子型号。 |
+| hardwareModel | string | 是 | 否 | 硬件版本号。 |
+| hardwareProfile | string | 是 | 否 | 硬件Profile。 |
+| serial | string | 是 | 否 | 设备序列号。 |
+| bootloaderVersion | string | 是 | 否 | Bootloader版本号。 |
+| abiList | string | 是 | 否 | 应用二进制接口（Abi）列表。 |
+| securityPatchTag | string | 是 | 否 | 安全补丁级别。 |
+| displayVersion | string | 是 | 否 | 产品版本。 |
+| incrementalVersion | string | 是 | 否 | 差异版本号。 |
+| osReleaseType | string | 是 | 否 | 系统的发布类型，取值为：
- Canary：面向特定开发者发布的早期预览版本，不承诺API稳定性。
- Beta：面向开发者公开发布的Beta版本，不承诺API稳定性。
- Release：面向开发者公开发布的正式版本，承诺API稳定性。 |
+| osFullName | string | 是 | 否 | 系统版本。 |
+| majorVersion | number | 是 | 否 | Major版本号，随主版本更新增加。 |
+| seniorVersion | number | 是 | 否 | Senior版本号，随局部架构、重大特性增加。 |
+| featureVersion | number | 是 | 否 | Feature版本号，标识规划的新特性版本。 |
+| buildVersion | number | 是 | 否 | Build版本号，标识编译构建的版本号。 |
+| sdkApiVersion | number | 是 | 否 | 系统软件API版本。 |
+| firstApiVersion | number | 是 | 否 | 首个版本系统软件API版本。 |
+| versionId | string | 是 | 否 | 版本ID。 |
+| buildType | string | 是 | 否 | 构建类型。 |
+| buildUser | string | 是 | 否 | 构建用户。 |
+| buildHost | string | 是 | 否 | 构建主机。 |
+| buildTime | string | 是 | 否 | 构建时间。 |
+| buildRootHash | string | 是 | 否 | 构建版本Hash。 |
diff --git a/zh-cn/application-dev/reference/apis/js-apis-device-manager.md b/zh-cn/application-dev/reference/apis/js-apis-device-manager.md
index 112f7bcb31c7e3d9da0f808791dd2d759325a6f8..eaac2ca81999080311d5761cfe12ab3653f21ecf 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-device-manager.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-device-manager.md
@@ -1,456 +1,189 @@
-# 设备管理
+# 设备管理
-> **说明：**
->从 API Version 7 开始支持。
+>  **说明：**
+> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
-## 导入模块
+
+## 导入模块
```
import deviceManager from '@ohos.distributedHardware.deviceManager';
```
-## deviceManager.createDeviceManager
-createDeviceManager\(bundleName: string, callback: AsyncCallback\): void
+## deviceManager.createDeviceManager
+
+createDeviceManager(bundleName: string, callback: AsyncCallback<DeviceManager>): void
创建一个设备管理器实例。
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | bundleName | string | 是 | 指示应用程序的包名。 |
+ | callback | AsyncCallback<[DeviceManager](#devicemanager)> | 是 | DeviceManager实例创建时调用的回调，返回设备管理器对象实例。 |
+
+- 示例：
+ ```
+ deviceManager.createDeviceManager("ohos.samples.jshelloworld", (err, data) => {
+ if (err) {
+ console.info("createDeviceManager err:" + JSON.stringify(err));
+ return;
+ }
+ console.info("createDeviceManager success");
+ this.dmInstance = data;
+ });
+ ```
+
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- bundleName
- |
- string
- |
- 是
- |
- 指示应用程序的包名。
- |
-
- callback
- |
- AsyncCallback<DeviceManager>
- |
- 是
- |
- DeviceManager实例创建时调用的回调，返回设备管理器对象实例。
- |
-
-
-
-
-- 示例：
-
- ```
- deviceManager.createDeviceManager("ohos.samples.jshelloworld", (err, data) => {
- if (err) {
- console.info("createDeviceManager err:" + JSON.stringify(err));
- return;
- }
- console.info("createDeviceManager success");
- this.dmInstance = data;
- });
- ```
-
-
-## DeviceStateChangeAction
+## DeviceStateChangeAction
表示设备状态变化的枚举。
-
-名称
- |
-默认值
- |
-说明
- |
-
|---|
-
-ONLINE
- |
-0
- |
-设备上线。
- |
-
-READY
- |
-1
- |
-设备就绪，设备信息同步已完成。
- |
-
-OFFLINE
- |
-2
- |
-设备下线。
- |
-
-CHANGE
- |
-3
- |
-设备信息更改。
- |
-
-
-
-
-## DeviceType
+| 名称 | 默认值 | 说明 |
+| -------- | -------- | -------- |
+| ONLINE | 0 | 设备上线。 |
+| READY | 1 | 设备就绪，设备信息同步已完成。 |
+| OFFLINE | 2 | 设备下线。 |
+| CHANGE | 3 | 设备信息更改。 |
+
+
+## DeviceType
表示设备类型的枚举类。
-
-名称
- |
-默认值
- |
-说明
- |
-
|---|
-
-SPEAKER
- |
-0x0A
- |
-智能音箱
- |
-
-PHONE
- |
-0x0E
- |
-手机
- |
-
-TABLET
- |
-0x11
- |
-平板
- |
-
-WEARABLE
- |
-0x6D
- |
-智能穿戴
- |
-
-TV
- |
-0x9C
- |
-智慧屏
- |
-
-
-
-
-## DeviceInfo
+| 名称 | 默认值 | 说明 |
+| -------- | -------- | -------- |
+| SPEAKER | 0x0A | 智能音箱 |
+| PHONE | 0x0E | 手机 |
+| TABLET | 0x11 | 平板 |
+| WEARABLE | 0x6D | 智能穿戴 |
+| TV | 0x9C | 智慧屏 |
+
+
+## DeviceInfo
设备信息。
-
-名称
- |
-类型
- |
-必填
- |
-描述
- |
-
|---|
-
-deviceId
- |
-number
- |
-是
- |
-设备的唯一标识。
- |
-
-deviceName
- |
-string
- |
-是
- |
-设备名称。
- |
-
-deviceType
- |
-number
- |
-是
- |
-设备类型。
- |
-
-
-
-
-## DeviceManager
+| 名称 | 类型 | 必填 | 描述 |
+| -------- | -------- | -------- | -------- |
+| deviceId | number | 是 | 设备的唯一标识。 |
+| deviceName | string | 是 | 设备名称。 |
+| deviceType | number | 是 | 设备类型。 |
+
+
+## DeviceManager
设备管理实例，用于获取可信设备和本地设备的相关信息。在调用DeviceManager的方法前，需要先通过createDeviceManager构建一个DeviceManager实例dmInstance。
-### release
-release\(\): void
+### release
-设备管理实例不再使用后，通过该方法释放DeviceManager实例。
+release(): void
-- 示例：
+设备管理实例不再使用后，通过该方法释放DeviceManager实例。
- ```
- dmInstance.release();
- ```
+- 示例：
+ ```
+ dmInstance.release();
+ ```
-### getTrustedDeviceListSync
+### getTrustedDeviceListSync
-getTrustedDeviceListSync\(\): Array
+getTrustedDeviceListSync(): Array<DeviceInfo>
同步获取所有可信设备列表。
-- 返回值：
+- 返回值：
+ | 名称 | 说明 |
+ | -------- | -------- |
+ | Array<[DeviceInfo](#deviceinfo)> | 返回可信设备列表。 |
+
+- 示例：
+ ```
+ var deviceInfoList = dmInstance.getTrustedDeviceListSync();
+ ```
-
- 名称
- |
- 说明
- |
-
|---|
-
- Array<DeviceInfo>
- |
- 返回可信设备列表。
- |
-
-
-
-- 示例：
+### on('deviceStateChange')
- ```
- var deviceInfoList = dmInstance.getTrustedDeviceListSync();
- ```
+on(type: 'deviceStateChange', callback: Callback<{ action: DeviceStateChangeAction, device: DeviceInfo }>): void
+注册设备状态回调。
+
+- 参数：
+ | 名称 | 参数类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | string | 是 | 注册设备状态回调，固定为deviceStateChange。 |
+ | callback | Callback<{ action: [DeviceStateChangeAction](#devicestatechangeaction), device: [DeviceInfo](#deviceinfo) }> | 是 | 指示要注册的设备状态回调，返回设备状态和设备信息。 |
-### on\('deviceStateChange'\)
+- 示例：
+ ```
+ dmInstance.on('deviceStateChange', (data) => {
+ console.info("deviceStateChange on:" + JSON.stringify(data));
+ }
+ );
+ ```
-on\(type: 'deviceStateChange', callback: Callback<\{ action: DeviceStateChangeAction, device: DeviceInfo \}\>\): void
-注册设备状态回调。
+### off('deviceStateChange')
-- 参数：
-
-
- 名称
- |
- 参数类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- type
- |
- string
- |
- 是
- |
- 注册设备状态回调，固定为deviceStateChange。
- |
-
- callback
- |
- Callback<{ action: DeviceStateChangeAction, device: DeviceInfo }>
- |
- 是
- |
- 指示要注册的设备状态回调，返回设备状态和设备信息。
- |
-
-
-
-
-
-- 示例：
-
- ```
- dmInstance.on('deviceStateChange', (data) => {
- console.info("deviceStateChange on:" + JSON.stringify(data));
- }
- );
- ```
-
-
-### off\('deviceStateChange'\)
-
-off\(type: 'deviceStateChange', callback?: Call back<\{ action: DeviceStateChangeAction, device: DeviceInfo \}\>\): void
+off(type: 'deviceStateChange', callback?: Call back<{ action: DeviceStateChangeAction, device: DeviceInfo }>): void
取消注册设备状态回调。
-- 参数：
-
-
- 名称
- |
- 参数类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- type
- |
- string
- |
- 是
- |
- 根据应用程序的包名取消注册设备状态回调。
- |
-
- callback
- |
- Callback<{ action: DeviceStateChangeAction, device: DeviceInfo }>
- |
- 是
- |
- 指示要取消注册的设备状态回调，返回设备状态和设备信息。
- |
-
-
-
-
-
-- 示例：
-
- ```
- dmInstance.off('deviceStateChange', (data) => {
- console.info('deviceStateChange' + JSON.stringify(data));
- }
- );
- ```
-
-
-### on\('serviceDie'\)
-
-on\(type: 'serviceDie', callback: \(\) =\> void\): void
+- 参数：
+ | 名称 | 参数类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | string | 是 | 根据应用程序的包名取消注册设备状态回调。 |
+ | callback | Callback<{ action: [DeviceStateChangeAction](#devicestatechangeaction), device: [DeviceInfo](#deviceinfo) }> | 是 | 指示要取消注册的设备状态回调，返回设备状态和设备信息。 |
+
+- 示例：
+ ```
+ dmInstance.off('deviceStateChange', (data) => {
+ console.info('deviceStateChange' + JSON.stringify(data));
+ }
+ );
+ ```
+
+
+### on('serviceDie')
+
+on(type: 'serviceDie', callback: () => void): void
注册设备管理服务死亡监听。
-- 参数：
-
-
- 名称
- |
- 参数类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- type
- |
- string
- |
- 是
- |
- 注册serviceDie回调，以便在devicemanager服务异常终止时通知应用程序。
- |
-
- callback
- |
- () => void
- |
- 是
- |
- 注册serviceDie的回调方法。
- |
-
-
-
-
-
-- 示例：
-
- ```
- dmInstance.on("serviceDie", () => {
- console.info("serviceDie on");
- }
- );
- ```
-
-
-### off\('serviceDie'\)
-
-off\(type: 'serviceDie', callback?: \(\) =\> void\): void
+- 参数：
+ | 名称 | 参数类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | string | 是 | 注册serviceDie回调，以便在devicemanager服务异常终止时通知应用程序。 |
+ | callback | () => void | 是 | 注册serviceDie的回调方法。 |
-取消注册设备管理服务死亡监听。
+- 示例：
+ ```
+ dmInstance.on("serviceDie", () => {
+ console.info("serviceDie on");
+ }
+ );
+ ```
-- 参数：
-
-
- 名称
- |
- 参数类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- type
- |
- string
- |
- 是
- |
- 取消注册serviceDie回调，以便在devicemanager服务异常终止时通知应用程序。
- |
-
- callback
- |
- () => void
- |
- 否
- |
- 取消注册serviceDie的回调方法。
- |
-
-
-
-
-
-- 示例：
-
- ```
- dmInstance.off("serviceDie", () => {
- console.info("serviceDie off");
- }
- );
- ```
+### off('serviceDie')
+
+off(type: 'serviceDie', callback?: () => void): void
+
+取消注册设备管理服务死亡监听。
+- 参数：
+ | 名称 | 参数类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | string | 是 | 取消注册serviceDie回调，以便在devicemanager服务异常终止时通知应用程序。 |
+ | callback | () => void | 否 | 取消注册serviceDie的回调方法。 |
+
+- 示例：
+ ```
+ dmInstance.off("serviceDie", () => {
+ console.info("serviceDie off");
+ }
+ );
+ ```
diff --git a/zh-cn/application-dev/reference/apis/js-apis-device-mgmt.md b/zh-cn/application-dev/reference/apis/js-apis-device-mgmt.md
index 16f4269b762a677cae9013123398641b12aa9dcc..c0db6aae2f1412eded00f9c564440163297c3fee 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-device-mgmt.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-device-mgmt.md
@@ -1,14 +1,25 @@
-# 设备管理
-
-- **[传感器](js-apis-sensor.md)**
-- **[振动](js-apis-vibrator.md)**
-- **[屏幕亮度](js-apis-brightness.md)**
-- **[电量信息](js-apis-battery-info.md)**
-- **[系统电源管理](js-apis-power.md)**
-- **[Runninglock锁](js-apis-runninglock.md)**
-- **[设备信息](js-apis-device-info.md)**
-- **[系统属性](js-apis-system-parameter.md)**
-- **[设备管理](js-apis-device-manager.md)**
-- **[显示设备属性](js-apis-display.md)**
-- **[升级](js-apis-libupdateclient.md)**
+# 设备管理
+
+
+- **[传感器](js-apis-sensor.md)**
+
+- **[振动](js-apis-vibrator.md)**
+
+- **[屏幕亮度(新)](js-apis-brightness.md)**
+
+- **[电量信息(新)](js-apis-battery-info.md)**
+
+- **[系统电源管理](js-apis-power.md)**
+
+- **[Runninglock锁](js-apis-runninglock.md)**
+
+- **[设备信息](js-apis-device-info.md)**
+
+- **[系统属性](js-apis-system-parameter.md)**
+
+- **[设备管理](js-apis-device-manager.md)**
+
+- **[窗口](js-apis-window.md)**
+
+- **[显示设备属性](js-apis-display.md)**
\ No newline at end of file
diff --git a/zh-cn/application-dev/reference/apis/js-apis-display.md b/zh-cn/application-dev/reference/apis/js-apis-display.md
index c4f999a68f2e82ff287c24e194c92d853375b1c9..180f23fa704b43a358514a0fe46a5f3f863e3073 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-display.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-display.md
@@ -1,436 +1,144 @@
-# 显示设备属性
+# 显示设备属性
-> **说明：**
->从 API Version 7 开始支持。
+>  **说明：**
+> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
-## 导入模块
+
+## 导入模块
```
import display from '@ohos.display';
```
-## 权限列表
+
+## 权限列表
无
-## DisplayState
+
+## DisplayState
用于表示显示设备的状态。
-
-名称
- |
-默认值
- |
-说明
- |
-
|---|
-
-STATE_UNKNOWN
- |
-0
- |
-表示显示设备状态未知。
- |
-
-STATE_OFF
- |
-1
- |
-表示显示设备状态为关闭。
- |
-
-STATE_ON
- |
-2
- |
-表示显示设备状态为开启。
- |
-
-STATE_DOZE
- |
-3
- |
-表示显示设备为低电耗模式。
- |
-
-STATE_DOZE_SUSPEND
- |
-4
- |
-表示显示设备为睡眠模式，CPU为挂起状态 。
- |
-
-STATE_VR
- |
-5
- |
-表示显示设备为VR模式。
- |
-
-STATE_ON_SUSPEND
- |
-6
- |
-表示显示设备为开启状态，CPU为挂起状态。
- |
-
-
-
-
-## Display
+| 名称 | 默认值 | 说明 |
+| -------- | -------- | -------- |
+| STATE_UNKNOWN | 0 | 表示显示设备状态未知。 |
+| STATE_OFF | 1 | 表示显示设备状态为关闭。 |
+| STATE_ON | 2 | 表示显示设备状态为开启。 |
+| STATE_DOZE | 3 | 表示显示设备为低电耗模式。 |
+| STATE_DOZE_SUSPEND | 4 | 表示显示设备为睡眠模式，CPU为挂起状态 。 |
+| STATE_VR | 5 | 表示显示设备为VR模式。 |
+| STATE_ON_SUSPEND | 6 | 表示显示设备为开启状态，CPU为挂起状态。 |
+
+
+## Display
描述display对象的属性。
-### 属性
-
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-id
- |
-number
- |
-是
- |
-否
- |
-显示设备的id号。
- |
-
-name
- |
-string
- |
-是
- |
-否
- |
-显示设备的名称。
- |
-
-alive
- |
-boolean
- |
-是
- |
-否
- |
-显示设备是否启用。
- |
-
-state
- |
-DisplayState
- |
-是
- |
-否
- |
-显示设备的状态。
- |
-
-refreshRate
- |
-number
- |
-是
- |
-否
- |
-显示设备的刷新率。
- |
-
-rotation
- |
-number
- |
-是
- |
-否
- |
-显示设备的屏幕旋转角度。
- |
-
-width
- |
-number
- |
-是
- |
-否
- |
-显示设备的宽度，单位为像素。
- |
-
-height
- |
-number
- |
-是
- |
-否
- |
-显示设备的高度，单位为像素。
- |
-
-densityDPI
- |
-number
- |
-是
- |
-否
- |
-显示设备的屏幕密度，单位为DPI。
- |
-
-densityPixels
- |
-number
- |
-是
- |
-否
- |
-显示设备的屏幕密度，单位为像素。
- |
-
-scaledDensity
- |
-number
- |
-是
- |
-否
- |
-显示设备的显示字体的缩放因子。
- |
-
-xDPI
- |
-number
- |
-是
- |
-否
- |
-x方向中每英寸屏幕的确切物理像素值。
- |
-
-yDPI
- |
-number
- |
-是
- |
-否
- |
-y方向中每英寸屏幕的确切物理像素值。
- |
-
-
-
-
-## display.getDefaultDisplay
-
-getDefaultDisplay\(callback: AsyncCallback\): void;
+
+### 属性
+
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| id | number | 是 | 否 | 显示设备的id号。 |
+| name | string | 是 | 否 | 显示设备的名称。 |
+| alive | boolean | 是 | 否 | 显示设备是否启用。 |
+| state | [DisplayState](#displaystate) | 是 | 否 | 显示设备的状态。 |
+| refreshRate | number | 是 | 否 | 显示设备的刷新率。 |
+| rotation | number | 是 | 否 | 显示设备的屏幕旋转角度。 |
+| width | number | 是 | 否 | 显示设备的宽度，单位为像素。 |
+| height | number | 是 | 否 | 显示设备的高度，单位为像素。 |
+| densityDPI | number | 是 | 否 | 显示设备的屏幕密度，单位为DPI。 |
+| densityPixels | number | 是 | 否 | 显示设备的屏幕密度，单位为像素。 |
+| scaledDensity | number | 是 | 否 | 显示设备的显示字体的缩放因子。 |
+| xDPI | number | 是 | 否 | x方向中每英寸屏幕的确切物理像素值。 |
+| yDPI | number | 是 | 否 | y方向中每英寸屏幕的确切物理像素值。 |
+
+
+## display.getDefaultDisplay
+
+getDefaultDisplay(callback: AsyncCallback<Display>): void;
获取当前默认的display对象。
-- 参数
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- callback
- |
- AsyncCallback<Display>
- |
- 是
- |
- 回调返回显示设备的属性。
- |
-
-
-
-
-- 示例
-
- ```
- var displayClass = null;
- display.getDefaultDisplay((err, data) => {
- if (err) {
- console.error('Failed to obtain the default display object. Code: ' + JSON.stringify(err));
- return;
- }
- console.info('Succeeded in obtaining the default display object. Data:' + JSON.stringify(data));
- displayClass = data;
- });
- ```
-
-
-## display.getAllDisplay
-
-getAllDisplay\(callback: AsyncCallback\>\): void;
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | callback | AsyncCallback<[Display](#display)> | 是 | 回调返回显示设备的属性。 |
+
+- 示例
+ ```
+ var displayClass = null;
+ display.getDefaultDisplay((err, data) => {
+ if (err) {
+ console.error('Failed to obtain the default display object. Code: ' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in obtaining the default display object. Data:' + JSON.stringify(data));
+ displayClass = data;
+ });
+ ```
+
+
+## display.getAllDisplay
+
+getAllDisplay(callback: AsyncCallback<Array<Display>>): void;
获取当前所有的display对象。
-- 参数
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- callback
- |
- AsyncCallback<Array<Display>>
- |
- 是
- |
- 回调返回多个显示设备的属性。
- |
-
-
-
-
-- 示例
-
- ```
- display.getAllDisplay((err, data) => {
- if (err) {
- console.error('Failed to obtain all the display objects. Code: ' + JSON.stringify(err));
- return;
- }
- console.info('Succeeded in obtaining all the display objects. Data: ' + JSON.stringify(data))
- });
- ```
-
-
-## display.on\('add'|'remove'|'change'\)
-
-on\(type: 'add'|'remove'|'change', callback: Callback\): void;
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | callback | AsyncCallback<Array<[Display](#display)>> | 是 | 回调返回多个显示设备的属性。 |
+
+- 示例
+ ```
+ display.getAllDisplay((err, data) => {
+ if (err) {
+ console.error('Failed to obtain all the display objects. Code: ' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in obtaining all the display objects. Data: ' + JSON.stringify(data))
+ });
+ ```
+
+
+## display.on('add'|'remove'|'change')
+
+on(type: 'add'|'remove'|'change', callback: Callback<number>): void;
开启监听。
-- 参数
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- type
- |
- string
- |
- 是
- |
- 设置监听类型。
- - type为"add"，表示监听增加显示设备。
- type为"remove"，表示监听移除显示设备。
- type为"change"，表示监听改变显示设备。
- |
-
- callback
- |
- Callback<number>
- |
- 是
- |
- 回调返回监听到的显示设备的id。
- |
-
-
-
-
-- 示例
-
- ```
- var type = "add";
- var callback = (data) => {
- console.info('Listening enabled. Data: ' + JSON.stringify(data))
- }
- display.on(type, callback);
- ```
-
-
-## display.off\('add'|'remove'|'change'\)
-
-off\(type: 'add'|'remove'|'change', callback?: Callback\): void;
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | string | 是 | 设置监听类型。
- type为"add"，表示监听增加显示设备。
- type为"remove"，表示监听移除显示设备。
- type为"change"，表示监听改变显示设备。 |
+ | callback | Callback<number> | 是 | 回调返回监听到的显示设备的id。 |
+
+- 示例
+ ```
+ var type = "add";
+ var callback = (data) => {
+ console.info('Listening enabled. Data: ' + JSON.stringify(data))
+ }
+ display.on(type, callback);
+ ```
-关闭监听。
-- 参数
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- type
- |
- string
- |
- 是
- |
- 设置监听类型。
- - type为"add"，表示监听增加显示设备。
- type为"remove"，表示监听移除显示设备。
- type为"change"，表示监听改变显示设备。
- |
-
- callback
- |
- Callback<number>
- |
- 否
- |
- 回调返回监听到的显示设备的id。
- |
-
-
-
-
-- 示例
-
- ```
- var type = "remove";
- display.off(type);
- ```
+## display.off('add'|'remove'|'change')
+off(type: 'add'|'remove'|'change', callback?: Callback<number>): void;
+
+关闭监听。
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | string | 是 | 设置监听类型。
- type为"add"，表示监听增加显示设备。
- type为"remove"，表示监听移除显示设备。
- type为"change"，表示监听改变显示设备。 |
+ | callback | Callback<number> | 否 | 回调返回监听到的显示设备的id。 |
+
+- 示例
+ ```
+ var type = "remove";
+ display.off(type);
+ ```
diff --git a/zh-cn/application-dev/reference/apis/js-apis-distributed-account.md b/zh-cn/application-dev/reference/apis/js-apis-distributed-account.md
index 72d981af6130df5fe707c88b94519da023449e20..e61397cf8b0820b160081327b319b3ca18ea93a5 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-distributed-account.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-distributed-account.md
@@ -1,300 +1,144 @@
-# 分布式帐号管理
+# 分布式帐号管理
-> **说明：**
->从API Version 7 开始支持。
+>  **说明：**
+> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
-## 导入模块
+
+## 导入模块
```
import account_distributedAccount from '@ohos.account.distributedAccount';
```
-## account\_distributedAccount.getDistributedAccountAbility
-getDistributedAccountAbility\(\): DistributedAccountAbility
+## account_distributedAccount.getDistributedAccountAbility
+
+getDistributedAccountAbility(): DistributedAccountAbility
获取分布式帐号单实例对象。
-- 返回值：
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [DistributedAccountAbility](#distributedaccountability) | 返回一个实例，实例提供查询和更新分布式帐号登录状态方法。 |
-
-
+- 示例：
+ ```
+ const accountAbility = account_distributedAccount.getDistributedAccountAbility();
+ ```
-- 示例：
+## DistributedAccountAbility
- ```
- const accountAbility = account_distributedAccount.getDistributedAccountAbility();
- ```
+提供查询和更新分布式帐号登录状态方法(需要先获取分布式帐号的单实例对象)。
+### queryOsAccountDistributedInfo
-## DistributedAccountAbility
+queryOsAccountDistributedInfo(callback: AsyncCallback<DistributedInfo>): void
-提供查询和更新分布式帐号登录状态方法\(需要先获取分布式帐号的单实例对象\)。
+获取分布式帐号信息，使用callback回调异步返回结果。
-### queryOsAccountDistributedInfo
+需要权限：ohos.permission.MANAGE_LOCAL_ACCOUNTS，该权限仅供系统应用使用。
-queryOsAccountDistributedInfo\(callback: AsyncCallback\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | callback | AsyncCallback<[DistributedInfo](#distributedinfo)> | 是 | 获取分布式帐号信息的回调。 |
-获取分布式帐号信息，使用callback回调异步返回结果。
+- 示例：
+ ```
+ const accountAbility = account_distributedAccount.getDistributedAccountAbility();
+ accountAbility.queryOsAccountDistributedInfo((err, data) => {
+ console.log("queryOsAccountDistributedInfo err: " + JSON.stringify(err));
+ console.log('Query account info name: ' + data.name);
+ console.log('Query account info id: ' + data.id);
+ });
+ ```
-需要权限：ohos.permission.MANAGE\_LOCAL\_ACCOUNTS，该权限仅供系统应用使用。
-
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- callback
- |
- AsyncCallback<DistributedInfo>
- |
- 是
- |
- 获取分布式帐号信息的回调。
- |
-
-
-
-
-- 示例：
-
- ```
- const accountAbility = account_distributedAccount.getDistributedAccountAbility();
- accountAbility.queryOsAccountDistributedInfo((err, data) => {
- console.log("queryOsAccountDistributedInfo err: " + JSON.stringify(err));
- console.log('Query account info name: ' + data.name);
- console.log('Query account info id: ' + data.id);
- });
- ```
-
-
-### queryOsAccountDistributedInfo
-
-queryOsAccountDistributedInfo\(\): Promise
+### queryOsAccountDistributedInfo
+
+queryOsAccountDistributedInfo(): Promise<DistributedInfo>
获取分布式帐号信息，使用Promise方式异步返回结果。
-需要权限：ohos.permission.MANAGE\_LOCAL\_ACCOUNTS，该权限仅供系统应用使用。
+需要权限：ohos.permission.MANAGE_LOCAL_ACCOUNTS，该权限仅供系统应用使用。
-- 返回值：
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<[DistributedInfo](#distributedinfo)> | Promise实例，用于获取异步返回结果。 |
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<DistributedInfo>
- |
- Promise实例，用于获取异步返回结果。
- |
-
-
-
+- 示例：
+ ```
+ const accountAbility = account_distributedAccount.getDistributedAccountAbility();
+ accountAbility.queryOsAccountDistributedInfo().then((data) => {
+ console.log('Query account info name: ' + data.name);
+ console.log('Query account info id: ' + data.id);
+ }).catch((err) => {
+ console.log("queryOsAccountDistributedInfoerr: " + JSON.stringify(err));
+ });
+ ```
-- 示例：
+### updateOsAccountDistributedInfo
- ```
- const accountAbility = account_distributedAccount.getDistributedAccountAbility();
- accountAbility.queryOsAccountDistributedInfo().then((data) => {
- console.log('Query account info name: ' + data.name);
- console.log('Query account info id: ' + data.id);
- }).catch((err) => {
- console.log("queryOsAccountDistributedInfoerr: " + JSON.stringify(err));
- });
- ```
+updateOsAccountDistributedInfo(accountInfo: DistributedInfo, callback: AsyncCallback<void>): void
+更新分布式帐号信息，使用callback回调异步返回结果。
-### updateOsAccountDistributedInfo
+需要权限：ohos.permission.MANAGE_LOCAL_ACCOUNTS，该权限仅供系统应用使用。
-updateOsAccountDistributedInfo\(accountInfo: DistributedInfo, callback: AsyncCallback\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | accountInfo | [DistributedInfo](#distributedinfo) | 是 | 分布式帐号信息。 |
+ | callback | AsyncCallback<void> | 是 | 更新分布式帐号信息的回调。 |
-更新分布式帐号信息，使用callback回调异步返回结果。
+- 示例：
+ ```
+ const accountAbility = account_distributedAccount.getDistributedAccountAbility();
+ let accountInfo = {id: '12345', name: 'ZhangSan', event: 'Ohos.account.event.LOGIN'};
+ accountAbility.updateOsAccountDistributedInfo(accountInfo, (err) => {
+ console.log("queryOsAccountDistributedInfo err: " + JSON.stringify(err));
+ });
+ ```
-需要权限：ohos.permission.MANAGE\_LOCAL\_ACCOUNTS，该权限仅供系统应用使用。
-
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- accountInfo
- |
- DistributedInfo
- |
- 是
- |
- 分布式帐号信息。
- |
-
- callback
- |
- AsyncCallback<void>
- |
- 是
- |
- 更新分布式帐号信息的回调。
- |
-
-
-
-
-- 示例：
-
- ```
- const accountAbility = account_distributedAccount.getDistributedAccountAbility();
- let accountInfo = {id: '12345', name: 'ZhangSan', event: 'Ohos.account.event.LOGIN'};
- accountAbility.updateOsAccountDistributedInfo(accountInfo, (err) => {
- console.log("queryOsAccountDistributedInfo err: " + JSON.stringify(err));
- });
- ```
-
-
-### updateOsAccountDistributedInfo
-
-updateOsAccountDistributedInfo\(accountInfo: DistributedInfo\): Promise
+### updateOsAccountDistributedInfo
+
+updateOsAccountDistributedInfo(accountInfo: DistributedInfo): Promise<void>
更新分布式帐号信息，使用Promise方式异步返回结果。
-需要权限：ohos.permission.MANAGE\_LOCAL\_ACCOUNTS，该权限仅供系统应用使用。
-
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- accountInfo
- |
- DistributedInfo
- |
- 是
- |
- 分布式帐户信息。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<void>
- |
- Promise实例，用于获取异步返回结果。
- |
-
-
-
-
-- 示例：
-
- ```
- const accountAbility = account_distributedAccount.getDistributedAccountAbility();
- let accountInfo = {id: '12345', name: 'ZhangSan', event: 'Ohos.account.event.LOGIN'};
- accountAbility.updateOsAccountDistributedInfo(accountInfo).then(() => {
- console.log('updateOsAccountDistributedInfo Success');
- }).catch((err) => {
- console.log("updateOsAccountDistributedInfo err: " + JSON.stringify(err));
- });
- ```
-
-
-## DistributedInfo
+需要权限：ohos.permission.MANAGE_LOCAL_ACCOUNTS，该权限仅供系统应用使用。
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | accountInfo | [DistributedInfo](#distributedinfo) | 是 | 分布式帐户信息。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<void> | Promise实例，用于获取异步返回结果。 |
+
+- 示例：
+ ```
+ const accountAbility = account_distributedAccount.getDistributedAccountAbility();
+ let accountInfo = {id: '12345', name: 'ZhangSan', event: 'Ohos.account.event.LOGIN'};
+ accountAbility.updateOsAccountDistributedInfo(accountInfo).then(() => {
+ console.log('updateOsAccountDistributedInfo Success');
+ }).catch((err) => {
+ console.log("updateOsAccountDistributedInfo err: " + JSON.stringify(err));
+ });
+ ```
+
+
+## DistributedInfo
提供操作系统帐户的分布式信息。
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-name
- |
-string
- |
-是
- |
-分布式帐号名称，非空字符串。
- |
-
-id
- |
-string
- |
-是
- |
-分布式帐号UID，非空字符串。
- |
-
-event
- |
-string
- |
-是
- |
-分布式帐号登录状态，包括登录、登出、Token失效和注销，分别对应以下字符串：
-- Ohos.account.event.LOGIN
- Ohos.account.event.LOGOUT
- Ohos.account.event.TOKEN_INVALID
- Ohos.account.event.LOGOFF
- |
-
-scalableData
- |
-object
- |
-否
- |
-分布式帐号扩展信息，根据业务所需，以k-v形式传递定制化信息。
-说明：该参数是预留的可选项，目前查询和更新的方法实现中未使用。
- |
-
-
-
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | -------- | -------- | -------- |
+| name | string | 是 | 分布式帐号名称，非空字符串。 |
+| id | string | 是 | 分布式帐号UID，非空字符串。 |
+| event | string | 是 | 分布式帐号登录状态，包括登录、登出、Token失效和注销，分别对应以下字符串：
- Ohos.account.event.LOGIN
- Ohos.account.event.LOGOUT
- Ohos.account.event.TOKEN_INVALID
- Ohos.account.event.LOGOFF |
+| scalableData | object | 否 | 分布式帐号扩展信息，根据业务所需，以k-v形式传递定制化信息。
说明：该参数是预留的可选项，目前查询和更新的方法实现中未使用。 |
diff --git a/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md b/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md
index bec049e62e9c45de62728d3819bd459b8fb0c945..76c59c43b8992ed7271d6f26475e7f365cfa0836 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md
@@ -1,1490 +1,611 @@
-# 分布式数据管理
+# 分布式数据管理
-> **说明：**
->从 API Version 7 开始支持。
+>  **说明：**
+> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
-## 导入模块
+
+## 导入模块
```
import distributedData from '@ohos.data.distributedData';
```
-## 权限
+
+## 权限
无
-## distributedData.createKVManager
-createKVManager\(config: KVManagerConfig, callback: AsyncCallback\): void
+## distributedData.createKVManager
+
+createKVManager(config: KVManagerConfig, callback: AsyncCallback<KVManager>): void
创建一个KVManager对象实例，用于管理数据库对象，并通过callback方式返回，此方法为异步方法。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- config
- |
- KVManagerConfig
- |
- 是
- |
- 提供KVManager实例的配置信息，包括调用方的包名和用户信息。
- |
-
- callback
- |
- AsyncCallback<KVManager>
- |
- 是
- |
- KVManager实例创建时调用的回调，返回KVManager对象实例。
- |
-
-
-
-
-- 示例：
-
- ```
- let kvManager;
- try {
- const kvManagerConfig = {
- bundleName : 'com.example.datamanagertest',
- userInfo : {
- userId : '0',
- userType : 0
- }
- }
- distributedData.createKVManager(kvManagerConfig, function (err, manager) {
- if (err) {
- console.log("createKVManager err: " + JSON.stringify(err));
- return;
- }
- console.log("createKVManager success");
- kvManager = manager;
- });
- } catch (e) {
- console.log("An unexpected error occurred. Error:" + e);
- }
- ```
-
-
-## distributedData.createKVManager
-
-createKVManager\(config: KVManagerConfig\): Promise
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | config | [KVManagerConfig](#kvmanagerconfig) | 是 | 提供KVManager实例的配置信息，包括调用方的包名和用户信息。 |
+ | callback | AsyncCallback<[KVManager](#kvmanager)> | 是 | KVManager实例创建时调用的回调，返回KVManager对象实例。 |
+
+- 示例：
+ ```
+ let kvManager;
+ try {
+ const kvManagerConfig = {
+ bundleName : 'com.example.datamanagertest',
+ userInfo : {
+ userId : '0',
+ userType : 0
+ }
+ }
+ distributedData.createKVManager(kvManagerConfig, function (err, manager) {
+ if (err) {
+ console.log("createKVManager err: " + JSON.stringify(err));
+ return;
+ }
+ console.log("createKVManager success");
+ kvManager = manager;
+ });
+ } catch (e) {
+ console.log("An unexpected error occurred. Error:" + e);
+ }
+ ```
+
+
+## distributedData.createKVManager
+
+createKVManager(config: KVManagerConfig): Promise<KVManager>
创建一个KVManager对象实例，用于管理数据库对象，并通过Promise方式返回，此方法为异步方法。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- config
- |
- KVManagerConfig
- |
- 是
- |
- 提供KVManager实例的配置信息，包括调用方的包名和用户信息。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<KVManager>
- |
- 指定的Promise回调方法，返回创建的KVManager对象实例。
- |
-
-
-
-
-- 示例：
-
- ```
- let kvManager;
- try {
- const kvManagerConfig = {
- bundleName : 'com.example.datamanagertest',
- userInfo : {
- userId : '0',
- userType : 0
- }
- }
- distributedData.createKVManager(kvManagerConfig).then((manager) => {
- console.log("createKVManager success");
- kvManager = manager;
- }).catch((err) => {
- console.log("createKVManager err: " + JSON.stringify(err));
- });
- } catch (e) {
- console.log("An unexpected error occurred. Error:" + e);
- }
- ```
-
-
-## KVManagerConfig
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | config | [KVManagerConfig](#kvmanagerconfig) | 是 | 提供KVManager实例的配置信息，包括调用方的包名和用户信息。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<[KVManager](#kvmanager)> | 指定的Promise回调方法，返回创建的KVManager对象实例。 |
+
+- 示例：
+ ```
+ let kvManager;
+ try {
+ const kvManagerConfig = {
+ bundleName : 'com.example.datamanagertest',
+ userInfo : {
+ userId : '0',
+ userType : 0
+ }
+ }
+ distributedData.createKVManager(kvManagerConfig).then((manager) => {
+ console.log("createKVManager success");
+ kvManager = manager;
+ }).catch((err) => {
+ console.log("createKVManager err: " + JSON.stringify(err));
+ });
+ } catch (e) {
+ console.log("An unexpected error occurred. Error:" + e);
+ }
+ ```
+
+
+## KVManagerConfig
提供KVManager实例的配置信息，包括调用方的包名和用户信息。
-
-名称
- |
-类型
- |
-必填
- |
-描述
- |
-
|---|
-
-userInfo
- |
-UserInfo
- |
-是
- |
-调用方的用户信息。
- |
-
-bundleName
- |
-string
- |
-是
- |
-调用方的包名。
- |
-
-
-
-
-## UserInfo
+| 名称 | 类型 | 必填 | 描述 |
+| -------- | -------- | -------- | -------- |
+| userInfo | [UserInfo](#userinfo) | 是 | 调用方的用户信息。 |
+| bundleName | string | 是 | 调用方的包名。 |
+
+
+## UserInfo
用户信息。
-
-名称
- |
-类型
- |
-必填
- |
-描述
- |
-
|---|
-
-userId
- |
-string
- |
-是
- |
-指示要设置的用户ID。
- |
-
-userType
- |
-UserType
- |
-是
- |
-指示要设置的用户类型。
- |
-
-
-
-
-## UserType
+| 名称 | 类型 | 必填 | 描述 |
+| -------- | -------- | -------- | -------- |
+| userId | string | 是 | 指示要设置的用户ID。 |
+| userType | [UserType](#usertype) | 是 | 指示要设置的用户类型。 |
+
+
+## UserType
用户类型。
-
-名称
- |
-默认值
- |
-说明
- |
-
|---|
-
-SAME_USER_ID
- |
-0
- |
-使用同一帐户登录不同设备的用户。
- |
-
-
-
-
-## KVManager
+| 名称 | 默认值 | 说明 |
+| -------- | -------- | -------- |
+| SAME_USER_ID | 0 | 使用同一帐户登录不同设备的用户。 |
+
+
+## KVManager
数据管理实例，用于获取KVStore的相关信息。在调用KVManager的方法前，需要先通过createKVManager构建一个KVManager实例。
-### getKVStore
-getKVStore\(storeId: string, options: Options, callback: AsyncCallback\): void
+### getKVStore
+
+getKVStore<T extends KVStore>(storeId: string, options: Options, callback: AsyncCallback<T>): void
通过指定Options和storeId，创建并获取KVStore数据库，并通过callback方式返回，此方法为异步方法。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- storeId
- |
- string
- |
- 是
- |
- 数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。
- |
-
- options
- |
- Options
- |
- 是
- |
- 创建KVStore实例的配置信息。
- |
-
- callback
- |
- AsyncCallback<T>，
- <T extends KVStore>
- |
- 是
- |
- 创建KVStore实例的回调，返回KVStore对象实例。
- |
-
-
-
-
-- 示例：
-
- ```
- let kvStore;
- try {
- const options = {
- createIfMissing : true,
- encrypt : false,
- backup : false,
- autoSync : true,
- kvStoreType : 1,
- securityLevel : 3,
- };
- kvManager.getKVStore('storeId', options, function (err, store) {
- if (err) {
- console.log("getKVStore err: " + JSON.stringify(err));
- return;
- }
- console.log("getKVStore success");
- kvStore = store;
- });
- } catch (e) {
- console.log("An unexpected error occurred. Error:" + e);
- }
- ```
-
-
-### getKVStore
-
-getKVStore\(storeId: string, options: Options\): Promise
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | storeId | string | 是 | 数据库唯一标识符，长度不大于[MAX_STORE_ID_LENGTH](#Constants)。 |
+ | options | [Options](#options) | 是 | 创建KVStore实例的配置信息。 |
+ | callback | AsyncCallback<T>，
<T extends KVStore> | 是 | 创建KVStore实例的回调，返回KVStore对象实例。 |
+
+- 示例：
+ ```
+ let kvStore;
+ try {
+ const options = {
+ createIfMissing : true,
+ encrypt : false,
+ backup : false,
+ autoSync : true,
+ kvStoreType : 1,
+ securityLevel : 3,
+ };
+ kvManager.getKVStore('storeId', options, function (err, store) {
+ if (err) {
+ console.log("getKVStore err: " + JSON.stringify(err));
+ return;
+ }
+ console.log("getKVStore success");
+ kvStore = store;
+ });
+ } catch (e) {
+ console.log("An unexpected error occurred. Error:" + e);
+ }
+ ```
+
+
+### getKVStore
+
+getKVStore<T extends KVStore>(storeId: string, options: Options): Promise<T>
通过指定Options和storeId，创建并获取KVStore数据库，并通过Promise方式返回，此方法为异步方法。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- storeId
- |
- string
- |
- 是
- |
- 数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。
- |
-
- options
- |
- Options
- |
- 是
- |
- 创建KVStore实例的配置信息。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<T>
- <T extends KVStore>
- |
- 指定的Promise回调方法，返回创建的KVStore数据库实例。
- |
-
-
-
-
-- 示例：
-
- ```
- let kvStore;
- try {
- const options = {
- createIfMissing : true,
- encrypt : false,
- backup : false,
- autoSync : true,
- kvStoreType : 1,
- securityLevel : 3,
- };
- kvManager.getKVStore('storeId', options).then((store) => {
- console.log("getKVStore success");
- kvStore = store;
- }).catch((err) => {
- console.log("getKVStore err: " + JSON.stringify(err));
- });
- } catch (e) {
- console.log("An unexpected error occurred. Error:" + e);
- }
- ```
-
-
-## Options
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | storeId | string | 是 | 数据库唯一标识符，长度不大于[MAX_STORE_ID_LENGTH](#Constants)。 |
+ | options | [Options](#options) | 是 | 创建KVStore实例的配置信息。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<T>
<T extends KVStore> | 指定的Promise回调方法，返回创建的KVStore数据库实例。 |
+
+- 示例：
+ ```
+ let kvStore;
+ try {
+ const options = {
+ createIfMissing : true,
+ encrypt : false,
+ backup : false,
+ autoSync : true,
+ kvStoreType : 1,
+ securityLevel : 3,
+ };
+ kvManager.getKVStore('storeId', options).then((store) => {
+ console.log("getKVStore success");
+ kvStore = store;
+ }).catch((err) => {
+ console.log("getKVStore err: " + JSON.stringify(err));
+ });
+ } catch (e) {
+ console.log("An unexpected error occurred. Error:" + e);
+ }
+ ```
+
+
+## Options
用于提供创建数据库的配置信息。
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-createIfMissing
- |
-boolean
- |
-否
- |
-当数据库文件不存在时是否创建数据库，默认创建。
- |
-
-encrypt
- |
-boolean
- |
-否
- |
-设置数据库文件是否加密，默认不加密。
- |
-
-backup
- |
-boolean
- |
-否
- |
-设置数据库文件是否备份，默认备份。
- |
-
-autoSync
- |
-boolean
- |
-否
- |
-设置数据库文件是否自动同步，默认不自动同步。
- |
-
-kvStoreType
- |
-KVStoreType
- |
-否
- |
-设置要创建的数据库类型，默认为多设备协同数据库。
- |
-
-securityLevel
- |
-SecurityLevel
- |
-否
- |
-设置数据库安全级别，默认不设置安全级别。
- |
-
-
-
-
-## KVStoreType
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | -------- | -------- | -------- |
+| createIfMissing | boolean | 否 | 当数据库文件不存在时是否创建数据库，默认创建。 |
+| encrypt | boolean | 否 | 设置数据库文件是否加密，默认不加密。 |
+| backup | boolean | 否 | 设置数据库文件是否备份，默认备份。 |
+| autoSync | boolean | 否 | 设置数据库文件是否自动同步，默认不自动同步。 |
+| kvStoreType | [KVStoreType](#kvstoretype) | 否 | 设置要创建的数据库类型，默认为多设备协同数据库。 |
+| securityLevel | [SecurityLevel](#securitylevel) | 否 | 设置数据库安全级别，默认不设置安全级别。 |
+
+
+## KVStoreType
用于指定创建的数据库的类型。
-
-名称
- |
-默认值
- |
-说明
- |
-
|---|
-
-DEVICE_COLLABORATION
- |
-0
- |
-表示多设备协同数据库。
- |
-
-SINGLE_VERSION
- |
-1
- |
-表示单版本数据库。
- |
-
-MULTI_VERSION
- |
-2
- |
-表示多版本数据库。此类型当前不允许使用。
- |
-
-
-
-
-## SecurityLevel
+| 名称 | 默认值 | 说明 |
+| -------- | -------- | -------- |
+| DEVICE_COLLABORATION | 0 | 表示多设备协同数据库。 |
+| SINGLE_VERSION | 1 | 表示单版本数据库。 |
+| MULTI_VERSION | 2 | 表示多版本数据库。此类型当前不允许使用。 |
+
+
+## SecurityLevel
用于指定创建的数据库的安全级别。
-
-名称
- |
-默认值
- |
-说明
- |
-
|---|
-
-NO_LEVEL
- |
-0
- |
-表示数据库不设置安全级别。
- |
-
-S0
- |
-1
- |
-表示数据库的安全级别为公共级别安全。
- |
-
-S1
- |
-2
- |
-表示数据库的安全级别为低级别安全，当数据泄露时会产生较低影响。
- |
-
-S2
- |
-3
- |
-表示数据库的安全级别为中级别安全，当数据泄露时会产生较大影响。
- |
-
-S3
- |
-5
- |
-表示数据库的安全级别为高级别安全，当数据泄露时会产生重大影响。
- |
-
-S4
- |
-6
- |
-表示数据库的安全级别为关键级别安全，当数据泄露时会产生严重影响。
- |
-
-
-
-
-## Constants
+| 名称 | 默认值 | 说明 |
+| -------- | -------- | -------- |
+| NO_LEVEL | 0 | 表示数据库不设置安全级别。 |
+| S0 | 1 | 表示数据库的安全级别为公共级别安全。 |
+| S1 | 2 | 表示数据库的安全级别为低级别安全，当数据泄露时会产生较低影响。 |
+| S2 | 3 | 表示数据库的安全级别为中级别安全，当数据泄露时会产生较大影响。 |
+| S3 | 5 | 表示数据库的安全级别为高级别安全，当数据泄露时会产生重大影响。 |
+| S4 | 6 | 表示数据库的安全级别为关键级别安全，当数据泄露时会产生严重影响。 |
+
+
+## Constants
KVStore常量。
-
-名称
- |
-默认值
- |
-说明
- |
-
|---|
-
-MAX_KEY_LENGTH
- |
-1024
- |
-数据库中Key允许最大长度，单位字节。
- |
-
-MAX_VALUE_LENGTH
- |
-4194303
- |
-数据库中Value允许的最大长度，单位字节。
- |
-
-MAX_KEY_LENGTH_DEVICE
- |
-896
- |
-最大设备坐标密钥长度。
- |
-
-MAX_STORE_ID_LENGTH
- |
-128
- |
-数据库标识符允许的最大长度，单位字节。
- |
-
-MAX_QUERY_LENGTH
- |
-512000
- |
-最大查询长度。
- |
-
-MAX_BATCH_SIZE
- |
-128
- |
-最大批处理操作大小。
- |
-
-
-
-
-## KVStore
+| 名称 | 默认值 | 说明 |
+| -------- | -------- | -------- |
+| MAX_KEY_LENGTH | 1024 | 数据库中Key允许最大长度，单位字节。 |
+| MAX_VALUE_LENGTH | 4194303 | 数据库中Value允许的最大长度，单位字节。 |
+| MAX_KEY_LENGTH_DEVICE | 896 | 最大设备坐标密钥长度。 |
+| MAX_STORE_ID_LENGTH | 128 | 数据库标识符允许的最大长度，单位字节。 |
+| MAX_QUERY_LENGTH | 512000 | 最大查询长度。 |
+| MAX_BATCH_SIZE | 128 | 最大批处理操作大小。 |
+
+
+## KVStore
KVStore数据库实例，提供增加数据、删除数据和订阅数据变更、订阅同步完成的方法。在调用KVStore的方法前，需要先通过getKVStore构建一个KVStore实例。
-### put
-put\(key: string, value: Uint8Array | string | number | boolean, callback: AsyncCallback\): void
+### put
+
+put(key: string, value: Uint8Array | string | number | boolean, callback: AsyncCallback<void>): void
添加指定类型键值对到数据库，并通过callback方式返回，此方法为异步方法。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- key
- |
- string
- |
- 是
- |
- 要添加数据的key，不能为空且长度不大于MAX_KEY_LENGTH。
- |
-
- value
- |
- Uint8Array | string | number | boolean
- |
- 是
- |
- 要添加数据的value，支持Uint8Array、number 、 string 、boolean，
- Uint8Array、string 的长度不大于MAX_VALUE_LENGTH。
- |
-
- callback
- |
- AsyncCallback<void>
- |
- 是
- |
- 回调函数。
- |
-
-
-
-
-- 示例
-
- ```
- const KEY_TEST_STRING_ELEMENT = 'key_test_string';
- const VALUE_TEST_STRING_ELEMENT = 'value-test-string';
- try {
- kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT, function (err,data) {
- if (err != undefined) {
- console.log("put err: " + JSON.stringify(err));
- return;
- }
- console.log("put success");
- });
- }catch (e) {
- console.log("An unexpected error occurred. Error:" + e);
- }
- ```
-
-
-### put
-
-put\(key: string, value: Uint8Array | string | number | boolean\): Promise
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | key | string | 是 | 要添加数据的key，不能为空且长度不大于[MAX_KEY_LENGTH](#Constants)。 |
+ | value | Uint8Array \| string \| number \| boolean | 是 | 要添加数据的value，支持Uint8Array、number 、 string 、boolean，
Uint8Array、string 的长度不大于[MAX_VALUE_LENGTH](#Constants)。 |
+ | callback | AsyncCallback<void> | 是 | 回调函数。 |
+
+- 示例
+ ```
+ const KEY_TEST_STRING_ELEMENT = 'key_test_string';
+ const VALUE_TEST_STRING_ELEMENT = 'value-test-string';
+ try {
+ kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT, function (err,data) {
+ if (err != undefined) {
+ console.log("put err: " + JSON.stringify(err));
+ return;
+ }
+ console.log("put success");
+ });
+ }catch (e) {
+ console.log("An unexpected error occurred. Error:" + e);
+ }
+ ```
+
+
+### put
+
+put(key: string, value: Uint8Array | string | number | boolean): Promise<void>
添加指定类型键值对到数据库，并通过Promise方式返回，此方法为异步方法。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- key
- |
- string
- |
- 是
- |
- 要添加数据的key，不能为空且长度不大于MAX_KEY_LENGTH。
- |
-
- value
- |
- Uint8Array | string | number | boolean
- |
- 是
- |
- 要添加数据的value，支持Uint8Array、number 、 string 、boolean，
- Uint8Array、string 的长度不大于MAX_VALUE_LENGTH。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<void>
- |
- Promise实例，用于异步处理。
- |
-
-
-
-
-
-- 示例
-
- ```
- const KEY_TEST_STRING_ELEMENT = 'key_test_string';
- const VALUE_TEST_STRING_ELEMENT = 'value-test-string';
- try {
- kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT).then((data) => {
- console.log("put success: " + JSON.stringify(data));
- }).catch((err) => {
- console.log("put err: " + JSON.stringify(err));
- });
- }catch (e) {
- console.log("An unexpected error occurred. Error:" + e);
- }
- ```
-
-
-### delete
-
-delete\(key: string, callback: AsyncCallback\): void
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | key | string | 是 | 要添加数据的key，不能为空且长度不大于[MAX_KEY_LENGTH](#Constants)。 |
+ | value | Uint8Array \| string \| number \| boolean | 是 | 要添加数据的value，支持Uint8Array、number 、 string 、boolean，
Uint8Array、string 的长度不大于[MAX_VALUE_LENGTH](#Constants)。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<void> | Promise实例，用于异步处理。 |
+
+
+- 示例
+ ```
+ const KEY_TEST_STRING_ELEMENT = 'key_test_string';
+ const VALUE_TEST_STRING_ELEMENT = 'value-test-string';
+ try {
+ kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT).then((data) => {
+ console.log("put success: " + JSON.stringify(data));
+ }).catch((err) => {
+ console.log("put err: " + JSON.stringify(err));
+ });
+ }catch (e) {
+ console.log("An unexpected error occurred. Error:" + e);
+ }
+ ```
+
+
+### delete
+
+delete(key: string, callback: AsyncCallback<void>): void
从数据库中删除指定键值的数据，并通过callback方式返回，此方法为异步方法。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- key
- |
- string
- |
- 是
- |
- 要删除数据的key，不能为空且长度不大于MAX_KEY_LENGTH。
- |
-
- callback
- |
- AsyncCallback<void>
- |
- 是
- |
- 回调函数。
- |
-
-
-
-
-- 示例
-
- ```
- const KEY_TEST_STRING_ELEMENT = 'key_test_string';
- const VALUE_TEST_STRING_ELEMENT = 'value-test-string';
- try {
- kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT, function (err,data) {
- if (err != undefined) {
- console.log("put err: " + JSON.stringify(err));
- return;
- }
- console.log("put success");
- kvStore.delete(KEY_TEST_STRING_ELEMENT, function (err,data) {
- if (err != undefined) {
- console.log("delete err: " + JSON.stringify(err));
- return;
- }
- console.log("delete success");
- });
- });
- }catch (e) {
- console.log("An unexpected error occurred. Error:" + e);
- }
- ```
-
-
-### delete
-
-delete\(key: string\): Promise
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | key | string | 是 | 要删除数据的key，不能为空且长度不大于[MAX_KEY_LENGTH](#Constants)。 |
+ | callback | AsyncCallback<void> | 是 | 回调函数。 |
+
+- 示例
+ ```
+ const KEY_TEST_STRING_ELEMENT = 'key_test_string';
+ const VALUE_TEST_STRING_ELEMENT = 'value-test-string';
+ try {
+ kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT, function (err,data) {
+ if (err != undefined) {
+ console.log("put err: " + JSON.stringify(err));
+ return;
+ }
+ console.log("put success");
+ kvStore.delete(KEY_TEST_STRING_ELEMENT, function (err,data) {
+ if (err != undefined) {
+ console.log("delete err: " + JSON.stringify(err));
+ return;
+ }
+ console.log("delete success");
+ });
+ });
+ }catch (e) {
+ console.log("An unexpected error occurred. Error:" + e);
+ }
+ ```
+
+
+### delete
+
+delete(key: string): Promise<void>
从数据库中删除指定键值的数据，并通过Promise方式返回，此方法为异步方法。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- key
- |
- string
- |
- 是
- |
- 要删除数据的key，不能为空且长度不大于MAX_KEY_LENGTH。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<void>
- |
- Promise实例，用于异步处理。
- |
-
-
-
-
-- 示例
-
- ```
- const KEY_TEST_STRING_ELEMENT = 'key_test_string';
- const VALUE_TEST_STRING_ELEMENT = 'value-test-string';
- try {
- kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT).then((data) => {
- console.log("put success: " + JSON.stringify(data));
- kvStore.delete(KEY_TEST_STRING_ELEMENT).then((data) => {
- console.log("delete success");
- }).catch((err) => {
- console.log("delete err: " + JSON.stringify(err));
- });
- }).catch((err) => {
- console.log("put err: " + JSON.stringify(err));
- });
- }catch (e) {
- console.log("An unexpected error occurred. Error:" + e);
- }
- ```
-
-
-### on
-
-on\(event: 'dataChange', type: SubscribeType, observer: Callback\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | key | string | 是 | 要删除数据的key，不能为空且长度不大于[MAX_KEY_LENGTH](#Constants)。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<void> | Promise实例，用于异步处理。 |
+
+- 示例
+ ```
+ const KEY_TEST_STRING_ELEMENT = 'key_test_string';
+ const VALUE_TEST_STRING_ELEMENT = 'value-test-string';
+ try {
+ kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT).then((data) => {
+ console.log("put success: " + JSON.stringify(data));
+ kvStore.delete(KEY_TEST_STRING_ELEMENT).then((data) => {
+ console.log("delete success");
+ }).catch((err) => {
+ console.log("delete err: " + JSON.stringify(err));
+ });
+ }).catch((err) => {
+ console.log("put err: " + JSON.stringify(err));
+ });
+ }catch (e) {
+ console.log("An unexpected error occurred. Error:" + e);
+ }
+ ```
+
+
+### on
+
+on(event: 'dataChange', type: SubscribeType, observer: Callback<ChangeNotification>): void
订阅指定类型的数据变更通知，此方法为同步方法。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 说明
- |
-
|---|
-
- event
- |
- 'dataChange'
- |
- 回调函数名称。
- |
-
- type
- |
- SubscribeType
- |
- 表示订阅的类型。
- |
-
- observer
- |
- Callback<ChangeNotification>
- |
- 回调函数。
- |
-
-
-
-
-- 示例
-
- ```
- kvStore.on('dataChange', 2, function (data) {
- console.log("dataChange callback call data: " + JSON.stringify(data));
- });
- ```
-
-
-### on
-
-on\(event: 'syncComplete', syncCallback: Callback\>\): void
+- 参数：
+ | 参数名 | 类型 | 说明 |
+ | -------- | -------- | -------- |
+ | event | 'dataChange' | 回调函数名称。 |
+ | type | [SubscribeType](#subscribetype) | 表示订阅的类型。 |
+ | observer | Callback<[ChangeNotification](#changenotification)> | 回调函数。 |
+
+- 示例
+ ```
+ kvStore.on('dataChange', 2, function (data) {
+ console.log("dataChange callback call data: " + JSON.stringify(data));
+ });
+ ```
+
+
+### on
+
+on(event: 'syncComplete', syncCallback: Callback<Array<[string, number]>>): void
订阅数据同步完成通知，此方法为同步方法。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 说明
- |
-
|---|
-
- event
- |
- 'syncComplete'
- |
- 回调函数名称。
- |
-
- syncCallback
- |
- Callback<Array<[string, number]>>
- |
- 回调函数。
- |
-
-
-
-
-- 示例
-
- ```
- kvStore.on('syncComplete', function (data) {
- console.log("syncComplete callback call data: " + data);
- });
- ```
-
-
-## SubscribeType
+- 参数：
+ | 参数名 | 类型 | 说明 |
+ | -------- | -------- | -------- |
+ | event | 'syncComplete' | 回调函数名称。 |
+ | syncCallback | Callback<Array<[string, number]>> | 回调函数。 |
+
+- 示例
+ ```
+ kvStore.on('syncComplete', function (data) {
+ console.log("syncComplete callback call data: " + data);
+ });
+ ```
+
+
+## SubscribeType
描述订阅类型。
-
-名称
- |
-默认值
- |
-说明
- |
-
|---|
-
-SUBSCRIBE_TYPE_LOCAL
- |
-0
- |
-表示订阅本地数据变更。
- |
-
-SUBSCRIBE_TYPE_REMOTE
- |
-1
- |
-表示订阅远端数据变更。
- |
-
-SUBSCRIBE_TYPE_ALL
- |
-2
- |
-表示订阅远端和本地数据变更。
- |
-
-
-
-
-## ChangeNotification
+| 名称 | 默认值 | 说明 |
+| -------- | -------- | -------- |
+| SUBSCRIBE_TYPE_LOCAL | 0 | 表示订阅本地数据变更。 |
+| SUBSCRIBE_TYPE_REMOTE | 1 | 表示订阅远端数据变更。 |
+| SUBSCRIBE_TYPE_ALL | 2 | 表示订阅远端和本地数据变更。 |
+
+
+## ChangeNotification
数据变更时通知的对象，包括数据插入的数据、更新的数据、删除的数据和设备ID。
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-insertEntries
- |
-Entry[]
- |
-是
- |
-是
- |
-数据添加记录。
- |
-
-updateEntries
- |
-Entry[]
- |
-是
- |
-是
- |
-数据更新记录。
- |
-
-deleteEntries
- |
-Entry[]
- |
-是
- |
-是
- |
-数据删除记录。
- |
-
-deviceId
- |
-string
- |
-是
- |
-是
- |
-设备ID，此处为设备UUID。
- |
-
-
-
-
-## Entry
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| insertEntries | [Entry](#entry)[] | 是 | 是 | 数据添加记录。 |
+| updateEntries | [Entry](#entry)[] | 是 | 是 | 数据更新记录。 |
+| deleteEntries | [Entry](#entry)[] | 是 | 是 | 数据删除记录。 |
+| deviceId | string | 是 | 是 | 设备ID，此处为设备UUID。 |
+
+
+## Entry
存储在数据库中的键值对。
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-key
- |
-string
- |
-是
- |
-是
- |
-键值。
- |
-
-value
- |
-Value
- |
-是
- |
-是
- |
-值对象。
- |
-
-
-
-
-## Value
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| key | string | 是 | 是 | 键值。 |
+| value | [Value](#value) | 是 | 是 | 值对象。 |
+
+
+## Value
存储在数据库中的对象。
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-type
- |
-ValueType
- |
-是
- |
-是
- |
-值类型。
- |
-
-value
- |
-Uint8Array | string | number | boolean
- |
-是
- |
-是
- |
-值，Uint8Array、string 的长度不大于MAX_VALUE_LENGTH。
- |
-
-
-
-
-## ValueType
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| type | [ValueType](#valuetype) | 是 | 是 | 值类型。 |
+| value | Uint8Array \| string \| number \| boolean | 是 | 是 | 值，Uint8Array、string 的长度不大于[MAX_VALUE_LENGTH](#Constants)。 |
+
+
+## ValueType
用于表示数据类型。
只能被内部应用使用。
-
-名称
- |
-默认值
- |
-说明
- |
-
|---|
-
-STRING
- |
-0
- |
-表示值类型为字符串。
- |
-
-INTEGER
- |
-1
- |
-表示值类型为整数。
- |
-
-FLOAT
- |
-2
- |
-表示值类型为浮点数。
- |
-
-BYTE_ARRAY
- |
-3
- |
-表示值类型为字节数组。
- |
-
-BOOLEAN
- |
-4
- |
-表示值类型为布尔值。
- |
-
-DOUBLE
- |
-5
- |
-表示值类型为双浮点数。
- |
-
-
-
-
-## SingleKVStore
+| 名称 | 默认值 | 说明 |
+| -------- | -------- | -------- |
+| STRING | 0 | 表示值类型为字符串。 |
+| INTEGER | 1 | 表示值类型为整数。 |
+| FLOAT | 2 | 表示值类型为浮点数。 |
+| BYTE_ARRAY | 3 | 表示值类型为字节数组。 |
+| BOOLEAN | 4 | 表示值类型为布尔值。 |
+| DOUBLE | 5 | 表示值类型为双浮点数。 |
+
+
+## SingleKVStore
单版本分布式数据库，继承自KVStore，提供查询数据和同步数据的方法。在调用SingleKVStore的方法前，需要先通过getKVStore构建一个KVStore实例。
-### get
-get\(key: string, callback: AsyncCallback\): void
+### get
+
+get(key: string, callback: AsyncCallback<Uint8Array | string | boolean | number>): void
获取指定键的值，并通过callback方式返回，此方法为异步方法。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- key
- |
- string
- |
- 是
- |
- 要查询数据的key，不能为空且长度不大于MAX_KEY_LENGTH。
- |
-
- callback
- |
- AsyncCallback<Uint8Array | string | boolean | number>
- |
- 是
- |
- 回调函数，获取查询的值。
- |
-
-
-
-
-- 示例
-
- ```
- const KEY_TEST_STRING_ELEMENT = 'key_test_string';
- const VALUE_TEST_STRING_ELEMENT = 'value-test-string';
- try {
- kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT, function (err,data) {
- if (err != undefined) {
- console.log("put err: " + JSON.stringify(err));
- return;
- }
- console.log("put success");
- kvStore.get(KEY_TEST_STRING_ELEMENT, function (err,data) {
- console.log("get success data: " + data);
- });
- });
- }catch (e) {
- console.log("An unexpected error occurred. Error:" + e);
- }
- ```
-
-
-### get
-
-get\(key: string\): Promise
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | key | string | 是 | 要查询数据的key，不能为空且长度不大于[MAX_KEY_LENGTH](#Constants)。 |
+ | callback | AsyncCallback<Uint8Array \| string \| boolean \| number> | 是 | 回调函数，获取查询的值。 |
+
+- 示例
+ ```
+ const KEY_TEST_STRING_ELEMENT = 'key_test_string';
+ const VALUE_TEST_STRING_ELEMENT = 'value-test-string';
+ try {
+ kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT, function (err,data) {
+ if (err != undefined) {
+ console.log("put err: " + JSON.stringify(err));
+ return;
+ }
+ console.log("put success");
+ kvStore.get(KEY_TEST_STRING_ELEMENT, function (err,data) {
+ console.log("get success data: " + data);
+ });
+ });
+ }catch (e) {
+ console.log("An unexpected error occurred. Error:" + e);
+ }
+ ```
+
+
+### get
+
+get(key: string): Promise<Uint8Array | string | boolean | number>
获取指定键的值，并通过Promise方式返回，此方法为异步方法。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- key
- |
- string
- |
- 是
- |
- 要查询数据的key，不能为空且长度不大于MAX_KEY_LENGTH。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<Uint8Array | string | boolean | number>
- |
- Promise实例，用于获取异步返回结果。
- |
-
-
-
-
-
-- 示例
-
- ```
- const KEY_TEST_STRING_ELEMENT = 'key_test_string';
- const VALUE_TEST_STRING_ELEMENT = 'value-test-string';
- try {
- kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT).then((data) => {
- console.log("put success: " + JSON.stringify(data));
- kvStore.get(KEY_TEST_STRING_ELEMENT).then((data) => {
- console.log("get success data: " + data);
- }).catch((err) => {
- console.log("get err: " + JSON.stringify(err));
- });
- }).catch((err) => {
- console.log("put err: " + JSON.stringify(err));
- });
- }catch (e) {
- console.log("An unexpected error occurred. Error:" + e);
- }
- ```
-
-
-### sync
-
-sync\(deviceIdList: string\[\], mode: SyncMode, allowedDelayMs?: number\): void
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | key | string | 是 | 要查询数据的key，不能为空且长度不大于[MAX_KEY_LENGTH](#Constants)。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<Uint8Array \| string \| boolean \| number> | Promise实例，用于获取异步返回结果。 |
+
+
+- 示例
+ ```
+ const KEY_TEST_STRING_ELEMENT = 'key_test_string';
+ const VALUE_TEST_STRING_ELEMENT = 'value-test-string';
+ try {
+ kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT).then((data) => {
+ console.log("put success: " + JSON.stringify(data));
+ kvStore.get(KEY_TEST_STRING_ELEMENT).then((data) => {
+ console.log("get success data: " + data);
+ }).catch((err) => {
+ console.log("get err: " + JSON.stringify(err));
+ });
+ }).catch((err) => {
+ console.log("put err: " + JSON.stringify(err));
+ });
+ }catch (e) {
+ console.log("An unexpected error occurred. Error:" + e);
+ }
+ ```
+
+
+### sync
+
+sync(deviceIdList: string[], mode: SyncMode, allowedDelayMs?: number): void
在手动同步模式下，触发数据库同步，此方法为同步方法。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- deviceIdList
- |
- string[]
- |
- 是
- |
- 同一组网环境下，需要同步的设备的deviceId列表。
- |
-
- mode
- |
- SyncMode
- |
- 是
- |
- 同步类型。
- |
-
- allowedDelayMs
- |
- number
- |
- 否
- |
- 可选参数，允许延时时间，单位：ms（毫秒）。
- |
-
-
-
-
-- 示例：
-
- ```
- kvStore.sync(deviceIds, 1, 1000);
- ```
-
-
-## SyncMode
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | deviceIdList | string[] | 是 | 同一组网环境下，需要同步的设备的deviceId列表。 |
+ | mode | [SyncMode](#syncmode) | 是 | 同步类型。 |
+ | allowedDelayMs | number | 否 | 可选参数，允许延时时间，单位：ms（毫秒）。 |
-用于指定同步模式。
+- 示例：
+ ```
+ kvStore.sync(deviceIds, 1, 1000);
+ ```
-
-名称
- |
-默认值
- |
-说明
- |
-
|---|
-
-PULL_ONLY
- |
-0
- |
-表示只能从远端拉取数据到本端。
- |
-
-PUSH_ONLY
- |
-1
- |
-表示只能从本端推送数据到对端。
- |
-
-PUSH_PULL
- |
-2
- |
-表示从本端推送数据到远端，然后从远端拉取数据到本端。
- |
-
-
-
+## SyncMode
+
+用于指定同步模式。
+
+| 名称 | 默认值 | 说明 |
+| -------- | -------- | -------- |
+| PULL_ONLY | 0 | 表示只能从远端拉取数据到本端。 |
+| PUSH_ONLY | 1 | 表示只能从本端推送数据到对端。 |
+| PUSH_PULL | 2 | 表示从本端推送数据到远端，然后从远端拉取数据到本端。 |
diff --git a/zh-cn/application-dev/reference/apis/js-apis-fileio.md b/zh-cn/application-dev/reference/apis/js-apis-fileio.md
index f4e52b91d2019292d8210efd7682f1a7b592c30c..bd6220ef2d71a5492081641cbf2eb5ffa77b0cef 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-fileio.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-fileio.md
@@ -1,2051 +1,878 @@
-# 文件管理
+# 文件管理
-> **说明：**
->从 API Version 6 开始支持。
+>  **说明：**
+> 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
-## 导入模块
+
+## 导入模块
```
import fileio from '@ohos.fileio';
```
-## 权限列表
+
+## 权限列表
无
-## 使用说明
-使用该功能模块对文件/目录进行操作前，需要先获取其绝对路径，获取方式及其接口用法请参考：[Context模块的接口getOrCreateLocalDir](js-apis-Context.md)。
+## 使用说明
+使用该功能模块对文件/目录进行操作前，需要先获取其绝对路径，获取方式及其接口用法请参考：[Context模块的接口getOrCreateLocalDir](js-apis-Context.md)。
“文件/目录绝对路径”=“应用目录路径”+“文件/目录名”
通过上述接口获取到应用目录路径dir，文件名为“xxx.txt”，文件所在绝对路径为：
```
-let path = dir + "/xxx.txt"
+let path = dir + "xxx.txt"
```
+
文件描述符fd：
+
```
let fd = fileio.openSync(path);
```
-## fileio.statSync
-statSync\(path:string\): Stat
+## fileio.statSync
+
+statSync(path:string): Stat
以同步方法获取文件的信息。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- path
- |
- string
- |
- 是
- |
- 待获取文件的绝对路径。
- |
-
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Stat
- |
- 表示文件的具体信息。
- |
-
-
-
-
-- 示例：
-
- ```
- let stat = fileio.statSync(path);
- ```
-
-
-## fileio.opendirSync
-
-opendirSync\(path: string\): Dir
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | path | string | 是 | 待获取文件的绝对路径。 |
+
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [Stat](#stat) | 表示文件的具体信息。 |
+
+- 示例：
+ ```
+ let stat = fileio.statSync(path);
+ ```
+
+
+## fileio.opendirSync
+
+opendirSync(path: string): Dir
以同步方法打开文件目录。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- path
- |
- string
- |
- 是
- |
- 待打开文件目录的绝对路径。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Dir
- |
- 返回Dir对象。
- |
-
-
-
-
-- 示例：
-
- ```
- let dir = fileio.opendirSync(path);
- ```
-
-
-## fileio.accessSync
-
-accessSync\(path: string, mode?: number\): void
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | path | string | 是 | 待打开文件目录的绝对路径。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [Dir](#dir) | 返回Dir对象。 |
+
+- 示例：
+ ```
+ let dir = fileio.opendirSync(path);
+ ```
+
+
+## fileio.accessSync
+
+accessSync(path: string, mode?: number): void
以同步方法检查当前进程是否可访问某文件。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- path
- |
- string
- |
- 是
- |
- 待访问文件的绝对路径。
- |
-
- mode
- |
- number
- |
- 否
- |
- 访问文件时的选项，可给定如下选项，以按位或的方式使用多个选项，默认给定0。
- 确认当前进程是否具有对应权限：
-
- - 1：确认当前进程是否具有可执行权限。
- 2：确认当前进程是否具有写权限。
- 4：确认当前进程是否具有读权限。
- |
-
-
-
-
-- 示例：
-
- ```
- fileio.accessSync(path);
- ```
-
-
-## fileio.closeSync
-
-closeSync\(fd: number\): void
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | path | string | 是 | 待访问文件的绝对路径。 |
+ | mode | number | 否 | 访问文件时的选项，可给定如下选项，以按位或的方式使用多个选项，默认给定0。
确认当前进程是否具有对应权限：
- 0：确认文件是否存在。
- 1：确认当前进程是否具有可执行权限。
- 2：确认当前进程是否具有写权限。
- 4：确认当前进程是否具有读权限。 |
+
+- 示例：
+ ```
+ fileio.accessSync(path);
+ ```
+
+
+## fileio.closeSync
+
+closeSync(fd: number): void
以同步方法关闭文件。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- fd
- |
- number
- |
- 是
- |
- 待关闭文件的文件描述符。
- |
-
-
-
-
-- 示例：
-
- ```
- fileio.closeSync(fd);
- ```
-
-
-## fileio.copyFileSync
-
-fileio.copyFileSync\(src: string, dest: string, mode?:number\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | fd | number | 是 | 待关闭文件的文件描述符。 |
+
+- 示例：
+ ```
+ fileio.closeSync(fd);
+ ```
+
+
+## fileio.copyFileSync
+
+fileio.copyFileSync(src: string, dest: string, mode?:number): void
以同步方法复制文件。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- src
- |
- string
- |
- 是
- |
- 待复制文件的路径。
- |
-
- dest
- |
- string
- |
- 是
- |
- 目标文件路径。
- |
-
- mode
- |
- number
- |
- 否
- |
- mode提供覆盖文件的选项，当前仅支持0，且默认为0。
- 0：完全覆盖目标文件，未覆盖部分将被裁切掉。
- |
-
-
-
-
-- 示例：
-
- ```
- fileio.copyFileSync(src, dest);
- ```
-
-
-## fileio.mkdirSync
-
-fileio.mkdirSync\(path: string, mode?: number\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | src | string | 是 | 待复制文件的路径。 |
+ | dest | string | 是 | 目标文件路径。 |
+ | mode | number | 否 | mode提供覆盖文件的选项，当前仅支持0，且默认为0。
0：完全覆盖目标文件，未覆盖部分将被裁切掉。 |
+
+- 示例：
+ ```
+ fileio.copyFileSync(src, dest);
+ ```
+
+
+## fileio.mkdirSync
+
+fileio.mkdirSync(path: string, mode?: number): void
以同步方法创建目录。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- path
- |
- string
- |
- 是
- |
- 待创建目录的绝对路径。
- |
-
- mode
- |
- number
- |
- 否
- |
- 创建目录的权限，可给定如下权限，以按位或的方式追加权限，默认给定0o775。
- - 0o775：所有者具有读、写及可执行权限，其余用户具有读及可执行权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。
- |
-
-
-
-
-- 示例：
-
- ```
- fileio.mkdirSync(path);
- ```
-
-
-## fileio.openSync
-
-openSync\(path: string, flags?: number, mode?: number\): number
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | path | string | 是 | 待创建目录的绝对路径。 |
+ | mode | number | 否 | 创建目录的权限，可给定如下权限，以按位或的方式追加权限，默认给定0o775。
- 0o775：所有者具有读、写及可执行权限，其余用户具有读及可执行权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 |
+
+- 示例：
+ ```
+ fileio.mkdirSync(path);
+ ```
+
+
+## fileio.openSync
+
+openSync(path: string, flags?: number, mode?: number): number
以同步方法打开文件。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- path
- |
- string
- |
- 是
- |
- 待打开文件的绝对路径。
- |
-
- flags
- |
- number
- |
- 否
- |
- 打开文件的选项，必须指定如下选项中的一个，默认以只读方式打开：
- - 0o0：只读打开。
- 0o1：只写打开。
- 0o2：读写打开。
- 同时，也可给定如下选项，以按位或的方式追加，默认不给定任何额外选项：
- - 0o100：若文件不存在，则创建文件。使用该选项时必须指定第三个参数 mode。
- 0o200：如果追加了0o100选项，且文件已经存在，则出错。
- 0o1000：如果文件存在且以只写或读写的方式打开文件，则将其长度裁剪为零。
- 0o2000：以追加方式打开，后续写将追加到文件末尾。
- 0o4000：如果path指向FIFO、块特殊文件或字符特殊文件，则本次打开及后续 IO 进行非阻塞操作。
- 0o200000：如果path指向目录，则出错。
- 0o400000：如果path指向符号链接，则出错。
- 0o4010000：以同步IO的方式打开文件。
- |
-
- mode
- |
- number
- |
- 否
- |
- 若创建文件，则指定文件的权限，可给定如下权限，以按位或的方式追加权限，默认给定0o666。
- - 0o666：所有者具有读、写权限，所有用户组具有读、写权限，其余用户具有读、写权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- number
- |
- 打开文件的文件描述符。
- |
-
-
-
-
-- 示例：
-
- ```
- fileio.openSync(path);
- ```
-
-
-## fileio.readSync
-
-readSync\(fd: number, buffer: ArrayBuffer, options?: Object\): number
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | path | string | 是 | 待打开文件的绝对路径。 |
+ | flags | number | 否 | 打开文件的选项，必须指定如下选项中的一个，默认以只读方式打开：
- 0o0：只读打开。
- 0o1：只写打开。
- 0o2：读写打开。
同时，也可给定如下选项，以按位或的方式追加，默认不给定任何额外选项：
- 0o100：若文件不存在，则创建文件。使用该选项时必须指定第三个参数 mode。
- 0o200：如果追加了0o100选项，且文件已经存在，则出错。
- 0o1000：如果文件存在且以只写或读写的方式打开文件，则将其长度裁剪为零。
- 0o2000：以追加方式打开，后续写将追加到文件末尾。
- 0o4000：如果path指向FIFO、块特殊文件或字符特殊文件，则本次打开及后续 IO 进行非阻塞操作。
- 0o200000：如果path指向目录，则出错。
- 0o400000：如果path指向符号链接，则出错。
- 0o4010000：以同步IO的方式打开文件。 |
+ | mode | number | 否 | 若创建文件，则指定文件的权限，可给定如下权限，以按位或的方式追加权限，默认给定0o666。
- 0o666：所有者具有读、写权限，所有用户组具有读、写权限，其余用户具有读、写权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | number | 打开文件的文件描述符。 |
+
+- 示例：
+ ```
+ fileio.openSync(path);
+ ```
+
+
+## fileio.readSync
+
+readSync(fd: number, buffer: ArrayBuffer, options?: Object): number
以同步方法从文件读取数据。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- fd
- |
- number
- |
- 是
- |
- 待读取文件的文件描述符。
- |
-
- buffer
- |
- ArrayBuffer
- |
- 是
- |
- 用于读取文件的缓冲区。
- |
-
- options
- |
- Object
- |
- 否
- |
- 支持如下选项：
- - offset，number 类型，表示将数据读取到缓冲区的位置，即相对于缓冲区首地址的偏移。可选，默认为0。
- length，number 类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
- position，number 类型，表示期望读取文件的位置。可选，默认从当前位置开始读。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- number
- |
- 实际读取的长度。
- |
-
-
-
-
-- 示例：
-
- ```
- let fd = fileio.openSync(path, 0o2);
- let buf = new ArrayBuffer(4096);
- fileio.readSync(fd, buf);
- console.log(String.fromCharCode.apply(null, new Uint8Array(buf)));
- ```
-
-
-## fileio.rmdirSync
-
-rmdirSync\(path: string\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | fd | number | 是 | 待读取文件的文件描述符。 |
+ | buffer | ArrayBuffer | 是 | 用于读取文件的缓冲区。 |
+ | options | Object | 否 | 支持如下选项：
- offset，number 类型，表示将数据读取到缓冲区的位置，即相对于缓冲区首地址的偏移。可选，默认为0。
- length，number 类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
- position，number 类型，表示期望读取文件的位置。可选，默认从当前位置开始读。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | number | 实际读取的长度。 |
+
+- 示例：
+ ```
+ let fd = fileio.openSync(path, 0o2);
+ let buf = new ArrayBuffer(4096);
+ fileio.readSync(fd, buf);
+ console.log(String.fromCharCode.apply(null, new Uint8Array(buf)));
+ ```
+
+
+## fileio.rmdirSync
+
+rmdirSync(path: string): void
以同步方法删除目录。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- path
- |
- string
- |
- 是
- |
- 待删除目录的绝对路径。
- |
-
-
-
-
-- 示例：
-
- ```
- fileio.rmdirSync(path);
- ```
-
-
-## fileio.unlinkSync
-
-unlinkSync\(path: string\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | path | string | 是 | 待删除目录的绝对路径。 |
+
+- 示例：
+ ```
+ fileio.rmdirSync(path);
+ ```
+
+
+## fileio.unlinkSync
+
+unlinkSync(path: string): void
以同步方法删除文件。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- path
- |
- string
- |
- 是
- |
- 待删除文件的绝对路径。
- |
-
-
-
-
-- 示例：
-
- ```
- fileio.unlinkSync(path);
- ```
-
-
-## fileio.writeSync
-
-writeSync\(fd: number, buffer: ArrayBuffer | string, options?:Object\): number
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | path | string | 是 | 待删除文件的绝对路径。 |
+
+- 示例：
+ ```
+ fileio.unlinkSync(path);
+ ```
+
+
+## fileio.writeSync
+
+writeSync(fd: number, buffer: ArrayBuffer | string, options?:Object): number
以同步方法将数据写入文件。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- fd
- |
- number
- |
- 是
- |
- 待写入文件的文件描述符。
- |
-
- buffer
- |
- ArrayBuffer | string
- |
- 是
- |
- 待写入文件的数据，可来自缓冲区或字符串。
- |
-
- options
- |
- Object
- |
- 否
- |
- 支持如下选项：
- - offset，number类型，表示期望写入数据的位置相对于数据首地址的偏移。可选，默认为0。
- length，number类型，表示期望写入数据的长度。可选，默认缓冲区长度减去偏移长度。
- position，number类型，表示期望写入文件的位置。可选，默认从当前位置开始写。
- encoding，string类型，当数据是 string 类型时有效，表示数据的编码方式，默认 'utf-8'，仅支持 'utf-8'。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- number
- |
- 实际写入的长度。
- |
-
-
-
-
-- 示例：
-
- ```
- let fd = fileio.openSync(path, 0o102, 0o666);
- fileio.writeSync(fd, "hello, world");
- ```
-
-
-## fileio.chmodSync7+
-
-chmodSync\(path: string, mode: number\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | fd | number | 是 | 待写入文件的文件描述符。 |
+ | buffer | ArrayBuffer \| string | 是 | 待写入文件的数据，可来自缓冲区或字符串。 |
+ | options | Object | 否 | 支持如下选项：
- offset，number类型，表示期望写入数据的位置相对于数据首地址的偏移。可选，默认为0。
- length，number类型，表示期望写入数据的长度。可选，默认缓冲区长度减去偏移长度。
- position，number类型，表示期望写入文件的位置。可选，默认从当前位置开始写。
- encoding，string类型，当数据是 string 类型时有效，表示数据的编码方式，默认 'utf-8'，仅支持 'utf-8'。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | number | 实际写入的长度。 |
+
+- 示例：
+ ```
+ let fd = fileio.openSync(path, 0o102, 0o666);
+ fileio.writeSync(fd, "hello, world");
+ ```
+
+
+## fileio.chmodSync7+
+
+chmodSync(path: string, mode: number): void
以同步方法基于文件路径改变文件权限。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- path
- |
- string
- |
- 是
- |
- 待改变文件权限的绝对路径。
- |
-
- mode
- |
- number
- |
- 是
- |
- 改变文件权限，可给定如下权限，以按位或的方式追加权限。
- - 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。
- |
-
-
-
-
-- 示例：
-
- ```
- fileio.chmodSync(fpath, mode);
- ```
-
-
-## fileio.fstatSync7+
-
-fstatSync\(fd: number\): Stat
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | path | string | 是 | 待改变文件权限的绝对路径。 |
+ | mode | number | 是 | 改变文件权限，可给定如下权限，以按位或的方式追加权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 |
+
+- 示例：
+ ```
+ fileio.chmodSync(fpath, mode);
+ ```
+
+
+## fileio.fstatSync7+
+
+fstatSync(fd: number): Stat
以同步方法基于文件描述符获取文件状态信息。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- fd
- |
- number
- |
- 是
- |
- 待获取文件的文件描述符。
- |
-
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<Stat>
- |
- 表示文件的具体信息。
- |
-
-
-
-
-
-- 示例：
-
- ```
- let fd = fileio.openSync(path);
- let stat = fileio.fstatSync(fd);
- ```
-
-
-## fileio.ftruncateSync7+
-
-ftruncateSync\(fd: number, len?: number\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | fd | number | 是 | 待获取文件的文件描述符。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<Stat> | 表示文件的具体信息。 |
+
+- 示例：
+ ```
+ let fd = fileio.openSync(path);
+ let stat = fileio.fstatSync(fd);
+ ```
+
+
+## fileio.ftruncateSync7+
+
+ftruncateSync(fd: number, len?: number): void
以同步方法基于文件描述符截断文件。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- fd
- |
- number
- |
- 是
- |
- 待截断文件的文件描述符。
- |
-
- len
- |
- number
- |
- 否
- |
- 文件截断后的长度，以字节为单位。
- |
-
-
-
-
-
-- 示例：
-
- ```
- fileio.ftruncate(fd, len);
- ```
-
-
-## fileio.fchmodSync7+
-
-fchmodSync\(existingPath: string, newPath: string\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | fd | number | 是 | 待截断文件的文件描述符。 |
+ | len | number | 否 | 文件截断后的长度，以字节为单位。 |
+
+- 示例：
+ ```
+ fileio.ftruncate(fd, len);
+ ```
+
+
+## fileio.fchmodSync7+
+
+fchmodSync(existingPath: string, newPath: string): void
以同步方法基于文件描述符改变文件权限。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- fd
- |
- number
- |
- 是
- |
- 待改变文件的文件描述符。
- |
-
- mode
- |
- number
- |
- 是
- |
- 若创建文件，则指定文件的权限，可给定如下权限，以按位或的方式追加权限。
- - 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。
- |
-
-
-
-
-- 示例：
-
- ```
- fileio.fchmodSync(fd, mode);
- ```
-
-
-## fileio.truncateSync7+
-
-truncateSync\(fpath: string, len?: number\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | fd | number | 是 | 待改变文件的文件描述符。 |
+ | mode | number | 是 | 若创建文件，则指定文件的权限，可给定如下权限，以按位或的方式追加权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 |
+
+- 示例：
+ ```
+ fileio.fchmodSync(fd, mode);
+ ```
+
+
+## fileio.truncateSync7+
+
+truncateSync(fpath: string, len?: number): void
以同步方法基于文件路径截断文件。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- path
- |
- string
- |
- 是
- |
- 待截断文件的绝对路径。
- |
-
- len
- |
- number
- |
- 否
- |
- 文件截断后的长度，以字节为单位。
- |
-
-
-
-
-
-- 示例：
-
- ```
- fileio.ftruncate(path, len);
- ```
-
-
-## fileio.renameSync7+
-
-renameSync\(oldPath: string, newPath: string\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | path | string | 是 | 待截断文件的绝对路径。 |
+ | len | number | 否 | 文件截断后的长度，以字节为单位。 |
+
+- 示例：
+ ```
+ fileio.ftruncate(path, len);
+ ```
+
+
+## fileio.renameSync7+
+
+renameSync(oldPath: string, newPath: string): void
以同步方法重命名文件。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- oldPath
- |
- string
- |
- 是
- |
- 目标文件的当前绝对路径。
- |
-
- Newpath
- |
- String
- |
- 是
- |
- 目标文件的新绝对路径。
- |
-
-
-
-
-- 示例：
-
- ```
- fileio.renameSync(oldpath, newpath);
- ```
-
-
-## fileio.fsyncSync7+
-
-fsyncSync\(fd: number\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | oldPath | string | 是 | 目标文件的当前绝对路径。 |
+ | Newpath | String | 是 | 目标文件的新绝对路径。 |
+
+- 示例：
+ ```
+ fileio.renameSync(oldpath, newpath);
+ ```
+
+
+## fileio.fsyncSync7+
+
+fsyncSync(fd: number): void
以同步方法同步文件数据。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- fd
- |
- number
- |
- 是
- |
- 待同步文件的文件描述符。
- |
-
-
-
-
-- 示例：
-
- ```
- fileio.fyncsSync)(fd);
- ```
-
-
-## fileio.chownSync7+
-
-chownSync\(path: string, uid: number, gid: number\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | fd | number | 是 | 待同步文件的文件描述符。 |
+
+- 示例：
+ ```
+ fileio.fyncsSync)(fd);
+ ```
+
+
+## fileio.chownSync7+
+
+chownSync(path: string, uid: number, gid: number): void
以同步的方法基于文件路径改变文件所有者。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- path
- |
- string
- |
- 是
- |
- 待改变文件的绝对路径。
- |
-
- uid
- |
- number
- |
- 是
- |
- 新的UID。
- |
-
- gid
- |
- number
- |
- 是
- |
- 新的GID。
- |
-
-
-
-
-- 示例：
-
- ```
- let stat = fileio.statSync(fpath)
- fileio.chownSync(path, stat.uid, stat.gid);
- ```
-
-
-## fileio.createStreamSync7+
-
-createStreamSync\(path: string, mode: string\): Stream
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | path | string | 是 | 待改变文件的绝对路径。 |
+ | uid | number | 是 | 新的UID。 |
+ | gid | number | 是 | 新的GID。 |
+
+- 示例：
+ ```
+ let stat = fileio.statSync(fpath)
+ fileio.chownSync(path, stat.uid, stat.gid);
+ ```
+
+
+## fileio.createStreamSync7+
+
+createStreamSync(path: string, mode: string): Stream
以同步方法基于文件路径打开文件流。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- path
- |
- string
- |
- 是
- |
- 待打开文件的绝对路径。
- |
-
- mode
- |
- string
- |
- 是
- |
- - r：打开只读文件，该文件必须存在。
- r+：打开可读写的文件，该文件必须存在。
- w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。
- a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。
- |
-
-
-
-
-
-- 返回值：
-
-
- 参数名
- |
- 说明
- |
-
|---|
-
- Stream
- |
- 返回文件流的结果。
- |
-
-
-
-
-- 示例：
-
- ```
- let ss = fileio.createStream(path, "r+");
- ```
-
-
-## fileio.fdopenStreamSync7+
-
-fdopenStreamSync\(fd: number, mode: string\): Stream
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | path | string | 是 | 待打开文件的绝对路径。 |
+ | mode | string | 是 | - r：打开只读文件，该文件必须存在。
- r+：打开可读写的文件，该文件必须存在。
- w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。
- a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。 |
+
+- 返回值：
+ | 参数名 | 说明 |
+ | -------- | -------- |
+ | [Stream](#stream7-) | 返回文件流的结果。 |
+
+- 示例：
+ ```
+ let ss = fileio.createStream(path, "r+");
+ ```
+
+
+## fileio.fdopenStreamSync7+
+
+fdopenStreamSync(fd: number, mode: string): Stream
以同步方法基于文件描述符打开文件流。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- fd
- |
- number
- |
- 是
- |
- 待打开文件的文件描述符。
- |
-
- mode
- |
- string
- |
- 是
- |
- - r：打开只读文件，该文件必须存在。
- r+：打开可读写的文件，该文件必须存在。
- w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。
- a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。
- |
-
-
-
-
-
-- 返回值：
-
-
- 参数名
- |
- 说明
- |
-
|---|
-
- Stream
- |
- 返回文件流的结果。
- |
-
-
-
-
-- 示例：
-
- ```
- let ss = fileio.fdopenStreamSync(fd, "r+");
- ```
-
-
-## fileio.fchownSync7+
-
-fchownSync\(fd: number, uid: number, gid: number\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | fd | number | 是 | 待打开文件的文件描述符。 |
+ | mode | string | 是 | - r：打开只读文件，该文件必须存在。
- r+：打开可读写的文件，该文件必须存在。
- w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。
- a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。 |
+
+- 返回值：
+ | 参数名 | 说明 |
+ | -------- | -------- |
+ | [Stream](#stream7-) | 返回文件流的结果。 |
+
+- 示例：
+ ```
+ let ss = fileio.fdopenStreamSync(fd, "r+");
+ ```
+
+
+## fileio.fchownSync7+
+
+fchownSync(fd: number, uid: number, gid: number): void
以同步方法基于文件描述符改变文件所有者。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- fd
- |
- number
- |
- 是
- |
- 待改变文件的文件描述符。
- |
-
- uid
- |
- number
- |
- 是
- |
- 文件所有者的UID。
- |
-
- gid
- |
- number
- |
- 是
- |
- 文件所有组的GID。
- |
-
-
-
-
-- 示例：
-
- ```
- let stat = fileio.statSync(fpath);
- fileio.fchownSync(fd, stat.uid, stat.gid);
- ```
-
-
-## Stat
-
-文件具体信息，在调用Stat的方法前，需要先通过[fileio.statSync](#section014281412198)来构建一个Stat实例。
-
-### 属性
-
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-dev
- |
-number
- |
-是
- |
-否
- |
-标识包含该文件的主设备号。
- |
-
-ino
- |
-number
- |
-是
- |
-否
- |
-标识该文件。通常同设备上的不同文件的INO不同。
- |
-
-mode
- |
-number
- |
-是
- |
-否
- |
-表示文件类型及权限，其首 4 位表示文件类型，后 12 位表示权限。各特征位的含义如下：
-- 0o170000：可用于获取文件类型的掩码。
- 0o140000：文件是套接字。
- 0o120000：文件是符号链接。
- 0o100000：文件是一般文件。
- 0o060000：文件属于块设备。
- 0o040000：文件是目录。
- 0o020000：文件是字符设备。
- 0o010000：文件是具名管道，即FIFO。
- 0o0700：可用于获取用户权限的掩码。
- 0o0400：用户读，对于普通文件，所有者可读取文件；对于目录，所有者可读取目录项。
- 0o0200：用户写，对于普通文件，所有者可写入文件；对于目录，所有者可创建/删除目录项。
- 0o0100：用户执行，对于普通文件，所有者可执行文件；对于目录，所有者可在目录中搜索给定路径名。
- 0o0070：可用于获取用户组权限的掩码。
- 0o0040：用户组读，对于普通文件，所有用户组可读取文件；对于目录，所有用户组可读取目录项。
- 0o0020：用户组写，对于普通文件，所有用户组可写入文件；对于目录，所有用户组可创建/删除目录项。
- 0o0010：用户组执行，对于普通文件，所有用户组可执行文件；对于目录，所有用户组是否可在目录中搜索给定路径名。
- 0o0007：可用于获取其他用户权限的掩码。
- 0o0004：其他读，对于普通文件，其余用户可读取文件；对于目录，其他用户组可读取目录项。
- 0o0002：其他写，对于普通文件，其余用户可写入文件；对于目录，其他用户组可创建/删除目录项。
- 0o0001：其他执行，对于普通文件，其余用户可执行文件；对于目录，其他用户组可在目录中搜索给定路径名。
- |
-
-nlink
- |
-number
- |
-是
- |
-否
- |
-文件的硬链接数。
- |
-
-uid
- |
-number
- |
-是
- |
-否
- |
-文件所有者的ID。
- |
-
-gid
- |
-number
- |
-是
- |
-否
- |
-文件所有组的ID。
- |
-
-rdev
- |
-number
- |
-是
- |
-否
- |
-标识包含该文件的从设备号。
- |
-
-size
- |
-number
- |
-是
- |
-否
- |
-文件的大小，以字节为单位。仅对普通文件有效。
- |
-
-blocks
- |
-number
- |
-是
- |
-否
- |
-文件占用的块数，计算时块大小按512B计算。
- |
-
-atime
- |
-number
- |
-是
- |
-否
- |
-上次访问该文件的时间，表示距1970年1月1日0时0分0秒的秒数。
- |
-
-mtime
- |
-number
- |
-是
- |
-否
- |
-上次修改该文件的时间，表示距1970年1月1日0时0分0秒的秒数。
- |
-
-ctime
- |
-number
- |
-是
- |
-否
- |
-最近改变文件状态的时间，表示距1970年1月1日0时0分0秒的秒数。
- |
-
-
-
-
-### isBlockDevice
-
-isBlockDevice\(\): boolean
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | fd | number | 是 | 待改变文件的文件描述符。 |
+ | uid | number | 是 | 文件所有者的UID。 |
+ | gid | number | 是 | 文件所有组的GID。 |
-用于判断当前目录项是否是块特殊文件。一个块特殊文件只能以块为粒度进行访问，且访问的时候带缓存。
+- 示例：
+ ```
+ let stat = fileio.statSync(fpath);
+ fileio.fchownSync(fd, stat.uid, stat.gid);
+ ```
-- 返回值：
-
- 类型
- |
- 说明
- |
-
|---|
-
- boolean
- |
- 表示当前目录项是否是块特殊设备。
- |
-
-
-
+## Stat
-- 示例：
+文件具体信息，在调用Stat的方法前，需要先通过[fileio.statSync](#fileio.statsync)来构建一个Stat实例。
- ```
- let isBLockDevice = fileio.statSync(path).isBlockDevice();
- ```
+### 属性
-### isCharacterDevice
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| dev | number | 是 | 否 | 标识包含该文件的主设备号。 |
+| ino | number | 是 | 否 | 标识该文件。通常同设备上的不同文件的INO不同。 |
+| mode | number | 是 | 否 | 表示文件类型及权限，其首 4 位表示文件类型，后 12 位表示权限。各特征位的含义如下：
- 0o170000：可用于获取文件类型的掩码。
- 0o140000：文件是套接字。
- 0o120000：文件是符号链接。
- 0o100000：文件是一般文件。
- 0o060000：文件属于块设备。
- 0o040000：文件是目录。
- 0o020000：文件是字符设备。
- 0o010000：文件是具名管道，即FIFO。
- 0o0700：可用于获取用户权限的掩码。
- 0o0400：用户读，对于普通文件，所有者可读取文件；对于目录，所有者可读取目录项。
- 0o0200：用户写，对于普通文件，所有者可写入文件；对于目录，所有者可创建/删除目录项。
- 0o0100：用户执行，对于普通文件，所有者可执行文件；对于目录，所有者可在目录中搜索给定路径名。
- 0o0070：可用于获取用户组权限的掩码。
- 0o0040：用户组读，对于普通文件，所有用户组可读取文件；对于目录，所有用户组可读取目录项。
- 0o0020：用户组写，对于普通文件，所有用户组可写入文件；对于目录，所有用户组可创建/删除目录项。
- 0o0010：用户组执行，对于普通文件，所有用户组可执行文件；对于目录，所有用户组是否可在目录中搜索给定路径名。
- 0o0007：可用于获取其他用户权限的掩码。
- 0o0004：其他读，对于普通文件，其余用户可读取文件；对于目录，其他用户组可读取目录项。
- 0o0002：其他写，对于普通文件，其余用户可写入文件；对于目录，其他用户组可创建/删除目录项。
- 0o0001：其他执行，对于普通文件，其余用户可执行文件；对于目录，其他用户组可在目录中搜索给定路径名。 |
+| nlink | number | 是 | 否 | 文件的硬链接数。 |
+| uid | number | 是 | 否 | 文件所有者的ID。 |
+| gid | number | 是 | 否 | 文件所有组的ID。 |
+| rdev | number | 是 | 否 | 标识包含该文件的从设备号。 |
+| size | number | 是 | 否 | 文件的大小，以字节为单位。仅对普通文件有效。 |
+| blocks | number | 是 | 否 | 文件占用的块数，计算时块大小按512B计算。 |
+| atime | number | 是 | 否 | 上次访问该文件的时间，表示距1970年1月1日0时0分0秒的秒数。 |
+| mtime | number | 是 | 否 | 上次修改该文件的时间，表示距1970年1月1日0时0分0秒的秒数。 |
+| ctime | number | 是 | 否 | 最近改变文件状态的时间，表示距1970年1月1日0时0分0秒的秒数。 |
-isCharacterDevice\(\): boolean
-用于判断当前目录项是否是字符特殊文件。一个字符特殊设备可进行随机访问，且访问的时候不带缓存。
+### isBlockDevice
-- 返回值：
+isBlockDevice(): boolean
-
- 类型
- |
- 说明
- |
-
|---|
-
- boolean
- |
- 表示当前目录项是否是字符特殊设备。
- |
-
-
-
+用于判断当前目录项是否是块特殊文件。一个块特殊文件只能以块为粒度进行访问，且访问的时候带缓存。
-- 示例：
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | boolean | 表示当前目录项是否是块特殊设备。 |
- ```
- let isCharacterDevice = fileio.statSync(path).isCharacterDevice();
- ```
+- 示例：
+ ```
+ let isBLockDevice = fileio.statSync(path).isBlockDevice();
+ ```
-### isDirectory
+### isCharacterDevice
-isDirectory\(\): boolean
+isCharacterDevice(): boolean
-用于判断当前目录项是否是目录。
+用于判断当前目录项是否是字符特殊文件。一个字符特殊设备可进行随机访问，且访问的时候不带缓存。
-- 返回值：
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | boolean | 表示当前目录项是否是字符特殊设备。 |
-
- 类型
- |
- 说明
- |
-
|---|
-
- boolean
- |
- 表示当前目录项是否是目录。
- |
-
-
-
+- 示例：
+ ```
+ let isCharacterDevice = fileio.statSync(path).isCharacterDevice();
+ ```
-- 示例：
- ```
- let isDirectory= fileio.statSync(path).isDirectory();
- ```
+### isDirectory
+isDirectory(): boolean
-### isFIFO
+用于判断当前目录项是否是目录。
-isFIFO\(\): boolean
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | boolean | 表示当前目录项是否是目录。 |
-用于判断当前目录项是否是命名管道（有时也称为FIFO）。命名管道通常用于进程间通信。
+- 示例：
+ ```
+ let isDirectory= fileio.statSync(path).isDirectory();
+ ```
-- 返回值：
-
- 类型
- |
- 说明
- |
-
|---|
-
- boolean
- |
- 表示当前目录项是否是 FIFO。
- |
-
-
-
+### isFIFO
-- 示例：
+isFIFO(): boolean
- ```
- let isFIFO= fileio.statSync(path).isFIFO();
- ```
+用于判断当前目录项是否是命名管道（有时也称为FIFO）。命名管道通常用于进程间通信。
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | boolean | 表示当前目录项是否是 FIFO。 |
-### isFile
+- 示例：
+ ```
+ let isFIFO= fileio.statSync(path).isFIFO();
+ ```
-isFile\(\): boolean
-用于判断当前目录项是否是普通文件。
+### isFile
-- 返回值：
+isFile(): boolean
-
- 类型
- |
- 说明
- |
-
|---|
-
- boolean
- |
- 表示当前目录项是否是普通文件。
- |
-
-
-
+用于判断当前目录项是否是普通文件。
-- 示例：
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | boolean | 表示当前目录项是否是普通文件。 |
- ```
- let isFile= fileio.statSync(fpath).isFile();
- ```
+- 示例：
+ ```
+ let isFile= fileio.statSync(fpath).isFile();
+ ```
-### isSocket
+### isSocket
-isSocket\(\): boolean
+isSocket(): boolean
用于判断当前目录项是否是套接字。
-- 返回值：
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | boolean | 表示当前目录项是否是套接字。 |
-
- 类型
- |
- 说明
- |
-
|---|
-
- boolean
- |
- 表示当前目录项是否是套接字。
- |
-
-
-
+- 示例：
+ ```
+ let isSocket = fileio.statSync(path).isSocket();
+ ```
-- 示例：
- ```
- let isSocket = fileio.statSync(path).isSocket();
- ```
+### isSymbolicLink
+isSymbolicLink(): boolean
-### isSymbolicLink
+用于判断当前目录项是否是符号链接。
-isSymbolicLink\(\): boolean
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | boolean | 表示当前目录项是否是符号链接。 |
-用于判断当前目录项是否是符号链接。
+- 示例：
+ ```
+ let isSymbolicLink = fileio.statSync(path).isSymbolicLink();
+ ```
-- 返回值：
-
- 类型
- |
- 说明
- |
-
|---|
-
- boolean
- |
- 表示当前目录项是否是符号链接。
- |
-
-
-
+## Stream7+
-- 示例：
+文件流，在调用Stream的方法前，需要先通过[fileio.createStreamSync](#fileio.createstreamsync)方法来构建一个Stream实例。
- ```
- let isSymbolicLink = fileio.statSync(path).isSymbolicLink();
- ```
+### closeSync7+
-## Stream7+
+closeSync(): void
-文件流，在调用Stream的方法前，需要先通过[fileio.createStreamSync](#section1956102153713)方法来构建一个Stream实例。
+同步关闭文件流。
-### closeSync7+
+- 示例：
+ ```
+ let ss= fileio.createStreamSync(path);
+ ss.closeSync();
+ ```
-closeSync\(\): void
-同步关闭文件流。
+### flushSync7+
-- 示例：
+flushSync(): void
- ```
- let ss= fileio.createStreamSync(path);
- ss.closeSync();
- ```
+同步刷新文件流。
+- 示例：
+ ```
+ let ss= fileio.createStreamSync(path);
+ ss.flushSync();
+ ```
-### flushSync7+
-flushSync\(\): void
+### writeSync7+
-同步刷新文件流。
+writeSync(buffer: ArrayBuffer | string, options?:Object): number
-- 示例：
+以同步方法将数据写入流文件。
- ```
- let ss= fileio.createStreamSync(path);
- ss.flushSync();
- ```
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | buffer | ArrayBuffer \| string | 是 | 待写入文件的数据，可来自缓冲区或字符串。 |
+ | options | Object | 否 | 支持如下选项：
- offset，number类型，表示期望写入数据的位置相对于数据首地址的偏移。可选，默认为0。
- length，number类型，表示期望写入数据的长度。可选，默认缓冲区长度减去偏移长度。
- position，number类型，表示期望写入文件的位置。可选，默认从当前位置开始写。
- encoding，string类型，当数据是 string 类型时有效，表示数据的编码方式，默认 'utf-8'，仅支持 'utf-8'。 |
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | number | 实际写入的长度。 |
-### writeSync7+
+- 示例：
+ ```
+ let ss= fileio.createStreamSync(fpath,"r+");
+ ss.writeSync("hello, world",{offset: 1,length: 5,position: 5,encoding :'utf-8'});
+ ```
-writeSync\(buffer: ArrayBuffer | string, options?:Object\): number
-以同步方法将数据写入流文件。
+### readSync7+
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- buffer
- |
- ArrayBuffer | string
- |
- 是
- |
- 待写入文件的数据，可来自缓冲区或字符串。
- |
-
- options
- |
- Object
- |
- 否
- |
- 支持如下选项：
- - offset，number类型，表示期望写入数据的位置相对于数据首地址的偏移。可选，默认为0。
- length，number类型，表示期望写入数据的长度。可选，默认缓冲区长度减去偏移长度。
- position，number类型，表示期望写入文件的位置。可选，默认从当前位置开始写。
- encoding，string类型，当数据是 string 类型时有效，表示数据的编码方式，默认 'utf-8'，仅支持 'utf-8'。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- number
- |
- 实际写入的长度。
- |
-
-
-
-
-- 示例：
-
- ```
- let ss= fileio.createStreamSync(fpath,"r+");
- ss.writeSync("hello, world",{offset: 1,length: 5,position: 5,encoding :'utf-8'});
- ```
-
-
-### readSync7+
-
-readSync\(buffer: ArrayBuffer, options?: Object\): number
+readSync(buffer: ArrayBuffer, options?: Object): number
以同步方法从流文件读取数据。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- buffer
- |
- ArrayBuffer
- |
- 是
- |
- 用于读取文件的缓冲区。
- |
-
- options
- |
- Object
- |
- 否
- |
- 支持如下选项：
- - offset，number 类型，表示将数据读取到缓冲区的位置，即相对于缓冲区首地址的偏移。可选，默认为0。
- length，number 类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
- position，number 类型，表示期望读取文件的位置。可选，默认从当前位置开始读。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- number
- |
- 实际读取的长度。
- |
-
-
-
-
-- 示例：
-
- ```
- let ss = fileio.createStreamSync(fpath, "r+");
- ss.readSync(new ArrayBuffer(4096),{offset: 1,length: FILE_CONTENT.length,position: 5});
- ```
-
-
-## Dir
-
-管理目录，在调用Dir的方法前，需要先通过[fileio.opendirSync](#section7741145112216)方法来构建一个Dir实例。
-
-### readSync
-
-readSync\(\): Dirent
-
-同步读取下一个目录项。
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | buffer | ArrayBuffer | 是 | 用于读取文件的缓冲区。 |
+ | options | Object | 否 | 支持如下选项：
- offset，number 类型，表示将数据读取到缓冲区的位置，即相对于缓冲区首地址的偏移。可选，默认为0。
- length，number 类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
- position，number 类型，表示期望读取文件的位置。可选，默认从当前位置开始读。 |
-- 返回值：
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | number | 实际读取的长度。 |
-
- 类型
- |
- 说明
- |
-
|---|
-
- Dirent
- |
- 表示一个目录项。
- |
-
-
-
+- 示例：
+ ```
+ let ss = fileio.createStreamSync(fpath, "r+");
+ ss.readSync(new ArrayBuffer(4096),{offset: 1,length: FILE_CONTENT.length,position: 5});
+ ```
-- 示例：
- ```
- let dir = fileio.opendirSync(dpath);
- let dirent = dir.readSync();
- console.log(dirent.name);
- ```
+## Dir
+管理目录，在调用Dir的方法前，需要先通过[fileio.opendirSync](#fileio.opendirsync)方法来构建一个Dir实例。
-### closeSync
-closeSync\(\): void
+### readSync
-用于关闭目录。目录被关闭后，Dir中持有的文件描述将被释放，后续将无法从Dir中读取目录项。
+readSync(): Dirent
-- 示例：
-
- ```
- let dir = fileio.opendirSync(dpath);
- dir.closeSync();
- ```
-
-
-## Dirent
-
-在调用Dirent的方法前，需要先通过[readSync](#section10198204912710)方法来构建一个Dirent实例。
-
-### 属性
-
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-name
- |
-string
- |
-是
- |
-否
- |
-目录项的名称。
- |
-
-
-
-
-### isBlockDevice
-
-isBlockDevice\(\): boolean
+同步读取下一个目录项。
-用于判断当前目录项是否是块特殊文件。一个块特殊文件只能以块为粒度进行访问，且访问的时候带缓存。
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [Dirent](#dirent) | 表示一个目录项。 |
-- 返回值：
+- 示例：
+ ```
+ let dir = fileio.opendirSync(dpath);
+ let dirent = dir.readSync();
+ console.log(dirent.name);
+ ```
-
- 类型
- |
- 说明
- |
-
|---|
-
- boolean
- |
- 表示当前目录项是否是块特殊设备。
- |
-
-
-
-- 示例：
+### closeSync
- ```
- let dir = fileio.opendirSync(dpath);
- let isBLockDevice = dir.readSync().isBlockDevice();
- ```
+closeSync(): void
+用于关闭目录。目录被关闭后，Dir中持有的文件描述将被释放，后续将无法从Dir中读取目录项。
-### isCharacterDevice
+- 示例：
+ ```
+ let dir = fileio.opendirSync(dpath);
+ dir.closeSync();
+ ```
-isCharacterDevice\(\): boolean
-用于判断当前目录项是否是字符特殊设备。一个字符特殊设备可进行随机访问，且访问的时候不带缓存。
+## Dirent
-- 返回值：
+在调用Dirent的方法前，需要先通过[readSync](#readsync)方法来构建一个Dirent实例。
-
- 类型
- |
- 说明
- |
-
|---|
-
- boolean
- |
- 表示当前目录项是否是字符特殊设备。
- |
-
-
-
-- 示例：
+### 属性
- ```
- let dir = fileio.opendirSync(dpath);
- let isCharacterDevice = dir.readSync().isCharacterDevice();
- ```
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| name | string | 是 | 否 | 目录项的名称。 |
-### isDirectory
+### isBlockDevice
-isDirectory\(\): boolean
+isBlockDevice(): boolean
-用于判断当前目录项是否是目录。
+用于判断当前目录项是否是块特殊文件。一个块特殊文件只能以块为粒度进行访问，且访问的时候带缓存。
-- 返回值：
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | boolean | 表示当前目录项是否是块特殊设备。 |
-
- 类型
- |
- 说明
- |
-
|---|
-
- boolean
- |
- 表示当前目录项是否是目录。
- |
-
-
-
+- 示例：
+ ```
+ let dir = fileio.opendirSync(dpath);
+ let isBLockDevice = dir.readSync().isBlockDevice();
+ ```
-- 示例：
- ```
- let dir = fileio.opendirSync(dpath);
- let isDirectory = dir.readSync().isDirectory();
- ```
+### isCharacterDevice
+isCharacterDevice(): boolean
-### isFIFO
+用于判断当前目录项是否是字符特殊设备。一个字符特殊设备可进行随机访问，且访问的时候不带缓存。
-isFIFO\(\): boolean
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | boolean | 表示当前目录项是否是字符特殊设备。 |
-用于判断当前目录项是否是命名管道（有时也称为FIFO）。命名管道通常用于进程间通信。
+- 示例：
+ ```
+ let dir = fileio.opendirSync(dpath);
+ let isCharacterDevice = dir.readSync().isCharacterDevice();
+ ```
-- 返回值：
-
- 类型
- |
- 说明
- |
-
|---|
-
- boolean
- |
- 表示当前目录项是否是FIFO。
- |
-
-
-
+### isDirectory
-- 示例：
+isDirectory(): boolean
- ```
- let dir = fileio.opendirSync(dpath);
- let isFIFO = dir.readSync().isFIFO();
- ```
+用于判断当前目录项是否是目录。
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | boolean | 表示当前目录项是否是目录。 |
-### isFile
+- 示例：
+ ```
+ let dir = fileio.opendirSync(dpath);
+ let isDirectory = dir.readSync().isDirectory();
+ ```
-isFile\(\): boolean
-用于判断当前目录项是否是普通文件。
+### isFIFO
-- 返回值：
+isFIFO(): boolean
-
- 类型
- |
- 说明
- |
-
|---|
-
- boolean
- |
- 表示当前目录项是否是普通文件。
- |
-
-
-
+用于判断当前目录项是否是命名管道（有时也称为FIFO）。命名管道通常用于进程间通信。
-- 示例：
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | boolean | 表示当前目录项是否是FIFO。 |
- ```
- let dir = fileio.opendirSync(dpath);
- let isFile = dir.readSync().isFile();
- ```
+- 示例：
+ ```
+ let dir = fileio.opendirSync(dpath);
+ let isFIFO = dir.readSync().isFIFO();
+ ```
-### isSocket
+### isFile
-isSocket\(\): boolean
+isFile(): boolean
-用于判断当前目录项是否是套接字。
+用于判断当前目录项是否是普通文件。
-- 返回值：
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | boolean | 表示当前目录项是否是普通文件。 |
-
- 类型
- |
- 说明
- |
-
|---|
-
- boolean
- |
- 表示当前目录项是否是套接字。
- |
-
-
-
+- 示例：
+ ```
+ let dir = fileio.opendirSync(dpath);
+ let isFile = dir.readSync().isFile();
+ ```
-- 示例：
- ```
- let dir = fileio.opendirSync(dpath);
- let isSocket = dir.readSync().isSocket();
- ```
+### isSocket
+isSocket(): boolean
-### isSymbolicLink
+用于判断当前目录项是否是套接字。
-isSymbolicLink\(\): boolean
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | boolean | 表示当前目录项是否是套接字。 |
-用于判断当前目录项是否是符号链接。
+- 示例：
+ ```
+ let dir = fileio.opendirSync(dpath);
+ let isSocket = dir.readSync().isSocket();
+ ```
-- 返回值：
-
- 类型
- |
- 说明
- |
-
|---|
-
- boolean
- |
- 表示当前目录项是否是符号链接。
- |
-
-
-
+### isSymbolicLink
-- 示例：
+isSymbolicLink(): boolean
- ```
- let dir = fileio.opendirSync(dpath);
- let isSymbolicLink = dir.readSync().isSymbolicLink();
- ```
+用于判断当前目录项是否是符号链接。
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | boolean | 表示当前目录项是否是符号链接。 |
+- 示例：
+ ```
+ let dir = fileio.opendirSync(dpath);
+ let isSymbolicLink = dir.readSync().isSymbolicLink();
+ ```
diff --git a/zh-cn/application-dev/reference/apis/js-apis-hiappevent.md b/zh-cn/application-dev/reference/apis/js-apis-hiappevent.md
index a1a318bf9dda1aeef0301d5a81a437a52777bc38..e0d5f8e146e5df63023b67a078e0c7d5edcb34a3 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-hiappevent.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-hiappevent.md
@@ -1,423 +1,150 @@
-# 应用打点
+# 应用打点
-> **说明：**
->从 API Version 7 开始支持。
+>  **说明：**
+> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
-## 导入模块
+
+## 导入模块
```
import hiAppEvent from '@ohos.hiAppEvent';
```
-## 权限
+
+## 权限
无
-## hiAppEvent.write
-write\(eventName: string, eventType: EventType, keyValues: object, callback: AsyncCallback\): void
+## hiAppEvent.write
+
+write(eventName: string, eventType: EventType, keyValues: object, callback: AsyncCallback<void>): void
应用事件打点方法，将事件写入到当天的事件文件中，可接收类型为Json对象的事件参数，使用callback方式作为异步回调。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- eventName
- |
- string
- |
- 是
- |
- 应用事件名称。
- |
-
- eventType
- |
- EventType
- |
- 是
- |
- 应用事件类型。
- |
-
- keyValues
- |
- object
- |
- 是
- |
- 应用事件的参数，key类型只能为string，value类型只能为string、number、boolean、Array（数组数据类型只能为string、number、boolean）。
- |
-
- callback
- |
- AsyncCallback<void>
- |
- 否
- |
- 回调函数，可以在回调函数中处理接口返回值。
- - 返回值为0表示事件校验成功，事件正常异步写入事件文件；
- 大于0表示事件校验存在异常参数，在忽略异常参数后将事件异步写入事件文件；
- 小于0表示事件校验失败，不将事件写入事件文件。
- |
-
-
-
-
-- 示例：
-
- ```
- hiAppEvent.write("test_event", hiAppEvent.EventType.FAULT, {"int_data":100, "str_data":"strValue"}, (err, value) => {
- if (err) {
- // 事件写入异常：事件存在异常参数时忽略异常参数后继续写入，或者事件校验失败时不执行写入
- console.error(`failed to write event because ${err.code}`);
- return;
- }
-
- // 事件写入正常
- console.log(`success to write event: ${value}`);
- });
- ```
-
-
-## hiAppEvent.write
-
-write\(eventName: string, eventType: EventType, keyValues: object\): Promise
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | eventName | string | 是 | 应用事件名称。 |
+ | eventType | [EventType](#eventtype) | 是 | 应用事件类型。 |
+ | keyValues | object | 是 | 应用事件的参数，key类型只能为string，value类型只能为string、number、boolean、Array（数组数据类型只能为string、number、boolean）。 |
+ | callback | AsyncCallback<void> | 否 | 回调函数，可以在回调函数中处理接口返回值。
- 返回值为0表示事件校验成功，事件正常异步写入事件文件；
- 大于0表示事件校验存在异常参数，在忽略异常参数后将事件异步写入事件文件；
- 小于0表示事件校验失败，不将事件写入事件文件。 |
+
+- 示例：
+ ```
+ hiAppEvent.write("test_event", hiAppEvent.EventType.FAULT, {"int_data":100, "str_data":"strValue"}, (err, value) => {
+ if (err) {
+ // 事件写入异常：事件存在异常参数时忽略异常参数后继续写入，或者事件校验失败时不执行写入
+ console.error(`failed to write event because ${err.code}`);
+ return;
+ }
+
+ // 事件写入正常
+ console.log(`success to write event: ${value}`);
+ });
+ ```
+
+
+## hiAppEvent.write
+
+write(eventName: string, eventType: EventType, keyValues: object): Promise<void>
应用事件打点方法，将事件写入到当天的事件文件中，可接收类型为Json对象的事件参数，使用promise方式作为异步回调。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- eventName
- |
- string
- |
- 是
- |
- 应用事件名称。
- |
-
- eventType
- |
- EventType
- |
- 是
- |
- 应用事件类型。
- |
-
- keyValues
- |
- object
- |
- 是
- |
- 应用事件的参数，key类型只能为string，value类型只能为string、number、boolean、Array（数组数据类型只能为string、number、boolean）。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<void>
- |
- Promise实例，可以在其then()、catch()方法中分别对事件写入成功、写入异常的情况进行回调处理。
- |
-
-
-
-
-- 示例：
-
- ```
- hiAppEvent.write("test_event", hiAppEvent.EventType.FAULT, {"int_data":100, "str_data":"strValue"})
- .then((value) => {
- // 事件写入正常
- console.log(`success to write event: ${value}`);
- }).catch((err) => {
- // 事件写入异常：事件存在异常参数时忽略异常参数后继续写入，或者事件校验失败时不执行写入
- console.error(`failed to write event because ${err.code}`);
- });
- ```
-
-
-## hiAppEvent.configure
-
-configure\(config: ConfigOption\): boolean
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | eventName | string | 是 | 应用事件名称。 |
+ | eventType | [EventType](#eventtype) | 是 | 应用事件类型。 |
+ | keyValues | object | 是 | 应用事件的参数，key类型只能为string，value类型只能为string、number、boolean、Array（数组数据类型只能为string、number、boolean）。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<void> | Promise实例，可以在其then()、catch()方法中分别对事件写入成功、写入异常的情况进行回调处理。 |
+
+- 示例：
+ ```
+ hiAppEvent.write("test_event", hiAppEvent.EventType.FAULT, {"int_data":100, "str_data":"strValue"})
+ .then((value) => {
+ // 事件写入正常
+ console.log(`success to write event: ${value}`);
+ }).catch((err) => {
+ // 事件写入异常：事件存在异常参数时忽略异常参数后继续写入，或者事件校验失败时不执行写入
+ console.error(`failed to write event because ${err.code}`);
+ });
+ ```
+
+
+## hiAppEvent.configure
+
+configure(config: ConfigOption): boolean
应用事件打点配置方法，可用于配置打点开关、文件目录存储限额大小等功能。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- config
- |
- ConfigOption
- |
- 是
- |
- 应用事件打点配置项对象。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- boolean
- |
- 配置结果，true 表示配置成功，false 表示配置失败。
- |
-
-
-
-
-- 示例：
-
- ```
- // 配置应用事件打点功能开关
- hiAppEvent.configure({
- disable: true
- });
-
- // 配置事件文件目录存储限额大小
- hiAppEvent.configure({
- maxStorage: '100M'
- });
- ```
-
-
-## ConfigOption
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | config | [ConfigOption](#configoption) | 是 | 应用事件打点配置项对象。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | boolean | 配置结果，true 表示配置成功，false 表示配置失败。 |
+
+- 示例：
+ ```
+ // 配置应用事件打点功能开关
+ hiAppEvent.configure({
+ disable: true
+ });
+
+ // 配置事件文件目录存储限额大小
+ hiAppEvent.configure({
+ maxStorage: '100M'
+ });
+ ```
+
+
+## ConfigOption
此接口提供了应用打点的配置选项。
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-disable
- |
-boolean
- |
-否
- |
-应用打点功能开关。配置值为true表示关闭打点功能，false表示不关闭打点功能。
- |
-
-maxStorage
- |
-string
- |
-否
- |
-打点数据本地存储文件所在目录的配额大小，默认限额为“10M”。所在目录大小超出限额后会对目录进行清理操作，会按从旧到新的顺序逐个删除打点数据文件，直到目录大小不超出限额时停止。
- |
-
-
-
-
-## EventType
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | -------- | -------- | -------- |
+| disable | boolean | 否 | 应用打点功能开关。配置值为true表示关闭打点功能，false表示不关闭打点功能。 |
+| maxStorage | string | 否 | 打点数据本地存储文件所在目录的配额大小，默认限额为“10M”。所在目录大小超出限额后会对目录进行清理操作，会按从旧到新的顺序逐个删除打点数据文件，直到目录大小不超出限额时停止。 |
+
+
+## EventType
事件类型枚举。
-
-名称
- |
-默认值
- |
-说明
- |
-
|---|
-
-FAULT
- |
-1
- |
-故障类型事件。
- |
-
-STATISTIC
- |
-2
- |
-统计类型事件。
- |
-
-SECURITY
- |
-3
- |
-安全类型事件。
- |
-
-BEHAVIOR
- |
-4
- |
-行为类型事件。
- |
-
-
-
-
-## Event
+| 名称 | 默认值 | 说明 |
+| -------- | -------- | -------- |
+| FAULT | 1 | 故障类型事件。 |
+| STATISTIC | 2 | 统计类型事件。 |
+| SECURITY | 3 | 安全类型事件。 |
+| BEHAVIOR | 4 | 行为类型事件。 |
+
+
+## Event
此接口提供了所有预定义事件的事件名称常量。
-### 属性
-
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-USER_LOGIN
- |
-string
- |
-是
- |
-否
- |
-用户登录事件。
- |
-
-USER_LOGOUT
- |
-string
- |
-是
- |
-否
- |
-用户登出事件。
- |
-
-DISTRIBUTED_SERVICE_START
- |
-string
- |
-是
- |
-否
- |
-分布式服务启动事件。
- |
-
-
-
-
-## Param
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| USER_LOGIN | string | 是 | 否 | 用户登录事件。 |
+| USER_LOGOUT | string | 是 | 否 | 用户登出事件。 |
+| DISTRIBUTED_SERVICE_START | string | 是 | 否 | 分布式服务启动事件。 |
-此接口提供了所有预定义参数的参数名称常量。
-### 属性
-
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-USER_ID
- |
-string
- |
-是
- |
-否
- |
-用户自定义ID。
- |
-
-DISTRIBUTED_SERVICE_NAME
- |
-string
- |
-是
- |
-否
- |
-分布式服务名称。
- |
-
-DISTRIBUTED_SERVICE_INSTANCE_ID
- |
-string
- |
-是
- |
-否
- |
-分布式服务实例ID。
- |
-
-
-
+## Param
+
+此接口提供了所有预定义参数的参数名称常量。
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| USER_ID | string | 是 | 否 | 用户自定义ID。 |
+| DISTRIBUTED_SERVICE_NAME | string | 是 | 否 | 分布式服务名称。 |
+| DISTRIBUTED_SERVICE_INSTANCE_ID | string | 是 | 否 | 分布式服务实例ID。 |
diff --git a/zh-cn/application-dev/reference/apis/js-apis-i18n.md b/zh-cn/application-dev/reference/apis/js-apis-i18n.md
index a36ee6dad7efca3aefcd44db6320b32ab122b390..cda606534f085f5aac08401c6634ac652142c335 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-i18n.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-i18n.md
@@ -1,253 +1,119 @@
-# 国际化（I18n）
+# 国际化-I18n
-> **说明：**
->从 API Version 7 开始支持。
+>  **说明：**
+> - 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
+>
+> - I18N模块包含国际化能力增强接口（未在ECMA 402中定义）。
-## 导入模块
+
+## 导入模块
```
import i18n from '@ohos.i18n';
```
-## 权限
+
+## 权限
无
-## i18n.getDisplayLanguage
-getDisplayLanguage\(language: string, locale: string, sentenceCase?: boolean\): string
+## i18n.getDisplayLanguage
+
+getDisplayLanguage(language: string, locale: string, sentenceCase?: boolean): string
获取指定语言的本地化显示文本。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- language
- |
- string
- |
- 是
- |
- 指定语言
- |
-
- locale
- |
- string
- |
- 是
- |
- 显示指定语言的区域ID
- |
-
- sentenceCase
- |
- boolean
- |
- 否
- |
- 本地化显示文本是否要首字母大写
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- string
- |
- 指定语言的本地化显示文本
- |
-
-
-
-
-- 示例：
-
- ```
- i18n.getDisplayLanguage("zh", "en-GB", true);
- i18n.getDisplayLanguage("zh", "en-GB");
- ```
-
-
-## i18n.getDisplayCountry
-
-getDisplayCountry\(country: string, locale: string, sentenceCase?: boolean\): string
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | language | string | 是 | 指定语言 |
+ | locale | string | 是 | 显示指定语言的区域ID |
+ | sentenceCase | boolean | 否 | 本地化显示文本是否要首字母大写 |
-获取指定国家的本地化显示文本。
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | string | 指定语言的本地化显示文本 |
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- country
- |
- string
- |
- 是
- |
- 指定国家
- |
-
- locale
- |
- string
- |
- 是
- |
- 显示指定国家的区域ID
- |
-
- sentenceCase
- |
- boolean
- |
- 否
- |
- 本地化显示文本是否要首字母大写
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- string
- |
- 指定国家的本地化显示文本
- |
-
-
-
-
-- 示例：
-
- ```
- i18n.getDisplayCountry("zh-CN", "en-GB", true);
- i18n.getDisplayCountry("zh-CN", "en-GB");
- ```
-
-
-## i18n.getSystemLanguage
-
-getSystemLanguage\(\): string
+- 示例：
+ ```
+ i18n.getDisplayLanguage("zh", "en-GB", true);
+ i18n.getDisplayLanguage("zh", "en-GB");
+ ```
-获取系统语言。
-- 返回值：
+## i18n.getDisplayCountry
-
- 类型
- |
- 说明
- |
-
|---|
-
- string
- |
- 系统语言ID
- |
-
-
-
+getDisplayCountry(country: string, locale: string, sentenceCase?: boolean): string
-- 示例：
+获取指定国家的本地化显示文本。
- ```
- i18n.getSystemLanguage();
- ```
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | country | string | 是 | 指定国家 |
+ | locale | string | 是 | 显示指定国家的区域ID |
+ | sentenceCase | boolean | 否 | 本地化显示文本是否要首字母大写 |
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | string | 指定国家的本地化显示文本 |
-## i18n.getSystemRegion
+- 示例：
+ ```
+ i18n.getDisplayCountry("zh-CN", "en-GB", true);
+ i18n.getDisplayCountry("zh-CN", "en-GB");
+ ```
-getSystemRegion\(\): string
-获取系统地区。
+## i18n.getSystemLanguage
-- 返回值：
+getSystemLanguage(): string
-
- 类型
- |
- 说明
- |
-
|---|
-
- string
- |
- 系统地区ID
- |
-
-
-
+获取系统语言。
-- 示例：
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | string | 系统语言ID |
- ```
- i18n.getSystemRegion();
- ```
+- 示例：
+ ```
+ i18n.getSystemLanguage();
+ ```
-## i18n.getSystemLocale
+## i18n.getSystemRegion
-getSystemLocale\(\): string
+getSystemRegion(): string
-获取系统区域。
+获取系统地区。
-- 返回值：
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | string | 系统地区ID |
-
- 类型
- |
- 说明
- |
-
|---|
-
- string
- |
- 系统区域ID
- |
-
-
-
+- 示例：
+ ```
+ i18n.getSystemRegion();
+ ```
-- 示例：
- ```
- i18n.getSystemLocale();
- ```
+## i18n.getSystemLocale
+
+getSystemLocale(): string
+
+获取系统区域。
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | string | 系统区域ID |
+- 示例：
+ ```
+ i18n.getSystemLocale();
+ ```
diff --git a/zh-cn/application-dev/reference/apis/js-apis-intl.md b/zh-cn/application-dev/reference/apis/js-apis-intl.md
index ebfc69390e7a1b43fe0a6fc21a67c76d6e3cbdb4..bed5a28c1e7f369ebb1e7fd75fe546c7492a6a96 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-intl.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-intl.md
@@ -1,1182 +1,357 @@
-# 国际化（Intl）
+# 国际化-Intl
-> **说明：**
->从 API Version 6 开始支持。
+>  **说明：**
+> - 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
+>
+> - Intl模块包含国际化能力基础接口（在ECMA 402中定义）。
-## 导入模块
+
+## 导入模块
```
-import intl from '@ohos.intl';
+import Intl from '@ohos.intl';
```
-## 权限
+
+## 权限
无
-## Locale
-
-### 属性
-
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-language
- |
-string
- |
-是
- |
-否
- |
-与区域设置关联的语言
- |
-
-script
- |
-string
- |
-是
- |
-否
- |
-语言的书写方式
- |
-
-region
- |
-string
- |
-是
- |
-否
- |
-与区域设置相关的地区
- |
-
-baseName
- |
-string
- |
-是
- |
-否
- |
-Locale的基本核心信息
- |
-
-caseFirst
- |
-string
- |
-是
- |
-否
- |
-区域的整理规则是否考虑大小写
- |
-
-calendar
- |
-string
- |
-是
- |
-否
- |
-区域的日历信息
- |
-
-collation
- |
-string
- |
-是
- |
-否
- |
-区域的排序规则
- |
-
-hourCycle
- |
-string
- |
-是
- |
-否
- |
-区域的时制信息
- |
-
-numberingSystem
- |
-string
- |
-是
- |
-否
- |
-区域使用的数字系统
- |
-
-numeric
- |
-boolean
- |
-是
- |
-否
- |
-是否对数字字符具有特殊的排序规则处理
- |
-
-
-
-
-### constructor
-
-constructor\(locale: string, options?:options\)
+
+## Locale
+
+
+### 属性
+
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| language | string | 是 | 否 | 与区域设置关联的语言 |
+| script | string | 是 | 否 | 语言的书写方式 |
+| region | string | 是 | 否 | 与区域设置相关的地区 |
+| baseName | string | 是 | 否 | Locale的基本核心信息 |
+| caseFirst | string | 是 | 否 | 区域的整理规则是否考虑大小写 |
+| calendar | string | 是 | 否 | 区域的日历信息 |
+| collation | string | 是 | 否 | 区域的排序规则 |
+| hourCycle | string | 是 | 否 | 区域的时制信息 |
+| numberingSystem | string | 是 | 否 | 区域使用的数字系统 |
+| numeric | boolean | 是 | 否 | 是否对数字字符具有特殊的排序规则处理 |
+
+
+### constructor
+
+constructor(locale: string, options?:options)
创建区域对象
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- locale
- |
- string
- |
- 是
- |
- 包含区域设置信息的字符串，包括语言以及可选的脚本和区域。
- |
-
- options
- |
- options
- |
- 否
- |
- 用于创建区域对象的选项。
- |
-
-
-
-
-
-- 示例：
-
- ```
- var locale = new Locale("zh-CN");
- ```
-
-
-### toString
-
-toString\(\): string
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | locale | string | 是 | 包含区域设置信息的字符串，包括语言以及可选的脚本和区域。 |
+ | options | options | 否 | 用于创建区域对象的选项。 |
-将区域信息转换为字符串
+- 示例：
+ ```
+ var locale = new Intl.Locale("zh-CN");
+ ```
-- 返回值：
-
- 类型
- |
- 说明
- |
-
|---|
-
- string
- |
- 字符串形式的区域信息
- |
-
-
-
+### toString
+toString(): string
-- 示例：
+将区域信息转换为字符串
- ```
- var locale = new Locale("zh-CN");
- locale.toString();
- ```
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | string | 字符串形式的区域信息 |
-### maximize
+- 示例：
+ ```
+ var locale = new Intl.Locale("zh-CN");
+ locale.toString();
+ ```
-maximize\(\): Locale
-最大化区域信息，若缺少脚本与地区信息，则补齐。
+### maximize
-- 返回值：
+maximize(): Locale
-
- 类型
- |
- 说明
- |
-
|---|
-
- Locale
- |
- 最大化后的区域对象
- |
-
-
-
+最大化区域信息，若缺少脚本与地区信息，则补齐。
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Locale | 最大化后的区域对象 |
-- 示例：
- ```
- var locale = new Locale("zh-CN");
- locale.maximize();
- ```
+- 示例：
+ ```
+ var locale = new Intl.Locale("zh-CN");
+ locale.maximize();
+ ```
-### minimize
+### minimize
-minimize\(\): Locale
+minimize(): Locale
最小化区域信息，若包含脚本与地区信息，则去除。
-- 返回值：
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Locale | 最小化后的区域对象 |
-
- 类型
- |
- 说明
- |
-
|---|
-
- Locale
- |
- 最小化后的区域对象
- |
-
-
-
+- 示例：
+ ```
+ var locale = new Intl.Locale("zh-CN");
+ locale.minimize();
+ ```
-- 示例：
- ```
- var locale = new Locale("zh-CN");
- locale.minimize();
- ```
+## DateTimeFormat
-## DateTimeFormat
+### constructor
-### constructor
-
-constructor\(locale: string, options?:DateTimeOptions\)
+constructor(locale: string, options?:DateTimeOptions)
创建时间日期格式化对象。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- locale
- |
- string
- |
- 是
- |
- 包含区域设置信息的字符串，包括语言以及可选的脚本和区域。
- |
-
- options
- |
- DateTimeOptions
- |
- 否
- |
- 用于创建时间日期格式化的选项。
- |
-
-
-
-
-
-- 示例：
-
- ```
- var datefmt= new DateTimeFormat("zh-CN", { dateStyle: 'full', timeStyle: 'medium' });
- ```
-
-
-### constructor
-
-constructor\(locales: Array, options?:DateTimeOptions\)
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | locale | string | 是 | 包含区域设置信息的字符串，包括语言以及可选的脚本和区域。 |
+ | options | [DateTimeOptions](#datetimeoptions) | 否 | 用于创建时间日期格式化的选项。 |
+
+- 示例：
+ ```
+ var datefmt= new Intl.DateTimeFormat("zh-CN", { dateStyle: 'full', timeStyle: 'medium' });
+ ```
+
+
+### constructor
+
+constructor(locales: Array<string>, options?:DateTimeOptions)
创建时间日期格式化对象。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- locales
- |
- Array<string>
- |
- 是
- |
- 包含区域设置信息的字符串的数组。
- |
-
- options
- |
- DateTimeOptions
- |
- 否
- |
- 用于创建时间日期格式化的选项。
- |
-
-
-
-
-
-- 示例：
-
- ```
- var datefmt= new DateTimeFormat(["ban", "zh"], { dateStyle: 'full', timeStyle: 'medium' });
- ```
-
-
-### format
-
-format\(date: Date\): string;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | locales | Array<string> | 是 | 包含区域设置信息的字符串的数组。 |
+ | options | [DateTimeOptions](#datetimeoptions) | 否 | 用于创建时间日期格式化的选项。 |
+
+- 示例：
+ ```
+ var datefmt= new Intl.DateTimeFormat(["ban", "zh"], { dateStyle: 'full', timeStyle: 'medium' });
+ ```
+
+
+### format
+
+format(date: Date): string;
格式化时间日期字符串。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- date
- |
- Date
- |
- 是
- |
- 时间日期对象。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- string
- |
- 格式化后的时间日期字符串
- |
-
-
-
-
-
-- 示例：
-
- ```
- var date = new Date(2021, 11, 17, 3, 24, 0);
- var datefmt = new Intl.DateTimeFormat("en-GB");
- datefmt.format(date);
- ```
-
-
-### formatRange
-
-formatRange\(fromDate: Date, toDate: Date\): string;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | date | Date | 是 | 时间日期对象。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | string | 格式化后的时间日期字符串 |
+
+
+- 示例：
+ ```
+ var date = new Date(2021, 11, 17, 3, 24, 0);
+ var datefmt = new Intl.DateTimeFormat("en-GB");
+ datefmt.format(date);
+ ```
+
+
+### formatRange
+
+formatRange(fromDate: Date, toDate: Date): string;
格式化时间日期段字符串。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- startDate
- |
- Date
- |
- 是
- |
- 起始的时间日期
- |
-
- endDate
- |
- Date
- |
- 是
- |
- 结束的时间日期
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- string
- |
- 格式化后的时间日期段字符串
- |
-
-
-
-
-
-- 示例：
-
- ```
- var startDate = new Date(2021, 11, 17, 3, 24, 0);
- var endDate = new Date(2021, 11, 18, 3, 24, 0);
- var datefmt = new Intl.DateTimeFormat("en-GB");
- datefmt.formatRange(startDate, endDate);
- ```
-
-
-### resolvedOptions
-
-resolvedOptions\(\): DateTimeOptions
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | startDate | Date | 是 | 起始的时间日期 |
+ | endDate | Date | 是 | 结束的时间日期 |
-获取DateTimeFormat 对象的格式化选项。
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | string | 格式化后的时间日期段字符串 |
+
+
+- 示例：
+ ```
+ var startDate = new Date(2021, 11, 17, 3, 24, 0);
+ var endDate = new Date(2021, 11, 18, 3, 24, 0);
+ var datefmt = new Intl.DateTimeFormat("en-GB");
+ datefmt.formatRange(startDate, endDate);
+ ```
-- 返回值：
-
-
+### resolvedOptions
+resolvedOptions(): DateTimeOptions
+
+获取DateTimeFormat 对象的格式化选项。
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [DateTimeOptions](#datetimeoptions) | DateTimeFormat 对象的格式化选项。 |
-- 示例：
- ```
- var datefmt = new Intl.DateTimeFormat("en-GB");
- datefmt.resolvedOptions();
- ```
+- 示例：
+ ```
+ var datefmt = new Intl.DateTimeFormat("en-GB");
+ datefmt.resolvedOptions();
+ ```
-## NumberFormat
+## NumberFormat
-### constructor
-constructor\(locale: string, options?:NumberOptions\)
+### constructor
+
+constructor(locale: string, options?:NumberOptions)
创建数字格式化对象。
参数：
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | -------- | -------- | -------- |
+| locale | string | 是 | 包含区域设置信息的字符串，包括语言以及可选的脚本和区域。 |
+| options | [NumberOptions](#numberoptions) | 否 | 用于创建数字格式化的选项。 |
+
+- 示例：
+ ```
+ var numfmt = new Intl.NumberFormat("en-GB", {style:'decimal', notation:"scientific"});
+ ```
+
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-locale
- |
-string
- |
-是
- |
-包含区域设置信息的字符串，包括语言以及可选的脚本和区域。
- |
-
-options
- |
-NumberOptions
- |
-否
- |
-用于创建数字格式化的选项。
- |
-
-
-
-
-- 示例：
-
- ```
- var numfmt = new Intl.NumberFormat("en-GB", {style:'decimal', notation:"scientific"});
- ```
-
-
-### constructor
-
-constructor\(locales: Array, options?:NumberOptions\)
+### constructor
+
+constructor(locales: Array<string>, options?:NumberOptions)
创建数字格式化对象。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- locales
- |
- Array<string>
- |
- 是
- |
- 包含区域设置信息的字符串的数组。
- |
-
- options
- |
- NumberOptions
- |
- 否
- |
- 用于创建数字格式化的选项。
- |
-
-
-
-
-
-- 示例：
-
- ```
- var numfmt = new Intl.NumberFormat(["en-GB", "zh"], {style:'decimal', notation:"scientific"});
- ```
-
-
-### format
-
-format\(number: number\): string;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | locales | Array<string> | 是 | 包含区域设置信息的字符串的数组。 |
+ | options | [NumberOptions](#numberoptions) | 否 | 用于创建数字格式化的选项。 |
+
+- 示例：
+ ```
+ var numfmt = new Intl.NumberFormat(["en-GB", "zh"], {style:'decimal', notation:"scientific"});
+ ```
+
+
+### format
+
+format(number: number): string;
格式化数字字符串。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- number
- |
- number
- |
- 是
- |
- 数字对象
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- string
- |
- 格式化后的数字字符串
- |
-
-
-
-
-
-- 示例：
-
- ```
- var numfmt = new Intl.NumberFormat(["en-GB", "zh"], {style:'decimal', notation:"scientific"});
- numfmt.format(1223);
- ```
-
-
-### resolvedOptions
-
-resolvedOptions\(\): NumberOptions
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | number | number | 是 | 数字对象 |
-获取NumberFormat 对象的格式化选项。
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | string | 格式化后的数字字符串 |
-- 返回值：
-
- 类型
- |
- 说明
- |
-
|---|
-
- NumberOptions
- |
- NumberFormat 对象的格式化选项。
- |
-
-
-
+- 示例：
+ ```
+ var numfmt = new Intl.NumberFormat(["en-GB", "zh"], {style:'decimal', notation:"scientific"});
+ numfmt.format(1223);
+ ```
-- 示例：
+### resolvedOptions
- ```
- var numfmt = new Intl.NumberFormat(["en-GB", "zh"], {style:'decimal', notation:"scientific"});
- numfmt.resolvedOptions();
- ```
+resolvedOptions(): NumberOptions
+
+获取NumberFormat 对象的格式化选项。
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [NumberOptions](#numberoptions) | NumberFormat 对象的格式化选项。 |
-## DateTimeOptions
+- 示例：
+ ```
+ var numfmt = new Intl.NumberFormat(["en-GB", "zh"], {style:'decimal', notation:"scientific"});
+ numfmt.resolvedOptions();
+ ```
+
+
+## DateTimeOptions
表示时间日期格式化选项。
-### 属性
-
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-locale
- |
-string
- |
-是
- |
-否
- |
-区域参数
- |
-
-dateStyle
- |
-string
- |
-是
- |
-是
- |
-日期显示格式，取值范围："long", "short", "medium", "full"
- |
-
-timeStyle
- |
-string
- |
-是
- |
-是
- |
-时间显示格式，取值范围："long", "short", "medium", "full"
- |
-
-hourCycle
- |
-string
- |
-是
- |
-是
- |
-时制格式，取值范围："h11", "h12", "h23", "h24".
- |
-
-timeZone
- |
-string
- |
-是
- |
-是
- |
-使用的时区（合法的IANA时区ID）
- |
-
-numberingSystem
- |
-string
- |
-是
- |
-是
- |
-数字系统
- |
-
-hour12
- |
-boolean
- |
-是
- |
-是
- |
-是否使用12小时制
- |
-
-weekday
- |
-string
- |
-是
- |
-是
- |
-工作日的显示格式，取值范围："long", "short", "narrow"
- |
-
-era
- |
-string
- |
-是
- |
-是
- |
-时代的显示格式，取值范围："long", "short", "narrow"
- |
-
-year
- |
-string
- |
-是
- |
-是
- |
-年份的显示格式，取值范围："numeric", "2-digit"
- |
-
-month
- |
-string
- |
-是
- |
-是
- |
-月份的显示格式，取值范围："numeric", "2-digit", "long", "short", "narrow"
- |
-
-day
- |
-string
- |
-是
- |
-是
- |
-日期的显示格式，取值范围："numeric", "2-digit"
- |
-
-hour
- |
-string
- |
-是
- |
-是
- |
-小时的显示格式，取值范围："numeric", "2-digit"
- |
-
-minute
- |
-string
- |
-是
- |
-是
- |
-分钟的显示格式，取值范围："numeric", "2-digit"
- |
-
-second
- |
-string
- |
-是
- |
-是
- |
-秒钟的显示格式，取值范围："numeric", "2-digit"
- |
-
-timeZoneName
- |
-string
- |
-是
- |
-是
- |
-时区名称的本地化表示
- |
-
-dayPeriod
- |
-string
- |
-是
- |
-是
- |
-时段的显示格式，取值范围："long", "short", "narrow"
- |
-
-localeMatcher
- |
-string
- |
-是
- |
-是
- |
-要使用的区域匹配算法，取值范围："lookup", "best fit"
- |
-
-formatMatcher
- |
-string
- |
-是
- |
-是
- |
-要使用的格式匹配算法，取值范围："basic", "best fit"
- |
-
-
-
-
-## NumberOptions
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| locale | string | 是 | 否 | 区域参数 |
+| dateStyle | string | 是 | 是 | 日期显示格式，取值范围："long", "short", "medium", "full" |
+| timeStyle | string | 是 | 是 | 时间显示格式，取值范围："long", "short", "medium", "full" |
+| hourCycle | string | 是 | 是 | 时制格式，取值范围："h11", "h12", "h23", "h24". |
+| timeZone | string | 是 | 是 | 使用的时区（合法的IANA时区ID） |
+| numberingSystem | string | 是 | 是 | 数字系统 |
+| hour12 | boolean | 是 | 是 | 是否使用12小时制 |
+| weekday | string | 是 | 是 | 工作日的显示格式，取值范围："long", "short", "narrow" |
+| era | string | 是 | 是 | 时代的显示格式，取值范围："long", "short", "narrow" |
+| year | string | 是 | 是 | 年份的显示格式，取值范围："numeric", "2-digit" |
+| month | string | 是 | 是 | 月份的显示格式，取值范围："numeric", "2-digit", "long", "short", "narrow" |
+| day | string | 是 | 是 | 日期的显示格式，取值范围："numeric", "2-digit" |
+| hour | string | 是 | 是 | 小时的显示格式，取值范围："numeric", "2-digit" |
+| minute | string | 是 | 是 | 分钟的显示格式，取值范围："numeric", "2-digit" |
+| second | string | 是 | 是 | 秒钟的显示格式，取值范围："numeric", "2-digit" |
+| timeZoneName | string | 是 | 是 | 时区名称的本地化表示 |
+| dayPeriod | string | 是 | 是 | 时段的显示格式，取值范围："long", "short", "narrow" |
+| localeMatcher | string | 是 | 是 | 要使用的区域匹配算法，取值范围："lookup", "best fit" |
+| formatMatcher | string | 是 | 是 | 要使用的格式匹配算法，取值范围："basic", "best fit" |
+
+
+## NumberOptions
表示设备支持的能力。
-### 属性
-
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-locale
- |
-string
- |
-是
- |
-否
- |
-区域参数
- |
-
-currency
- |
-string
- |
-是
- |
-是
- |
-货币单位
- |
-
-currencySign
- |
-string
- |
-是
- |
-是
- |
-货币单位的符号显示
- |
-
-currencyDisplay
- |
-string
- |
-是
- |
-是
- |
-货币的显示方式，取值范围："symbol", "narrowSymbol", "code", "name"
- |
-
-unit
- |
-string
- |
-是
- |
-是
- |
-单位
- |
-
-unitDisplay
- |
-string
- |
-是
- |
-是
- |
-单位的显示格式，取值范围："long", "short", "medium"
- |
-
-signDisplay
- |
-string
- |
-是
- |
-是
- |
-数字符号的显示格式，取值范围："auto", "never", "always", "expectZero"
- |
-
-compactDisplay
- |
-string
- |
-是
- |
-是
- |
-紧凑型的显示格式，取值范围："long", "short"
- |
-
-notation
- |
-string
- |
-是
- |
-是
- |
-数字的格式化规格，取值范围："standard", "scientific", "engineering", "compact"
- |
-
-localeMatcher
- |
-string
- |
-是
- |
-是
- |
-要使用的区域匹配算法，取值范围："lookup", "best fit"
- |
-
-style
- |
-string
- |
-是
- |
-是
- |
-数字的显示格式，取值范围："decimal", "currency", "percent", "unit"
- |
-
-numberingSystem
- |
-string
- |
-是
- |
-是
- |
-数字系统
- |
-
-useGrouping
- |
-boolean
- |
-是
- |
-是
- |
-是否分组显示
- |
-
-miniumumIntegerDigits
- |
-number
- |
-是
- |
-是
- |
-最少整数个数
- |
-
-miniumumFractionDigits
- |
-number
- |
-是
- |
-是
- |
-最少小数个数
- |
-
-maxiumumFractionDigits
- |
-number
- |
-是
- |
-是
- |
-最多小数个数
- |
-
-miniumumSignificantDigits
- |
-number
- |
-是
- |
-是
- |
-最少有效位个数
- |
-
-maxiumumSignificantDigits
- |
-number
- |
-是
- |
-是
- |
-最多有效位个数
- |
-
-
-
-
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| locale | string | 是 | 否 | 区域参数 |
+| currency | string | 是 | 是 | 货币单位 |
+| currencySign | string | 是 | 是 | 货币单位的符号显示 |
+| currencyDisplay | string | 是 | 是 | 货币的显示方式，取值范围："symbol", "narrowSymbol", "code", "name" |
+| unit | string | 是 | 是 | 单位 |
+| unitDisplay | string | 是 | 是 | 单位的显示格式，取值范围："long", "short", "medium" |
+| signDisplay | string | 是 | 是 | 数字符号的显示格式，取值范围："auto", "never", "always", "expectZero" |
+| compactDisplay | string | 是 | 是 | 紧凑型的显示格式，取值范围："long", "short" |
+| notation | string | 是 | 是 | 数字的格式化规格，取值范围："standard", "scientific", "engineering", "compact" |
+| localeMatcher | string | 是 | 是 | 要使用的区域匹配算法，取值范围："lookup", "best fit" |
+| style | string | 是 | 是 | 数字的显示格式，取值范围："decimal", "currency", "percent", "unit" |
+| numberingSystem | string | 是 | 是 | 数字系统 |
+| useGrouping | boolean | 是 | 是 | 是否分组显示 |
+| miniumumIntegerDigits | number | 是 | 是 | 最少整数个数 |
+| miniumumFractionDigits | number | 是 | 是 | 最少小数个数 |
+| maxiumumFractionDigits | number | 是 | 是 | 最多小数个数 |
+| miniumumSignificantDigits | number | 是 | 是 | 最少有效位个数 |
+| maxiumumSignificantDigits | number | 是 | 是 | 最多有效位个数 |
diff --git a/zh-cn/application-dev/reference/apis/js-apis-libupdateclient.md b/zh-cn/application-dev/reference/apis/js-apis-libupdateclient.md
deleted file mode 100644
index 71585421ddcd344b35e1b1b9f9206eb785e3a6d9..0000000000000000000000000000000000000000
--- a/zh-cn/application-dev/reference/apis/js-apis-libupdateclient.md
+++ /dev/null
@@ -1,1316 +0,0 @@
-# 升级
-
-升级范围：升级整个OpenHarmony系统，包括内置的资源、预置应用；第三方的应用不在升级的范围。
-
-升级依赖：升级分为SD卡升级和在线升级两种。
-
-- SD卡升级依赖升级包和SD卡安装。
-- 在线升级依赖手机厂商部署的用于管理升级包的服务器。服务器由手机厂商部署，IP由调用者传入，请求的request接口是固定的，由手机厂商开发。
-
-## 导入模块
-
-```
-import client from '@ohos.update'
-```
-
-## 权限列表
-
-无
-
-## getNewVersionInfo\(callback: AsyncCallback\): void
-
-获取新版本信息，使用callback方式作为异步方法。
-
-- 参数
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- callback
- |
- AsyncCallback<NewVersionInfo>
- |
- 否
- |
- 回调返回新版本信息
- |
-
-
-
-
-
-- 返回值
-
- 无
-
-
-- 示例
-
- ```
- updater.getNewVersionInfo(info => {
- console.log("getNewVersionInfo success " + info.status);
- console.log(`info versionName = ` + info.result[0].versionName);
- console.log(`info versionCode = ` + info.result[0].versionCode);
- console.log(`info verifyInfo = ` + info.result[0].verifyInfo);
- )};
- ```
-
-
-## getNewVersionInfo\(\): Promise
-
-获取新版本信息，使用promise方式作为异步方法。
-
-- 参数
-
- 无
-
-
-- 返回值
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<NewVersionInfo>
- |
- Promise，用于异步获取结果
- |
-
-
-
-
-
-- 示例
-
- ```
- var p = updater.getNewVersionInfo();
- p.then(function (value) {
- console.log(`info versionName = ` + value.result[0].versionName);
- console.log(`info versionCode = ` + value.result[0].versionCode);
- console.log(`info verifyInfo = ` + value.result[0].verifyInfo);
- }).catch(function (err) {
- console.log("getNewVersionInfo promise error: " + err.code);
- )};
- ```
-
-
-## checkNewVersion\(callback: AsyncCallback\): void
-
-检查新版本，使用callback方式作为异步方法。
-
-- 参数
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- callback
- |
- AsyncCallback<NewVersionInfo>
- |
- 否
- |
- 回调返回新版本信息
- |
-
-
-
-
-
-- 返回值
-
- 无
-
-
-- 示例
-
- ```
- updater.checkNewVersion(info => {
- console.log("checkNewVersion success " + info.status);
- console.log(`info versionName = ` + info.result[0].versionName);
- console.log(`info versionCode = ` + info.result[0].versionCode);
- console.log(`info verifyInfo = ` + info.result[0].verifyInfo);
- )};
- ```
-
-
-## checkNewVersion\(\): Promise
-
-检查新版本，使用promise方式作为异步方法。
-
-- 参数
-
- 无
-
-
-- 返回值
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<NewVersionInfo>
- |
- Promise函数返回新版本信息
- |
-
-
-
-
-
-- 示例
-
- ```
- var p = updater.checkNewVersion();
- p.then(function (value) {
- console.log(`info versionName = ` + value.result[0].versionName);
- console.log(`info versionCode = ` + value.result[0].versionCode);
- console.log(`info verifyInfo = ` + value.result[0].verifyInfo);
- }).catch(function (err) {
- console.log("checkNewVersion promise error: " + err.code);
- )};
- ```
-
-
-## verifyUpdatePackage\(upgradeFile: string, certsFile: string\): void
-
-升级前检查升级包是否有效。
-
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- upgradeFile
- |
- string
- |
- 是
- |
- 待校验的升级包路径
- |
-
- certsFile
- |
- string
- |
- 是
- |
- 证书路径
- |
-
-
-
-
-- 返回值：
-
- 无
-
-- 示例：
-
- ```
- var getVar = update.getUpdater();
- getVar.on("verifyProgress", function (callback){
- console.info('on verifyProgress ' + callback.percent);
- });
- getVar.verifyUpdatePackage("XXX", "XXX");
- getVar.off("verifyProgress");
- ```
-
-
-## rebootAndCleanUserData\(\): Promise
-
-重启设备并清除用户分区数据。
-
-- 参数：
-
- 无
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<number>
- |
- Promise示例，用于异步获取结果。
- |
-
-
-
-
-
-- 示例：
-
- ```
- var getVar = update.getUpdater();
- p = getVar.rebootAndCleanUserData();
- p.then(function (value) {
- console.info("rebootAndCleanUserData promise success: " + value);
- }).catch(function (err) {
- console.info("rebootAndCleanUserData promise error: " + err.code);
- });
- ```
-
-
-## rebootAndCleanUserData\(callback: AsyncCallback\): void
-
-重启设备并清除用户分区数据。
-
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- callback
- |
- Function
- |
- 是
- |
- AsyncCallback<number>
- |
-
-
-
-
-
-- 返回值：
-
- 无
-
-
-- 示例：
-
- ```
- var getVar = update.getUpdater();
- getVar.rebootAndCleanUserData(function (err, data) {
- if (err.code == 0) {
- console.info("rebootAndCleanUserData callback success:" + data)
- } else {
- console.info("rebootAndCleanUserData callback err:" + err.code)
- }
- });
- ```
-
-
-## applyNewVersion\(\): Promise
-
-重启设备后安装升级包。
-
-- 参数：
-
- 无
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<number>
- |
- Promise示例，用于异步获取结果。
- |
-
-
-
-
-
-- 示例：
-
- ```
- var getVar = update.getUpdater();
- p.then(function (value) {
- console.info("applyNewVersion promise success: " + value);
- }).catch(function (err) {
- console.info("applyNewVersion promise error: " + err.code);
- });
- ```
-
-
-## applyNewVersion\(callback: AsyncCallback\): void
-
-重启设备后安装升级包。
-
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- callback
- |
- Function
- |
- 是
- |
- AsyncCallback<number>
- |
-
-
-
-
-
-- 返回值：
-
- 无
-
-
-- 示例：
-
- ```
- var getVar = update.getUpdater();
- getVar.applyNewVersion(function (err, data) {
- if (err.code == 0) {
- console.info("applyNewVersion callback success:" + data)
- } else {
- console.info("applyNewVersion callback err:" + err.code)
- }
- });
- ```
-
-
-## download\(\): void
-
-下载新版本，并监听下载进程。
-
-- 参数
-
- 无
-
-
-- 返回值
-
- 无
-
-
-- 示例
-
-```
-updater.on("downloadProgress", progress => {
- console.log("downloadProgress on" + progress);
- console.log(`downloadProgress status: ` + progress.status);
- console.log(`downloadProgress percent: ` + progress.percent);
-)};
-updater.download();
-```
-
-## updater.upgrade\(\):void
-
-启动升级。
-
-- 参数
-
- 无
-
-
-- 返回值
-
- 无
-
-
-- 示例
-
-```
-updater.on("upgradeProgress", progress => {
- console.log("upgradeProgress on" + progress);
- console.log(`upgradeProgress status: ` + progress.status);
- console.log(`upgradeProgress percent: ` + progress.percent);
-)};
-updater.upgrade();
-```
-
-## setUpdatePolicy\(policy: UpdatePolicy, callback: AsyncCallback\): void
-
-设置升级策略，使用callback方式作为异步方法。
-
-- 参数
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- policy
- |
- UpdatePolicy
- |
- 是
- |
- 设置升级策略
- |
-
- callback
- |
- AsyncCallback<number>
- |
- 是
- |
- 回调返回结果
- |
-
-
-
-
-
-- 返回值
-
- 无
-
-- 示例
-
- ```
- // 设置策略
- let policy = {
- autoDownload: false,
- autoDownloadNet: true,
- mode: 2,
- autoUpgradeInterval: [ 2, 3 ],
- autoUpgradeCondition: 2
- }
- updater.setUpdatePolicy(policy, function(result) {
- console.log("setUpdatePolicy ", result)});
- ```
-
-
-## setUpdatePolicy\(policy: UpdatePolicy\): Promise
-
-设置升级策略，使用promise方式作为异步方法。
-
-- 参数
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- policy
- |
- UpdatePolicy
- |
- 是
- |
- 设置升级策略
- |
-
-
-
-
-
-- 返回值
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<number>
- |
- Promise函数返回设置结果
- |
-
-
-
-
-
-- 示例
-
- ```
- let policy = {
- autoDownload: false,
- autoDownloadNet: true,
- mode: 2,
- autoUpgradeInterval: [ 2, 3 ],
- autoUpgradeCondition: 2
- }
- updater.setUpdatePolicy(policy)
- .then(data=>
- console.log('set policy success')
- )
- ```
-
-
-## getUpdatePolicy\(callback: AsyncCallback\): void
-
-获取升级策略信息，使用callback方式作为异步方法。
-
-- 参数
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- callback
- |
- AsyncCallback<UpdatePolicy>
- |
- 否
- |
- 回调返回升级策略信息
- |
-
-
-
-
-
-- 返回值
-
-
- 参数名
- |
- 类型
- |
- 说明
- |
-
|---|
-
- policy
- |
- UpdatePolicy
- |
- 升级策略信息
- |
-
-
-
-
-
-- 示例
-
- ```
- updater.getUpdatePolicy(policy => {
- console.log("getUpdatePolicy success");
- console.log(`policy autoDownload = ` + policy.autoDownload);
- console.log(`policy autoDownloadNet = ` + policy.autoDownloadNet);
- console.log(`policy mode = ` + policy.mode);
- )};
- ```
-
-
-## getUpdatePolicy\(\): Promise
-
-获取升级策略，通过promise方式作为异步方法。
-
-- 参数
-
- 无
-
-
-- 返回值
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<UpdatePolicy>
- |
- Promise函数返回升级策略信息
- |
-
-
-
-
-
-- 示例
-
- ```
- p = updater.getUpdatePolicy();
- p.then(function (value) {
- console.log(`info autoDownload = ` + value.autoDownload);
- console.log(`info autoDownloadNet = ` + value.autoDownloadNet);
- console.log(`info mode = ` + value.mode);
- }).catch(function (err) {
- console.log("getUpdatePolicy promise error: " + err.code);
- )};
- ```
-
-
-## getUpdater\(upgradeFile: string, updateType?: UpdateTypes\): Updater
-
-获取本地升级Updater。
-
-- 参数
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- upgradeFile
- |
- string
- |
- 是
- |
- 升级文件
- |
-
- updateType
- |
- UpdateTypes
- |
- 是
- |
- 升级类型
- |
-
-
-
-
-
-- 返回值
-
-
- 参数名
- |
- 类型
- |
- 说明
- |
-
|---|
-
- updater
- |
- Updater
- |
- 升级对象
- |
-
-
-
-
-
-- 示例
-
- ```
- try {
- page.data.updater = client.getUpdater('/data/updater/updater.zip', 'OTA');
- } catch(error) {
- console.error(" Fail to get updater error: " + error);
- }
- ```
-
-
-## getUpdaterForOther\(upgradeFile: string, device: string, updateType?: UpdateTypes\): Updater
-
-获取升级对象给待升级设备。
-
-- 参数
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- upgradeFile
- |
- string
- |
- 是
- |
- 升级文件
- |
-
- device
- |
- string
- |
- 是
- |
- 待升级设备
- |
-
- updateType
- |
- UpdateTypes
- |
- 是
- |
- 升级类型
- |
-
-
-
-
-
-- 返回值
-
-
- 参数名
- |
- 类型
- |
- 说明
- |
-
|---|
-
- updater
- |
- Updater
- |
- 升级对象
- |
-
-
-
-
-
-- 示例
-
- ```
- try {
- page.data.updater = client.getUpdaterForOther('/data/updater/updater.zip', '1234567890', 'OTA');
- } catch(error) {
- console.error(" Fail to get updater error: " + error);
- }
- ```
-
-
-## getUpdaterFromOther\(upgradeFile: string, device: string, updateType?: UpdateTypes\): Updater
-
-获取其它设备为本设备升级的Updater。
-
-- 参数
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- upgradeFile
- |
- string
- |
- 是
- |
- 升级文件
- |
-
- device
- |
- string
- |
- 是
- |
- 待升级设备
- |
-
- updateType
- |
- UpdateTypes
- |
- 是
- |
- 升级类型
- |
-
-
-
-
-
-- 返回值
-
-
- 参数名
- |
- 类型
- |
- 说明
- |
-
|---|
-
- updater
- |
- Updater
- |
- 升级对象
- |
-
-
-
-
-
-- 示例
-
- ```
- try {
- page.data.updater = client.getUpdaterFromOther('/data/updater/updater.zip', '1234567890', 'OTA');
- } catch(error) {
- console.error(" Fail to get updater error: " + error);
- }
- ```
-
-
-## UpdateTypes
-
-升级类型
-
-
-参数名
- |
-说明
- |
-
|---|
-
-OTA
- |
-OTA升级
- |
-
-patch
- |
-补丁升级
- |
-
-
-
-
-## PackageTypes
-
-升级包类型
-
-
-参数名
- |
-默认值
- |
-说明
- |
-
|---|
-
-PACKAGE_TYPE_NORMAL
- |
-1
- |
-通用升级包
- |
-
-PACKAGE_TYPE_BASE
- |
-2
- |
-基础升级包
- |
-
-PACKAGE_TYPE_CUST
- |
-3
- |
-定制升级包
- |
-
-PACKAGE_TYPE_PRELOAD
- |
-4
- |
-预装升级包
- |
-
-PACKAGE_TYPE_COTA
- |
-5
- |
-参数配置升级包
- |
-
-PACKAGE_TYPE_VERSION
- |
-6
- |
-版本升级包
- |
-
-PACKAGE_TYPE_PATCH
- |
-7
- |
-补丁包
- |
-
-
-
-
-## InstallMode
-
-安装模式
-
-
-参数名
- |
-默认值
- |
-说明
- |
-
|---|
-
-INSTALL_MODE_NORMAL
- |
-0
- |
-正常升级
- |
-
-INSTALL_MODE_NIGHT
- |
-1
- |
-夜间升级
- |
-
-INSTALL_MODE_AUTO
- |
-2
- |
-自动升级
- |
-
-
-
-
-## NewVersionStatus
-
-新版本检测状态
-
-
-参数名
- |
-默认值
- |
-说明
- |
-
|---|
-
-VERSION_STATUS_ERR
- |
--1
- |
-检测版本时出错
- |
-
-VERSION_STATUS_NEW
- |
-0
- |
-检测到新版本
- |
-
-VERSION_STATUS_NONE
- |
-1
- |
-没有检测到新版本
- |
-
-VERSION_STATUS_BUSY
- |
-2
- |
-检测版本时忙
- |
-
-
-
-
-## UpdatePolicy
-
-升级策略
-
-
-名称
- |
-参数类型
- |
-必填
- |
-说明
- |
-
|---|
-
-autoDownload
- |
-bool
- |
-是
- |
-自动升级开关
- |
-
-installMode
- |
-InstallMode
- |
-是
- |
-安装模式
- |
-
-autoUpgradeInterval
- |
-Array<number>
- |
-是
- |
-自动升级时间段
- |
-
-
-
-
-## NewVersionInfo
-
-新版本信息
-
-
-名称
- |
-参数类型
- |
-必填
- |
-说明
- |
-
|---|
-
-status
- |
-NewVersionStatus
- |
-是
- |
-升级状态
- |
-
-errMsg
- |
-string
- |
-是
- |
-错误信息
- |
-
-checkResults
- |
-Array<CheckResult>
- |
-是
- |
-检测结果
- |
-
-descriptionInfo
- |
-Array<DescriptionInfo>
- |
-是
- |
-描述信息
- |
-
-
-
-
-## CheckResult
-
-检测结果
-
-
-名称
- |
-参数类型
- |
-必填
- |
-说明
- |
-
|---|
-
-versionName
- |
-string
- |
-是
- |
-版本名称
- |
-
-versionCode
- |
-number
- |
-是
- |
-版本编码
- |
-
-size
- |
-number
- |
-是
- |
-版本大小
- |
-
-verifyInfo
- |
-string
- |
-是
- |
-版本校验信息
- |
-
-packageType
- |
-PackageTypes
- |
-是
- |
-版本类型
- |
-
-descriptionId
- |
-string
- |
-是
- |
-版本描述信息
- |
-
-
-
-
-## DescriptionInfo
-
-版本描述信息
-
-
-名称
- |
-参数类型
- |
-必填
- |
-说明
- |
-
|---|
-
-descriptionId
- |
-string
- |
-是
- |
-版本versionId信息
- |
-
-content
- |
-string
- |
-是
- |
-版本changelog信息
- |
-
-
-
-
diff --git a/zh-cn/application-dev/reference/apis/js-apis-media.md b/zh-cn/application-dev/reference/apis/js-apis-media.md
index fed05acd5dd8bf8b6f05901644fff71dd569368c..22bbb3998329082e085bf9c70aaef9c63583b6aa 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-media.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-media.md
@@ -1,618 +1,416 @@
-# 音频播放
+# 音频播放和录制
-## 导入模块
+## 导入模块
```
import media from '@ohos.multimedia.media';
```
-## 权限
+
+## 权限
无
-## createAudioPlayer\(\)
-创建音频播放的实例。
+## media.createAudioPlayer
-- 参数：
+createAudioPlayer(): AudioPlayer
- 无
+创建音频播放的实例。
-- 返回值：
+**返回值：**
-
-类型
- |
-说明
- |
-
|---|
-
-AudioPlayer
- |
-返回AudioPlayer类实例，失败时返回null。
- |
-
-
-
+| 类型 | 说明 |
+| -------- | -------- |
+| [AudioPlayer](#audioplayer) | 返回AudioPlayer类实例，失败时返回null。 |
**示例：**
```
var audioplayer = media.createAudioPlayer();
```
+## media.createAudioRecorder
+createAudioRecorder(): AudioRecorder
-## AudioPlayer
-
-音频播放管理类，用于管理和播放音频媒体。在调用AudioPlayer的方法前，需要先通过[createAudioPlayer\(\)](#zh-cn_topic_0000001103383404_section582314017253)构建一个AudioPlayer实例。
-
-### 属性
-
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-src
- |
-string
- |
-是
- |
-是
- |
-音频媒体URI，支持当前主流的音频格式(mp4、aac、mp3、ogg)，支持本地绝对路径（file://)
- |
-
-loop
- |
-boolean
- |
-是
- |
-是
- |
-音频循环播放属性，设置为'true'表示循环播放。
- |
-
-currentTime
- |
-number
- |
-是
- |
-否
- |
-音频的当前播放阶段。
- |
-
-duration
- |
-number
- |
-是
- |
-否
- |
-音频播放的时长。
- |
-
-state
- |
-AudioState
- |
-是
- |
-否
- |
-音频播放的状态。
- |
-
-
-
-
-### play\(\): void
+创建音频录制的实例来控制音频的录制。
-开始播放音频资源。
+**返回值:**
-- 参数：
+| 类型 | 说明 |
+| ------------------------------- | ----------------------------------------- |
+| [AudioRecorder](#audiorecorder) | 返回AudioRecorder类实例，失败时返回null。 |
- 无
+**示例：**
+```
+var audiorecorder = media.createAudioRecorder();
+```
-- 返回值：
+## AudioPlayer
- 无
+音频播放管理类，用于管理和播放音频媒体。在调用AudioPlayer的方法前，需要先通过[createAudioPlayer()](#createaudioplayer-)构建一个AudioPlayer实例。
-- 示例：
- ```
- audioplayer.src = 'file://xxx/sounds.mp4';
- audioplayer.on('play', () => {
- console.log('Playback starts.');
- audioplayer.pause();
- });
- audioplayer.play();
- ```
+### 属性
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| src | string | 是 | 是 | 音频媒体URI，支持当前主流的音频格式(mp4、aac、mp3、ogg)，支持本地绝对路径（file://) |
+| loop | boolean | 是 | 是 | 音频循环播放属性，设置为'true'表示循环播放。 |
+| currentTime | number | 是 | 否 | 音频的当前播放阶段。 |
+| duration | number | 是 | 否 | 音频时长。 |
+| state | [AudioState](#audiostate) | 是 | 否 | 音频播放的状态。 |
-### pause\(\): void
+### play
-暂停播放音频资源。
+play(): void
-- 参数：
+开始播放音频资源。
- 无
+**示例：**
-- 返回值：
+```
+audioplayer.src = 'file:///data/media/sounds.mp4';
+audioplayer.on('play', () => {
+ console.log('Playback starts.');
+});
+audioplayer.play();
+```
- 无
+### pause
-- 示例：
+pause(): void
- ```
- audioplayer.src = 'file://xxx/sounds.mp4';
- audioplayer.on('pause', () => {
- console.log('Playback paused.');
- });
- audioplayer.pause();
- ```
+暂停播放音频资源。
+**示例：**
-### stop\(\): void
+```
+audioplayer.src = 'file:///data/media/sounds.mp4';
+audioplayer.on('pause', () => {
+ console.log('Playback paused.');
+});
+audioplayer.pause();
+```
-停止播放音频资源。
+### stop
-- 参数：
+stop(): void
- 无
+停止播放音频资源。
-- 返回值：
+**示例：**
- 无
+```
+audioplayer.src = 'file:///data/media/sounds.mp4';
+audioplayer.on('stop',() => {
+ console.log('Playback stopped.');
+});
+audioplayer.stop();
+```
-- 示例：
+### seek
- ```
- audioplayer.src = 'file://xxx/sounds.mp4';
- audioplayer.on('stop',() => {
- console.log('Playback stopped.');
- });
- audioplayer.stop();
- ```
+seek(timeMs: number): void
+跳转到指定播放位置。
-### seek\(timeMs: number\): void
+**参数：**
-跳转到指定播放位置。
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | -------- | -------- | -------- |
+| timeMs | number | 是 | 指定的跳转时间节点。 |
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- timeMs
- |
- number
- |
- 是
- |
- 指定的跳转时间节点。
- |
-
-
-
-
-- 返回值：
-
- 无
-
-- 示例：
-
- ```
- audioplayer.src = 'file://xxx/sounds.mp4';
- audioplayer.on('timeupdate', (action) => {
- var newTime = audioplayer.currenTime;
- if(newTime >= 30000) {
- console.info('Seek succeeded. New time: ' + newTime);
- } else {
- console.info('Seek failed.');
- }
- });
- audioplayer.seek(30000);
- ```
-
-
-### setVolume\(vol: number\): void
+**示例：**
-设置音量。
+```
+audioplayer.src = 'file:///data/media/sounds.mp4';
+audioplayer.on('timeupdate', (action) => {
+ var newTime = audioplayer.currenTime;
+ if(newTime >= 30000) {
+ console.info('Seek succeeded. New time: ' + newTime);
+ } else {
+ console.info('Seek failed.');
+ }
+});
+audioplayer.seek(30000);
+```
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- vol
- |
- number
- |
- 是
- |
- 指定的相对音量大小，取值范围为[0.00-1.00]，1表示最大音量，即100%。
- |
-
-
-
-
-- 返回值：
-
- 无
-
-- 示例：
-
- ```
- audioplayer.src = 'file://xxx/sounds.mp4';
- audioplayer.on('volumeChange', () => {
- console.log('Playback volume changed.');
- });
- audioplayer.setVolume(1);
- ```
-
-
-### reset\(\): void7+
+### setVolume
-切换播放音频资源。
+setVolume(vol: number): void
-- 参数：
+设置音量。
- 无
+**参数：**
-- 返回值：
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | -------- | -------- | -------- |
+| vol | number | 是 | 指定的相对音量大小，取值范围为[0.00-1.00]，1表示最大音量，即100%。 |
- 无
+**示例：**
-- 示例：
+```
+audioplayer.src = 'file:///data/media/sounds.mp4';
+audioplayer.on('volumeChange', () => {
+ console.log('Playback volume changed.');
+});
+audioplayer.setVolume(1);
+```
- ```
- audioplay.reset();
- ```
+### reset7+
+reset(): void
-### release\(\): void
+切换播放音频资源。
-释放音频资源。
+**示例：**
-- 参数：
+```
+audioplay.reset();
+```
- 无
+### release7+
-- 返回值：
+release(): void
- 无
+释放音频资源。
-- 示例：
+**示例：**
```
audioplay.release();
```
-### on\(type: string, callback: \(\) =\> void\): void
+### on('play' | 'pause' | 'stop' | 'reset' | 'dataLoad' | 'finish' | 'volumeChange')
+
+on(type: 'play' | 'pause' | 'stop' | 'reset' | 'dataLoad' | 'finish' | 'volumeChange', callback: () => void)
开始监听音频播放事件。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- type
- |
- string
- |
- 是
- |
- 播放事件回调类型，支持的事件包括：'play' | 'pause' | 'stop' | 'dataLoad' |'reset'| |'finish' | 'volumeChange'。
- |
-
- callback
- |
- ()=>void
- |
- 是
- |
- 播放事件回调方法。
- |
-
-
-
-
-- 返回值：
-
- 无
-
-- 示例：
-
- ```
- audioplayer.src = 'file://xxx/sounds.mp4';
- audioplayer.on('play', () => {
- console.log('Playback starts.');
- });
- audioplayer.play();
- ```
-
-
-### on\(type: string, callback: Callback\): void
+**参数：**
+
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | -------- | -------- | -------- |
+| type | string | 是 | 播放事件回调类型，支持的事件包括：'play' \| 'pause' \| 'stop' \| 'reset' \| 'dataLoad' \| 'finish' \| 'volumeChange'。
- 'play' ：完成play方法调用，音频开始播放，触发该事件。
- 'pause'：完成pause方法调用，音频暂停播放，触发该事件。
- 'stop'：完成stop方法调用，音频停止播放，触发该事件。
- 'reset'：完成reset方法调用，播放器重置，触发该事件。
- 'dataLoad'：完成音频数据加载后触发该事件。
- 'finish'：完成音频播放后触发该事件。
- 'volumeChange'：播放音量改变后触发该事件。播放事件回调方法。 |
+| callback | function | 是 | 播放事件回调方法。 |
+
+**示例：**
+
+```
+audioplayer.src = 'file://xxx/sounds.mp4';
+audioplayer.on('play', () => {
+ console.log('Playback starts.');
+});
+audioplayer.play();
+```
+
+### on('timeUpdate')
+
+on(type: 'timeUpdate', callback: Callback\): void
开始监听音频播放时间戳更新事件。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- type
- |
- string
- |
- 是
- |
- 播放事件回调类型，支持的事件为：'timeUpdate'。
- |
-
- callback
- |
- Callback<number>
- |
- 是
- |
- 播放事件回调方法。
- |
-
-
-
-
-- 返回值：
-
- 无
-
-- 示例：
-
- ```
- audioplayer.src = 'file://xxx/sounds.mp4';
- audioplayer.on('timeupdate', (action) => {
- var newTime = audioplayer.currenTime;
- if(newTime >= 30000) {
- console.info('Seek succeeded. New time: ' + newTime);
- } else {
- console.info('Seek failed.');
- }
- });
- audioplayer.seek(30000);
- ```
-
-
-### on\(type: string, callback: ErrorCallback\): void
+**参数：**
+
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | -------- | -------- | -------- |
+| type | string | 是 | 播放事件回调类型，支持的事件为：'timeUpdate'。
'timeUpdate'：音频播放时间戳更新，触发该事件。seek方法调用时也会触发该事件。 |
+| callback | Callback<number> | 是 | 播放事件回调方法。 |
+
+**示例：**
+
+```
+audioplayer.src = 'file://xxx/sounds.mp4';
+audioplayer.on('timeupdate', (newTime ) => {
+ if(newTime >= 30000) {
+ console.info('Seek succeeded. New time: ' + newTime);
+ } else {
+ console.info('Seek failed.');
+ }
+});
+audioplayer.seek(30000);
+```
+
+### on('error')
+
+on(type: 'error', callback: ErrorCallback): void
开始监听音频播放错误事件。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- type
- |
- string
- |
- 是
- |
- 播放错误事件回调类型'error'。
- |
-
- callback
- |
- ErrorCallback
- |
- 是
- |
- 播放错误事件回调方法。
- |
-
-
-
-
-- 返回值：
-
- 无
-
-- 示例：
-
- ```
- audioplayer.src = 'file:///xxx/sounds.mp4';
- audioplayer.on('error', (err) => {
- console.info('error callback info: ' + err);
- });
- audioplayer.setVolume(30000);
- ```
-
-
-### 事件
-
-AudioPlayer支持订阅以下事件。
-
-
-名称
- |
-参数
- |
-描述
- |
-
|---|
-
-play
- |
--
- |
-完成play方法调用，音频开始播放，触发该事件。
- |
-
-pause
- |
--
- |
-完成pause方法调用，音频暂停播放，触发该事件。
- |
-
-stop
- |
--
- |
-完成stop方法调用，音频停止播放，触发该事件。
- |
-
-reset
- |
--
- |
-完成reset方法调用，释放音频播放资源，触发该事件。
- |
-
-dataLoad
- |
--
- |
-完成音频数据加载后触发该事件。
- |
-
-finish
- |
--
- |
-完成音频播放后触发该事件。
- |
-
-volumeChange
- |
--
- |
-播放音量改变后触发该事件。
- |
-
-timeUpdate
- |
--
- |
-完成seek方法调用，音频播放时间戳更新，触发该事件。
- |
-
-error
- |
-callback
- |
-音频播放中发生错误，触发该事件。
- |
-
-
-
-
-**表 1** error事件的参数说明
-
-
-参数名
- |
-类型
- |
-说明
- |
-
|---|
-
-callback
- |
-ErrorCallback
- |
-错误事件的回调函数。
- |
-
-
-
-
-## AudioState
+**参数：**
+
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | -------- | -------- | -------- |
+| type | string | 是 | 播放错误事件回调类型'error'。
'error'：音频播放中发生错误，触发该事件。 |
+| callback | ErrorCallback | 是 | 播放错误事件回调方法。 |
+
+**示例：**
+
+```
+audioplayer.src = 'file:///data/sounds.mp4';
+audioplayer.on('error', (err) => {
+ console.info('error callback info: ' + err);
+});
+audioplayer.setVolume(30000);
+```
+
+
+## AudioState
音频播放的状态机。
-
-名称
- |
-描述
- |
-
|---|
-
-idle
- |
-音频播放空闲。
- |
-
-playing
- |
-音频正在播放。
- |
-
-paused
- |
-音频暂停播放。
- |
-
-stopped
- |
-音频播放停止。
- |
-
-
-
+| 名称 | 描述 |
+| -------- | -------- |
+| idle | 音频播放空闲。 |
+| playing | 音频正在播放。 |
+| paused | 音频暂停播放。 |
+| stopped | 音频播放停止。 |
+
+## AudioRecorder
+
+音频录制管理类，用于录制音频媒体。在调用AudioRecorder的方法前，需要先通过[createAudioRecorder()](#createaudiorecorder-audiorecorder)构建一个AudioRecorder实例。
+
+### prepare
+
+prepare(config: AudioRecorderConfig): void
+
+录音准备。
+
+**参数：**
+
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ------------------------------------------- | ---- | ------------------------------------------------------------ |
+| config | [AudioRecorderConfig](#audiorecorderconfig) | 是 | 配置录音的相关参数，包括音频输出URI、编码格式、采样率、声道数等。 |
+
+**示例：**
+
+```
+let audioRecorderConfig = {
+ audioEncoder : AAC_LC ,
+ audioEncodeBitRate : 22050,
+ audioSampleRate : 22050,
+ numberOfChannels : 2,
+ format : AAC_ADTS,
+ uri : 'file:///data/accounts/account_0/appdata/appdata/recorder/test.m4a',
+}
+audiorecorder.prepare(audioRecorderConfig)
+```
+
+
+### start
+
+start(): void
+
+开始录音。
+
+**示例：**
+
+```
+audiorecorder.start();
+```
+
+### stop
+
+stop(): void
+
+停止录音。
+
+**示例：**
+
+```
+audiorecorder.stop();
+```
+
+### release
+
+release(): void
+
+释放录音资源。
+
+**示例：**
+
+```
+audiorecorder.release();
+```
+
+### reset
+
+reset(): void
+
+重置录音。
+
+进行重置录音之前，需要先调用stop()停止录音。重置录音之后，需要调用prepare()设置录音配置项，才能再次进行录音。
+
+**示例：**
+
+```
+audiorecorder.reset();
+```
+
+### on('prepare' | 'start' | 'stop' | 'release' | 'reset')
+
+on(type: 'prepare' | 'start' | 'stop' | 'release' | 'reset', callback: () => void): void
+
+开始订阅音频录制事件。
+
+**参数：**
+
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | -------- | ---- | ------------------------------------------------------------ |
+| type | string | 是 | 录制事件回调类型，支持的事件包括：'prepare' \| 'start' \| 'stop' \| 'release' \| 'reset'。
- 'prepare' ：音频录制准备完成后，触发该事件。
- 'start' ：音频录制开始后，触发该事件。
- 'stop' ：音频录制停止后，触发该事件。
- 'release' ：音频录制相关资源释放后，触发该事件。
- 'reset'：音频录制重置后，触发该事件。 |
+| callback | function | 是 | 录制事件回调方法。 |
+
+**示例：**
+
+```
+audiorecorder.on('prepare', () => {
+ console.log('Preparation succeeded.');
+ audiorecorder.start();
+});
+```
+
+### on('error')
+
+on(type: 'error', callback: ErrorCallback): void
+
+开始订阅音频录制错误事件。
+
+**参数：**
+
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ------------- | ---- | ------------------------------------------------------------ |
+| type | string | 是 | 录制错误事件回调类型'error'。
- 'error'：音频录制过程中发生错误，触发该事件。 |
+| callback | ErrorCallback | 是 | 录制错误事件回调方法。 |
+
+
+## AudioRecorderConfig
+
+表示音频的录音配置。
+
+| 名称 | 参数类型 | 必填 | 说明 |
+| ------------------ | --------------------------------------- | ---- | ------------------------------------------------------------ |
+| audioEncoder | [AudioEncoder](#audioencoder) | 否 | 音频编码格式，默认设置为AAC_LC。 |
+| audioEncodeBitRate | number | 否 | 音频编码比特率，默认值为48000。 |
+| audioSampleRate | number | 否 | 音频采集采样率，默认值为48000。 |
+| numberOfChannels | number | 否 | 音频采集声道数，默认值为2。 |
+| format | [AudioOutputFormat](#audiooutputformat) | 否 | 音量输出封装格式，默认设置为MPEG_4。 |
+| uri | string | 是 | 音频输出URI。支持：
1. 文件的绝对路径：file:///data/data/ohos.xxx.xxx/cache/test.mp4
2. 文件的fd路径：file://1 (fd number) |
+
+
+## AudioEncoder
+
+表示音频编码格式的枚举。
+
+| 名称 | 默认值 | 说明 |
+| ------ | ------ | ------------------------------------------------------------ |
+| AAC_LC | 3 | AAC-LC（Advanced Audio Coding Low Complexity）编码格式。 |
+
+
+## AudioOutputFormat
+
+表示音频封装格式的枚举。
+| 名称 | 默认值 | 说明 |
+| -------- | ------ | ------------------------------------------------------------ |
+| MPEG_4 | 2 | 封装为MPEG-4格式。 |
+| AAC_ADTS | 6 | 封装为ADTS（Audio Data Transport Stream）格式，是AAC音频的传输流格式。 |
\ No newline at end of file
diff --git a/zh-cn/application-dev/reference/apis/js-apis-multmedia.md b/zh-cn/application-dev/reference/apis/js-apis-multmedia.md
index 167fb9d67728bacdbad2e971660c8093efbfd395..f0e04036770055995edc35b72946a92fa3382ddf 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-multmedia.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-multmedia.md
@@ -1,9 +1,7 @@
-# 媒体
+# 媒体
-- **[音频管理](js-apis-audio.md)**
-- **[音频播放](js-apis-media.md)**
-
-- **[音频录制](js-apis-recorder.md)**
+- **[音频管理](js-apis-audio.md)**
+- **[音频播放和录制](js-apis-media.md)**
diff --git a/zh-cn/application-dev/reference/apis/js-apis-notification-fwk.md b/zh-cn/application-dev/reference/apis/js-apis-notification-fwk.md
deleted file mode 100644
index 83de3deb0ce18d4936e228b531c63f1267a15379..0000000000000000000000000000000000000000
--- a/zh-cn/application-dev/reference/apis/js-apis-notification-fwk.md
+++ /dev/null
@@ -1,2 +0,0 @@
-# 公共事件与通知
-
diff --git a/zh-cn/application-dev/reference/apis/js-apis-power.md b/zh-cn/application-dev/reference/apis/js-apis-power.md
index a5bab82ea9d958e47f11674f8fae8cc4e62feafa..8304b440be0a7fa40c3be3af046863b6cb2da3af 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-power.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-power.md
@@ -1,179 +1,102 @@
-# 系统电源管理
+# 系统电源管理
-> **说明：**
->从 API Version 7 开始支持。
+>  **说明：**
+> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
-## 导入模块
+
+## 导入模块
```
import power from '@ohos.power';
```
-## 权限
+
+## 权限
关机权限： ohos.permission.SHUTDOWN
重启权限： ohos.permission.REBOOT
-重启并进入recovery模式的权限：ohos.permission.REBOOT\_RECOVERY
+重启并进入recovery模式的权限：ohos.permission.REBOOT_RECOVERY
-## power.shutdownDevice
-shutdownDevice\(reason: string\): void
+## power.shutdownDevice
+
+shutdownDevice(reason: string): void
系统关机。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- reason
- |
- string
- |
- 是
- |
- 关机原因。
- |
-
-
-
-
-- 示例：
-
- ```
- power.shutdownDevice("shutdown_test");
- console.info('power_shutdown_device_test success')
- ```
-
-
-## power.rebootDevice
-
-rebootDevice\(reason: string\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | reason | string | 是 | 关机原因。 |
+
+- 示例：
+ ```
+ power.shutdownDevice("shutdown_test");
+ console.info('power_shutdown_device_test success')
+ ```
+
+
+## power.rebootDevice
+
+rebootDevice(reason: string): void
重启设备。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- reason
- |
- string
- |
- 是
- |
- 重启原因。
- |
-
-
-
-
-- 示例：
-
- ```
- power.rebootDevice("reboot_test");
- console.info('power_reboot_device_test success')
- ```
-
-
-## power.isScreenOn
-
-isScreenOn\(callback: AsyncCallback\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | reason | string | 是 | 重启原因。 |
-检测当前设备的亮灭屏状态。
+- 示例：
+ ```
+ power.rebootDevice("reboot_test");
+ console.info('power_reboot_device_test success')
+ ```
-- 参数：
-
-
- 类型
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- callback
- |
- AsyncCallback<boolean>
- |
- 是
- |
- 指定的callback回调方法，用于获取返回值。
- callback返回值：亮屏返回true，灭屏返回false。
- |
-
-
-
-
-
-- 示例：
-
- ```
- power.isScreenOn((error, screenOn) => {
- if (typeof error === "undefined") {
- console.info('screenOn status is ' + screenOn);
- } else {
- console.log('error: ' + error);
- }
- })
- ```
-
-
-## power.isScreenOn
-
-isScreenOn\(\): Promise
+
+## power.isScreenOn
+
+isScreenOn(callback: AsyncCallback<boolean>): void
检测当前设备的亮灭屏状态。
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<boolean>
- |
- Promise实例，用于异步获取返回值，亮屏返回true，灭屏返回false。
- |
-
-
-
-
-- 示例：
-
- ```
- power.isScreenOn()
- .then(screenOn => {
- console.info('screenOn status is ' + screenOn);
- })
- .catch(error => {
- console.log('error: ' + error);
- })
- ```
+- 参数：
+ | 类型 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | callback | AsyncCallback<boolean> | 是 | 指定的callback回调方法，用于获取返回值。
callback返回值：亮屏返回true，灭屏返回false。 |
+
+- 示例：
+ ```
+ power.isScreenOn((error, screenOn) => {
+ if (typeof error === "undefined") {
+ console.info('screenOn status is ' + screenOn);
+ } else {
+ console.log('error: ' + error);
+ }
+ })
+ ```
+
+## power.isScreenOn
+
+isScreenOn(): Promise<boolean>
+
+检测当前设备的亮灭屏状态。
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<boolean> | Promise实例，用于异步获取返回值，亮屏返回true，灭屏返回false。 |
+
+- 示例：
+ ```
+ power.isScreenOn()
+ .then(screenOn => {
+ console.info('screenOn status is ' + screenOn);
+ })
+ .catch(error => {
+ console.log('error: ' + error);
+ })
+ ```
diff --git a/zh-cn/application-dev/reference/apis/js-apis-process.md b/zh-cn/application-dev/reference/apis/js-apis-process.md
index 818806a4c18af6a9e9e4265b1609b00fdc403e8b..932158f683e36699996904229e3e960e76022a75 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-process.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-process.md
@@ -1,777 +1,337 @@
-# 获取进程相关的信息
+# 获取进程相关的信息
-> **说明：**
->从 API Version 7 开始支持。
+>  **说明：**
+> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
-## 导入模块
+
+## 导入模块
```
import process from '@ohos.process';
```
-## 权限
+
+## 权限
无
-## 属性
-
-
-名称
- |
-类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-egid
- |
-number
- |
-是
- |
-否
- |
-获取进程的有效组标识。
- |
-
-euid
- |
-number
- |
-是
- |
-否
- |
-获取进程的有效用户身份。
- |
-
-gid
- |
-number
- |
-是
- |
-否
- |
-获取进程的组标识。
- |
-
-uid
- |
-number
- |
-是
- |
-否
- |
-获取进程的用户标识。
- |
-
-groups
- |
-number[]
- |
-是
- |
-否
- |
-获取一个带有补充组id的数组。
- |
-
-pid
- |
-number
- |
-是
- |
-否
- |
-获取当前进程的pid。
- |
-
-ppid
- |
-number
- |
-是
- |
-否
- |
-获取当前进程的父进程的pid。
- |
-
-
-
-
-## ChildProcess
+
+## 属性
+
+| 名称 | 类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| egid | number | 是 | 否 | 获取进程的有效组标识。 |
+| euid | number | 是 | 否 | 获取进程的有效用户身份。 |
+| gid | number | 是 | 否 | 获取进程的组标识。 |
+| uid | number | 是 | 否 | 获取进程的用户标识。 |
+| groups | number[] | 是 | 否 | 获取一个带有补充组id的数组。 |
+| pid | number | 是 | 否 | 获取当前进程的pid。 |
+| ppid | number | 是 | 否 | 获取当前进程的父进程的pid。 |
+
+
+## ChildProcess
主进程可以获取子进程的标准输入输出，以及发送信号和关闭子进程。
-### 属性
-
-
-名称
- |
-类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-pid
- |
-number
- |
-是
- |
-否
- |
-子进程的pid。
- |
-
-ppid
- |
-number
- |
-是
- |
-否
- |
-子进程的父进程的pid。
- |
-
-exitCode
- |
-number
- |
-是
- |
-否
- |
-子进程的退出码。
- |
-
-killed
- |
-boolean
- |
-是
- |
-否
- |
-父进程给子进程发信号是否成功。
- |
-
-
-
-
-### wait
-
-wait\(\): Promise
-等待子进程运行结束，返回promise对象，其值为子进程的退出码。
+### 属性
-- 返回值：
+| 名称 | 类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| pid | number | 是 | 否 | 子进程的pid。 |
+| ppid | number | 是 | 否 | 子进程的父进程的pid。 |
+| exitCode | number | 是 | 否 | 子进程的退出码。 |
+| killed | boolean | 是 | 否 | 父进程给子进程发信号是否成功。 |
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<number>
- |
- 异步返回子进程的退出码。
- |
-
-
-
-- 示例：
+### wait
- ```
- import process from '@ohos.process';
- var child = process.runCmd('ls');
- var result = child.wait();
- result.then(val=>{
- console.log("result = " + val);
- })
- ```
+wait(): Promise<number>
+等待子进程运行结束，返回promise对象，其值为子进程的退出码。
-### getOutput
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<number> | 异步返回子进程的退出码。 |
-getOutput\(\): Promise
+- 示例：
+ ```
+ import process from '@ohos.process';
+ var child = process.runCmd('ls');
+ var result = child.wait();
+ result.then(val=>{
+ console.log("result = " + val);
+ })
+ ```
-获取子进程的标准输出。
-- 返回值：
+### getOutput
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<Uint8Array>
- |
- 异步返回标准输出的字节流。
- |
-
-
-
+getOutput(): Promise<Uint8Array>
+
+获取子进程的标准输出。
-- 示例：
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<Uint8Array> | 异步返回标准输出的字节流。 |
- ```
- import process from '@ohos.process';
- var child = process.runCmd('ls');
- var result = child.wait();
- child.getOutput.then(val=>{
- console.log("child.getOutput = " + val);
- })
- ```
+- 示例：
+ ```
+ import process from '@ohos.process';
+ var child = process.runCmd('ls');
+ var result = child.wait();
+ child.getOutput.then(val=>{
+ console.log("child.getOutput = " + val);
+ })
+ ```
-### getErrorOutput
+### getErrorOutput
-getErrorOutput\(\): Promise
+getErrorOutput(): Promise<Uint8Array>
getErrorOutput函数用来获取子进程的标准错误输出。
-- 返回值：
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<Uint8Array> | 异步返回标准错误输出的字节流。 |
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<Uint8Array>
- |
- 异步返回标准错误输出的字节流。
- |
-
-
-
+- 示例：
+ ```
+ import process from '@ohos.process';
+ var child = process.runCmd('madir test.text');
+ var result = child.wait();
+ child.getErrorOutput.then(val=>{
+ console.log("child.getErrorOutput= " + val);
+ })
+ ```
-- 示例：
- ```
- import process from '@ohos.process';
- var child = process.runCmd('madir test.text');
- var result = child.wait();
- child.getErrorOutput.then(val=>{
- console.log("child.getErrorOutput= " + val);
- })
- ```
+### close
+close(): void
-### close
+关闭正在运行的子进程。
-close\(\): void
+- 示例：
+ ```
+ import process from '@ohos.process';
+ var child = process.runCmd('sleep 5; ls');
+ child.close();
+ ```
-关闭正在运行的子进程。
-- 示例：
+### kill
- ```
- import process from '@ohos.process';
- var child = process.runCmd('sleep 5; ls');
- child.close();
- ```
+kill(signal: number | string): void
+kill函数用来发送信号给子进程，结束指定进程。
-### kill
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | signal | number \| string | 是 | 数字或字符串。 |
-kill\(signal: number | string\): void
+- 示例：
+ ```
+ import process from '@ohos.process';
+ var child = process.runCmd('sleep 5; ls');
+ child.kill(9);
+ ```
-kill函数用来发送信号给子进程，结束指定进程。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- signal
- |
- number | string
- |
- 是
- |
- 数字或字符串。
- |
-
-
-
-
-- 示例：
-
- ```
- import process from '@ohos.process';
- var child = process.runCmd('sleep 5; ls');
- child.kill(9);
- ```
-
-
-## process.runCmd
-
-runCmd\(command: string, options?: \{ timeout : number, killSignal ：number | string, maxBuffer : number \}\) : ChildProcess
+## process.runCmd
+
+runCmd(command: string, options?: { timeout : number, killSignal ：number | string, maxBuffer : number }) : ChildProcess
通过runcmd可以fork一个新的进程来运行一段shell，并返回ChildProcess对象。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- command
- |
- string
- |
- 是
- |
- shell命令。
- |
-
- options
- |
- Object
- |
- 否
- |
- 相关选项参数。
- |
-
-
-
-
- **表 1** options
-
-
- 名称
- |
- 参数类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- timeout
- |
- number
- |
- 否
- |
- 子进程运行的ms数，当子进程运行时间超出此时间，则父进程发送killSignal信号给子进程。timeout默认为0。
- |
-
- killSignal
- |
- number | string
- |
- 否
- |
- 子进程运行时间超出timeout时，父进程发送killSignal 信号给子进程。killSignal 默认为'SIGTERM'。
- |
-
- maxBuffer
- |
- number
- |
- 否
- |
- 子进程标准输入输出的最大缓冲区大小，当超出此大小时则终止子进程。maxBuffer默认1024*1024。
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- import process from '@ohos.process';
- var child = process.runCmd('ls', { maxBuffer : 2 });
- var result = child.wait();
- child.getOutput.then(val=>{
- console.log("child.getOutput = " + val);
- }
- ```
-
-
-## process.abort
-
-abort\(\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | command | string | 是 | shell命令。 |
+ | options | Object | 否 | 相关选项参数。 |
-该方法会导致进程立即退出并生成一个核心文件，谨慎使用。
+ **表1** options
+
+ | 名称 | 参数类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | timeout | number | 否 | 子进程运行的ms数，当子进程运行时间超出此时间，则父进程发送killSignal信号给子进程。timeout默认为0。 |
+ | killSignal | number \| string | 否 | 子进程运行时间超出timeout时，父进程发送killSignal 信号给子进程。killSignal 默认为'SIGTERM'。 |
+ | maxBuffer | number | 否 | 子进程标准输入输出的最大缓冲区大小，当超出此大小时则终止子进程。maxBuffer默认1024\*1024。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | [ChildProcess](#childprocess) | 子进程对象。 |
+
+- 示例：
+ ```
+ import process from '@ohos.process';
+ var child = process.runCmd('ls', { maxBuffer : 2 });
+ var result = child.wait();
+ child.getOutput.then(val=>{
+ console.log("child.getOutput = " + val);
+ }
+ ```
+
+
+## process.abort
-- 示例：
+abort(): void
- ```
- import process from '@ohos.process';
- process.abort();
- ```
+该方法会导致进程立即退出并生成一个核心文件，谨慎使用。
+
+- 示例：
+ ```
+ import process from '@ohos.process';
+ process.abort();
+ ```
-## process.on
+## process.on
-on\(type: string, listener: EventListener\): void
+on(type: string, listener: EventListener): void
用该方法来存储用户所触发的事件。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- type
- |
- string
- |
- 是
- |
- 存储事件的type。
- |
-
- listener
- |
- EventListener
- |
- 是
- |
- 回调的事件。
- |
-
-
-
-
- **表 2** EventListener
-
-
- 名称
- |
- 说明
- |
-
|---|
-
- EventListener = (evt: Object) => void
- |
- 用户存储的事件。
- |
-
-
-
-
-- 示例：
-
- ```
- import process from '@ohos.process';
- process.on("data", (e)=>{
- console.log("data callback");
- })
- ```
-
-
-## process.off
-
-off\(type: string\): boolean
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | string | 是 | 存储事件的type。 |
+ | listener | EventListener | 是 | 回调的事件。 |
+
+ **表2** EventListener
+
+ | 名称 | 说明 |
+ | -------- | -------- |
+ | EventListener = (evt: Object) => void | 用户存储的事件。 |
+
+- 示例：
+ ```
+ import process from '@ohos.process';
+ process.on("data", (e)=>{
+ console.log("data callback");
+ })
+ ```
+
+
+## process.off
+
+off(type: string): boolean
用该方法来删除用户存储的事件。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- type
- |
- string
- |
- 是
- |
- 删除事件的type。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- boolean
- |
- 事件是否删除成功。
- |
-
-
-
-
-- 示例：
-
- ```
- import process from '@ohos.process';
- process.on("data", (e)=>{
- console.log("data callback");
- })
- var result = process.off("data");
- ```
-
-
-## process.exit
-
-exit\(code: number\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | string | 是 | 删除事件的type。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | boolean | 事件是否删除成功。 |
+
+- 示例：
+ ```
+ import process from '@ohos.process';
+ process.on("data", (e)=>{
+ console.log("data callback");
+ })
+ var result = process.off("data");
+ ```
+
+
+## process.exit
+
+exit(code: number): void
用该方法终止程序，谨慎使用。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- code
- |
- number
- |
- 是
- |
- 进程的退出码。
- |
-
-
-
-
-- 示例：
-
- ```
- import process from '@ohos.process';
- process.exit(0);
- ```
-
-
-## process.cwd
-
-cwd\(\): string
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | code | number | 是 | 进程的退出码。 |
-用该方法获取进程的工作目录。
+- 示例：
+ ```
+ import process from '@ohos.process';
+ process.exit(0);
+ ```
+
+
+## process.cwd
+
+cwd(): string
-- 示例：
+用该方法获取进程的工作目录。
- ```
- import process from '@ohos.process';
- var path = process.cwd();
- ```
+- 示例：
+ ```
+ import process from '@ohos.process';
+ var path = process.cwd();
+ ```
-## process.chdir
+## process.chdir
-chdir\(dir: string\): void
+chdir(dir: string): void
用该方法更改进程的当前工作目录。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- dir
- |
- string
- |
- 是
- |
- 路径。
- |
-
-
-
-
-- 示例：
-
- ```
- import process from '@ohos.process';
- process.chdir('/system');
- ```
-
-
-## process.uptime
-
-uptime\(\): number
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | dir | string | 是 | 路径。 |
-获取当前系统已运行的秒数。
+- 示例：
+ ```
+ import process from '@ohos.process';
+ process.chdir('/system');
+ ```
-- 返回值：
-
- 类型
- |
- 说明
- |
-
|---|
-
- number
- |
- 当前系统已运行的秒数。
- |
-
-
-
+## process.uptime
-- 示例：
+uptime(): number
- ```
- import process from '@ohos.process';
- var time = process.uptime();
- ```
+获取当前系统已运行的秒数。
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | number | 当前系统已运行的秒数。 |
-## process.kill
+- 示例：
+ ```
+ import process from '@ohos.process';
+ var time = process.uptime();
+ ```
-kill\(pid: number，signal: number \): boolean
-用该方法发送signal到指定的进程，结束指定进程。
+## process.kill
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- pid
- |
- number
- |
- 是
- |
- 进程的id。
- |
-
- signal
- |
- number
- |
- 是
- |
- 发送的信号。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- boolean
- |
- 信号是否发送成功。
- |
-
-
-
-
-- 示例：
-
- ```
- import process from '@ohos.process'
- var pres = process.pid
- var result = that.kill(pres, 28)
- ```
+kill(pid: number，signal: number ): boolean
+用该方法发送signal到指定的进程，结束指定进程。
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | pid | number | 是 | 进程的id。 |
+ | signal | number | 是 | 发送的信号。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | boolean | 信号是否发送成功。 |
+
+- 示例：
+ ```
+ import process from '@ohos.process'
+ var pres = process.pid
+ var result = that.kill(pres, 28)
+ ```
diff --git a/zh-cn/application-dev/reference/apis/js-apis-radio.md b/zh-cn/application-dev/reference/apis/js-apis-radio.md
index 5d2a244e8c2fc2453405c8a41b765b0ab525681a..0f9dac3e5f4ee050e0e79fdfce2093eca07cbcac 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-radio.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-radio.md
@@ -2,8 +2,7 @@
>**说明：**
>
->- 从 API Version 6 开始支持。
->- 标记7+的接口从API Version 7开始支持。
+>本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
diff --git a/zh-cn/application-dev/reference/apis/js-apis-recorder.md b/zh-cn/application-dev/reference/apis/js-apis-recorder.md
deleted file mode 100644
index 9dbfb5c7539a7322cb9b7258494e7fe6264d0142..0000000000000000000000000000000000000000
--- a/zh-cn/application-dev/reference/apis/js-apis-recorder.md
+++ /dev/null
@@ -1,478 +0,0 @@
-# 音频录制
-
-## 导入模块
-
-```
-import media from '@ohos.multimedia.media';
-```
-
-## 权限
-
-无
-
-## createAudioRecorder\(\): AudioRecorder
-
-创建音频录制的实例来控制音频的录制。
-
-- 参数：
-
- 无
-
-- 返回值
-
-
-类型
- |
-说明
- |
-
|---|
-
-AudioRecorder
- |
-返回AudioRecorder类实例，失败时返回null。
- |
-
-
-
-
-- 示例
-
-```
-var audiorecorder = media.createAudioRecorder();
-```
-
-## AudioRecorder
-
-音频录制管理类，用于录制音频媒体。在调用AudioRecorder的方法前，需要先通过[createAudioRecorder\(\)](#section582314017253)构建一个AudioRecorder实例。
-
-### prepare\(config: AudioRecorderConfig\): void
-
-录音准备。
-
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- config
- |
- AudioRecorderConfig
- |
- 是
- |
- 配置录音的相关参数，包括音频输出URI、编码格式、采样率、声道数等。
- |
-
-
-
-
-
-- 返回值：
-
- 无
-
-- 示例：
-
- ```
- let audioRecorderConfig = {
- audioEncoder : AAC_LC ,
- audioEncodeBitRate : 22050,
- audioSampleRate : 22050,
- numberOfChannels : 2,
- format : AAC_ADTS,
- uri : 'file:///data/accounts/account_0/appdata/appdata/recorder/test.m4a',
- }
- audiorecorder.prepare(audioRecorderConfig)
- ```
-
-
-## start\(\): void
-
-开始录音。
-
-- 参数：
-
- 无
-
-- 返回值：
-
- 无
-
-- 示例：
-
- ```
- audiorecorder.start();
- ```
-
-
-## stop\(\): void
-
-停止录音。
-
-- 参数：
-
- 无
-
-
-- 返回值：
-
- 无
-
-- 示例：
-
- ```
- audiorecorder.stop();
- ```
-
-
-## release\(\): void
-
-释放录音资源。
-
-- 参数：
-
- 无
-
-- 返回值：
-
- 无
-
-- 示例：
-
- ```
- audiorecorder.release();
- ```
-
-
-## reset\(\): void
-
-重置录音。
-
-进行重置录音之前，需要先调用stop\(\)停止录音。重置录音之后，需要调用prepare\(\)设置录音配置项，才能再次进行录音。
-
-- 参数：
-
- 无
-
-- 返回值：
-
- 无
-
-- 示例：
-
- ```
- audiorecorder.reset();
- ```
-
-
-## on\(type: string, callback: \(\) =\> void\): void
-
-开始订阅音频录制事件。
-
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- type
- |
- string
- |
- 是
- |
- 录制事件回调类型，支持的事件包括：'prepare' | 'start' | 'stop' | 'release' | 'reset'。
- - 'prepare' ：音频录制准备完成后，触发该事件。
- 'start' ：音频录制开始后，触发该事件。
- 'stop' ：音频录制停止后，触发该事件。
- 'release' ：音频录制相关资源释放后，触发该事件。
- 'reset'：音频录制重置后，触发该事件。
- |
-
- callback
- |
- function
- |
- 是
- |
- 录制事件回调方法。
- |
-
-
-
-
-- 返回值：
-
- 无
-
-- 示例：
-
- ```
- audiorecorder.on('prepare', () => {
- console.log('Preparation succeeded.');
- audiorecorder.start();
- });
- ```
-
-
-## on\(type: string, callback: ErrorCallback\): void
-
-开始订阅音频录制错误事件。
-
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- type
- |
- string
- |
- 是
- |
- 录制错误事件回调类型'error'。
- - 'error'：音频录制过程中发生错误，触发该事件。
- |
-
- callback
- |
- ErrorCallback
- |
- 是
- |
- 录制错误事件回调方法。
- |
-
-
-
-
-- 返回值：
-
- 无
-
-
-### 事件
-
-AudioRecorder支持订阅以下事件。
-
-
-名称
- |
-参数
- |
-描述
- |
-
|---|
-
-prepare
- |
--
- |
-音频录制准备完成后，触发该事件。
- |
-
-start
- |
--
- |
-音频录制开始后，触发该事件。
- |
-
-stop
- |
--
- |
-音频录制停止后，触发该事件。
- |
-
-release
- |
--
- |
-音频录制相关资源释放后，触发该事件。
- |
-
-reset
- |
--
- |
-音频录制重置后，触发该事件。
- |
-
-error
- |
-callback
- |
-音频录制过程中发生错误，触发该事件。
- |
-
-
-
-
-**表 1** error事件的参数说明
-
-
-参数名
- |
-类型
- |
-说明
- |
-
|---|
-
-callback
- |
-ErrorCallback
- |
-错误事件的回调函数。
- |
-
-
-
-
-## AudioRecorderConfig
-
-表示音频的录音配置。
-
-
-名称
- |
-参数类型
- |
-必填
- |
-说明
- |
-
|---|
-
-audioEncoder
- |
-AudioEncoder
- |
-否
- |
-音频编码格式，默认设置为AAC_LC。
- |
-
-audioEncodeBitRate
- |
-number
- |
-否
- |
-音频编码比特率，默认值为48000。
- |
-
-audioSampleRate
- |
-number
- |
-否
- |
-音频采集采样率，默认值为48000。
- |
-
-numberOfChannels
- |
-number
- |
-否
- |
-音频采集声道数，默认值为2。
- |
-
-format
- |
-AudioOutputFormat
- |
-否
- |
-音量输出封装格式，默认设置为MPEG_4。
- |
-
-uri
- |
-string
- |
-是
- |
-音频输出URI。支持：
-- 文件的绝对路径：file:///data/data/ohos.xxx.xxx/cache/test.mp4
 - 文件的fd路径：file://1 (fd number)
-
- |
-
-
-
-
-## AudioEncoder
-
-表示音频编码格式的枚举。
-
-
-名称
- |
-默认值
- |
-说明
- |
-
|---|
-
-AAC_LC
- |
-3
- |
-AAC-LC（Advanced Audio Coding Low Complexity）编码格式。
- |
-
-
-
-
-## AudioOutputFormat
-
-表示音频封装格式的枚举。
-
-
-名称
- |
-默认值
- |
-说明
- |
-
|---|
-
-MPEG_4
- |
-2
- |
-封装为MPEG-4格式。
- |
-
-AAC_ADTS
- |
-6
- |
-封装为ADTS（Audio Data Transport Stream）格式，是AAC音频的传输流格式。
- |
-
-
-
-
diff --git a/zh-cn/application-dev/reference/apis/js-apis-resource-manager.md b/zh-cn/application-dev/reference/apis/js-apis-resource-manager.md
index 886030e18e0ccb83c57400385a0acbc6867924a1..09edae1a0d06601c4414573ccd3e6894964c08e5 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-resource-manager.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-resource-manager.md
@@ -1,1213 +1,559 @@
-# 资源管理
+# 资源管理
-> **说明：**
->从 API Version 7 开始支持。
+>  **说明：**
+> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
-## 导入模块
+
+## 导入模块
```
import resourceManager from '@ohos.resourceManager';
```
-## 权限
+
+## 权限
无
-## resourceManager.getResourceManager
-getResourceManager\(callback: AsyncCallback\): void
+## resourceManager.getResourceManager
+
+getResourceManager(callback: AsyncCallback<ResourceManager>): void
获取当前应用的资源管理对象，使用callback形式返回ResourceManager对象。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- callback
- |
- AsyncCallback<ResourceManager>
- |
- 是
- |
- callback方式返回ResourceManager对象
- |
-
-
-
-
-
-- 示例：
-
- ```
- resourceManager.getResourceManager((error, mgr) => {
- if (error != null) {
- console.log("error occurs" + error);
- return;
- }
- mgr.getString(0x1000000, (error, value) => {
- if (error != null) {
- console.log(value);
- } else {
- console.log(value);
- }
- });
- });
- ```
-
-
-## resourceManager.getResourceManager
-
-getResourceManager\(bundleName: string, callback: AsyncCallback\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | callback | AsyncCallback<[ResourceManager](#resourcemanager)> | 是 | callback方式返回ResourceManager对象 |
+
+- 示例：
+ ```
+ resourceManager.getResourceManager((error, mgr) => {
+ if (error != null) {
+ console.log("error occurs" + error);
+ return;
+ }
+ mgr.getString(0x1000000, (error, value) => {
+ if (error != null) {
+ console.log(value);
+ } else {
+ console.log(value);
+ }
+ });
+ });
+ ```
+
+
+## resourceManager.getResourceManager
+
+getResourceManager(bundleName: string, callback: AsyncCallback<ResourceManager>): void
获取指定应用的资源管理对象，使用callback形式返回ResourceManager对象。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- bundleName
- |
- string
- |
- 是
- |
- 指定应用的Bundle名称
- |
-
- callback
- |
- AsyncCallback<ResourceManager>
- |
- 是
- |
- callback方式返回ResourceManager对象
- |
-
-
-
-
-- 示例：
-
- ```
- resourceManager.getResourceManager("com.example.myapplication", (error, mgr) => {
- });
- ```
-
-
-## resourceManager.getResourceManager
-
-getResourceManager\(\): Promise
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | bundleName | string | 是 | 指定应用的Bundle名称 |
+ | callback | AsyncCallback<[ResourceManager](#resourcemanager)> | 是 | callback方式返回ResourceManager对象 |
+
+- 示例：
+ ```
+ resourceManager.getResourceManager("com.example.myapplication", (error, mgr) => {
+ });
+ ```
+
+
+## resourceManager.getResourceManager
+
+getResourceManager(): Promise<ResourceManager>
获取当前应用的资源管理对象，使用Promise形式返回ResourceManager对象。
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- resourceManager.getResourceManager().then(mgr => {
- mgr.getString(0x1000000, (error, value) => {
- if (error != null) {
- console.log(value);
- } else {
- console.log(value);
- }
- });
- }).catch(error => {
- console.log(error);
- });
- ```
-
-
-## resourceManager.getResourceManager
-
-getResourceManager\(bundleName: string\): Promise
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<[ResourceManager](#resourcemanager)> | Promise方式返回资源管理对象 |
+
+- 示例：
+ ```
+ resourceManager.getResourceManager().then(mgr => {
+ mgr.getString(0x1000000, (error, value) => {
+ if (error != null) {
+ console.log(value);
+ } else {
+ console.log(value);
+ }
+ });
+ }).catch(error => {
+ console.log(error);
+ });
+ ```
+
+
+## resourceManager.getResourceManager
+
+getResourceManager(bundleName: string): Promise<ResourceManager>
获取指定应用的资源管理对象，使用Promise形式返回ResourceManager对象。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- bundleName
- |
- string
- |
- 是
- |
- 指定应用的Bundle名称
- |
-
-
-
-
-- 返回值：
-
-
-
-
-- 示例：
-
- ```
- resourceManager.getResourceManager("com.example.myapplication").then(mgr => {
-
- }).catch(error => {
-
- });
- ```
-
-
-## Direction
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | bundleName | string | 是 | 指定应用的Bundle名称 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<[ResourceManager](#resourcemanager)> | Promise方式返回的资源管理对象 |
+
+- 示例：
+ ```
+ resourceManager.getResourceManager("com.example.myapplication").then(mgr => {
+
+ }).catch(error => {
+
+ });
+ ```
+
+
+## Direction
用于表示设备屏幕方向。
-
-名称
- |
-默认值
- |
-说明
- |
-
|---|
-
-DIRECTION_VERTICAL
- |
-0
- |
-竖屏
- |
-
-DIRECTION_HORIZONTAL
- |
-1
- |
-横屏
- |
-
-
-
-
-## DeviceType
+| 名称 | 默认值 | 说明 |
+| -------- | -------- | -------- |
+| DIRECTION_VERTICAL | 0 | 竖屏 |
+| DIRECTION_HORIZONTAL | 1 | 横屏 |
+
+
+## DeviceType
用于表示当前设备类型。
-
-名称
- |
-默认值
- |
-说明
- |
-
|---|
-
-DEVICE_TYPE_PHONE
- |
-0x00
- |
-手机.
- |
-
-DEVICE_TYPE_TABLET
- |
-0x01
- |
-平板
- |
-
-DEVICE_TYPE_CAR
- |
-0x02
- |
-汽车
- |
-
-DEVICE_TYPE_PC
- |
-0x03
- |
-电脑
- |
-
-DEVICE_TYPE_TV
- |
-0x04
- |
-电视
- |
-
-DEVICE_TYPE_WEARABLE
- |
-0x06
- |
-穿戴
- |
-
-
-
-
-## ScreenDensity
+| 名称 | 默认值 | 说明 |
+| -------- | -------- | -------- |
+| DEVICE_TYPE_PHONE | 0x00 | 手机 |
+| DEVICE_TYPE_TABLET | 0x01 | 平板 |
+| DEVICE_TYPE_CAR | 0x02 | 汽车 |
+| DEVICE_TYPE_PC | 0x03 | 电脑 |
+| DEVICE_TYPE_TV | 0x04 | 电视 |
+| DEVICE_TYPE_WEARABLE | 0x06 | 穿戴 |
+
+
+## ScreenDensity
用于表示当前设备屏幕密度。
-
-名称
- |
-默认值
- |
-说明
- |
-
|---|
-
-SCREEN_SDPI
- |
-120
- |
-小规模的屏幕密度
- |
-
-SCREEN_MDPI
- |
-160
- |
-中规模的屏幕密度
- |
-
-SCREEN_LDPI
- |
-240
- |
-大规模的屏幕密度
- |
-
-SCREEN_XLDPI
- |
-320
- |
-特大规模的屏幕密度
- |
-
-SCREEN_XXLDPI
- |
-480
- |
-超大规模的屏幕密度
- |
-
-SCREEN_XXXLDPI
- |
-640
- |
-超特大规模的屏幕密度
- |
-
-
-
-
-## Configuration
+| 名称 | 默认值 | 说明 |
+| -------- | -------- | -------- |
+| SCREEN_SDPI | 120 | 小规模的屏幕密度 |
+| SCREEN_MDPI | 160 | 中规模的屏幕密度 |
+| SCREEN_LDPI | 240 | 大规模的屏幕密度 |
+| SCREEN_XLDPI | 320 | 特大规模的屏幕密度 |
+| SCREEN_XXLDPI | 480 | 超大规模的屏幕密度 |
+| SCREEN_XXXLDPI | 640 | 超特大规模的屏幕密度 |
+
+
+## Configuration
表示当前设备的状态。
-### 属性
-
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-direction
- |
-Direction
- |
-是
- |
-否
- |
-当前设备屏幕方向
- |
-
-locale
- |
-string
- |
-是
- |
-否
- |
-当前系统语言
- |
-
-
-
-
-## DeviceCapability
+
+### 属性
+
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| direction | [Direction](#direction) | 是 | 否 | 当前设备屏幕方向 |
+| locale | string | 是 | 否 | 当前系统语言 |
+
+
+## DeviceCapability
表示设备支持的能力。
-### 属性
-
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-screenDensity
- |
-ScreenDensity
- |
-是
- |
-否
- |
-当前设备屏幕密度
- |
-
-deviceType
- |
-DeviceType
- |
-是
- |
-否
- |
-当前设备类型
- |
-
-
-
-
-## ResourceManager
+
+### 属性
+
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| screenDensity | [ScreenDensity](#screendensity) | 是 | 否 | 当前设备屏幕密度 |
+| deviceType | [DeviceType](#devicetype) | 是 | 否 | 当前设备类型 |
+
+
+## ResourceManager
提供访问应用资源的能力。
-### getString
+>  **说明：**
+> - ResourceManager涉及到的方法，仅限基于TS扩展的声明式开发范式使用。
+>
+> - 资源文件在工程的resources目录中定义，id可通过$r(资源地址).id的方式获取，例如$r('app.string.test').id。
+
-getString\(resId: number, callback: AsyncCallback\): void
+### getString
+
+getString(resId: number, callback: AsyncCallback<string>): void
用户获取指定资源ID对应的字符串，使用callback形式返回字符串。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- resId
- |
- number
- |
- 是
- |
- 资源ID值
- |
-
- callback
- |
- AsyncCallback<string>
- |
- 是
- |
- 异步回调，用于返回获取的字符串
- |
-
-
-
-
-- 示例：
-
- ```
- resourceManager.getResourceManager((error, mgr) => {
- mgr.getString(0x1000000, (error, value) => {
- if (error != null) {
- console.log(value);
- } else {
- console.log(value);
- }
- });
- });
- ```
-
-
-### getString
-
-getString\(resId: number\): Promise
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | resId | number | 是 | 资源ID值 |
+ | callback | AsyncCallback<string> | 是 | 异步回调，用于返回获取的字符串 |
+
+- 示例：
+ ```
+ resourceManager.getResourceManager((error, mgr) => {
+ mgr.getString($r('app.string.test').id, (error, value) => {
+ if (error != null) {
+ console.log(value);
+ } else {
+ console.log(value);
+ }
+ });
+ });
+ ```
+
+
+### getString
+
+getString(resId: number): Promise<string>
用户获取指定资源ID对应的字符串，使用Promise形式返回字符串。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- resId
- |
- number
- |
- 是
- |
- 资源ID值
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<string>
- |
- 资源ID值对应的字符串
- |
-
-
-
-
-- 示例：
-
- ```
- resourceManager.getResourceManager((error, mgr) => {
- mgr.getString(0x1000000).then(value => {
- console.log(value);
- }).catch(error => {
- console.log("getstring promise " + error);
- });
- });
- ```
-
-
-### getStringArray
-
-getStringArray\(resId: number, callback: AsyncCallback\>\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | resId | number | 是 | 资源ID值 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<string> | 资源ID值对应的字符串 |
+
+- 示例：
+ ```
+ resourceManager.getResourceManager((error, mgr) => {
+ mgr.getString($r('app.string.test').id).then(value => {
+ console.log(value);
+ }).catch(error => {
+ console.log("getstring promise " + error);
+ });
+ });
+ ```
+
+
+### getStringArray
+
+getStringArray(resId: number, callback: AsyncCallback<Array<string>>): void
用户获取指定资源ID对应的字符串数组，使用callback形式返回字符串数组。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- resId
- |
- number
- |
- 是
- |
- 资源ID值
- |
-
- callback
- |
- AsyncCallback<Array<string>>
- |
- 是
- |
- 异步回调，用于返回获取的字符串数组
- |
-
-
-
-
-- 示例：
-
- ```
- resourceManager.getResourceManager((error, mgr) => {
- mgr.getStringArray(0x1000000, (error, value) => {
- if (error != null) {
- console.log(value);
- } else {
- console.log(value);
- }
- });
- });
- ```
-
-
-### getStringArray
-
-getStringArray\(resId: number\): Promise\>
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | resId | number | 是 | 资源ID值 |
+ | callback | AsyncCallback<Array<string>> | 是 | 异步回调，用于返回获取的字符串数组 |
+
+- 示例：
+ ```
+ resourceManager.getResourceManager((error, mgr) => {
+ mgr.getStringArray($r('app.strarray.test').id, (error, value) => {
+ if (error != null) {
+ console.log(value);
+ } else {
+ console.log(value);
+ }
+ });
+ });
+ ```
+
+
+### getStringArray
+
+getStringArray(resId: number): Promise<Array<string>>
用户获取指定资源ID对应的字符串数组，使用Promise形式返回字符串数组。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- resId
- |
- number
- |
- 是
- |
- 资源ID值
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<Array<string>>
- |
- 资源ID值对应的字符串数组
- |
-
-
-
-
-- 示例：
-
- ```
- resourceManager.getResourceManager((error, mgr) => {
- mgr.getStringArray(0x1000000).then(value => {
- console.log(value);
- }).catch(error => {
- console.log("getstring promise " + error);
- });
- });
- ```
-
-
-### getMedia
-
-getMedia\(resId: number, callback: AsyncCallback\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | resId | number | 是 | 资源ID值 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<Array<string>> | 资源ID值对应的字符串数组 |
+
+- 示例：
+ ```
+ resourceManager.getResourceManager((error, mgr) => {
+ mgr.getStringArray($r('app.strarray.test').id).then(value => {
+ console.log(value);
+ }).catch(error => {
+ console.log("getstring promise " + error);
+ });
+ });
+ ```
+
+
+### getMedia
+
+getMedia(resId: number, callback: AsyncCallback<Uint8Array>): void
用户获取指定资源ID对应的媒体文件内容，使用callback形式返回字节数组。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- resId
- |
- number
- |
- 是
- |
- 资源ID值
- |
-
- callback
- |
- AsyncCallback<Array<Uint8Array>>
- |
- 是
- |
- 异步回调，用于返回获取的媒体文件内容
- |
-
-
-
-
-- 示例：
-
- ```
- resourceManager.getResourceManager((error, mgr) => {
- mgr.getMedia(0x1000000, (error, value) => {
- if (error != null) {
- console.log(value);
- } else {
- console.log(value);
- }
- });
- });
- ```
-
-
-### getMedia
-
-getMedia\(resId: number\): Promise
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | resId | number | 是 | 资源ID值 |
+ | callback | AsyncCallback<Array<Uint8Array>> | 是 | 异步回调，用于返回获取的媒体文件内容 |
+
+- 示例：
+ ```
+ resourceManager.getResourceManager((error, mgr) => {
+ mgr.getMedia($r('app.media.test').id, (error, value) => {
+ if (error != null) {
+ console.log(value);
+ } else {
+ console.log(value);
+ }
+ });
+ });
+ ```
+
+
+### getMedia
+
+getMedia(resId: number): Promise<Uint8Array>
用户获取指定资源ID对应的媒体文件内容，使用Promise形式返回字节数组。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- resId
- |
- number
- |
- 是
- |
- 资源ID值
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<Array<Uint8Array>>
- |
- 资源ID值对应的媒体文件内容
- |
-
-
-
-
-- 示例：
-
- ```
- resourceManager.getResourceManager((error, mgr) => {
- mgr.getMedia(0x1000000).then(value => {
- console.log(value);
- }).catch(error => {
- console.log("getstring promise " + error);
- });
- });
- ```
-
-
-### getMediaBase64
-
-getMediaBase64\(resId: number, callback: AsyncCallback\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | resId | number | 是 | 资源ID值 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<Array<Uint8Array>> | 资源ID值对应的媒体文件内容 |
+
+- 示例：
+ ```
+ resourceManager.getResourceManager((error, mgr) => {
+ mgr.getMedia($r('app.media.test').id).then(value => {
+ console.log(value);
+ }).catch(error => {
+ console.log("getstring promise " + error);
+ });
+ });
+ ```
+
+
+### getMediaBase64
+
+getMediaBase64(resId: number, callback: AsyncCallback<string>): void
用户获取指定资源ID对应的图片资源Base64编码，使用callback形式返回字符串。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- resId
- |
- number
- |
- 是
- |
- 资源ID值
- |
-
- callback
- |
- AsyncCallback<string>
- |
- 是
- |
- 异步回调，用于返回获取的图片资源Base64编码
- |
-
-
-
-
-- 示例：
-
- ```
- resourceManager.getResourceManager((error, mgr) => {
- mgr.getMediaBase64(0x1000000, (error, value) => {
- if (error != null) {
- console.log(value);
- } else {
- console.log(value);
- }
- });
- });
- ```
-
-
-### getMediaBase64
-
-getMediaBase64\(resId: number\): Promise
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | resId | number | 是 | 资源ID值 |
+ | callback | AsyncCallback<string> | 是 | 异步回调，用于返回获取的图片资源Base64编码 |
+
+- 示例：
+ ```
+ resourceManager.getResourceManager((error, mgr) => {
+ mgr.getMediaBase64($r('app.media.test').id, (error, value) => {
+ if (error != null) {
+ console.log(value);
+ } else {
+ console.log(value);
+ }
+ });
+ });
+ ```
+
+
+### getMediaBase64
+
+getMediaBase64(resId: number): Promise<string>
用户获取指定资源ID对应的图片资源Base64编码，使用Promise形式返回字符串。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- resId
- |
- number
- |
- 是
- |
- 资源ID值
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<string>
- |
- 资源ID值对应的图片资源Base64编码
- |
-
-
-
-
-- 示例：
-
- ```
- resourceManager.getResourceManager((error, mgr) => {
- mgr.getMediaBase64(0x1000000).then(value => {
- console.log(value);
- }).catch(error => {
- console.log("getstring promise " + error);
- });
- });
- ```
-
-
-### getConfiguration
-
-getConfiguration\(callback: AsyncCallback\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | resId | number | 是 | 资源ID值 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<string> | 资源ID值对应的图片资源Base64编码 |
+
+- 示例：
+ ```
+ resourceManager.getResourceManager((error, mgr) => {
+ mgr.getMediaBase64($r('app.media.test').id).then(value => {
+ console.log(value);
+ }).catch(error => {
+ console.log("getstring promise " + error);
+ });
+ });
+ ```
+
+
+### getConfiguration
+
+getConfiguration(callback: AsyncCallback<Configuration>): void
用户获取设备的Configuration，使用callback形式返回Configuration对象。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- callback
- |
- AsyncCallback<Configuration>
- |
- 是
- |
- 异步回调，用于返回设备的Configuration
- |
-
-
-
-
-- 示例：
-
- ```
- resourceManager.getResourceManager((error, mgr) => {
- mgr.getConfiguration((error, value) => {
- if (error != null) {
- console.log(value);
- } else {
- console.log(value);
- }
- });
- });
- ```
-
-
-### getConfiguration
-
-getConfiguration\(\): Promise
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | callback | AsyncCallback<[Configuration](#configuration)> | 是 | 异步回调，用于返回设备的Configuration |
-用户获取设备的Configuration，使用Promise形式返回Configuration对象。
+- 示例：
+ ```
+ resourceManager.getResourceManager((error, mgr) => {
+ mgr.getConfiguration((error, value) => {
+ if (error != null) {
+ console.log(value);
+ } else {
+ console.log(value);
+ }
+ });
+ });
+ ```
-- 返回值：
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<Configuration>
- |
- 设备的Configuration
- |
-
-
-
+### getConfiguration
-- 示例：
+getConfiguration(): Promise<Configuration>
+
+用户获取设备的Configuration，使用Promise形式返回Configuration对象。
- ```
- resourceManager.getResourceManager((error, mgr) => {
- mgr.getConfiguration().then(value => {
- console.log(value);
- }).catch(error => {
- console.log("getstring promise " + error);
- });
- });
- ```
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<[Configuration](#configuration)> | 设备的Configuration |
+- 示例：
+ ```
+ resourceManager.getResourceManager((error, mgr) => {
+ mgr.getConfiguration().then(value => {
+ console.log(value);
+ }).catch(error => {
+ console.log("getstring promise " + error);
+ });
+ });
+ ```
-### getDeviceCapability
-getDeviceCapability\(callback: AsyncCallback\): void
+### getDeviceCapability
+
+getDeviceCapability(callback: AsyncCallback<DeviceCapability>): void
用户获取设备的DeviceCapability，使用callback形式返回DeviceCapability对象。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- callback
- |
- AsyncCallback<DeviceCapability>
- |
- 是
- |
- 异步回调，用于返回设备的DeviceCapability
- |
-
-
-
-
-- 示例：
-
- ```
- resourceManager.getResourceManager((error, mgr) => {
- mgr.getDeviceCapability((error, value) => {
- if (error != null) {
- console.log(value);
- } else {
- console.log(value);
- }
- });
- });
- ```
-
-
-### getDeviceCapability
-
-getDeviceCapability\(\): Promise
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | callback | AsyncCallback<[DeviceCapability](#devicecapability)> | 是 | 异步回调，用于返回设备的DeviceCapability |
+
+- 示例：
+ ```
+ resourceManager.getResourceManager((error, mgr) => {
+ mgr.getDeviceCapability((error, value) => {
+ if (error != null) {
+ console.log(value);
+ } else {
+ console.log(value);
+ }
+ });
+ });
+ ```
-用户获取设备的DeviceCapability，使用Promise形式返回DeviceCapability对象。
-- 返回值：
+### getDeviceCapability
-
-
+getDeviceCapability(): Promise<DeviceCapability>
+
+用户获取设备的DeviceCapability，使用Promise形式返回DeviceCapability对象。
-- 示例：
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<[DeviceCapability](#devicecapability)> | 设备的DeviceCapability |
- ```
- resourceManager.getResourceManager((error, mgr) => {
- mgr.getDeviceCapability().then(value => {
- console.log(value);
- }).catch(error => {
- console.log("getstring promise " + error);
- });
- });
- ```
+- 示例：
+ ```
+ resourceManager.getResourceManager((error, mgr) => {
+ mgr.getDeviceCapability().then(value => {
+ console.log(value);
+ }).catch(error => {
+ console.log("getstring promise " + error);
+ });
+ });
+ ```
-### getPluralString
+### getPluralString
-getPluralString\(resId: number, num: number, callback: AsyncCallback\): void
+getPluralString(resId: number, num: number, callback: AsyncCallback<string>): void
根据指定数量获取指定ID字符串表示的单复数字符串，使用callback形式返回字符串。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- resId
- |
- number
- |
- 是
- |
- 资源ID值
- |
-
- num
- |
- number
- |
- 是
- |
- 数量值
- |
-
- callback
- |
- AsyncCallback<string>
- |
- 是
- |
- 异步回调，返回根据指定数量获取指定ID字符串表示的单复数字符串
- |
-
-
-
-
-- 示例：
-
- ```
- resourceManager.getResourceManager((error, mgr) => {
- mgr.getPluralString(0x1000000, 1, (error, value) => {
- if (error != null) {
- console.log(value);
- } else {
- console.log(value);
- }
- });
- });
- ```
-
-
-### getPluralString
-
-getPluralString\(resId: number, num: number\): Promise
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | resId | number | 是 | 资源ID值 |
+ | num | number | 是 | 数量值 |
+ | callback | AsyncCallback<string> | 是 | 异步回调，返回根据指定数量获取指定ID字符串表示的单复数字符串 |
+
+- 示例：
+ ```
+ resourceManager.getResourceManager((error, mgr) => {
+ mgr.getPluralString($r("app.plural.test").id, 1, (error, value) => {
+ if (error != null) {
+ console.log(value);
+ } else {
+ console.log(value);
+ }
+ });
+ });
+ ```
-根据指定数量获取对指定ID字符串表示的单复数字符串，使用Promise形式返回字符串。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- resId
- |
- number
- |
- 是
- |
- 资源ID值
- |
-
- num
- |
- number
- |
- 是
- |
- 数量值
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<string>
- |
- 根据提供的数量获取对应ID字符串表示的单复数字符串
- |
-
-
-
-
-- 示例：
-
- ```
- resourceManager.getResourceManager((error, mgr) => {
- mgr.getPluralString(0x1000000, 1).then(value => {
- console.log(value);
- }).catch(error => {
- console.log("getstring promise " + error);
- });
- });
- ```
+### getPluralString
+getPluralString(resId: number, num: number): Promise<string>
+
+根据指定数量获取对指定ID字符串表示的单复数字符串，使用Promise形式返回字符串。
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | resId | number | 是 | 资源ID值 |
+ | num | number | 是 | 数量值 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<string> | 根据提供的数量获取对应ID字符串表示的单复数字符串 |
+
+- 示例：
+ ```
+ resourceManager.getResourceManager((error, mgr) => {
+ mgr.getPluralString($r("app.plural.test").id, 1).then(value => {
+ console.log(value);
+ }).catch(error => {
+ console.log("getstring promise " + error);
+ });
+ });
+ ```
diff --git a/zh-cn/application-dev/reference/apis/js-apis-resource.md b/zh-cn/application-dev/reference/apis/js-apis-resource.md
index 256f3bbd13c9bd5bb56b107918341d1b86a7be9e..73f7c912a25e287ac1ce7f7baeb23a8753218cfe 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-resource.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-resource.md
@@ -1,9 +1,9 @@
-# 资源管理
+# 资源管理
-- **[资源管理](js-apis-resource-manager.md)**
-- **[国际化（I18n）](js-apis-i18n.md)**
-- **[国际化（Intl）](js-apis-intl.md)**
+- **[资源管理](js-apis-resource-manager.md)**
+- **[国际化-Intl(新)](js-apis-intl.md)**
+- **[国际化-I18n(新)](js-apis-i18n.md)**
\ No newline at end of file
diff --git a/zh-cn/application-dev/reference/apis/js-apis-runninglock.md b/zh-cn/application-dev/reference/apis/js-apis-runninglock.md
index 6da949f38aca8b89218a7db72924e950fee7318d..887fa5eb22a99229226be3d13c70037e44d61318 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-runninglock.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-runninglock.md
@@ -1,402 +1,208 @@
-# Runninglock锁
+# Runninglock锁
-> **说明：**
->从 API Version 7 开始支持。
+>  **说明：**
+> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
-## 导入模块
+
+## 导入模块
```
import runninglock from '@ohos.runningLock';
```
-## 权限
-申请、使用锁的权限：ohos.permission.RUNNING\_LOCK
+## 权限
+
+申请、使用锁的权限：ohos.permission.RUNNING_LOCK
-## RunningLockType
+
+## RunningLockType
RunningLock锁的类型。
-
-名称
- |
-默认值
- |
-描述
- |
-
|---|
-
-BACKGROUND
- |
-1
- |
-阻止系统休眠的锁。
- |
-
-PROXIMITY_SCREEN_CONTROL
- |
-2
- |
-通过接近或者远离状态来控制亮灭屏的锁。
- |
-
-
-
-
-## isRunningLockTypeSupported
-
-isRunningLockTypeSupported\(type: RunningLockType, callback: AsyncCallback\): void
+| 名称 | 默认值 | 描述 |
+| -------- | -------- | -------- |
+| BACKGROUND | 1 | 阻止系统休眠的锁。 |
+| PROXIMITY_SCREEN_CONTROL | 2 | 通过接近或者远离状态来控制亮灭屏的锁。 |
+
+
+## isRunningLockTypeSupported
+
+isRunningLockTypeSupported(type: RunningLockType, callback: AsyncCallback<boolean>): void
查询系统是否支持该类型的锁。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- type
- |
- RunningLockType
- |
- 是
- |
- 需要查询的锁的类型。
- |
-
- callback
- |
- AsyncCallback<boolean>
- |
- 是
- |
- 指定的callback回调方法，用于获取返回值。
- callback返回值：支持返回true，不支持返回false。
- |
-
-
-
-
-- 示例：
-
- ```
- runningLock.isRunningLockTypeSupported(runningLock.RunningLockType.BACKGROUND, (error, supported) => {
- if (typeof error === "undefined") {
- console.info('BACKGROUND support status is ' + supported);
- } else {
- console.log('error: ' + error);
- }
- })
- ```
-
-
-## isRunningLockTypeSupported
-
-isRunningLockTypeSupported\(type: RunningLockType\): Promise
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | RunningLockType | 是 | 需要查询的锁的类型。 |
+ | callback | AsyncCallback<boolean> | 是 | 指定的callback回调方法，用于获取返回值。
callback返回值：支持返回true，不支持返回false。 |
+
+- 示例：
+ ```
+ runningLock.isRunningLockTypeSupported(runningLock.RunningLockType.BACKGROUND, (error, supported) => {
+ if (typeof error === "undefined") {
+ console.info('BACKGROUND support status is ' + supported);
+ } else {
+ console.log('error: ' + error);
+ }
+ })
+ ```
+
+
+## isRunningLockTypeSupported
+
+isRunningLockTypeSupported(type: RunningLockType): Promise<boolean>
查询系统是否支持该类型的锁。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- type
- |
- RunningLockType
- |
- 是
- |
- 需要查询的锁的类型。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<boolean>
- |
- Promise实例，用于异步获取返回值，支持返回true，不支持返回false。
- |
-
-
-
-
-- 示例：
-
- ```
- runningLock.isRunningLockTypeSupported(runningLock.RunningLockType.PROXIMITY_SCREEN_CONTROL)
- .then(supported => {
- console.info('PROXIMITY_SCREEN_CONTROL support status is ' + supported);
- })
- .catch(error => {
- console.log('error: ' + error);
- });
- ```
-
-
-## createRunningLock
-
-createRunningLock\(name: string, type: RunningLockType, callback: AsyncCallback\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | RunningLockType | 是 | 需要查询的锁的类型。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<boolean> | Promise实例，用于异步获取返回值，支持返回true，不支持返回false。 |
+
+- 示例：
+ ```
+ runningLock.isRunningLockTypeSupported(runningLock.RunningLockType.PROXIMITY_SCREEN_CONTROL)
+ .then(supported => {
+ console.info('PROXIMITY_SCREEN_CONTROL support status is ' + supported);
+ })
+ .catch(error => {
+ console.log('error: ' + error);
+ });
+ ```
+
+
+## createRunningLock
+
+createRunningLock(name: string, type: RunningLockType, callback: AsyncCallback<RunningLock>): void
创建RunningLock锁。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- name
- |
- string
- |
- 是
- |
- 锁的名字。
- |
-
- type
- |
- RunningLockType
- |
- 是
- |
- 要创建的锁的类型。
- |
-
- callback
- |
- AsyncCallback<RunningLock>
- |
- 是
- |
- 指定的callback回调方法，用于获取返回的RunningLock锁对象。
- |
-
-
-
-
-- 示例：
-
- ```
- runningLock.createRunningLock("running_lock_test", runningLock.RunningLockType.BACKGROUND)
- .then(runninglock => {
- var used = runninglock.isUsed();
- console.info('runninglock is used: ' + used);
- runninglock.lock(500);
- used = runninglock.isUsed();
- console.info('after lock runninglock is used ' + used);
- })
- .catch(error => {
- console.log('create runningLock test error: ' + error);
- })
- ```
-
-
-## createRunningLock
-
-createRunningLock\(name: string, type: RunningLockType\): Promise
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | name | string | 是 | 锁的名字。 |
+ | type | RunningLockType | 是 | 要创建的锁的类型。 |
+ | callback | AsyncCallback<[RunningLock](#runninglock)> | 是 | 指定的callback回调方法，用于获取返回的RunningLock锁对象。 |
+
+- 示例：
+ ```
+ runningLock.createRunningLock("running_lock_test", runningLock.RunningLockType.BACKGROUND)
+ .then(runninglock => {
+ var used = runninglock.isUsed();
+ console.info('runninglock is used: ' + used);
+ runninglock.lock(500);
+ used = runninglock.isUsed();
+ console.info('after lock runninglock is used ' + used);
+ })
+ .catch(error => {
+ console.log('create runningLock test error: ' + error);
+ })
+ ```
+
+
+## createRunningLock
+
+createRunningLock(name: string, type: RunningLockType): Promise<RunningLock>
创建Runninglock锁。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- name
- |
- string
- |
- 是
- |
- 锁的名字。
- |
-
- type
- |
- RunningLockType
- |
- 是
- |
- 要创建的锁的类型。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<RunningLock>
- |
- Promise实例，用于异步获取返回的RunningLock锁对象。
- |
-
-
-
-
-- 示例：
-
- ```
- runningLock.createRunningLock("running_lock_test", runningLock.RunningLockType.BACKGROUND)
- .then(runninglock => {
- console.info('create runningLock success');
- })
- .catch(error => {
- console.log('create runningLock test error: ' + error);
- })
- ```
-
-
-## RunningLock
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | name | string | 是 | 锁的名字。 |
+ | type | RunningLockType | 是 | 要创建的锁的类型。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<[RunningLock](#runninglock)> | Promise实例，用于异步获取返回的RunningLock锁对象。 |
+
+- 示例：
+ ```
+ runningLock.createRunningLock("running_lock_test", runningLock.RunningLockType.BACKGROUND)
+ .then(runninglock => {
+ console.info('create runningLock success');
+ })
+ .catch(error => {
+ console.log('create runningLock test error: ' + error);
+ })
+ ```
+
+
+## RunningLock
阻止系统休眠的锁。
-### lock
-lock\(timeout: number\): void
+### lock
+
+lock(timeout: number): void
锁定和持有RunningLock
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- timeout
- |
- number
- |
- 否
- |
- 锁定和持有RunningLock的时长。
- |
-
-
-
-
-- 示例：
-
- ```
- runningLock.createRunningLock("running_lock_test", runningLock.RunningLockType.BACKGROUND)
- .then(runningLock => {
- runningLock.lock(100)
- console.info('create runningLock success')
- })
- .catch(error => {
- console.log('Lock runningLock test error: ' + error)
- });
- ```
-
-
-### unlock
-
-unlock\(\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | timeout | number | 否 | 锁定和持有RunningLock的时长。 |
+
+- 示例：
+ ```
+ runningLock.createRunningLock("running_lock_test", runningLock.RunningLockType.BACKGROUND)
+ .then(runningLock => {
+ runningLock.lock(100)
+ console.info('create runningLock success')
+ })
+ .catch(error => {
+ console.log('Lock runningLock test error: ' + error)
+ });
+ ```
-释放Runninglock锁。
-- 示例：
+### unlock
- ```
- runningLock.createRunningLock("running_lock_test", runningLock.RunningLockType.BACKGROUND)
- .then(runningLock => {
- runningLock.unlock()
- console.info('unLock runningLock success')
- })
- .catch(error => {
- console.log('unLock runningLock test error: ' + error)
- });
- ```
+unlock(): void
+释放Runninglock锁。
-### isUsed
+- 示例：
+ ```
+ runningLock.createRunningLock("running_lock_test", runningLock.RunningLockType.BACKGROUND)
+ .then(runningLock => {
+ runningLock.unlock()
+ console.info('unLock runningLock success')
+ })
+ .catch(error => {
+ console.log('unLock runningLock test error: ' + error)
+ });
+ ```
-isUsed\(\): boolean
-查询当前Runninglock是持有状态，还是释放状态。
+### isUsed
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- boolean
- |
- 当前RunningLock是持有状态返回true，释放状态返回false。
- |
-
-
-
-
-- 示例：
-
- ```
- runningLock.createRunningLock("running_lock_test", runningLock.RunningLockType.BACKGROUND)
- .then(runningLock => {
- var used = runningLock.isUsed()
- console.info('runningLock used status: ' + used)
- })
- .catch(error => {
- console.log('runningLock isUsed test error: ' + error)
- });
- ```
+isUsed(): boolean
+查询当前Runninglock是持有状态，还是释放状态。
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | boolean | 当前RunningLock是持有状态返回true，释放状态返回false。 |
+
+- 示例：
+ ```
+ runningLock.createRunningLock("running_lock_test", runningLock.RunningLockType.BACKGROUND)
+ .then(runningLock => {
+ var used = runningLock.isUsed()
+ console.info('runningLock used status: ' + used)
+ })
+ .catch(error => {
+ console.log('runningLock isUsed test error: ' + error)
+ });
+ ```
diff --git a/zh-cn/application-dev/reference/apis/js-apis-sensor.md b/zh-cn/application-dev/reference/apis/js-apis-sensor.md
index 75d83aca39a4a0e442cbdbf19e57bc619f6c1802..a4472bce4bcebd388bb000f3f4f858f143b17ed4 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-sensor.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-sensor.md
@@ -1,3680 +1,1567 @@
-# 传感器
+# 传感器
-> **说明：**
->从API Version 8 开始支持。
+>  **说明：**
+> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
-## 导入模块
+
+## 导入模块
```
import sensor from '@ohos.sensor';
```
-## 权限列表
-计步器：ohos.permission.ACTIVITY\_MOTION
+## 权限列表
+
+计步器：ohos.permission.ACTIVITY_MOTION
-心率：ohos.permission.READ\_HEALTH\_DATA
+心率：ohos.permission.READ_HEALTH_DATA
加速度：ohos.permission.ACCELEROMETER
-## sensor.on\(SensorType.SENSOR\_TYPE\_ID\_ACCELEROMETER\)
+陀螺仪：ohos.permission.GYROSCOPE
+
+
+## sensor.on(SensorType.SENSOR_TYPE_ID_ACCELEROMETER)
+
+on(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback: AsyncCallback<AccelerometerResponse>,options?: Options): void
-on\(type: SensorType.SENSOR\_TYPE\_ID\_ACCELEROMETER, callback: AsyncCallback,options?: Options\): void
监听加速度传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-要订阅的加速度传感器类型为SENSOR_TYPE_ID_ACCELEROMETER。
- |
-
-callback
- |
-AsyncCallback<AccelerometerResponse>
- |
-是
- |
-注册加速度传感器的回调函数，上报的数据类型为AccelerometerResponse。
- |
-
-Options
- |
-options
- |
-否
- |
-可选参数列表，设置上报频率，默认值为200000000ns。
- |
-
-
-
-
-**示例**：
-```
-sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER, function(error, data) {
- if (error) {
- console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
- return;
- }
- //打印data的x,y,z轴坐标的分量
- console.info('X-coordinate component: ' + data.x);
- console.info('Y-coordinate component: ' + data.y);
- console.info('Z-coordinate component: ' + data.z);
- },
- {interval: 10000000}
-);
-```
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 要订阅的加速度传感器类型为SENSOR_TYPE_ID_ACCELEROMETER。 |
+ | callback | AsyncCallback<[AccelerometerResponse](#accelerometerresponse)> | 是 | 注册加速度传感器的回调函数，上报的数据类型为AccelerometerResponse。 |
+ | options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 |
-## sensor.on\(SensorType.SENSOR\_TYPE\_ID\_LINEAR\_ACCELERATION\)
+- 示例：
+ ```
+ sensor.on(type:SensorType.SENSOR_TYPE_ID_ACCELEROMETER,function(error,data){
+ if (error) {
+ console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ //打印data的x,y,z轴坐标的分量
+ console.info('X-coordinate component: ' + data.x);
+ console.info('Y-coordinate component: ' + data.y);
+ console.info('Z-coordinate component: ' + data.z);
+ },
+ {interval: 10000000}
+ );
+ ```
-on\(type:SensorType.SENSOR\_TYPE\_ID\_LINEAR\_ACCELERATION,callback:AsyncCallback, options?: Options\): void
-监听线性加速度传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
+## sensor.on(SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION)
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-要订阅的线性加速度传感器类型为SENSOR_TYPE_ID_LINEAR_ACCELERATION。
- |
-
-callback
- |
-AsyncCallback<LinearAccelerometerResponse>
- |
-是
- |
-注册线性加速度传感器的回调函数，上报的数据类型为LinearAccelerometerResponse。
- |
-
-Options
- |
-options
- |
-否
- |
-可选参数列表，设置上报频率，默认值为200000000ns。
- |
-
-
-
-
-**示例**：
+on(type:SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,callback:AsyncCallback<LinearAccelerometerResponse>, options?: Options): void
-```
-sensor.on(sensor.SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION, function(error, data) {
- if (error) {
- console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
- return;
+监听线性加速度传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 要订阅的线性加速度传感器类型为SENSOR_TYPE_ID_LINEAR_ACCELERATION。 |
+ | callback | AsyncCallback<[LinearAccelerometerResponse](#linearaccelerometerresponse)> | 是 | 注册线性加速度传感器的回调函数，上报的数据类型为LinearAccelerometerResponse。 |
+ | options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 |
+
+- 示例：
+ ```
+ sensor.on(type:SensorType.SENSOR_TYPE_ID_LINEAR_ACCELEROMETER,function(error,data){
+ if (error) {
+ console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ //打印data的x,y,z轴坐标的分量
+ console.info('X-coordinate component: ' + data.x);
+ console.info('Y-coordinate component: ' + data.y);
+ console.info('Z-coordinate component: ' + data.z);
}
- //打印data的x,y,z轴坐标的分量
- console.info('X-coordinate component: ' + data.x);
- console.info('Y-coordinate component: ' + data.y);
- console.info('Z-coordinate component: ' + data.z);
- }
- {interval: 10000000}
-);
-```
+ {interval: 10000000}
+ );
+ ```
-## sensor.on\(SensorType.SENSOR\_TYPE\_ID\_ACCELEROMETER\_UNCALIBRATED\)
-on\(type:SensorType.SENSOR\_TYPE\_ID\_ACCELEROMETER\_UNCALIBRATED,callback:AsyncCallback, options?: Options\): void
+## sensor.on(SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED)
-监听未校准加速度计传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
+on(type:SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,callback:AsyncCallback<AccelerometerUncalibratedResponse>, options?: Options): void
-**参数**：
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-要订阅的未校准加速度计传感器类型为SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED。
- |
-
-callback
- |
-AsyncCallback<AccelerometerUncalibratedResponse>
- |
-是
- |
-注册未校准加速度计传感器的回调函数，上报的数据类型为AccelerometerUncalibratedResponse。
- |
-
-Options
- |
-options
- |
-否
- |
-可选参数列表，设置上报频率，默认值为200000000ns。
- |
-
-
-
-
-**示例**：
+监听未校准加速度计传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
-```
-sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED, function(error, data) {
- if (error) {
- console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
- return;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 要订阅的未校准加速度计传感器类型为SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED。 |
+ | callback | AsyncCallback<[AccelerometerUncalibratedResponse](#accelerometeruncalibratedresponse)> | 是 | 注册未校准加速度计传感器的回调函数，上报的数据类型为AccelerometerUncalibratedResponse。 |
+ | options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 |
+
+- 示例：
+ ```
+ sensor.on(type:SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,function(error,data){
+ if (error) {
+ console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ //打印data的x,y,z轴坐标的分量
+ console.info('X-coordinate component: ' + data.x);
+ console.info('Y-coordinate component: ' + data.y);
+ console.info('Z-coordinate component: ' + data.z);
+ //打印data在x,y,z轴坐标的偏移量
+ console.info('X-coordinate bias: ' + data.biasX);
+ console.info('Y-coordinate bias: ' + data.biasY);
+ console.info('Z-coordinate bias: ' + data.biasZ);
}
- //打印data的x,y,z轴坐标的分量
- console.info('X-coordinate component: ' + data.x);
- console.info('Y-coordinate component: ' + data.y);
- console.info('Z-coordinate component: ' + data.z);
- //打印data在x,y,z轴坐标的偏移量
- console.info('X-coordinate bias: ' + data.biasX);
- console.info('Y-coordinate bias: ' + data.biasY);
- console.info('Z-coordinate bias: ' + data.biasZ);
- }
- {interval: 10000000}
-);
-```
+ {interval: 10000000}
+ );
+ ```
-## sensor.on\(SensorType.SENSOR\_TYPE\_ID\_GRAVITY\)
-on\(type: SensorType.SENSOR\_TYPE\_ID\_GRAVITY, callback: AsyncCallback,options?: Options\): void
+## sensor.on(SensorType.SENSOR_TYPE_ID_GRAVITY)
-监听重力传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
+on(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback: AsyncCallback<GravityResponse>,options?: Options): void
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-要订阅的重力传感器类型为SENSOR_TYPE_ID_GRAVITY。
- |
-
-callback
- |
-AsyncCallback<GravityResponse>
- |
-是
- |
-注册重力传感器的回调函数，上报的数据类型为GravityResponse。
- |
-
-Options
- |
-options
- |
-否
- |
-可选参数列表，设置上报频率，默认值为200000000ns。
- |
-
-
-
-
-**示例**：
+监听重力传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
-```
-sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GRAVITY, function(error, data) {
- if (error) {
- console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
- return;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 要订阅的重力传感器类型为SENSOR_TYPE_ID_GRAVITY。 |
+ | callback | AsyncCallback<[GravityResponse](#gravityresponse)> | 是 | 注册重力传感器的回调函数，上报的数据类型为GravityResponse。 |
+ | options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 |
+
+- 示例：
+ ```
+ sensor.on(type:SensorType.SENSOR_TYPE_ID_GRAVITY,function(error,data){
+ if (error) {
+ console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ //打印data的x,y,z轴坐标的分量
+ console.info('X-coordinate component: ' + data.x);
+ console.info('Y-coordinate component: ' + data.y);
+ console.info('Z-coordinate component: ' + data.z);
}
- //打印data的x,y,z轴坐标的分量
- console.info('X-coordinate component: ' + data.x);
- console.info('Y-coordinate component: ' + data.y);
- console.info('Z-coordinate component: ' + data.z);
- }
- {interval: 10000000}
-);
-```
+ {interval: 10000000}
+ );
+ ```
-## sensor.on\(SensorType.SENSOR\_TYPE\_ID\_GYROSCOPE\)
-on\(type: SensorType.SENSOR\_TYPE\_ID\_GYROSCOPE, callback: AsyncCallback, options?: Options\): void
+## sensor.on(SensorType.SENSOR_TYPE_ID_GYROSCOPE)
-监听陀螺仪传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
+on(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback: AsyncCallback<GyroscopeResponse>, options?: Options): void
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-要订阅的陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE。
- |
-
-callback
- |
-AsyncCallback<GyroscopeResponse>
- |
-是
- |
-注册陀螺仪传感器的回调函数，上报的数据类型为GyroscopeResponse。
- |
-
-Options
- |
-options
- |
-否
- |
-可选参数列表，设置上报频率，默认值为200000000ns。
- |
-
-
-
-
-**示例：**
+监听陀螺仪传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
-```
-sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE, function(error, data) {
- if (error) {
- console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
- return;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 要订阅的陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE。 |
+ | callback | AsyncCallback<[GyroscopeResponse](#gyroscoperesponse)> | 是 | 注册陀螺仪传感器的回调函数，上报的数据类型为GyroscopeResponse。 |
+ | options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 |
+
+- 示例：
+ ```
+ sensor.on(type:SensorType.SENSOR_TYPE_ID_GUROSCOPE,function(error,data){
+ if (error) {
+ console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ //打印data的x,y,z轴坐标的分量
+ console.info('X-coordinate component: ' + data.x);
+ console.info('Y-coordinate component: ' + data.y);
+ console.info('Z-coordinate component: ' + data.z);
}
- //打印data的x,y,z轴坐标的分量
- console.info('X-coordinate component: ' + data.x);
- console.info('Y-coordinate component: ' + data.y);
- console.info('Z-coordinate component: ' + data.z);
- }
- {interval: 10000000}
-);
-```
+ {interval: 10000000}
+ );
+ ```
-## sensor.on\(SensorType.SENSOR\_TYPE\_ID\_GYROSCOPE\_UNCALIBRATED\)
-on\(type:SensorType.SENSOR\_TYPE\_ID\_GYROSCOPE\_UNCALIBRATED,callback:AsyncCallback, options?: Options\): void
+## sensor.on(SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED)
-监听未校准陀螺仪传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
+on(type:SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,callback:AsyncCallback<GyroscopeUncalibratedResponse>, options?: Options): void
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-要订阅的未校准陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED。
- |
-
-callback
- |
-AsyncCallback<GyroscopeUncalibratedResponse>
- |
-是
- |
-注册未校准陀螺仪传感器的回调函数，上报的数据类型为GyroscopeUncalibratedResponse。
- |
-
-Options
- |
-options
- |
-否
- |
-可选参数列表，设置上报频率。
- |
-
-
-
-
-**示例：**
+监听未校准陀螺仪传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
-```
-sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, function(error, data) {
- if (error) {
- console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
- return;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 要订阅的未校准陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED。 |
+ | callback | AsyncCallback<[GyroscopeUncalibratedResponse](#gyroscopeuncalibratedresponse)> | 是 | 注册未校准陀螺仪传感器的回调函数，上报的数据类型为GyroscopeUncalibratedResponse。 |
+ | options | [Options](#options) | 否 | 可选参数列表，设置上报频率。 |
+
+- 示例：
+ ```
+ sensor.on(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,function(error,data){
+ if (error) {
+ console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ //打印data的x,y,z轴坐标的分量
+ console.info('X-coordinate component: ' + data.x);
+ console.info('Y-coordinate component: ' + data.y);
+ console.info('Z-coordinate component: ' + data.z);
+ //打印data的x,y,z轴坐标的偏移量
+ console.info('X-coordinate bias: ' + data.biasX);
+ console.info('Y-coordinate bias: ' + data.biasY);
+ console.info('Z-coordinate bias: ' + data.biasZ);
}
- //打印data的x,y,z轴坐标的分量
- console.info('X-coordinate component: ' + data.x);
- console.info('Y-coordinate component: ' + data.y);
- console.info('Z-coordinate component: ' + data.z);
- //打印data的x,y,z轴坐标的偏移量
- console.info('X-coordinate bias: ' + data.biasX);
- console.info('Y-coordinate bias: ' + data.biasY);
- console.info('Z-coordinate bias: ' + data.biasZ);
- }
- {interval: 10000000}
-);
-```
+ {interval: 10000000}
+ );
+ ```
-## sensor.on\(SensorType.SENSOR\_TYPE\_ID\_SIGNIFICANT\_MOTION\)
-on\(type: SensorType.SENSOR\_TYPE\_ID\_SIGNIFICANT\_MOTION, callback: AsyncCallback, options?: Options\): void
+## sensor.on(SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION)
-监听有效运动传感器数据变化。如果多次调用该接口，仅最后一次调用生效。
+on(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, callback: AsyncCallback<SignificantMotionResponse>, options?: Options): void
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-要订阅的有效运动传感器类型为SENSOR_TYPE_ID_SIGNIFICANT_MOTION。
- |
-
-callback
- |
-AsyncCallback<SignificantMotionResponse>
- |
-是
- |
-注册有效运动传感器的回调函数，上报的数据类型为SignificantMotionResponse。
- |
-
-Options
- |
-options
- |
-否
- |
-可选参数列表，设置上报频率，默认值为200000000ns。
- |
-
-
-
-
-**示例：**
+监听有效运动传感器数据变化。如果多次调用该接口，仅最后一次调用生效。
-```
-sensor.on(sensor.SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, function(error, data) {
- if (error) {
- console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
- return;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 要订阅的有效运动传感器类型为SENSOR_TYPE_ID_SIGNIFICANT_MOTION。 |
+ | callback | AsyncCallback<[SignificantMotionResponse](#significantmotionresponse)> | 是 | 注册有效运动传感器的回调函数，上报的数据类型为SignificantMotionResponse。 |
+ | options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 |
+
+- 示例：
+ ```
+ sensor.on(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION,function(error,data){
+ if (error) {
+ console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ console.info('Scalar data: ' + data.scalar);
}
- console.info('Scalar data: ' + data.scalar);
- }
- {interval: 10000000}
-);
-```
+ {interval: 10000000}
+ );
+ ```
-## sensor.on\(SensorType.SENSOR\_TYPE\_ID\_PEDOMETER\_DETECTION\)
-on\(type: SensorType.SENSOR\_TYPE\_ID\_PEDOMETER\_DETECTION, callback: AsyncCallback, options?: Options\): void
+## sensor.on(SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION)
-监听计步检测传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
+on(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, callback: AsyncCallback<PedometerDetectResponse>, options?: Options): void
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-要订阅的计步检测传感器类型为SENSOR_TYPE_ID_PEDOMETER_DETECTION。
- |
-
-callback
- |
-AsyncCallback<PedometerDetectResponse>
- |
-是
- |
-注册计步检测传感器的回调函数，上报的数据类型为PedometerDetectResponse。
- |
-
-Options
- |
-options
- |
-否
- |
-可选参数列表，设置上报频率，默认值为200000000ns。
- |
-
-
-
-
-**示例：**
+监听计步检测传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
-```
-sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, function(error, data) {
- if (error) {
- console.error(""Subscription failed. Error code: " + error.code + "; message: " + error.message);
- return;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 要订阅的计步检测传感器类型为SENSOR_TYPE_ID_PEDOMETER_DETECTION。 |
+ | callback | AsyncCallback<[PedometerDetectResponse](#pedometerdetectresponse)> | 是 | 注册计步检测传感器的回调函数，上报的数据类型为PedometerDetectResponse。 |
+ | options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 |
+
+- 示例：
+ ```
+ sensor.on(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION,function(error,data){
+ if (error) {
+ console.error(""Subscription failed. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ console.info('Scalar data: ' + data.scalar);
}
- console.info('Scalar data: ' + data.scalar);
- }
- {interval: 10000000}
-);
-```
+ {interval: 10000000}
+ );
+ ```
-## sensor.on\(SensorType.SENSOR\_TYPE\_ID\_PEDOMETER\)
-on\(type: SensorType.SENSOR\_TYPE\_ID\_PEDOMETER, callback: AsyncCallback, options?: Options\): void
+## sensor.on(SensorType.SENSOR_TYPE_ID_PEDOMETER)
-监听计步传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
+on(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback: AsyncCallback<PedometerResponse>, options?: Options): void
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-要订阅的计步传感器类型为SENSOR_TYPE_ID_PEDOMETER。
- |
-
-callback
- |
-AsyncCallback<PedometerResponse>
- |
-是
- |
-注册计步传感器的回调函数，上报的数据类型为PedometerResponse。
- |
-
-Options
- |
-options
- |
-否
- |
-可选参数列表，设置上报频率，默认值为200000000ns。
- |
-
-
-
-
-**示例：**
+监听计步传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
-```
-sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER, function(error, data) {
- if (error) {
- console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
- return;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 要订阅的计步传感器类型为SENSOR_TYPE_ID_PEDOMETER。 |
+ | callback | AsyncCallback<[PedometerResponse](#pedometerresponse)> | 是 | 注册计步传感器的回调函数，上报的数据类型为PedometerResponse。 |
+ | options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 |
+
+- 示例：
+ ```
+ sensor.on(type: SensorType.SENSOR_TYPE_ID_PEDOMETER,function(error,data){
+ if (error) {
+ console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ //打印data的步数
+ console.info('Steps: ' + data.steps);
}
- //打印data的步数
- console.info('Steps: ' + data.steps);
- }
- {interval: 10000000}
-);
-```
+ {interval: 10000000}
+ );
+ ```
-## sensor.on\(SensorType.SENSOR\_TYPE\_ID\_AMBIENT\_TEMPERATURE\)
-on\(type:SensorType.SENSOR\_TYPE\_ID\_AMBIENT\_TEMPERATURE,callback:AsyncCallback, options?: Options\): void
+## sensor.on(SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE)
-监听环境温度传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
+on(type:SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,callback:AsyncCallback<AmbientTemperatureResponse>, options?: Options): void
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-要订阅的环境温度传感器类型为SENSOR_TYPE_ID_AMBIENT_TEMPERATURE。
- |
-
-callback
- |
-AsyncCallback<AmbientTemperatureResponse>
- |
-是
- |
-注册环境温度传感器的回调函数，上报的数据类型为AmbientTemperatureResponse。
- |
-
-Options
- |
-options
- |
-否
- |
-可选参数列表，设置上报频率，默认值为200000000ns。
- |
-
-
-
-
-**示例：**
+监听环境温度传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
-```
-sensor.on(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, function(error, data) {
- if (error) {
- console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
- return;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 要订阅的环境温度传感器类型为SENSOR_TYPE_ID_AMBIENT_TEMPERATURE。 |
+ | callback | AsyncCallback<[AmbientTemperatureResponse](#ambienttemperatureresponse)> | 是 | 注册环境温度传感器的回调函数，上报的数据类型为AmbientTemperatureResponse。 |
+ | options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 |
+
+- 示例：
+ ```
+ sensor.on(type: SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,function(error,data){
+ if (error) {
+ console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ //打印data的温度值
+ console.info('Temperature: ' + data.temperature);
}
- //打印data的温度值
- console.info('Temperature: ' + data.temperature);
- }
- {interval: 10000000}
-);
-```
+ {interval: 10000000}
+ );
+ ```
-## sensor.on\(SensorType.SENSOR\_TYPE\_ID\_MAGNETIC\_FIELD\)
-on\(type: SensorType.SENSOR\_TYPE\_ID\_MAGNETIC\_FIELD, callback: AsyncCallback,options?: Options\): void
+## sensor.on(SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD)
-监听磁场传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
+on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback: AsyncCallback<MagneticFieldResponse>,options?: Options): void
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-要订阅的磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD。
- |
-
-callback
- |
-AsyncCallback<MagneticFieldResponse>
- |
-是
- |
-注册磁场传感器的回调函数，上报的数据类型为MagneticFieldResponse。
- |
-
-Options
- |
-options
- |
-否
- |
-可选参数列表，设置上报频率，默认值为200000000ns。
- |
-
-
-
-
-**示例：**
+监听磁场传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
-```
-sensor.on(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, function(error, data) {
- if (error) {
- console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
- return;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 要订阅的磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD。 |
+ | callback | AsyncCallback<[MagneticFieldResponse](#magneticfieldresponse)> | 是 | 注册磁场传感器的回调函数，上报的数据类型为MagneticFieldResponse。 |
+ | options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 |
+
+- 示例：
+ ```
+ sensor.on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD,function(error,data){
+ if (error) {
+ console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ //打印data的x,y,z轴坐标的分量
+ console.info('X-coordinate component: ' + data.x);
+ console.info('Y-coordinate component: ' + data.y);
+ console.info('Z-coordinate component: ' + data.z);
}
- //打印data的x,y,z轴坐标的分量
- console.info('X-coordinate component: ' + data.x);
- console.info('Y-coordinate component: ' + data.y);
- console.info('Z-coordinate component: ' + data.z);
- }
- {interval: 10000000}
-);
-```
+ {interval: 10000000}
+ );
+ ```
-## sensor.on\(SensorType.SENSOR\_TYPE\_ID\_MAGNETIC\_FIELD\_UNCALIBRATED\)
-on\(type:SensorType.SENSOR\_TYPE\_ID\_MAGNETIC\_FIELD\_UNCALIBRATED,callback:AsyncCallback, options: Options\): void
+## sensor.on(SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED)
-监听未校准磁场传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
+on(type:SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,callback:AsyncCallback<MagneticFieldUncalibratedResponse>, options: Options): void
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-要订阅的未校准磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED。
- |
-
-callback
- |
-AsyncCallback<MagneticFieldUncalibratedResponse>
- |
-是
- |
-注册未校准磁场传感器的回调函数，上报的数据类型为MagneticFieldUncalibratedResponse。
- |
-
-Options
- |
-options
- |
-否
- |
-可选参数列表，设置上报频率，默认值为200000000ns。
- |
-
-
-
-
-**示例：**
+监听未校准磁场传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
-```
-sensor.on(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED, function(error, data) {
- if (error) {
- console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
- return;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 要订阅的未校准磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED。 |
+ | callback | AsyncCallback<[MagneticFieldUncalibratedResponse](#magneticfielduncalibratedresponse)> | 是 | 注册未校准磁场传感器的回调函数，上报的数据类型为MagneticFieldUncalibratedResponse。 |
+ | options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 |
+
+- 示例：
+ ```
+ ensor.on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,function(error,data){
+ if (error) {
+ console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ //打印data的x,y,z轴坐标的分量
+ console.info('X-coordinate component: ' + data.x);
+ console.info('Y-coordinate component: ' + data.y);
+ console.info('Z-coordinate component: ' + data.z);
+ //打印data的x,y,z轴坐标的偏移量
+ console.info('X-coordinate bias: ' + data.biasX);
+ console.info('Y-coordinate bias: ' + data.biasY);
+ console.info('Z-coordinate bias: ' + data.biasZ);
}
- //打印data的x,y,z轴坐标的分量
- console.info('X-coordinate component: ' + data.x);
- console.info('Y-coordinate component: ' + data.y);
- console.info('Z-coordinate component: ' + data.z);
- //打印data的x,y,z轴坐标的偏移量
- console.info('X-coordinate bias: ' + data.biasX);
- console.info('Y-coordinate bias: ' + data.biasY);
- console.info('Z-coordinate bias: ' + data.biasZ);
- }
- {interval: 10000000} //设置数据的上报频率。
-);
-```
+ {interval: 10000000} //设置数据的上报频率。
+ );
+ ```
-## sensor.on\(SensorType.SENSOR\_TYPE\_ID\_PROXIMITY\)
-on\(type: SensorType.SENSOR\_TYPE\_ID\_PROXIMITY, callback: AsyncCallback,options?: Options\): void
+## sensor.on(SensorType.SENSOR_TYPE_ID_PROXIMITY)
-监听接近光传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
+on(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback: AsyncCallback<ProximityResponse>,options?: Options): void
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-要订阅的接近光传感器类型为SENSOR_TYPE_ID_PROXIMITY。
- |
-
-callback
- |
-AsyncCallback<ProximityResponse>
- |
-是
- |
-注册接近光传感器的回调函数，上报的数据类型为ProximityResponse。
- |
-
-Options
- |
-options
- |
-否
- |
-可选参数列表，设置上报频率，默认值为200000000ns。
- |
-
-
-
-
-**示例：**
+监听接近光传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
-```
-sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PROXIMITY, function(error, data) {
- if (error) {
- console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
- return;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 要订阅的接近光传感器类型为SENSOR_TYPE_ID_PROXIMITY。 |
+ | callback | AsyncCallback<[ProximityResponse](#proximityresponse)> | 是 | 注册接近光传感器的回调函数，上报的数据类型为ProximityResponse。 |
+ | options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 |
+
+- 示例：
+ ```
+ sensor.on(type: SensorType.SENSOR_TYPE_ID_PROXIMITY,function(error,data){
+ if (error) {
+ console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ //打印data的距离值
+ console.info('Distance: ' + data.distance);
}
- //打印data的距离值
- console.info('Distance: ' + data.distance);
- }
- {interval: 10000000}
-);
-```
+ {interval: 10000000}
+ );
+ ```
-## sensor.on\(SensorType.SENSOR\_TYPE\_ID\_HUMIDITY\)
-on\(type: SensorType.SENSOR\_TYPE\_ID\_HUMIDITY, callback: AsyncCallback,options?: Options\): void
+## sensor.on(SensorType.SENSOR_TYPE_ID_HUMIDITY)
-监听湿度传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
+on(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback: AsyncCallback<HumidityResponse>,options?: Options): void
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-要订阅的湿度传感器类型为SENSOR_TYPE_ID_HUMIDITY。
- |
-
-callback
- |
-AsyncCallback<HumidityResponse>
- |
-是
- |
-注册湿度传感器的回调函数，上报的数据类型为HumidityResponse。
- |
-
-Options
- |
-options
- |
-否
- |
-可选参数列表，设置上报频率，默认值为200000000ns。
- |
-
-
-
-
-**示例：**
+监听湿度传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
-```
-sensor.on(sensor.SensorType.SENSOR_TYPE_ID_HUMIDITY, function(error, data) {
- if (error) {
- console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
- return;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 要订阅的湿度传感器类型为SENSOR_TYPE_ID_HUMIDITY。 |
+ | callback | AsyncCallback<[HumidityResponse](#humidityresponse)> | 是 | 注册湿度传感器的回调函数，上报的数据类型为HumidityResponse。 |
+ | options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 |
+
+- 示例：
+ ```
+ sensor.on(type: SensorType.SENSOR_TYPE_ID_HUMIDITY,function(error,data){
+ if (error) {
+ console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ //打印data的湿度值
+ console.info('Humidity: ' + data.humidity);
}
- //打印data的湿度值
- console.info('Humidity: ' + data.humidity);
- }
- {interval: 10000000}
-);
-```
+ {interval: 10000000}
+ );
+ ```
-## sensor.on\(SensorType.SENSOR\_TYPE\_ID\_BAROMETER\)
-on\(type: SensorType.SENSOR\_TYPE\_ID\_BAROMETER, callback: AsyncCallback,options?: Options\): void
+## sensor.on(SensorType.SENSOR_TYPE_ID_BAROMETER)
-监听气压计传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
+on(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback: AsyncCallback<BarometerResponse>,options?: Options): void
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-要订阅的气压计传感器类型为SENSOR_TYPE_ID_BAROMETER。
- |
-
-callback
- |
-AsyncCallback<BarometerResponse>
- |
-是
- |
-注册气压计传感器的回调函数，上报的数据类型为BarometerResponse。
- |
-
-Options
- |
-options
- |
-否
- |
-可选参数列表，设置上报频率，默认值为200000000ns。
- |
-
-
-
-
-**示例：**
+监听气压计传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
-```
-sensor.on(sensor.SensorType.SENSOR_TYPE_ID_BAROMETER, function(error, data) {
- if (error) {
- console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
- return;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 要订阅的气压计传感器类型为SENSOR_TYPE_ID_BAROMETER。 |
+ | callback | AsyncCallback<[BarometerResponse](#barometerresponse)> | 是 | 注册气压计传感器的回调函数，上报的数据类型为BarometerResponse。 |
+ | options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 |
+
+- 示例：
+ ```
+ sensor.on(type: SensorType.SENSOR_TYPE_ID_BAROMETER,function(error,data){
+ if (error) {
+ console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ //打印data的压强值
+ console.info('Atmospheric pressure: ' + data.pressure);
}
- //打印data的压强值
- console.info('Atmospheric pressure: ' + data.pressure);
- }
- {interval: 10000000}
-);
-```
+ {interval: 10000000}
+ );
+ ```
-## sensor.on\(SensorType.SENSOR\_TYPE\_ID\_HALL\)
-on\(type: SensorType.SENSOR\_TYPE\_ID\_HALL, callback: AsyncCallback, options?: Options\): void
+## sensor.on(SensorType.SENSOR_TYPE_ID_HALL)
-监听霍尔传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
+on(type: SensorType.SENSOR_TYPE_ID_HALL, callback: AsyncCallback<HallResponse>, options?: Options): void
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-要订阅的霍尔传感器类型为SENSOR_TYPE_ID_HALL。
- |
-
-callback
- |
-AsyncCallback<HallResponse>
- |
-是
- |
-注册霍尔传感器的回调函数，上报的数据类型为 HallResponse。
- |
-
-Options
- |
-options
- |
-否
- |
-可选参数列表，设置上报频率，默认值为200000000ns。
- |
-
-
-
-
-**示例：**
+监听霍尔传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
-```
-sensor.on(sensor.SensorType.SENSOR_TYPE_ID_HALL, function(error, data) {
- if (error) {
- console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
- return;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 要订阅的霍尔传感器类型为SENSOR_TYPE_ID_HALL。 |
+ | callback | AsyncCallback<[HallResponse](#hallresponse)> | 是 | 注册霍尔传感器的回调函数，上报的数据类型为 HallResponse。 |
+ | options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 |
+
+- 示例：
+ ```
+ sensor.on(type: SensorType.SENSOR_TYPE_ID_HALL,function(error,data){
+ if (error) {
+ console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ //打印data的状态值
+ console.info('Status: ' + data.status);
}
- //打印data的状态值
- console.info('Status: ' + data.status);
- }
- {interval: 10000000}
-);
-```
+ {interval: 10000000}
+ );
+ ```
-## sensor.on\(SensorType.SENSOR\_TYPE\_ID\_AMBIENT\_LIGHT\)
-on\(type: SensorType.SENSOR\_TYPE\_ID\_AMBIENT\_LIGHT, callback: AsyncCallback, options?: Options\): void
+## sensor.on(SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT)
-监听环境光传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
+on(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback: AsyncCallback<LightResponse>, options?: Options): void
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-要订阅的环境光传感器类型为SENSOR_TYPE_ID_AMBIENT_LIGHT。
- |
-
-callback
- |
-AsyncCallback<LightResponse>
- |
-是
- |
-注册环境光传感器的回调函数，上报的数据类型为LightResponse。
- |
-
-Options
- |
-options
- |
-否
- |
-可选参数列表，设置上报频率，默认值为200000000ns。
- |
-
-
-
-
-**示例：**
+监听环境光传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
-```
-sensor.on(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, function(error, data) {
- if (error) {
- console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
- return;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 要订阅的环境光传感器类型为SENSOR_TYPE_ID_AMBIENT_LIGHT。 |
+ | callback | AsyncCallback<[LightResponse](#lightresponse)> | 是 | 注册环境光传感器的回调函数，上报的数据类型为LightResponse。 |
+ | options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 |
+
+- 示例：
+ ```
+ sensor.on(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT,function(error,data){
+ if (error) {
+ console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ //打印data的光强值
+ console.info(''Illumination: ' + data.intensity);
}
- //打印data的光强值
- console.info(''Illumination: ' + data.intensity);
- }
- {interval: 10000000}
-);
-```
+ {interval: 10000000}
+ );
+ ```
-## sensor.on\(SensorType.SENSOR\_TYPE\_ID\_ORIENTATION\)
-on\(type: SensorType.SENSOR\_TYPE\_ID\_ORIENTATION, callback: AsyncCallback, options?: Options\): void
+## sensor.on(SensorType.SENSOR_TYPE_ID_ORIENTATION)
-监听方向传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
+on(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback: AsyncCallback<OrientationResponse>, options?: Options): void
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-要订阅的方向传感器类型为SENSOR_TYPE_ID_ORIENTATION
- |
-
-callback
- |
-AsyncCallback<OrientationResponse>
- |
-是
- |
-注册方向传感器的回调函数，上报的数据类型为OrientationResponse。
- |
-
-Options
- |
-options
- |
-否
- |
-可选参数列表，设置上报频率，默认值为200000000ns。
- |
-
-
-
-
-**示例：**
+监听方向传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
-```
-sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ORIENTATION, function(error, data) {
- if (error) {
- console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
- return;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 要订阅的方向传感器类型为SENSOR_TYPE_ID_ORIENTATION |
+ | callback | AsyncCallback<[OrientationResponse](#orientationresponse)> | 是 | 注册方向传感器的回调函数，上报的数据类型为OrientationResponse。 |
+ | options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 |
+
+- 示例：
+ ```
+ sensor.on(type: SensorType.SENSOR_TYPE_ID_ORIENTATION,function(error,data){
+ if (error) {
+ console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ //打印data的x,y,z轴坐标的分量
+ console.info('X-coordinate component: ' + data.x);
+ console.info('Y-coordinate component: ' + data.y);
+ console.info('Z-coordinate component: ' + data.z);
}
- //打印data的x,y,z轴坐标的分量
- console.info('X-coordinate component: ' + data.x);
- console.info('Y-coordinate component: ' + data.y);
- console.info('Z-coordinate component: ' + data.z);
- }
- {interval: 10000000}
-);
-```
+ {interval: 10000000}
+ );
+ ```
-## sensor.on\(SensorType.SENSOR\_TYPE\_ID\_ROTATION\_VECTOR\)
-on\(type:SensorType.SENSOR\_TYPE\_ID\_ROTATION\_VECTOR,callback:AsyncCallback,options?: Options\): void
+## sensor.on(SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR)
-监听旋转矢量传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
+on(type:SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR,callback:AsyncCallback<RotationVectorResponse>,options?: Options): void
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-要订阅的旋转矢量传感器类型为SENSOR_TYPE_ID_ROTATION_VECTOR。
- |
-
-callback
- |
-AsyncCallback<RotationVectorResponse>
- |
-是
- |
-注册旋转矢量传感器的回调函数，上报的数据类型为RotationVectorResponse。
- |
-
-Options
- |
-options
- |
-否
- |
-可选参数列表，设置上报频率，默认值为200000000ns。
- |
-
-
-
-
-**示例：**
+监听旋转矢量传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
-```
-sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, function(error, data) {
- if (error) {
- console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
- return;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 要订阅的旋转矢量传感器类型为SENSOR_TYPE_ID_ROTATION_VECTOR。 |
+ | callback | AsyncCallback<[RotationVectorResponse](#rotationvectorresponse)> | 是 | 注册旋转矢量传感器的回调函数，上报的数据类型为RotationVectorResponse。 |
+ | options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 |
+
+- 示例：
+ ```
+ sensor.on(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR,function(error,data){
+ if (error) {
+ console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ //打印data的x,y,z轴坐标的分量
+ console.info('X-coordinate component: ' + data.x);
+ console.info('Y-coordinate component: ' + data.y);
+ console.info('Z-coordinate component: ' + data.z);
}
- //打印data的x,y,z轴坐标的分量
- console.info('X-coordinate component: ' + data.x);
- console.info('Y-coordinate component: ' + data.y);
- console.info('Z-coordinate component: ' + data.z);
- }
- {interval: 10000000}
-);
-```
+ {interval: 10000000}
+ );
+ ```
-## sensor.on\(SensorType.SENSOR\_TYPE\_ID\_WEAR\_DETECTION\)
-on\(type: SensorType.SENSOR\_TYPE\_ID\_WEAR\_DETECTION, callback: AsyncCallback,options?: Options\): void
+## sensor.on(SensorType.SENSOR_TYPE_ID_WEAR_DETECTION)
-监听佩戴检测传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
+on(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback: AsyncCallback<WearDetectionResponse>,options?: Options): void
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-要订阅的佩戴检测传感器类型为SENSOR_TYPE_ID_WEAR_DETECTION。
- |
-
-callback
- |
-AsyncCallback<WearDetectionResponse>
- |
-是
- |
-注册佩戴检测传感器的回调函数，上报的数据类型为WearDetectionResponse。
- |
-
-Options
- |
-options
- |
-否
- |
-可选参数列表，设置上报频率，默认值为200000000ns。
- |
-
-
-
-
-**示例：**
+监听佩戴检测传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
-```
-sensor.on(sensor.SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, function(error, data) {
- if (error) {
- console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
- return;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 要订阅的佩戴检测传感器类型为SENSOR_TYPE_ID_WEAR_DETECTION。 |
+ | callback | AsyncCallback<[WearDetectionResponse](#weardetectionresponse)> | 是 | 注册佩戴检测传感器的回调函数，上报的数据类型为WearDetectionResponse。 |
+ | options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 |
+
+- 示例：
+ ```
+ sensor.on(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION,function(error,data){
+ if (error) {
+ console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ //打印data的佩戴状态
+ console.info('Wear status: ' + data.value);
}
- //打印data的佩戴状态
- console.info('Wear status: ' + data.value);
- }
- {interval: 10000000}
-);
-```
+ {interval: 10000000}
+ );
+ ```
-## sensor.once\(SensorType.SENSOR\_TYPE\_ID\_ACCELEROMETER\)
-once\(type: SensorType.SENSOR\_TYPE\_ID\_ACCELEROMETER, callback: AsyncCallback\): void
+## sensor.once(SensorType.SENSOR_TYPE_ID_ACCELEROMETER)
-监听加速度传感器的数据变化一次。
+once(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback: AsyncCallback<AccelerometerResponse>): void
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-加速度传感器类型为SENSOR_TYPE_ID_ACCELEROMETER。
- |
-
-callback
- |
-AsyncCallback<AccelerometerResponse>
- |
-是
- |
-注册一次加速度传感器的回调函数，上报的数据类型为AccelerometerResponse。
- |
-
-
-
-
-**示例：**
+监听加速度传感器的数据变化一次。
-```
-sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER, function(error, data) {
- if (error) {
- console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
- return;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 加速度传感器类型为SENSOR_TYPE_ID_ACCELEROMETER。 |
+ | callback | AsyncCallback<[AccelerometerResponse](#accelerometerresponse)> | 是 | 注册一次加速度传感器的回调函数，上报的数据类型为AccelerometerResponse。 |
+
+- 示例：
+ ```
+ sensor.once(type:SensorType.SENSOR_TYPE_ID_ACCELEROMETER, function(error, data) {
+ if (error) {
+ console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ //打印data的x,y,z轴坐标的分量
+ console.info('X-coordinate component: ' + data.x);
+ console.info('Y-coordinate component: ' + data.y);
+ console.info('Z-coordinate component: ' + data.z);
}
- //打印data的x,y,z轴坐标的分量
- console.info('X-coordinate component: ' + data.x);
- console.info('Y-coordinate component: ' + data.y);
- console.info('Z-coordinate component: ' + data.z);
- }
-);
-```
+ );
+ ```
-## sensor.once\(SensorType.SENSOR\_TYPE\_ID\_LINEAR\_ACCELERATION\)
-once\(type:SensorType.SENSOR\_TYPE\_ID\_LINEAR\_ACCELERATION,callback:AsyncCallback\): void
+## sensor.once(SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION)
-监听线性加速度传感器数据变化一次。
+once(type:SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,callback:AsyncCallback<LinearAccelerometerResponse>): void
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-线性加速度传感器类型为SENSOR_TYPE_ID_LINEAR_ACCELERATION。
- |
-
-callback
- |
-AsyncCallback<LinearAccelerometerResponse>
- |
-是
- |
-注册一次线性加速度传感器的回调函数，上报的数据类型为LinearAccelerometerResponse。
- |
-
-
-
-
-**示例：**
+监听线性加速度传感器数据变化一次。
-```
-sensor.once(sensor.SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION, function(error, data) {
- if (error) {
- console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
- return;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 线性加速度传感器类型为SENSOR_TYPE_ID_LINEAR_ACCELERATION。 |
+ | callback | AsyncCallback<[LinearAccelerometerResponse](#linearaccelerometerresponse)> | 是 | 注册一次线性加速度传感器的回调函数，上报的数据类型为LinearAccelerometerResponse。 |
+
+- 示例：
+ ```
+ sensor.once(type:SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION, function(error, data) {
+ if (error) {
+ console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ //打印data的x,y,z轴坐标的分量
+ console.info('X-coordinate component: ' + data.x);
+ console.info('Y-coordinate component: ' + data.y);
+ console.info('Z-coordinate component: ' + data.z);
}
- //打印data的x,y,z轴坐标的分量
- console.info('X-coordinate component: ' + data.x);
- console.info('Y-coordinate component: ' + data.y);
- console.info('Z-coordinate component: ' + data.z);
- }
-);
-```
+ );
+ ```
-## sensor.once\(SensorType.SENSOR\_TYPE\_ID\_ACCELEROMETER\_UNCALIBRATED\)
-once\(type:SensorType.SENSOR\_TYPE\_ID\_ACCELEROMETER\_UNCALIBRATED,callback:AsyncCallback\): void
+## sensor.once(SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED)
-监听未校准加速度传感器的数据变化一次。
+once(type:SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,callback:AsyncCallback<AccelerometerUncalibratedResponse>): void
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-未校准加速度传感器类型为SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED。
- |
-
-callback
- |
-AsyncCallback<AccelerometerUncalibratedResponse>
- |
-是
- |
-注册一次未校准加速度传感器的回调函数，上报的数据类型为AccelerometerUncalibratedResponse。
- |
-
-
-
-
-**示例：**
+监听未校准加速度传感器的数据变化一次。
-```
-sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED, function(error, data) {
- if (error) {
- console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
- return;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 未校准加速度传感器类型为SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED。 |
+ | callback | AsyncCallback<[AccelerometerUncalibratedResponse](#accelerometeruncalibratedresponse)> | 是 | 注册一次未校准加速度传感器的回调函数，上报的数据类型为AccelerometerUncalibratedResponse。 |
+
+- 示例：
+ ```
+ sensor.once(type:SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED, function(error, data) {
+ if (error) {
+ console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ //打印data的x,y,z轴坐标的分量
+ console.info('X-coordinate component: ' + data.x);
+ console.info('Y-coordinate component: ' + data.y);
+ console.info('Z-coordinate component: ' + data.z);
+ //打印data的x,y,z轴坐标的偏移量
+ console.info('X-coordinate bias: ' + data.biasX);
+ console.info('Y-coordinate bias: ' + data.biasY);
+ console.info('Z-coordinate bias: ' + data.biasZ);
}
- //打印data的x,y,z轴坐标的分量
- console.info('X-coordinate component: ' + data.x);
- console.info('Y-coordinate component: ' + data.y);
- console.info('Z-coordinate component: ' + data.z);
- //打印data的x,y,z轴坐标的偏移量
- console.info('X-coordinate bias: ' + data.biasX);
- console.info('Y-coordinate bias: ' + data.biasY);
- console.info('Z-coordinate bias: ' + data.biasZ);
- }
-);
-```
+ );
+ ```
-## sensor.once\(SensorType.SENSOR\_TYPE\_ID\_GRAVITY\)
-once\(type: SensorType.SENSOR\_TYPE\_ID\_GRAVITY, callback: AsyncCallback\): void
+## sensor.once(SensorType.SENSOR_TYPE_ID_GRAVITY)
-监听重力传感器的数据变化一次。
+once(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback: AsyncCallback<GravityResponse>): void
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-重力传感器类型为SENSOR_TYPE_ID_GRAVITY。
- |
-
-callback
- |
-AsyncCallback<GravityResponse>
- |
-是
- |
-注册一次重力传感器的回调函数，上报的数据类型为GravityResponse。
- |
-
-
-
-
-**示例：**
+监听重力传感器的数据变化一次。
-```
-sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GRAVITY, function(error, data) {
- if (error) {
- console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
- return;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 重力传感器类型为SENSOR_TYPE_ID_GRAVITY。 |
+ | callback | AsyncCallback<[GravityResponse](#gravityresponse)> | 是 | 注册一次重力传感器的回调函数，上报的数据类型为GravityResponse。 |
+
+- 示例：
+ ```
+ sensor.once(type:SensorType.SENSOR_TYPE_ID_GRAVITY, function(error, data) {
+ if (error) {
+ console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ //打印data的x,y,z轴坐标的分量
+ console.info('X-coordinate component: ' + data.x);
+ console.info('Y-coordinate component: ' + data.y);
+ console.info('Z-coordinate component: ' + data.z);
}
- //打印data的x,y,z轴坐标的分量
- console.info('X-coordinate component: ' + data.x);
- console.info('Y-coordinate component: ' + data.y);
- console.info('Z-coordinate component: ' + data.z);
- }
-);
-```
+ );
+ ```
-## sensor.once\(SensorType.SENSOR\_TYPE\_ID\_GYROSCOPE\)
-once\(type: SensorType.SENSOR\_TYPE\_ID\_GYROSCOPE, callback: AsyncCallback\): void
+## sensor.once(SensorType.SENSOR_TYPE_ID_GYROSCOPE)
-监听陀螺仪传感器的数据变化一次。
+once(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback: AsyncCallback<GyroscopeResponse>): void
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE。
- |
-
-callback
- |
-AsyncCallback<GyroscopeResponse>
- |
-是
- |
-注册一次陀螺仪传感器的回调函数，上报的数据类型为GyroscopeResponse。
- |
-
-
-
-
-**示例：**
+监听陀螺仪传感器的数据变化一次。
-```
-sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE, function(error, data) {
- if (error) {
- console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
- return;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE。 |
+ | callback | AsyncCallback<[GyroscopeResponse](#gyroscoperesponse)> | 是 | 注册一次陀螺仪传感器的回调函数，上报的数据类型为GyroscopeResponse。 |
+
+- 示例：
+ ```
+ sensor.once(type:SensorType.SENSOR_TYPE_ID_GYROSCOPE, function(error, data) {
+ if (error) {
+ console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ //打印data的x,y,z轴坐标的分量
+ console.info('X-coordinate component: ' + data.x);
+ console.info('Y-coordinate component: ' + data.y);
+ console.info('Z-coordinate component: ' + data.z);
}
- //打印data的x,y,z轴坐标的分量
- console.info('X-coordinate component: ' + data.x);
- console.info('Y-coordinate component: ' + data.y);
- console.info('Z-coordinate component: ' + data.z);
- }
-);
-```
+ );
+ ```
-## sensor.once\(SensorType.SENSOR\_TYPE\_ID\_GYROSCOPE\_UNCALIBRATED\)
-once\(type:SensorType.SENSOR\_TYPE\_ID\_GYROSCOPE\_UNCALIBRATED,callback:AsyncCallback\): void
+## sensor.once(SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED)
-监听未校准陀螺仪传感器的数据变化一次。
+once(type:SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,callback:AsyncCallback<GyroscopeUncalibratedResponse>): void
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-未校准陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED。
- |
-
-callback
- |
-AsyncCallback<GyroscopeUncalibratedResponse>
- |
-是
- |
-注册一次未校准陀螺仪传感器的回调函数，上报的数据类型为GyroscopeUncalibratedResponse。
- |
-
-
-
-
-**示例：**
+监听未校准陀螺仪传感器的数据变化一次。
-```
-sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, function(error, data) {
- if (error) {
- console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
- return;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 未校准陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED。 |
+ | callback | AsyncCallback<[GyroscopeUncalibratedResponse](#gyroscopeuncalibratedresponse)> | 是 | 注册一次未校准陀螺仪传感器的回调函数，上报的数据类型为GyroscopeUncalibratedResponse。 |
+
+- 示例：
+ ```
+ sensor.once(type:SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, function(error, data) {
+ if (error) {
+ console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ //打印data的x,y,z轴坐标的分量
+ console.info('X-coordinate component: ' + data.x);
+ console.info('Y-coordinate component: ' + data.y);
+ console.info('Z-coordinate component: ' + data.z);
+ //打印data的x,y,z轴坐标的偏移量
+ console.info('X-coordinate bias: ' + data.biasX);
+ console.info('Y-coordinate bias: ' + data.biasY);
+ console.info('Z-coordinate bias: ' + data.biasZ);
}
- //打印data的x,y,z轴坐标的分量
- console.info('X-coordinate component: ' + data.x);
- console.info('Y-coordinate component: ' + data.y);
- console.info('Z-coordinate component: ' + data.z);
- //打印data的x,y,z轴坐标的偏移量
- console.info('X-coordinate bias: ' + data.biasX);
- console.info('Y-coordinate bias: ' + data.biasY);
- console.info('Z-coordinate bias: ' + data.biasZ);
- }
-);
-```
+ );
+ ```
-## sensor.once\(SensorType.SENSOR\_TYPE\_ID\_SIGNIFICANT\_MOTION\)
-once\(type: SensorType.SENSOR\_TYPE\_ID\_SIGNIFICANT\_MOTION,callback:AsyncCallback\): void
+## sensor.once(SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION)
-监听有效运动传感器的数据变化一次。
+once(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION,callback:AsyncCallback<SignificantMotionResponse>): void
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-有效运动传感器类型为SENSOR_TYPE_ID_SIGNIFICANT_MOTION。
- |
-
-callback
- |
-AsyncCallback<SignificantMotionResponse>
- |
-是
- |
-注册一次有效运动传感器的回调函数，上报的数据类型为SignificantMotionResponse。
- |
-
-
-
-
-**示例：**
+监听有效运动传感器的数据变化一次。
-```
-sensor.once(sensor.SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, function(error, data) {
- if (error) {
- console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
- return;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 有效运动传感器类型为SENSOR_TYPE_ID_SIGNIFICANT_MOTION。 |
+ | callback | AsyncCallback<[SignificantMotionResponse](#significantmotionresponse)> | 是 | 注册一次有效运动传感器的回调函数，上报的数据类型为SignificantMotionResponse。 |
+
+- 示例：
+ ```
+ sensor.once(type:SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, function(error, data) {
+ if (error) {
+ console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ console.info('Scalar data: ' + data.scalar);
}
- console.info('Scalar data: ' + data.scalar);
- }
-);
-```
+ );
+ ```
-## sensor.once\(SensorType.SENSOR\_TYPE\_ID\_PEDOMETER\_DETECTION\)
-once\(type:SensorType.SENSOR\_TYPE\_ID\_PEDOMETER\_DETECTION,callback:AsyncCallback\): void
+## sensor.once(SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION)
-监听计步检测传感器数据变化一次。
+once(type:SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION,callback:AsyncCallback<PedometerDetectResponse>): void
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-计步检测传感器类型为SENSOR_TYPE_ID_PEDOMETER_DETECTION。
- |
-
-callback
- |
-AsyncCallback<PedometerDetectResponse>
- |
-是
- |
-注册一次计步检测传感器的回调函数，上报的数据类型为PedometerDetectResponse。
- |
-
-
-
-
-**示例：**
+监听计步检测传感器数据变化一次。
-```
-sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, function(error, data) {
- if (error) {
- console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
- return;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 计步检测传感器类型为SENSOR_TYPE_ID_PEDOMETER_DETECTION。 |
+ | callback | AsyncCallback<[PedometerDetectResponse](#pedometerdetectresponse)> | 是 | 注册一次计步检测传感器的回调函数，上报的数据类型为PedometerDetectResponse。 |
+
+- 示例：
+ ```
+ sensor.once(type:SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, function(error, data) {
+ if (error) {
+ console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ console.info('Scalar data: ' + data.scalar);
}
- console.info('Scalar data: ' + data.scalar);
- }
-);
-```
+ );
+ ```
-## sensor.once\(SensorType.SENSOR\_TYPE\_ID\_PEDOMETER\)
-once\(type: SensorType.SENSOR\_TYPE\_ID\_PEDOMETER, callback: AsyncCallback\): void
+## sensor.once(SensorType.SENSOR_TYPE_ID_PEDOMETER)
-监听计步器传感器数据变化一次。
+once(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback: AsyncCallback<PedometerResponse>): void
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-计步传感器类型为SENSOR_TYPE_ID_PEDOMETER。
- |
-
-callback
- |
-AsyncCallback<PedometerResponse>
- |
-是
- |
-注册一次计步传感器的回调函数，上报的数据类型为PedometerResponse。
- |
-
-
-
-
-**示例：**
+监听计步器传感器数据变化一次。
-```
-sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER, function(error, data) {
- if (error) {
- console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
- return;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 计步传感器类型为SENSOR_TYPE_ID_PEDOMETER。 |
+ | callback | AsyncCallback<[PedometerResponse](#pedometerresponse)> | 是 | 注册一次计步传感器的回调函数，上报的数据类型为PedometerResponse。 |
+
+- 示例：
+ ```
+ sensor.once(type:SensorType.SENSOR_TYPE_ID_PEDOMETER, function(error, data) {
+ if (error) {
+ console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ //打印data的步数
+ console.info('Steps: ' + data.steps);
}
- //打印data的步数
- console.info('Steps: ' + data.steps);
- }
-);
-```
+ );
+ ```
-## sensor.once\(SensorType.SENSOR\_TYPE\_ID\_AMBIENT\_TEMPERATURE\)
-once\(type:SensorType.SENSOR\_TYPE\_ID\_AMBIENT\_TEMPERATURE,callback:AsyncCallback\): void
+## sensor.once(SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE)
-监听环境温度传感器数据变化一次。
+once(type:SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,callback:AsyncCallback<AmbientTemperatureResponse>): void
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-环境温度传感器类型为SENSOR_TYPE_ID_AMBIENT_TEMPERATURE。
- |
-
-callback
- |
-AsyncCallback<AmbientTemperatureResponse>
- |
-是
- |
-注册一次环境温度传感器的回调函数，上报的数据类型为AmbientTemperatureResponse。
- |
-
-
-
-
-**示例：**
+监听环境温度传感器数据变化一次。
-```
-sensor.once(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, function(error, data) {
- if (error) {
- console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
- return;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 环境温度传感器类型为SENSOR_TYPE_ID_AMBIENT_TEMPERATURE。 |
+ | callback | AsyncCallback<[AmbientTemperatureResponse](#ambienttemperatureresponse)> | 是 | 注册一次环境温度传感器的回调函数，上报的数据类型为AmbientTemperatureResponse。 |
+
+- 示例：
+ ```
+ sensor.once(type:SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, function(error, data) {
+ if (error) {
+ console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ //打印data的温度值
+ console.info('Temperature: ' + data.temperature);
}
- //打印data的温度值
- console.info('Temperature: ' + data.temperature);
- }
-);
-```
+ );
+ ```
-## sensor.once\(SensorType.SENSOR\_TYPE\_ID\_MAGNETIC\_FIELD\)
-once\(type: SensorType.SENSOR\_TYPE\_ID\_MAGNETIC\_FIELD, callback: AsyncCallback\): void
+## sensor.once(SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD)
-监听磁场传感器数据变化一次。
+once(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback: AsyncCallback<MagneticFieldResponse>): void
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD。
- |
-
-callback
- |
-AsyncCallback<MagneticFieldResponse>
- |
-是
- |
-注册一次磁场传感器的回调函数，上报的数据类型为MagneticFieldResponse。
- |
-
-
-
-
-**示例：**
+监听磁场传感器数据变化一次。
-```
-sensor.once(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, function(error, data) {
- if (error) {
- console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
- return;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD。 |
+ | callback | AsyncCallback<[MagneticFieldResponse](#magneticfieldresponse)> | 是 | 注册一次磁场传感器的回调函数，上报的数据类型为MagneticFieldResponse。 |
+
+- 示例：
+ ```
+ sensor.once(type:SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, function(error, data) {
+ if (error) {
+ console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ //打印data的x,y,z轴坐标的分量
+ console.info('X-coordinate component: ' + data.x);
+ console.info('Y-coordinate component: ' + data.y);
+ console.info('Z-coordinate component: ' + data.z);
}
- //打印data的x,y,z轴坐标的分量
- console.info('X-coordinate component: ' + data.x);
- console.info('Y-coordinate component: ' + data.y);
- console.info('Z-coordinate component: ' + data.z);
- }
-);
-```
+ );
+ ```
-## sensor.once\(SensorType.SENSOR\_TYPE\_ID\_MAGNETIC\_FIELD\_UNCALIBRATED\)
-once\(type:SensorType.SENSOR\_TYPE\_ID\_MAGNETIC\_FIELD\_UNCALIBRATED,callback:AsyncCallback\): void
+## sensor.once(SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED)
-监听未校准磁场传感器数据变化一次。
+once(type:SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,callback:AsyncCallback<MagneticFieldUncalibratedResponse>): void
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-未校准磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED。
- |
-
-callback
- |
-AsyncCallback<MagneticFieldUncalibratedResponse>
- |
-是
- |
-注册一次未校准磁场传感器的回调函数，上报的数据类型为MagneticFieldUncalibratedResponse。
- |
-
-
-
-
-**示例：**
+监听未校准磁场传感器数据变化一次。
-```
-sensor.once(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED, function(error, data) {
- if (error) {
- console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
- return;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 未校准磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED。 |
+ | callback | AsyncCallback<[MagneticFieldUncalibratedResponse](#magneticfielduncalibratedresponse)> | 是 | 注册一次未校准磁场传感器的回调函数，上报的数据类型为MagneticFieldUncalibratedResponse。 |
+
+- 示例：
+ ```
+ sensor.once(type:SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED, function(error, data) {
+ if (error) {
+ console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ //打印data的x,y,z轴坐标的分量
+ console.info('X-coordinate component: ' + data.x);
+ console.info('Y-coordinate component: ' + data.y);
+ console.info('Z-coordinate component: ' + data.z);
+ //打印data的x,y,z轴坐标的偏移量
+ console.info('X-coordinate bias: ' + data.biasX);
+ console.info('Y-coordinate bias: ' + data.biasY);
+ console.info('Z-coordinate bias: ' + data.biasZ);
}
- //打印data的x,y,z轴坐标的分量
- console.info('X-coordinate component: ' + data.x);
- console.info('Y-coordinate component: ' + data.y);
- console.info('Z-coordinate component: ' + data.z);
- //打印data的x,y,z轴坐标的偏移量
- console.info('X-coordinate bias: ' + data.biasX);
- console.info('Y-coordinate bias: ' + data.biasY);
- console.info('Z-coordinate bias: ' + data.biasZ);
- }
-);
-```
+ );
+ ```
-## sensor.once\(SensorType.SENSOR\_TYPE\_ID\_PROXIMITY\)
-once\(type: SensorType.SENSOR\_TYPE\_ID\_PROXIMITY, callback: AsyncCallback\): void
+## sensor.once(SensorType.SENSOR_TYPE_ID_PROXIMITY)
-监听接近光传感器数据变化一次。
+once(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback: AsyncCallback<ProximityResponse>): void
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-接近光传感器类型为SENSOR_TYPE_ID_PROXIMITY。
- |
-
-callback
- |
-AsyncCallback<ProximityResponse>
- |
-是
- |
-注册一次接近光传感器的回调函数，上报的数据类型为ProximityResponse。
- |
-
-
-
-
-**示例：**
+监听接近光传感器数据变化一次。
-```
-sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PROXIMITY, function(error, data) {
- if (error) {
- console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
- return;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 接近光传感器类型为SENSOR_TYPE_ID_PROXIMITY。 |
+ | callback | AsyncCallback<[ProximityResponse](#proximityresponse)> | 是 | 注册一次接近光传感器的回调函数，上报的数据类型为ProximityResponse。 |
+
+- 示例：
+ ```
+ sensor.once(type:SensorType.SENSOR_TYPE_ID_PROXIMITY, function(error, data) {
+ if (error) {
+ console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ //打印data的距离值
+ console.info('Distance: ' + data.distance);
}
- //打印data的距离值
- console.info('Distance: ' + data.distance);
- }
-);
-```
+ );
+ ```
-## sensor.once\(SensorType.SENSOR\_TYPE\_ID\_HUMIDITY\)
-once\(type: SensorType.SENSOR\_TYPE\_ID\_HUMIDITY, callback: AsyncCallback\): void
+## sensor.once(SensorType.SENSOR_TYPE_ID_HUMIDITY)
-监听湿度传感器数据变化一次。
+once(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback: AsyncCallback<HumidityResponse>): void
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-湿度传感器类型为SENSOR_TYPE_ID_HUMIDITY。
- |
-
-callback
- |
-AsyncCallback<HumidityResponse>
- |
-是
- |
-注册一次湿度传感器的回调函数，上报的数据类型为HumidityResponse。
- |
-
-
-
-
-**示例：**
+监听湿度传感器数据变化一次。
-```
-sensor.once(sensor.SensorType.SENSOR_TYPE_ID_HUMIDITY, function(error, data) {
- if (error) {
- console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
- return;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 湿度传感器类型为SENSOR_TYPE_ID_HUMIDITY。 |
+ | callback | AsyncCallback<[HumidityResponse](#humidityresponse)> | 是 | 注册一次湿度传感器的回调函数，上报的数据类型为HumidityResponse。 |
+
+- 示例：
+ ```
+ sensor.once(type:SensorType.SENSOR_TYPE_ID_HUMIDITY, function(error, data) {
+ if (error) {
+ console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ //打印data的湿度值
+ console.info('Humidity: ' + data.humidity);
}
- //打印data的湿度值
- console.info('Humidity: ' + data.humidity);
- }
-);
-```
+ );
+ ```
-## sensor.once\(SensorType.SENSOR\_TYPE\_ID\_BAROMETER\)
-once\(type: SensorType.SENSOR\_TYPE\_ID\_BAROMETER, callback: AsyncCallback\): void
+## sensor.once(SensorType.SENSOR_TYPE_ID_BAROMETER)
-监听气压计传感器数据变化一次。
+once(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback: AsyncCallback<BarometerResponse>): void
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-气压计传感器类型为SENSOR_TYPE_ID_BAROMETER。
- |
-
-callback
- |
-AsyncCallback<BarometerResponse>
- |
-是
- |
-注册一次气压计传感器的回调函数，上报的数据类型为BarometerResponse。
- |
-
-
-
-
-**示例：**
+监听气压计传感器数据变化一次。
-```
-sensor.once(sensor.SensorType.SENSOR_TYPE_ID_BAROMETER, function(error, data) {
- if (error) {
- console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
- return;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 气压计传感器类型为SENSOR_TYPE_ID_BAROMETER。 |
+ | callback | AsyncCallback<[BarometerResponse](#barometerresponse)> | 是 | 注册一次气压计传感器的回调函数，上报的数据类型为BarometerResponse。 |
+
+- 示例：
+ ```
+ sensor.once(type:SensorType.SENSOR_TYPE_ID_BAROMETER, function(error, data) {
+ if (error) {
+ console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ //打印data的压强值
+ console.info('Atmospheric pressure: ' + data.pressure);
}
- //打印data的压强值
- console.info('Atmospheric pressure: ' + data.pressure);
- }
-);
-```
+ );
+ ```
-## sensor.once\(SensorType.SENSOR\_TYPE\_ID\_HALL\)
-once\(type: SensorType.SENSOR\_TYPE\_ID\_HALL, callback: AsyncCallback\): void
+## sensor.once(SensorType.SENSOR_TYPE_ID_HALL)
-监听霍尔传感器数据变化一次。
+once(type: SensorType.SENSOR_TYPE_ID_HALL, callback: AsyncCallback<HallResponse>): void
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-霍尔传感器类型为SENSOR_TYPE_ID_HALL。
- |
-
-callback
- |
-AsyncCallback<HallResponse>
- |
-是
- |
-注册一次霍尔传感器的回调函数，上报的数据类型为HallResponse。
- |
-
-
-
-
-**示例：**
+监听霍尔传感器数据变化一次。
-```
-sensor.once(sensor.SensorType.SENSOR_TYPE_ID_HALL, function(error, data) {
- if (error) {
- console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
- return;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 霍尔传感器类型为SENSOR_TYPE_ID_HALL。 |
+ | callback | AsyncCallback<[HallResponse](#hallresponse)> | 是 | 注册一次霍尔传感器的回调函数，上报的数据类型为HallResponse。 |
+
+- 示例：
+ ```
+ sensor.once(type:SensorType.SENSOR_TYPE_ID_HALL, function(error, data) {
+ if (error) {
+ console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ //打印data的状态值
+ console.info('Status: ' + data.status);
}
- //打印data的状态值
- console.info('Status: ' + data.status);
- }
-);
-```
+ );
+ ```
-## sensor.once\(SensorType.SENSOR\_TYPE\_ID\_AMBIENT\_LIGHT\)
-once\(type: SensorType.SENSOR\_TYPE\_ID\_AMBIENT\_LIGHT, callback: AsyncCallback\): void
+## sensor.once(SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT)
-监听环境光传感器数据变化一次。
+once(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback: AsyncCallback<LightResponse>): void
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-环境光传感器类型为SENSOR_TYPE_ID_AMBIENT_LIGHT。
- |
-
-callback
- |
-AsyncCallback<LightResponse>
- |
-是
- |
-注册一次环境光传感器的回调函数，上报的数据类型为LightResponse。
- |
-
-
-
-
-**示例：**
+监听环境光传感器数据变化一次。
-```
-sensor.once(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, function(error, data) {
- if (error) {
- console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
- return;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 环境光传感器类型为SENSOR_TYPE_ID_AMBIENT_LIGHT。 |
+ | callback | AsyncCallback<[LightResponse](#lightresponse)> | 是 | 注册一次环境光传感器的回调函数，上报的数据类型为LightResponse。 |
+
+- 示例：
+ ```
+ sensor.once(type:SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, function(error, data) {
+ if (error) {
+ console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ //打印data的光强值
+ console.info(''Illumination: ' + data.intensity);
}
- //打印data的光强值
- console.info(''Illumination: ' + data.intensity);
- }
-);
-```
+ );
+ ```
-## sensor.once\(SensorType.SENSOR\_TYPE\_ID\_ORIENTATION\)
-once\(type: SensorType.SENSOR\_TYPE\_ID\_ORIENTATION, callback: AsyncCallback\): void
+## sensor.once(SensorType.SENSOR_TYPE_ID_ORIENTATION)
-监听方向传感器数据变化一次。
+once(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback: AsyncCallback<OrientationResponse>): void
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-方向传感器类型为SENSOR_TYPE_ID_ORIENTATION。
- |
-
-callback
- |
-AsyncCallback<OrientationResponse>
- |
-是
- |
-注册一次方向传感器的回调函数，上报的数据类型为OrientationResponse。
- |
-
-
-
-
-**示例：**
+监听方向传感器数据变化一次。
-```
-sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ORIENTATION, function(error, data) {
- if (error) {
- console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
- return;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 方向传感器类型为SENSOR_TYPE_ID_ORIENTATION。 |
+ | callback | AsyncCallback<[OrientationResponse](#orientationresponse)> | 是 | 注册一次方向传感器的回调函数，上报的数据类型为OrientationResponse。 |
+
+- 示例：
+ ```
+ sensor.once(type:SensorType.SENSOR_TYPE_ID_ORIENTATION, function(error, data) {
+ if (error) {
+ console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ //打印data的x,y,z轴坐标的分量
+ console.info('X-coordinate component: ' + data.x);
+ console.info('Y-coordinate component: ' + data.y);
+ console.info('Z-coordinate component: ' + data.z);
}
- //打印data的x,y,z轴坐标的分量
- console.info('X-coordinate component: ' + data.x);
- console.info('Y-coordinate component: ' + data.y);
- console.info('Z-coordinate component: ' + data.z);
- }
-);
-```
+ );
+ ```
-## sensor.once\(SensorType.SENSOR\_TYPE\_ID\_ROTATION\_VECTOR\)
-once\(type: SensorType.SENSOR\_TYPE\_ID\_ROTATION\_VECTOR, callback: AsyncCallback\): void
+## sensor.once(SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR)
-监听旋转矢量传感器数据变化一次。
+once(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, callback: AsyncCallback<RotationVectorResponse>): void
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-旋转矢量传感器类型为SENSOR_TYPE_ID_ROTATION_VECTOR。
- |
-
-callback
- |
-AsyncCallback<RotationVectorResponse>
- |
-是
- |
-注册一次旋转矢量传感器的回调函数，上报的数据类型为RotationVectorResponse。
- |
-
-
-
-
-**示例：**
+监听旋转矢量传感器数据变化一次。
-```
-sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, function(error, data) {
- if (error) {
- console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
- return;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 旋转矢量传感器类型为SENSOR_TYPE_ID_ROTATION_VECTOR。 |
+ | callback | AsyncCallback<[RotationVectorResponse](#rotationvectorresponse)> | 是 | 注册一次旋转矢量传感器的回调函数，上报的数据类型为RotationVectorResponse。 |
+
+- 示例：
+ ```
+ sensor.once(type:SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, function(error, data) {
+ if (error) {
+ console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ //打印data的x,y,z轴坐标的分量
+ console.info('X-coordinate component: ' + data.x);
+ console.info('Y-coordinate component: ' + data.y);
+ console.info('Z-coordinate component: ' + data.z);
}
- //打印data的x,y,z轴坐标的分量
- console.info('X-coordinate component: ' + data.x);
- console.info('Y-coordinate component: ' + data.y);
- console.info('Z-coordinate component: ' + data.z);
- }
-);
-```
+ );
+ ```
-## sensor.once\(SensorType.SENSOR\_TYPE\_ID\_HEART\_RATE\)
-once\(type: SensorType.SENSOR\_TYPE\_ID\_HEART\_RATE, callback: AsyncCallback\): void
+## sensor.once(SensorType.SENSOR_TYPE_ID_HEART_RATE)
-监听心率传感器数据变化一次。
+once(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback: AsyncCallback<HeartRateResponse>): void
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-心率传感器类型为SENSOR_TYPE_ID_HEART_RATE。
- |
-
-callback
- |
-AsyncCallback<HeartRateResponse>
- |
-是
- |
-注册一次心率传感器的回调函数，上报的数据类型为HeartRateResponse。
- |
-
-
-
-
-**示例：**
+监听心率传感器数据变化一次。
-```
-sensor.once(sensor.SensorType.SENSOR_TYPE_ID_HEART_RATE, function(error, data) {
- if (error) {
- console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
- return;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 心率传感器类型为SENSOR_TYPE_ID_HEART_RATE。 |
+ | callback | AsyncCallback<[HeartRateResponse](#heartrateresponse)> | 是 | 注册一次心率传感器的回调函数，上报的数据类型为HeartRateResponse。 |
+
+- 示例：
+ ```
+ sensor.once(type:SensorType.SENSOR_TYPE_ID_HEART_RATE, function(error, data) {
+ if (error) {
+ console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ //打印data的心率值
+ console.info("Heart rate: " + data.heartRate);
}
- //打印data的心率值
- console.info("Heart rate: " + data.heartRate);
- }
-);
-```
+ );
+ ```
-## sensor.once\(SensorType.SENSOR\_TYPE\_ID\_WEAR\_DETECTION\)
-once\(type: SensorType.SENSOR\_TYPE\_ID\_WEAR\_DETECTION, callback: AsyncCallback\): void
+## sensor.once(SensorType.SENSOR_TYPE_ID_WEAR_DETECTION)
-监听佩戴检测传感器数据变化一次。
+once(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback: AsyncCallback<WearDetectionResponse>): void
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-佩戴检测传感器类型为SENSOR_TYPE_ID_WEAR_DETECTION。
- |
-
-callback
- |
-AsyncCallback<WearDetectionResponse>
- |
-是
- |
-注册一次穿戴检测传感器的回调函数，上报的数据类型为WearDetectionResponse。
- |
-
-
-
-
-**示例：**
+监听佩戴检测传感器数据变化一次。
-```
-sensor.once(sensor.SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, function(error, data) {
- if (error) {
- console.error("Failed to register data, error code is" + error.code + ", message: " + error.message);
- return;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 佩戴检测传感器类型为SENSOR_TYPE_ID_WEAR_DETECTION。 |
+ | callback | AsyncCallback<[WearDetectionResponse](#weardetectionresponse)> | 是 | 注册一次穿戴检测传感器的回调函数，上报的数据类型为WearDetectionResponse。 |
+
+- 示例：
+ ```
+ sensor.once(type:SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, function(error, data) {
+ if (error) {
+ console.error("Failed to register data, error code is" + error.code + ", message: " + error.message);
+ return;
+ }
+ //打印data的佩戴状态
+ console.info("Wear status: "+ data.value);
}
- //打印data的佩戴状态
- console.info("Wear status: "+ data.value);
- }
-);
-```
+ );
+ ```
-## sensor.off
-off\(type: SensorType, callback?: AsyncCallback\): void
+## sensor.off
-取消订阅传感器数据。
+off(type: SensorType, callback?: AsyncCallback<void>): void
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-type
- |
-SensorType
- |
-是
- |
-要取消订阅的传感器类型。
- |
-
-callback
- |
-AsyncCallback<void>
- |
-是
- |
-取消订阅的传感器的回调函数，表示接口调用是否成功。
- |
-
-
-
-
-**示例：**
+取消订阅传感器数据。
-```
-sensor.off(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER, function(error) {
- if (error) {
- console.error("Failed to unsubscribe from acceleration sensor data. Error code: " + error.code + "; message: " + error.message);
- return;
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [SensorType](#sensortype) | 是 | 要取消订阅的传感器类型。 |
+ | callback | AsyncCallback<void> | 是 | 取消订阅的传感器的回调函数，表示接口调用是否成功。 |
+
+- 示例：
+ ```
+ sensor.off(type:SensorType.SENSOR_TYPE_ID_ACCELEROMETER, function(error) {
+ if (error) {
+ console.error("Failed to unsubscribe from acceleration sensor data. Error code: " + error.code + "; message: " + error.message);
+ return;
+ }
+ console.info("Succeeded in unsubscribing from acceleration sensor data.");
}
- console.info("Succeeded in unsubscribing from acceleration sensor data.");
- }
-);
+ );
+
+ ```
-```
-## SensorType
+## sensor.createRotationMatrix
+
+createRotationMatrix(rotationVector: Array<number>): Promise<Array<number>>
+
+将旋转矢量转换为旋转矩阵,返回值为数组。
+
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | rotationVector | Array<number> | 是 | 旋转矢量指示旋转矢量。 |
+
+- 返回值
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<Array<number>> | 返回角度变化的数字（z、x和y）数组。 |
+
+- 示例
+ ```
+ const promise = sensor.createRotationMatrix([0.20046076, 0.21907, 0.73978853, 0.60376877]);
+ promise.then((data) => {
+ console.info(LABEL + 'createRotationMatrix_promise success');
+ for (var i=0; i < data.length; i++) {
+ console.info(LABEL + "data[" + i + "]: " + data[i]);
+ }
+ }).catch((reason) => {
+ console.info(LABEL + "promise::catch", reason);
+ });
+ ```
+
+## SensorType
表示要订阅或取消订阅的传感器类型。
-
-名称
- |
-默认值
- |
-说明
- |
-
|---|
-
-SENSOR_TYPE_ID_ACCELEROMETER
- |
-1
- |
-加速度传感器。
- |
-
-SENSOR_TYPE_ID_GYROSCOPE
- |
-2
- |
-陀螺仪传感器。
- |
-
-SENSOR_TYPE_ID_AMBIENT_LIGHT
- |
-5
- |
-环境光传感器。
- |
-
-SENSOR_TYPE_ID_MAGNETIC_FIELD
- |
-6
- |
-磁场传感器。
- |
-
-SENSOR_TYPE_ID_BAROMETER
- |
-8
- |
-气压计传感器。
- |
-
-SENSOR_TYPE_ID_HALL
- |
-10
- |
-霍尔传感器。
- |
-
-SENSOR_TYPE_ID_PROXIMITY
- |
-12
- |
-接近光传感器。
- |
-
-SENSOR_TYPE_ID_HUMIDITY
- |
-13
- |
-湿度传感器。
- |
-
-SENSOR_TYPE_ID_ORIENTATION
- |
-256
- |
-方向传感器。
- |
-
-SENSOR_TYPE_ID_GRAVITY
- |
-257
- |
-重力传感器。
- |
-
-SENSOR_TYPE_ID_LINEAR_ACCELERATION
- |
-258
- |
-线性加速度传感器。
- |
-
-SENSOR_TYPE_ID_ROTATION_VECTOR
- |
-259
- |
-旋转矢量传感器。
- |
-
-SENSOR_TYPE_ID_AMBIENT_TEMPERATURE
- |
-260
- |
-环境温度传感器。
- |
-
-SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED
- |
-261
- |
-未校准磁场传感器。
- |
-
-SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED
- |
-263
- |
-未校准陀螺仪传感器。
- |
-
-SENSOR_TYPE_ID_SIGNIFICANT_MOTION
- |
-264
- |
-有效运动传感器。
- |
-
-SENSOR_TYPE_ID_PEDOMETER_DETECTION
- |
-265
- |
-计步检测传感器。
- |
-
-SENSOR_TYPE_ID_PEDOMETER
- |
-266
- |
-计步传感器。
- |
-
-SENSOR_TYPE_ID_HEART_RATE
- |
-278
- |
-心率传感器。
- |
-
-SENSOR_TYPE_ID_WEAR_DETECTION
- |
-280
- |
-佩戴检测传感器。
- |
-
-SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED
- |
-281
- |
-未校准加速度计传感器。
- |
-
-
-
-
-## AccelerometerResponse
+
+| 名称 | 默认值 | 说明 |
+| -------- | -------- | -------- |
+| SENSOR_TYPE_ID_ACCELEROMETER | 1 | 加速度传感器。 |
+| SENSOR_TYPE_ID_GYROSCOPE | 2 | 陀螺仪传感器。 |
+| SENSOR_TYPE_ID_AMBIENT_LIGHT | 5 | 环境光传感器。 |
+| SENSOR_TYPE_ID_MAGNETIC_FIELD | 6 | 磁场传感器。 |
+| SENSOR_TYPE_ID_BAROMETER | 8 | 气压计传感器。 |
+| SENSOR_TYPE_ID_HALL | 10 | 霍尔传感器。 |
+| SENSOR_TYPE_ID_PROXIMITY | 12 | 接近光传感器。 |
+| SENSOR_TYPE_ID_HUMIDITY | 13 | 湿度传感器。 |
+| SENSOR_TYPE_ID_ORIENTATION | 256 | 方向传感器。 |
+| SENSOR_TYPE_ID_GRAVITY | 257 | 重力传感器。 |
+| SENSOR_TYPE_ID_LINEAR_ACCELERATION | 258 | 线性加速度传感器。 |
+| SENSOR_TYPE_ID_ROTATION_VECTOR | 259 | 旋转矢量传感器。 |
+| SENSOR_TYPE_ID_AMBIENT_TEMPERATURE | 260 | 环境温度传感器。 |
+| SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED | 261 | 未校准磁场传感器。 |
+| SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED | 263 | 未校准陀螺仪传感器。 |
+| SENSOR_TYPE_ID_SIGNIFICANT_MOTION | 264 | 有效运动传感器。 |
+| SENSOR_TYPE_ID_PEDOMETER_DETECTION | 265 | 计步检测传感器。 |
+| SENSOR_TYPE_ID_PEDOMETER | 266 | 计步传感器。 |
+| SENSOR_TYPE_ID_HEART_RATE | 278 | 心率传感器。 |
+| SENSOR_TYPE_ID_WEAR_DETECTION | 280 | 佩戴检测传感器。 |
+| SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED | 281 | 未校准加速度计传感器。 |
+
+
+## AccelerometerResponse
加速度传感器数据。
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-x
- |
-number
- |
-是
- |
-是
- |
-x轴坐标分量。
- |
-
-y
- |
-number
- |
-是
- |
-是
- |
-y轴坐标分量。
- |
-
-z
- |
-number
- |
-是
- |
-是
- |
-z轴坐标分量。
- |
-
-
-
-
-## LinearAccelerometerResponse
+
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| x | number | 是 | 是 | x轴坐标分量。 |
+| y | number | 是 | 是 | y轴坐标分量。 |
+| z | number | 是 | 是 | z轴坐标分量。 |
+
+
+## LinearAccelerometerResponse
线性加速度传感器数据。
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-x
- |
-number
- |
-是
- |
-是
- |
-x轴坐标分量。
- |
-
-y
- |
-number
- |
-是
- |
-是
- |
-y轴坐标分量。
- |
-
-z
- |
-number
- |
-是
- |
-是
- |
-z轴坐标分量。
- |
-
-
-
-
-## AccelerometerUncalibratedResponse
+
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| x | number | 是 | 是 | x轴坐标分量。 |
+| y | number | 是 | 是 | y轴坐标分量。 |
+| z | number | 是 | 是 | z轴坐标分量。 |
+
+
+## AccelerometerUncalibratedResponse
未校准加速度计传感器数据。
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-x
- |
-number
- |
-是
- |
-是
- |
-x轴坐标分量。
- |
-
-y
- |
-number
- |
-是
- |
-是
- |
-y轴坐标分量。
- |
-
-z
- |
-number
- |
-是
- |
-是
- |
-z轴坐标分量。
- |
-
-biasX
- |
-number
- |
-是
- |
-是
- |
-x轴坐标偏移量。
- |
-
-biasY
- |
-number
- |
-是
- |
-是
- |
-y轴坐标偏移量。
- |
-
-biasZ
- |
-number
- |
-是
- |
-是
- |
-z轴坐标偏移量。
- |
-
-
-
-
-## GravityResponse
+
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| x | number | 是 | 是 | x轴坐标分量。 |
+| y | number | 是 | 是 | y轴坐标分量。 |
+| z | number | 是 | 是 | z轴坐标分量。 |
+| biasX | number | 是 | 是 | x轴坐标偏移量。 |
+| biasY | number | 是 | 是 | y轴坐标偏移量。 |
+| biasZ | number | 是 | 是 | z轴坐标偏移量。 |
+
+
+## GravityResponse
重力传感器数据。
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-x
- |
-number
- |
-是
- |
-是
- |
-x轴坐标分量。
- |
-
-y
- |
-number
- |
-是
- |
-是
- |
-y轴坐标分量。
- |
-
-z
- |
-number
- |
-是
- |
-是
- |
-z轴坐标分量。
- |
-
-
-
-
-## OrientationResponse
+
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| x | number | 是 | 是 | x轴坐标分量。 |
+| y | number | 是 | 是 | y轴坐标分量。 |
+| z | number | 是 | 是 | z轴坐标分量。 |
+
+
+## OrientationResponse
方向传感器数据。
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-x
- |
-number
- |
-是
- |
-是
- |
-x轴坐标分量。
- |
-
-y
- |
-number
- |
-是
- |
-是
- |
-y轴坐标分量。
- |
-
-z
- |
-number
- |
-是
- |
-是
- |
-z轴坐标分量。
- |
-
-
-
-
-## RotationVectorResponse
+
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| x | number | 是 | 是 | x轴坐标分量。 |
+| y | number | 是 | 是 | y轴坐标分量。 |
+| z | number | 是 | 是 | z轴坐标分量。 |
+
+
+## RotationVectorResponse
旋转矢量传感器数据。
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-x
- |
-number
- |
-是
- |
-是
- |
-x轴坐标分量。
- |
-
-y
- |
-number
- |
-是
- |
-是
- |
-y轴坐标分量。
- |
-
-z
- |
-number
- |
-是
- |
-是
- |
-z轴坐标分量。
- |
-
-
-
-
-## GyroscopeResponse
+
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| x | number | 是 | 是 | x轴坐标分量。 |
+| y | number | 是 | 是 | y轴坐标分量。 |
+| z | number | 是 | 是 | z轴坐标分量。 |
+
+
+## GyroscopeResponse
陀螺仪传感器数据。
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-x
- |
-number
- |
-是
- |
-是
- |
-x轴坐标分量。
- |
-
-y
- |
-number
- |
-是
- |
-是
- |
-y轴坐标分量。
- |
-
-z
- |
-number
- |
-是
- |
-是
- |
-z轴坐标分量。
- |
-
-
-
-
-## GyroscopeUncalibratedResponse
+
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| x | number | 是 | 是 | x轴坐标分量。 |
+| y | number | 是 | 是 | y轴坐标分量。 |
+| z | number | 是 | 是 | z轴坐标分量。 |
+
+
+## GyroscopeUncalibratedResponse
未校准陀螺仪传感器数据。
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-x
- |
-number
- |
-是
- |
-是
- |
-x轴坐标分量。
- |
-
-y
- |
-number
- |
-是
- |
-是
- |
-y轴坐标分量。
- |
-
-z
- |
-number
- |
-是
- |
-是
- |
-z轴坐标分量。
- |
-
-biasX
- |
-number
- |
-是
- |
-是
- |
-x轴坐标偏移量。
- |
-
-biasY
- |
-number
- |
-是
- |
-是
- |
-y轴坐标偏移量。
- |
-
-biasZ
- |
-number
- |
-是
- |
-是
- |
-z轴坐标偏移量。
- |
-
-
-
-
-## SignificantMotionResponse
+
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| x | number | 是 | 是 | x轴坐标分量。 |
+| y | number | 是 | 是 | y轴坐标分量。 |
+| z | number | 是 | 是 | z轴坐标分量。 |
+| biasX | number | 是 | 是 | x轴坐标偏移量。 |
+| biasY | number | 是 | 是 | y轴坐标偏移量。 |
+| biasZ | number | 是 | 是 | z轴坐标偏移量。 |
+
+
+## SignificantMotionResponse
有效运动传感器数据。
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-scalar
- |
-number
- |
-是
- |
-是
- |
-表示剧烈运动程度。测量三个物理轴（x、y 和 z）上，设备是否存在大幅度运动；如果取值为1则代表存在大幅度运动，取值为0则代表没有大幅度运动。
- |
-
-
-
-
-## ProximityResponse
+
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| scalar | number | 是 | 是 | 表示剧烈运动程度。测量三个物理轴（x、y 和 z）上，设备是否存在大幅度运动；如果取值为1则代表存在大幅度运动，取值为0则代表没有大幅度运动。 |
+
+
+## ProximityResponse
接近光传感器数据。
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-distance
- |
-number
- |
-是
- |
-是
- |
-可见物体与设备显示器的接近程度。0表示接近，1表示远离。
- |
-
-
-
-
-## LightResponse
+
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| distance | number | 是 | 是 | 可见物体与设备显示器的接近程度。0表示接近，1表示远离。 |
+
+
+## LightResponse
环境光传感器数据。
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-intensity
- |
-number
- |
-是
- |
-是
- |
-光强（单位：勒克斯）。
- |
-
-
-
-
-## HallResponse
+
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| intensity | number | 是 | 是 | 光强（单位：勒克斯）。 |
+
+
+## HallResponse
霍尔传感器数据。
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-status
- |
-number
- |
-是
- |
-是
- |
-显示霍尔状态。测量设备周围是否存在磁力吸引，0表示有，1表示没有。
- |
-
-
-
-
-## MagneticFieldResponse
+
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| status | number | 是 | 是 | 显示霍尔状态。测量设备周围是否存在磁力吸引，0表示有，1表示没有。 |
+
+
+## MagneticFieldResponse
磁场传感器数据。
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-x
- |
-number
- |
-是
- |
-是
- |
-x轴坐标分量。
- |
-
-y
- |
-number
- |
-是
- |
-是
- |
-y轴坐标分量。
- |
-
-z
- |
-number
- |
-是
- |
-是
- |
-z轴坐标分量。
- |
-
-
-
-
-## MagneticFieldUncalibratedResponse
+
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| x | number | 是 | 是 | x轴坐标分量。 |
+| y | number | 是 | 是 | y轴坐标分量。 |
+| z | number | 是 | 是 | z轴坐标分量。 |
+
+
+## MagneticFieldUncalibratedResponse
未校准磁场传感器数据。
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-x
- |
-number
- |
-是
- |
-是
- |
-x轴坐标分量。
- |
-
-y
- |
-number
- |
-是
- |
-是
- |
-y轴坐标分量。
- |
-
-z
- |
-number
- |
-是
- |
-是
- |
-z轴坐标分量。
- |
-
-biasX
- |
-number
- |
-是
- |
-是
- |
-x轴坐标偏移量。
- |
-
-biasY
- |
-number
- |
-是
- |
-是
- |
-y轴坐标偏移量。
- |
-
-biasZ
- |
-number
- |
-是
- |
-是
- |
-z轴坐标偏移量。
- |
-
-
-
-
-## PedometerResponse
+
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| x | number | 是 | 是 | x轴坐标分量。 |
+| y | number | 是 | 是 | y轴坐标分量。 |
+| z | number | 是 | 是 | z轴坐标分量。 |
+| biasX | number | 是 | 是 | x轴坐标偏移量。 |
+| biasY | number | 是 | 是 | y轴坐标偏移量。 |
+| biasZ | number | 是 | 是 | z轴坐标偏移量。 |
+
+
+## PedometerResponse
计步传感器数据。
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-steps
- |
-number
- |
-是
- |
-是
- |
-计数的步骤数。每次设备重新启动时，该值将从0重新计算。
- |
-
-
-
-
-## HumidityResponse
+
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| steps | number | 是 | 是 | 计数的步骤数。每次设备重新启动时，该值将从0重新计算。 |
+
+
+## HumidityResponse
湿度传感器数据。
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-humidity
- |
-number
- |
-是
- |
-是
- |
-湿度值。测量环境的相对湿度，以百分比 (%) 表示。
- |
-
-
-
-
-## PedometerDetectResponse
+
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| humidity | number | 是 | 是 | 湿度值。测量环境的相对湿度，以百分比 (%) 表示。 |
+
+
+## PedometerDetectResponse
计步检测传感器数据。
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-scalar
- |
-number
- |
-是
- |
-是
- |
-计步器检测。检测用户的计步动作，如果取值为1则代表用户产生了计步行走的动作，取值为0则代表用户没有发生运动。
- |
-
-
-
-
-## AmbientTemperatureResponse
+
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| scalar | number | 是 | 是 | 计步器检测。检测用户的计步动作，如果取值为1则代表用户产生了计步行走的动作，取值为0则代表用户没有发生运动。 |
+
+
+## AmbientTemperatureResponse
温度传感器数据。
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-temperature
- |
-number
- |
-是
- |
-是
- |
-环境温度（单位：摄氏度）。
- |
-
-
-
-
-## BarometerResponse
+
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| temperature | number | 是 | 是 | 环境温度（单位：摄氏度）。 |
+
+
+## BarometerResponse
气压计传感器数据。
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-pressure
- |
-number
- |
-是
- |
-是
- |
-压力值（单位：帕斯卡）。
- |
-
-
-
-
-## HeartRateResponse
+
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| pressure | number | 是 | 是 | 压力值（单位：帕斯卡）。 |
+
+
+## HeartRateResponse
心率传感器数据。
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-heartRate
- |
-number
- |
-是
- |
-是
- |
-心率值。测量用户的心率数值，单位是次/分。
- |
-
-
-
-
-## WearDetectionResponse
+
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| heartRate | number | 是 | 是 | 心率值。测量用户的心率数值，单位是次/分。 |
+
+
+## WearDetectionResponse
佩戴检测传感器数据。
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-value
- |
-boolean
- |
-是
- |
-是
- |
-表示设备是否被穿戴（true 表示已穿戴，false表示未穿戴）。
- |
-
-
-
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| value | boolean | 是 | 是 | 表示设备是否被穿戴（true 表示已穿戴，false表示未穿戴）。 |
+
+
+## Options
+
+设置传感器上报频率
+
+| 名称 | 参数类型 | 说明 |
+| -------- | -------- | -------- |
+| interval | number | 表示传感器的上报频率，默认值为200000000ns。 |
+
+
+## RotationMatrixResponse
+
+设置旋转矩阵响应对象
+
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| rotation | Array<number> | 是 | 是 | 旋转矩阵。 |
+| inclination | Array<number> | 是 | 是 | 倾斜矩阵。 |
+
+
+## CoordinatesOptions
+
+设置坐标选项对象
+
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| x | number | 是 | 是 | x坐标偏移量。 |
+| y | number | 是 | 是 | y坐标偏移量。 |
+
+
+## GeomagneticResponse
+
+设置地磁响应对象
+
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| x | number | 是 | 是 | x轴坐标分量。 |
+| y | number | 是 | 是 | y轴坐标分量。 |
+| z | number | 是 | 是 | z轴坐标分量。 |
+| geomagneticDip | number | 是 | 是 | 地磁倾角。 |
+| deflectionAngle | number | 是 | 是 | 偏转角。 |
+| levelIntensity | number | 是 | 是 | 水平强度。 |
+| totalIntensity | number | 是 | 是 | 总强度。 |
+
+
+## LocationOptions
+
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| latitude | number | 是 | 是 | 纬度。 |
+| longitude | number | 是 | 是 | 经度。 |
+| altitude | number | 是 | 是 | 海拔。 |
diff --git a/zh-cn/application-dev/reference/apis/js-apis-sim.md b/zh-cn/application-dev/reference/apis/js-apis-sim.md
index 2b6cf3a095b54ec0d9d26e4350e99636ea6f0d22..b772808f63ef3f85293b5b486ee339f28eca6c66 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-sim.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-sim.md
@@ -2,8 +2,7 @@
>**说明：**
>
->- 从 API Version 6 开始支持。
->- 标记7+的接口从API Version 7开始支持。
+>本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
@@ -275,10 +274,10 @@ getSimState\(slotId: number, callback: AsyncCallback\): void
- 参数
- | 参数名 | 类型 | 必填 | 说明 |
- | -------- | -------------------------------------- | ---- | ----------------------------------------- |
- | slotId | number | 是 | 卡槽ID。
- 0：卡槽1
- 1：卡槽2 |
- | callback | AsyncCallback\<[SimState](#SimState)\> | 是 | 回调函数。参考[SimState](#SimState)。 |
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------------------------------------- | ---- | -------------------------------------- |
+ | slotId | number | 是 | 卡槽ID。
- 0：卡槽1
- 1：卡槽2 |
+ | callback | AsyncCallback\<[SimState](#SimState)\> | 是 | 回调函数。参考[SimState](#SimState)。 |
- 示例
diff --git a/zh-cn/application-dev/reference/apis/js-apis-sms.md b/zh-cn/application-dev/reference/apis/js-apis-sms.md
index 2970a538c4917692164073019ed3512c1e0f4dc9..f07b61d7feb94e57598bca3bdc4e0ec3c4811b78 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-sms.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-sms.md
@@ -2,9 +2,7 @@
>**说明：**
>
->- 从 API Version 6 开始支持。
->
->- 标记7+的接口从API Version 7开始支持。
+>本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
@@ -281,13 +279,13 @@ getSmscAddr\(slotId: number\): Promise
| isSmsStatusReportMessage | boolean | 当前消息是否为“短信状态报告”，默认为false。
“短信状态报告”是一种特定格式的短信，被用来从Service Center到Mobile Station传送状态报告。 |
| messageClass | [ShortMessageClass](#ShortMessageClass) | 短信类型。 |
| pdu | Array<number> | SMS消息中的协议数据单元 （PDU）。 |
-|protocolId|number|发送短信时使用的协议标识。|
-|scAddress|string|短消息服务中心（SMSC）地址。|
-|scTimestamp|number|SMSC时间戳。|
-|status|number|SMS-STATUS-REPORT消息中的短信状态指示短信服务中心（SMSC）发送的短信状态。|
-|userRawData|Array<number>|除数据头外的用户数据。|
-|visibleMessageBody|string|短信正文。|
-|visibleRawAddress|string|发送者地址。|
+| protocolId | number | 发送短信时使用的协议标识。 |
+| scAddress | string | 短消息服务中心（SMSC）地址。 |
+| scTimestamp | number | SMSC时间戳。 |
+| status | number | SMS-STATUS-REPORT消息中的短信状态指示短信服务中心（SMSC）发送的短信状态。 |
+| userRawData | Array<number> | 除数据头外的用户数据。 |
+| visibleMessageBody | string | 短信正文。 |
+| visibleRawAddress | string | 发送者地址。 |
## ShortMessageClass
@@ -349,5 +347,4 @@ getSmscAddr\(slotId: number\): Promise
| SEND_SMS_SUCCESS | 0 | 发送短信成功。 |
| SEND_SMS_FAILURE_UNKNOWN | 1 | 发送短信失败，原因未知。 |
| SEND_SMS_FAILURE_RADIO_OFF | 2 | 发送短信失败，原因为调制解调器关机。 |
-| SEND_SMS_FAILURE_SERVICE_UNAVAILABLE | 3 | 发送短信失败，原因为网络不可用、不支持发送或接收短信。 |
-
+| SEND_SMS_FAILURE_SERVICE_UNAVAILABLE | 3 | 发送短信失败，原因为网络不可用、不支持发送或接收短信。 |
\ No newline at end of file
diff --git a/zh-cn/application-dev/reference/apis/js-apis-system-parameter.md b/zh-cn/application-dev/reference/apis/js-apis-system-parameter.md
index 1e49dcdb149f6079a866fc5102dca8d823f9956f..6016c59263a766d1a45f9ec278002142a5a3d887 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-system-parameter.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-system-parameter.md
@@ -1,71 +1,35 @@
-# 系统属性
+# 系统属性
-## 导入模块
+## 导入模块
```
import parameter from '@ohos.systemParameter'
```
-## 权限列表
+
+## 权限列表
无
-## parameter.getSync
-getSync\(key: string, def?: string\)
+## parameter.getSync
+
+getSync(key: string, def?: string)
获取系统属性Key对应的值。
**参数：**
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-key
- |
-string
- |
-是
- |
-待查询的系统属性Key。
- |
-
-def
- |
-string
- |
-否
- |
-默认值。
- |
-
-
-
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | -------- | -------- | -------- |
+| key | string | 是 | 待查询的系统属性Key。 |
+| def | string | 否 | 默认值。 |
**返回值：**
-
-类型
- |
-说明
- |
-
|---|
-
-string
- |
-系统属性值，若key不存在，返回默认值。若未指定默认值，返回空字符串。
- |
-
-
-
+| 类型 | 说明 |
+| -------- | -------- |
+| string | 系统属性值，若key不存在，返回默认值。若未指定默认值，返回空字符串。 |
**示例：**
@@ -78,45 +42,19 @@ try {
}
```
-## parameter.get
-get\(key: string, callback: AsyncCallback\)
+## parameter.get
+
+get(key: string, callback: AsyncCallback<string>)
获取系统属性Key对应的值。
**参数：**
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-key
- |
-string
- |
-是
- |
-待查询的系统属性Key。
- |
-
-callback
- |
-AsyncCallback<string>
- |
-是
- |
-回调函数。
- |
-
-
-
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | -------- | -------- | -------- |
+| key | string | 是 | 待查询的系统属性Key。 |
+| callback | AsyncCallback<string> | 是 | 回调函数。 |
**示例：**
@@ -133,54 +71,20 @@ try {
}
```
-## parameter.get
-get\(key: string, def: string, callback: AsyncCallback\)
+## parameter.get
+
+get(key: string, def: string, callback: AsyncCallback<string>)
获取系统属性Key对应的值。
**参数：**
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-key
- |
-string
- |
-是
- |
-待查询的系统属性Key。
- |
-
-def
- |
-string
- |
-是
- |
-默认值。
- |
-
-callback
- |
-AsyncCallback<string>
- |
-是
- |
-回调函数。
- |
-
-
-
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | -------- | -------- | -------- |
+| key | string | 是 | 待查询的系统属性Key。 |
+| def | string | 是 | 默认值。 |
+| callback | AsyncCallback<string> | 是 | 回调函数。 |
**示例：**
@@ -198,62 +102,25 @@ try {
}
```
-## parameter.get
-get\(key: string, def?: string\)
+## parameter.get
+
+get(key: string, def?: string)
获取系统属性Key对应的值。
**参数：**
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-key
- |
-string
- |
-是
- |
-待查询的系统属性Key。
- |
-
-def
- |
-string
- |
-否
- |
-默认值。
- |
-
-
-
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | -------- | -------- | -------- |
+| key | string | 是 | 待查询的系统属性Key。 |
+| def | string | 否 | 默认值。 |
**返回值：**
-
-类型
- |
-说明
- |
-
|---|
-
-Promise<string>
- |
-Promise示例，用于异步获取结果。
- |
-
-
-
+| 类型 | 说明 |
+| -------- | -------- |
+| Promise<string> | Promise示例，用于异步获取结果。 |
**示例：**
@@ -270,45 +137,19 @@ try {
}
```
-## parameter.setSync
-setSync\(key: string, value: string\)
+## parameter.setSync
+
+setSync(key: string, value: string)
设置系统属性Key对应的值。
**参数：**
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-key
- |
-string
- |
-是
- |
-待设置的系统属性Key。
- |
-
-value
- |
-string
- |
-是
- |
-待设置的系统属性值。
- |
-
-
-
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | -------- | -------- | -------- |
+| key | string | 是 | 待设置的系统属性Key。 |
+| value | string | 是 | 待设置的系统属性值。 |
**示例：**
@@ -320,54 +161,20 @@ try {
}
```
-## parameter.set\(key: string, value: string, callback: AsyncCallback\)
-set\(key: string, value: string, callback: AsyncCallback\)
+## parameter.set(key: string, value: string, callback: AsyncCallback<void>)
+
+set(key: string, value: string, callback: AsyncCallback<void>)
设置系统属性Key对应的值。
**参数：**
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-key
- |
-string
- |
-是
- |
-待查询的系统属性Key。
- |
-
-def
- |
-string
- |
-是
- |
-默认值。
- |
-
-callback
- |
-AsyncCallback<void>
- |
-是
- |
-回调函数。
- |
-
-
-
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | -------- | -------- | -------- |
+| key | string | 是 | 待查询的系统属性Key。 |
+| def | string | 是 | 默认值。 |
+| callback | AsyncCallback<void> | 是 | 回调函数。 |
**示例：**
@@ -384,62 +191,25 @@ try {
}
```
-## parameter.set\(key: string, def?: string\)
-set\(key: string, def?: string\)
+## parameter.set(key: string, def?: string)
+
+set(key: string, def?: string)
设置系统属性Key对应的值。
**参数：**
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-key
- |
-string
- |
-是
- |
-待查询的系统属性Key。
- |
-
-def
- |
-string
- |
-否
- |
-默认值。
- |
-
-
-
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | -------- | -------- | -------- |
+| key | string | 是 | 待查询的系统属性Key。 |
+| def | string | 否 | 默认值。 |
**返回值：**
-
-类型
- |
-说明
- |
-
|---|
-
-Promise<string>
- |
-Promise示例，用于异步获取结果。
- |
-
-
-
+| 类型 | 说明 |
+| -------- | -------- |
+| Promise<string> | Promise示例，用于异步获取结果。 |
**示例：**
@@ -455,4 +225,3 @@ try {
console.log("set unexpected error: " + e);
}
```
-
diff --git a/zh-cn/application-dev/reference/apis/js-apis-system-time.md b/zh-cn/application-dev/reference/apis/js-apis-system-time.md
index 0a5c29ecff012d60b574c48fb7f97aae9920e366..4e869adf45b67bb7420df2bd427a4e2fa54269f2 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-system-time.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-system-time.md
@@ -1,379 +1,174 @@
-# 设置系统时间
-
-> **说明：**
->从 API Version 7 开始支持。
-
-## 支持设备
-
-
-手机
- |
-平板
- |
-智慧屏
- |
-智能穿戴
- |
-
|---|
-
-支持
- |
-支持
- |
-支持
- |
-支持
- |
-
-
-
-
-## 导入模块
+# 设置系统时间
+
+>  **说明：**
+> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
+
+
+## 支持设备
+
+| 手机 | 平板 | 智慧屏 | 智能穿戴 |
+| -------- | -------- | -------- | -------- |
+| 支持 | 支持 | 支持 | 支持 |
+
+
+## 导入模块
```
import systemTime from '@ohos.systemTime';
```
-## systemTime.setTime
-
-setTime\(time : number, callback : AsyncCallback\) : void
-
-设置系统时间，需要ohos.permission.SET\_TIME权限。
-
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- time
- |
- number
- |
- 是
- |
- 目标时间戳（毫秒）。
- |
-
- callback
- |
- AsyncCallback<void>
- |
- 是
- |
- 回调函数，可以在回调函数中处理接口返回值。
- |
-
-
-
-
-- 示例：
-
- ```
- // time对应的时间为2021-01-20 02:36:25
- var time = 1611081385000;
- systemTime.setTime(time, (error, data) => {
- if (error) {
- console.error(`failed to systemTime.setTime because ` + JSON.stringify(error));
- return;
- }
- console.log(`success to systemTime.setTime: ` + JSON.stringify(data));
- });
- ```
-
-
-## systemTime.setTime
-
-setTime\(time : number\) : Promise
-
-设置系统时间，需要ohos.permission.SET\_TIME权限。
-
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- time
- |
- number
- |
- 是
- |
- 目标时间戳（毫秒）。
- |
-
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<void>
- |
- 返回的异步回调函数。
- |
-
-
-
-
-- 示例：
-
- ```
- // time对应的时间为2021-01-20 02:36:25
- var time = 1611081385000;
- systemTime.setTime(time).then((data) => {
- console.log(`success to systemTime.setTime: ` + JSON.stringify(data));
- }).catch((error) => {
- console.error(`failed to systemTime.setTime because ` + JSON.stringify(error));
- });
- ```
-
-
-## systemTime.setDate
-
-setDate\(date: Date, callback: AsyncCallback\): void
-
-设置系统日期，需要ohos.permission.SET\_TIME权限。
-
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- date
- |
- Date
- |
- 是
- |
- 目标日期。
- |
-
- callback
- |
- AsyncCallback<void>
- |
- 是
- |
- 回调函数，可以在回调函数中处理接口返回值。
- |
-
-
-
-
-- 示例：
-
- ```
- var data = new Date("October 13, 2020 11:13:00");
- systemTime.setDate(data,(error, data) => {
- if (error) {
- console.error('SystemTimePlugin setDate failed because ' + JSON.stringify(error));
- return;
- }
- console.info('SystemTimePlugin setDate success data : ' + JSON.stringify(data));
- });
- ```
-
-
-## systemTime.setDate
-
-setDate\(date: Date\): Promise
-
-设置系统日期，需要ohos.permission.SET\_TIME权限。
-
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- date
- |
- Date
- |
- 是
- |
- 目标日期。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<void>
- |
- 返回的异步回调函数。
- |
-
-
-
-
-- 示例：
-
- ```
- var data = new Date("October 13, 2020 11:13:00");
- systemTime.setDate(data).then((value) => {
- console.log(`SystemTimePlugin success to systemTime.setDate: ` + JSON.stringify(value));
- }).catch((error) => {
- console.error(`SystemTimePlugin failed to systemTime.setDate because: ` + JSON.stringify(error));
- });
- ```
-
-
-## systemTime.setTimezone
-
-setTimezone\(timezone: string, callback: AsyncCallback\): void
-
-设置系统时区，需要ohos.permission.SET\_TIME\_ZONE权限。
-
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- timezone
- |
- string
- |
- 是
- |
- 系统时区。
- |
-
- callback
- |
- AsyncCallback<void>
- |
- 是
- |
- 回调函数，可以在回调函数中处理接口返回值。
- |
-
-
-
-
-- 示例：
-
- ```
- systemTime.setTimezone('Asia/Shanghai', (error, data) => {
- if (error) {
- console.error('SystemTimePlugin setTimezone failed because ' + JSON.stringify(error));
- return;
- }
- console.info('SystemTimePlugin setTimezone success data : ' + JSON.stringify(data));
- });
- ```
-
-
-## systemTime.setTimezone
-
-setTimezone\(timezone: string\): Promise
-
-设置系统时区，需要ohos.permission.SET\_TIME\_ZONE权限。
-
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- timezone
- |
- string
- |
- 是
- |
- 系统时区。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise<void>
- |
- 返回的异步回调函数。
- |
-
-
-
-
-- 示例：
-
- ```
- systemTime.setTimezone('Asia/Shanghai').then((data) => {
- console.log(`SystemTimePlugin success to systemTime.setTimezone: ` + JSON.stringify(data));
- }).catch((error) => {
- console.error(`SystemTimePlugin failed to systemTime.setTimezone because: ` + JSON.stringify(error));
- });
- ```
+## systemTime.setTime
+
+setTime(time : number, callback : AsyncCallback<void>) : void
+
+设置系统时间，需要ohos.permission.SET_TIME权限。
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | time | number | 是 | 目标时间戳（毫秒）。 |
+ | callback | AsyncCallback<void> | 是 | 回调函数，可以在回调函数中处理接口返回值。 |
+
+- 示例：
+ ```
+ // time对应的时间为2021-01-20 02:36:25
+ var time = 1611081385000;
+ systemTime.setTime(time, (error, data) => {
+ if (error) {
+ console.error(`failed to systemTime.setTime because ` + JSON.stringify(error));
+ return;
+ }
+ console.log(`success to systemTime.setTime: ` + JSON.stringify(data));
+ });
+ ```
+
+
+## systemTime.setTime
+
+setTime(time : number) : Promise<void>
+
+设置系统时间，需要ohos.permission.SET_TIME权限。
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | time | number | 是 | 目标时间戳（毫秒）。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<void> | 返回的异步回调函数。 |
+
+- 示例：
+ ```
+ // time对应的时间为2021-01-20 02:36:25
+ var time = 1611081385000;
+ systemTime.setTime(time).then((data) => {
+ console.log(`success to systemTime.setTime: ` + JSON.stringify(data));
+ }).catch((error) => {
+ console.error(`failed to systemTime.setTime because ` + JSON.stringify(error));
+ });
+ ```
+
+
+## systemTime.setDate
+
+setDate(date: Date, callback: AsyncCallback<void>): void
+
+设置系统日期，需要ohos.permission.SET_TIME权限。
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | date | Date | 是 | 目标日期。 |
+ | callback | AsyncCallback<void> | 是 | 回调函数，可以在回调函数中处理接口返回值。 |
+
+- 示例：
+ ```
+ var data = new Date("October 13, 2020 11:13:00");
+ systemTime.setDate(data,(error, data) => {
+ if (error) {
+ console.error('SystemTimePlugin setDate failed because ' + JSON.stringify(error));
+ return;
+ }
+ console.info('SystemTimePlugin setDate success data : ' + JSON.stringify(data));
+ });
+ ```
+
+
+## systemTime.setDate
+
+setDate(date: Date): Promise<void>
+
+设置系统日期，需要ohos.permission.SET_TIME权限。
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | date | Date | 是 | 目标日期。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<void> | 返回的异步回调函数。 |
+- 示例：
+ ```
+ var data = new Date("October 13, 2020 11:13:00");
+ systemTime.setDate(data).then((value) => {
+ console.log(`SystemTimePlugin success to systemTime.setDate: ` + JSON.stringify(value));
+ }).catch((error) => {
+ console.error(`SystemTimePlugin failed to systemTime.setDate because: ` + JSON.stringify(error));
+ });
+ ```
+
+
+## systemTime.setTimezone
+
+setTimezone(timezone: string, callback: AsyncCallback<void>): void
+
+设置系统时区，需要ohos.permission.SET_TIME_ZONE权限。
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | timezone | string | 是 | 系统时区。 |
+ | callback | AsyncCallback<void> | 是 | 回调函数，可以在回调函数中处理接口返回值。 |
+
+- 示例：
+ ```
+ systemTime.setTimezone('Asia/Shanghai', (error, data) => {
+ if (error) {
+ console.error('SystemTimePlugin setTimezone failed because ' + JSON.stringify(error));
+ return;
+ }
+ console.info('SystemTimePlugin setTimezone success data : ' + JSON.stringify(data));
+ });
+ ```
+
+
+## systemTime.setTimezone
+
+setTimezone(timezone: string): Promise<void>
+
+设置系统时区，需要ohos.permission.SET_TIME_ZONE权限。
+
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | timezone | string | 是 | 系统时区。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<void> | 返回的异步回调函数。 |
+
+- 示例：
+ ```
+ systemTime.setTimezone('Asia/Shanghai').then((data) => {
+ console.log(`SystemTimePlugin success to systemTime.setTimezone: ` + JSON.stringify(data));
+ }).catch((error) => {
+ console.error(`SystemTimePlugin failed to systemTime.setTimezone because: ` + JSON.stringify(error));
+ });
+ ```
diff --git a/zh-cn/application-dev/reference/apis/js-apis-telephony.md b/zh-cn/application-dev/reference/apis/js-apis-telephony.md
index ab33a0a089a1c4a0cf311ffe0ace786e107e0776..f0e4f4ed886f45a9c062e9328d71b622d526cef5 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-telephony.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-telephony.md
@@ -1,6 +1,2 @@
-# 电话服务
+# 电话服务
-- [拨打电话](js-apis-call.md)
-- [短信服务](js-apis-sms.md)
-- [SIM卡管理](js-apis-sim.md)
-- [网络搜索](js-apis-radio.md)
\ No newline at end of file
diff --git a/zh-cn/application-dev/reference/apis/js-apis-update.md b/zh-cn/application-dev/reference/apis/js-apis-update.md
new file mode 100644
index 0000000000000000000000000000000000000000..c1845759c88716b69468ffac22f6233e98e2c521
--- /dev/null
+++ b/zh-cn/application-dev/reference/apis/js-apis-update.md
@@ -0,0 +1,557 @@
+# 升级
+
+升级范围：升级整个OpenHarmony系统，包括内置的资源、预置应用；第三方的应用不在升级的范围。
+
+升级依赖：升级分为SD卡升级和在线升级两种。
+
+- SD卡升级依赖升级包和SD卡安装。
+- 在线升级依赖手机厂商部署的用于管理升级包的服务器。服务器由手机厂商部署，IP由调用者传入，请求的request接口是固定的，由手机厂商开发。
+
+## 导入模块
+
+```js
+import client from '@ohos.update'
+```
+
+## 权限列表
+
+无
+
+## Updater
+
+### getNewVersionInfo
+
+getNewVersionInfo(callback: AsyncCallback\): void
+
+获取新版本信息，使用callback方式作为异步方法。
+
+**参数：**
+
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ------------------------------------------------ | ---- | ------------------ |
+| callback | AsyncCallback<[NewVersionInfo](#newversioninfo)> | 否 | 回调返回新版本信息 |
+
+**示例：**
+
+```
+updater.getNewVersionInfo(info => {
+ console.log("getNewVersionInfo success " + info.status);
+ console.log(`info versionName = ` + info.result[0].versionName);
+ console.log(`info versionCode = ` + info.result[0].versionCode);
+ console.log(`info verifyInfo = ` + info.result[0].verifyInfo);
+)};
+```
+
+### getNewVersionInfo
+
+getNewVersionInfo(): Promise\
+
+获取新版本信息，使用promise方式作为异步方法。
+
+**返回值：**
+
+| 类型 | 说明 |
+| ------------------------------------------- | ------------------------- |
+| Promise\<[NewVersionInfo](#newversioninfo)> | Promise，用于异步获取结果 |
+
+**示例：**
+
+```
+var p = updater.getNewVersionInfo();
+p.then(function (value) {
+ console.log(`info versionName = ` + value.result[0].versionName);
+ console.log(`info versionCode = ` + value.result[0].versionCode);
+ console.log(`info verifyInfo = ` + value.result[0].verifyInfo);
+}).catch(function (err) {
+ console.log("getNewVersionInfo promise error: " + err.code);
+)};
+```
+
+### checkNewVersion
+
+checkNewVersion(callback: AsyncCallback\): void
+
+检查新版本，使用callback方式作为异步方法。
+
+**参数：**
+
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ------------------------------------------------- | ---- | ------------------ |
+| callback | AsyncCallback\<[NewVersionInfo](#newversioninfo)> | 否 | 回调返回新版本信息 |
+
+**示例：**
+
+```
+updater.checkNewVersion(info => {
+ console.log("checkNewVersion success " + info.status);
+ console.log(`info versionName = ` + info.result[0].versionName);
+ console.log(`info versionCode = ` + info.result[0].versionCode);
+ console.log(`info verifyInfo = ` + info.result[0].verifyInfo);
+)};
+```
+
+### checkNewVersion
+
+checkNewVersion(): Promise\
+
+检查新版本，使用promise方式作为异步方法。
+
+**返回值:**
+
+| 类型 | 说明 |
+| ------------------------------------------- | ------------------------- |
+| Promise\<[NewVersionInfo](#newversioninfo)> | Promise函数返回新版本信息 |
+
+**示例:**
+
+```
+var p = updater.checkNewVersion();
+p.then(function (value) {
+ console.log(`info versionName = ` + value.result[0].versionName);
+ console.log(`info versionCode = ` + value.result[0].versionCode);
+ console.log(`info verifyInfo = ` + value.result[0].verifyInfo);
+}).catch(function (err) {
+ console.log("checkNewVersion promise error: " + err.code);
+)};
+```
+
+### verifyUpdatePackage
+
+verifyUpdatePackage(upgradeFile: string, certsFile: string): void
+
+升级前检查升级包是否有效。
+
+**参数：**
+
+| 参数名 | 类型 | 必填 | 说明 |
+| ----------- | ------ | ---- | ------------------ |
+| upgradeFile | string | 是 | 待校验的升级包路径 |
+| certsFile | string | 是 | 证书路径 |
+
+**示例：**
+
+```
+var getVar = update.getUpdater();
+getVar.on("verifyProgress", function (callback){
+ console.info('on verifyProgress ' + callback.percent);
+});
+getVar.verifyUpdatePackage("XXX", "XXX");
+getVar.off("verifyProgress");
+```
+
+### rebootAndCleanUserData
+
+rebootAndCleanUserData(): Promise\
+
+重启设备并清除用户分区数据。
+
+**返回值：**
+
+| 类型 | 说明 |
+| ---------------- | ------------------------------- |
+| Promise\ | Promise示例，用于异步获取结果。 |
+
+**示例：**
+
+```
+var getVar = update.getUpdater();
+p = getVar.rebootAndCleanUserData();
+p.then(function (value) {
+ console.info("rebootAndCleanUserData promise success: " + value);
+}).catch(function (err) {
+ console.info("rebootAndCleanUserData promise error: " + err.code);
+});
+```
+
+### rebootAndCleanUserData
+
+rebootAndCleanUserData(callback: AsyncCallback\): void
+
+重启设备并清除用户分区数据。
+
+**参数：**
+
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | -------- | ---- | ---------------------- |
+| callback | Function | 是 | AsyncCallback\ |
+
+**示例：**
+
+```
+var getVar = update.getUpdater();
+getVar.rebootAndCleanUserData(function (err, data) {
+ if (err.code == 0) {
+ console.info("rebootAndCleanUserData callback success:" + data)
+ } else {
+ console.info("rebootAndCleanUserData callback err:" + err.code)
+ }
+});
+```
+
+### applyNewVersion
+
+applyNewVersion(): Promise\
+
+重启设备后安装升级包。
+
+**返回值：**
+
+| 类型 | 说明 |
+| ---------------- | ------------------------------- |
+| Promise\ | Promise示例，用于异步获取结果。 |
+
+**示例：**
+
+```
+var getVar = update.getUpdater();
+p.then(function (value) {
+ console.info("applyNewVersion promise success: " + value);
+}).catch(function (err) {
+ console.info("applyNewVersion promise error: " + err.code);
+});
+```
+
+### applyNewVersion
+
+applyNewVersion(callback: AsyncCallback\): void
+
+重启设备后安装升级包。
+
+**参数：**
+
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | -------- | ---- | ---------------------- |
+| callback | Function | 是 | AsyncCallback\ |
+
+**示例：**
+
+```
+var getVar = update.getUpdater();
+getVar.applyNewVersion(function (err, data) {
+ if (err.code == 0) {
+ console.info("applyNewVersion callback success:" + data)
+ } else {
+ console.info("applyNewVersion callback err:" + err.code)
+ }
+});
+```
+
+### download
+
+download(): void
+
+下载新版本，并监听下载进程。
+
+**示例：**
+
+```
+updater.on("downloadProgress", progress => {
+ console.log("downloadProgress on" + progress);
+ console.log(`downloadProgress status: ` + progress.status);
+ console.log(`downloadProgress percent: ` + progress.percent);
+)};
+updater.download();
+```
+
+### upgrade
+
+updater.upgrade():void
+
+启动升级。
+
+**示例：**
+
+```
+updater.on("upgradeProgress", progress => {
+ console.log("upgradeProgress on" + progress);
+ console.log(`upgradeProgress status: ` + progress.status);
+ console.log(`upgradeProgress percent: ` + progress.percent);
+)};
+updater.upgrade();
+```
+
+### setUpdatePolicy
+
+setUpdatePolicy(policy: UpdatePolicy, callback: AsyncCallback\): void
+
+设置升级策略，使用callback方式作为异步方法。
+
+**参数：**
+
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ----------------------------- | ---- | ------------ |
+| policy | [UpdatePolicy](#updatepolicy) | 是 | 设置升级策略 |
+| callback | AsyncCallback\ | 是 | 回调返回结果 |
+
+**示例：**
+
+```
+// 设置策略
+let policy = {
+autoDownload: false,
+autoDownloadNet: true,
+mode: 2,
+autoUpgradeInterval: [ 2, 3 ],
+autoUpgradeCondition: 2
+}
+updater.setUpdatePolicy(policy, function(result) {
+console.log("setUpdatePolicy ", result)});
+```
+
+### setUpdatePolicy
+
+setUpdatePolicy(policy: UpdatePolicy): Promise\
+
+设置升级策略，使用promise方式作为异步方法。
+
+**参数：**
+
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ----------------------------- | ---- | ------------ |
+| policy | [UpdatePolicy](#updatepolicy) | 是 | 设置升级策略 |
+
+**返回值：**
+
+| 类型 | 说明 |
+| ---------------- | ----------------------- |
+| Promise\ | Promise函数返回设置结果 |
+
+**示例：**
+
+```
+let policy = {
+autoDownload: false,
+autoDownloadNet: true,
+mode: 2,
+autoUpgradeInterval: [ 2, 3 ],
+autoUpgradeCondition: 2
+}
+updater.setUpdatePolicy(policy)
+.then(data=>
+console.log('set policy success')
+)
+```
+
+### getUpdatePolicy
+
+getUpdatePolicy(callback: AsyncCallback\): void
+
+获取升级策略信息，使用callback方式作为异步方法。
+
+**参数：**
+
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | --------------------------------------------- | ---- | -------------------- |
+| callback | AsyncCallback\<[UpdatePolicy](#updatepolicy)> | 否 | 回调返回升级策略信息 |
+
+**示例：**
+
+```
+updater.getUpdatePolicy(policy => {
+ console.log("getUpdatePolicy success");
+ console.log(`policy autoDownload = ` + policy.autoDownload);
+ console.log(`policy autoDownloadNet = ` + policy.autoDownloadNet);
+ console.log(`policy mode = ` + policy.mode);
+)};
+```
+
+### getUpdatePolicy
+
+getUpdatePolicy(): Promise\
+
+获取升级策略，通过promise方式作为异步方法。
+
+**返回值：**
+
+| 类型 | 说明 |
+| --------------------------------------- | --------------------------- |
+| Promise\<[UpdatePolicy](#updatepolicy)> | Promise函数返回升级策略信息 |
+
+**示例：**
+
+```
+p = updater.getUpdatePolicy();
+p.then(function (value) {
+ console.log(`info autoDownload = ` + value.autoDownload);
+ console.log(`info autoDownloadNet = ` + value.autoDownloadNet);
+ console.log(`info mode = ` + value.mode);
+}).catch(function (err) {
+ console.log("getUpdatePolicy promise error: " + err.code);
+)};
+```
+
+## update.getUpdater
+
+getUpdater(upgradeFile: string, updateType?: UpdateTypes): Updater
+
+获取本地升级Updater。
+
+**参数：**
+
+| 参数名 | 类型 | 必填 | 说明 |
+| ----------- | --------------------------- | ---- | -------- |
+| upgradeFile | string | 是 | 升级文件 |
+| updateType | [UpdateTypes](#updatetypes) | 是 | 升级类型 |
+
+**返回值：**
+
+| 类型 | 说明 |
+| ------------------- | -------- |
+| [Updater](#updater) | 升级对象 |
+
+**示例：**
+
+```
+try {
+ page.data.updater = update.getUpdater('/data/updater/updater.zip', 'OTA');
+} catch(error) {
+ console.error(" Fail to get updater error: " + error);
+}
+```
+
+## update.getUpdaterForOther
+
+getUpdaterForOther(upgradeFile: string, device: string, updateType?: UpdateTypes): Updater
+
+获取升级对象给待升级设备。
+
+**参数：**
+
+| 参数名 | 类型 | 必填 | 说明 |
+| ----------- | --------------------------- | ---- | ---------- |
+| upgradeFile | string | 是 | 升级文件 |
+| device | string | 是 | 待升级设备 |
+| updateType | [UpdateTypes](#updatetypes) | 是 | 升级类型 |
+
+**返回值：**
+
+| 类型 | 说明 |
+| ------------------- | -------- |
+| [Updater](#updater) | 升级对象 |
+
+**示例：**
+
+```
+try {
+ page.data.updater = update.getUpdaterForOther('/data/updater/updater.zip', '1234567890', 'OTA');
+} catch(error) {
+ console.error(" Fail to get updater error: " + error);
+}
+```
+
+## update.getUpdaterFromOther
+
+getUpdaterFromOther(upgradeFile: string, device: string, updateType?: UpdateTypes): Updater
+
+获取其它设备为本设备升级的Updater。
+
+**参数：**
+
+| 参数名 | 类型 | 必填 | 说明 |
+| ----------- | --------------------------- | ---- | ---------- |
+| upgradeFile | string | 是 | 升级文件 |
+| device | string | 是 | 待升级设备 |
+| updateType | [UpdateTypes](#updatetypes) | 是 | 升级类型 |
+
+**返回值：**
+
+| 类型 | 说明 |
+| ------------------- | -------- |
+| [Updater](#updater) | 升级对象 |
+
+**示例：**
+
+```
+try {
+ page.data.updater = update.getUpdaterFromOther('/data/updater/updater.zip', '1234567890', 'OTA');
+} catch(error) {
+ console.error(" Fail to get updater error: " + error);
+}
+```
+
+## UpdateTypes
+
+升级类型。
+
+| 参数名 | 说明 |
+| ------ | -------- |
+| OTA | OTA升级 |
+| patch | 补丁升级 |
+
+## PackageTypes
+
+升级包类型。
+
+| 参数名 | 默认值 | 说明 |
+| -------------------- | ------ | -------------- |
+| PACKAGE_TYPE_NORMAL | 1 | 通用升级包 |
+| PACKAGE_TYPE_BASE | 2 | 基础升级包 |
+| PACKAGE_TYPE_CUST | 3 | 定制升级包 |
+| PACKAGE_TYPE_PRELOAD | 4 | 预装升级包 |
+| PACKAGE_TYPE_COTA | 5 | 参数配置升级包 |
+| PACKAGE_TYPE_VERSION | 6 | 版本升级包 |
+| PACKAGE_TYPE_PATCH | 7 | 补丁包 |
+
+## InstallMode
+
+安装模式。
+
+| 参数名 | 默认值 | 说明 |
+| ------------------- | ------ | -------- |
+| INSTALL_MODE_NORMAL | 0 | 正常升级 |
+| INSTALL_MODE_NIGHT | 1 | 夜间升级 |
+| INSTALL_MODE_AUTO | 2 | 自动升级 |
+
+## NewVersionStatus
+
+新版本检测状态。
+
+| 参数名 | 默认值 | 说明 |
+| ------------------- | ------ | ---------------- |
+| VERSION_STATUS_ERR | -1 | 检测版本时出错 |
+| VERSION_STATUS_NEW | 0 | 检测到新版本 |
+| VERSION_STATUS_NONE | 1 | 没有检测到新版本 |
+| VERSION_STATUS_BUSY | 2 | 检测版本时忙 |
+
+## UpdatePolicy
+
+升级策略。
+
+| 名称 | 参数类型 | 必填 | 说明 |
+| ------------------- | --------------------------- | ---- | -------------- |
+| autoDownload | bool | 是 | 自动升级开关 |
+| installMode | [InstallMode](#installmode) | 是 | 安装模式 |
+| autoUpgradeInterval | Array\ | 是 | 自动升级时间段 |
+
+## NewVersionInfo
+
+新版本信息。
+
+| 名称 | 参数类型 | 必填 | 说明 |
+| --------------- | ------------------------------------------- | ---- | -------- |
+| status | [NewVersionStatus](#newversionstatus) | 是 | 升级状态 |
+| errMsg | string | 是 | 错误信息 |
+| checkResults | Array<[CheckResult](#checkresult)> | 是 | 检测结果 |
+| descriptionInfo | Array\<[DescriptionInfo](#descriptioninfo)> | 是 | 描述信息 |
+
+## CheckResult
+
+检测结果。
+
+| 名称 | 参数类型 | 必填 | 说明 |
+| ------------- | ----------------------------- | ---- | ------------ |
+| versionName | string | 是 | 版本名称 |
+| versionCode | number | 是 | 版本编码 |
+| size | number | 是 | 版本大小 |
+| verifyInfo | string | 是 | 版本校验信息 |
+| packageType | [PackageTypes](#packagetypes) | 是 | 版本类型 |
+| descriptionId | string | 是 | 版本描述信息 |
+
+## DescriptionInfo
+
+版本描述信息。
+
+| 名称 | 参数类型 | 必填 | 说明 |
+| ------------- | -------- | ---- | ----------------- |
+| descriptionId | string | 是 | 版本versionId信息 |
+| content | string | 是 | 版本changelog信息 |
\ No newline at end of file
diff --git a/zh-cn/application-dev/reference/apis/js-apis-url.md b/zh-cn/application-dev/reference/apis/js-apis-url.md
index 29b197150d3bf7bce305ed1f0720aa5502fff108..fd25a94c7c392327fdf963f807a13ee5457a69e1 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-url.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-url.md
@@ -1,934 +1,421 @@
-# URL字符串解析
+# URL字符串解析
-> **说明：**
->从 API Version 7 开始支持。
+>  **说明：**
+> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
-## 导入模块
+
+## 导入模块
```
import Url from '@ohos.url'
```
-## 权限
+
+## 权限
无
-## URLSearchParams
-### constructor
+## URLSearchParams
+
+
+### constructor
-constructor\(init?: string\[\]\[\] | Record | string | URLSearchParams\)
+constructor(init?: string[][] | Record<string, string> | string | URLSearchParams)
URLSearchParams的构造函数。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- init
- |
- string[][] | Record<string, string> | string | URLSearchParams
- |
- 否
- |
- 入参对象。
- - string[][]：字符串二维数组
- Record<string, string>：对象列表
- string：字符串
- URLSearchParams：对象
- |
-
-
-
-
-- 示例：
-
- ```
- var objectParams = new URLSearchParams([ ['user1', 'abc1'], ['query2', 'first2'], ['query3', 'second3'] ]);
- var objectParams1 = new URLSearchParams({"fod" : 1 , "bard" : 2});
- var objectParams2 = new URLSearchParams('?fod=1&bard=2');
- var urlObject = new URL('https://developer.mozilla.org/?fod=1&bard=2');
- var params = new URLSearchParams(urlObject .search);
- ```
-
-
-### append
-
-append\(name: string, value: string\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | init | string[][] \| Record<string, string> \| string \| URLSearchParams | 否 | 入参对象。
- string[][]：字符串二维数组
- Record<string, string>：对象列表
- string：字符串
- URLSearchParams：对象 |
+
+- 示例：
+ ```
+ var objectParams = new URLSearchParams([ ['user1', 'abc1'], ['query2', 'first2'], ['query3', 'second3'] ]);
+ var objectParams1 = new URLSearchParams({"fod" : 1 , "bard" : 2});
+ var objectParams2 = new URLSearchParams('?fod=1&bard=2');
+ var urlObject = new URL('https://developer.mozilla.org/?fod=1&bard=2');
+ var params = new URLSearchParams(urlObject .search);
+ ```
+
+
+### append
+
+append(name: string, value: string): void
将新的键值对插入到查询字符串。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- name
- |
- string
- |
- 是
- |
- 需要插入搜索参数的键名。
- |
-
- value
- |
- string
- |
- 是
- |
- 需要插入搜索参数的值。
- |
-
-
-
-
-- 示例：
-
- ```
- let urlObject = new URL('https://developer.exampleUrl/?fod=1&bard=2');
- let paramsObject = new URLSearchParams(urlObject.search.slice(1));
- paramsObject.append('fod', 3);
- ```
-
-
-### delete
-
-delete\(name: string\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | name | string | 是 | 需要插入搜索参数的键名。 |
+ | value | string | 是 | 需要插入搜索参数的值。 |
+
+- 示例：
+ ```
+ let urlObject = new URL('https://developer.exampleUrl/?fod=1&bard=2');
+ let paramsObject = new URLSearchParams(urlObject.search.slice(1));
+ paramsObject.append('fod', 3);
+ ```
+
+
+### delete
+
+delete(name: string): void
删除指定名称的键值对。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- name
- |
- string
- |
- 是
- |
- 需要删除的键值名称。
- |
-
-
-
-
-
-- 示例：
-
- ```
- let urlObject = new URL('https://developer.exampleUrl/?fod=1&bard=2');
- let paramsobject = new URLSearchParams(urlObject.search.slice(1));
- paramsobject.delete('foo');
- ```
-
-
-### getAll
-
-getAll\(name: string\): string\[\]
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | name | string | 是 | 需要删除的键值名称。 |
+
+- 示例：
+ ```
+ let urlObject = new URL('https://developer.exampleUrl/?fod=1&bard=2');
+ let paramsobject = new URLSearchParams(urlObject.search.slice(1));
+ paramsobject.delete('foo');
+ ```
+
+
+### getAll
+
+getAll(name: string): string[]
获取指定名称的所有键值对。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- name
- |
- string
- |
- 是
- |
- 指定的键值名称。
- |
-
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- string[]
- |
- 返回指定名称的所有键值对。
- |
-
-
-
-
-
-- 示例：
-
- ```
- let urlObject = new URL('https://developer.exampleUrl/?fod=1&bard=2');
- let paramsObject = new URLSearchParams(urlObject.search.slice(1));
- paramsObject.append('fod', 3); // Add a second value for the foo parameter.
- console.log(params.getAll('fod')) // Output ["1","3"].
- ```
-
-
-### entries
-
-entries\(\): IterableIterator<\[string, string\]\>
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | name | string | 是 | 指定的键值名称。 |
-返回一个ES6的迭代器，迭代器的每一项都是一个 JavaScript Array。Array的第一项是name，Array的第二项是value。
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | string[] | 返回指定名称的所有键值对。 |
+
+- 示例：
+ ```
+ let urlObject = new URL('https://developer.exampleUrl/?fod=1&bard=2');
+ let paramsObject = new URLSearchParams(urlObject.search.slice(1));
+ paramsObject.append('fod', 3); // Add a second value for the foo parameter.
+ console.log(params.getAll('fod')) // Output ["1","3"].
+ ```
-- 返回值：
-
- 类型
- |
- 说明
- |
-
|---|
-
- IterableIterator<[string, string]>
- |
- 返回一个ES6的迭代器。
- |
-
-
-
+### entries
+entries(): IterableIterator<[string, string]>
+
+返回一个ES6的迭代器，迭代器的每一项都是一个 JavaScript Array。Array的第一项是name，Array的第二项是value。
-- 示例：
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | IterableIterator<[string, string]> | 返回一个ES6的迭代器。 |
- ```
- var searchParamsObject = new URLSearchParams("keyName1=valueName1&keyName2=valueName2");
- for (var pair of searchParamsObject .entries()) { // Show keyName/valueName pairs
- console.log(pair[0]+ ', '+ pair[1]);
- }
- ```
+- 示例：
+ ```
+ var searchParamsObject = new URLSearchParams("keyName1=valueName1&keyName2=valueName2");
+ for (var pair of searchParamsObject .entries()) { // Show keyName/valueName pairs
+ console.log(pair[0]+ ', '+ pair[1]);
+ }
+ ```
-### forEach
+### forEach
-forEach\(callbackfn: \(value: string, key: string, searchParams: Object\) =\> void, thisArg?: Object\): void
+forEach(callbackfn: (value: string, key: string, searchParams: Object) => void, thisArg?: Object): void
通过回调函数来遍历URLSearchParams实例对象上的键值对。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- callbackfn
- |
- function
- |
- 是
- |
- 回调函数。
- |
-
- thisArg
- |
- Object
- |
- 否
- |
- callbackfn被调用时用作this值
- |
-
-
-
-
- **表 1** callbackfn的参数说明
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- value
- |
- string
- |
- 是
- |
- 当前遍历到的键值。
- |
-
- key
- |
- string
- |
- 是
- |
- 当前遍历到的键名。
- |
-
- searchParams
- |
- Object
- |
- 是
- |
- 当前调用forEach方法的实例对象。
- |
-
-
-
-
-- 示例：
-
- ```
- const myURLObject = new URL('https://developer.exampleUrl/?fod=1&bard=2');
- myURLObject.searchParams.forEach((value, name, searchParams) => {
- console.log(name, value, myURLObject.searchParams === searchParams);
- });
- ```
-
-
-### get
-
-get\(name: string\): string | null
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | callbackfn | function | 是 | 回调函数。 |
+ | thisArg | Object | 否 | callbackfn被调用时用作this值 |
+
+ **表1** callbackfn的参数说明
+
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | value | string | 是 | 当前遍历到的键值。 |
+ | key | string | 是 | 当前遍历到的键名。 |
+ | searchParams | Object | 是 | 当前调用forEach方法的实例对象。 |
+
+- 示例：
+ ```
+ const myURLObject = new URL('https://developer.exampleUrl/?fod=1&bard=2');
+ myURLObject.searchParams.forEach((value, name, searchParams) => {
+ console.log(name, value, myURLObject.searchParams === searchParams);
+ });
+ ```
+
+
+### get
+
+get(name: string): string | null
获取指定名称对应的第一个值。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- name
- |
- string
- |
- 是
- |
- 指定键值对的名称。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- string
- |
- 返回第一个值。
- |
-
- null
- |
- 如果没找到，返回 null。
- |
-
-
-
-
-- 示例：
-
- ```
- var paramsOject = new URLSearchParams(document.location.search.substring(1));
- var name = paramsOject.get("name"); // is the string "Jonathan"
- var age = parseInt(paramsOject.get("age"), 10); // is the number 18
- var address = paramsOject.get("address"); // null
- ```
-
-
-### has
-
-has\(name: string\): boolean
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | name | string | 是 | 指定键值对的名称。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | string | 返回第一个值。 |
+ | null | 如果没找到，返回 null。 |
+
+- 示例：
+ ```
+ var paramsOject = new URLSearchParams(document.location.search.substring(1));
+ var name = paramsOject.get("name"); // is the string "Jonathan"
+ var age = parseInt(paramsOject.get("age"), 10); // is the number 18
+ var address = paramsOject.get("address"); // null
+ ```
+
+
+### has
+
+has(name: string): boolean
判断一个指定的键名对应的值是否存在。
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | name | string | 是 | 要查找的参数的键名。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | boolean | 是否存在相对应的key值，存在返回true，否则返回false。 |
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- name
- |
- string
- |
- 是
- |
- 要查找的参数的键名。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- boolean
- |
- 是否存在相对应的key值，存在返回true，否则返回false。
- |
-
-
-
-
-- 示例：
-
- ```
- let urlObject = new URL('https://developer.exampleUrl/?fod=1&bard=2');
- let paramsObject = new URLSearchParams(urlObject.search.slice(1));
- paramsObject.has('bard') === true;
- ```
-
-
-### set
-
-set\(name: string, value: string\): void
+- 示例：
+ ```
+ let urlObject = new URL('https://developer.exampleUrl/?fod=1&bard=2');
+ let paramsObject = new URLSearchParams(urlObject.search.slice(1));
+ paramsObject.has('bard') === true;
+ ```
+
+
+### set
+
+set(name: string, value: string): void
将与name关联的URLSearchParams对象中的值设置为value。如果存在名称为name的键值对，请将第一个键值对的值设置为value并删除所有其他值。如果不是，则将键值对附加到查询字符串。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- name
- |
- string
- |
- 是
- |
- 将要设置的参数的键值名。
- |
-
- value
- |
- string
- |
- 是
- |
- 所要设置的参数值。
- |
-
-
-
-
-
-- 示例：
-
- ```
- let urlObject = new URL('https://developer.exampleUrl/?fod=1&bard=2');
- let paramsObject = new URLSearchParams(urlObject.search.slice(1));
- paramsObject.set('baz', 3); // Add a third parameter.
- ```
-
-
-### sort
-
-sort\(\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | name | string | 是 | 将要设置的参数的键值名。 |
+ | value | string | 是 | 所要设置的参数值。 |
-对包含在此对象中的所有键值对进行排序，并返回undefined。排序顺序是根据键的Unicode代码点。该方法使用稳定的排序算法 （即，将保留具有相等键的键值对之间的相对顺序）。
+- 示例：
+ ```
+ let urlObject = new URL('https://developer.exampleUrl/?fod=1&bard=2');
+ let paramsObject = new URLSearchParams(urlObject.search.slice(1));
+ paramsObject.set('baz', 3); // Add a third parameter.
+ ```
-- 示例：
- ```
- var searchParamsObject = new URLSearchParams("c=3&a=9&b=4&d=2"); // Create a test URLSearchParams object
- searchParamsObject.sort(); // Sort the key/value pairs
- console.log(searchParamsObject.toString()); // Display the sorted query string // Output a=9&b=2&c=3&d=4
- ```
+### sort
+sort(): void
-### keys
-keys\(\): IterableIterator
+对包含在此对象中的所有键值对进行排序，并返回undefined。排序顺序是根据键的Unicode代码点。该方法使用稳定的排序算法 （即，将保留具有相等键的键值对之间的相对顺序）。
-返回一个所有键值对的name的ES6迭代器。
-- 返回值：
+- 示例：
+ ```
+ var searchParamsObject = new URLSearchParams("c=3&a=9&b=4&d=2"); // Create a test URLSearchParams object
+ searchParamsObject.sort(); // Sort the key/value pairs
+ console.log(searchParamsObject.toString()); // Display the sorted query string // Output a=9&b=2&c=3&d=4
+ ```
-
- 类型
- |
- 说明
- |
-
|---|
-
- IterableIterator<string>
- |
- 返回一个所有键值对的name的ES6迭代器。
- |
-
-
-
+### keys
-- 示例：
+keys(): IterableIterator<string>
- ```
- var searchParamsObject = new URLSearchParams("key1=value1&key2=value2"); // Create a URLSearchParamsObject object for testing
- for (var key of searchParamsObject .keys()) { // Output key-value pairs
- console.log(key);
- }
- ```
+返回一个所有键值对的name的ES6迭代器。
-### values
-values\(\): IterableIterator
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | IterableIterator<string> | 返回一个所有键值对的name的ES6迭代器。 |
-返回一个所有键值对的value的ES6迭代器。
-- 返回值：
+- 示例：
+ ```
+ var searchParamsObject = new URLSearchParams("key1=value1&key2=value2"); // Create a URLSearchParamsObject object for testing
+ for (var key of searchParamsObject .keys()) { // Output key-value pairs
+ console.log(key);
+ }
+ ```
-
- 类型
- |
- 说明
- |
-
|---|
-
- IterableIterator<string>
- |
- 返回一个所有键值对的value的ES6迭代器。
- |
-
-
-
+### values
-- 示例
+values(): IterableIterator<string>
+
+返回一个所有键值对的value的ES6迭代器。
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | IterableIterator<string> | 返回一个所有键值对的value的ES6迭代器。 |
+
+- 示例
+ ```
+ var searchParams = new URLSearchParams("key1=value1&key2=value2"); // Create a URLSearchParamsObject object for testing
+ for (var value of searchParams.values()) {
+ console.log(value);
+ }
+ ```
- ```
- var searchParams = new URLSearchParams("key1=value1&key2=value2"); // Create a URLSearchParamsObject object for testing
- for (var value of searchParams.values()) {
- console.log(value);
- }
- ```
+### [Symbol.iterator]
-### \[Symbol.iterator\]
+[Symbol.iterator](): IterableIterator<[string, string]>
-\[Symbol.iterator\]\(\): IterableIterator<\[string, string\]\>
返回一个ES6的迭代器，迭代器的每一项都是一个 JavaScript Array。Array的第一项是name，Array的第二项是value。
-- 返回值：
-
- 类型
- |
- 说明
- |
-
|---|
-
- IterableIterator<[string, string]>
- |
- 返回一个ES6的迭代器。
- |
-
-
-
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | IterableIterator<[string, string]> | 返回一个ES6的迭代器。 |
-- 示例：
+- 示例：
+ ```
+ const paramsObject = new URLSearchParams('fod=bay&edg=bap');
+ for (const [name, value] of paramsObject) {
+ console.log(name, value);
+ }
+ ```
- ```
- const paramsObject = new URLSearchParams('fod=bay&edg=bap');
- for (const [name, value] of paramsObject) {
- console.log(name, value);
- }
- ```
+### tostring
-### tostring
+toString(): string
-toString\(\): string
返回序列化为字符串的搜索参数，必要时对字符进行百分比编码。
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- string
- |
- 返回序列化为字符串的搜索参数，必要时对字符进行百分比编码。
- |
-
-
-
-
-
-- 示例：
-
- ```
- let url = new URL('https://developer.exampleUrl/?fod=1&bard=2');
- let params = new URLSearchParams(url.search.slice(1));
- params.append('fod', 3);
- console.log(params.toString());
- ```
-
-
-## URL
-
-### 属性
-
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-hash
- |
-string
- |
-是
- |
-是
- |
-获取和设置URL的片段部分。
- |
-
-host
- |
-string
- |
-是
- |
-是
- |
-获取和设置URL的主机部分。
- |
-
-hostname
- |
-string
- |
-是
- |
-是
- |
-获取和设置URL的主机名部分，不带端口。
- |
-
-href
- |
-string
- |
-是
- |
-是
- |
-获取和设置序列化的URL。
- |
-
-origin
- |
-string
- |
-是
- |
-否
- |
-获取URL源的只读序列化。
- |
-
-password
- |
-string
- |
-是
- |
-是
- |
-获取和设置URL的密码部分。
- |
-
-pathname
- |
-string
- |
-是
- |
-是
- |
-获取和设置URL的路径部分。
- |
-
-port
- |
-string
- |
-是
- |
-是
- |
-获取和设置URL的端口部分。
- |
-
-protocol
- |
-string
- |
-是
- |
-是
- |
-获取和设置URL的协议部分。
- |
-
-search
- |
-string
- |
-是
- |
-是
- |
-获取和设置URL的序列化查询部分。
- |
-
-searchParams
- |
-URLsearchParams
- |
-是
- |
-否
- |
-获取URLSearchParams表示URL查询参数的对象。
- |
-
-username
- |
-string
- |
-是
- |
-是
- |
-获取和设置URL的用户名部分。
- |
-
-
-
-
-### constructor
-
-constructor\(url: string, base?: string | URL\)
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | string | 返回序列化为字符串的搜索参数，必要时对字符进行百分比编码。 |
+
+
+- 示例：
+ ```
+ let url = new URL('https://developer.exampleUrl/?fod=1&bard=2');
+ let params = new URLSearchParams(url.search.slice(1));
+ params.append('fod', 3);
+ console.log(params.toString());
+ ```
+
+
+## URL
+
+
+### 属性
+
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| hash | string | 是 | 是 | 获取和设置URL的片段部分。 |
+| host | string | 是 | 是 | 获取和设置URL的主机部分。 |
+| hostname | string | 是 | 是 | 获取和设置URL的主机名部分，不带端口。 |
+| href | string | 是 | 是 | 获取和设置序列化的URL。 |
+| origin | string | 是 | 否 | 获取URL源的只读序列化。 |
+| password | string | 是 | 是 | 获取和设置URL的密码部分。 |
+| pathname | string | 是 | 是 | 获取和设置URL的路径部分。 |
+| port | string | 是 | 是 | 获取和设置URL的端口部分。 |
+| protocol | string | 是 | 是 | 获取和设置URL的协议部分。 |
+| search | string | 是 | 是 | 获取和设置URL的序列化查询部分。 |
+| searchParams | URLsearchParams | 是 | 否 | 获取URLSearchParams表示URL查询参数的对象。 |
+| username | string | 是 | 是 | 获取和设置URL的用户名部分。 |
+
+
+### constructor
+
+constructor(url: string, base?: string | URL)
+
URL的构造函数。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- url
- |
- string
- |
- 是
- |
- 入参对象。
- |
-
- base
- |
- string | URL
- |
- 否
- |
- 入参字符串或者对象。
-
- |
-
-
-
-
-
-- 示例：
-
- ```
- var mm = 'http://username:password@host:8080';
- var a = new URL("/", mm); // Output 'http://username:password@host:8080/';
- var b = new URL(mm); // Output 'http://username:password@host:8080/';
- new URL('path/path1', b); // Output 'http://username:password@host:8080/path/path1';
- var c = new URL('/path/path1', b); // Output 'http://username:password@host:8080/path/path1';
- new URL('/path/path1', c); // Output 'http://username:password@host:8080/path/path1';
- new URL('/path/path1', a); // Output 'http://username:password@host:8080/path/path1';
- new URL('/path/path1', "https://www.exampleUrl/fr-FR/toto"); // Output https://www.exampleUrl/path/path1
- new URL('/path/path1', ''); // Raises a TypeError exception as '' is not a valid URL
- new URL('/path/path1'); // Raises a TypeError exception as '/path/path1' is not a valid URL
- new URL('http://www.shanxi.com', ); // Output http://www.shanxi.com/
- new URL('http://www.shanxi.com', b); // Output http://www.shanxi.com/
- ```
-
-
-### tostring
-
-toString\(\): string
-将解析过后的URL转化为字符串。
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | url | string | 是 | 入参对象。 |
+ | base | string \| URL | 否 | 入参字符串或者对象。
- string：字符串
- URL：字符串或对象 |
+
-- 返回值：
+- 示例：
+ ```
+ var mm = 'http://username:password@host:8080';
+ var a = new URL("/", mm); // Output 'http://username:password@host:8080/';
+ var b = new URL(mm); // Output 'http://username:password@host:8080/';
+ new URL('path/path1', b); // Output 'http://username:password@host:8080/path/path1';
+ var c = new URL('/path/path1', b); // Output 'http://username:password@host:8080/path/path1';
+ new URL('/path/path1', c); // Output 'http://username:password@host:8080/path/path1';
+ new URL('/path/path1', a); // Output 'http://username:password@host:8080/path/path1';
+ new URL('/path/path1', "https://www.exampleUrl/fr-FR/toto"); // Output https://www.exampleUrl/path/path1
+ new URL('/path/path1', ''); // Raises a TypeError exception as '' is not a valid URL
+ new URL('/path/path1'); // Raises a TypeError exception as '/path/path1' is not a valid URL
+ new URL('http://www.shanxi.com', ); // Output http://www.shanxi.com/
+ new URL('http://www.shanxi.com', b); // Output http://www.shanxi.com/
+ ```
-
- 类型
- |
- 说明
- |
-
|---|
-
- string
- |
- 用于返回网址的字符串序列化。
- |
-
-
-
+### tostring
-- 示例：
+toString(): string
- ```
- const url = new URL('http://username:password@host:8080/directory/file?query=pppppp#qwer=da');
- url.toString()
- ```
+将解析过后的URL转化为字符串。
-### toJSON
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | string | 用于返回网址的字符串序列化。 |
-toJSON\(\): string
-将解析过后的URL转化为JSON字符串。
+- 示例：
+ ```
+ const url = new URL('http://username:password@host:8080/directory/file?query=pppppp#qwer=da');
+ url.toString()
+ ```
-- 返回值：
-
- 类型
- |
- 说明
- |
-
|---|
-
- string
- |
- 用于返回网址的字符串序列化。
- |
-
-
-
+### toJSON
+toJSON(): string
+
+
+将解析过后的URL转化为JSON字符串。
-- 示例：
- ```
- const url = new URL('http://username:password@host:8080/directory/file?query=pppppp#qwer=da');
- url.toString()
- ```
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | string | 用于返回网址的字符串序列化。 |
+- 示例：
+ ```
+ const url = new URL('http://username:password@host:8080/directory/file?query=pppppp#qwer=da');
+ url.toString()
+ ```
diff --git a/zh-cn/application-dev/reference/apis/js-apis-util.md b/zh-cn/application-dev/reference/apis/js-apis-util.md
index 9cf776e9a760b3b34d241d3d1a42d6991c5d57d8..2b0da9c6af96b71757c14cebb62eafbfc5a27cec 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-util.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-util.md
@@ -1,668 +1,276 @@
-# 字符串编解码
+# 字符串编解码
-> **说明：**
->从 API Version 7 开始支持。
+>  **说明：**
+> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
-## 导入模块
+
+## 导入模块
```
import util from '@ohos.util';
```
-## 权限
+
+## 权限
无
-## util.printf
-printf\(format: string, ...args: Object\[\]\): string
+## util.printf
+
+printf(format: string, ...args: Object[]): string
通过式样化字符串对输入的内容按特定格式输出。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- format
- |
- string
- |
- 是
- |
- 式样化字符串。
- |
-
- ...args
- |
- Object[]
- |
- 否
- |
- 待式样化数据。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- string
- |
- 按特定格式式样化后的字符串。
- |
-
-
-
-
-- 示例：
-
- ```
- var res = util.printf("%s", "hello world!");
- console.log(res);
- ```
-
-
-## util.getErrorString
-
-getErrorString\(errno: number\): string
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | format | string | 是 | 式样化字符串。 |
+ | ...args | Object[] | 否 | 待式样化数据。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | string | 按特定格式式样化后的字符串。 |
+
+- 示例：
+ ```
+ var res = util.printf("%s", "hello world!");
+ console.log(res);
+ ```
+
+
+## util.getErrorString
+
+getErrorString(errno: number): string
获取系统错误码对应的详细信息。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- errno
- |
- number
- |
- 是
- |
- 系统发生错误产生的错误码。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- string
- |
- 错误码对应的详细信息。
- |
-
-
-
-
-- 示例：
-
- ```
- var errnum = 10; // 10：a system error number
- var result = util.getErrorString(errnum);
- console.log("result = " + result);
- ```
-
-
-## util.callbackWrapper
-
-callbackWrapper\(original: Function\): \(err: Object, value: Object\)=\>void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | errno | number | 是 | 系统发生错误产生的错误码。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | string | 错误码对应的详细信息。 |
+
+- 示例：
+ ```
+ var errnum = 10; // 10：a system error number
+ var result = util.getErrorString(errnum);
+ console.log("result = " + result);
+ ```
+
+
+## util.callbackWrapper
+
+callbackWrapper(original: Function): (err: Object, value: Object)=>void
对异步函数进行回调化处理，回调中第一个参数将是拒绝原因（如果 Promise 已解决，则为 null），第二个参数将是已解决的值。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- original
- |
- Function
- |
- 是
- |
- 异步函数。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Function
- |
- 返回一个第一个参数是拒绝原因（如果 Promise 已解决，则为 null），第二个参数是已解决的回调函数。
- |
-
-
-
-
-- 示例：
-
- ```
- async function promiseFn() {
- return Promise.reject('value');
- }
- var cb = util.callbackWrapper(promiseFn);
- cb((err, ret) => {
- expect(err).strictEqual('value');
- expect(ret).strictEqual(undefined);
- })
- ```
-
-
-## util.promiseWrapper
-
-promiseWrapper\(original: \(err: Object, value: Object\) =\> void\): Object
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | original | Function | 是 | 异步函数。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Function | 返回一个第一个参数是拒绝原因（如果 Promise 已解决，则为 null），第二个参数是已解决的回调函数。 |
+
+- 示例：
+ ```
+ async function promiseFn() {
+ return Promise.reject('value');
+ }
+ var cb = util.callbackWrapper(promiseFn);
+ cb((err, ret) => {
+ expect(err).strictEqual('value');
+ expect(ret).strictEqual(undefined);
+ })
+ ```
+
+
+## util.promiseWrapper
+
+promiseWrapper(original: (err: Object, value: Object) => void): Object
对异步函数处理并返回一个promise的版本。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- original
- |
- Function
- |
- 是
- |
- 异步函数。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Function
- |
- 采用遵循常见的错误优先的回调风格的函数（也就是将 (err, value) => ... 回调作为最后一个参数），并返回一个返回 promise 的版本。
- |
-
-
-
-
-- 示例：
-
- ```
- function aysnFun(str1, str2, callback) {
- if (typeof str1 === 'string' && typeof str1 === 'string') {
- callback(null, str1 + str2);
- } else {
- callback('type err');
- }
- }
- let newPromiseObj = util.promiseWrapper(aysnFun)("Hello", 'World');
- newPromiseObj.then(res => {
- expect(res).strictEqual('HelloWorld');
- })
- ```
-
-
-## TextDecoder
-
-### 属性
-
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-encoding
- |
-string
- |
-是
- |
-否
- |
-编码格式。
- |
-
-fatal
- |
-boolean
- |
-是
- |
-否
- |
-是否显示致命错误。
- |
-
-ignoreBOM
- |
-boolean
- |
-是
- |
-否
- |
-是否忽略BOM（byte order marker）标记，默认值是false。
- |
-
-
-
-
-### constructor
-
-constructor\(encoding?: string, options?: \{ fatal?: boolean; ignoreBOM?: boolean \},\)
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | original | Function | 是 | 异步函数。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Function | 采用遵循常见的错误优先的回调风格的函数（也就是将 (err, value) => ... 回调作为最后一个参数），并返回一个返回 promise 的版本。 |
+
+- 示例：
+ ```
+ function aysnFun(str1, str2, callback) {
+ if (typeof str1 === 'string' && typeof str1 === 'string') {
+ callback(null, str1 + str2);
+ } else {
+ callback('type err');
+ }
+ }
+ let newPromiseObj = util.promiseWrapper(aysnFun)("Hello", 'World');
+ newPromiseObj.then(res => {
+ expect(res).strictEqual('HelloWorld');
+ })
+ ```
+
+
+## TextDecoder
+
+
+### 属性
+
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| encoding | string | 是 | 否 | 编码格式。
- 支持格式：utf-8、ibm866、iso-8859-2、iso-8859-3、iso-8859-4、iso-8859-5、iso-8859-6、iso-8859-7、iso-8859-8、iso-8859-8-i、iso-8859-10、iso-8859-13、iso-8859-14、iso-8859-15、koi8-r、koi8-u、macintosh、windows-874、windows-1250、windows-1251、windows-1252、windows-1253、windows-1254、windows-1255、windows-1256、windows-1257、windows-1258、x-mac-cyrilli、gbk、gb18030、big5、euc-jp、iso-2022-jp、shift_jis、euc-kr、utf-16be、utf-16le。 |
+| fatal | boolean | 是 | 否 | 是否显示致命错误。 |
+| ignoreBOM | boolean | 是 | 否 | 是否忽略BOM（byte order marker）标记，默认值是false。 |
+
+
+### constructor
+
+constructor(encoding?: string, options?: { fatal?: boolean; ignoreBOM?: boolean },)
TextDecoder的构造函数。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- encoding
- |
- string
- |
- 否
- |
- 编码格式。
- |
-
- options
- |
- Object
- |
- 否
- |
- 编码相关选项参数，存在两个属性fatal和ignoreBOM。
- |
-
-
-
-
- **表 1** options
-
-
- 名称
- |
- 参数类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- fatal
- |
- boolean
- |
- 否
- |
- 是否显示致命错误。
- |
-
- ignoreBOM
- |
- boolean
- |
- 否
- |
- 是否忽略BOM标记。
- |
-
-
-
-
-- 示例：
-
- ```
- var textDecoder = new util.TextDecoder("utf-8",{ignoreBOM:true});
- ```
-
-
-### decode
-
-decode\(input: Uint8Array, options?:\{stream?:false\}\): string
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | encoding | string | 否 | 编码格式。 |
+ | options | Object | 否 | 编码相关选项参数，存在两个属性fatal和ignoreBOM。 |
+
+ **表1** options
+
+ | 名称 | 参数类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | fatal | boolean | 否 | 是否显示致命错误。 |
+ | ignoreBOM | boolean | 否 | 是否忽略BOM标记。 |
+
+- 示例：
+ ```
+ var textDecoder = new util.TextDecoder("utf-8",{ignoreBOM:true});
+ ```
+
+
+### decode
+
+decode(input: Uint8Array, options?:{stream?:false}): string
通过输入参数解码后输出对应文本。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- input
- |
- Uint8Array
- |
- 是
- |
- 符合格式需要解码的数组。
- |
-
- options
- |
- Object
- |
- 否
- |
- 解码相关选项参数。
- |
-
-
-
-
- **表 2** options
-
-
- 名称
- |
- 参数类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- stream
- |
- boolean
- |
- 否
- |
- 在随后的decode()调用中是否跟随附加数据块，如果以块的形式处理数据，则设置为true；如果处理最后的数据块或数据未分块，则设置为false。默认为false。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- string
- |
- 解码后的数据。
- |
-
-
-
-
-- 示例：
-
- ```
- var textDecoder = new util.TextDecoder("utf-8",{ignoreBOM:true});
- var result = new Uint8Array(6);
- result[0] = 0xEF;
- result[1] = 0xBB;
- result[2] = 0xBF;
- result[3] = 0x61;
- result[4] = 0x62;
- result[5] = 0x63;
- console.log("input num:");
- for(var j= 0; j < 6; j++) {
- console.log(result[j]);
- }
- var retStr = textDecoder.decode( result , {stream:false});
- console.log("retStr = " + retStr);
- ```
-
-
-## TextEncoder
-
-### 属性
-
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-encoding
- |
-string
- |
-是
- |
-否
- |
-编码格式，默认值是utf-8。
- |
-
-
-
-
-### constructor
-
-constructor\(\)
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | input | Uint8Array | 是 | 符合格式需要解码的数组。 |
+ | options | Object | 否 | 解码相关选项参数。 |
-TextEncoder的构造函数。
+ **表2** options
+
+ | 名称 | 参数类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | stream | boolean | 否 | 在随后的decode()调用中是否跟随附加数据块，如果以块的形式处理数据，则设置为true；如果处理最后的数据块或数据未分块，则设置为false。默认为false。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | string | 解码后的数据。 |
+
+- 示例：
+ ```
+ var textDecoder = new util.TextDecoder("utf-8",{ignoreBOM:true});
+ var result = new Uint8Array(6);
+ result[0] = 0xEF;
+ result[1] = 0xBB;
+ result[2] = 0xBF;
+ result[3] = 0x61;
+ result[4] = 0x62;
+ result[5] = 0x63;
+ console.log("input num:");
+ for(var j= 0; j < 6; j++) {
+ console.log(result[j]);
+ }
+ var retStr = textDecoder.decode( result , {stream:false});
+ console.log("retStr = " + retStr);
+ ```
+
+
+## TextEncoder
-- 示例：
- ```
- var textEncoder = new util.TextEncoder();
- ```
+### 属性
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| encoding | string | 是 | 否 | 编码格式，默认值是utf-8。 |
-### encode
-encode\(input?: string\): Uint8Array
+### constructor
+
+constructor()
+
+TextEncoder的构造函数。
+
+- 示例：
+ ```
+ var textEncoder = new util.TextEncoder();
+ ```
+
+
+### encode
+
+encode(input?: string): Uint8Array
通过输入参数编码后输出对应文本。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- input
- |
- string
- |
- 是
- |
- 需要编码的字符串。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Uint8Array
- |
- 返回编码后的文本。
- |
-
-
-
-
-- 示例：
-
- ```
- var textEncoder = new util.TextEncoder();
- var result = new Uint8Array(buffer);
- result = textEncoder.encode("\uD800¥¥");
- ```
-
-
-### encodeInto
-
-encodeInto\(input: string, dest: Uint8Array,\):\{ read: number; written: number \}
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | input | string | 是 | 需要编码的字符串。 |
-放置生成的UTF-8编码文本。
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Uint8Array | 返回编码后的文本。 |
+
+- 示例：
+ ```
+ var textEncoder = new util.TextEncoder();
+ var result = new Uint8Array(buffer);
+ result = textEncoder.encode("\uD800¥¥");
+ ```
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- input
- |
- string
- |
- 是
- |
- 需要编码的字符串。
- |
-
- dest
- |
- Uint8Array
- |
- 是
- |
- Uint8Array对象实例，用于将生成的UTF-8编码文本放入其中。
- |
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- Uint8Array
- |
- 返回编码后的文本。
- |
-
-
-
-
-- 示例：
-
- ```
- var that = new util.TextEncoder();
- var buffer = new ArrayBuffer(4);
- this.dest = new Uint8Array(buffer);
- var result = that.encodeInto("abcd", this.dest);
- ```
+### encodeInto
+
+encodeInto(input: string, dest: Uint8Array,):{ read: number; written: number }
+
+放置生成的UTF-8编码文本。
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | input | string | 是 | 需要编码的字符串。 |
+ | dest | Uint8Array | 是 | Uint8Array对象实例，用于将生成的UTF-8编码文本放入其中。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Uint8Array | 返回编码后的文本。 |
+
+- 示例：
+ ```
+ var that = new util.TextEncoder();
+ var buffer = new ArrayBuffer(4);
+ this.dest = new Uint8Array(buffer);
+ var result = that.encodeInto("abcd", this.dest);
+ ```
diff --git a/zh-cn/application-dev/reference/apis/js-apis-vibrator.md b/zh-cn/application-dev/reference/apis/js-apis-vibrator.md
index c1999657a92dc066f4a726329d3d76271d2862c3..9cfa6ff54f467089e50f0d2e26cab8a01e9e27b4 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-vibrator.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-vibrator.md
@@ -1,398 +1,194 @@
-# 振动
+# 振动
-> **说明：**
->从API Version 8 开始支持。
+>  **说明：**
+> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
-## 导入模块
+
+## 导入模块
```
import vibrate from '@ohos.vibrator';
```
-## 权限列表
+
+## 权限列表
ohos.permission.VIBRATE
-## vibrate.vibrate
-vibrate\(duration: number\): Promise
+## vibrate.vibrate
+
+vibrate(duration: number): Promise<void>
+
按照指定持续时间触发马达振动。
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-duration
- |
-number
- |
-是
- |
-指示马达振动的持续时间。
- |
-
-
-
-
-**返回值：**
-
-
-类型
- |
-说明
- |
-
|---|
-
-Promise<void>
- |
-指示触发振动是否成功。
- |
-
-
-
-
-**示例：**
-```
-vibrate.vibrate(100).then(()=>
- console.log('Promise returned to indicate a successful vibration.')
-).catch((error) => {
- console.error('Failed to trigger vibration.');
-});
-```
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | duration | number | 是 | 指示马达振动的持续时间。 |
+
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<void> | 指示触发振动是否成功。 |
+
-## vibrate.vibrate
+- 示例：
+ ```
+ vibrator.vibrate(1000).then(error)=>{
+ if(error){
+ console.log(“error.code”+error.code+“error.message”+error.message);
+ }else{
+ console.log(“Promise returned to indicate a successful vibration.”);
+ }
+ }
+ ```
-vibrate\(duration: number, callback?: AsyncCallback\): void
+
+## vibrate.vibrate
+
+vibrate(duration: number, callback?: AsyncCallback<void>): void
按照指定持续时间触发马达振动。
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-duration
- |
-number
- |
-是
- |
-指示马达振动的持续时间。
- |
-
-callback
- |
-AsyncCallback<void>
- |
-否
- |
-马达执行振动的回调函数，指示触发振动是否成功。
- |
-
-
-
-
-**示例：**
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | duration | number | 是 | 指示马达振动的持续时间。 |
+ | callback | AsyncCallback<void> | 否 | 马达执行振动的回调函数，指示触发振动是否成功。 |
-```
-vibrate.vibrate(100, function(error) {
- if (error) {
- console.error("Failed to trigger vibration. Error code: " + error.code + ", message: " + error.message);
- return;
- }
- console.info("Succeeded in triggering vibration.");
-});
-```
+- 示例**：**
+ ```
+ vibrator.vibrate(1000,function(error){
+ if(error){
+ console.log(“error.code”+error.code+“error.message”+error.message);
+ }else{
+ console.log(“Callback returned to indicate a successful vibration.”);
+ }
+ })
+ ```
-## vibrate.vibrate
-vibrate\(effectId: EffectId\): Promise
+## vibrate.vibrate
+
+vibrate(effectId: EffectId): Promise<void>
按照指定振动效果触发马达振动。
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-effectId
- |
-EffectId
- |
-是
- |
-指示马达振动效果的字符串。
- |
-
-
-
-
-**返回值：**
-
-
-类型
- |
-说明
- |
-
|---|
-
-Promise<void>
- |
-指示触发振动是否成功。
- |
-
-
-
-
-**示例：**
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | effectId | [EffectId](#effectid) | 是 | 指示马达振动效果的字符串。 |
-```
-vibrate.vibrate(vibrate.EffectId.EFFECT_CLOCK_TIMER).then(()=>
- console.log('Promise returned to indicate a successful vibration.')
-).catch((error) => {
- console.error('Failed to trigger vibration.');
-});
-```
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<void> | 指示触发振动是否成功。 |
-## vibrate.vibrate
+- 示例：
+ ```
+ vibrator.vibrate(effectId:EffectId).then(error)=>{
+ if(error){
+ console.log(“error.code”+error.code+“error.message”+error.message);
+ }else{
+ Console.log(“Promise returned to indicate a successful vibration.”);
+ }
+ }
+ ```
-vibrate\(effectId: EffectId, callback?: AsyncCallback\): void
+
+## vibrate.vibrate
+
+vibrate(effectId: EffectId, callback?: AsyncCallback<void>): void
按照指定振动效果触发马达振动。
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-effectId
- |
-EffectId
- |
-是
- |
-指示马达振动效果的字符串。
- |
-
-callback
- |
-AsyncCallback<void>
- |
-否
- |
-马达执行振动的回调函数，指示触发振动是否成功。
- |
-
-
-
-
-**示例：**
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | effectId | [EffectId](#effectid) | 是 | 指示马达振动效果的字符串。 |
+ | callback | AsyncCallback<void> | 否 | 马达执行振动的回调函数，指示触发振动是否成功。 |
-```
-vibrate.vibrate(vibrate.EffectId.EFFECT_CLOCK_TIMER, function(error) {
- if (error) {
- console.error("Failed to trigger vibration. Error code: " + error.code + ", message: " + error.message);
- return;
- }
- console.info("Succeeded in triggering vibration.");
-});
-```
+- 示例：
+ ```
+ vibrator.vibrate(effectId:EffectId,function(error){
+ if(error){
+ console.log(“error.code”+error.code+“error.message”+error.message);
+ }else{
+ console.log(“Callback returned to indicate a successful vibration.”);
+ }
+ })
+ ```
-## vibrate.stop
-stop\(stopMode: VibratorStopMode\): Promise
+## vibrate.stop
+
+stop(stopMode: VibratorStopMode): Promise<void>
按照要停止指定的振动模式来停止马达的振动。如果要停止的振动模式与触发马达振动时的模式不相同，则调用本接口会失败。
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-stopMode
- |
-VibratorStopMode
- |
-是
- |
-指示马达要停止指定的振动模式。
- |
-
-
-
-
-**返回值：**
-
-
-类型
- |
-说明
- |
-
|---|
-
-Promise<void>
- |
-指示停止振动是否成功。
- |
-
-
-
-
-**示例：**
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | stopMode | [VibratorStopMode](#vibratorstopmode) | 是 | 指示马达要停止指定的振动模式。 |
-```
-vibrate.stop(vibrate.VibratorStopMode.VIBRATOR_STOP_MODE_TIME).then(()=>
- console.log('Promise returned to indicate a successful vibration stop.')
-).catch((error) => {
- console.error('Failed to stop vibration.');
-});
-```
+- 返回值：
+ | 类型 | 说明 |
+ | -------- | -------- |
+ | Promise<void> | 指示停止振动是否成功。 |
+
+- 示例：
+ ```
+ vibrator.stop(stopMode:VibratorStopMode).then((error)=>{
+ if(error){
+ console.log(“error.code”+error.code+“error.message”+error.message);
+ }else{
+ Console.log(“Promise returned to indicate successful.”);
+ }
+ })
+ ```
-## vibrate.stop
-stop\(stopMode: VibratorStopMode, callback?: AsyncCallback\): void;
+## vibrate.stop
+
+stop(stopMode: VibratorStopMode, callback?: AsyncCallback<void>): void;
按照要停止指定的振动模式来停止马达的振动。如果要停止的振动模式与触发马达振动时的模式不相同，则调用本接口会失败。
-**参数：**
-
-
-参数名
- |
-类型
- |
-必填
- |
-说明
- |
-
|---|
-
-stopMode
- |
-VibratorStopMode
- |
-是
- |
-指示马达要停止指定的振动模式。
- |
-
-callback
- |
-AsyncCallback<void>
- |
-否
- |
-马达停止振动的回调函数，指示停止振动是否成功。
- |
-
-
-
-
-**示例：**
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | stopMode | [VibratorStopMode](#vibratorstopmode) | 是 | 指示马达要停止指定的振动模式。 |
+ | callback | AsyncCallback<void> | 否 | 马达停止振动的回调函数，指示停止振动是否成功。 |
+
+- 示例：
+ ```
+ vibrator.stop(stopMode:VibratorStopMode,function(error){
+ if(error){
+ console.log(“error.code”+error.code+“error.message”+error.message);
+ }else{
+ Console.log(“Callback returned to indicate successful.”);
+ }
+ })
+ ```
-```
-vibrate.stop(vibrate.VibratorStopMode.VIBRATOR_STOP_MODE_TIME, function(error) {
- if (error) {
- console.error("Failed to stop vibration. Error code: " + error.code + ", message: " + error.message);
- return;
- }
- console.info("Vibration stopped.");
-});
-```
-## EffectId
+## EffectId
表示马达振动效果的字符串。
-
-名称
- |
-默认值
- |
-说明
- |
-
|---|
-
-EFFECT_CLOCK_TIMER
- |
-"haptic.clock.timer"
- |
-调整定时器时振动器的振动效果。
- |
-
-
-
-
-## VibratorStopMode
+| 名称 | 默认值 | 说明 |
+| -------- | -------- | -------- |
+| EFFECT_CLOCK_TIMER | "haptic.clock.timer" | 调整定时器时振动器的振动效果。 |
-表示马达要停止指定的振动模式。
-
-名称
- |
-默认值
- |
-说明
- |
-
|---|
-
-VIBRATOR_STOP_MODE_TIME
- |
-"time"
- |
-停止模式为duration模式的振动。即触发振动时参数类型为number，参数本身为指示振动持续时间的触发方式。
- |
-
-VIBRATOR_STOP_MODE_PRESET
- |
-"preset"
- |
-停止模式为预置EffectId的振动。即触发振动时参数类型为EffectId，参数本身为指示马达振动效果的字符串的触发方式。
- |
-
-
-
+## VibratorStopMode
+
+表示马达要停止指定的振动模式。
+| 名称 | 默认值 | 说明 |
+| -------- | -------- | -------- |
+| VIBRATOR_STOP_MODE_TIME | "time" | 停止模式为duration模式的振动。即触发振动时参数类型为number，参数本身为指示振动持续时间的触发方式。 |
+| VIBRATOR_STOP_MODE_PRESET | "preset" | 停止模式为预置EffectId的振动。即触发振动时参数类型为EffectId，参数本身为指示马达振动效果的字符串的触发方式。 |
diff --git a/zh-cn/application-dev/reference/apis/js-apis-wifi.md b/zh-cn/application-dev/reference/apis/js-apis-wifi.md
index ac1bcc7fc717dfc909c81eda643d3ab5b27c7b34..512732d38636d4dd1b8f1ee89dab0d43e4df1d39 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-wifi.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-wifi.md
@@ -1,295 +1,124 @@
-# WLAN
+# WLAN
->**说明：**
->从 API Version 6 开始支持。
+>  **说明：**
+> 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
-
-## 导入模块
+## 导入模块
```
import wifi from '@ohos.wifi_native_js';
```
+## wifi.isWifiActive
-## wifi.isWifiActive
-
-isWifiActive\(\): boolean
+isWifiActive(): boolean
查询WLAN是否已激活。
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- boolean
- |
- true:已激活， false:未激活。
- |
-
-
-
+**返回值：**
+| **类型** | **说明** |
+| -------- | ---------------------------- |
+| boolean | true:已激活， false:未激活。 |
-## wifi.getSignalLevel
+## wifi.getSignalLevel
-getSignalLevel\(rssi: number, band: number\): number
+getSignalLevel(rssi: number, band: number): number
查询WLAN信号强度。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- rssi
- |
- number
- |
- 是
- |
- 热点的信号强度(dBm)。
- |
-
- band
- |
- number
- |
- 是
- |
- WLAN接入点的频段。
- |
-
-
-
-
-
-- 返回值：
-
-
- 类型
- |
- 说明
- |
-
|---|
-
- number
- |
- 信号强度，取值范围为[0, 4]。
- |
-
-
-
-
-
-## wifi.scan
-
-scan\(\): boolean
+**参数：**
-启动WLAN扫描。
+| **参数名** | **类型** | **必填** | **说明** |
+| ---------- | -------- | -------- | --------------------- |
+| rssi | number | 是 | 热点的信号强度(dBm)。 |
+| band | number | 是 | WLAN接入点的频段。 |
-- 返回值：
+**返回值：**
-
- 类型
- |
- 说明
- |
-
|---|
-
- boolean
- |
- true:扫描操作成功， false:扫描操作执行失败。
- |
-
-
-
+| **类型** | **说明** |
+| -------- | ---------------------------- |
+| number | 信号强度，取值范围为[0, 4]。 |
+## wifi.scan
-## wifi.getScanInfos
+scan(): boolean
-getScanInfos\(\): Promise\>
+启动WLAN扫描。
-获取扫描结果，使用promise方式作为异步方法。
+**返回值：**
+
+| **类型** | **说明** |
+| -------- | -------------------------------------------- |
+| boolean | true:扫描操作成功， false:扫描操作执行失败。 |
+
+## wifi.getScanInfos
+
+getScanInfos(): Promise>
-- 返回值：
+获取扫描结果，使用promise方式作为异步方法。
-
- 类型
- |
- 说明
- |
-
|---|
-
- Promise< Array<WifiScanInfo> >
- |
- 返回扫描到的热点列表。
- |
-
-
-
+**返回值：**
+| **类型** | **说明** |
+| ------------------------------------------------ | ---------------------- |
+| Promise< Array\<[WifiScanInfo](#wifiscaninfo)> > | 返回扫描到的热点列表。 |
-## wifi.getScanInfos
+## wifi.getScanInfos
-getScanInfos\(callback: AsyncCallback\>\): void
+getScanInfos(callback: AsyncCallback>): void
获取扫描结果，使用callback方式作为异步方法。
-- 参数
-
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- callback
- |
- AsyncCallback< Array<WifiScanInfo>>
- |
- 是
- |
- 扫描到的热点列表结果回调函数。
- |
-
-
-
-
-
-- 示例
-
- ```
- import wifi from '@ohos.wifi_native_js';
-
-
- wifi.getScanInfos(result => {
- var len = Object.keys(result).length;
- console.log("received scan info size: " + len);
- for (var i = 0; i < len; ++j) {
- console.info("ssid: " + result[i].ssid);
- console.info("bssid: " + result[i].bssid);
- console.info("securityType: " + result[i].securityType);
- console.info("rssi: " + result[i].rssi);
- console.info("band: " + result[i].band);
- console.info("frequency: " + result[i].frequency);
- console.info("timestamp: " + result[i].timestamp);
- }
- });
-
- wifi.getScanInfos().then(result => {
- var len = Object.keys(result).length;
- console.log("received scan info size: " + len);
- for (var i = 0; i < len; ++i) {
- console.info("ssid: " + result[i].ssid);
- console.info("bssid: " + result[i].bssid);
- console.info("securityType: " + result[i].securityType);
- console.info("rssi: " + result[i].rssi);
- console.info("band: " + result[i].band);
- console.info("frequency: " + result[i].frequency);
- console.info("timestamp: " + result[i].timestamp);
- }
- });
- ```
-
-
-## WifiScanInfo
+| **参数名** | **类型** | **必填** | **说明** |
+| ---------- | ----------------------------------------------------- | -------- | ------------------------------ |
+| callback | AsyncCallback< Array\<[WifiScanInfo](#wifiscaninfo)>> | 是 | 扫描到的热点列表结果回调函数。 |
-WLAN热点信息。
+**示例：**
+
+```
+import wifi from '@ohos.wifi_native_js';
-
-参数名
- |
-类型
- |
-读写属性
- |
-说明
- |
-
|---|
-
-ssid
- |
-string
- |
-只读
- |
-热点的SSID，编码格式为UTF-8。
- |
-
-bssid
- |
-string
- |
-只读
- |
-热点的BSSID。
- |
-
-securityType
- |
-WifiSecurityType
- |
-只读
- |
-WLAN加密类型。
- |
-
-rssi
- |
-number
- |
-只读
- |
-热点的信号强度(dBm)。
- |
-
-band
- |
-number
- |
-只读
- |
-WLAN接入点的频段。
- |
-
-frequency
- |
-number
- |
-只读
- |
-WLAN接入点的频率。
- |
-
-timestamp
- |
-number
- |
-只读
- |
-时间戳。
- |
-
-
-
+wifi.getScanInfos(result => {
+ var len = Object.keys(result).length;
+ console.log("received scan info size: " + len);
+ for (var i = 0; i < len; ++j) {
+ console.info("ssid: " + result[i].ssid);
+ console.info("bssid: " + result[i].bssid);
+ console.info("securityType: " + result[i].securityType);
+ console.info("rssi: " + result[i].rssi);
+ console.info("band: " + result[i].band);
+ console.info("frequency: " + result[i].frequency);
+ console.info("timestamp: " + result[i].timestamp);
+ }
+});
+
+wifi.getScanInfos().then(result => {
+ var len = Object.keys(result).length;
+ console.log("received scan info size: " + len);
+ for (var i = 0; i < len; ++i) {
+ console.info("ssid: " + result[i].ssid);
+ console.info("bssid: " + result[i].bssid);
+ console.info("securityType: " + result[i].securityType);
+ console.info("rssi: " + result[i].rssi);
+ console.info("band: " + result[i].band);
+ console.info("frequency: " + result[i].frequency);
+ console.info("timestamp: " + result[i].timestamp);
+ }
+});
+```
+
+## WifiScanInfo
+
+WLAN热点信息。
+| **参数名** | **类型** | **读写属性** | **说明** |
+| ------------ | ---------------- | ------------ | ----------------------------- |
+| ssid | string | 只读 | 热点的SSID，编码格式为UTF-8。 |
+| bssid | string | 只读 | 热点的BSSID。 |
+| securityType | WifiSecurityType | 只读 | WLAN加密类型。 |
+| rssi | number | 只读 | 热点的信号强度(dBm)。 |
+| band | number | 只读 | WLAN接入点的频段。 |
+| frequency | number | 只读 | WLAN接入点的频率。 |
+| timestamp | number | 只读 | 时间戳。 |
\ No newline at end of file
diff --git a/zh-cn/application-dev/reference/apis/js-apis-window.md b/zh-cn/application-dev/reference/apis/js-apis-window.md
new file mode 100644
index 0000000000000000000000000000000000000000..ecbeffbc3ff3720f0f0a4142bbffe03b887ef70a
--- /dev/null
+++ b/zh-cn/application-dev/reference/apis/js-apis-window.md
@@ -0,0 +1,933 @@
+# 窗口
+
+>  **说明：**
+> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
+
+
+## 导入模块
+
+```
+import window from '@ohos.window';
+```
+
+
+## 权限列表
+
+ohos.permission.SYSTEM_FLOAT_WINDOW
+
+
+## SystemBarProperties
+
+状态栏导航栏的属性。
+
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| statusBarColor | string | 是 | 是 | 状态栏颜色，为16进制颜色，例如"\#00FF00"或"\#FF00FF00"。 |
+| isStatusBarLightIcon7+ | boolean | 是 | 是 | 状态栏图标是否为高亮状态。 |
+| navigationBarColor | string | 是 | 是 | 导航栏颜色，为16进制颜色，例如"\#00FF00"或"\#FF00FF00"。 |
+| isNavigationBarLightIcon7+ | boolean | 是 | 是 | 导航栏图标是否为高亮状态。 |
+
+
+## Rect7+
+
+矩形。
+
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| left | number | 是 | 是 | 矩形区域的左边界。 |
+| top | number | 是 | 是 | 矩形区域的上边界。 |
+| width | number | 是 | 是 | 矩形区域的宽度。 |
+| height | number | 是 | 是 | 矩形区域的高度。 |
+
+
+## AvoidArea7+
+
+表示窗口内容规避区域。
+
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| leftRect | [Rect](#rect) | 是 | 是 | 屏幕左侧的矩形区。 |
+| topRect | [Rect](#rect) | 是 | 是 | 屏幕顶部的矩形区。 |
+| rightRect | [Rect](#rect) | 是 | 是 | 屏幕右侧的矩形区。 |
+| bottomRect | [Rect](#rect) | 是 | 是 | 屏幕底部的矩形区。 |
+
+
+## Size7+
+
+窗口大小。
+
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| width | number | 是 | 是 | 窗口宽度。 |
+| height | number | 是 | 是 | 窗口高度。 |
+
+
+## WindowProperties
+
+窗口属性。
+
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| windowRect7+ | [Rect](#rect) | 是 | 否 | 窗口尺寸。 |
+| type7+ | [WindowType](#windowtype) | 是 | 否 | 窗口类型。 |
+| brightness | number | 是 | 是 | 屏幕亮度，取值范围为0~1，1表示最大亮度值。 |
+| isTransparent7+ | boolean | 是 | 是 | 窗口是否透明，默认为false。 |
+| isFullScreen | boolean | 是 | 是 | 是否全屏，默认为false。 |
+| isKeepScreenOn | boolean | 是 | 是 | 屏幕是否常亮，默认为false。 |
+| dimBehindValue7+ | number | 是 | 是 | 靠后的窗口的暗度值，取值范围为0~1，1表示最暗。 |
+| isLayoutFullScreen7+ | boolean | 是 | 是 | 窗口是否为沉浸式，默认为false。 |
+| focusable7+ | boolean | 是 | 是 | 窗口是否可聚焦，默认为true。 |
+| touchable7+ | boolean | 是 | 是 | 窗口是否可触摸，默认为true。 |
+| isPrivacyMode7+ | boolean | 是 | 是 | 隐私模式，默认为false。 |
+| isRoundCorner7+ | boolean | 是 | 是 | 窗口是否为圆角。 |
+
+
+## SplitScreenBoundsInfo7+
+
+分屏边界相关信息。
+
+| 名称 | 类型 | 说明 |
+| -------- | -------- | -------- |
+| [splitMode](#splitmode) | number | 表示分屏模式。 |
+| primaryBounds | [Rect](#rect) | 表示主要边界信息，返回Rect类实例。 |
+| secondaryBounds | [Rect](#rect) | 表示次要边界信息，返回Rect类实例。 |
+
+
+## window.getTopWindow
+
+getTopWindow(callback: AsyncCallback<Window>): void
+
+获取当前窗口，用于获取到window实例。
+
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | callback | AsyncCallback<[Window](#window)> | 是 | 回调返回当前窗口对象。 |
+
+- 示例
+ ```
+ window.getTopWindow((err, data) => {
+ if (err) {
+ console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in obtaining the top window. Data: ' + JSON.stringify(data));
+ windowClass = data;
+ });
+ ```
+
+
+## window.create7+
+
+create(id: string, type: WindowType, callback: AsyncCallback<Window>): void
+
+创建子窗口。
+
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | id | string | 是 | 窗口id。 |
+ | type | [WindowType](#windowtype7-) | 是 | 窗口类型。 |
+ | callback | AsyncCallback<[Window](#window)> | 是 | 回调返回当前窗口对象。 |
+
+- 示例
+
+
+```
+ window.create("first", 1, (err, data) => {
+ windowClass = data;
+ if (err) {
+ console.error('Failed to create the subWindow. Cause: ' + JSON.stringify(err));
+ return;
+ }
+ console.info('SubWindow created. Data: ' + JSON.stringify(data))
+ windowClass.resetSize(500, 1000);
+ windowClass.setOutsideTouchable(true);
+ windowClass.loadContent("pages/index/index", (err, data) => {
+ });
+})
+```
+
+
+## window.find7+
+
+find(id: string, callback: AsyncCallback<Window>): void
+
+查找子窗口。
+
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | id | string | 是 | 窗口id。 |
+ | callback | AsyncCallback<[Window](#window)> | 是 | 回调返回当前窗口对象。 |
+
+- 示例
+ ```
+ window.find("first", (err, data) => {
+ if (err) {
+ console.error('Failed to find the subWindow. Cause: ' + JSON.stringify(err));
+ return;
+ }
+ console.info('SubWindow found. Data: ' + JSON.stringify(data))
+ windowClass = data;
+ })
+ ```
+
+
+## window.getAbilityWindowMode7+
+
+getAbilityWindowMode(callback: AsyncCallback<WindowMode>): void
+
+获取当前窗口模式。
+
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | callback | AsyncCallback<[WindowMode](#windowmode)> | 是 | 回调返回当前窗口模式。 |
+
+- 示例
+ ```
+ window.getAbilityWindowMode((err, data) => {
+ if (err) {
+ console.error(''Failed to obtain the window mode. Cause:' + JSON.stringify(err));
+ return;
+ }
+ console.info('Window mode obtained. Data:' + JSON.stringify(data))
+
+ });
+ ```
+
+
+## window.getSplitScreenBounds7+
+
+getSplitScreenBounds(splitRatio: SplitRatio, callback: AsyncCallback<SplitScreenBoundsInfo>): void
+
+获取分屏多窗口的位置和区域.。
+
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | splitRatio | SplitRatio | 是 | 表示分屏比例，默认值为1:1，传值1表示1:2，传值2为2:1。 |
+ | callback | AsyncCallback<[SplitScreenBoundsInfo](#splitscreenboundsinfo)> | 是 | 回调返回一个SplitScreenBoundsInfo对象，表示分屏边界相关信息。 |
+
+- 示例
+ ```
+ var splitRatio = '1:1';
+ window.getSplitScreenBounds(splitRatio, (err, data) => {
+ if (err) {
+ console.error('Failed to obtain the split-screen boundary information. Cause: ' + JSON.stringify(err));
+ return;
+ }
+ console.info('Split-screen boundary information obtained. Data: ' + JSON.stringify(data))
+
+ });
+ ```
+
+
+## window.isFloatingAbilityWindowVisible7+
+
+isFloatingAbilityWindowVisible(callback:AsyncCallback<boolean>): void
+
+悬浮窗是否显示可见。
+
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | callback | AsyncCallback<boolean> | 是 | 回调返回一个boolean对象，表示悬浮窗是否可见。 |
+
+- 示例
+ ```
+ window.isFloatingAbilityWindowVisible( (err, data) => {
+ if (err) {
+ console.error('Failed to check whether the floating window is visible. Cause:' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in checking whether the floating window is visible. Data:' + JSON.stringify(data))
+
+ });
+ ```
+
+
+## window.setSplitBarVisibility7+
+
+setSplitBarVisibility(isVisibility: boolean, callback: AsyncCallback<void>): void
+
+设置分屏线是否可见。
+
+- 参数
+ | 参数名 | 类型 | 说明 |
+ | -------- | -------- | -------- |
+ | isVisibility | boolean | 表示分屏线是否是否显示，true为显示，false为显示。 |
+ | callback | AsyncCallback<void> | callback形式返回结果。 |
+
+- 示例
+ ```
+ var isVisibility = false;
+ window.setSplitBarVisibility(isVisibility , (err, data) => {
+ if (err) {
+ console.error('Failed to set the divider to be invisible. Cause:' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in setting the divider to be invisible. Data:' + JSON.stringify(data))
+ });
+ ```
+
+
+## WindowType7+
+
+窗口类型。
+
+| 名称 | 默认值 | 说明 |
+| -------- | -------- | -------- |
+| TYPE_APP | 0 | 表示应用窗口。 |
+| TYPE_SYSTEM_ALERT | 1 | 表示系统弹窗。 |
+
+
+## AvoidAreaType7+
+
+窗口内容需要规避区域的类型。
+
+| 名称 | 默认值 | 说明 |
+| -------- | -------- | -------- |
+| TYPE_SYSTEM | 0 | 表示系统默认。 |
+| TYPE_CUTOUT | 1 | 表示刘海屏区域。 |
+
+
+## WindowMode7+
+
+窗口模式。
+
+| 名称 | 默认值 | 说明 |
+| -------- | -------- | -------- |
+| UNDEFINED | 1 | 表示APP未定义窗口模式。 |
+| FULLSCREEN | 2 | 表示APP全屏模式。 |
+| PRIMARY | 3 | 表示APP分屏多窗口主要模式。 |
+| SECONDARY | 4 | 表示APP分屏多窗口次要模式。 |
+| FLOATING | 5 | 表示APP自由悬浮形式窗口模式。 |
+
+
+## splitMode7+
+
+分屏模式。
+
+| 名称 | 默认值 | 说明 |
+| -------- | -------- | -------- |
+| VERTICAL | 0 | 表示垂直上下分屏模式 |
+| HORIZONTAL | 1 | 表示水平左右分屏模式 |
+
+
+## Window
+
+下列API示例中都需使用[getTopWindow()](#window-gettopwindow)先获取到Window实例，再通过此实例调用对应方法。
+
+
+### setBrightness
+
+setBrightness(brightness:number, callback: AsyncCallback<void>): void
+
+设置屏幕亮度值。
+
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | brightness | number | 是 | 屏幕亮度值，值为0-1之间。1表示最亮。 |
+ | callback | AsyncCallback<void> | 是 | 回调函数。 |
+
+- 示例
+ ```
+ var brightness = 10;
+ windowClass.setBrightness(brightness, (err, data) => {
+ if (err) {
+ console.error('Failed to set the brightness. Cause: ' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in setting the brightness. Data: ' + JSON.stringify(data));
+ });
+ ```
+
+
+### setBackgroundColor
+
+setBackgroundColor(color: string, callback: AsyncCallback<void>): void
+
+设置窗口的背景色。
+
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | color | string | 是 | 需要设置的背景色，为16进制颜色，例如"\#00FF00"或"\#FF00FF00"。 |
+ | callback | AsyncCallback<void> | 是 | 回调函数。 |
+
+- 示例
+ ```
+ var color = '#00ff33';
+ windowClass.setBackgroundColor(color, (err, data) => {
+ if (err) {
+ console.error('Failed to set the background color. Cause: ' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in setting the background color. Data: ' + JSON.stringify(data));
+ });
+ ```
+
+### setTransparent7+
+
+setTransparent(isTransparent: boolean, callback: AsyncCallback<void>): void
+
+设置窗口是否透明。
+
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | isTransparent | boolean | 是 | 窗口是否透明。 |
+ | callback | AsyncCallback<void> | 是 | 回调函数。 |
+
+- 示例
+ ```
+ var isTransparent = true;
+ windowClass.setTransparent(isTransparent, (err, data) => {
+ if (err) {
+ console.error('Failed to set the window to be transparent. Cause: ' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in setting the window to be transparent. Data: ' + JSON.stringify(data))
+ });
+ ```
+
+### setFullScreen
+
+setFullScreen(isFullScreen: boolean, callback: AsyncCallback<void>): void
+
+设置是否为全屏状态。
+
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | isFullScreen | boolean | 是 | 是否设为全屏状态。 |
+ | callback | AsyncCallback<void> | 是 | 回调函数。 |
+
+- 示例
+ ```
+ var isFullScreen = true;
+ windowClass.setFullScreen(isFullScreen, (err, data) => {
+ if (err) {
+ console.error('Failed to enable the full-screen mode. Cause: ' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in enabling the full-screen mode. Data: ' + JSON.stringify(data));
+ });
+ ```
+
+### setKeepScreenOn
+
+setKeepScreenOn(isKeepScreenOn: boolean, callback: AsyncCallback<void>): void
+
+设置屏幕是否为常亮状态。
+
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | isKeepScreenOn | boolean | 是 | 是否设置为屏幕常亮状态。 |
+ | callback | AsyncCallback<void> | 是 | 回调函数。 |
+
+- 示例
+ ```
+ var isKeepScreenOn = true;
+ windowClass.setKeepScreenOn(isKeepScreenOn, (err, data) => {
+ if (err) {
+ console.error('Failed to set the screen to be always on. Cause: ' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in setting the screen to be always on. Data: ' + JSON.stringify(data));
+ });
+ ```
+
+### setDimBehind7+
+
+setDimBehind(dimBehindValue: number, callback: AsyncCallback<void>): void
+
+窗口叠加时，设备有子窗口的情况下设置靠后的窗口的暗度值。
+
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | dimBehindValue | number | 是 | 表示靠后的窗口的暗度值，取值范围为0-1，1表示最暗。 |
+ | callback | AsyncCallback<void> | 是 | 回调函数。 |
+
+- 示例
+ ```
+ windowClass.setDimBehind(0.5, (err, data) => {
+ if (err) {
+ console.error('Failed to set the dimness. Cause: ' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in setting the dimness. Data:' + JSON.stringify(data));
+ });
+ ```
+
+### setLayoutFullScreen7+
+
+setLayoutFullScreen(isLayoutFullScreen: boolean, callback: AsyncCallback<void>): void
+
+设置窗口的布局是否为全屏显示状态。
+
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | isLayoutFullScreen | boolean | 是 | 窗口的布局是否为全屏显示状态。 |
+ | callback | AsyncCallback<void> | 是 | 回调函数。 |
+
+- 示例
+ ```
+ var isLayoutFullScreen= true;
+ windowClass.setLayoutFullScreen(isLayoutFullScreen, (err, data) => {
+ if (err) {
+ console.error('Failed to set the window layout to full-screen mode. Cause:' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in setting the window layout to full-screen mode. Data:' + JSON.stringify(data));
+ });
+ ```
+
+### setFocusable7+
+
+setFocusable(isFocusable: boolean, callback: AsyncCallback<void>): void
+
+设置点击时是否支持切换焦点窗口。
+
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | isFocusable | boolean | 是 | 点击时是否支持切换焦点窗口。 |
+ | callback | AsyncCallback<void> | 是 | 回调函数。 |
+
+- 示例
+ ```
+ var isFocusable= true;
+ windowClass.setFocusable(isFocusable, (err, data) => {
+ if (err) {
+ console.error('Failed to set the window to be focusable. Cause:' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in setting the window to be focusable. Data: ' + JSON.stringify(data));
+ });
+ ```
+
+### setTouchable7+
+
+setTouchable(isTouchable: boolean, callback: AsyncCallback<void>): void
+
+设置窗口是否为可触状态。
+
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | isTouchable | boolean | 是 | 窗口是否为可触状态。 |
+ | callback | AsyncCallback<void> | 是 | 回调函数。 |
+
+- 示例
+ ```
+ var isTouchable = true;
+ windowClass.setTouchable(isTouchable, (err, data) => {
+ if (err) {
+ console.error('Failed to set the window to be touchable. Cause:' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in setting the window to be touchable. Data:' + JSON.stringify(data));
+
+ });
+ ```
+
+### setPrivacyMode7+
+
+setPrivacyMode(isPrivacyMode: boolean, callback: AsyncCallback<void>): void
+
+设置窗口是否为隐私模式。
+
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | isPrivacyMode | boolean | 是 | 窗口是否为隐私模式。 |
+ | callback | AsyncCallback<void> | 是 | 回调函数。 |
+
+- 示例
+ ```
+ var isPrivacyMode = true;
+ windowClass.setPrivacyMode(isPrivacyMode, (err, data) => {
+ if (err) {
+ console.error('Failed to set the window to privacy mode. Cause:' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in setting the window to privacy mode. Data:' + JSON.stringify(data));
+
+ });
+ ```
+
+### setSystemBarEnable7+
+
+setSystemBarEnable(names: Array, callback: AsyncCallback<void>): void
+
+设置导航栏、状态栏的可见模式。
+
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | names | Array | 是 | 设置状态栏和导航栏是否显示。例如，需全部显示，该参数设置为["status", "navigation"]。 |
+ | callback | AsyncCallback<void> | 是 | 回调函数。 |
+
+- 示例
+ ```
+ var names = ["status", "navigation"];
+ windowClass.setSystemBarEnable(names, (err, data) => {
+ if (err) {
+ console.error('Failed to set the system bar to be visible. Cause:' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in setting the system bar to be visible. Data: ' + JSON.stringify(data));
+ });
+ ```
+
+### setSystemBarProperties
+
+setSystemBarProperties(systemBarProperties: SystemBarProperties, callback: AsyncCallback<void>): void
+
+设置窗口内导航条状态栏的属性。
+
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | SystemBarProperties | [SystemBarProperties](#systembarproperties) | 是 | 导航条状态栏的属性。 |
+ | callback | AsyncCallback<void> | 是 | 回调函数。 |
+
+- 示例
+ ```
+ var SystemBarProperties={
+ statusBarColor: '#ff00ff',
+ navigationBarColor: '#00ff00',
+ //以下两个属性从API Version7开始支持
+ isStatusBarLightIcon: true,
+ isNavigationBarLightIcon:false
+ };
+ windowClass.setSystemBarProperties(SystemBarProperties, (err, data) => {
+ if (err) {
+ console.error('Failed to set the system bar properties. Cause: ' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in setting the system bar properties. Data: ' + JSON.stringify(data));
+ });
+ ```
+
+### getProperties
+
+getProperties(callback: AsyncCallback<WindowProperties>): void
+
+获取当前窗口的属性，异步返回WindowProperties。
+
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | callback | AsyncCallback<[WindowProperties](#windowproperties)> | 是 | 回调返回窗口属性。 |
+
+- 示例
+ ```
+ windowClass.getProperties((err, data) => {
+ if (err) {
+ console.error('Failed to obtain the window properties. Cause: ' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in obtaining the window properties. Data: ' + JSON.stringify(data));
+ });
+ ```
+
+### getAvoidArea7+
+
+getAvoidArea(type: AvoidAreaType, callback: AsyncCallback<AvoidArea>): void
+
+获取窗口内容规避的区域。如系统的系统栏区域 、凹口区域。
+
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | [AvoidAreaType](#avoidareatype7-) | 是 | 表示规避区类型。type为TYPE_SYSTEM，表示系统默认区域。type为TYPE_CUTOUT，表示刘海屏区域。 |
+ | callback | AsyncCallback<[AvoidArea](#avoidarea7-)> | 是 | 回调返回窗口内容规避区域。 |
+
+- 示例
+ ```
+ var type = window.AvoidAreaType.TYPE_SYSTEM;
+ windowClass.getAvoidArea(type, (err, data) => {
+ if (err) {
+ console.error('Failed to obtain the area. Cause:' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in obtaining the area. Data:' + JSON.stringify(data));
+ });
+ ```
+
+### moveTo7+
+
+moveTo(x: number, y: number, callback: AsyncCallback<void>): void
+
+窗口位置移动。
+
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | x | number | 是 | 窗口在x轴方向移动的值，值为正表示右移。 |
+ | y | number | 是 | 窗口在y轴方向移动的值，值为正表示下移。 |
+ | callback | AsyncCallback<void> | 是 | 回调函数。 |
+
+- 示例
+ ```
+ windowClass.moveTo(300, 300, (err, data)=>{
+ if (err) {
+ console.error('Failed to move the window. Cause:' + JSON.stringify(err));
+ return;
+ }
+ console.info('Window moved. Data:' + JSON.stringify(data));
+
+ });
+ ```
+
+### resetSize7+
+
+resetSize(width: number, height: number, callback: AsyncCallback<void>): void
+
+改变当前窗口大小。
+
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | width | number | 是 | 目标窗口的宽度。 |
+ | height | number | 是 | 目标窗口的高度。 |
+ | callback | AsyncCallback<void> | 是 | 回调函数。 |
+
+- 示例
+ ```
+ windowClass.resetSize(500, 1000, (err, data) => {
+ if (err) {
+ console.error('Failed to change the window size. Cause:' + JSON.stringify(err));
+ return;
+ }
+ console.info('Window size changed. Data:' + JSON.stringify(data));
+ });
+ ```
+
+### loadContent7+
+
+loadContent(path: string, callback: AsyncCallback<void>): void
+
+子窗口加载具体页面内容。
+
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | path | string | 是 | 设置加载页面的代码路径。 |
+ | callback | AsyncCallback<void> | 是 | 回调函数。 |
+
+- 示例
+ ```
+ windowClass.loadContent("pages/page2/page2", (err, data) => {
+ if (err) {
+ console.error('Failed to load the content. Cause:' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in loading the content. Data:' + JSON.stringify(data));
+ });
+ ```
+
+### hide7+
+
+hide (callback: AsyncCallback<void>): void
+
+隐藏子窗口。
+
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | callback | AsyncCallback<void> | 是 | 回调函数。 |
+
+- 示例
+ ```
+ windowClass.hide((err, data) => {
+ if (err) {
+ console.error('Failed to hide the subwindow. Cause: ' + JSON.stringify(err));
+ return;
+ }
+ console.info('Subwindow hidden. Data:' + JSON.stringify(data))
+ })
+ ```
+
+### show7+
+
+show(callback: AsyncCallback<void>): void
+
+显示子窗口。
+
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | callback | AsyncCallback<void> | 是 | 回调函数。 |
+
+- 示例
+ ```
+ windowClass.show((err, data) => {
+ if (err) {
+ console.error('Failed to show the subwindow. Cause: ' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in showing the subwindow. Data: ' + JSON.stringify(data))
+ })
+ ```
+
+### isShowing7+
+
+isShowing(callback: AsyncCallback<boolean>): void
+
+判断子窗口是否已显示。
+
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | callback | AsyncCallback<boolean> | 是 | 回调函数返回是否显示子窗口结果。 |
+
+- 示例
+ ```
+ windowClass.isShowing((err, data) => {
+ if (err) {
+ console.error('Failed to check whether the subwindow is showing. Cause:' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in checking whether the subwindow is showing. Cause:' + JSON.stringify(data))
+ })
+ ```
+
+### destroy7+
+
+destroy(callback: AsyncCallback<void>): void
+
+销毁子窗口。
+
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | callback | AsyncCallback<void> | 是 | 回调函数。 |
+
+- 示例
+ ```
+ windowClass.destroy((err, data) => {
+ if (err) {
+ console.error('Failed to destroy the subwindow. Cause:' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in destroying the subwindow. Data:' + JSON.stringify(data))
+ })
+ ```
+
+### setOutsideTouchable7+
+
+setOutsideTouchable(touchable: boolean, callback: AsyncCallback<void>): void;
+
+设置是否允许可点击子窗口以外的区域。
+
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | touchable | boolean | 是 | 设置是否可点击。 |
+ | callback | AsyncCallback<void> | 是 | 回调函数。 |
+
+- 示例
+ ```
+ windowClass.setOutsideTouchable(true, (err, data) => {
+ if (err) {
+ console.error('Failed to set the area to be touchable. Cause: ' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in setting the area to be touchable. Data: ' + JSON.stringify(data))
+ })
+ ```
+
+### on('keyboardHeightChange')
+
+on(type: string, callback: AsyncCallback<number>): void
+
+>  **说明：**
+> 从 API Version 7 开始废弃。
+
+开启监听键盘高度变化。
+
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | string | 是 | 设置监听类型为监听键盘高度变化，应设置type为'keyboardHeightChange'。 |
+ | callback | AsyncCallback<number> | 是 | 回调返回监听到的键盘高度。 |
+
+- 示例
+ ```
+ var type= 'keyboardHeightChange';
+ windowClass.on(type, (err, data) => {
+ if (err) {
+ console.error('Failed to enable the listener for keyboard height changes. Cause: ' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in enabling the listener for keyboard height changes. Data: ' + JSON.stringify(data));
+ });
+ ```
+
+### off('keyboardHeightChange')
+
+off(type: string, callback?: AsyncCallback<number>): void
+
+>  **说明：**
+> 从 API Version 7 开始废弃。
+
+关闭监听键盘高度变化。
+
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | string | 是 | 设置监听类型为监听键盘高度变化，应设置type为'keyboardHeightChange'。 |
+ | callback | AsyncCallback<number> | 否 | 回调返回监听到的键盘高度。 |
+
+- 示例
+ ```
+ var type= 'keyboardHeightChange';
+ windowClass.off(type);
+ ```
+
+### on('keyboardHeightChange'|'windowSizeChange'7+|'systemAvoidAreaChange'7+)
+
+on(type: string, callback: Callback<AvoidArea | Size | number>): void
+
+开启监听。
+
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | string | 是 | 设置监听类型。
- type为'keyboardHeightChange'时表示监听类型为键盘高度变化监听；
- type为'windowSizeChange'7+时表示监听类型为窗口尺寸变化监听；
- type为'systemAvoidAreaChange'7+时表示监听类型为系统窗口规避区变化监听。 |
+ | callback | Callback<[AvoidArea](#avoidarea7-) \| Size \| number> | 是 | 回调返回监听到的信息。 |
+
+- 示例
+ ```
+ var type = 'windowSizeChange';
+ windowClass.on(type, (data) => {
+ console.info('Succeeded in enabling the listener for window size changes. Data: ' + JSON.stringify(data));
+ });
+ ```
+
+### off('keyboardHeightChange'|'windowSizeChange'7+|'systemAvoidAreaChange'7+)
+
+off(type: string, callback?: Callback<AvoidArea | Size | number>): void
+
+关闭监听。
+
+- 参数
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | string | 是 | 设置监听类型。
- type为'keyboardHeightChange'时表示监听类型为键盘高度变化监听；
- type为'windowSizeChange'7+时表示监听类型为窗口尺寸变化监听；
- type为'systemAvoidAreaChange'7+时表示监听类型为系统窗口规避区变化监听。 |
+ | callback | Callback<[AvoidArea](#avoidarea7-) \| Size \| number> | 否 | 回调返回监听到的信息。 |
+
+- 示例
+ ```
+ var type = 'windowSizeChange';
+ windowClass.off(type);
+ ```
diff --git a/zh-cn/application-dev/reference/apis/js-apis-worker.md b/zh-cn/application-dev/reference/apis/js-apis-worker.md
index 30bb07d2084b19cfe6cd70392cd1588c4e8f5516..f78fea87fccaa5a270c6e37246cb44cd8ceb9eca 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-worker.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-worker.md
@@ -1,1228 +1,550 @@
-# 启动一个worker
+# 启动一个worker
-> **说明：**
->从 API Version 7 开始支持。
+>  **说明：**
+> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
-## 导入模块
+
+## 导入模块
```
import worker from '@ohos.worker';
```
-## 权限
+
+## 权限
无
-## 属性
-
-
-
-
-## WorkerOptions
+
+## 属性
+
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| parentPort | [DedicatedWorkerGlobalScope](#dedicatedworkerglobalscope) | 是 | 是 | worker线程用于与宿主线程通信的对象 |
+
+
+## WorkerOptions
worker构造函数函数的选项信息，用于为worker添加其他信息。
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-type
- |
-"classic"
- |
-是
- |
-是
- |
-按照指定方式执行脚本。
- |
-
-name
- |
-string
- |
-是
- |
-是
- |
-worker的名称。
- |
-
-
-
-
-## Worker
-
-使用以下方法前，均需先构造worker实例，Worker类继承[EventTarget](#section256019311465)。
-
-### constructor
-
-constructor\(scriptURL: string, options?: WorkerOptions\)
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| type | "classic" | 是 | 是 | 按照指定方式执行脚本。 |
+| name | string | 是 | 是 | worker的名称。 |
+
+
+## Worker
+
+使用以下方法前，均需先构造worker实例，Worker类继承[EventTarget](#eventtarget)。
+
+
+### constructor
+
+constructor(scriptURL: string, options?: WorkerOptions)
worker构造函数。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- scriptURL
- |
- string
- |
- 是
- |
- worker执行脚本的url，路径规范：若DevEco新建工程在pages同级下没有workers目录，需要新建workers目录，将脚本文件放入workers目录。
- |
-
- options
- |
- WorkerOptions
- |
- 否
- |
- worker构造的选项。
- |
-
-
-
-
-- 返回值：
-
-
- 参数名
- |
- 说明
- |
-
|---|
-
- worker
- |
- 执行Worker构造函数生成的Worker对象，失败则返回undefined。
- |
-
-
-
-
-- 示例：
-
- ```
- import worker from '@ohos.worker';
- const worker = new worker.Worker("workers/worker.js", {name:"first worker"});
- ```
-
-
-### postMessage
-
-postMessage\(message: Object, options?: PostMessageOptions\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | scriptURL | string | 是 | worker执行脚本的url，路径规范：若DevEco新建工程在pages同级下没有workers目录，需要新建workers目录，将脚本文件放入workers目录。 |
+ | options | [WorkerOptions](#workeroptions) | 否 | worker构造的选项。 |
+
+- 返回值：
+ | 参数名 | 说明 |
+ | -------- | -------- |
+ | worker | 执行Worker构造函数生成的Worker对象，失败则返回undefined。 |
+
+- 示例：
+ ```
+ import worker from '@ohos.worker';
+ const worker = new worker.Worker("workers/worker.js", {name:"first worker"});
+ ```
+
+
+### postMessage
+
+postMessage(message: Object, options?: PostMessageOptions): void
向worker线程发送消息，数据的传输采用结构化克隆算法。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- message
- |
- Object
- |
- 是
- |
- 发送至worker的数据。
- |
-
- options
- |
- PostMessageOptions
- |
- 否
- |
- 可转移对象是 ArrayBuffer 的实例对象。transferList数组中不可传入null。
- |
-
-
-
-
-- 示例：
-
- ```
- import worker from '@ohos.worker';
- const worker = new worker.Worker("workers/worker.js");
- worker.postMessage("hello world");
-
- const worker = new worker.Worker("workers/worker.js");
- var buffer = new ArrayBuffer(8);
- worker.postMessage(buffer, [buffer]);
- ```
-
-
-### on
-
-on\(type: string, listener: EventListener\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | message | Object | 是 | 发送至worker的数据。 |
+ | options | [PostMessageOptions](#postmessageoptions) | 否 | 可转移对象是 ArrayBuffer 的实例对象。transferList数组中不可传入null。 |
+
+- 示例：
+ ```
+ import worker from '@ohos.worker';
+ const worker = new worker.Worker("workers/worker.js");
+ worker.postMessage("hello world");
+
+ const worker = new worker.Worker("workers/worker.js");
+ var buffer = new ArrayBuffer(8);
+ worker.postMessage(buffer, [buffer]);
+ ```
+
+
+### on
+
+on(type: string, listener: EventListener): void
向worker添加一个事件监听。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- type
- |
- string
- |
- 是
- |
- 监听事件的type。
- |
-
- listener
- |
- EventListener
- |
- 是
- |
- 回调的事件。
- |
-
-
-
-
-- 示例：
-
- ```
- import worker from '@ohos.worker';
- const worker = new worker.Worker("workers/worker.js")
- worker.on("alert", (e)=>{
- console.log("alert listener callback");
- })
- ```
-
-
-### once
-
-once\(type: string, listener: EventListener\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | string | 是 | 监听事件的type。 |
+ | listener | [EventListener](#eventlistener) | 是 | 回调的事件。 |
+
+- 示例：
+ ```
+ import worker from '@ohos.worker';
+ const worker = new worker.Worker("workers/worker.js")
+ worker.on("alert", (e)=>{
+ console.log("alert listener callback");
+ })
+ ```
+
+
+### once
+
+once(type: string, listener: EventListener): void
向worker添加一个事件监听，事件监听只执行一次便自动删除。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- type
- |
- string
- |
- 是
- |
- 监听事件的type。
- |
-
- listener
- |
- EventListener
- |
- 是
- |
- 回调的事件。
- |
-
-
-
-
-- 示例：
-
- ```
- import worker from '@ohos.worker';
- const worker = new worker.Worker("workers/worker.js");
- worker.once("alert", (e)=>{
- console.log("alert listener callback");
- })
- ```
-
-
-### off
-
-off\(type: string, listener?: EventListener\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | string | 是 | 监听事件的type。 |
+ | listener | [EventListener](#eventlistener) | 是 | 回调的事件。 |
+
+- 示例：
+ ```
+ import worker from '@ohos.worker';
+ const worker = new worker.Worker("workers/worker.js");
+ worker.once("alert", (e)=>{
+ console.log("alert listener callback");
+ })
+ ```
+
+
+### off
+
+off(type: string, listener?: EventListener): void
删除worker的事件监听。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- type
- |
- string
- |
- 是
- |
- 需要删除事件的type。
- |
-
- listener
- |
- EventListener
- |
- 否
- |
- 需要删除的回调的事件。
- |
-
-
-
-
-- 示例：
-
- ```
- import worker from '@ohos.worker';
- const worker = new worker.Worker("workers/worker.js");
- worker.off("alert");
- ```
-
-
-### terminate
-
-terminate\(\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | string | 是 | 需要删除事件的type。 |
+ | listener | [EventListener](#eventlistener) | 否 | 需要删除的回调的事件。 |
-关闭worker线程，终止worker接收消息。
+- 示例：
+ ```
+ import worker from '@ohos.worker';
+ const worker = new worker.Worker("workers/worker.js");
+ worker.off("alert");
+ ```
-- 示例：
- ```
- import worker from '@ohos.worker';
- const worker = new worker.Worker("workers/worker.js")
- worker.terminate()
- ```
+### terminate
+terminate(): void
+
+关闭worker线程，终止worker接收消息。
+
+- 示例：
+ ```
+ import worker from '@ohos.worker';
+ const worker = new worker.Worker("workers/worker.js")
+ worker.terminate()
+ ```
-### onexit
-onexit?: \(code: number\) =\> void
+### onexit
+
+onexit?: (code: number) => void
Worker对象的onexit属性表示worker退出时被调用的事件处理程序，处理程序在宿主线程中执行。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- code
- |
- number
- |
- 否
- |
- worker退出的code。
- |
-
-
-
-
-- 示例：
-
- ```
- import worker from '@ohos.worker';
- const worker = new worker.Worker("workers/worker.js")
- worker.onexit = function(e) {
- console.log("onexit")
- }
- ```
-
-
-### onerror
-
-onerror?: \(err: ErrorEvent\) =\> void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | code | number | 否 | worker退出的code。 |
+
+- 示例：
+ ```
+ import worker from '@ohos.worker';
+ const worker = new worker.Worker("workers/worker.js")
+ worker.onexit = function(e) {
+ console.log("onexit")
+ }
+ ```
+
+
+### onerror
+
+onerror?: (err: ErrorEvent) => void
Worker对象的onerror属性表示worker在执行过程中发生异常被调用的事件处理程序，处理程序在宿主线程中执行。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- err
- |
- ErrorEvent
- |
- 否
- |
- 异常数据。
- |
-
-
-
-
-- 示例：
-
- ```
- import worker from '@ohos.worker';
- const worker = new worker.Worker("workers/worker.js")
- worker.onerror = function(e) {
- console.log("onerror")
- }
- ```
-
-
-### onmessage
-
-onmessage?: \(event: MessageEvent\) =\> void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | err | [ErrorEvent](#errorevent) | 否 | 异常数据。 |
+
+- 示例：
+ ```
+ import worker from '@ohos.worker';
+ const worker = new worker.Worker("workers/worker.js")
+ worker.onerror = function(e) {
+ console.log("onerror")
+ }
+ ```
+
+
+### onmessage
+
+onmessage?: (event: MessageEvent) => void
Worker对象的onmessage属性表示宿主线程接收到来自其创建的worker通过parentPort.postMessage接口发送的消息时被调用的事件处理程序，处理程序在宿主线程中执行。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- event
- |
- MessageEvent
- |
- 否
- |
- 收到的worker消息数据。
- |
-
-
-
-
-- 示例：
-
- ```
- import worker from '@ohos.worker';
- const worker = new worker.Worker("workers/worker.js")
- worker.onmessage = function(e) {
- console.log("onerror")
- }
- ```
-
-
-### onmessageerror
-
-onmessageerror?: \(event: MessageEvent\) =\> void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | event | [MessageEvent](#messageevent) | 否 | 收到的worker消息数据。 |
+
+- 示例：
+ ```
+ import worker from '@ohos.worker';
+ const worker = new worker.Worker("workers/worker.js")
+ worker.onmessage = function(e) {
+ console.log("onerror")
+ }
+ ```
+
+
+### onmessageerror
+
+onmessageerror?: (event: MessageEvent) => void
Worker对象的onmessageerror属性表示当 Worker 对象接收到一条无法被序列化的消息时被调用的事件处理程序，处理程序在宿主线程中执行。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- event
- |
- MessageEvent
- |
- 否
- |
- 异常数据。
- |
-
-
-
-
-- 示例：
-
- ```
- import worker from '@ohos.worker';
- const worker = new worker.Worker("workers/worker.js")
- worker.onmessageerror= function(e) {
- console.log("onmessageerror")
- }
- ```
-
-
-## EventTarget
-
-### addEventListener
-
-addEventListener\(type: string, listener: EventListener\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | event | [MessageEvent](#messageevent) | 否 | 异常数据。 |
+
+- 示例：
+ ```
+ import worker from '@ohos.worker';
+ const worker = new worker.Worker("workers/worker.js")
+ worker.onmessageerror= function(e) {
+ console.log("onmessageerror")
+ }
+ ```
+
+
+## EventTarget
+
+
+### addEventListener
+
+addEventListener(type: string, listener: EventListener): void
向worker添加一个事件监听。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- type
- |
- string
- |
- 是
- |
- 监听事件的type。
- |
-
- listener
- |
- EventListener
- |
- 是
- |
- 回调的事件。
- |
-
-
-
-
-- 示例：
-
- ```
- import worker from '@ohos.worker';
- const worker = new worker.Worker("workers/worker.js")
- worker.addEventListener("alert", (e)=>{
- console.log("alert listener callback");
- })
- ```
-
-
-### removeEventListener
-
-removeEventListener\(type: string, callback?: EventListener\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | string | 是 | 监听事件的type。 |
+ | listener | [EventListener](#eventlistener) | 是 | 回调的事件。 |
+
+- 示例：
+ ```
+ import worker from '@ohos.worker';
+ const worker = new worker.Worker("workers/worker.js")
+ worker.addEventListener("alert", (e)=>{
+ console.log("alert listener callback");
+ })
+ ```
+
+
+### removeEventListener
+
+removeEventListener(type: string, callback?: EventListener): void
删除worker的事件监听。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- type
- |
- string
- |
- 是
- |
- 需要删除事件的type。
- |
-
- callback
- |
- EventListener
- |
- 否
- |
- 需要删除的回调的事件。
- |
-
-
-
-
-- 示例：
-
- ```
- import worker from '@ohos.worker';
- const worker = new worker.Worker("workers/worker.js")
- worker.removeEventListener("alert")
- ```
-
-
-### dispatchEvent
-
-dispatchEvent\(event: Event\): boolean
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | type | string | 是 | 需要删除事件的type。 |
+ | callback | [EventListener](#eventlistener) | 否 | 需要删除的回调的事件。 |
+
+- 示例：
+ ```
+ import worker from '@ohos.worker';
+ const worker = new worker.Worker("workers/worker.js")
+ worker.removeEventListener("alert")
+ ```
+
+
+### dispatchEvent
+
+dispatchEvent(event: Event): boolean
分发定义在worker的事件。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- event
- |
- Event
- |
- 是
- |
- 需要分发的事件。
- |
-
-
-
-
-- 返回值：
-
-
- 参数名
- |
- 说明
- |
-
|---|
-
- boolean
- |
- 分发的结果，false表示分发失败。
- |
-
-
-
-
-- 示例：
-
- ```
- import worker from '@ohos.worker';
- const worker = new worker.Worker("workers/worker.js")
- worker.dispatchEvent({type:"alert"})
- ```
-
-
-### removeAllListener
-
-removeAllListener\(\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | event | [Event](#event) | 是 | 需要分发的事件。 |
+
+- 返回值：
+ | 参数名 | 说明 |
+ | -------- | -------- |
+ | boolean | 分发的结果，false表示分发失败。 |
+
+- 示例：
+ ```
+ import worker from '@ohos.worker';
+ const worker = new worker.Worker("workers/worker.js")
+ worker.dispatchEvent({type:"alert"})
+ ```
+
+
+### removeAllListener
+
+removeAllListener(): void
删除worker的所有事件监听。
-- 示例：
+- 示例：
+ ```
+ import worker from '@ohos.worker';
+ const worker = new worker.Worker("workers/worker.js")
+ worker.removeAllListener({type:"alert"})
+ ```
- ```
- import worker from '@ohos.worker';
- const worker = new worker.Worker("workers/worker.js")
- worker.removeAllListener({type:"alert"})
- ```
+## DedicatedWorkerGlobalScope
-## DedicatedWorkerGlobalScope
+worker线程用于与宿主线程通信的类，通过postMessage接口发送消息给宿主线程、close接口关闭worker线程，DedicatedWorkerGlobalScope类继承[WorkerGlobalScope](#workerglobalscope)。
-worker线程用于与宿主线程通信的类，通过postMessage接口发送消息给宿主线程、close接口关闭worker线程，DedicatedWorkerGlobalScope类继承[WorkerGlobalScope](#section12882825611)。
-### postMessage
+### postMessage
-postMessage\(message: Object, options?: PostMessageOptions\): void
+postMessage(message: Object, options?: PostMessageOptions): void
worker向宿主线程发送消息。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- message
- |
- Object
- |
- 是
- |
- 发送至worker的数据。
- |
-
- options
- |
- PostMessageOptions
- |
- 否
- |
- 可转移对象是ArrayBuffer的实例对象。transferList数组中不可传入null。
- |
-
-
-
-
-- 示例：
-
- ```
- // main.js
- import worker from '@ohos.worker';
- const worker = new worker.Worker("workers/worker.js")
- worker.postMessage("hello world")
- worker.onmessage = function(e) {
- console.log("receive data from worker.js")
- }
-
- // worker.js
- import worker from "@ohos.worker";
- const parentPort = worker.parentPort;
- parentPort.onmessage = function(e){
- parentPort.postMessage("receive data from main.js")
- }
- ```
-
-
-### close
-
-close\(\): void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | message | Object | 是 | 发送至worker的数据。 |
+ | options | [PostMessageOptions](#postmessageoptions) | 否 | 可转移对象是ArrayBuffer的实例对象。transferList数组中不可传入null。 |
+
+- 示例：
+ ```
+ // main.js
+ import worker from '@ohos.worker';
+ const worker = new worker.Worker("workers/worker.js")
+ worker.postMessage("hello world")
+ worker.onmessage = function(e) {
+ console.log("receive data from worker.js")
+ }
+
+ // worker.js
+ import worker from "@ohos.worker";
+ const parentPort = worker.parentPort;
+ parentPort.onmessage = function(e){
+ parentPort.postMessage("receive data from main.js")
+ }
+ ```
+
+
+### close
+
+close(): void
关闭worker线程，终止worker接收消息。
-- 示例：
-
- ```
- // main.js
- import worker from '@ohos.worker';
- const worker = new worker.Worker("workers/worker.js")
-
- // worker.js
- import worker from "@ohos.worker";
- const parentPort = worker.parentPort;
- parentPort.onmessage = function(e) {
- parentPort.close()
- }
- ```
+- 示例：
+ ```
+ // main.js
+ import worker from '@ohos.worker';
+ const worker = new worker.Worker("workers/worker.js")
+
+ // worker.js
+ import worker from "@ohos.worker";
+ const parentPort = worker.parentPort;
+ parentPort.onmessage = function(e) {
+ parentPort.close()
+ }
+ ```
-### onmessage
+### onmessage
-onmessage?: \(event: MessageEvent\) =\> void
+onmessage?: (event: MessageEvent) => void
DedicatedWorkerGlobalScope的onmessage属性表示worker线程收到来自其宿主线程通过worker.postMessage接口发送的消息时被调用的事件处理程序，处理程序在worker线程中执行。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- event
- |
- MessageEvent
- |
- 否
- |
- 收到的worker消息数据。
- |
-
-
-
-
-- 示例：
-
- ```
- // main.js
- import worker from '@ohos.worker';
- const worker = new worker.Worker("workers/worker.js")
- worker.postMessage("hello world")
-
- // worker.js
- import worker from "@ohos.worker";
- const parentPort = worker.parentPort;
- parentPort.onmessage = function(e) {
- console.log("receive main.js message")
- }
- ```
-
-
-### onmessageerror
-
-onmessageerror?: \(event: MessageEvent\) =\> void
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | event | [MessageEvent](#messageevent) | 否 | 收到的worker消息数据。 |
+
+- 示例：
+ ```
+ // main.js
+ import worker from '@ohos.worker';
+ const worker = new worker.Worker("workers/worker.js")
+ worker.postMessage("hello world")
+
+ // worker.js
+ import worker from "@ohos.worker";
+ const parentPort = worker.parentPort;
+ parentPort.onmessage = function(e) {
+ console.log("receive main.js message")
+ }
+ ```
+
+
+### onmessageerror
+
+onmessageerror?: (event: MessageEvent) => void
DedicatedWorkerGlobalScope的onmessageerror属性表示当 Worker 对象接收到一条无法被反序列化的消息时被调用的事件处理程序，处理程序在worker线程中执行。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- event
- |
- MessageEvent
- |
- 否
- |
- 异常数据。
- |
-
-
-
-
-- 示例：
-
- ```
- // main.js
- import worker from '@ohos.worker';
- const worker = new worker.Worker("workers/worker.js")
-
- // worker.js
- import worker from "@ohos.worker";
- const parentPort = worker.parentPort;
- parentPort.onmessageerror= function(e) {
- console.log("worker.js onmessageerror")
- }
- ```
-
-
-## PostMessageOptions
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | event | [MessageEvent](#messageevent) | 否 | 异常数据。 |
+
+- 示例：
+ ```
+ // main.js
+ import worker from '@ohos.worker';
+ const worker = new worker.Worker("workers/worker.js")
+
+ // worker.js
+ import worker from "@ohos.worker";
+ const parentPort = worker.parentPort;
+ parentPort.onmessageerror= function(e) {
+ console.log("worker.js onmessageerror")
+ }
+ ```
+
+
+## PostMessageOptions
明确数据传递过程中需要转移所有权对象的类，传递所有权的对象必须是ArrayBuffer。
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-transfer
- |
-Object[]
- |
-是
- |
-是
- |
-ArrayBuffer数组，用于传递所有权。
- |
-
-
-
-
-## Event
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| transfer | Object[] | 是 | 是 | ArrayBuffer数组，用于传递所有权。 |
+
+
+## Event
事件类。
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-type
- |
-string
- |
-是
- |
-否
- |
-指定事件的type。
- |
-
-timeStamp
- |
-number
- |
-是
- |
-否
- |
-事件创建时的时间戳（精度为毫秒）。
- |
-
-
-
-
-## EventListener
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| type | string | 是 | 否 | 指定事件的type。 |
+| timeStamp | number | 是 | 否 | 事件创建时的时间戳（精度为毫秒）。 |
+
+
+## EventListener
事件监听类。
-### \(evt: Event\): void | Promise
+
+### (evt: Event): void | Promise<void>
执行的回调函数。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- evt
- |
- Event
- |
- 是
- |
- 回调的事件类。
- |
-
-
-
-
-- 返回值
-
-
- 参数名
- |
- 说明
- |
-
|---|
-
- void | Promise<void>
- |
- 无返回值或者以Promise形式返回。
- |
-
-
-
-
-- 示例：
-
- ```
- import worker from '@ohos.worker';
- const worker = new worker.Worker("workers/worker.js");
- worker.addEventListener("alert", (e)=>{
- console.log("alert listener callback");
- })
- ```
-
-
-## ErrorEvent
-
-错误事件类，用于表示worker执行过程中出现异常的详细信息，ErrorEvent类继承[Event](#section1674694018507)。
-
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-message
- |
-string
- |
-是
- |
-否
- |
-异常发生的错误信息。
- |
-
-filename
- |
-string
- |
-是
- |
-否
- |
-出现异常所在的文件。
- |
-
-lineno
- |
-number
- |
-是
- |
-否
- |
-异常所在的行数。
- |
-
-colno
- |
-number
- |
-是
- |
-否
- |
-异常所在的列数。
- |
-
-error
- |
-Object
- |
-是
- |
-否
- |
-异常类型。
- |
-
-
-
-
-## MessageEvent
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | evt | [Event](#event) | 是 | 回调的事件类。 |
+
+- 返回值
+ | 参数名 | 说明 |
+ | -------- | -------- |
+ | void \| Promise<void> | 无返回值或者以Promise形式返回。 |
+
+- 示例：
+ ```
+ import worker from '@ohos.worker';
+ const worker = new worker.Worker("workers/worker.js");
+ worker.addEventListener("alert", (e)=>{
+ console.log("alert listener callback");
+ })
+ ```
+
+
+## ErrorEvent
+
+错误事件类，用于表示worker执行过程中出现异常的详细信息，ErrorEvent类继承[Event](#event)。
+
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| message | string | 是 | 否 | 异常发生的错误信息。 |
+| filename | string | 是 | 否 | 出现异常所在的文件。 |
+| lineno | number | 是 | 否 | 异常所在的行数。 |
+| colno | number | 是 | 否 | 异常所在的列数。 |
+| error | Object | 是 | 否 | 异常类型。 |
+
+
+## MessageEvent
消息类，持有worker线程间传递的数据。
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-data
- |
-T
- |
-是
- |
-否
- |
-线程间传递的数据。
- |
-
-
-
-
-## WorkerGlobalScope
-
-worker线程自身的运行环境，WorkerGlobalScope类继承[EventTarget](#section256019311465)。
-
-### 属性
-
-
-名称
- |
-参数类型
- |
-可读
- |
-可写
- |
-说明
- |
-
|---|
-
-name
- |
-string
- |
-是
- |
-否
- |
-worker的名字，有new Worker时指定。
- |
-
-self
- |
-WorkerGlobalScope & typeof globalThis
- |
-是
- |
-否
- |
-WorkerGlobalScope本身。
- |
-
-
-
-
-### onerror
-
-onerror?: \(ev: ErrorEvent\) =\> void
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| data | T | 是 | 否 | 线程间传递的数据。 |
+
+
+## WorkerGlobalScope
+
+worker线程自身的运行环境，WorkerGlobalScope类继承[EventTarget](#eventtarget)。
-WorkerGlobalScope的onerror属性表示worker在执行过程中发生异常被调用的事件处理程序，处理程序在worker线程中执行。
-- 参数：
-
-
- 参数名
- |
- 类型
- |
- 必填
- |
- 说明
- |
-
|---|
-
- ev
- |
- ErrorEvent
- |
- 否
- |
- 异常数据。
- |
-
-
-
-
-- 示例：
-
- ```
- // main.js
- import worker from '@ohos.worker';
- const worker = new worker.Worker("workers/worker.js")
-
- // worker.js
- import worker from "@ohos.worker";
- const parentPort = worker.parentPort
- parentPort.onerror = function(e){
- console.log("worker.js onerror")
- }
- ```
+### 属性
+| 名称 | 参数类型 | 可读 | 可写 | 说明 |
+| -------- | -------- | -------- | -------- | -------- |
+| name | string | 是 | 否 | worker的名字，有new Worker时指定。 |
+| self | [WorkerGlobalScope](#workerglobalscope) & typeof globalThis | 是 | 否 | WorkerGlobalScope本身。 |
+
+
+### onerror
+
+onerror?: (ev: ErrorEvent) => void
+
+WorkerGlobalScope的onerror属性表示worker在执行过程中发生异常被调用的事件处理程序，处理程序在worker线程中执行。
+- 参数：
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------- | -------- | -------- | -------- |
+ | ev | [ErrorEvent](#errorevent) | 否 | 异常数据。 |
+
+- 示例：
+ ```
+ // main.js
+ import worker from '@ohos.worker';
+ const worker = new worker.Worker("workers/worker.js")
+
+ // worker.js
+ import worker from "@ohos.worker";
+ const parentPort = worker.parentPort
+ parentPort.onerror = function(e){
+ console.log("worker.js onerror")
+ }
+ ```
diff --git a/zh-cn/application-dev/reference/apis/js-apis.md b/zh-cn/application-dev/reference/apis/js-apis.md
index 391ecba4f9c62b11f4dc78951a174172145dabf8..995d83c72f0404cec907c2b95b545325a7589e09 100644
--- a/zh-cn/application-dev/reference/apis/js-apis.md
+++ b/zh-cn/application-dev/reference/apis/js-apis.md
@@ -1,13 +1,21 @@
-# 接口
-
-- **[Ability框架](js-apis-ability.md)**
-- **[资源管理](js-apis-resource.md)**
-- **[媒体](js-apis-multmedia.md)**
-- **[数据管理](js-apis-data.md)**
-- **[账号管理](js-apis-account.md)**
-- **[电话服务](js-apis-telephony.md)**
-- **[网络与连接](js-apis-connectivity.md)**
-- **[设备管理](js-apis-device-mgmt.md)**
-- **[基本功能](js-apis-basic-features.md)**
-- **[语言基础类库](js-apis-base-library.md)**
+# 接口
+
+
+- **[Ability框架](js-apis-ability.md)**
+
+- **[资源管理](js-apis-resource.md)**
+
+- **[媒体](js-apis-multmedia.md)**
+
+- **[数据管理](js-apis-data.md)**
+
+- **[账号管理](js-apis-account.md)**
+
+- **[电话服务](js-apis-telephony.md)**
+
+- **[设备管理](js-apis-device-mgmt.md)**
+
+- **[基本功能](js-apis-basic-features.md)**
+
+- **[语言基础类库](js-apis-base-library.md)**
\ No newline at end of file
diff --git a/zh-cn/application-dev/reference/apis/public_sys-resources/icon-caution.gif b/zh-cn/application-dev/reference/apis/public_sys-resources/icon-caution.gif
new file mode 100644
index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571
Binary files /dev/null and b/zh-cn/application-dev/reference/apis/public_sys-resources/icon-caution.gif differ
diff --git a/zh-cn/application-dev/reference/apis/public_sys-resources/icon-danger.gif b/zh-cn/application-dev/reference/apis/public_sys-resources/icon-danger.gif
new file mode 100644
index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571
Binary files /dev/null and b/zh-cn/application-dev/reference/apis/public_sys-resources/icon-danger.gif differ
diff --git a/zh-cn/application-dev/reference/apis/public_sys-resources/icon-note.gif b/zh-cn/application-dev/reference/apis/public_sys-resources/icon-note.gif
new file mode 100644
index 0000000000000000000000000000000000000000..6314297e45c1de184204098efd4814d6dc8b1cda
Binary files /dev/null and b/zh-cn/application-dev/reference/apis/public_sys-resources/icon-note.gif differ
diff --git a/zh-cn/application-dev/reference/apis/public_sys-resources/icon-notice.gif b/zh-cn/application-dev/reference/apis/public_sys-resources/icon-notice.gif
new file mode 100644
index 0000000000000000000000000000000000000000..86024f61b691400bea99e5b1f506d9d9aef36e27
Binary files /dev/null and b/zh-cn/application-dev/reference/apis/public_sys-resources/icon-notice.gif differ
diff --git a/zh-cn/application-dev/reference/apis/public_sys-resources/icon-tip.gif b/zh-cn/application-dev/reference/apis/public_sys-resources/icon-tip.gif
new file mode 100644
index 0000000000000000000000000000000000000000..93aa72053b510e456b149f36a0972703ea9999b7
Binary files /dev/null and b/zh-cn/application-dev/reference/apis/public_sys-resources/icon-tip.gif differ
diff --git a/zh-cn/application-dev/reference/apis/public_sys-resources/icon-warning.gif b/zh-cn/application-dev/reference/apis/public_sys-resources/icon-warning.gif
new file mode 100644
index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571
Binary files /dev/null and b/zh-cn/application-dev/reference/apis/public_sys-resources/icon-warning.gif differ