js-apis-dataAbilityHelper.md 33.3 KB
Newer Older
Z
zengyawen 已提交
1 2
# DataAbilityHelper模块(JS端SDK接口)

3 4 5
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

Z
zengyawen 已提交
6
## 导入模块
X
xuchenghua09 已提交
7

8 9 10 11 12 13 14
```js
import dataAbilityHelper from "@ohos.ability.dataAbilityHelper";
```

## 使用说明

使用前根据具体情况引入如下模块
X
xuchenghua09 已提交
15 16 17 18 19 20
```
import featureAbility from '@ohos.ability.featureAbility'
import ohos_data_ability from '@ohos.data.dataability'
import ohos_data_rdb from '@ohos.data.rdb'
```

Y
yuyaozhi 已提交
21
## DataAbilityHelper.openFile
X
xuchenghua09 已提交
22

Z
zengyawen 已提交
23
openFile(uri: string, mode: string, callback: AsyncCallback\<number>): void
X
xuchenghua09 已提交
24

Z
zengyawen 已提交
25
在指定的远程路径中打开文件(callback形式)。
X
xuchenghua09 已提交
26

Y
yuyaozhi 已提交
27
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
28

Z
zengyawen 已提交
29
**参数:**
X
xuchenghua09 已提交
30

Z
zengyawen 已提交
31 32 33 34 35
| 名称     | 类型                   | 必填 | 描述                               |
| -------- | ---------------------- | ---- | ---------------------------------- |
| uri      | string                 | 是   | 指示要打开的文件的路径。           |
| mode     | string                 | 是   | 指示文件打开模式‘rwt’。            |
| callback | AsyncCallback\<number> | 是   | 被指定的回调方法,返回文件描述符。 |
X
xuchenghua09 已提交
36

Z
zengyawen 已提交
37
**示例:**
X
xuchenghua09 已提交
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52

```javascript
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
var mode = "rwt";
DAHelper.openFile(
    "dataability:///com.example.DataAbility",
    mode,
    (err) => {
		console.info("==========================>Called=======================>");
});
```

Y
yuyaozhi 已提交
53
## DataAbilityHelper.openFile
X
xuchenghua09 已提交
54

Z
zengyawen 已提交
55
openFile(uri: string, mode: string): Promise\<number>
X
xuchenghua09 已提交
56

W
wusongqing 已提交
57 58
在指定的远程路径中打开文件(promise形式)。

Y
yuyaozhi 已提交
59
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
60

Z
zengyawen 已提交
61
**参数:**
X
xuchenghua09 已提交
62

Z
zengyawen 已提交
63 64 65 66
| 名称 | 类型   | 必填 | 描述                     |
| ---- | ------ | ---- | ------------------------ |
| uri  | string | 是   | 指示要打开的文件的路径。 |
| mode | string | 是   | 指示文件打开模式‘rwt’。  |
X
xuchenghua09 已提交
67

Z
zengyawen 已提交
68
**返回值:**
Y
yuyaozhi 已提交
69

Z
zengyawen 已提交
70 71 72
| 类型             | 说明             |
| ---------------- | ---------------- |
| Promise\<number> | 返回文件描述符。 |
X
xuchenghua09 已提交
73

Z
zengyawen 已提交
74
**示例:**
X
xuchenghua09 已提交
75 76 77 78 79 80 81 82

```javascript
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
var mode = "rwt";
DAHelper.openFile(
ahjxliubao2's avatar
ahjxliubao2 已提交
83 84
    "dataability:///com.example.DataAbility",
    mode).then((data) => {
X
xuchenghua09 已提交
85 86 87 88
		console.info("==========================>openFileCallback=======================>");
});
```

Y
yuyaozhi 已提交
89
## DataAbilityHelper.on
X
xuchenghua09 已提交
90

Z
zengyawen 已提交
91
on(type: 'dataChange', uri: string, callback: AsyncCallback\<void>): void
X
xuchenghua09 已提交
92

Z
zengyawen 已提交
93
注册观察者以观察给定uri指定的数据callback通知。
X
xuchenghua09 已提交
94

Y
yuyaozhi 已提交
95
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
96

Z
zengyawen 已提交
97
**参数:**
X
xuchenghua09 已提交
98

Z
zengyawen 已提交
99 100 101 102 103
| 名称     | 类型                 | 必填 | 描述                     |
| -------- | -------------------- | ---- | ------------------------ |
| type     | string               | 是   | 数据更改。               |
| uri      | string               | 是   | 指示要操作的数据的路径。 |
| callback | AsyncCallback\<void> | 是   | 指示数据更改时的回调。   |
X
xuchenghua09 已提交
104

Z
zengyawen 已提交
105
**示例:**
X
xuchenghua09 已提交
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121

```js
import featureAbility from '@ohos.ability.featureAbility'
var helper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
function onChangeNotify() {
    console.info("==========================>onChangeNotify=======================>");
};
helper.on(
    "dataChange",
    "dataability:///com.example.DataAbility",
    onChangeNotify
)
```

