js-apis-inner-ability-dataAbilityHelper.md 36.0 KB
Newer Older
Z
zengyawen 已提交
1
# DataAbilityHelper
M
m00512953 已提交
2

Z
zhongjianfei 已提交
3 4
可以通过[acquireDataAbilityHelper](js-apis-ability-featureAbility.md#featureabilityacquiredataabilityhelper7)接口获取DataAbilityHelper对象。

M
m00512953 已提交
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
> **说明:**
> 
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。  
> 本模块接口仅可在FA模型下使用。

## 使用说明

使用前根据具体情况引入如下模块
```ts
import ohos_data_ability from '@ohos.data.dataAbility'
import ohos_data_rdb from '@ohos.data.rdb'
```

## DataAbilityHelper.openFile

openFile(uri: string, mode: string, callback: AsyncCallback\<number>): void

D
dy_study 已提交
22
打开指定uri对应的文件,返回文件描述符(callback形式)。
M
m00512953 已提交
23 24 25 26 27 28 29

**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel

**参数:**

| 参数名     | 类型                   | 必填 | 说明                               |
| -------- | ---------------------- | ---- | ---------------------------------- |
D
dy_study 已提交
30 31 32
| uri      | string                 | 是   | 指示待打开文件的uri。           |
| mode     | string                 | 是   | 指示文件打开模式,可以设置为‘r’表示只读访问,‘w’表示只写访问,‘rw’表示读写访问等。            |
| callback | AsyncCallback\<number> | 是   | 指示文件打开的回调方法,返回文件描述符。 |
M
m00512953 已提交
33 34 35 36 37 38 39 40

**示例:**

```ts
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
D
dy_study 已提交
41 42 43
var mode = "rw";
DAHelper.openFile("dataability:///com.example.DataAbility", mode, (err, data) => {
        console.info("openFile err: " + JSON.stringify(err) + "data: " + JSON.stringify(data));
M
m00512953 已提交
44 45 46 47 48 49 50
});
```

## DataAbilityHelper.openFile

openFile(uri: string, mode: string): Promise\<number>

D
dy_study 已提交
51
打开指定uri对应的文件,返回文件描述符(promise形式)。
M
m00512953 已提交
52 53 54 55 56 57 58

**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel

**参数:**

| 参数名 | 类型   | 必填 | 说明                     |
| ---- | ------ | ---- | ------------------------ |
D
dy_study 已提交
59 60
| uri  | string | 是   | 指示待打开文件的uri。 |
| mode | string | 是   | 指示文件打开模式,可以设置为‘r’表示只读访问,‘w’表示只写访问,‘rw’表示读写访问等。  |
M
m00512953 已提交
61 62 63 64 65 66 67 68 69 70 71 72 73 74

**返回值:**

| 类型             | 说明             |
| ---------------- | ---------------- |
| Promise\<number> | 返回文件说明符。 |

**示例:**

```ts
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
D
dy_study 已提交
75
var mode = "rw";
Z
zhongjianfei 已提交
76
DAHelper.openFile("dataability:///com.example.DataAbility", mode).then((data) => {
D
dy_study 已提交
77
    console.info("openFile data: " + JSON.stringify(data));
M
m00512953 已提交
78 79 80 81 82 83 84
});
```

## DataAbilityHelper.on

on(type: 'dataChange', uri: string, callback: AsyncCallback\<void>): void

D
dy_study 已提交
85
注册观察者以监听给定uri指定数据的数据变化通知。
M
m00512953 已提交
86 87 88 89 90 91 92

**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel

**参数:**

| 参数名     | 类型                 | 必填 | 说明                     |
| -------- | -------------------- | ---- | ------------------------ |
D
dy_study 已提交
93 94 95
| type     | string               | 是   | 指示监听操作类型,"dataChange"表示数据变化操作。               |
| uri      | string               | 是   | 指示待操作数据的uri。 |
| callback | AsyncCallback\<void> | 是   | 指示数据变化时的回调。   |
M
m00512953 已提交
96 97 98 99 100

**示例:**

```ts
import featureAbility from '@ohos.ability.featureAbility'
D
dy_study 已提交
101
var DAHelper = featureAbility.acquireDataAbilityHelper(
M
m00512953 已提交
102 103 104
    "dataability:///com.example.DataAbility"
);
function onChangeNotify() {
D
dy_study 已提交
105
    console.info("onChangeNotify call back");
M
m00512953 已提交
106
};
D
dy_study 已提交
107
DAHelper.on(
M
m00512953 已提交
108 109 110 111 112 113 114 115 116 117
    "dataChange",
    "dataability:///com.example.DataAbility",
    onChangeNotify
)
```

## DataAbilityHelper.off

off(type: 'dataChange', uri: string, callback?: AsyncCallback\<void>): void

D
dy_study 已提交
118
注消观察者以停止监听给定uri指定数据的数据变化通知。
M
m00512953 已提交
119 120 121 122 123 124 125

**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel

**参数:**

| 参数名     | 类型                 | 必填 | 说明                     |
| -------- | -------------------- | ---- | ------------------------ |
D
dy_study 已提交
126 127 128
| type     | string               | 是   | 指示监听操作类型,"dataChange"表示数据变化操作。               |
| uri      | string               | 是   | 指示待操作数据的uri。 |
| callback | AsyncCallback\<void> | 否   | 指示已注册的数据变化回调。如果设置数据变化回调为空,将会取消所有数据变化监听。       |
M
m00512953 已提交
129 130 131 132 133

**示例:**

```ts
import featureAbility from '@ohos.ability.featureAbility'
D
dy_study 已提交
134
var DAHelper = featureAbility.acquireDataAbilityHelper(
M
m00512953 已提交
135 136 137
    "dataability:///com.example.DataAbility"
);
function onChangeNotify() {
D
dy_study 已提交
138
    console.info("onChangeNotify call back");
M
m00512953 已提交
139
};
D
dy_study 已提交
140
DAHelper.off(
M
m00512953 已提交
141 142
    "dataChange",
    "dataability:///com.example.DataAbility",
D
dy_study 已提交
143
    onChangeNotify
M
m00512953 已提交
144
)
D
dy_study 已提交
145
DAHelper.off(
M
m00512953 已提交
146 147 148 149 150 151 152 153 154
    "dataChange",
    "dataability:///com.example.DataAbility",
)
```

## DataAbilityHelper.getType

getType(uri: string, callback: AsyncCallback\<string>): void

D
dy_study 已提交
155
获取给定uri指向数据的媒体资源类型(callback形式)。
M
m00512953 已提交
156 157 158 159 160 161 162

**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel

**参数:**

| 参数名     | 类型                   | 必填 | 说明                                          |
| -------- | ---------------------- | ---- | --------------------------------------------- |
D
dy_study 已提交
163 164
| uri      | string                 | 是   | 指示待获取数据的uri。                      |
| callback | AsyncCallback\<string> | 是   | 指示获取媒体资源类型的回调,返回与uri指向数据匹配的媒体资源类型。 |
M
m00512953 已提交
165 166 167 168 169 170 171 172

**示例:**

```ts
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
Z
zhongjianfei 已提交
173
DAHelper.getType("dataability:///com.example.DataAbility", (err, data) => {
D
dy_study 已提交
174
    console.info("getType err: " + JSON.stringify(err) + "data: " + JSON.stringify(data));
M
m00512953 已提交
175 176 177 178 179 180 181
});
```

## DataAbilityHelper.getType

getType(uri: string): Promise\<string>

D
dy_study 已提交
182
获取给定uri指向数据的媒体资源类型(Promise形式)。
M
m00512953 已提交
183 184 185 186 187 188 189

**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel

**参数:**

| 参数名 | 类型   | 必填 | 说明                     |
| ---- | ------ | ---- | ------------------------ |
D
dy_study 已提交
190
| uri  | string | 是   | 指示待获取数据的uri。 |
M
m00512953 已提交
191 192 193 194 195

**返回值:**

| 类型             | 说明                                |
| ---------------- | ----------------------------------- |
D
dy_study 已提交
196
| Promise\<string> | 返回与uri指向数据匹配的媒体资源类型。 |
M
m00512953 已提交
197 198 199 200 201 202 203 204

**示例:**

```ts
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
Z
zhongjianfei 已提交
205
DAHelper.getType("dataability:///com.example.DataAbility").then((data) => {
D
dy_study 已提交
206
    console.info("getType data: " + JSON.stringify(data));
M
m00512953 已提交
207 208 209 210 211 212 213
});
```

## DataAbilityHelper.getFileTypes

getFileTypes(uri: string, mimeTypeFilter: string, callback: AsyncCallback<Array\<string>>): void

D
dy_study 已提交
214
获取支持的文件的媒体资源类型(callback形式)。
M
m00512953 已提交
215 216 217 218 219 220 221 222

**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel

**参数:**

| 参数名           | 类型                           | 必填 | 说明                               |
| -------------- | ------------------------------ | ---- | ---------------------------------- |
| uri            | string                         | 是   | 指示要获取的文件的路径。           |
D
dy_study 已提交
223 224
| mimeTypeFilter | string                         | 是   | 指示要获取的文件的媒体资源类型。       |
| callback       | AsyncCallback\<Array\<string>> | 是   | 回调方法,返回匹配的媒体资源类型数组。 |
M
m00512953 已提交
225 226 227 228 229 230 231 232

**示例:**

```ts
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
Z
zhongjianfei 已提交
233 234 235
DAHelper.getFileTypes( "dataability:///com.example.DataAbility",
    "image/*", (err, data) => {
    console.info("==========================>Called=======================>");
M
m00512953 已提交
236 237 238 239 240 241 242 243 244
});
```



## DataAbilityHelper.getFileTypes

getFileTypes(uri: string, mimeTypeFilter: string): Promise\<Array\<string>>

D
dy_study 已提交
245
获取支持的文件的媒体资源类型(Promise形式)。
M
m00512953 已提交
246 247 248 249 250 251 252 253

**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel

**参数:**

| 参数名           | 类型   | 必填 | 说明                         |
| -------------- | ------ | ---- | ---------------------------- |
| uri            | string | 是   | 指示要获取的文件的路径。     |
D
dy_study 已提交
254
| mimeTypeFilter | string | 是   | 指示要获取的文件的媒体资源类型。 |
M
m00512953 已提交
255 256 257 258 259

**返回值:**

| 类型                     | 说明                     |
| ------------------------ | ------------------------ |
D
dy_study 已提交
260
| Promise\<Array\<string>> | 返回匹配的媒体资源类型数组。 |
M
m00512953 已提交
261 262 263 264 265 266 267 268

**示例:**

```ts
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
Z
zhongjianfei 已提交
269 270 271
DAHelper.getFileTypes("dataability:///com.example.DataAbility",
    "image/*").then((data) => {
     console.info("===================>getFileTypesCallback================>");
M
m00512953 已提交
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
});
```

## DataAbilityHelper.normalizeUri

normalizeUri(uri: string, callback: AsyncCallback\<string>): void

将引用数据功能的给定uri转换为规范化uri(callback形式)。

**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel

**参数:**

| 参数名     | 类型                   | 必填 | 说明                                                         |
| -------- | ---------------------- | ---- | ------------------------------------------------------------ |
| uri      | string                 | 是   | 指示要规范化的uri对象。                                      |
| callback | AsyncCallback\<string> | 是   | 回调方法。如果数据功能支持uri规范化,则返回规范化uri对象;否则返回null。 |

**示例:**

```ts
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
Z
zhongjianfei 已提交
297 298
DAHelper.normalizeUri("dataability:///com.example.DataAbility", (err, data) => {
    console.info("==========================>Called=======================>");
M
m00512953 已提交
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
});
```

## DataAbilityHelper.normalizeUri

normalizeUri(uri: string): Promise\<string>

将引用数据功能的给定uri转换为规范化uri(Promise形式)。

**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel

**参数:**

| 参数名 | 类型   | 必填 | 说明                    |
| ---- | ------ | ---- | ----------------------- |
| uri  | string | 是   | 指示要规范化的uri对象。 |

**返回值:**

| 类型             | 说明                                                   |
| ---------------- | ------------------------------------------------------ |
| Promise\<string> | 如果数据功能支持uri规范化,则返回规范化uri对象;否则返回null。 |

**示例:**

```ts
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
Z
zhongjianfei 已提交
329 330
DAHelper.normalizeUri("dataability:///com.example.DataAbility",).then((data) => {
    console.info("=================>normalizeUriCallback=======================>");
M
m00512953 已提交
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
});
```

## DataAbilityHelper.denormalizeUri

denormalizeUri(uri: string, callback: AsyncCallback\<string>): void

将由normalizeUri(uri)生成的给定规范化uri转换为非规范化uri(callback形式)。

**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel

**参数:**

| 参数名     | 类型                   | 必填 | 说明                                                |
| -------- | ---------------------- | ---- | --------------------------------------------------- |
| uri      | string                 | 是   | 指示要规范化的uri对象。                             |
| callback | AsyncCallback\<string> | 是   | 回调方法。如果反规范化成功,则返回反规范化uri对象。 |

**示例:**

```ts
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
Z
zhongjianfei 已提交
356 357
DAHelper.denormalizeUri("dataability:///com.example.DataAbility", (err, data) => {
    console.info("==========================>Called=======================>");
M
m00512953 已提交
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
});
```



## DataAbilityHelper.denormalizeUri

denormalizeUri(uri: string): Promise\<string>

将由normalizeUri(uri)生成的给定规范化uri转换为非规范化uri(Promise形式)。

**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel

**参数:**

| 参数名 | 类型   | 必填 | 说明                    |
| ---- | ------ | ---- | ----------------------- |
| uri  | string | 是   | 指示要规范化的uri对象。 |

**返回值:**

| 类型             | 说明                                      |
| ---------------- | ----------------------------------------- |
| Promise\<string> | 如果反规范化成功,则返回反规范化uri对象。 |

**示例:**

```ts
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
Z
zhongjianfei 已提交
390 391
DAHelper.denormalizeUri("dataability:///com.example.DataAbility",).then((data) => {
    console.info("===============>denormalizeUriCallback=======================>");
M
m00512953 已提交
392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413
});
```

## DataAbilityHelper.notifyChange

notifyChange(uri: string, callback: AsyncCallback\<void>): void

通知已注册的观察者uri指定的数据资源的更改(callback形式)。

**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel

**参数:**

| 参数名     | 类型                 | 必填 | 说明                     |
| -------- | -------------------- | ---- | ------------------------ |
| uri      | string               | 是   | 指示要操作的数据的路径。 |
| callback | AsyncCallback\<void> | 是   | 回调方法。               |

**示例:**

```ts
import featureAbility from '@ohos.ability.featureAbility'
D
dy_study 已提交
414
var DAHelper = featureAbility.acquireDataAbilityHelper(
M
m00512953 已提交
415 416
    "dataability:///com.example.DataAbility"
);
D
dy_study 已提交
417
DAHelper.notifyChange("dataability:///com.example.DataAbility", (err) => {
Z
zhongjianfei 已提交
418
    console.info("==========================>Called=======================>");
M
m00512953 已提交
419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448
});
```

## DataAbilityHelper.notifyChange

notifyChange(uri: string): Promise\<void>

通知已注册的观察者uri指定的数据资源的更改(Promise形式)。

**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel

**参数:**

| 参数名 | 类型   | 必填 | 说明                     |
| ---- | ------ | ---- | ------------------------ |
| uri  | string | 是   | 指示要操作的数据的路径。 |

**返回值:**

| 类型           | 说明                  |
| -------------- | --------------------- |
| Promise\<void> | 返回值为Promise对象。 |

**示例:**

```ts
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
Z
zhongjianfei 已提交
449 450
DAHelper.notifyChange("dataability:///com.example.DataAbility").then(() => {
    console.info("================>notifyChangeCallback================>");
M
m00512953 已提交
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482
});
```

## DataAbilityHelper.insert

insert(uri: string, valuesBucket: rdb.ValuesBucket, callback: AsyncCallback\<number>): void

将单个数据记录插入数据库(callback形式)。

**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel

**参数:**

| 参数名         | 类型                   | 必填 | 说明                                                   |
| ------------ | ---------------------- | ---- | ------------------------------------------------------ |
| uri          | string                 | 是   | 指示要插入的数据的路径。                               |
| valuesBucket | rdb.ValuesBucket       | 是   | 指示要插入的数据记录。如果此参数为空,将插入一个空行。 |
| callback     | AsyncCallback\<number> | 是   | 回调方法,返回插入数据记录的索引。                     |

**示例:**

```ts
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
const valueBucket = {
    "name": "rose",
    "age": 22,
    "salary": 200.5,
    "blobType": "u8",
}
Z
zhongjianfei 已提交
483
DAHelper.insert("dataability:///com.example.DataAbility", valueBucket,
M
m00512953 已提交
484
    (err, data) => {
Z
zhongjianfei 已提交
485
    console.info("==========================>Called=======================>");
M
m00512953 已提交
486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522
});
```

## DataAbilityHelper.insert

insert(uri: string, valuesBucket: rdb.ValuesBucket): Promise\<number>

将单个数据记录插入数据库(Promise形式)。

**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel

**参数:**

| 参数名         | 类型             | 必填 | 说明                                                   |
| ------------ | ---------------- | ---- | ------------------------------------------------------ |
| uri          | string           | 是   | 指示要插入的数据的路径。                               |
| valuesBucket | rdb.ValuesBucket | 是   | 指示要插入的数据记录。如果此参数为空,将插入一个空行。 |

**返回值:**

| 类型             | 说明                     |
| ---------------- | ------------------------ |
| Promise\<number> | 返回插入数据记录的索引。 |

**示例:**

```ts
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
const valueBucket = {
    "name": "rose1",
    "age": 221,
    "salary": 20.5,
    "blobType": "u8",
}
Z
zhongjianfei 已提交
523 524
DAHelper.insert("dataability:///com.example.DataAbility", valueBucket).then((data) => {
    console.info("====================>insertCallback=======================>");
M
m00512953 已提交
525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553
});
```

## DataAbilityHelper.batchInsert

batchInsert(uri: string, valuesBuckets: Array\<rdb.ValuesBucket>, callback: AsyncCallback\<number>): void

插入数据库(callback形式)。

**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel

**参数:**

| 参数名         | 类型                    | 必填 | 说明                             |
| ------------ | ----------------------- | ---- | -------------------------------- |
| uri          | string                  | 是   | 指示要插入的数据的路径。         |
| valuesBucket | Array\<rdb.ValuesBucket> | 是   | 指示要插入的数据记录。           |
| callback     | AsyncCallback\<number>  | 是   | 回调方法。返回插入的数据记录数。 |

**示例:**

```ts
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
var cars = new Array({"name": "roe11", "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",})
Z
zhongjianfei 已提交
554
DAHelper.batchInsert("dataability:///com.example.DataAbility", cars,
M
m00512953 已提交
555
    (err, data) => {
Z
zhongjianfei 已提交
556
    console.info("==========================>Called=======================>");
M
m00512953 已提交
557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590
});
```

## DataAbilityHelper.batchInsert

batchInsert(uri: string, valuesBuckets: Array<rdb.ValuesBucket>): Promise\<number>

将多个数据记录插入数据库(Promise形式)。

**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel

**参数:**

| 参数名         | 类型                    | 必填 | 说明                     |
| ------------ | ----------------------- | ---- | ------------------------ |
| uri          | string                  | 是   | 指示要插入的数据的路径。 |
| valuesBucket | Array<rdb.ValuesBucket> | 是   | 指示要插入的数据记录。   |

**返回值:**

| 类型             | 说明                   |
| ---------------- | ---------------------- |
| Promise\<number> | 返回插入的数据记录数。 |

**示例:**

```ts
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
var cars = new Array({"name": "roe11", "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",})
Z
zhongjianfei 已提交
591 592
DAHelper.batchInsert("dataability:///com.example.DataAbility", cars).then((data) => {
    console.info("==================>batchInsertCallback=======================>");
M
m00512953 已提交
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620
});
```

## DataAbilityHelper.delete

delete(uri: string, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\<number>): void

从数据库中删除一个或多个数据记录(callback形式)。

**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel

**参数:**

| 参数名         | 类型                              | 必填 | 说明                                             |
| ------------ | --------------------------------- | ---- | ------------------------------------------------ |
| uri          | string                            | 是   | 指示要删除的数据的路径。                         |
| predicates | dataAbility.DataAbilityPredicates | 是   | 指示筛选条件。当此参数为null时,应定义处理逻辑。 |
| callback     | AsyncCallback\<number>            | 是   | 回调方法。返回已删除的数据记录数。               |

**示例:**

```ts
import featureAbility from '@ohos.ability.featureAbility'
import ohos_data_ability from '@ohos.data.dataAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
let da = new ohos_data_ability.DataAbilityPredicates()
Z
zhongjianfei 已提交
621
DAHelper.delete("dataability:///com.example.DataAbility", da,
M
m00512953 已提交
622
    (err, data) => {
Z
zhongjianfei 已提交
623
    console.info("==========================>Called=======================>");
M
m00512953 已提交
624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656
});
```

## DataAbilityHelper.delete

delete(uri: string, predicates?: dataAbility.DataAbilityPredicates): Promise\<number>;

从数据库中删除一个或多个数据记录(Promise形式)。

**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel

**参数:**

| 参数名         | 类型                              | 必填 | 说明                                             |
| ------------ | --------------------------------- | ---- | ------------------------------------------------ |
| uri          | string                            | 是   | 指示要删除的数据的路径。                         |
| predicates | dataAbility.DataAbilityPredicates | 否   | 指示筛选条件。当此参数为null时,应定义处理逻辑。 |

**返回值:**

| 类型             | 说明                     |
| ---------------- | ------------------------ |
| Promise\<number> | 返回已删除的数据记录数。 |

**示例:**

```ts
import featureAbility from '@ohos.ability.featureAbility'
import ohos_data_ability from '@ohos.data.dataAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
let da = new ohos_data_ability.DataAbilityPredicates()
Z
zhongjianfei 已提交
657 658
DAHelper.delete("dataability:///com.example.DataAbility", da).then((data) => {
    console.info("==========================>deleteCallback=======================>");
M
m00512953 已提交
659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693
});
```

## DataAbilityHelper.update

update(uri: string, valuesBucket: rdb.ValuesBucket, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\<number>): void

更新数据库中的数据记录(callback形式)。

**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel

**参数:**

| 参数名         | 类型                              | 必填 | 说明                                             |
| ------------ | --------------------------------- | ---- | ------------------------------------------------ |
| uri          | string                            | 是   | 指示要更新的数据的路径。                         |
| valuesBucket | rdb.ValuesBucket                  | 是   | 指示要更新的数据。                               |
| predicates   | dataAbility.DataAbilityPredicates | 是   | 指示筛选条件。当此参数为null时,应定义处理逻辑。 |
| callback     | AsyncCallback\<number>            | 是   | 回调方法,返回更新的数据记录数。                 |

**示例:**

```ts
import featureAbility from '@ohos.ability.featureAbility'
import ohos_data_ability from '@ohos.data.dataAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
const va = {
    "name": "roe1",
    "age": 21,
    "salary": 20.5,
    "blobType": "u8",
}
let da = new ohos_data_ability.DataAbilityPredicates()
Z
zhongjianfei 已提交
694 695
DAHelper.update("dataability:///com.example.DataAbility", va, da, (err, data) => {
    console.info("==========================>Called=======================>");
M
m00512953 已提交
696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735
});
```

## DataAbilityHelper.update

update(uri: string, valuesBucket: rdb.ValuesBucket, predicates?: dataAbility.DataAbilityPredicates): Promise\<number>;

更新数据库中的数据记录(Promise形式)。

**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel

**参数:**

| 参数名         | 类型                              | 必填 | 说明                                             |
| ------------ | --------------------------------- | ---- | ------------------------------------------------ |
| uri          | string                            | 是   | 指示要更新的数据的路径。                         |
| valuesBucket | rdb.ValuesBucket                  | 是   | 指示要更新的数据。                               |
| predicates   | dataAbility.DataAbilityPredicates | 否   | 指示筛选条件。当此参数为null时,应定义处理逻辑。 |

**返回值:**

| 类型             | 说明                                         |
| ---------------- | -------------------------------------------- |
| Promise\<number> | Promise中包含更新的数据记录数。 。 |

**示例:**

```ts
import featureAbility from '@ohos.ability.featureAbility'
import ohos_data_ability from '@ohos.data.dataAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
const va = {
    "name": "roe1",
    "age": 21,
    "salary": 20.5,
    "blobType": "u8",
}
let da = new ohos_data_ability.DataAbilityPredicates()
Z
zhongjianfei 已提交
736 737
DAHelper.update("dataability:///com.example.DataAbility", va, da).then((data) => {
    console.info("==========================>updateCallback=======================>");
M
m00512953 已提交
738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767
});
```

## DataAbilityHelper.query

query(uri: string, columns: Array\<string>, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\<ResultSet>): void

查询数据库中的数据(callback形式)。

**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel

**参数:**

| 参数名       | 类型                              | 必填 | 说明                                             |
| ---------- | --------------------------------- | ---- | ------------------------------------------------ |
| uri        | string                            | 是   | 指示要查询的数据的路径。                         |
| columns    | Array\<string>                | 是   | 指示要查询的列。如果此参数为空,则查询所有列。   |
| predicates | dataAbility.DataAbilityPredicates | 是   | 指示筛选条件。当此参数为null时,应定义处理逻辑。 |
| callback   | AsyncCallback\<ResultSet>         | 是   | 回调方法,返回查询结果。                         |

**示例:**

```ts
import featureAbility from '@ohos.ability.featureAbility'
import ohos_data_ability from '@ohos.data.dataAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
var cars=new Array("value1", "value2", "value3", "value4");
let da = new ohos_data_ability.DataAbilityPredicates()
Z
zhongjianfei 已提交
768 769
DAHelper.query("dataability:///com.example.DataAbility", cars, da, (err, data) => {
    console.info("==========================>Called=======================>");
M
m00512953 已提交
770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804
});
```



## DataAbilityHelper.query

query(uri: string, columns?: Array\<string>, predicates?: dataAbility.DataAbilityPredicates): Promise\<ResultSet>;

查询数据库中的数据(Promise形式)。

**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel

**参数:**

| 参数名       | 类型                              | 必填 | 说明                                             |
| ---------- | --------------------------------- | ---- | ------------------------------------------------ |
| uri        | string                            | 是   | 指示要查询的数据的路径。                         |
| columns    | Array\<string>               | 否   | 指示要查询的列。如果此参数为空,则查询所有列。   |
| predicates | dataAbility.DataAbilityPredicates | 否   | 指示筛选条件。当此参数为null时,应定义处理逻辑。 |

**返回值:**

| 类型                | 说明           |
| ------------------- | -------------- |
| Promise\<ResultSet> | 返回查询结果。 |

**示例:**

```ts
import featureAbility from '@ohos.ability.featureAbility'
import ohos_data_ability from '@ohos.data.dataAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
Z
zhongjianfei 已提交
805
var cars = new Array("value1", "value2", "value3", "value4");
M
m00512953 已提交
806
let da = new ohos_data_ability.DataAbilityPredicates()
Z
zhongjianfei 已提交
807 808
DAHelper.query("dataability:///com.example.DataAbility", cars, da).then((data) => {
    console.info("==========================>queryCallback=======================>");
M
m00512953 已提交
809 810 811 812 813 814 815 816 817 818 819 820 821 822 823
});
```

## DataAbilityHelper.call

call(uri: string, method: string, arg: string, extras: PacMap): Promise\<PacMap>

调用DataAbility的扩展接口,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel

**参数:**

| 参数名       | 类型                              | 必填 | 说明                                             |
| ---------- | --------------------------------- | ---- | ------------------------------------------------ |
D
dy_study 已提交
824
| uri        | string                 | 是   | 指示待处理的DataAbility。例:"dataability:///com.example.xxx.xxxx"           |
M
m00512953 已提交
825 826 827 828 829 830 831 832 833 834 835 836 837 838 839
| method    | string                  | 是   | 被调用的方法名。   |
| arg      | string                   | 是   |需传入的参数。      |
| extras   | [PacMap](#pacmap)        | 是   | 键值对参数。       |

**返回值:**

| 类型 | 说明 |
|------ | ------- |
|Promise\<[PacMap](#pacmap)> | 调用的返回值。 |

**示例:**

```ts
import featureAbility from '@ohos.ability.featureAbility';

Z
zhongjianfei 已提交
840 841 842 843
let dataAbilityHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.jsapidemo.UserDataAbility");
dataAbilityHelper.call("dataability:///com.example.jsapidemo.UserDataAbility",
    "method", "arg", {"key1":"value1"}).then((data) => {
M
m00512953 已提交
844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861
    console.info('Operation succeeded: ' + data);
}).catch((error) => {
    console.error('Operation failed. Cause: ' + error);
});
```

## DataAbilityHelper.call

call(uri: string, method: string, arg: string, extras: PacMap, callback: AsyncCallback\<PacMap>): void

调用DataAbility的扩展接口,使用callback方式作为异步方法。

**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel

**参数:**

| 参数名       | 类型                              | 必填 | 说明                                             |
| ---------- | --------------------------------- | ---- | ------------------------------------------------ |
D
dy_study 已提交
862
| uri        | string                 | 是   | 指示待处理的DataAbility。例:"dataability:///com.example.xxx.xxxx"           |
M
m00512953 已提交
863 864 865 866 867 868 869 870 871 872
| method    | string                  | 是   | 被调用的方法名。   |
| arg      | string                   | 是   |需传入的参数。      |
| extras   | [PacMap](#pacmap)        | 是   | 键值对参数。       |
| callback | AsyncCallback\<[PacMap](#pacmap)> | 是 | 返回值。     |

**示例:**

```ts
import featureAbility from '@ohos.ability.featureAbility';

Z
zhongjianfei 已提交
873 874 875 876
let dataAbilityHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.jsapidemo.UserDataAbility");
dataAbilityHelper.call("dataability:///com.example.jsapidemo.UserDataAbility",
    "method", "arg", {"key1":"value1"}, (err, data) => {
M
m00512953 已提交
877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896
    if (err) {
        console.error('Operation failed. Cause: ' + err);
        return;
    }
    console.info('Operation succeeded: ' + data);
});
```

## DataAbilityHelper.executeBatch

executeBatch(uri: string, operations: Array\<DataAbilityOperation>, callback: AsyncCallback\<Array\<DataAbilityResult>>): void;

查询数据库中的数据。

**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel

**参数:**

| 参数名            | 类型                                         | 必填 | 说明                                             |
| ----------    | ---------------------------------             | ---- | ------------------------------------------------ |
D
dy_study 已提交
897
| uri           | string                                        | 是   | 指示待处理的DataAbility。例:"dataability:///com.example.xxx.xxxx"。|
M
m00512953 已提交
898 899 900 901 902 903 904 905 906 907
| operations    |  Array\<[DataAbilityOperation](js-apis-inner-ability-dataAbilityOperation.md)>               | 是   | 指示数据操作列表,其中可以包含对数据库的多个操作。   |
| callback      |  AsyncCallback\<Array\<[DataAbilityResult](js-apis-inner-ability-dataAbilityResult.md)>>    | 是   |在数组 DataAbilityResult中返回每个操作的结果。      |

**示例:**

```ts
import featureAbility from '@ohos.ability.featureAbility';

// 根据DataAbilityOperation列表选择要对数据库做的操作
let op=new Array();
Z
zhongjianfei 已提交
908 909 910 911
let dataAbilityHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.jsapidemo.UserDataAbility");
dataAbilityHelper.executeBatch("dataability:///com.example.jsapidemo.UserDataAbility",
    op, (err, data) => {
M
m00512953 已提交
912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931
    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

**参数:**

| 参数名          | 类型                            | 必填 | 说明                                             |
| ----------    | -------------------------------| ---- | ------------------------------------------------ |
D
dy_study 已提交
932
| uri           | string                         | 是   | 指示待处理的DataAbility。例:"dataability:///com.example.xxx.xxxx"。|
M
m00512953 已提交
933 934 935 936 937 938 939 940 941 942 943 944 945 946 947
| operations    |  Array\<[DataAbilityOperation](js-apis-inner-ability-dataAbilityOperation.md)>  | 是   | 指示数据操作列表,其中可以包含对数据库的多个操作。   |

**返回值:**

| 类型 | 说明 |
|------ | ------- |
|Promise\<Array\<[DataAbilityResult](js-apis-inner-ability-dataAbilityResult.md)>> | 在数组 DataAbilityResult中返回每个操作的结果。 |

**示例:**

```ts
import featureAbility from '@ohos.ability.featureAbility';

// 根据DataAbilityOperation列表选择要对数据库做的操作
let op=new Array();
Z
zhongjianfei 已提交
948 949 950 951
let dataAbilityHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.jsapidemo.UserDataAbility");
dataAbilityHelper.executeBatch("dataability:///com.example.jsapidemo.UserDataAbility",
    op).then((data) => {
M
m00512953 已提交
952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967
    console.info('Operation succeeded: ' + data);
}).catch((error) => {
    console.error('Operation failed. Cause: ' + error);
});

```

## PacMap

[key: string]: number | string | boolean | Array\<string | number | boolean> | null;

**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel

| 参数名 | 参数类型 | 必填 | 说明 |
| ------ | ------ | ------ | ------ |
| [key: string] | number \| string \| boolean \| Array\<string \| number \| boolean\> \| null | Yes| 数据存储在键值对中。|