提交 c2cf6445 编写于 作者: Y yuyaozhi

Fix master branch document problems of ability

Signed-off-by: Nyuyaozhi <yuyaozhi@huawei.com>
上级 7b0ee367
...@@ -19,7 +19,7 @@ Caller及Callee功能如下:具体的API详见[接口文档](../reference/apis ...@@ -19,7 +19,7 @@ Caller及Callee功能如下:具体的API详见[接口文档](../reference/apis
|接口名|描述| |接口名|描述|
|:------|:------| |:------|:------|
|startAbilityByCall(want: Want): Promise\<Caller>|获取指定通用组件的Caller通信接口,拉起指定通用组件并将其切换到后台。| |startAbilityByCall(want: Want): Promise\<Caller>|获取指定通用组件的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方法。| |off(method: string): void|通用组件Callee去注册method的callback方法。|
|call(method: string, data: rpc.Sequenceable): Promise\<void>|向通用组件Callee发送约定序列化数据。| |call(method: string, data: rpc.Sequenceable): Promise\<void>|向通用组件Callee发送约定序列化数据。|
|callWithResult(method: string, data: rpc.Sequenceable): Promise\<rpc.MessageParcel>|向通用组件Callee发送约定序列化数据, 并将返回的约定序列化数据带回。| |callWithResult(method: string, data: rpc.Sequenceable): Promise\<rpc.MessageParcel>|向通用组件Callee发送约定序列化数据, 并将返回的约定序列化数据带回。|
......
...@@ -984,7 +984,7 @@ context.getHapModuleInfo().then((data) => { ...@@ -984,7 +984,7 @@ context.getHapModuleInfo().then((data) => {
## Context.getAppVersionInfo<sup>7+</sup> ## Context.getAppVersionInfo<sup>7+</sup>
getAppVersionInfo(callback: AsyncCallback<AppVersionInfo>): void getAppVersionInfo(callback: AsyncCallback\<AppVersionInfo>): void
获取应用的版本信息(callback形式)。 获取应用的版本信息(callback形式)。
......
...@@ -46,7 +46,7 @@ want操作的常数。 ...@@ -46,7 +46,7 @@ want操作的常数。
| ACTION_FILE_SELECT<sup>7+</sup> | ohos.action.fileSelect | 指示选择文件的操作。 | | ACTION_FILE_SELECT<sup>7+</sup> | ohos.action.fileSelect | 指示选择文件的操作。 |
| PARAMS_STREAM<sup>7+</sup> | ability.params.stream | 指示与连接发送数据一起使用时,包含与意图相关联的数据流的URI。 | | PARAMS_STREAM<sup>7+</sup> | ability.params.stream | 指示与连接发送数据一起使用时,包含与意图相关联的数据流的URI。 |
| ACTION_APP_ACCOUNT_OAUTH <sup>8+</sup> | ohos.account.appAccount.action.oauth | 指示提供oauth服务的操作。 | | ACTION_APP_ACCOUNT_OAUTH <sup>8+</sup> | ohos.account.appAccount.action.oauth | 指示提供oauth服务的操作。 |
| ACTION_MARKER_DOWNLOAD <sup>9+</sup> | ohos.want.action.marketDownload | 表示从应用程序市场下载应用程序的的操作。 | | ACTION_MARKER_DOWNLOAD <sup>9+</sup> | ohos.want.action.marketDownload | 表示从应用程序市场下载应用程序的的操作。<br>**系统API**:该接口为系统接口,三方应用不支持调用。 |
## wantConstant.Entity ## wantConstant.Entity
......
...@@ -654,7 +654,7 @@ abilityDelegator.printSync(msg); ...@@ -654,7 +654,7 @@ abilityDelegator.printSync(msg);
### print<sup>9+</sup> ### print
print(msg: string, callback: AsyncCallback\<void>): void print(msg: string, callback: AsyncCallback\<void>): void
...@@ -683,7 +683,7 @@ abilityDelegator.print(msg, (err : any) => { ...@@ -683,7 +683,7 @@ abilityDelegator.print(msg, (err : any) => {
### print<sup>9+</sup> ### print
print(msg: string): Promise\<void> print(msg: string): Promise\<void>
......
...@@ -11,7 +11,7 @@ AbilityLifecycleCallback模块提供应用上下文ApplicationContext的生命 ...@@ -11,7 +11,7 @@ AbilityLifecycleCallback模块提供应用上下文ApplicationContext的生命
## 导入模块 ## 导入模块
```js ```js
import AbilityLifecycleCallback from "@ohos.application.abilityLifecycleCallback"; import AbilityLifecycleCallback from "@ohos.application.AbilityLifecycleCallback";
``` ```
......
...@@ -23,3 +23,5 @@ import Configuration from '@ohos.application.Configuration'; ...@@ -23,3 +23,5 @@ import Configuration from '@ohos.application.Configuration';
| direction<sup>9+</sup> | Direction | 是 | 否 | 表示屏幕方向,取值范围:水平方向(DIRECTION_HORIZONTAL),垂直方向(DIRECTION_VERTICAL)。 | | direction<sup>9+</sup> | Direction | 是 | 否 | 表示屏幕方向,取值范围:水平方向(DIRECTION_HORIZONTAL),垂直方向(DIRECTION_VERTICAL)。 |
| screenDensity<sup>9+</sup> | ScreenDensity | 是 | 否 | 表示屏幕分辨率,取值范围:SCREEN_DENSITY_SDPI(120)、SCREEN_DENSITY_MDPI(160)、SCREEN_DENSITY_LDPI(240)、SCREEN_DENSITY_XLDPI(320)、SCREEN_DENSITY_XXLDPI(480)、SCREEN_DENSITY_XXXLDPI(640)。 | | screenDensity<sup>9+</sup> | ScreenDensity | 是 | 否 | 表示屏幕分辨率,取值范围:SCREEN_DENSITY_SDPI(120)、SCREEN_DENSITY_MDPI(160)、SCREEN_DENSITY_LDPI(240)、SCREEN_DENSITY_XLDPI(320)、SCREEN_DENSITY_XXLDPI(480)、SCREEN_DENSITY_XXXLDPI(640)。 |
| displayId<sup>9+</sup> | number | 是 | 否 | 表示应用所在的displayId。 | | displayId<sup>9+</sup> | number | 是 | 否 | 表示应用所在的displayId。 |
| hasPointerDevice<sup>9+</sup> | boolean | 是 | 否 | 指示指针类型设备是否已连接。 |
...@@ -685,7 +685,7 @@ delete(uri: string, predicates?: dataAbility.DataAbilityPredicates): Promise\<nu ...@@ -685,7 +685,7 @@ delete(uri: string, predicates?: dataAbility.DataAbilityPredicates): Promise\<nu
```js ```js
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility'
import ohos_data_ability from '@ohos.dataAbility' import ohos_data_ability from '@ohos.data.dataAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper( var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
...@@ -825,7 +825,7 @@ DAHelper.query( ...@@ -825,7 +825,7 @@ DAHelper.query(
## DataAbilityHelper.query ## DataAbilityHelper.query
query(uri: string, columns?: Array<string>, predicates?: dataAbility.DataAbilityPredicates): Promise\<ResultSet>; query(uri: string, columns?: Array\<string>, predicates?: dataAbility.DataAbilityPredicates): Promise\<ResultSet>;
查询数据库中的数据(Promise形式)。 查询数据库中的数据(Promise形式)。
...@@ -932,6 +932,77 @@ dataAbilityHelper.call("dataability:///com.example.jsapidemo.UserDataAbility", " ...@@ -932,6 +932,77 @@ dataAbilityHelper.call("dataability:///com.example.jsapidemo.UserDataAbility", "
console.info('Operation succeeded: ' + data); console.info('Operation succeeded: ' + data);
}); });
``` ```
## DataAbilityHelper.executeBatch
executeBatch(uri: string, operations: Array\<DataAbilityOperation>, callback: AsyncCallback\<Array\<DataAbilityResult>>): void;
查询数据库中的数据。
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| ---------- | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指定待处理的DataAbility。例:"dataability:///com.example.xxx.xxxx"。|
| operations | Array\<[DataAbilityOperation](#dataabilityoperation)> | 是 | 指示数据操作列表,其中可以包含对数据库的多个操作。 |
| callback | AsyncCallback\<Array\<[DataAbilityResult](#dataabilityresult)>> | 是 |在数组 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\<DataAbilityOperation>): Promise\<Array\<DataAbilityResult>>;
查询数据库中的数据。
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| ---------- | -------------------------------| ---- | ------------------------------------------------ |
| uri | string | 是 | 指定待处理的DataAbility。例:"dataability:///com.example.xxx.xxxx"。|
| operations | Array\<[DataAbilityOperation](#dataabilityoperation)> | 是 | 指示数据操作列表,其中可以包含对数据库的多个操作。 |
**返回值:**
| 类型 | 说明 |
|------ | ------- |
|Promise\<Array\<[DataAbilityResult](#dataabilityresult)>> | 在数组 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 ## PacMap
[key: string]: number | string | boolean | Array\<string | number | boolean> | null; [key: string]: number | string | boolean | Array\<string | number | boolean> | null;
...@@ -940,4 +1011,28 @@ dataAbilityHelper.call("dataability:///com.example.jsapidemo.UserDataAbility", " ...@@ -940,4 +1011,28 @@ dataAbilityHelper.call("dataability:///com.example.jsapidemo.UserDataAbility", "
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| ------ | ------ | ------ | ------ | | ------ | ------ | ------ | ------ |
| [key: string] | number \| string \| boolean \| Array\<string \| number \| boolean\> \| null | Yes| 数据存储在键值对中。| | [key: string] | number \| string \| boolean \| Array\<string \| number \| boolean\> \| null | Yes| 数据存储在键值对中。|
\ No newline at end of file
## 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\<number, number> | 是 | 否 | 否 | 指示用作谓词中筛选条件的反向引用。 |
| 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
...@@ -362,7 +362,7 @@ getMissionSnapShot(deviceId: string, missionId: number): Promise&lt;MissionSnaps ...@@ -362,7 +362,7 @@ getMissionSnapShot(deviceId: string, missionId: number): Promise&lt;MissionSnaps
}); });
``` ```
## missionManager.getLowResolutionMissionSnapShot ## missionManager.getLowResolutionMissionSnapShot<sup>9+</sup>
getLowResolutionMissionSnapShot(deviceId: string, missionId: number, callback: AsyncCallback\<MissionSnapshot>): void; getLowResolutionMissionSnapShot(deviceId: string, missionId: number, callback: AsyncCallback\<MissionSnapshot>): void;
...@@ -401,7 +401,7 @@ getLowResolutionMissionSnapShot(deviceId: string, missionId: number, callback: A ...@@ -401,7 +401,7 @@ getLowResolutionMissionSnapShot(deviceId: string, missionId: number, callback: A
``` ```
## missionManager.getLowResolutionMissionSnapShot ## missionManager.getLowResolutionMissionSnapShot<sup>9+</sup>
getLowResolutionMissionSnapShot(deviceId: string, missionId: number): Promise\<MissionSnapshot>; getLowResolutionMissionSnapShot(deviceId: string, missionId: number): Promise\<MissionSnapshot>;
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册