Y
yuyaozhi 已提交
122
## DataAbilityHelper.off
X
xuchenghua09 已提交
123

Z
zengyawen 已提交
124
off(type: 'dataChange', uri: string, callback?: AsyncCallback\<void>): void
X
xuchenghua09 已提交
125

Z
zengyawen 已提交
126
注消观察者以停止观察给定uri指定的数据callback通知。
X
xuchenghua09 已提交
127

Y
yuyaozhi 已提交
128
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
129

Z
zengyawen 已提交
130
**参数:**
X
xuchenghua09 已提交
131

Z
zengyawen 已提交
132 133 134 135 136
| 名称     | 类型                 | 必填 | 描述                     |
| -------- | -------------------- | ---- | ------------------------ |
| type     | string               | 是   | 数据更改。               |
| uri      | string               | 是   | 指示要操作的数据的路径。 |
| callback | AsyncCallback\<void> | 否   | 指示已注册的回调。       |
X
xuchenghua09 已提交
137

Z
zengyawen 已提交
138
**示例:**
X
xuchenghua09 已提交
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158

```js
import featureAbility from '@ohos.ability.featureAbility'
var helper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
function onChangeNotify() {
    console.info("==========================>onChangeNotify=======================>");
};
helper.off(
    "dataChange",
    "dataability:///com.example.DataAbility",
)
helper.off(
    "dataChange",
    "dataability:///com.example.DataAbility",
    onChangeNotify
)
```

Y
yuyaozhi 已提交
159
## DataAbilityHelper.getType
X
xuchenghua09 已提交
160

Z
zengyawen 已提交
161
getType(uri: string, callback: AsyncCallback\<string>): void
X
xuchenghua09 已提交
162

Z
zengyawen 已提交
163
获取给定URI指定数据的MIME类型(callback形式)。
X
xuchenghua09 已提交
164

Y
yuyaozhi 已提交
165
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
166

Z
zengyawen 已提交
167
**参数:**
X
xuchenghua09 已提交
168

Z
zengyawen 已提交
169 170 171 172
| 名称     | 类型                   | 必填 | 描述                                          |
| -------- | ---------------------- | ---- | --------------------------------------------- |
| uri      | string                 | 是   | 指示要操作的数据的路径。                      |
| callback | AsyncCallback\<string> | 是   | 回调方法,返回与uri指定的数据匹配的MIME类型。 |
X
xuchenghua09 已提交
173

Z
zengyawen 已提交
174
**示例:**
X
xuchenghua09 已提交
175 176 177 178 179 180 181 182 183 184 185 186 187

```js
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
DAHelper.getType(
    "dataability:///com.example.DataAbility",
    (err, data) => {
		console.info("==========================>Called=======================>");
});
```

Y
yuyaozhi 已提交
188
## DataAbilityHelper.getType
X
xuchenghua09 已提交
189

Z
zengyawen 已提交
190
getType(uri: string): Promise\<string>
X
xuchenghua09 已提交
191

Z
zengyawen 已提交
192
获取给定URI指定数据的MIME类型(Promise形式)。
X
xuchenghua09 已提交
193

Y
yuyaozhi 已提交
194
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
195

Z
zengyawen 已提交
196
**参数:**
X
xuchenghua09 已提交
197

Z
zengyawen 已提交
198 199 200
| 名称 | 类型   | 必填 | 描述                     |
| ---- | ------ | ---- | ------------------------ |
| uri  | string | 是   | 指示要操作的数据的路径。 |
X
xuchenghua09 已提交
201

Z
zengyawen 已提交
202
**返回值:**
Y
yuyaozhi 已提交
203

Z
zengyawen 已提交
204 205 206
| 类型             | 说明                                |
| ---------------- | ----------------------------------- |
| Promise\<string> | 返回与uri指定的数据匹配的MIME类型。 |
X
xuchenghua09 已提交
207

Z
zengyawen 已提交
208
**示例:**
X
xuchenghua09 已提交
209 210 211 212 213 214 215 216 217 218 219 220 221

```js
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
DAHelper.getType(
    "dataability:///com.example.DataAbility"
	).then((data) => {
		console.info("==========================>getTypeCallback=======================>");
});
```

Y
yuyaozhi 已提交
222
## DataAbilityHelper.getFileTypes
X
xuchenghua09 已提交
223

Z
zengyawen 已提交
224
getFileTypes(uri: string, mimeTypeFilter: string, callback: AsyncCallback<Array\<string>>): void
X
xuchenghua09 已提交
225

Z
zengyawen 已提交
226
获取支持的文件的MIME类型(callback形式)。
X
xuchenghua09 已提交
227

Y
yuyaozhi 已提交
228
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
229

Z
zengyawen 已提交
230
**参数:**
X
xuchenghua09 已提交
231

