未验证 提交 7924cf04 编写于 作者: O openharmony_ci 提交者: Gitee

!12785 DataAbility相关资料说明修复

Merge pull request !12785 from dy/update_1220
# AbilityResult # AbilityResult
定义Ability拉起、销毁之后返回的结果码和数据,可以通过[startAbilityForResult](js-apis-ability-context.md#abilitycontextstartabilityforresult)获取对端Ability销毁后返回的AbilityResult对象,被startAbilityForResult拉起的Ability对象可以通过[terminateSelfWithResult](js-apis-ability-context.md#abilitycontextterminateselfwithresult)返回AbilityResult对象。 定义Ability被拉起并退出后返回的结果码和数据,可以通过[startAbilityForResult](js-apis-ability-context.md#abilitycontextstartabilityforresult)获取被拉起Ability退出后返回的AbilityResult对象,被startAbilityForResult拉起的Ability对象可以通过[terminateSelfWithResult](js-apis-ability-context.md#abilitycontextterminateselfwithresult)返回AbilityResult对象。
> **说明:** > **说明:**
> >
...@@ -10,6 +10,6 @@ ...@@ -10,6 +10,6 @@
| 名称 | 可读 | 可写 | 类型 | 必填 | 说明 | | 名称 | 可读 | 可写 | 类型 | 必填 | 说明 |
| ----------- | -------- |-------- | -------------------- | ---- | ------------------------------------------------------------ | | ----------- | -------- |-------- | -------------------- | ---- | ------------------------------------------------------------ |
| resultCode | 是 | 否 | number | 是 | 表示ability拉起、销毁之后返回的结果码。 | | resultCode | 是 | 是 | number | 是 | 表示Ability被拉起并退出后返回的结果码。 |
| want | 是 | 否 | [Want](./js-apis-app-ability-want.md) | 否 | 表示ability销毁之后返回的数据。 | | want | 是 | 是 | [Want](./js-apis-app-ability-want.md) | 否 | 表示Ability被拉起并退出后返回的数据。 |
# ConnectOptions # ConnectOptions
在连接指定的后台服务时作为入参用于接收连接过程中的状态变化,如作为[connectServiceExtensionAbility](js-apis-inner-application-serviceExtensionContext.md#serviceextensioncontextconnectserviceextensionability)的入参连接指定的ServiceExtensionAbility。 在连接指定的后台服务时作为入参,用于接收连接过程中的状态变化,如作为[connectServiceExtensionAbility](js-apis-inner-application-uiAbilityContext.md#uiabilitycontextconnectserviceextensionability)的入参,连接指定的ServiceExtensionAbility。
**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core **系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
......
...@@ -11,15 +11,15 @@ ...@@ -11,15 +11,15 @@
使用前根据具体情况引入如下模块 使用前根据具体情况引入如下模块
```ts ```ts
import ohos_data_ability from '@ohos.data.dataAbility' import ohos_data_ability from '@ohos.data.dataAbility';
import ohos_data_rdb from '@ohos.data.rdb' import ohos_data_rdb from '@ohos.data.rdb';
``` ```
## DataAbilityHelper.openFile ## DataAbilityHelper.openFile
openFile(uri: string, mode: string, callback: AsyncCallback\<number>): void openFile(uri: string, mode: string, callback: AsyncCallback\<number>): void
在指定的远程路径中打开文件(callback形式)。 打开指定uri对应的文件,返回文件描述符(callback形式)。
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
...@@ -27,20 +27,20 @@ openFile(uri: string, mode: string, callback: AsyncCallback\<number>): void ...@@ -27,20 +27,20 @@ openFile(uri: string, mode: string, callback: AsyncCallback\<number>): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | ---------------------------------- | | -------- | ---------------------- | ---- | ---------------------------------- |
| uri | string | 是 | 指示要打开的文件的路径。 | | uri | string | 是 | 指示待打开文件的uri。 |
| mode | string | 是 | 指示文件打开模式‘rwt’。 | | mode | string | 是 | 指示文件打开模式,可以设置为‘r’表示只读访问,‘w’表示只写访问,‘rw’表示读写访问等。 |
| callback | AsyncCallback\<number> | 是 | 被指定的回调方法,返回文件说明符。 | | callback | AsyncCallback\<number> | 是 | 指示文件打开的回调方法,返回文件描述符。 |
**示例:** **示例:**
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility';
var DAHelper = featureAbility.acquireDataAbilityHelper( var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
var mode = "rwt"; var mode = "rw";
DAHelper.openFile("dataability:///com.example.DataAbility", mode, (err) => { DAHelper.openFile("dataability:///com.example.DataAbility", mode, (err, data) => {
console.info("==========================>Called=======================>"); console.info("openFile err: " + JSON.stringify(err) + "data: " + JSON.stringify(data));
}); });
``` ```
...@@ -48,7 +48,7 @@ DAHelper.openFile("dataability:///com.example.DataAbility", mode, (err) => { ...@@ -48,7 +48,7 @@ DAHelper.openFile("dataability:///com.example.DataAbility", mode, (err) => {
openFile(uri: string, mode: string): Promise\<number> openFile(uri: string, mode: string): Promise\<number>
在指定的远程路径中打开文件(promise形式)。 打开指定uri对应的文件,返回文件描述符(promise形式)。
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
...@@ -56,8 +56,8 @@ openFile(uri: string, mode: string): Promise\<number> ...@@ -56,8 +56,8 @@ openFile(uri: string, mode: string): Promise\<number>
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------------------ | | ---- | ------ | ---- | ------------------------ |
| uri | string | 是 | 指示要打开的文件的路径。 | | uri | string | 是 | 指示待打开文件的uri。 |
| mode | string | 是 | 指示文件打开模式‘rwt’。 | | mode | string | 是 | 指示文件打开模式,可以设置为‘r’表示只读访问,‘w’表示只写访问,‘rw’表示读写访问等。 |
**返回值:** **返回值:**
...@@ -68,13 +68,13 @@ openFile(uri: string, mode: string): Promise\<number> ...@@ -68,13 +68,13 @@ openFile(uri: string, mode: string): Promise\<number>
**示例:** **示例:**
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility';
var DAHelper = featureAbility.acquireDataAbilityHelper( var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
var mode = "rwt"; var mode = "rw";
DAHelper.openFile("dataability:///com.example.DataAbility", mode).then((data) => { DAHelper.openFile("dataability:///com.example.DataAbility", mode).then((data) => {
console.info("==========================>openFileCallback=======================>"); console.info("openFile data: " + JSON.stringify(data));
}); });
``` ```
...@@ -82,7 +82,7 @@ DAHelper.openFile("dataability:///com.example.DataAbility", mode).then((data) => ...@@ -82,7 +82,7 @@ DAHelper.openFile("dataability:///com.example.DataAbility", mode).then((data) =>
on(type: 'dataChange', uri: string, callback: AsyncCallback\<void>): void on(type: 'dataChange', uri: string, callback: AsyncCallback\<void>): void
注册观察者以观察给定uri指定的数据callback通知。 注册观察者以监听uri指定数据的数据变化通知。
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
...@@ -90,32 +90,32 @@ on(type: 'dataChange', uri: string, callback: AsyncCallback\<void>): void ...@@ -90,32 +90,32 @@ on(type: 'dataChange', uri: string, callback: AsyncCallback\<void>): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------ | | -------- | -------------------- | ---- | ------------------------ |
| type | string | 是 | 数据更改。 | | type | string | 是 | 指示监听操作类型,"dataChange"表示数据变化操作。 |
| uri | string | 是 | 指示要操作的数据的路径。 | | uri | string | 是 | 指示待监听数据变化的uri。 |
| callback | AsyncCallback\<void> | 是 | 指示数据更改时的回调。 | | callback | AsyncCallback\<void> | 是 | 指示数据变化时的回调方法。 |
**示例:** **示例:**
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility';
var helper = featureAbility.acquireDataAbilityHelper( var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
function onChangeNotify() { function onChangeNotify() {
console.info("==========================>onChangeNotify=======================>"); console.info("onChangeNotify call back");
}; };
helper.on( DAHelper.on(
"dataChange", "dataChange",
"dataability:///com.example.DataAbility", "dataability:///com.example.DataAbility",
onChangeNotify onChangeNotify
) );
``` ```
## DataAbilityHelper.off ## DataAbilityHelper.off
off(type: 'dataChange', uri: string, callback?: AsyncCallback\<void>): void off(type: 'dataChange', uri: string, callback?: AsyncCallback\<void>): void
注消观察者以停止观察给定uri指定的数据callback通知。 注消观察者以停止监听uri指定数据的数据变化通知。
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
...@@ -123,36 +123,36 @@ off(type: 'dataChange', uri: string, callback?: AsyncCallback\<void>): void ...@@ -123,36 +123,36 @@ off(type: 'dataChange', uri: string, callback?: AsyncCallback\<void>): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------ | | -------- | -------------------- | ---- | ------------------------ |
| type | string | 是 | 数据更改。 | | type | string | 是 | 指示监听操作类型,"dataChange"表示数据变化操作。 |
| uri | string | 是 | 指示要操作的数据的路径。 | | uri | string | 是 | 指示待取消监听数据变化的uri。 |
| callback | AsyncCallback\<void> | 否 | 指示已注册的回调。 | | callback | AsyncCallback\<void> | 否 | 指示已注册的数据变化回调方法。如果设置数据变化回调为空,将会取消所有数据变化监听。 |
**示例:** **示例:**
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility';
var helper = featureAbility.acquireDataAbilityHelper( var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
function onChangeNotify() { function onChangeNotify() {
console.info("==========================>onChangeNotify=======================>"); console.info("onChangeNotify call back");
}; };
helper.off( DAHelper.off(
"dataChange", "dataChange",
"dataability:///com.example.DataAbility", "dataability:///com.example.DataAbility",
) onChangeNotify
helper.off( );
DAHelper.off(
"dataChange", "dataChange",
"dataability:///com.example.DataAbility", "dataability:///com.example.DataAbility",
onChangeNotify );
)
``` ```
## DataAbilityHelper.getType ## DataAbilityHelper.getType
getType(uri: string, callback: AsyncCallback\<string>): void getType(uri: string, callback: AsyncCallback\<string>): void
获取给定URI指定数据的MIME类型(callback形式)。 获取给定uri指向数据的媒体资源类型(callback形式)。
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
...@@ -160,18 +160,18 @@ getType(uri: string, callback: AsyncCallback\<string>): void ...@@ -160,18 +160,18 @@ getType(uri: string, callback: AsyncCallback\<string>): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | --------------------------------------------- | | -------- | ---------------------- | ---- | --------------------------------------------- |
| uri | string | 是 | 指示要操作的数据的路径。 | | uri | string | 是 | 指示待获取数据的uri。 |
| callback | AsyncCallback\<string> | 是 | 回调方法,返回与uri指定的数据匹配的MIME类型。 | | callback | AsyncCallback\<string> | 是 | 指示获取媒体资源类型的回调方法,返回与uri指向数据匹配的媒体资源类型。 |
**示例:** **示例:**
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility';
var DAHelper = featureAbility.acquireDataAbilityHelper( var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
DAHelper.getType("dataability:///com.example.DataAbility", (err, data) => { DAHelper.getType("dataability:///com.example.DataAbility", (err, data) => {
console.info("==========================>Called=======================>"); console.info("getType err: " + JSON.stringify(err) + "data: " + JSON.stringify(data));
}); });
``` ```
...@@ -179,7 +179,7 @@ DAHelper.getType("dataability:///com.example.DataAbility", (err, data) => { ...@@ -179,7 +179,7 @@ DAHelper.getType("dataability:///com.example.DataAbility", (err, data) => {
getType(uri: string): Promise\<string> getType(uri: string): Promise\<string>
获取给定URI指定数据的MIME类型(Promise形式)。 获取给定uri指向数据的媒体资源类型(Promise形式)。
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
...@@ -187,23 +187,23 @@ getType(uri: string): Promise\<string> ...@@ -187,23 +187,23 @@ getType(uri: string): Promise\<string>
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------------------ | | ---- | ------ | ---- | ------------------------ |
| uri | string | 是 | 指示要操作的数据的路径。 | | uri | string | 是 | 指示待获取数据的uri。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | ----------------------------------- | | ---------------- | ----------------------------------- |
| Promise\<string> | 返回与uri指定的数据匹配的MIME类型。 | | Promise\<string> | 返回与uri指向数据匹配的媒体资源类型。 |
**示例:** **示例:**
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility';
var DAHelper = featureAbility.acquireDataAbilityHelper( var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
DAHelper.getType("dataability:///com.example.DataAbility").then((data) => { DAHelper.getType("dataability:///com.example.DataAbility").then((data) => {
console.info("==========================>getTypeCallback=======================>"); console.info("getType data: " + JSON.stringify(data));
}); });
``` ```
...@@ -211,7 +211,7 @@ DAHelper.getType("dataability:///com.example.DataAbility").then((data) => { ...@@ -211,7 +211,7 @@ DAHelper.getType("dataability:///com.example.DataAbility").then((data) => {
getFileTypes(uri: string, mimeTypeFilter: string, callback: AsyncCallback<Array\<string>>): void getFileTypes(uri: string, mimeTypeFilter: string, callback: AsyncCallback<Array\<string>>): void
获取支持的文件的MIME类型(callback形式)。 获取支持的文件媒体资源类型(callback形式)。
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
...@@ -219,30 +219,27 @@ getFileTypes(uri: string, mimeTypeFilter: string, callback: AsyncCallback<Array\ ...@@ -219,30 +219,27 @@ getFileTypes(uri: string, mimeTypeFilter: string, callback: AsyncCallback<Array\
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------------- | ------------------------------ | ---- | ---------------------------------- | | -------------- | ------------------------------ | ---- | ---------------------------------- |
| uri | string | 是 | 指示要获取的文件的路径。 | | uri | string | 是 | 指示待获取文件的uri。 |
| mimeTypeFilter | string | 是 | 指示要获取的文件的MIME类型。 | | mimeTypeFilter | string | 是 | 指示待获取文件的媒体资源类型。 |
| callback | AsyncCallback\<Array\<string>> | 是 | 回调方法,返回匹配的MIME类型数组。 | | callback | AsyncCallback\<Array\<string>> | 是 | 指示获取媒体资源类型的回调方法,返回匹配的媒体资源类型数组。 |
**示例:** **示例:**
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility';
var DAHelper = featureAbility.acquireDataAbilityHelper( var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
DAHelper.getFileTypes( "dataability:///com.example.DataAbility", DAHelper.getFileTypes( "dataability:///com.example.DataAbility", "image/*", (err, data) => {
"image/*", (err, data) => { console.info("getFileTypes err: " + JSON.stringify(err) + "data: " + JSON.stringify(data));
console.info("==========================>Called=======================>");
}); });
``` ```
## DataAbilityHelper.getFileTypes ## DataAbilityHelper.getFileTypes
getFileTypes(uri: string, mimeTypeFilter: string): Promise\<Array\<string>> getFileTypes(uri: string, mimeTypeFilter: string): Promise\<Array\<string>>
获取支持的文件的MIME类型(Promise形式)。 获取支持的文件媒体资源类型(Promise形式)。
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
...@@ -250,25 +247,24 @@ getFileTypes(uri: string, mimeTypeFilter: string): Promise\<Array\<string>> ...@@ -250,25 +247,24 @@ getFileTypes(uri: string, mimeTypeFilter: string): Promise\<Array\<string>>
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------------- | ------ | ---- | ---------------------------- | | -------------- | ------ | ---- | ---------------------------- |
| uri | string | 是 | 指示要获取的文件的路径。 | | uri | string | 是 | 指示待获取文件的uri。 |
| mimeTypeFilter | string | 是 | 指示要获取的文件的MIME类型。 | | mimeTypeFilter | string | 是 | 指示待获取文件的媒体资源类型。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------ | ------------------------ | | ------------------------ | ------------------------ |
| Promise\<Array\<string>> | 返回匹配的MIME类型数组。 | | Promise\<Array\<string>> | 返回匹配的媒体资源类型数组。 |
**示例:** **示例:**
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility';
var DAHelper = featureAbility.acquireDataAbilityHelper( var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
DAHelper.getFileTypes("dataability:///com.example.DataAbility", DAHelper.getFileTypes("dataability:///com.example.DataAbility", "image/*").then((data) => {
"image/*").then((data) => { console.info("getFileTypes data: " + JSON.stringify(data));
console.info("===================>getFileTypesCallback================>");
}); });
``` ```
...@@ -285,17 +281,17 @@ normalizeUri(uri: string, callback: AsyncCallback\<string>): void ...@@ -285,17 +281,17 @@ normalizeUri(uri: string, callback: AsyncCallback\<string>): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------- | ---- | ------------------------------------------------------------ |
| uri | string | 是 | 指示要规范化的uri对象。 | | uri | string | 是 | 指示要规范化的uri对象。 |
| callback | AsyncCallback\<string> | 是 | 回调方法。如果数据功能支持uri规范化,则返回规范化uri对象;否则返回null。 | | callback | AsyncCallback\<string> | 是 | 指示uri规范化的回调方法。如果数据功能支持uri规范化,则返回规范化uri对象;否则返回null。 |
**示例:** **示例:**
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility';
var DAHelper = featureAbility.acquireDataAbilityHelper( var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
DAHelper.normalizeUri("dataability:///com.example.DataAbility", (err, data) => { DAHelper.normalizeUri("dataability:///com.example.DataAbility", (err, data) => {
console.info("==========================>Called=======================>"); console.info("normalizeUri err: " + JSON.stringify(err) + "data: " + JSON.stringify(data));
}); });
``` ```
...@@ -322,12 +318,12 @@ normalizeUri(uri: string): Promise\<string> ...@@ -322,12 +318,12 @@ normalizeUri(uri: string): Promise\<string>
**示例:** **示例:**
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility';
var DAHelper = featureAbility.acquireDataAbilityHelper( var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
DAHelper.normalizeUri("dataability:///com.example.DataAbility",).then((data) => { DAHelper.normalizeUri("dataability:///com.example.DataAbility",).then((data) => {
console.info("=================>normalizeUriCallback=======================>"); console.info("normalizeUri data: " + JSON.stringify(data));
}); });
``` ```
...@@ -343,23 +339,21 @@ denormalizeUri(uri: string, callback: AsyncCallback\<string>): void ...@@ -343,23 +339,21 @@ denormalizeUri(uri: string, callback: AsyncCallback\<string>): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | --------------------------------------------------- | | -------- | ---------------------- | ---- | --------------------------------------------------- |
| uri | string | 是 | 指示要规范化的uri对象。 | | uri | string | 是 | 指示要规范化的uri对象。 |
| callback | AsyncCallback\<string> | 是 | 回调方法。如果反规范化成功,则返回反规范化uri对象。 | | callback | AsyncCallback\<string> | 是 | 指示反规范化uri的回调方法。如果反规范化成功,则返回反规范化uri对象。 |
**示例:** **示例:**
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility';
var DAHelper = featureAbility.acquireDataAbilityHelper( var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
DAHelper.denormalizeUri("dataability:///com.example.DataAbility", (err, data) => { DAHelper.denormalizeUri("dataability:///com.example.DataAbility", (err, data) => {
console.info("==========================>Called=======================>"); console.info("denormalizeUri err: " + JSON.stringify(err) + "data: " + JSON.stringify(data));
}); });
``` ```
## DataAbilityHelper.denormalizeUri ## DataAbilityHelper.denormalizeUri
denormalizeUri(uri: string): Promise\<string> denormalizeUri(uri: string): Promise\<string>
...@@ -383,12 +377,12 @@ denormalizeUri(uri: string): Promise\<string> ...@@ -383,12 +377,12 @@ denormalizeUri(uri: string): Promise\<string>
**示例:** **示例:**
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility';
var DAHelper = featureAbility.acquireDataAbilityHelper( var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
DAHelper.denormalizeUri("dataability:///com.example.DataAbility",).then((data) => { DAHelper.denormalizeUri("dataability:///com.example.DataAbility",).then((data) => {
console.info("===============>denormalizeUriCallback=======================>"); console.info("denormalizeUri data: " + JSON.stringify(data));
}); });
``` ```
...@@ -396,7 +390,7 @@ DAHelper.denormalizeUri("dataability:///com.example.DataAbility",).then((data) = ...@@ -396,7 +390,7 @@ DAHelper.denormalizeUri("dataability:///com.example.DataAbility",).then((data) =
notifyChange(uri: string, callback: AsyncCallback\<void>): void notifyChange(uri: string, callback: AsyncCallback\<void>): void
通知已注册的观察者uri指定的数据资源的更改(callback形式)。 通知注册的观察者,uri指定数据的数据变化(callback形式)。
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
...@@ -404,17 +398,17 @@ notifyChange(uri: string, callback: AsyncCallback\<void>): void ...@@ -404,17 +398,17 @@ notifyChange(uri: string, callback: AsyncCallback\<void>): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------ | | -------- | -------------------- | ---- | ------------------------ |
| uri | string | 是 | 指示要操作的数据的路径。 | | uri | string | 是 | 指示数据变化的uri。 |
| callback | AsyncCallback\<void> | 是 | 回调方法。 | | callback | AsyncCallback\<void> | 是 | 回调方法。 |
**示例:** **示例:**
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility';
var helper = featureAbility.acquireDataAbilityHelper( var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
helper.notifyChange("dataability:///com.example.DataAbility", (err) => { DAHelper.notifyChange("dataability:///com.example.DataAbility", (err) => {
console.info("==========================>Called=======================>"); console.info("==========================>Called=======================>");
}); });
``` ```
...@@ -423,7 +417,7 @@ helper.notifyChange("dataability:///com.example.DataAbility", (err) => { ...@@ -423,7 +417,7 @@ helper.notifyChange("dataability:///com.example.DataAbility", (err) => {
notifyChange(uri: string): Promise\<void> notifyChange(uri: string): Promise\<void>
通知已注册的观察者uri指定的数据资源的更改(Promise形式)。 通知注册的观察者,uri指定数据的数据变化(Promise形式)。
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
...@@ -431,7 +425,7 @@ notifyChange(uri: string): Promise\<void> ...@@ -431,7 +425,7 @@ notifyChange(uri: string): Promise\<void>
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------------------ | | ---- | ------ | ---- | ------------------------ |
| uri | string | 是 | 指示要操作的数据的路径。 | | uri | string | 是 | 指示数据变化的uri。 |
**返回值:** **返回值:**
...@@ -442,7 +436,7 @@ notifyChange(uri: string): Promise\<void> ...@@ -442,7 +436,7 @@ notifyChange(uri: string): Promise\<void>
**示例:** **示例:**
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility';
var DAHelper = featureAbility.acquireDataAbilityHelper( var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
...@@ -463,14 +457,14 @@ insert(uri: string, valuesBucket: rdb.ValuesBucket, callback: AsyncCallback\<num ...@@ -463,14 +457,14 @@ insert(uri: string, valuesBucket: rdb.ValuesBucket, callback: AsyncCallback\<num
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------ | ---------------------- | ---- | ------------------------------------------------------ | | ------------ | ---------------------- | ---- | ------------------------------------------------------ |
| uri | string | 是 | 指示要插入的数据的路径。 | | uri | string | 是 | 指示要插入数据的uri。 |
| valuesBucket | rdb.ValuesBucket | 是 | 指示要插入的数据记录。如果此参数为空,将插入一个空行。 | | valuesBucket | rdb.ValuesBucket | 是 | 指示要插入的数据记录。如果此参数为空,将插入一个空行。 |
| callback | AsyncCallback\<number> | 是 | 回调方法,返回插入数据记录的索引。 | | callback | AsyncCallback\<number> | 是 | 指示数据插入的回调方法,返回插入数据记录的索引。 |
**示例:** **示例:**
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility';
var DAHelper = featureAbility.acquireDataAbilityHelper( var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
...@@ -479,10 +473,9 @@ const valueBucket = { ...@@ -479,10 +473,9 @@ const valueBucket = {
"age": 22, "age": 22,
"salary": 200.5, "salary": 200.5,
"blobType": "u8", "blobType": "u8",
} };
DAHelper.insert("dataability:///com.example.DataAbility", valueBucket, DAHelper.insert("dataability:///com.example.DataAbility", valueBucket, (err, data) => {
(err, data) => { console.info("insert err: " + JSON.stringify(err) + "data: " + JSON.stringify(data));
console.info("==========================>Called=======================>");
}); });
``` ```
...@@ -498,7 +491,7 @@ insert(uri: string, valuesBucket: rdb.ValuesBucket): Promise\<number> ...@@ -498,7 +491,7 @@ insert(uri: string, valuesBucket: rdb.ValuesBucket): Promise\<number>
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------ | ---------------- | ---- | ------------------------------------------------------ | | ------------ | ---------------- | ---- | ------------------------------------------------------ |
| uri | string | 是 | 指示要插入的数据的路径。 | | uri | string | 是 | 指示要插入数据的uri。 |
| valuesBucket | rdb.ValuesBucket | 是 | 指示要插入的数据记录。如果此参数为空,将插入一个空行。 | | valuesBucket | rdb.ValuesBucket | 是 | 指示要插入的数据记录。如果此参数为空,将插入一个空行。 |
**返回值:** **返回值:**
...@@ -510,7 +503,7 @@ insert(uri: string, valuesBucket: rdb.ValuesBucket): Promise\<number> ...@@ -510,7 +503,7 @@ insert(uri: string, valuesBucket: rdb.ValuesBucket): Promise\<number>
**示例:** **示例:**
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility';
var DAHelper = featureAbility.acquireDataAbilityHelper( var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
...@@ -519,9 +512,9 @@ const valueBucket = { ...@@ -519,9 +512,9 @@ const valueBucket = {
"age": 221, "age": 221,
"salary": 20.5, "salary": 20.5,
"blobType": "u8", "blobType": "u8",
} };
DAHelper.insert("dataability:///com.example.DataAbility", valueBucket).then((data) => { DAHelper.insert("dataability:///com.example.DataAbility", valueBucket).then((data) => {
console.info("====================>insertCallback=======================>"); console.info("insert data: " + JSON.stringify(data));
}); });
``` ```
...@@ -529,7 +522,7 @@ DAHelper.insert("dataability:///com.example.DataAbility", valueBucket).then((dat ...@@ -529,7 +522,7 @@ DAHelper.insert("dataability:///com.example.DataAbility", valueBucket).then((dat
batchInsert(uri: string, valuesBuckets: Array\<rdb.ValuesBucket>, callback: AsyncCallback\<number>): void batchInsert(uri: string, valuesBuckets: Array\<rdb.ValuesBucket>, callback: AsyncCallback\<number>): void
插入数据库(callback形式)。 将多个数据记录插入数据库(callback形式)。
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
...@@ -537,23 +530,22 @@ batchInsert(uri: string, valuesBuckets: Array\<rdb.ValuesBucket>, callback: Asyn ...@@ -537,23 +530,22 @@ batchInsert(uri: string, valuesBuckets: Array\<rdb.ValuesBucket>, callback: Asyn
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------ | ----------------------- | ---- | -------------------------------- | | ------------ | ----------------------- | ---- | -------------------------------- |
| uri | string | 是 | 指示要插入的数据的路径。 | | uri | string | 是 | 指示要插入数据的uri。 |
| valuesBucket | Array\<rdb.ValuesBucket> | 是 | 指示要插入的数据记录。 | | valuesBucket | Array\<rdb.ValuesBucket> | 是 | 指示要插入的数据记录数组。 |
| callback | AsyncCallback\<number> | 是 | 回调方法。返回插入的数据记录数。 | | callback | AsyncCallback\<number> | 是 | 指示批量数据插入的回调方法。返回插入的数据记录数。 |
**示例:** **示例:**
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility';
var DAHelper = featureAbility.acquireDataAbilityHelper( var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
var cars = new Array({"name": "roe11", "age": 21, "salary": 20.5, "blobType": "u8",}, var cars = new Array({"name": "roe11", "age": 21, "salary": 20.5, "blobType": "u8",},
{"name": "roe12", "age": 21, "salary": 20.5, "blobType": "u8",}, {"name": "roe12", "age": 21, "salary": 20.5, "blobType": "u8",},
{"name": "roe13", "age": 21, "salary": 20.5, "blobType": "u8",}) {"name": "roe13", "age": 21, "salary": 20.5, "blobType": "u8",});
DAHelper.batchInsert("dataability:///com.example.DataAbility", cars, DAHelper.batchInsert("dataability:///com.example.DataAbility", cars, (err, data) => {
(err, data) => { console.info("batchInsert err: " + JSON.stringify(err) + "data: " + JSON.stringify(data));
console.info("==========================>Called=======================>");
}); });
``` ```
...@@ -569,8 +561,8 @@ batchInsert(uri: string, valuesBuckets: Array<rdb.ValuesBucket>): Promise\<numbe ...@@ -569,8 +561,8 @@ batchInsert(uri: string, valuesBuckets: Array<rdb.ValuesBucket>): Promise\<numbe
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------ | ----------------------- | ---- | ------------------------ | | ------------ | ----------------------- | ---- | ------------------------ |
| uri | string | 是 | 指示要插入的数据的路径。 | | uri | string | 是 | 指示要插入数据的uri。 |
| valuesBucket | Array<rdb.ValuesBucket> | 是 | 指示要插入的数据记录。 | | valuesBucket | Array<rdb.ValuesBucket> | 是 | 指示要插入的数据记录数组。 |
**返回值:** **返回值:**
...@@ -581,15 +573,15 @@ batchInsert(uri: string, valuesBuckets: Array<rdb.ValuesBucket>): Promise\<numbe ...@@ -581,15 +573,15 @@ batchInsert(uri: string, valuesBuckets: Array<rdb.ValuesBucket>): Promise\<numbe
**示例:** **示例:**
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility';
var DAHelper = featureAbility.acquireDataAbilityHelper( var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility"
); );
var cars = new Array({"name": "roe11", "age": 21, "salary": 20.5, "blobType": "u8",}, var cars = new Array({"name": "roe11", "age": 21, "salary": 20.5, "blobType": "u8",},
{"name": "roe12", "age": 21, "salary": 20.5, "blobType": "u8",}, {"name": "roe12", "age": 21, "salary": 20.5, "blobType": "u8",},
{"name": "roe13", "age": 21, "salary": 20.5, "blobType": "u8",}) {"name": "roe13", "age": 21, "salary": 20.5, "blobType": "u8",});
DAHelper.batchInsert("dataability:///com.example.DataAbility", cars).then((data) => { DAHelper.batchInsert("dataability:///com.example.DataAbility", cars).then((data) => {
console.info("==================>batchInsertCallback=======================>"); console.info("batchInsert data: " + JSON.stringify(data));
}); });
``` ```
...@@ -605,22 +597,21 @@ delete(uri: string, predicates: dataAbility.DataAbilityPredicates, callback: Asy ...@@ -605,22 +597,21 @@ delete(uri: string, predicates: dataAbility.DataAbilityPredicates, callback: Asy
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------ | --------------------------------- | ---- | ------------------------------------------------ | | ------------ | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指示要删除的数据的路径。 | | uri | string | 是 | 指示要删除数据的uri。 |
| predicates | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时,应定义处理逻辑。 | | predicates | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时,应定义处理逻辑。 |
| callback | AsyncCallback\<number> | 是 | 回调方法。返回已删除的数据记录数。 | | callback | AsyncCallback\<number> | 是 | 指示数据删除的回调方法。返回已删除的数据记录数。 |
**示例:** **示例:**
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility';
import ohos_data_ability from '@ohos.data.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"
); );
let da = new ohos_data_ability.DataAbilityPredicates() let da = new ohos_data_ability.DataAbilityPredicates();
DAHelper.delete("dataability:///com.example.DataAbility", da, DAHelper.delete("dataability:///com.example.DataAbility", da, (err, data) => {
(err, data) => { console.info("delete err: " + JSON.stringify(err) + "data: " + JSON.stringify(data));
console.info("==========================>Called=======================>");
}); });
``` ```
...@@ -636,7 +627,7 @@ delete(uri: string, predicates?: dataAbility.DataAbilityPredicates): Promise\<nu ...@@ -636,7 +627,7 @@ delete(uri: string, predicates?: dataAbility.DataAbilityPredicates): Promise\<nu
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------ | --------------------------------- | ---- | ------------------------------------------------ | | ------------ | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指示要删除的数据的路径。 | | uri | string | 是 | 指示要删除数据的uri。 |
| predicates | dataAbility.DataAbilityPredicates | 否 | 指示筛选条件。当此参数为null时,应定义处理逻辑。 | | predicates | dataAbility.DataAbilityPredicates | 否 | 指示筛选条件。当此参数为null时,应定义处理逻辑。 |
**返回值:** **返回值:**
...@@ -648,14 +639,14 @@ delete(uri: string, predicates?: dataAbility.DataAbilityPredicates): Promise\<nu ...@@ -648,14 +639,14 @@ delete(uri: string, predicates?: dataAbility.DataAbilityPredicates): Promise\<nu
**示例:** **示例:**
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility';
import ohos_data_ability from '@ohos.data.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"
); );
let da = new ohos_data_ability.DataAbilityPredicates() let da = new ohos_data_ability.DataAbilityPredicates();
DAHelper.delete("dataability:///com.example.DataAbility", da).then((data) => { DAHelper.delete("dataability:///com.example.DataAbility", da).then((data) => {
console.info("==========================>deleteCallback=======================>"); console.info("delete data: " + JSON.stringify(data));
}); });
``` ```
...@@ -671,16 +662,16 @@ update(uri: string, valuesBucket: rdb.ValuesBucket, predicates: dataAbility.Data ...@@ -671,16 +662,16 @@ update(uri: string, valuesBucket: rdb.ValuesBucket, predicates: dataAbility.Data
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------ | --------------------------------- | ---- | ------------------------------------------------ | | ------------ | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指示要更新的数据的路径。 | | uri | string | 是 | 指示要更新数据的uri。 |
| valuesBucket | rdb.ValuesBucket | 是 | 指示要更新的数据。 | | valuesBucket | rdb.ValuesBucket | 是 | 指示要更新的数据。 |
| predicates | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时,应定义处理逻辑。 | | predicates | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时,应定义处理逻辑。 |
| callback | AsyncCallback\<number> | 是 | 回调方法,返回更新的数据记录数。 | | callback | AsyncCallback\<number> | 是 | 指示数据更新的回调方法,返回更新的数据记录数。 |
**示例:** **示例:**
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility';
import ohos_data_ability from '@ohos.data.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"
); );
...@@ -689,10 +680,10 @@ const va = { ...@@ -689,10 +680,10 @@ const va = {
"age": 21, "age": 21,
"salary": 20.5, "salary": 20.5,
"blobType": "u8", "blobType": "u8",
} };
let da = new ohos_data_ability.DataAbilityPredicates() let da = new ohos_data_ability.DataAbilityPredicates();
DAHelper.update("dataability:///com.example.DataAbility", va, da, (err, data) => { DAHelper.update("dataability:///com.example.DataAbility", va, da, (err, data) => {
console.info("==========================>Called=======================>"); console.info("update err: " + JSON.stringify(err) + "data: " + JSON.stringify(data));
}); });
``` ```
...@@ -708,7 +699,7 @@ update(uri: string, valuesBucket: rdb.ValuesBucket, predicates?: dataAbility.Dat ...@@ -708,7 +699,7 @@ update(uri: string, valuesBucket: rdb.ValuesBucket, predicates?: dataAbility.Dat
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------ | --------------------------------- | ---- | ------------------------------------------------ | | ------------ | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指示要更新的数据的路径。 | | uri | string | 是 | 指示要更新数据的uri。 |
| valuesBucket | rdb.ValuesBucket | 是 | 指示要更新的数据。 | | valuesBucket | rdb.ValuesBucket | 是 | 指示要更新的数据。 |
| predicates | dataAbility.DataAbilityPredicates | 否 | 指示筛选条件。当此参数为null时,应定义处理逻辑。 | | predicates | dataAbility.DataAbilityPredicates | 否 | 指示筛选条件。当此参数为null时,应定义处理逻辑。 |
...@@ -721,8 +712,8 @@ update(uri: string, valuesBucket: rdb.ValuesBucket, predicates?: dataAbility.Dat ...@@ -721,8 +712,8 @@ update(uri: string, valuesBucket: rdb.ValuesBucket, predicates?: dataAbility.Dat
**示例:** **示例:**
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility';
import ohos_data_ability from '@ohos.data.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"
); );
...@@ -731,10 +722,10 @@ const va = { ...@@ -731,10 +722,10 @@ const va = {
"age": 21, "age": 21,
"salary": 20.5, "salary": 20.5,
"blobType": "u8", "blobType": "u8",
} };
let da = new ohos_data_ability.DataAbilityPredicates() let da = new ohos_data_ability.DataAbilityPredicates();
DAHelper.update("dataability:///com.example.DataAbility", va, da).then((data) => { DAHelper.update("dataability:///com.example.DataAbility", va, da).then((data) => {
console.info("==========================>updateCallback=======================>"); console.info("update data: " + JSON.stringify(data));
}); });
``` ```
...@@ -750,23 +741,23 @@ query(uri: string, columns: Array\<string>, predicates: dataAbility.DataAbilityP ...@@ -750,23 +741,23 @@ query(uri: string, columns: Array\<string>, predicates: dataAbility.DataAbilityP
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | --------------------------------- | ---- | ------------------------------------------------ | | ---------- | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指示要查询的数据的路径。 | | uri | string | 是 | 指示要查询数据的uri。 |
| columns | Array\<string> | 是 | 指示要查询的列。如果此参数为空,则查询所有列。 | | columns | Array\<string> | 是 | 指示要查询的列。如果此参数为空,则查询所有列。 |
| predicates | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时,应定义处理逻辑。 | | predicates | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时,应定义处理逻辑。 |
| callback | AsyncCallback\<ResultSet> | 是 | 回调方法,返回查询结果。 | | callback | AsyncCallback\<ResultSet> | 是 | 指示数据查询的回调方法,返回查询结果。 |
**示例:** **示例:**
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility';
import ohos_data_ability from '@ohos.data.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"
); );
var cars=new Array("value1", "value2", "value3", "value4"); var cars=new Array("value1", "value2", "value3", "value4");
let da = new ohos_data_ability.DataAbilityPredicates() let da = new ohos_data_ability.DataAbilityPredicates();
DAHelper.query("dataability:///com.example.DataAbility", cars, da, (err, data) => { DAHelper.query("dataability:///com.example.DataAbility", cars, da, (err, data) => {
console.info("==========================>Called=======================>"); console.info("query err: " + JSON.stringify(err) + "data: " + JSON.stringify(data));
}); });
``` ```
...@@ -784,7 +775,7 @@ query(uri: string, columns?: Array\<string>, predicates?: dataAbility.DataAbilit ...@@ -784,7 +775,7 @@ query(uri: string, columns?: Array\<string>, predicates?: dataAbility.DataAbilit
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | --------------------------------- | ---- | ------------------------------------------------ | | ---------- | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指示要查询的数据的路径。 | | uri | string | 是 | 指示要查询数据的uri。 |
| columns | Array\<string> | 否 | 指示要查询的列。如果此参数为空,则查询所有列。 | | columns | Array\<string> | 否 | 指示要查询的列。如果此参数为空,则查询所有列。 |
| predicates | dataAbility.DataAbilityPredicates | 否 | 指示筛选条件。当此参数为null时,应定义处理逻辑。 | | predicates | dataAbility.DataAbilityPredicates | 否 | 指示筛选条件。当此参数为null时,应定义处理逻辑。 |
...@@ -797,23 +788,23 @@ query(uri: string, columns?: Array\<string>, predicates?: dataAbility.DataAbilit ...@@ -797,23 +788,23 @@ query(uri: string, columns?: Array\<string>, predicates?: dataAbility.DataAbilit
**示例:** **示例:**
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility';
import ohos_data_ability from '@ohos.data.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"
); );
var cars = new Array("value1", "value2", "value3", "value4"); var cars = new Array("value1", "value2", "value3", "value4");
let da = new ohos_data_ability.DataAbilityPredicates() let da = new ohos_data_ability.DataAbilityPredicates();
DAHelper.query("dataability:///com.example.DataAbility", cars, da).then((data) => { DAHelper.query("dataability:///com.example.DataAbility", cars, da).then((data) => {
console.info("==========================>queryCallback=======================>"); console.info("query data: " + JSON.stringify(data));
}); });
``` ```
## DataAbilityHelper.call ## DataAbilityHelper.call
call(uri: string, method: string, arg: string, extras: PacMap): Promise\<PacMap> call(uri: string, method: string, arg: string, extras: PacMap, callback: AsyncCallback\<PacMap>): void
调用DataAbility的扩展接口,使用Promise方式作为异步方法 调用DataAbility的扩展接口(callback形式)
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
...@@ -821,16 +812,11 @@ call(uri: string, method: string, arg: string, extras: PacMap): Promise\<PacMap> ...@@ -821,16 +812,11 @@ call(uri: string, method: string, arg: string, extras: PacMap): Promise\<PacMap>
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | --------------------------------- | ---- | ------------------------------------------------ | | ---------- | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指定待处理的DataAbility。例:"dataability:///com.example.xxx.xxxx" | | uri | string | 是 | 指示待处理的DataAbility。例:"dataability:///com.example.xxx.xxxx" |
| method | string | 是 | 被调用的方法名。 | | method | string | 是 | 指示被调用的方法名。 |
| arg | string | 是 |需传入的参数。 | | arg | string | 是 | 指示需传入的参数。 |
| extras | [PacMap](#pacmap) | 是 | 键值对参数。 | | extras | [PacMap](#pacmap) | 是 | 指示扩展的键值对参数。 |
| callback | AsyncCallback\<[PacMap](#pacmap)> | 是 | 指示数据操作的回调方法,返回操作结果。 |
**返回值:**
| 类型 | 说明 |
|------ | ------- |
|Promise\<[PacMap](#pacmap)> | 调用的返回值。 |
**示例:** **示例:**
...@@ -838,20 +824,23 @@ call(uri: string, method: string, arg: string, extras: PacMap): Promise\<PacMap> ...@@ -838,20 +824,23 @@ call(uri: string, method: string, arg: string, extras: PacMap): Promise\<PacMap>
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
let dataAbilityHelper = featureAbility.acquireDataAbilityHelper( let dataAbilityHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.jsapidemo.UserDataAbility"); "dataability:///com.example.jsapidemo.UserDataAbility"
);
dataAbilityHelper.call("dataability:///com.example.jsapidemo.UserDataAbility", dataAbilityHelper.call("dataability:///com.example.jsapidemo.UserDataAbility",
"method", "arg", {"key1":"value1"}).then((data) => { "method", "arg", {"key1":"value1"}, (err, data) => {
if (err) {
console.error('Operation failed. Cause: ' + err);
return;
}
console.info('Operation succeeded: ' + data); console.info('Operation succeeded: ' + data);
}).catch((error) => {
console.error('Operation failed. Cause: ' + error);
}); });
``` ```
## DataAbilityHelper.call ## DataAbilityHelper.call
call(uri: string, method: string, arg: string, extras: PacMap, callback: AsyncCallback\<PacMap>): void call(uri: string, method: string, arg: string, extras: PacMap): Promise\<PacMap>
调用DataAbility的扩展接口,使用callback方式作为异步方法 调用DataAbility的扩展接口(Promise形式)
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
...@@ -859,11 +848,16 @@ call(uri: string, method: string, arg: string, extras: PacMap, callback: AsyncCa ...@@ -859,11 +848,16 @@ call(uri: string, method: string, arg: string, extras: PacMap, callback: AsyncCa
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | --------------------------------- | ---- | ------------------------------------------------ | | ---------- | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指定待处理的DataAbility。例:"dataability:///com.example.xxx.xxxx" | | uri | string | 是 | 指示待处理的DataAbility。例:"dataability:///com.example.xxx.xxxx" |
| method | string | 是 | 被调用的方法名。 | | method | string | 是 | 指示被调用的方法名。 |
| arg | string | 是 |需传入的参数。 | | arg | string | 是 | 指示需传入的参数。 |
| extras | [PacMap](#pacmap) | 是 | 键值对参数。 | | extras | [PacMap](#pacmap) | 是 | 指示扩展的键值对参数。 |
| callback | AsyncCallback\<[PacMap](#pacmap)> | 是 | 返回值。 |
**返回值:**
| 类型 | 说明 |
|------ | ------- |
|Promise\<[PacMap](#pacmap)> | 返回操作结果。 |
**示例:** **示例:**
...@@ -871,14 +865,13 @@ call(uri: string, method: string, arg: string, extras: PacMap, callback: AsyncCa ...@@ -871,14 +865,13 @@ call(uri: string, method: string, arg: string, extras: PacMap, callback: AsyncCa
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
let dataAbilityHelper = featureAbility.acquireDataAbilityHelper( let dataAbilityHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.jsapidemo.UserDataAbility"); "dataability:///com.example.jsapidemo.UserDataAbility"
);
dataAbilityHelper.call("dataability:///com.example.jsapidemo.UserDataAbility", dataAbilityHelper.call("dataability:///com.example.jsapidemo.UserDataAbility",
"method", "arg", {"key1":"value1"}, (err, data) => { "method", "arg", {"key1":"value1"}).then((data) => {
if (err) {
console.error('Operation failed. Cause: ' + err);
return;
}
console.info('Operation succeeded: ' + data); console.info('Operation succeeded: ' + data);
}).catch((error) => {
console.error('Operation failed. Cause: ' + error);
}); });
``` ```
...@@ -886,17 +879,17 @@ dataAbilityHelper.call("dataability:///com.example.jsapidemo.UserDataAbility", ...@@ -886,17 +879,17 @@ dataAbilityHelper.call("dataability:///com.example.jsapidemo.UserDataAbility",
executeBatch(uri: string, operations: Array\<DataAbilityOperation>, callback: AsyncCallback\<Array\<DataAbilityResult>>): void; executeBatch(uri: string, operations: Array\<DataAbilityOperation>, callback: AsyncCallback\<Array\<DataAbilityResult>>): void;
查询数据库中的数据。 批量操作数据库中的数据。
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | --------------------------------- | ---- | ------------------------------------------------ | | ----------| ---------------------------------| ---- | ------------------------------------------------ |
| uri | string | 是 | 指定待处理的DataAbility。例:"dataability:///com.example.xxx.xxxx"。| | uri | string | 是 | 指示待处理的DataAbility。例:"dataability:///com.example.xxx.xxxx"。|
| operations | Array\<[DataAbilityOperation](js-apis-inner-ability-dataAbilityOperation.md)> | 是 | 指示数据操作列表,其中可以包含对数据库的多个操作。 | | operations | Array\<[DataAbilityOperation](js-apis-inner-ability-dataAbilityOperation.md)> | 是 | 指示数据操作数组,其中可以包含对数据库的多个不同操作。 |
| callback | AsyncCallback\<Array\<[DataAbilityResult](js-apis-inner-ability-dataAbilityResult.md)>> | 是 |在数组 DataAbilityResult中返回每个操作的结果。 | | callback | AsyncCallback\<Array\<[DataAbilityResult](js-apis-inner-ability-dataAbilityResult.md)>> | 是 | 指示批量操作的回调方法,在DataAbilityResult数组中返回每个操作的结果。 |
**示例:** **示例:**
...@@ -906,9 +899,9 @@ import featureAbility from '@ohos.ability.featureAbility'; ...@@ -906,9 +899,9 @@ import featureAbility from '@ohos.ability.featureAbility';
// 根据DataAbilityOperation列表选择要对数据库做的操作 // 根据DataAbilityOperation列表选择要对数据库做的操作
let op=new Array(); let op=new Array();
let dataAbilityHelper = featureAbility.acquireDataAbilityHelper( let dataAbilityHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.jsapidemo.UserDataAbility"); "dataability:///com.example.jsapidemo.UserDataAbility"
dataAbilityHelper.executeBatch("dataability:///com.example.jsapidemo.UserDataAbility", );
op, (err, data) => { dataAbilityHelper.executeBatch("dataability:///com.example.jsapidemo.UserDataAbility", op, (err, data) => {
if (err) { if (err) {
console.error('Operation failed. Cause: ' + err); console.error('Operation failed. Cause: ' + err);
return; return;
...@@ -921,7 +914,7 @@ dataAbilityHelper.executeBatch("dataability:///com.example.jsapidemo.UserDataAbi ...@@ -921,7 +914,7 @@ dataAbilityHelper.executeBatch("dataability:///com.example.jsapidemo.UserDataAbi
executeBatch(uri: string, operations: Array\<DataAbilityOperation>): Promise\<Array\<DataAbilityResult>>; executeBatch(uri: string, operations: Array\<DataAbilityOperation>): Promise\<Array\<DataAbilityResult>>;
查询数据库中的数据。 批量操作数据库中的数据。
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel **系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
...@@ -929,14 +922,14 @@ executeBatch(uri: string, operations: Array\<DataAbilityOperation>): Promise\<Ar ...@@ -929,14 +922,14 @@ executeBatch(uri: string, operations: Array\<DataAbilityOperation>): Promise\<Ar
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | -------------------------------| ---- | ------------------------------------------------ | | ---------- | -------------------------------| ---- | ------------------------------------------------ |
| uri | string | 是 | 指待处理的DataAbility。例:"dataability:///com.example.xxx.xxxx"。| | uri | string | 是 | 指待处理的DataAbility。例:"dataability:///com.example.xxx.xxxx"。|
| operations | Array\<[DataAbilityOperation](js-apis-inner-ability-dataAbilityOperation.md)> | 是 | 指示数据操作列表,其中可以包含对数据库的多个操作。 | | operations | Array\<[DataAbilityOperation](js-apis-inner-ability-dataAbilityOperation.md)> | 是 | 指示数据操作数组,其中可以包含对数据库的多个不同操作。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
|------ | ------- | |------ | ------- |
|Promise\<Array\<[DataAbilityResult](js-apis-inner-ability-dataAbilityResult.md)>> | 在数组 DataAbilityResult中返回每个操作的结果。 | |Promise\<Array\<[DataAbilityResult](js-apis-inner-ability-dataAbilityResult.md)>> | 在DataAbilityResult数组中返回每个操作的结果。 |
**示例:** **示例:**
...@@ -946,9 +939,9 @@ import featureAbility from '@ohos.ability.featureAbility'; ...@@ -946,9 +939,9 @@ import featureAbility from '@ohos.ability.featureAbility';
// 根据DataAbilityOperation列表选择要对数据库做的操作 // 根据DataAbilityOperation列表选择要对数据库做的操作
let op=new Array(); let op=new Array();
let dataAbilityHelper = featureAbility.acquireDataAbilityHelper( let dataAbilityHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.jsapidemo.UserDataAbility"); "dataability:///com.example.jsapidemo.UserDataAbility"
dataAbilityHelper.executeBatch("dataability:///com.example.jsapidemo.UserDataAbility", );
op).then((data) => { dataAbilityHelper.executeBatch("dataability:///com.example.jsapidemo.UserDataAbility", op).then((data) => {
console.info('Operation succeeded: ' + data); console.info('Operation succeeded: ' + data);
}).catch((error) => { }).catch((error) => {
console.error('Operation failed. Cause: ' + error); console.error('Operation failed. Cause: ' + error);
......
# DataAbilityOperation # DataAbilityOperation
定义dataAbility数据操作方式,可以作为[executeBatch](js-apis-inner-ability-dataAbilityHelper.md#dataabilityhelperexecutebatch)的入参查询数据库的信息。 定义DataAbility数据操作方式,可以作为[executeBatch](js-apis-inner-ability-dataAbilityHelper.md#dataabilityhelperexecutebatch)的入参,操作数据库的信息。
> **说明:** > **说明:**
> >
...@@ -11,11 +11,11 @@ ...@@ -11,11 +11,11 @@
| 名称 | 类型 | 必填| 说明 | | 名称 | 类型 | 必填| 说明 |
| -------- | -------- | --------| -------- | | -------- | -------- | --------| -------- |
| uri | string | 是 | 指待处理的DataAbility。例:"dataability:///com.example.xxx.xxxx"。 | | uri | string | 是 | 指待处理的DataAbility。例:"dataability:///com.example.xxx.xxxx"。 |
| type | featureAbility.DataAbilityOperationType | 是 | 指示操作类型。 | | type | featureAbility.DataAbilityOperationType | 是 | 指示数据操作类型。 |
| valuesBucket? | rdb.ValuesBucket | 否 | 指示要设置的数据值。 | | valuesBucket? | rdb.ValuesBucket | 否 | 指示要操作的数据值。 |
| valueBackReferences? | rdb.ValuesBucket | 否 | 指示包含一组键值对的valuesBucket对象。 | | valueBackReferences? | rdb.ValuesBucket | 否 | 指示包含一组键值对的valuesBucket对象。 |
| predicates? | dataAbility.DataAbilityPredicates | 否 | 指示要设置的筛选条件。如果此参数为空,则所有数据记录。 | | predicates? | dataAbility.DataAbilityPredicates | 否 | 指示要设置的筛选条件。如果此参数为空,则操作所有数据记录。 |
| predicatesBackReferences? | Map\<number, number> | 否 | 指示用作谓词中筛选条件的反向引用。 | | predicatesBackReferences? | Map\<number, number> | 否 | 指示用作谓词中筛选条件的反向引用。 |
| interrupted? | boolean | 否 | 指是否可以中断批处理操作。 | | interrupted? | boolean | 否 | 指是否可以中断批处理操作。 |
| expectedCount? | number | 否 | 指示要更新或删除的预期行数。 | | expectedCount? | number | 否 | 指示要更新或删除的预期行数。 |
# DataAbilityResult # DataAbilityResult
定义dataAbility数据操作结果,通过[executeBatch](js-apis-inner-ability-dataAbilityHelper.md#dataabilityhelperexecutebatch)查询数据库信息时查询结果通过DataAbilityResult对象返回。 定义DataAbility数据操作结果,通过[executeBatch](js-apis-inner-ability-dataAbilityHelper.md#dataabilityhelperexecutebatch)操作数据库时,操作结果使用DataAbilityResult对象返回。
> **说明:** > **说明:**
> >
...@@ -11,8 +11,8 @@ ...@@ -11,8 +11,8 @@
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| uri? | string | 否 | 指待处理的DataAbility。例:"dataability:///com.example.xxx.xxxx"。 | | uri? | string | 否 | 指待处理的DataAbility。例:"dataability:///com.example.xxx.xxxx"。 |
| count? | number | 否 | 指示受操作影响的行数。 | | count? | number | 否 | 指示受操作影响的数据数量。 |
**示例:** **示例:**
...@@ -59,7 +59,7 @@ let operations = [ ...@@ -59,7 +59,7 @@ let operations = [
]; ];
try { try {
let promise = DAHelper.executeBatch(dataAbilityUri, operations).then((data) => { DAHelper.executeBatch(dataAbilityUri, operations).then((data) => {
for (let i = 0; i < data.length; i++) { for (let i = 0; i < data.length; i++) {
let dataAbilityResult = data[i]; let dataAbilityResult = data[i];
console.log('dataAbilityResult.uri: ' + dataAbilityResult.uri); console.log('dataAbilityResult.uri: ' + dataAbilityResult.uri);
......
# StartAbilityParameter # StartAbilityParameter
定义启动Ability参数,可以作为入参调用[startAbility](js-apis-ability-featureAbility.md#featureabilitystartability)启动指定的Ability。 定义启动Ability参数,可以作为入参调用[startAbility](js-apis-ability-featureAbility.md#featureabilitystartability)启动指定的Ability。
> **说明:** > **说明:**
> >
...@@ -11,8 +11,8 @@ ...@@ -11,8 +11,8 @@
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ------------------- | -------- | ---- | -------------------------------------- | | ------------------- | -------- | ---- | -------------------------------------- |
| want | [Want](js-apis-application-want.md)| 是 | 表示需要包含有关目标启动能力的信息。 | | want | [Want](js-apis-application-want.md)| 是 | 启动Ability的want信息。 |
| abilityStartSetting | {[key: string]: any} | 否 | 表示能力的特殊属性,当开发者启动能力时,该属性可以作为调用中的输入参数传递。 | | abilityStartSetting | {[key: string]: any} | 否 | 启动Ability的特殊属性,当开发者启动Ability时,该属性可以作为调用中的输入参数传递。 |
**示例:** **示例:**
```ts ```ts
...@@ -35,9 +35,11 @@ let startAbilityParameter = { ...@@ -35,9 +35,11 @@ let startAbilityParameter = {
abilityStartSetting : abilityStartSetting abilityStartSetting : abilityStartSetting
} }
featureAbility.startAbility(startAbilityParameter, (err, data)=>{ try {
featureAbility.startAbility(startAbilityParameter, (err, data) => {
console.log('errCode : ' + JSON.stringify(err)); console.log('errCode : ' + JSON.stringify(err));
console.log('data : ' + JSON.stringify(data)); console.log('data : ' + JSON.stringify(data));
});
} catch(error) { } catch(error) {
console.log("startAbility error: " + JSON.stringify(error)); console.log("startAbility error: " + JSON.stringify(error));
} }
......
...@@ -12,5 +12,5 @@ ...@@ -12,5 +12,5 @@
| ----------- | ------ | ---- | ---- | -------------- | | ----------- | ------ | ---- | ---- | -------------- |
| appName | string | 是 | 否 | 应用名称。 | | appName | string | 是 | 否 | 应用名称。 |
| versionCode | number | 是 | 否 | 应用版本编码。 | | versionCode | number | 是 | 否 | 应用版本编码。 |
| versionName | string | 是 | 否 | 应用版本。 | | versionName | string | 是 | 否 | 应用版本名称。 |
# AbilityDelegatorArgs # AbilityDelegatorArgs
AbilityDelegatorArgs模块提供在应用程序启动期间,用于存储已注册的AbilityDelegator和AbilityDelegatorArgs对象的全局寄存器的能力。 AbilityDelegatorArgs模块提供在应用程序执行测试用例期间,获取测试用例参数AbilityDelegatorArgs对象的能力。
> **说明:** > **说明:**
> >
...@@ -21,7 +21,7 @@ AbilityDelegatorArgs模块提供在应用程序启动期间,用于存储已注 ...@@ -21,7 +21,7 @@ AbilityDelegatorArgs模块提供在应用程序启动期间,用于存储已注
| bundleName | string | 是 | 是 | 当前被测试应用的包名 | | bundleName | string | 是 | 是 | 当前被测试应用的包名 |
| parameters | {[key:string]: string} | 是 | 是 | 当前启动单元测试的参数 | | parameters | {[key:string]: string} | 是 | 是 | 当前启动单元测试的参数 |
| testCaseNames | string | 是 | 是 | 测试用例名称 | | testCaseNames | string | 是 | 是 | 测试用例名称 |
| testRunnerClassName | string | 是 | 是 | 执行测试用例的测试执行器名称 | | testRunnerClassName | string | 是 | 是 | 执行测试用例的测试执行器名称 |
**示例:** **示例:**
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册