From c2cf6445703e0446aac2bb4573dddf24b85b828c Mon Sep 17 00:00:00 2001 From: yuyaozhi Date: Wed, 20 Jul 2022 17:05:42 +0800 Subject: [PATCH] Fix master branch document problems of ability Signed-off-by: yuyaozhi --- zh-cn/application-dev/ability/stage-call.md | 2 +- .../reference/apis/js-apis-Context.md | 2 +- .../apis/js-apis-ability-wantConstant.md | 2 +- .../js-apis-application-abilityDelegator.md | 4 +- ...is-application-abilityLifecycleCallback.md | 2 +- .../reference/apis/js-apis-configuration.md | 2 + .../apis/js-apis-dataAbilityHelper.md | 101 +++++++++++++++++- .../reference/apis/js-apis-missionManager.md | 4 +- 8 files changed, 108 insertions(+), 11 deletions(-) diff --git a/zh-cn/application-dev/ability/stage-call.md b/zh-cn/application-dev/ability/stage-call.md index 1cec47b609..e8126fa0d7 100644 --- a/zh-cn/application-dev/ability/stage-call.md +++ b/zh-cn/application-dev/ability/stage-call.md @@ -19,7 +19,7 @@ Caller及Callee功能如下：具体的API详见[接口文档](../reference/apis |接口名|描述| |:------|:------| |startAbilityByCall(want: Want): Promise\|获取指定通用组件的Caller通信接口，拉起指定通用组件并将其切换到后台。| -|on(method: string, callback: CaleeCallBack): void|通用组件Callee注册method对应的callback方法。| +|on(method: string, callback: CalleeCallBack): void|通用组件Callee注册method对应的callback方法。| |off(method: string): void|通用组件Callee去注册method的callback方法。| |call(method: string, data: rpc.Sequenceable): Promise\|向通用组件Callee发送约定序列化数据。| |callWithResult(method: string, data: rpc.Sequenceable): Promise\|向通用组件Callee发送约定序列化数据, 并将返回的约定序列化数据带回。| diff --git a/zh-cn/application-dev/reference/apis/js-apis-Context.md b/zh-cn/application-dev/reference/apis/js-apis-Context.md index 1df895cc26..e8a3685896 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-Context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-Context.md @@ -984,7 +984,7 @@ context.getHapModuleInfo().then((data) => { ## Context.getAppVersionInfo7+ -getAppVersionInfo(callback: AsyncCallback): void +getAppVersionInfo(callback: AsyncCallback\): void 获取应用的版本信息（callback形式）。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-ability-wantConstant.md b/zh-cn/application-dev/reference/apis/js-apis-ability-wantConstant.md index 13b1ed18b8..f337e932bc 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-ability-wantConstant.md +++ b/zh-cn/application-dev/reference/apis/js-apis-ability-wantConstant.md @@ -46,7 +46,7 @@ want操作的常数。 | ACTION_FILE_SELECT7+ | ohos.action.fileSelect | 指示选择文件的操作。 | | PARAMS_STREAM7+ | ability.params.stream | 指示与连接发送数据一起使用时，包含与意图相关联的数据流的URI。 | | ACTION_APP_ACCOUNT_OAUTH 8+ | ohos.account.appAccount.action.oauth | 指示提供oauth服务的操作。 | -| ACTION_MARKER_DOWNLOAD 9+ | ohos.want.action.marketDownload | 表示从应用程序市场下载应用程序的的操作。 | +| ACTION_MARKER_DOWNLOAD 9+ | ohos.want.action.marketDownload | 表示从应用程序市场下载应用程序的的操作。
**系统API**：该接口为系统接口，三方应用不支持调用。 | ## wantConstant.Entity diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegator.md b/zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegator.md index e16c93cc90..b9f2671b47 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegator.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegator.md @@ -654,7 +654,7 @@ abilityDelegator.printSync(msg); -### print9+ +### print print(msg: string, callback: AsyncCallback\): void @@ -683,7 +683,7 @@ abilityDelegator.print(msg, (err : any) => { -### print9+ +### print print(msg: string): Promise\ diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-abilityLifecycleCallback.md b/zh-cn/application-dev/reference/apis/js-apis-application-abilityLifecycleCallback.md index f220273cbf..40c41150c2 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-abilityLifecycleCallback.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-abilityLifecycleCallback.md @@ -11,7 +11,7 @@ AbilityLifecycleCallback模块提供应用上下文ApplicationContext的生命 ## 导入模块 ```js -import AbilityLifecycleCallback from "@ohos.application.abilityLifecycleCallback"; +import AbilityLifecycleCallback from "@ohos.application.AbilityLifecycleCallback"; ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-configuration.md b/zh-cn/application-dev/reference/apis/js-apis-configuration.md index 1889e753e1..0f82948b51 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-configuration.md +++ b/zh-cn/application-dev/reference/apis/js-apis-configuration.md @@ -23,3 +23,5 @@ import Configuration from '@ohos.application.Configuration'; | direction9+ | Direction | 是 | 否 | 表示屏幕方向，取值范围：水平方向（DIRECTION_HORIZONTAL），垂直方向（DIRECTION_VERTICAL）。 | | screenDensity9+ | ScreenDensity | 是 | 否 | 表示屏幕分辨率，取值范围：SCREEN_DENSITY_SDPI（120）、SCREEN_DENSITY_MDPI（160）、SCREEN_DENSITY_LDPI（240）、SCREEN_DENSITY_XLDPI（320）、SCREEN_DENSITY_XXLDPI（480）、SCREEN_DENSITY_XXXLDPI（640）。 | | displayId9+ | number | 是 | 否 | 表示应用所在的displayId。 | +| hasPointerDevice9+ | boolean | 是 | 否 | 指示指针类型设备是否已连接。 | + diff --git a/zh-cn/application-dev/reference/apis/js-apis-dataAbilityHelper.md b/zh-cn/application-dev/reference/apis/js-apis-dataAbilityHelper.md index 16d5108ce9..be98b82dab 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-dataAbilityHelper.md +++ b/zh-cn/application-dev/reference/apis/js-apis-dataAbilityHelper.md @@ -685,7 +685,7 @@ delete(uri: string, predicates?: dataAbility.DataAbilityPredicates): Promise\, predicates?: dataAbility.DataAbilityPredicates): Promise\; +query(uri: string, columns?: Array\, predicates?: dataAbility.DataAbilityPredicates): Promise\; 查询数据库中的数据（Promise形式）。 @@ -932,6 +932,77 @@ dataAbilityHelper.call("dataability:///com.example.jsapidemo.UserDataAbility", " console.info('Operation succeeded: ' + data); }); ``` + +## DataAbilityHelper.executeBatch + +executeBatch(uri: string, operations: Array\, callback: AsyncCallback\>): void; + +查询数据库中的数据。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 名称 | 类型 | 必填 | 描述 | +| ---------- | --------------------------------- | ---- | ------------------------------------------------ | +| uri | string | 是 | 指定待处理的DataAbility。例："dataability:///com.example.xxx.xxxx"。| +| operations | Array\<[DataAbilityOperation](#dataabilityoperation)> | 是 | 指示数据操作列表，其中可以包含对数据库的多个操作。 | +| callback | AsyncCallback\> | 是 |在数组 DataAbilityResult中返回每个操作的结果。 | + +**示例：** + +```js +import featureAbility from '@ohos.ability.featureAbility'; + +// 根据DataAbilityOperation列表选择要对数据库做的操作 +let op=new Array(); +let dataAbilityHelper = featureAbility.acquireDataAbilityHelper("dataability:///com.example.jsapidemo.UserDataAbility"); +dataAbilityHelper.executeBatch("dataability:///com.example.jsapidemo.UserDataAbility", op, (err, data) => { + if (err) { + console.error('Operation failed. Cause: ' + err); + return; + } + console.info('Operation succeeded: ' + data); +}); +``` + +## DataAbilityHelper.executeBatch + +executeBatch(uri: string, operations: Array\): Promise\>; + +查询数据库中的数据。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel + +**参数：** + +| 名称 | 类型 | 必填 | 描述 | +| ---------- | -------------------------------| ---- | ------------------------------------------------ | +| uri | string | 是 | 指定待处理的DataAbility。例："dataability:///com.example.xxx.xxxx"。| +| operations | Array\<[DataAbilityOperation](#dataabilityoperation)> | 是 | 指示数据操作列表，其中可以包含对数据库的多个操作。 | + +**返回值：** + +| 类型 | 说明 | +|------ | ------- | +|Promise\> | 在数组 DataAbilityResult中返回每个操作的结果。 | + +**示例：** + +```js +import featureAbility from '@ohos.ability.featureAbility'; + +// 根据DataAbilityOperation列表选择要对数据库做的操作 +let op=new Array(); +let dataAbilityHelper = featureAbility.acquireDataAbilityHelper("dataability:///com.example.jsapidemo.UserDataAbility"); +dataAbilityHelper.executeBatch("dataability:///com.example.jsapidemo.UserDataAbility",op ).then((data) => { + console.info('Operation succeeded: ' + data); +}).catch((error) => { + console.error('Operation failed. Cause: ' + error); +}); + +``` + ## PacMap [key: string]: number | string | boolean | Array\ | null; @@ -940,4 +1011,28 @@ dataAbilityHelper.call("dataability:///com.example.jsapidemo.UserDataAbility", " | 名称 | 参数类型 | 必填 | 说明 | | ------ | ------ | ------ | ------ | -| [key: string] | number \| string \| boolean \| Array\ \| null | Yes| 数据存储在键值对中。| \ No newline at end of file +| [key: string] | number \| string \| boolean \| Array\ \| null | Yes| 数据存储在键值对中。| + +## DataAbilityOperation + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel + +| 名称 | 参数类型 | 可读 | 可写 | 必填| 说明 | +| -------- | -------- | -------- | -------- | --------| -------- | +| uri | string | 是 | 否 | 是 | 指定待处理的DataAbility。例："dataability:///com.example.xxx.xxxx"。 | +| type | featureAbility.DataAbilityOperationType | 是 | 否 | 是 | 指示操作类型。 | +| valuesBucket? | rdb.ValuesBucket | 是 | 否 | 否 | 指示要设置的数据值。 | +| valueBackReferences? | rdb.ValuesBucket | 是 | 否 | 否 | 指示包含一组键值对的valuesBucket对象。 | +| predicates? | dataAbility.DataAbilityPredicates | 是 | 否 | 否 | 指示要设置的筛选条件。如果此参数为空，则所有数据记录。 | +| predicatesBackReferences? | Map\ | 是 | 否 | 否 | 指示用作谓词中筛选条件的反向引用。 | +| interrupted? | boolean | 是 | 否 | 否 | 指定是否可以中断批处理操作。 | +| expectedCount? | number | 是 | 否 | 否 | 指示要更新或删除的预期行数。 | + +## DataAbilityResult + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel + +| 名称 | 参数类型 | 可读 | 可写 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | -------- | -------- | +| uri? | string | 是 | 否 | 否 | 指定待处理的DataAbility。例："dataability:///com.example.xxx.xxxx"。 | +| count? | number | 是 | 否 | 否 | 指示受操作影响的行数。 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-missionManager.md b/zh-cn/application-dev/reference/apis/js-apis-missionManager.md index 0a4ded95e1..bb2deac5e5 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-missionManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-missionManager.md @@ -362,7 +362,7 @@ getMissionSnapShot(deviceId: string, missionId: number): Promise<MissionSnaps }); ``` -## missionManager.getLowResolutionMissionSnapShot +## missionManager.getLowResolutionMissionSnapShot9+ getLowResolutionMissionSnapShot(deviceId: string, missionId: number, callback: AsyncCallback\): void; @@ -401,7 +401,7 @@ getLowResolutionMissionSnapShot(deviceId: string, missionId: number, callback: A ``` -## missionManager.getLowResolutionMissionSnapShot +## missionManager.getLowResolutionMissionSnapShot9+ getLowResolutionMissionSnapShot(deviceId: string, missionId: number): Promise\; -- GitLab