Z
zengyawen 已提交
232 233 234 235 236
| 名称           | 类型                           | 必填 | 描述                               |
| -------------- | ------------------------------ | ---- | ---------------------------------- |
| uri            | string                         | 是   | 指示要获取的文件的路径。           |
| mimeTypeFilter | string                         | 是   | 指示要获取的文件的MIME类型。       |
| callback       | AsyncCallback\<Array\<string>> | 是   | 回调方法,返回匹配的MIME类型数组。 |
X
xuchenghua09 已提交
237

Z
zengyawen 已提交
238
**示例:**
X
xuchenghua09 已提交
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254

```js
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
DAHelper.getFileTypes(
    "dataability:///com.example.DataAbility",
    "image/*",
    (err, data) => {
		console.info("==========================>Called=======================>");
});
```



Y
yuyaozhi 已提交
255
## DataAbilityHelper.getFileTypes
Z
zengyawen 已提交
256 257

getFileTypes(uri: string, mimeTypeFilter: string): Promise\<Array\<string>>
X
xuchenghua09 已提交
258

Z
zengyawen 已提交
259
获取支持的文件的MIME类型(Promise形式)。
X
xuchenghua09 已提交
260

Y
yuyaozhi 已提交
261
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
262

Z
zengyawen 已提交
263
**参数:**
X
xuchenghua09 已提交
264

Z
zengyawen 已提交
265 266 267 268
| 名称           | 类型   | 必填 | 描述                         |
| -------------- | ------ | ---- | ---------------------------- |
| uri            | string | 是   | 指示要获取的文件的路径。     |
| mimeTypeFilter | string | 是   | 指示要获取的文件的MIME类型。 |
X
xuchenghua09 已提交
269

Z
zengyawen 已提交
270
**返回值:**
Y
yuyaozhi 已提交
271

Z
zengyawen 已提交
272 273 274
| 类型                     | 说明                     |
| ------------------------ | ------------------------ |
| Promise\<Array\<string>> | 返回匹配的MIME类型数组。 |
X
xuchenghua09 已提交
275

Z
zengyawen 已提交
276
**示例:**
X
xuchenghua09 已提交
277 278 279 280 281 282 283 284 285 286 287 288 289 290

```js
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
DAHelper.getFileTypes(
    "dataability:///com.example.DataAbility",
    "image/*"
	).then((data) => {
		console.info("==========================>getFileTypesCallback=======================>");
});
```

Y
yuyaozhi 已提交
291
## DataAbilityHelper.normalizeUri
X
xuchenghua09 已提交
292

Z
zengyawen 已提交
293
normalizeUri(uri: string, callback: AsyncCallback\<string>): void
X
xuchenghua09 已提交
294

Z
zengyawen 已提交
295
将引用数据功能的给定uri转换为规范化uri(callback形式)。
X
xuchenghua09 已提交
296

Y
yuyaozhi 已提交
297
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
298

Z
zengyawen 已提交
299
**参数:**
X
xuchenghua09 已提交
300

Z
zengyawen 已提交
301 302 303
| 名称     | 类型                   | 必填 | 描述                                                         |
| -------- | ---------------------- | ---- | ------------------------------------------------------------ |
| uri      | string                 | 是   | 指示要规范化的uri对象。                                      |
W
wusongqing 已提交
304
| callback | AsyncCallback\<string> | 是   | 回调方法。如果数据功能支持uri规范化,则返回规范化uri对象;否则返回null。 |
X
xuchenghua09 已提交
305

Z
zengyawen 已提交
306
**示例:**
X
xuchenghua09 已提交
307 308 309 310 311 312 313 314 315 316 317 318 319

```js
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
DAHelper.normalizeUri(
    "dataability:///com.example.DataAbility",
    (err, data) => {
		console.info("==========================>Called=======================>");
});
```

Y
yuyaozhi 已提交
320
## DataAbilityHelper.normalizeUri
X
xuchenghua09 已提交
321

Z
zengyawen 已提交
322
normalizeUri(uri: string): Promise\<string>
X
xuchenghua09 已提交
323

Z
zengyawen 已提交
324
将引用数据功能的给定uri转换为规范化uri(Promise形式)。
X
xuchenghua09 已提交
325

Y
yuyaozhi 已提交
326
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
327

Z
zengyawen 已提交
328
**参数:**
X
xuchenghua09 已提交
329

Z
zengyawen 已提交
330 331 332
| 名称 | 类型   | 必填 | 描述                    |
| ---- | ------ | ---- | ----------------------- |
| uri  | string | 是   | 指示要规范化的uri对象。 |
X
xuchenghua09 已提交
333

Z
zengyawen 已提交
334
**返回值:**
Y
yuyaozhi 已提交
335

Z
zengyawen 已提交
336 337
| 类型             | 说明                                                   |
| ---------------- | ------------------------------------------------------ |
W
wusongqing 已提交
338
| Promise\<string> | 如果数据功能支持uri规范化,则返回规范化uri对象;否则返回null。 |
X
xuchenghua09 已提交
339

