You need to sign in or sign up before continuing.
js-apis-data-dataShare.md 39.0 KB
Newer Older
S
songruirui 已提交
1
# DataShare
S
songruirui 已提交
2

S
songruirui 已提交
3
**DataShare**用于应用管理其自身数据,同时支持同个设备上不同应用间的数据共享。
S
songruirui 已提交
4 5

>**说明:** 
S
songruirui 已提交
6
>
S
songruirui 已提交
7 8 9 10 11
>本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。


## 导入模块

S
songruirui 已提交
12
```ts
S
songruirui 已提交
13 14 15 16 17 18 19
import Ability from '@ohos.application.Ability'
import dataShare from '@ohos.data.dataShare'
```


## dataShare.createDataShareHelper

S
songruirui 已提交
20
createDataShareHelper(context: Context, uri: string, callback: AsyncCallback<DataShareHelper>): void
S
songruirui 已提交
21

S
songruirui 已提交
22
创建DataShareHelper实例。使用callback异步回调。
S
songruirui 已提交
23

S
songruirui 已提交
24
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
25 26 27

**参数:**

S
songruirui 已提交
28 29 30 31
| 参数名   | 参数类型                                                 | 必填 | 说明                                                         |
| -------- | -------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context  | [Context](js-apis-application-context.md#context)        | 是   | 应用的上下文环境。                                           |
| uri      | string                                                   | 是   | 指示要连接的服务端应用的路径。                               |
S
songruirui 已提交
32
| callback | AsyncCallback<[DataShareHelper](#datasharehelper)> | 是   | 回调函数。当创建DataShareHelper实例成功,err为undefined,data为获取到的DataShareHelper实例;否则为错误对象。 |
S
songruirui 已提交
33 34 35

**示例:**

S
songruirui 已提交
36 37 38
```ts
import dataShare from '@ohos.data.dataShare'

S
修改  
songruirui 已提交
39 40 41
let uri = ("datashare:///com.samples.datasharetest.DataShare");
let dataShareHelper;
dataShare.createDataShareHelper(this.context, uri, (err, data) => {
S
songruirui 已提交
42
    if (err != undefined) {
S
songruirui 已提交
43
        console.info("createDataShareHelper failed, error message : " + err);
S
songruirui 已提交
44
    } else {
S
songruirui 已提交
45
        console.info("createDataShareHelper succeed, data : " + data);
S
修改  
songruirui 已提交
46
        dataShareHelper = data;
S
songruirui 已提交
47 48 49 50
    }
});
```

S
songruirui 已提交
51 52 53 54
## dataShare.createDataShareHelper

createDataShareHelper(context: Context, uri: string): Promise<DataShareHelper>

S
songruirui 已提交
55
创建DataShareHelper实例。使用Promise异步回调。
S
songruirui 已提交
56 57 58 59 60

**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer

**参数:**

S
songruirui 已提交
61 62 63 64
| 参数名  | 参数类型                                          | 必填 | 说明                           |
| ------- | ------------------------------------------------- | ---- | ------------------------------ |
| context | [Context](js-apis-application-context.md#context) | 是   | 应用的上下文环境。             |
| uri     | string                                            | 是   | 指示要连接的服务端应用的路径。 |
S
songruirui 已提交
65 66 67

**返回值:**

S
songruirui 已提交
68 69 70
| 类型                                               | 说明                                   |
| -------------------------------------------------- | -------------------------------------- |
| Promise<[DataShareHelper](#datasharehelper)> | Promise对象。返回DataShareHelper实例。 |
S
songruirui 已提交
71 72 73 74 75 76

**示例:**

```ts
import dataShare from '@ohos.data.dataShare'

S
修改  
songruirui 已提交
77 78 79
let uri = ("datashare:///com.samples.datasharetest.DataShare");
let dataShareHelper;
dataShare.createDataShareHelper(this.context, uri).then((data) => {
S
songruirui 已提交
80
    console.info("createDataShareHelper succeed, data : " + data);
S
修改  
songruirui 已提交
81
    dataShareHelper = data;
S
songruirui 已提交
82
}).catch((err) => {
S
songruirui 已提交
83
	console.info("createDataShareHelper failed, error message : " + err); 
S
songruirui 已提交
84 85 86
})
```

S
songruirui 已提交
87 88
## DataShareHelper

S
修改  
songruirui 已提交
89
DataShare管理工具实例,可使用此实例访问或管理服务端的数据。在调用DataShareHelper提供的方法前,需要先通过[createDataShareHelper](#datasharecreatedatasharehelper)构建一个实例。
S
songruirui 已提交
90

S
songruirui 已提交
91 92
### openFile

S
songruirui 已提交
93
openFile(uri: string, mode: string, callback: AsyncCallback<number>): void
S
songruirui 已提交
94

S
songruirui 已提交
95
打开指定路径的文件。使用callback异步回调。
S
songruirui 已提交
96

S
songruirui 已提交
97 98
此接口仅可在Stage模型下使用。

S
songruirui 已提交
99
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
100 101 102 103 104 105

**参数:**

| 名称     | 类型                  | 必填 | 描述                               |
| -------- | --------------------- | ---- | ---------------------------------- |
| uri      | string                | 是   | 指示要打开的文件的路径。           |
S
songruirui 已提交
106
| mode     | string                | 是   | 指示文件打开模式,如“r”表示只读访问,“w”表示只写访问(擦除文件中当前的任何数据),“wa”表示附加到任何现有数据的写访问,“rw”表示对任何现有数据的读写访问。 |
S
songruirui 已提交
107
| callback | AsyncCallback<number> | 是   | 回调函数。当打开指定路径的文件成功,err为undefined,data为获取到的文件描述符;否则为错误对象。 |
S
songruirui 已提交
108 109 110

**示例:**

S
songruirui 已提交
111
```ts
S
songruirui 已提交
112
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
113 114
dataShareHelper.openFile(uri, "rwt", (err, data) => {
    if (err != undefined) {
S
songruirui 已提交
115
        console.info("openFile failed, error message : " + err);
S
songruirui 已提交
116
    }erse {
S
songruirui 已提交
117
        console.info("openFile succeed, data : " + data);
S
songruirui 已提交
118 119 120 121 122 123 124
        let fd = data;
    }
});
```

### openFile

S
songruirui 已提交
125
openFile(uri: string, mode: string): Promise<number>
S
songruirui 已提交
126

S
songruirui 已提交
127
打开指定路径的文件。使用Promise异步回调。
S
songruirui 已提交
128

S
songruirui 已提交
129 130
此接口仅可在Stage模型下使用。

S
songruirui 已提交
131
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
132 133 134

**参数:**

S
songruirui 已提交
135 136 137 138
| 名称 | 类型   | 必填 | 描述                                                         |
| ---- | ------ | ---- | ------------------------------------------------------------ |
| uri  | string | 是   | 指示要打开的文件的路径                                       |
| mode | string | 是   | 指示文件打开模式,如“r”表示只读访问,“w”表示只写访问(擦除文件中当前的任何数据),“wa”表示附加到任何现有数据的写访问,“rw”表示对任何现有数据的读写访问。 |
S
songruirui 已提交
139 140 141 142 143

**返回值:**

| 类型            | 说明             |
| --------------- | ---------------- |
S
songruirui 已提交
144
| Promise<number> | Promise对象。返回文件描述符。 |
S
songruirui 已提交
145 146 147

**示例:**

S
songruirui 已提交
148
```ts
S
songruirui 已提交
149
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
150
dataShareHelper.openFile(uri, "rwt").then((data) => {
S
songruirui 已提交
151
    console.info("openFile succeed, data : " + data);
S
songruirui 已提交
152
    let fd = data;
S
songruirui 已提交
153
}).catch((err) => {
S
songruirui 已提交
154
	console.info("openFile failed, error message : " + err); 
S
songruirui 已提交
155 156 157 158 159
})
```

### on('dataChange')

S
songruirui 已提交
160
on(type: 'dataChange', uri: string, callback: AsyncCallback<void>): void
S
songruirui 已提交
161

S
songruirui 已提交
162 163 164
订阅指定URI对应数据的数据变更事件。若用户(订阅者)已注册了观察者,当有其他用户触发了变更通知时(调用了下文中的notifyChange方法),订阅者将会接收到callback通知。使用callback异步回调。

此接口仅可在Stage模型下使用。
S
songruirui 已提交
165

S
songruirui 已提交
166
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
167 168 169 170 171

**参数:**

| 名称     | 类型                 | 必填 | 描述                     |
| -------- | -------------------- | ---- | ------------------------ |
S
songruirui 已提交
172 173
| type     | string               | 是   | 订阅的事件/回调类型,支持的事件为'dataChange',当数据更改时,触发该事件。 |
| uri      | string               | 是   | 表示指定的数据路径。 |
S
songruirui 已提交
174
| callback | AsyncCallback<void> | 是   | 回调函数。当有其他用户触发了变更通知时调用,err为undefined;否则不被触发或为错误对象。 |
S
songruirui 已提交
175 176 177

**示例:**

S
songruirui 已提交
178
```ts
S
修改  
songruirui 已提交
179
function onCallback() {
S
songruirui 已提交
180 181
    console.info("**** Observer on callback ****");
}
S
songruirui 已提交
182
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
修改  
songruirui 已提交
183
dataShareHelper.on("dataChange", uri, onCallback);
S
songruirui 已提交
184 185 186 187
```

### off('dataChange')

S
songruirui 已提交
188
off(type: 'dataChange', uri: string, callback?: AsyncCallback<void>): void
S
songruirui 已提交
189

S
songruirui 已提交
190
取消订阅指定URI对应的数据资源的变更通知。使用callback异步回调。
S
songruirui 已提交
191

S
songruirui 已提交
192 193
此接口仅可在Stage模型下使用。

S
songruirui 已提交
194
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
195

S
songruirui 已提交
196 197 198 199
**参数:**

| 名称     | 类型                 | 必填 | 描述                     |
| -------- | -------------------- | ---- | ------------------------ |
S
songruirui 已提交
200 201
| type     | string               | 是   | 取消订阅的事件/回调类型,支持的事件为'dataChange'。 |
| uri      | string               | 是   | 表示指定的数据路径。 |
S
songruirui 已提交
202
| callback | AsyncCallback<void> | 否   | 回调函数。当取消订阅指定URI对应的数据资源的变更通知成功,err为undefined;否则为错误对象。 |
S
songruirui 已提交
203 204 205

**示例:**

S
songruirui 已提交
206
```ts
S
修改  
songruirui 已提交
207
function offCallback() {
S
songruirui 已提交
208 209
    console.info("**** Observer off callback ****");
}
S
songruirui 已提交
210
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
修改  
songruirui 已提交
211
dataShareHelper.off("dataChange", uri, offCallback);
S
songruirui 已提交
212 213
```

S
songruirui 已提交
214
### insert
S
songruirui 已提交
215

S
songruirui 已提交
216
insert(uri: string, value: ValuesBucket, callback: AsyncCallback<number>): void
S
songruirui 已提交
217

S
songruirui 已提交
218
将单条数据插入数据库。使用callback异步回调。
S
songruirui 已提交
219

S
songruirui 已提交
220 221
此接口仅可在Stage模型下使用。

S
songruirui 已提交
222
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
223 224 225

**参数:**

S
songruirui 已提交
226 227 228 229 230
| 名称     | 类型                                                      | 必填 | 描述                                                         |
| -------- | --------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| uri      | string                                                    | 是   | 指示要插入的数据的路径。                                     |
| value    | [ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket) | 是   | 指示要插入的数据。如果此参数为空,将插入一个空行。           |
| callback | AsyncCallback&lt;number&gt;                               | 是   | 回调函数。当将单条数据插入数据库成功,err为undefined,data为获取到的插入数据记录的索引;否则为错误对象。<br />因部分数据库(如KVDB)的相应接口并不支持返回索引,故若服务端使用了不支持索引的数据库,则此callback也无法返回索引值。 |
S
songruirui 已提交
231 232 233 234

**示例:**

```ts
S
songruirui 已提交
235
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
236 237 238 239 240 241 242 243 244 245 246
const valueBucket = {
    "name": "rose",
    "age": 22,
    "salary": 200.5,
}
dataShareHelper.insert(uri, valueBucket, (err, data) => {
    if (err != undefined) {
        console.log("insert failed, error message : " + err);
    }else{
        console.log("insert succeed, data : " + data);
    }
S
songruirui 已提交
247 248 249
});
```

S
songruirui 已提交
250
### insert
S
songruirui 已提交
251

S
songruirui 已提交
252
insert(uri: string, value: ValuesBucket): Promise&lt;number&gt;
S
songruirui 已提交
253

S
songruirui 已提交
254
将单条数据插入数据库。使用Promise异步回调。
S
songruirui 已提交
255

S
songruirui 已提交
256 257
此接口仅可在Stage模型下使用。

S
songruirui 已提交
258
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
259 260 261

**参数:**

S
songruirui 已提交
262 263 264 265
| 名称  | 类型                                                      | 必填 | 描述                                               |
| ----- | --------------------------------------------------------- | ---- | -------------------------------------------------- |
| uri   | string                                                    | 是   | 指示要插入的数据的路径。                           |
| value | [ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket) | 是   | 指示要插入的数据。如果此参数为空,将插入一个空行。 |
S
songruirui 已提交
266 267 268

**返回值:**

S
songruirui 已提交
269 270 271
| 类型             | 说明                                                         |
| ---------------- | ------------------------------------------------------------ |
| Promise&lt;number&gt; | Promise对象。返回插入数据记录的索引。<br />因部分数据库(如KVDB)的相应接口并不支持返回索引,故若服务端使用了不支持索引的数据库,则此Promise也无法返回索引值。 |
S
songruirui 已提交
272 273 274 275

**示例:**

```ts
S
songruirui 已提交
276
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
277 278 279 280 281 282 283 284 285 286
const valueBucket = {
    "name": "rose1",
    "age": 221,
    "salary": 20.5,
}
dataShareHelper.insert(uri, valueBucket).then((data) => {
    console.log("insert succeed, data : " + data);
}).catch((err) => {
    console.log("insert failed, error message : " + err);
});
S
songruirui 已提交
287 288
```

S
songruirui 已提交
289
### delete
S
songruirui 已提交
290

S
songruirui 已提交
291
delete(uri: string, predicates: dataSharePredicates.DataSharePredicates, callback: AsyncCallback&lt;number&gt;): void
S
songruirui 已提交
292

S
songruirui 已提交
293
从数据库中删除一条或多条数据记录。使用callback异步回调。
S
songruirui 已提交
294

S
songruirui 已提交
295 296
此接口仅可在Stage模型下使用。

S
songruirui 已提交
297
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
298 299 300

**参数:**

S
songruirui 已提交
301 302 303 304 305
| 名称       | 类型                                                         | 必填 | 描述                                                         |
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| uri        | string                                                       | 是   | 指示要删除的数据的路径。                                     |
| predicates | [DataSharePredicates](js-apis-data-DataSharePredicates.md#datasharepredicates) | 是   | 指示筛选条件。<br />delete接口所支持的谓词方法取决于服务端所选用的数据库,如KVDB的删除目前仅支持inKeys谓词。 |
| callback   | AsyncCallback&lt;number&gt;                                  | 是   | 回调函数。当从数据库中删除一条或多条数据记录成功,err为undefined,data为获取到的已删除的数据记录数;否则为错误对象。<br />因部分数据库(如KVDB)的相应接口并不提供相应支持,故若服务端使用此数据库,则此callback也无法返回删除的数据记录数。 |
S
songruirui 已提交
306 307 308

**示例:**

S
songruirui 已提交
309
```ts
S
songruirui 已提交
310 311
import dataSharePredicates from '@ohos.data.dataSharePredicates'

S
songruirui 已提交
312
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
313 314 315
let da = new dataSharePredicates.DataSharePredicates();
da.equalTo("name", "ZhangSan");
dataShareHelper.delete(uri, da, (err, data) => {
S
songruirui 已提交
316
    if (err != undefined) {
S
songruirui 已提交
317
        console.log("delete failed, error message : " + err);
S
songruirui 已提交
318
    }else{
S
songruirui 已提交
319
        console.log("delete succeed, data : " + data);
S
修改  
songruirui 已提交
320
    }
S
songruirui 已提交
321 322 323
});
```

S
songruirui 已提交
324
### delete
S
songruirui 已提交
325

S
songruirui 已提交
326
delete(uri: string, predicates: dataSharePredicates.DataSharePredicates): Promise&lt;number&gt;
S
songruirui 已提交
327

S
songruirui 已提交
328
从数据库中删除一条或多条数据记录。使用Promise异步回调。
S
songruirui 已提交
329

S
songruirui 已提交
330 331
此接口仅可在Stage模型下使用。

S
songruirui 已提交
332
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
333 334 335

**参数:**

S
songruirui 已提交
336 337 338 339
| 名称       | 类型                                                         | 必填 | 描述                                                         |
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| uri        | string                                                       | 是   | 指示要删除的数据的路径。                                     |
| predicates | [DataSharePredicates](js-apis-data-DataSharePredicates.md#datasharepredicates) | 是   | 指示筛选条件。<br />delete接口所支持的谓词方法取决于服务端所选用的数据库,如KVDB的删除目前仅支持inKeys谓词。 |
S
songruirui 已提交
340 341 342

**返回值:**

S
songruirui 已提交
343 344 345
| 类型             | 说明                                                         |
| ---------------- | ------------------------------------------------------------ |
| Promise&lt;number&gt; | Promise对象。返回已删除的数据记录数。<br />因部分数据库(如KVDB)的相应接口并不提供相应支持,故若服务端使用此数据库,则此Promise也无法返回删除的数据记录数。 |
S
songruirui 已提交
346 347 348

**示例:**

S
songruirui 已提交
349
```ts
S
songruirui 已提交
350 351
import dataSharePredicates from '@ohos.data.dataSharePredicates'

S
songruirui 已提交
352
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
353 354 355 356
let da = new dataSharePredicates.DataSharePredicates();
da.equalTo("name", "ZhangSan");
dataShareHelper.delete(uri, da).then((data) => {
    console.log("delete succeed, data : " + data);
S
songruirui 已提交
357
}).catch((err) => {
S
songruirui 已提交
358
    console.log("delete failed, error message : " + err);
S
songruirui 已提交
359 360 361
});
```

S
songruirui 已提交
362
### query
S
songruirui 已提交
363

S
songruirui 已提交
364
query(uri: string, predicates: dataSharePredicates.DataSharePredicates, columns: Array&lt;string&gt;, callback: AsyncCallback&lt;DataShareResultSet&gt;): void
S
songruirui 已提交
365

S
songruirui 已提交
366
查询数据库中的数据。使用callback异步回调。
S
songruirui 已提交
367

S
songruirui 已提交
368 369
此接口仅可在Stage模型下使用。

S
songruirui 已提交
370
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
371

S
songruirui 已提交
372 373
**参数:**

S
songruirui 已提交
374 375 376 377 378 379
| 名称       | 类型                                                         | 必填 | 描述                                                         |
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| uri        | string                                                       | 是   | 指示要查询的数据的路径。                                     |
| predicates | [DataSharePredicates](js-apis-data-DataSharePredicates.md#datasharepredicates) | 是   | 指示筛选条件。<br />query接口所支持的谓词方法取决于服务端所选用的数据库,如KVDB目前仅支持inKeys和prefixKey。 |
| columns    | Array&lt;string&gt;                                          | 是   | 指示要查询的列。如果此参数为空,则查询所有列。               |
| callback   | AsyncCallback&lt;[DataShareResultSet](js-apis-data-DataShareResultSet.md#datashareresultset)&gt; | 是   | 回调函数。当查询数据库中的数据成功,err为undefined,data为获取到的查询到的结果集;否则为错误对象。 |
S
songruirui 已提交
380 381 382

**示例:**

S
songruirui 已提交
383
```ts
S
songruirui 已提交
384 385
import dataSharePredicates from '@ohos.data.dataSharePredicates'

S
songruirui 已提交
386
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
387 388 389 390
let columns = ["*"];
let da = new dataSharePredicates.DataSharePredicates();
da.equalTo("name", "ZhangSan");
dataShareHelper.query(uri, da, columns, (err, data) => {
S
songruirui 已提交
391
    if (err != undefined) {
S
songruirui 已提交
392
        console.log("query failed, error message : " + err);
S
songruirui 已提交
393
    }else{
S
songruirui 已提交
394
        console.log("query succeed, rowCount : " + data.rowCount);
S
songruirui 已提交
395
    }
S
songruirui 已提交
396 397 398
});
```

S
songruirui 已提交
399
### query
S
songruirui 已提交
400

S
songruirui 已提交
401
query(uri: string, predicates: dataSharePredicates.DataSharePredicates, columns: Array&lt;string&gt;): Promise&lt;DataShareResultSet&gt;
S
songruirui 已提交
402

S
songruirui 已提交
403
查询数据库中的数据。使用Promise异步回调。
S
songruirui 已提交
404

S
songruirui 已提交
405 406
此接口仅可在Stage模型下使用。

S
songruirui 已提交
407
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
408

S
songruirui 已提交
409 410
**参数:**

S
songruirui 已提交
411 412 413 414 415
| 名称       | 类型                                                         | 必填 | 描述                                                         |
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| uri        | string                                                       | 是   | 指示要查询的数据的路径。                                     |
| predicates | [DataSharePredicates](js-apis-data-DataSharePredicates.md#datasharepredicates) | 是   | 指示筛选条件。<br />query接口所支持的谓词方法取决于服务端所选用的数据库,如KVDB目前仅支持inKeys和prefixKey。 |
| columns    | Array&lt;string&gt;                                          | 是   | 指示要查询的列。如果此参数为空,则查询所有列。               |
S
songruirui 已提交
416 417 418

**返回值:**

S
songruirui 已提交
419 420 421
| 类型                                                         | 说明                              |
| ------------------------------------------------------------ | --------------------------------- |
| Promise&lt;[DataShareResultSet](js-apis-data-DataShareResultSet.md#datashareresultset)&gt; | Promise对象。返回查询到的结果集。 |
S
songruirui 已提交
422 423 424

**示例:**

S
songruirui 已提交
425
```ts
S
songruirui 已提交
426 427
import dataSharePredicates from '@ohos.data.dataSharePredicates'

S
songruirui 已提交
428
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
429 430 431 432 433
let columns = ["*"];
let da = new dataSharePredicates.DataSharePredicates();
da.equalTo("name", "ZhangSan");
dataShareHelper.query(uri, da, columns).then((data) => {
    console.log("query succeed, rowCount : " + data.rowCount);
S
songruirui 已提交
434
}).catch((err) => {
S
songruirui 已提交
435
    console.log("query failed, error message : " + err);
S
songruirui 已提交
436 437 438
});
```

S
songruirui 已提交
439
### update
S
songruirui 已提交
440

S
songruirui 已提交
441
update(uri: string, predicates: dataSharePredicates.DataSharePredicates, value: ValuesBucket, callback: AsyncCallback&lt;number&gt;): void
S
songruirui 已提交
442

S
songruirui 已提交
443
更新数据库中的数据记录。使用callback异步回调。
S
songruirui 已提交
444

S
songruirui 已提交
445 446
此接口仅可在Stage模型下使用。

S
songruirui 已提交
447
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
448 449 450

**参数:**

S
songruirui 已提交
451 452 453 454 455 456
| 名称       | 类型                                                         | 必填 | 描述                                                         |
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| uri        | string                                                       | 是   | 指示要更新的数据的路径。                                     |
| predicates | [DataSharePredicates](js-apis-data-DataSharePredicates.md#datasharepredicates) | 是   | 指示筛选条件。<br />update接口是否支持谓词筛选条件取决于服务端所选用的数据库,如KVDB目前并不支持谓词筛选条件,仅RDB支持。 |
| value      | [ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket)    | 是   | 指示要更新的数据。                                           |
| callback   | AsyncCallback&lt;number&gt;                                  | 是   | 回调函数。当更新数据库中的数据记录成功,err为undefined,data为获取到的更新的数据记录数;否则为错误对象。<br />因部分数据库(如KVDB)的相应接口并不提供相应支持,故若服务端使用此数据库,则此callback也无法返回更新的数据记录数。 |
S
songruirui 已提交
457 458 459

**示例:**

S
songruirui 已提交
460
```ts
S
songruirui 已提交
461 462
import dataSharePredicates from '@ohos.data.dataSharePredicates'

S
songruirui 已提交
463
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
464 465 466 467 468 469 470 471 472
let da = new dataSharePredicates.DataSharePredicates();
da.equalTo("name", "ZhangSan");
const va = {
    "name": "roe1",
    "age": 21,
    "salary": 20.5,
   
}
dataShareHelper.update(uri, da, va, (err, data) => {
S
songruirui 已提交
473
    if (err != undefined) {
S
songruirui 已提交
474
        console.log("update failed, error message : " + err);
S
songruirui 已提交
475
    }else{
S
songruirui 已提交
476
        console.log("update succeed, data : " + data);
S
songruirui 已提交
477
    }
S
songruirui 已提交
478 479 480
});
```

S
songruirui 已提交
481
### update
S
songruirui 已提交
482

S
songruirui 已提交
483
update(uri: string, predicates: dataSharePredicates.DataSharePredicates, value: ValuesBucket): Promise&lt;number&gt;
S
songruirui 已提交
484

S
songruirui 已提交
485
更新数据库中的数据记录。使用Promise异步回调。
S
songruirui 已提交
486

S
songruirui 已提交
487 488
此接口仅可在Stage模型下使用。

S
songruirui 已提交
489
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
490 491 492

**参数:**

S
songruirui 已提交
493 494 495 496 497
| 名称       | 类型                                                         | 必填 | 描述                                                         |
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| uri        | string                                                       | 是   | 指示要更新的数据的路径。                                     |
| predicates | [DataSharePredicates](js-apis-data-DataSharePredicates.md#datasharepredicates) | 是   | 指示筛选条件。<br />update接口是否支持谓词筛选条件取决于服务端所选用的数据库,如KVDB目前并不支持谓词筛选条件,仅RDB支持。 |
| value      | [ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket)    | 是   | 指示要更新的数据。                                           |
S
songruirui 已提交
498 499 500

**返回值:**

S
songruirui 已提交
501 502 503
| 类型             | 说明                                                         |
| ---------------- | ------------------------------------------------------------ |
| Promise&lt;number&gt; | Promise对象。返回更新的数据记录数。<br />因部分数据库(如KVDB)的相应接口并不提供相应支持,故若服务端使用此数据库,则此Promise也无法返回更新的数据记录数。 |
S
songruirui 已提交
504 505 506

**示例:**

S
songruirui 已提交
507
```ts
S
songruirui 已提交
508 509
import dataSharePredicates from '@ohos.data.dataSharePredicates'

S
songruirui 已提交
510
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
511 512 513 514 515 516 517 518 519 520
let da = new dataSharePredicates.DataSharePredicates();
da.equalTo("name", "ZhangSan");
const va = {
    "name": "roe1",
    "age": 21,
    "salary": 20.5,
   
}
dataShareHelper.update(uri, da, va).then((data) => {
    console.log("update succeed, data : " + data);
S
songruirui 已提交
521
}).catch((err) => {
S
songruirui 已提交
522
    console.log("update failed, error message : " + err);
S
songruirui 已提交
523 524 525
});
```

S
songruirui 已提交
526
### batchInsert
S
songruirui 已提交
527

S
songruirui 已提交
528
batchInsert(uri: string, values: Array&lt;ValuesBucket&gt;, callback: AsyncCallback&lt;number&gt;): void
S
songruirui 已提交
529

S
songruirui 已提交
530
将批量数据插入数据库。使用callback异步回调。
S
songruirui 已提交
531

S
songruirui 已提交
532 533
此接口仅可在Stage模型下使用。

S
songruirui 已提交
534
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
535 536 537

**参数:**

S
songruirui 已提交
538 539 540 541 542
| 名称     | 类型                                                         | 必填 | 描述                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| uri      | string                                                       | 是   | 指示要插入的数据的路径。                                     |
| values   | Array&lt;[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket)&gt; | 是   | 指示要插入的数据。                                           |
| callback | AsyncCallback&lt;number&gt;                                  | 是   | 回调函数。当将批量数据插入数据库成功,err为undefined,data为获取到的插入的数据记录数;否则为错误对象。<br />因部分数据库(如KVDB)的相应接口并不提供相应支持,故若服务端使用此数据库,则此Promise也无法返回插入的数据记录数。 |
S
songruirui 已提交
543 544 545

**示例:**

S
songruirui 已提交
546
```ts
S
songruirui 已提交
547
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
548 549 550 551
let vbs = new Array({"name": "roe11", "age": 21, "salary": 20.5,},
                     {"name": "roe12", "age": 21, "salary": 20.5,},
                     {"name": "roe13", "age": 21, "salary": 20.5,})
dataShareHelper.batchInsert(uri, vbs, (err, data) => {
S
songruirui 已提交
552
    if (err != undefined) {
S
songruirui 已提交
553
        console.log("batchInsert failed, error message : " + err);
S
songruirui 已提交
554
    }else{
S
songruirui 已提交
555
        console.log("batchInsert succeed, data : " + data);
S
songruirui 已提交
556
    }
S
songruirui 已提交
557 558 559
});
```

S
songruirui 已提交
560
### batchInsert
S
songruirui 已提交
561

S
songruirui 已提交
562
batchInsert(uri: string, values: Array&lt;ValuesBucket&gt;): Promise&lt;number&gt;
S
songruirui 已提交
563

S
songruirui 已提交
564
将批量数据插入数据库。使用Promise异步回调。
S
songruirui 已提交
565

S
songruirui 已提交
566 567
此接口仅可在Stage模型下使用。

S
songruirui 已提交
568
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
569 570 571

**参数:**

S
songruirui 已提交
572 573 574 575
| 名称   | 类型                                                         | 必填 | 描述                     |
| ------ | ------------------------------------------------------------ | ---- | ------------------------ |
| uri    | string                                                       | 是   | 指示要插入的数据的路径。 |
| values | Array&lt;[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket)&gt; | 是   | 指示要插入的数据。       |
S
songruirui 已提交
576 577 578

**返回值:**

S
songruirui 已提交
579 580 581
| 类型             | 说明                                                         |
| ---------------- | ------------------------------------------------------------ |
| Promise&lt;number&gt; | Promise对象。返回插入的数据记录数。<br />因部分数据库(如KVDB)的相应接口并不提供相应支持,故若服务端使用此数据库,则此Promise也无法返回插入的数据记录数。 |
S
songruirui 已提交
582 583 584

**示例:**

S
songruirui 已提交
585
```ts
S
songruirui 已提交
586
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
587 588 589 590 591
let vbs = new Array({"name": "roe11", "age": 21, "salary": 20.5,},
                     {"name": "roe12", "age": 21, "salary": 20.5,},
                     {"name": "roe13", "age": 21, "salary": 20.5,})
dataShareHelper.batchInsert(uri, vbs).then((data) => {
    console.log("batchInsert succeed, data : " + data);
S
songruirui 已提交
592
}).catch((err) => {
S
songruirui 已提交
593
    console.log("batchInsert failed, error message : " + err);
S
songruirui 已提交
594 595 596
});
```

S
songruirui 已提交
597
### getType
S
songruirui 已提交
598

S
songruirui 已提交
599
getType(uri: string, callback: AsyncCallback&lt;string&gt;): void
S
songruirui 已提交
600

S
songruirui 已提交
601
获取URI所指定的数据的MIME类型。使用callback异步回调。
S
songruirui 已提交
602

S
songruirui 已提交
603 604
此接口仅可在Stage模型下使用。

S
songruirui 已提交
605
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
606 607 608

**参数:**

S
songruirui 已提交
609 610 611 612
| 名称     | 类型                   | 必填 | 描述                                          |
| -------- | ---------------------- | ---- | --------------------------------------------- |
| uri      | string                 | 是   | 表示指定的数据路径。                      |
| callback | AsyncCallback&lt;string&gt; | 是   | 回调函数。当获取URI所指定的数据的MIME类型成功,err为undefined,data为获取到的与URI指定的数据匹配的MIME类型;否则为错误对象。 |
S
songruirui 已提交
613 614 615

**示例:**

S
songruirui 已提交
616
```ts
S
songruirui 已提交
617
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
618
dataShareHelper.getType(uri, (err, data)=>{
S
songruirui 已提交
619
    if (err != undefined) {
S
songruirui 已提交
620
        console.log("getType failed, error message : " + err);
S
songruirui 已提交
621
    }else{
S
songruirui 已提交
622 623
        console.log("getType succeed, data : " + data);
        let result = data;
S
songruirui 已提交
624
    }
S
songruirui 已提交
625 626 627
});
```

S
songruirui 已提交
628
### getType
S
songruirui 已提交
629

S
songruirui 已提交
630
getType(uri: string): Promise&lt;string&gt;
S
songruirui 已提交
631

S
songruirui 已提交
632
获取URI所指定数据的MIME类型。使用Promise异步回调。
S
songruirui 已提交
633

S
songruirui 已提交
634 635
此接口仅可在Stage模型下使用。

S
songruirui 已提交
636
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
637 638 639

**参数:**

S
songruirui 已提交
640 641 642
| 名称 | 类型   | 必填 | 描述                 |
| ---- | ------ | ---- | -------------------- |
| uri  | string | 是   | 表示指定的数据路径。 |
S
songruirui 已提交
643 644 645

**返回值:**

S
songruirui 已提交
646 647 648
| 类型             | 说明                                |
| ---------------- | ----------------------------------- |
| Promise&lt;string&gt; | Promise对象。返回与URI指定的数据匹配的MIME类型。 |
S
songruirui 已提交
649 650 651

**示例:**

S
songruirui 已提交
652
```ts
S
songruirui 已提交
653
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
654 655
dataShareHelper.getType(uri).then((data) => {
    console.log("getType succeed, data : " + data);
S
songruirui 已提交
656
}).catch((err) => {
S
songruirui 已提交
657
    console.log("getType failed, error message : " + err);
S
songruirui 已提交
658 659 660
});
```

S
songruirui 已提交
661
### getFileTypes
S
songruirui 已提交
662

S
songruirui 已提交
663
getFileTypes(uri: string, mimeTypeFilter: string, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;): void
S
songruirui 已提交
664

S
songruirui 已提交
665
获取支持的文件的MIME类型。使用callback异步回调。
S
songruirui 已提交
666

S
songruirui 已提交
667 668
此接口仅可在Stage模型下使用。

S
songruirui 已提交
669
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
670 671 672

**参数:**

S
songruirui 已提交
673 674 675 676 677
| 名称           | 类型                                                         | 必填 | 描述                                                         |
| -------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| uri            | string                                                       | 是   | 指示要获取的文件的路径。                                     |
| mimeTypeFilter | string                                                       | 是   | 指示要筛选的MIME类型。例如:<br />\*/\*”:获取支持的所有类型。<br/>“image/\*”:获取主类型image,子类型为任何类型的MIME。<br />\*/jpg”:获取子类型为jpg,主类型为任何类型的MIME。 |
| callback       | openFile(uri: string, mode: string, callback: AsyncCallback<number>) {    let err = {"code":0};    let fd = 0;    callback(err,fd);}ts | 是   | 回调函数。当获取支持的文件的MIME类型成功,err为undefined,data为获取到的匹配的MIME类型数组;否则为错误对象。 |
S
songruirui 已提交
678 679 680

**示例:**

S
songruirui 已提交
681
```ts
S
songruirui 已提交
682
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
683 684
let mimeTypeFilter = "image/*";
dataShareHelper.getFileTypes(uri, mimeTypeFilter, (err,data) => {
S
songruirui 已提交
685
    if (err != undefined) {
S
songruirui 已提交
686
        console.log("getFileTypes failed, error message : " + err);
S
songruirui 已提交
687
    }else{
S
songruirui 已提交
688
        console.log("getFileTypes succeed, data : " + data);
S
songruirui 已提交
689
    }
S
songruirui 已提交
690 691 692
});
```

S
songruirui 已提交
693
### getFileTypes
S
songruirui 已提交
694

S
songruirui 已提交
695
getFileTypes(uri: string, mimeTypeFilter: string): Promise&lt;Array&lt;string&gt;&gt;
S
songruirui 已提交
696

S
songruirui 已提交
697
获取支持的文件的MIME类型。使用Promise异步回调。
S
songruirui 已提交
698

S
songruirui 已提交
699 700
此接口仅可在Stage模型下使用。

S
songruirui 已提交
701
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
702 703 704

**参数:**

S
songruirui 已提交
705 706 707 708
| 名称           | 类型   | 必填 | 描述                                                         |
| -------------- | ------ | ---- | ------------------------------------------------------------ |
| uri            | string | 是   | 指示要获取的文件的路径。                                     |
| mimeTypeFilter | string | 是   | 指示要筛选的MIME类型。例如:<br />\*/\*”:获取支持的所有类型。<br/>“image/\*”:获取主类型image,子类型为任何类型的MIME。<br />\*/jpg”:获取子类型为jpg,主类型为任何类型的MIME。 |
S
songruirui 已提交
709 710 711

**返回值:**

S
songruirui 已提交
712 713 714
| 类型                     | 说明                     |
| ------------------------ | ------------------------ |
| Promise&lt;Array&lt;string&gt;&gt; | Promise对象。返回匹配的MIME类型数组。 |
S
songruirui 已提交
715 716 717

**示例:**

S
songruirui 已提交
718
```ts
S
songruirui 已提交
719
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
720 721 722
let mimeTypeFilter = "image/*";
dataShareHelper.getFileTypes(uri, mimeTypeFilter).then((data) => {
	console.log("getFileTypes succeed, data : " + data);
S
songruirui 已提交
723
}).catch((err) => {
S
songruirui 已提交
724
	console.log("getFileTypes failed, error message : " + err);
S
songruirui 已提交
725 726 727
});
```

S
songruirui 已提交
728
### normalizeUri
S
songruirui 已提交
729

S
songruirui 已提交
730
normalizeUri(uri: string, callback: AsyncCallback&lt;string&gt;): void
S
songruirui 已提交
731

S
songruirui 已提交
732
将给定的DataShare URI转换为规范化URI,规范化URI可供跨设备使用,DataShare  URI仅供本地环境中使用。使用callback异步回调。
S
songruirui 已提交
733

S
songruirui 已提交
734 735
此接口仅可在Stage模型下使用。

S
songruirui 已提交
736
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
737 738 739

**参数:**

S
songruirui 已提交
740 741 742 743
| 名称     | 类型                   | 必填 | 描述                                                     |
| -------- | ---------------------- | ---- | -------------------------------------------------------- |
| uri      | string                 | 是   | 指示要规范化的[URI](js-apis-uri.md#uri)。      |
| callback | AsyncCallback&lt;string&gt; | 是   | 回调函数。当将给定的DataShare URI转换为规范化URI成功,err为undefined,data为获取到的规范化URI(如果支持URI规范化,则返回规范化URI,否则返回空);否则为错误对象。 |
S
songruirui 已提交
744 745 746

**示例:**

S
songruirui 已提交
747
```ts
S
songruirui 已提交
748
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
749
dataShareHelper.normalizeUri(uri, (err, data) => {
S
songruirui 已提交
750
    if (err != undefined) {
S
songruirui 已提交
751
        console.log("normalizeUri failed, error message : " + err);
S
songruirui 已提交
752
    }else{
S
songruirui 已提交
753
        console.log("normalizeUri = " + data);
S
songruirui 已提交
754
    }
S
songruirui 已提交
755 756 757
});
```

S
songruirui 已提交
758
### normalizeUri
S
songruirui 已提交
759

S
songruirui 已提交
760
normalizeUri(uri: string): Promise&lt;string&gt;
S
songruirui 已提交
761

S
songruirui 已提交
762
将给定的DataShare URI转换为规范化URI,规范化URI可供跨设备使用,DataShare  URI仅供本地环境中使用。使用Promise异步回调。
S
songruirui 已提交
763

S
songruirui 已提交
764 765
此接口仅可在Stage模型下使用。

S
songruirui 已提交
766
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
767 768 769

**参数:**

S
songruirui 已提交
770 771 772
| 名称 | 类型   | 必填 | 描述                                      |
| ---- | ------ | ---- | ----------------------------------------- |
| uri  | string | 是   | 指示要规范化的[URI](js-apis-uri.md#uri)。 |
S
songruirui 已提交
773 774 775

**返回值:**

S
songruirui 已提交
776 777 778
| 类型             | 说明                                           |
| ---------------- | ---------------------------------------------- |
| Promise&lt;string&gt; | Promise对象。如果支持URI规范化,则返回规范化URI,否则返回空。 |
S
songruirui 已提交
779 780 781

**示例:**

S
songruirui 已提交
782
```ts
S
songruirui 已提交
783
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
784 785
dataShareHelper.normalizeUri(uri).then((data) => {
    console.log("normalizeUri = " + data);
S
songruirui 已提交
786
}).catch((err) => {
S
songruirui 已提交
787
    console.log("normalizeUri failed, error message : " + err);
S
songruirui 已提交
788 789 790
});
```

S
songruirui 已提交
791
### denormalizeUri
S
songruirui 已提交
792

S
songruirui 已提交
793
denormalizeUri(uri: string, callback: AsyncCallback&lt;string&gt;): void
S
songruirui 已提交
794

S
songruirui 已提交
795
将指定的URI转换为非规范化URI。使用callback异步回调。
S
songruirui 已提交
796

S
songruirui 已提交
797 798
此接口仅可在Stage模型下使用。

S
songruirui 已提交
799
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
800

S
songruirui 已提交
801 802
**参数:**

S
songruirui 已提交
803 804 805 806
| 名称     | 类型                   | 必填 | 描述                                                |
| -------- | ---------------------- | ---- | --------------------------------------------------- |
| uri      | string                 | 是   | 指示要反规范化的[URI](js-apis-uri.md#uri)。 |
| callback | AsyncCallback&lt;string&gt; | 是   | 回调函数。当将指定的URI转换为非规范化URI,err为undefined,data为获取到的反规范化URI(如果反规范化成功,则返回反规范化的URI;如果无需进行反规范化,则返回原始URI;若不支持则返回空);否则为错误对象。 |
S
songruirui 已提交
807 808 809

**示例:**

S
songruirui 已提交
810
```ts
S
songruirui 已提交
811
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
812
dataShareHelper.denormalizeUri(uri, (err, data) => {
S
songruirui 已提交
813
    if (err != undefined) {
S
songruirui 已提交
814
        console.log("denormalizeUri failed, error message : " + err);
S
songruirui 已提交
815
    }else{
S
songruirui 已提交
816
        console.log("denormalizeUri = " + data);
S
songruirui 已提交
817
    }
S
songruirui 已提交
818 819 820
});
```

S
songruirui 已提交
821
### denormalizeUri
S
songruirui 已提交
822

S
songruirui 已提交
823
denormalizeUri(uri: string): Promise&lt;string&gt;
S
songruirui 已提交
824

S
songruirui 已提交
825
将指定的URI转换为非规范化URI。使用Promise异步回调。
S
songruirui 已提交
826

S
songruirui 已提交
827 828
此接口仅可在Stage模型下使用。

S
songruirui 已提交
829
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
830

S
songruirui 已提交
831 832
**参数:**

S
songruirui 已提交
833 834 835
| 名称 | 类型   | 必填 | 描述                                        |
| ---- | ------ | ---- | ------------------------------------------- |
| uri  | string | 是   | 指示要反规范化的[URI](js-apis-uri.md#uri)。 |
S
songruirui 已提交
836 837 838

**返回值:**

S
songruirui 已提交
839 840 841
| 类型             | 说明                                      |
| ---------------- | ----------------------------------------- |
| Promise&lt;string&gt; | Promise对象。如果反规范化成功,则返回反规范化的URI;如果无需执行任何操作,则返回原始URI;若不支持则返回空。 |
S
songruirui 已提交
842 843 844

**示例:**

S
songruirui 已提交
845
```ts
S
songruirui 已提交
846
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
847 848
dataShareHelper.denormalizeUri(uri).then((data) => {
    console.log("denormalizeUri = " + data);
S
songruirui 已提交
849
}).catch((err) => {
S
songruirui 已提交
850
    console.log("denormalizeUri failed, error message : " + err);
S
songruirui 已提交
851 852 853
});
```

S
songruirui 已提交
854
### notifyChange
S
songruirui 已提交
855

S
songruirui 已提交
856
notifyChange(uri: string, callback: AsyncCallback&lt;void&gt;): void
S
songruirui 已提交
857

S
songruirui 已提交
858
通知已注册的观察者指定URI对应的数据资源已发生变更。使用callback异步回调。
S
songruirui 已提交
859

S
songruirui 已提交
860 861
此接口仅可在Stage模型下使用。

S
songruirui 已提交
862
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
863

S
songruirui 已提交
864 865
**参数:**

S
songruirui 已提交
866 867 868 869
| 名称     | 类型                 | 必填 | 描述                     |
| -------- | -------------------- | ---- | ------------------------ |
| uri      | string               | 是   | 表示指定的数据路径。 |
| callback | AsyncCallback&lt;void&gt; | 是   | 回调函数。当通知已注册的观察者指定URI对应的数据资源已发生变更成功,err为undefined;否则为错误对象。 |
S
songruirui 已提交
870 871 872

**示例:**

S
songruirui 已提交
873
```ts
S
songruirui 已提交
874
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
875 876
dataShareHelper.notifyChange(uri, () => {
    console.log("***** notifyChange *****");
S
songruirui 已提交
877 878 879
});
```

S
songruirui 已提交
880
### notifyChange
S
songruirui 已提交
881

S
songruirui 已提交
882
notifyChange(uri: string): Promise&lt;void&gt;
S
songruirui 已提交
883

S
songruirui 已提交
884
通知已注册的观察者指定URI对应的数据资源已发生变更。使用Promise异步回调。
S
songruirui 已提交
885

S
songruirui 已提交
886 887
此接口仅可在Stage模型下使用。

S
songruirui 已提交
888
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
889

S
songruirui 已提交
890 891
**参数:**

S
songruirui 已提交
892 893 894
| 名称 | 类型   | 必填 | 描述                 |
| ---- | ------ | ---- | -------------------- |
| uri  | string | 是   | 表示指定的数据路径。 |
S
songruirui 已提交
895 896 897

**返回值:**

S
songruirui 已提交
898 899 900
| 类型           | 说明                  |
| -------------- | --------------------- |
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |
S
songruirui 已提交
901 902 903

**示例:**

S
songruirui 已提交
904
```ts
S
songruirui 已提交
905
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
906
dataShareHelper.notifyChange(uri);
S
songruirui 已提交
907
```