Z
zengyawen 已提交
340
**示例:**
X
xuchenghua09 已提交
341 342 343 344 345 346 347 348 349 350 351 352 353

```js
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
DAHelper.normalizeUri(
    "dataability:///com.example.DataAbility",
	).then((data) => {
		console.info("==========================>normalizeUriCallback=======================>");
});
```

Y
yuyaozhi 已提交
354
## DataAbilityHelper.denormalizeUri
X
xuchenghua09 已提交
355

Z
zengyawen 已提交
356
denormalizeUri(uri: string, callback: AsyncCallback\<string>): void
X
xuchenghua09 已提交
357

Z
zengyawen 已提交
358
将由normalizeUri(uri)生成的给定规范化uri转换为非规范化uri(callback形式)。
X
xuchenghua09 已提交
359

Y
yuyaozhi 已提交
360
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
361

Z
zengyawen 已提交
362
**参数:**
X
xuchenghua09 已提交
363

Z
zengyawen 已提交
364 365 366 367
| 名称     | 类型                   | 必填 | 描述                                                |
| -------- | ---------------------- | ---- | --------------------------------------------------- |
| uri      | string                 | 是   | 指示要规范化的uri对象。                             |
| callback | AsyncCallback\<string> | 是   | 回调方法。如果反规范化成功,则返回反规范化uri对象。 |
X
xuchenghua09 已提交
368

Z
zengyawen 已提交
369
**示例:**
X
xuchenghua09 已提交
370 371 372 373 374 375 376

```js
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
DAHelper.denormalizeUri(
ahjxliubao2's avatar
ahjxliubao2 已提交
377
    "dataability:///com.example.DataAbility",
X
xuchenghua09 已提交
378 379 380 381 382 383 384
    (err, data) => {
		console.info("==========================>Called=======================>");
});
```



Y
yuyaozhi 已提交
385
## DataAbilityHelper.denormalizeUri
X
xuchenghua09 已提交
386

Z
zengyawen 已提交
387
denormalizeUri(uri: string): Promise\<string>
X
xuchenghua09 已提交
388

Z
zengyawen 已提交
389
将由normalizeUri(uri)生成的给定规范化uri转换为非规范化uri(Promise形式)。
X
xuchenghua09 已提交
390

Y
yuyaozhi 已提交
391
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
392

Z
zengyawen 已提交
393
**参数:**
X
xuchenghua09 已提交
394

Z
zengyawen 已提交
395 396 397
| 名称 | 类型   | 必填 | 描述                    |
| ---- | ------ | ---- | ----------------------- |
| uri  | string | 是   | 指示要规范化的uri对象。 |
X
xuchenghua09 已提交
398

Z
zengyawen 已提交
399
**返回值:**
Y
yuyaozhi 已提交
400

Z
zengyawen 已提交
401 402 403 404 405
| 类型             | 说明                                      |
| ---------------- | ----------------------------------------- |
| Promise\<string> | 如果反规范化成功,则返回反规范化uri对象。 |

**示例:**
X
xuchenghua09 已提交
406 407 408 409 410 411 412 413 414 415 416 417 418

```js
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
DAHelper.denormalizeUri(
    "dataability:///com.example.DataAbility",
	).then((data) => {
		console.info("==========================>denormalizeUriCallback=======================>");
});
```

Y
yuyaozhi 已提交
419
## DataAbilityHelper.notifyChange
X
xuchenghua09 已提交
420

Z
zengyawen 已提交
421
notifyChange(uri: string, callback: AsyncCallback\<void>): void
X
xuchenghua09 已提交
422

Z
zengyawen 已提交
423
通知已注册的观察者uri指定的数据资源的更改(callback形式)。
X
xuchenghua09 已提交
424

Y
yuyaozhi 已提交
425
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
426

Z
zengyawen 已提交
427
**参数:**
X
xuchenghua09 已提交
428

Z
zengyawen 已提交
429 430 431 432
| 名称     | 类型                 | 必填 | 描述                     |
| -------- | -------------------- | ---- | ------------------------ |
| uri      | string               | 是   | 指示要操作的数据的路径。 |
| callback | AsyncCallback\<void> | 是   | 回调方法。               |
X
xuchenghua09 已提交
433

Z
zengyawen 已提交
434
**示例:**
X
xuchenghua09 已提交
435 436 437 438 439 440 441

```js
import featureAbility from '@ohos.ability.featureAbility'
var helper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
helper.notifyChange(
ahjxliubao2's avatar
ahjxliubao2 已提交
442
    "dataability:///com.example.DataAbility",
X
xuchenghua09 已提交
443 444 445 446 447
    (err) => {
		console.info("==========================>Called=======================>");
});
```

Y
yuyaozhi 已提交
448
## DataAbilityHelper.notifyChange
X
xuchenghua09 已提交
449

Z
zengyawen 已提交
450
notifyChange(uri: string): Promise\<void>
X
xuchenghua09 已提交
451

Z
zengyawen 已提交
452
通知已注册的观察者uri指定的数据资源的更改(Promise形式)。
X
xuchenghua09 已提交
453

Y
yuyaozhi 已提交
454
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
455

Z
zengyawen 已提交
456
**参数:**
X
xuchenghua09 已提交
457

Z
zengyawen 已提交
458 459 460
| 名称 | 类型   | 必填 | 描述                     |
| ---- | ------ | ---- | ------------------------ |
| uri  | string | 是   | 指示要操作的数据的路径。 |
X
xuchenghua09 已提交
461

Z
zengyawen 已提交
462
**返回值:**
Y
yuyaozhi 已提交
463

Z
zengyawen 已提交
464 465 466
| 类型           | 说明                  |
| -------------- | --------------------- |
| Promise\<void> | 返回值为Promise对象。 |
X
xuchenghua09 已提交
467

Z
zengyawen 已提交
468
**示例:**
X
xuchenghua09 已提交
469 470 471 472 473 474 475 476

```js
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
DAHelper.notifyChange(
    "dataability:///com.example.DataAbility",
ahjxliubao2's avatar
ahjxliubao2 已提交
477
	).then(() => {
X
xuchenghua09 已提交
478 479 480 481
		console.info("==========================>notifyChangeCallback=======================>");
});
```

Y
yuyaozhi 已提交
482
## DataAbilityHelper.insert
X
xuchenghua09 已提交
483

Z
zengyawen 已提交
484
insert(uri: string, valuesBucket: rdb.ValuesBucket, callback: AsyncCallback\<number>): void
X
xuchenghua09 已提交
485

Z
zengyawen 已提交
486
将单个数据记录插入数据库(callback形式)。
X
xuchenghua09 已提交
487

Y
yuyaozhi 已提交
488
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
489

Z
zengyawen 已提交
490
**参数:**
X
xuchenghua09 已提交
491

Z
zengyawen 已提交
492 493 494 495 496
| 名称         | 类型                   | 必填 | 描述                                                   |
| ------------ | ---------------------- | ---- | ------------------------------------------------------ |
| uri          | string                 | 是   | 指示要插入的数据的路径。                               |
| valuesBucket | rdb.ValuesBucket       | 是   | 指示要插入的数据记录。如果此参数为空,将插入一个空行。 |
| callback     | AsyncCallback\<number> | 是   | 回调方法,返回插入数据记录的索引。                     |
X
xuchenghua09 已提交
497

Z
zengyawen 已提交
498
**示例:**
X
xuchenghua09 已提交
499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518

```js
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,
}
DAHelper.insert(
    "dataability:///com.example.DataAbility",
    valueBucket,
    (err, data) => {
		console.info("==========================>Called=======================>");
});
```

Y
yuyaozhi 已提交
519
## DataAbilityHelper.insert
X
xuchenghua09 已提交
520

Z
zengyawen 已提交
521
insert(uri: string, valuesBucket: rdb.ValuesBucket): Promise\<number>
X
xuchenghua09 已提交
522

Z
zengyawen 已提交
523
将单个数据记录插入数据库(Promise形式)。
X
xuchenghua09 已提交
524

Y
yuyaozhi 已提交
525
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
526

Z
zengyawen 已提交
527
**参数:**
X
xuchenghua09 已提交
528

Z
zengyawen 已提交
529 530 531 532
| 名称         | 类型             | 必填 | 描述                                                   |
| ------------ | ---------------- | ---- | ------------------------------------------------------ |
| uri          | string           | 是   | 指示要插入的数据的路径。                               |
| valuesBucket | rdb.ValuesBucket | 是   | 指示要插入的数据记录。如果此参数为空,将插入一个空行。 |
X
xuchenghua09 已提交
533

Z
zengyawen 已提交
534
**返回值:**
Y
yuyaozhi 已提交
535

Z
zengyawen 已提交
536 537 538
| 类型             | 说明                     |
| ---------------- | ------------------------ |
| Promise\<number> | 返回插入数据记录的索引。 |
X
xuchenghua09 已提交
539

Z
zengyawen 已提交
540
**示例:**
X
xuchenghua09 已提交
541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560

```js
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,
}
DAHelper.insert(
    "dataability:///com.example.DataAbility",
    valueBucket
	).then((data) => {
		console.info("==========================>insertCallback=======================>");
});
```

Y
yuyaozhi 已提交
561
## DataAbilityHelper.batchInsert
X
xuchenghua09 已提交
562

Z
zengyawen 已提交
563
batchInsert(uri: string, valuesBuckets: Array<rdb.ValuesBucket>, callback: AsyncCallback\<number>): void
X
xuchenghua09 已提交
564

Z
zengyawen 已提交
565
插入数据库(callback形式)。
X
xuchenghua09 已提交
566

Y
yuyaozhi 已提交
567
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
568

Z
zengyawen 已提交
569
**参数:**
X
xuchenghua09 已提交
570

Z
zengyawen 已提交
571 572 573 574 575
| 名称         | 类型                    | 必填 | 描述                             |
| ------------ | ----------------------- | ---- | -------------------------------- |
| uri          | string                  | 是   | 指示要插入的数据的路径。         |
| valuesBucket | Array<rdb.ValuesBucket> | 是   | 指示要插入的数据记录。           |
| callback     | AsyncCallback\<number>  | 是   | 回调方法。返回插入的数据记录数。 |
X
xuchenghua09 已提交
576

Z
zengyawen 已提交
577
**示例:**
X
xuchenghua09 已提交
578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594

```js
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,})
DAHelper.batchInsert(
    "dataability:///com.example.DataAbility",
    cars,
    (err, data) => {
		console.info("==========================>Called=======================>");
});
```

Y
yuyaozhi 已提交
595
## DataAbilityHelper.batchInsert
X
xuchenghua09 已提交
596

Z
zengyawen 已提交
597
batchInsert(uri: string, valuesBuckets: Array<rdb.ValuesBucket>): Promise\<number>
X
xuchenghua09 已提交
598

Z
zengyawen 已提交
599
将多个数据记录插入数据库(Promise形式)。
X
xuchenghua09 已提交
600

Y
yuyaozhi 已提交
601
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
602

Z
zengyawen 已提交
603
**参数:**
X
xuchenghua09 已提交
604

Z
zengyawen 已提交
605 606 607 608
| 名称         | 类型                    | 必填 | 描述                     |
| ------------ | ----------------------- | ---- | ------------------------ |
| uri          | string                  | 是   | 指示要插入的数据的路径。 |
| valuesBucket | Array<rdb.ValuesBucket> | 是   | 指示要插入的数据记录。   |
X
xuchenghua09 已提交
609

Z
zengyawen 已提交
610
**返回值:**
Y
yuyaozhi 已提交
611

Z
zengyawen 已提交
612 613 614
| 类型             | 说明                   |
| ---------------- | ---------------------- |
| Promise\<number> | 返回插入的数据记录数。 |
X
xuchenghua09 已提交
615

Z
zengyawen 已提交
616
**示例:**
X
xuchenghua09 已提交
617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633

```js
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,})
DAHelper.batchInsert(
    "dataability:///com.example.DataAbility",
    cars
	).then((data) => {
		console.info("==========================>batchInsertCallback=======================>");
});
```

Y
yuyaozhi 已提交
634
## DataAbilityHelper.delete
X
xuchenghua09 已提交
635

Z
zengyawen 已提交
636
delete(uri: string, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\<number>): void
X
xuchenghua09 已提交
637

Z
zengyawen 已提交
638
从数据库中删除一个或多个数据记录(callback形式)。
X
xuchenghua09 已提交
639

Y
yuyaozhi 已提交
640
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
641

Z
zengyawen 已提交
642
**参数:**
X
xuchenghua09 已提交
643

Z
zengyawen 已提交
644 645 646 647 648
| 名称         | 类型                              | 必填 | 描述                                             |
| ------------ | --------------------------------- | ---- | ------------------------------------------------ |
| uri          | string                            | 是   | 指示要删除的数据的路径。                         |
| valuesBucket | dataAbility.DataAbilityPredicates | 是   | 指示筛选条件。当此参数为null时,应定义处理逻辑。 |
| callback     | AsyncCallback\<number>            | 是   | 回调方法。返回已删除的数据记录数。               |
X
xuchenghua09 已提交
649

Z
zengyawen 已提交
650
**示例:**
X
xuchenghua09 已提交
651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666

```js
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()
DAHelper.delete(
    "dataability:///com.example.DataAbility",
    da,
    (err, data) => {
		console.info("==========================>Called=======================>");
});
```

Y
yuyaozhi 已提交
667
## DataAbilityHelper.delete
X
xuchenghua09 已提交
668

Z
zengyawen 已提交
669
delete(uri: string, predicates: dataAbility.DataAbilityPredicates): Promise\<number>
X
xuchenghua09 已提交
670

Z
zengyawen 已提交
671
从数据库中删除一个或多个数据记录(Promise形式)。
X
xuchenghua09 已提交
672

Y
yuyaozhi 已提交
673
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
674

Z
zengyawen 已提交
675
**参数:**
X
xuchenghua09 已提交
676

Z
zengyawen 已提交
677 678 679 680
| 名称         | 类型                              | 必填 | 描述                                             |
| ------------ | --------------------------------- | ---- | ------------------------------------------------ |
| uri          | string                            | 是   | 指示要删除的数据的路径。                         |
| valuesBucket | dataAbility.DataAbilityPredicates | 是   | 指示筛选条件。当此参数为null时,应定义处理逻辑。 |
X
xuchenghua09 已提交
681

Z
zengyawen 已提交
682
**返回值:**
Y
yuyaozhi 已提交
683

Z
zengyawen 已提交
684 685 686
| 类型             | 说明                     |
| ---------------- | ------------------------ |
| Promise\<number> | 返回已删除的数据记录数。 |
X
xuchenghua09 已提交
687

Z
zengyawen 已提交
688
**示例:**
X
xuchenghua09 已提交
689 690 691 692 693 694 695 696 697 698 699 700 701 702 703

```js
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
let da = new ohos_data_ability.DataAbilityPredicates()
DAHelper.delete(
    "dataability:///com.example.DataAbility",
    da
	).then((data) => {
		console.info("==========================>deleteCallback=======================>");
});
```

Y
yuyaozhi 已提交
704
## DataAbilityHelper.update
X
xuchenghua09 已提交
705

Z
zengyawen 已提交
706
update(uri: string, valuesBucket: rdb.ValuesBucket, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\<number>): void
X
xuchenghua09 已提交
707

Z
zengyawen 已提交
708
更新数据库中的数据记录(callback形式)。
X
xuchenghua09 已提交
709

Y
yuyaozhi 已提交
710
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
711

Z
zengyawen 已提交
712
**参数:**
X
xuchenghua09 已提交
713

Z
zengyawen 已提交
714 715 716 717 718 719
| 名称         | 类型                              | 必填 | 描述                                             |
| ------------ | --------------------------------- | ---- | ------------------------------------------------ |
| uri          | string                            | 是   | 指示要更新的数据的路径。                         |
| valuesBucket | rdb.ValuesBucket                  | 是   | 指示要更新的数据。                               |
| predicates   | dataAbility.DataAbilityPredicates | 是   | 指示筛选条件。当此参数为null时,应定义处理逻辑。 |
| callback     | AsyncCallback\<number>            | 是   | 回调方法,返回更新的数据记录数。                 |
X
xuchenghua09 已提交
720

Z
zengyawen 已提交
721
**示例:**
X
xuchenghua09 已提交
722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744

```js
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()
DAHelper.update(
    "dataability:///com.example.DataAbility",
    va,
    da,
    (err, data) => {
		console.info("==========================>Called=======================>");
});
```

Y
yuyaozhi 已提交
745
## DataAbilityHelper.update
X
xuchenghua09 已提交
746

Z
zengyawen 已提交
747
update(uri: string, valuesBucket: rdb.ValuesBucket, predicates: dataAbility.DataAbilityPredicates): Promise\<number>
X
xuchenghua09 已提交
748

Z
zengyawen 已提交
749
更新数据库中的数据记录(Promise形式)。
X
xuchenghua09 已提交
750

Y
yuyaozhi 已提交
751
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
752

Z
zengyawen 已提交
753
**参数:**
X
xuchenghua09 已提交
754

Z
zengyawen 已提交
755 756 757 758 759
| 名称         | 类型                              | 必填 | 描述                                             |
| ------------ | --------------------------------- | ---- | ------------------------------------------------ |
| uri          | string                            | 是   | 指示要更新的数据的路径。                         |
| valuesBucket | rdb.ValuesBucket                  | 是   | 指示要更新的数据。                               |
| predicates   | dataAbility.DataAbilityPredicates | 是   | 指示筛选条件。当此参数为null时,应定义处理逻辑。 |
X
xuchenghua09 已提交
760

Z
zengyawen 已提交
761
**返回值:**
Y
yuyaozhi 已提交
762

Z
zengyawen 已提交
763 764
| 类型             | 说明                                         |
| ---------------- | -------------------------------------------- |
W
wusongqing 已提交
765
| Promise\<number> | Promise中包含更新的数据记录数。 。 |
X
xuchenghua09 已提交
766

Z
zengyawen 已提交
767
**示例:**
X
xuchenghua09 已提交
768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790

```js
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()
DAHelper.update(
    "dataability:///com.example.DataAbility",
    va,
    da
	).then((data) => {
		console.info("==========================>updateCallback=======================>");
});
```

Y
yuyaozhi 已提交
791
## DataAbilityHelper.query
X
xuchenghua09 已提交
792

Z
zengyawen 已提交
793
query(uri: string, columns: Array\<string>, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\<ResultSet>): void
X
xuchenghua09 已提交
794

Z
zengyawen 已提交
795
查询数据库中的数据(callback形式)。
X
xuchenghua09 已提交
796

Y
yuyaozhi 已提交
797
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
798

Z
zengyawen 已提交
799
**参数:**
X
xuchenghua09 已提交
800

Z
zengyawen 已提交
801 802 803 804 805 806
| 名称       | 类型                              | 必填 | 描述                                             |
| ---------- | --------------------------------- | ---- | ------------------------------------------------ |
| uri        | string                            | 是   | 指示要查询的数据的路径。                         |
| columns    | rdb.ValuesBucket                  | 是   | 指示要查询的列。如果此参数为空,则查询所有列。   |
| predicates | dataAbility.DataAbilityPredicates | 是   | 指示筛选条件。当此参数为null时,应定义处理逻辑。 |
| callback   | AsyncCallback\<ResultSet>         | 是   | 回调方法,返回查询结果。                         |
X
xuchenghua09 已提交
807

Z
zengyawen 已提交
808
**示例:**
X
xuchenghua09 已提交
809 810 811 812 813 814 815

```js
import featureAbility from '@ohos.ability.featureAbility'
import ohos_data_ability from '@ohos.data.dataability'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
ahjxliubao2's avatar
ahjxliubao2 已提交
816
var cars=new Array("value1", "value2", "value3", "value4");
X
xuchenghua09 已提交
817 818 819 820 821 822 823 824 825 826 827 828
let da = new ohos_data_ability.DataAbilityPredicates()
DAHelper.query(
    "dataability:///com.example.DataAbility",
    cars,
    da,
    (err, data) => {
		console.info("==========================>Called=======================>");
});
```



Y
yuyaozhi 已提交
829
## DataAbilityHelper.query
X
xuchenghua09 已提交
830

Z
zengyawen 已提交
831
query(uri: string, columns: Array\<string>, predicates: dataAbility.DataAbilityPredicates): Promise\<ResultSet>
X
xuchenghua09 已提交
832

Z
zengyawen 已提交
833
查询数据库中的数据(Promise形式)。
X
xuchenghua09 已提交
834

Y
yuyaozhi 已提交
835
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
836

Z
zengyawen 已提交
837
**参数:**
X
xuchenghua09 已提交
838

Z
zengyawen 已提交
839 840 841 842 843
| 名称       | 类型                              | 必填 | 描述                                             |
| ---------- | --------------------------------- | ---- | ------------------------------------------------ |
| uri        | string                            | 是   | 指示要查询的数据的路径。                         |
| columns    | rdb.ValuesBucket                  | 是   | 指示要查询的列。如果此参数为空,则查询所有列。   |
| predicates | dataAbility.DataAbilityPredicates | 是   | 指示筛选条件。当此参数为null时,应定义处理逻辑。 |
X
xuchenghua09 已提交
844

Z
zengyawen 已提交
845
**返回值:**
Y
yuyaozhi 已提交
846

Z
zengyawen 已提交
847 848 849
| 类型                | 说明           |
| ------------------- | -------------- |
| Promise\<ResultSet> | 返回查询结果。 |
X
xuchenghua09 已提交
850

Z
zengyawen 已提交
851
**示例:**
X
xuchenghua09 已提交
852 853 854 855 856 857 858

```js
import featureAbility from '@ohos.ability.featureAbility'
import ohos_data_ability from '@ohos.data.dataability'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
ahjxliubao2's avatar
ahjxliubao2 已提交
859
var cars=new Array("value1", "value2", "value3", "value4");
X
xuchenghua09 已提交
860 861 862 863 864 865 866 867
let da = new ohos_data_ability.DataAbilityPredicates()
DAHelper.query(
    "dataability:///com.example.DataAbility",
    cars,
    da
	).then((data) => {
		console.info("==========================>queryCallback=======================>");
});
D
dy 已提交
868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942
```

## DataAbilityHelper.call

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

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

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

**参数:**

| 名称       | 类型                              | 必填 | 描述                                             |
| ---------- | --------------------------------- | ---- | ------------------------------------------------ |
| uri        | string                 | 是   | 指定待处理的DataAbility。例:"dataability:///com.example.xxx.xxxx"           |
| method    | string                  | 是   | 被调用的方法名。   |
| arg      | string                   | 是   |需传入的参数。      |
| extras   | [PacMap](#pacmap)        | 是   | 键值对参数。       |

**返回值:**

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

**示例:**

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

let dataAbilityHelper = featureAbility.acquireDataAbilityHelper("dataability:///com.example.jsapidemo.UserDataAbility");
dataAbilityHelper.call("dataability:///com.example.jsapidemo.UserDataAbility", "method", "arg", {"key1":"value1"}).then((data) => {
    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

**参数:**

| 名称       | 类型                              | 必填 | 描述                                             |
| ---------- | --------------------------------- | ---- | ------------------------------------------------ |
| uri        | string                 | 是   | 指定待处理的DataAbility。例:"dataability:///com.example.xxx.xxxx"           |
| method    | string                  | 是   | 被调用的方法名。   |
| arg      | string                   | 是   |需传入的参数。      |
| extras   | [PacMap](#pacmap)        | 是   | 键值对参数。       |
| callback | AsyncCallback<[PacMap](#pacmap)> | 是 | 返回值。     |

**示例:**

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

let dataAbilityHelper = featureAbility.acquireDataAbilityHelper("dataability:///com.example.jsapidemo.UserDataAbility");
dataAbilityHelper.call("dataability:///com.example.jsapidemo.UserDataAbility", "method", "arg", {"key1":"value1"}, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + err);
        return;
    }
    console.info('Operation succeeded: ' + data);
});
```
## PacMap

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