js-apis-userFileManager.md 140.0 KB
Newer Older
Z
zengyawen 已提交
1
# @ohos.filemanagement.userFileManager (用户数据管理)
Y
yangbo 已提交
2

Z
zhang-daiyue 已提交
3 4
该模块提供用户数据管理能力,包括访问、修改用户等用户公共媒体数据信息等常用功能。

zyjhandsome's avatar
zyjhandsome 已提交
5
> **说明:**
Z
zengyawen 已提交
6 7 8
>
> - 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> - 本模块接口为系统接口。
Y
yangbo 已提交
9 10

## 导入模块
W
wangqinxiao 已提交
11

Z
zhang-daiyue 已提交
12 13
```ts
import userFileManager from '@ohos.filemanagement.userFileManager';
Y
yangbo 已提交
14 15 16 17 18 19 20 21
```

## userFileManager.getUserFileMgr

getUserFileMgr(context: Context): UserFileManager

获取用户数据管理模块的实例,用于访问和修改用户等用户公共媒体数据信息(如音频、视频、图片、文档等)。

H
huweiqi 已提交
22
**模型约束**: 此接口仅可在Stage模型下使用。
zyjhandsome's avatar
zyjhandsome 已提交
23

Y
yangbo 已提交
24 25
**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

Z
zengyawen 已提交
26
**参数:**
Y
yangbo 已提交
27 28 29

| 参数名  | 类型    | 必填 | 说明                       |
| ------- | ------- | ---- | -------------------------- |
H
huweiqi 已提交
30
| context | [Context](js-apis-inner-app-context.md) | 是   | 传入Ability实例的Context。 |
Y
yangbo 已提交
31 32 33 34 35

**返回值:**

| 类型                            | 说明    |
| ----------------------------- | :---- |
H
huweiqi 已提交
36
| [UserFileManager](#userfilemanager) | 媒体库实例。 |
Y
yangbo 已提交
37 38 39 40

**示例:**

```ts
41
//此处获取的userFileManager实例mgr为全局对象,后续使用到mgr的地方默认为使用此处获取的对象,如未添加此段代码报mgr未定义的错误请自行添加
Y
yangbo 已提交
42
const context = getContext(this);
H
huweiqi 已提交
43
let mgr = userFileManager.getUserFileMgr(context);
Y
yangbo 已提交
44
```
W
wangqinxiao 已提交
45

Y
yangbo 已提交
46 47
## UserFileManager

Z
zhang-daiyue 已提交
48 49 50 51 52
### getPhotoAssets

getPhotoAssets(options: FetchOptions, callback: AsyncCallback<FetchResult<FileAsset>>): void;

获取图片和视频资源,使用callback方式返回结果。
Y
yangbo 已提交
53 54 55

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

Z
zhang-daiyue 已提交
56 57
**需要权限**:ohos.permission.READ_IMAGEVIDEO

Y
yangbo 已提交
58 59 60 61
**参数:**

| 参数名   | 类型                     | 必填 | 说明                      |
| -------- | ------------------------ | ---- | ------------------------- |
H
huweiqi 已提交
62 63
| options  | [FetchOptions](#fetchoptions)        | 是   | 图片和视频检索选项。              |
| callback |  AsyncCallback<[FetchResult](#fetchresult)<[FileAsset](#fileasset)>> | 是   | callback返回图片和视频检索结果集。 |
Y
yangbo 已提交
64

H
huweiqi 已提交
65 66 67 68 69 70 71 72
**错误码:**

接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 13900020   | if type options is not FetchOptions.         |

Y
yangbo 已提交
73 74 75
**示例:**

```ts
H
huweiqi 已提交
76 77
import dataSharePredicates from '@ohos.data.dataSharePredicates';

Z
zhang-daiyue 已提交
78 79 80 81 82 83 84 85 86 87 88 89 90
async function example() {
  console.info('getPhotoAssets');
  let predicates = new dataSharePredicates.DataSharePredicates();
  let fetchOptions = {
    fetchColumns: [],
    predicates: predicates
  };

  mgr.getPhotoAssets(fetchOptions, async (err, fetchResult) => {
    if (fetchResult != undefined) {
      console.info('fetchResult success');
      let fileAsset = await fetchResult.getFirstObject();
      if (fileAsset != undefined) {
H
huweiqi 已提交
91
        console.info('fileAsset.displayName : ' + fileAsset.displayName);
Z
zhang-daiyue 已提交
92 93
      }
    } else {
H
huweiqi 已提交
94
      console.error('fetchResult fail' + err);
Z
zhang-daiyue 已提交
95
    }
H
huweiqi 已提交
96
  });
Y
yangbo 已提交
97 98 99
}
```

Z
zhang-daiyue 已提交
100 101 102
### getPhotoAssets

getPhotoAssets(options: FetchOptions): Promise<FetchResult<FileAsset>>;
Y
yangbo 已提交
103

Z
zhang-daiyue 已提交
104
获取图片和视频资源,使用Promise方式返回结果。
Y
yangbo 已提交
105 106 107

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

Z
zhang-daiyue 已提交
108 109
**需要权限**:ohos.permission.READ_IMAGEVIDEO

Y
yangbo 已提交
110 111
**参数:**

Z
zhang-daiyue 已提交
112 113
| 参数名  | 类型                | 必填 | 说明             |
| ------- | ------------------- | ---- | ---------------- |
H
huweiqi 已提交
114
| options | [FetchOptions](#fetchoptions)   | 是   | 图片和视频检索选项。     |
Y
yangbo 已提交
115

Z
zengyawen 已提交
116
**返回值:**
Y
yangbo 已提交
117

Z
zhang-daiyue 已提交
118 119
| 类型                        | 说明           |
| --------------------------- | -------------- |
H
huweiqi 已提交
120
| Promise<[FetchResult](#fetchresult)<[FileAsset](#fileasset)>> | Promise对象,返回图片和视频数据结果集。 |
Y
yangbo 已提交
121

H
huweiqi 已提交
122 123 124 125 126 127 128 129
**错误码:**

接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 13900020   | if type options is not FetchOptions.         |

Y
yangbo 已提交
130 131 132
**示例:**

```ts
H
huweiqi 已提交
133 134
import dataSharePredicates from '@ohos.data.dataSharePredicates';

Z
zhang-daiyue 已提交
135 136 137 138 139 140 141 142
async function example() {
  console.info('getPhotoAssets');
  let predicates = new dataSharePredicates.DataSharePredicates();
  let fetchOptions = {
    fetchColumns: [],
    predicates: predicates
  };
  try {
143
    let fetchResult = await mgr.getPhotoAssets(fetchOptions);
Z
zhang-daiyue 已提交
144 145 146 147
    if (fetchResult != undefined) {
      console.info('fetchResult success');
      let fileAsset = await fetchResult.getFirstObject();
      if (fileAsset != undefined) {
H
huweiqi 已提交
148
        console.info('fileAsset.displayName :' + fileAsset.displayName);
Z
zhang-daiyue 已提交
149
      }
Y
yangbo 已提交
150
    }
Z
zhang-daiyue 已提交
151
  } catch (err) {
H
huweiqi 已提交
152
    console.error('getPhotoAssets failed, message = ', err);
Z
zhang-daiyue 已提交
153
  }
Y
yangbo 已提交
154 155
}
```
Z
zhang-daiyue 已提交
156
### createPhotoAsset
Y
yangbo 已提交
157

Z
zhang-daiyue 已提交
158
createPhotoAsset(displayName: string, albumUri: string, callback: AsyncCallback<FileAsset>): void;
Y
yangbo 已提交
159

H
huweiqi 已提交
160
指定待创建的图片或者视频的文件名和所在相册的uri,创建图片或视频资源,使用callback方式返回结果。
Y
yangbo 已提交
161 162 163

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

Z
zhang-daiyue 已提交
164
**需要权限**:ohos.permission.WRITE_IMAGEVIDEO
Y
yangbo 已提交
165 166 167 168 169

**参数:**

| 参数名   | 类型                     | 必填 | 说明                      |
| -------- | ------------------------ | ---- | ------------------------- |
H
huweiqi 已提交
170 171 172
| displayName  | string        | 是   | 创建的图片或者视频文件名。              |
| albumUri  | string        | 是   | 创建的图片或者视频所在相册的uri。              |
| callback |  AsyncCallback<[FileAsset](#fileasset)> | 是   | callback返回创建的图片和视频结果。 |
Y
yangbo 已提交
173

H
huweiqi 已提交
174 175 176 177 178 179 180 181 182
**错误码:**

接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 13900020   | if type displayName or albumUri is not string.         |
| 14000001   | if type displayName invalid.         |

Y
yangbo 已提交
183 184 185
**示例:**

```ts
H
huweiqi 已提交
186 187
import dataSharePredicates from '@ohos.data.dataSharePredicates';

Z
zhang-daiyue 已提交
188
async function example() {
H
huweiqi 已提交
189
  console.info('createPhotoAssetDemo');
Z
zhang-daiyue 已提交
190 191 192 193
  let predicates = new dataSharePredicates.DataSharePredicates();
  let fetchOptions = {
    predicates: predicates
  };
H
huweiqi 已提交
194 195
  let albums = await mgr.getPhotoAlbums(fetchOptions);
  let album = await albums.getFirstObject();
H
huweiqi 已提交
196
  let testFileName = 'testFile' + Date.now() + '.jpg';
H
huweiqi 已提交
197
  mgr.createPhotoAsset(testFileName, album.albumUri, (err, fileAsset) => {
Z
zhang-daiyue 已提交
198 199 200 201
    if (fileAsset != undefined) {
      console.info('createPhotoAsset file displayName' + fileAsset.displayName);
      console.info('createPhotoAsset successfully');
    } else {
H
huweiqi 已提交
202
      console.error('createPhotoAsset failed, message = ', err);
Z
zhang-daiyue 已提交
203
    }
H
huweiqi 已提交
204
  });
Z
zhang-daiyue 已提交
205 206
}
```
Y
yangbo 已提交
207

Z
zhang-daiyue 已提交
208 209 210 211
### createPhotoAsset

createPhotoAsset(displayName: string, callback: AsyncCallback<FileAsset>): void;

H
huweiqi 已提交
212
指定待创建的图片或者视频的文件名,创建图片或视频资源,使用callback方式返回结果。
Z
zhang-daiyue 已提交
213 214 215 216 217 218 219 220 221

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

**需要权限**:ohos.permission.WRITE_IMAGEVIDEO

**参数:**

| 参数名   | 类型                     | 必填 | 说明                      |
| -------- | ------------------------ | ---- | ------------------------- |
H
huweiqi 已提交
222 223
| displayName  | string        | 是   | 创建的图片或者视频文件名。              |
| callback |  AsyncCallback<[FileAsset](#fileasset)> | 是   | callback返回创建的图片和视频结果。 |
Z
zhang-daiyue 已提交
224

H
huweiqi 已提交
225 226 227 228 229 230 231 232 233
**错误码:**

接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 13900020   | if type displayName is not string.         |
| 14000001   | if type displayName invalid.         |

Z
zhang-daiyue 已提交
234 235 236 237
**示例:**

```ts
async function example() {
H
huweiqi 已提交
238
  console.info('createPhotoAssetDemo');
H
huweiqi 已提交
239
  let testFileName = 'testFile' + Date.now() + '.jpg';
H
huweiqi 已提交
240
  mgr.createPhotoAsset(testFileName, (err, fileAsset) => {
Z
zhang-daiyue 已提交
241 242 243 244
    if (fileAsset != undefined) {
      console.info('createPhotoAsset file displayName' + fileAsset.displayName);
      console.info('createPhotoAsset successfully');
    } else {
H
huweiqi 已提交
245
      console.error('createPhotoAsset failed, message = ', err);
Z
zhang-daiyue 已提交
246
    }
H
huweiqi 已提交
247
  });
Y
yangbo 已提交
248 249 250
}
```

Z
zhang-daiyue 已提交
251
### createPhotoAsset
Y
yangbo 已提交
252

H
huweiqi 已提交
253
createPhotoAsset(displayName: string, albumUri?: string): Promise<FileAsset>;
Y
yangbo 已提交
254

H
huweiqi 已提交
255
指定待创建的图片或者视频的文件名和所在相册的uri,创建图片或视频资源,使用Promise方式返回结果。
Y
yangbo 已提交
256 257 258

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

Z
zhang-daiyue 已提交
259
**需要权限**:ohos.permission.WRITE_IMAGEVIDEO
Y
yangbo 已提交
260 261 262

**参数:**

Z
zhang-daiyue 已提交
263 264
| 参数名   | 类型                     | 必填 | 说明                      |
| -------- | ------------------------ | ---- | ------------------------- |
H
huweiqi 已提交
265 266
| displayName  | string        | 是   | 创建的图片或者视频文件名。              |
| albumUri  | string        | 否   | 创建的图片或者视频所在相册的uri。              |
Y
yangbo 已提交
267

Z
zengyawen 已提交
268
**返回值:**
Y
yangbo 已提交
269 270 271

| 类型                        | 说明           |
| --------------------------- | -------------- |
H
huweiqi 已提交
272
| Promise<[FileAsset](#fileasset)> | Promise对象,返回创建的图片和视频结果。 |
Y
yangbo 已提交
273

H
huweiqi 已提交
274 275 276 277 278 279 280 281
**错误码:**

接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 13900020   | if type displayName or albumUri is not string.         |

Y
yangbo 已提交
282 283 284
**示例:**

```ts
Z
zhang-daiyue 已提交
285
async function example() {
H
huweiqi 已提交
286
  console.info('createPhotoAssetDemo');
Z
zhang-daiyue 已提交
287
  try {
H
huweiqi 已提交
288
    let testFileName = 'testFile' + Date.now() + '.jpg';
H
huweiqi 已提交
289
    let fileAsset = await mgr.createPhotoAsset(testFileName);
Z
zhang-daiyue 已提交
290 291 292
    console.info('createPhotoAsset file displayName' + fileAsset.displayName);
    console.info('createPhotoAsset successfully');
  } catch (err) {
H
huweiqi 已提交
293
    console.error('createPhotoAsset failed, message = ', err);
Z
zhang-daiyue 已提交
294
  }
Y
yangbo 已提交
295 296 297
}
```

H
huweiqi 已提交
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
### createPhotoAsset

createPhotoAsset(displayName: string, createOption: PhotoCreateOptions, callback: AsyncCallback<FileAsset>): void;

指定待创建的图片或者视频的文件名和创建选项,创建图片或视频资源,使用callback方式返回结果。

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

**需要权限**:ohos.permission.WRITE_IMAGEVIDEO

**参数:**

| 参数名   | 类型                     | 必填 | 说明                      |
| -------- | ------------------------ | ---- | ------------------------- |
| displayName  | string        | 是   | 创建的图片或者视频文件名。              |
| createOption  | [PhotoCreateOptions](#photocreateoptions10)        | 是   | 图片或视频的创建选项。              |
| callback |  AsyncCallback<[FileAsset](#fileasset)> | 是   | callback返回创建的图片和视频结果。 |

H
huweiqi 已提交
316 317 318 319 320 321 322 323 324
**错误码:**

接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 13900020   | if type displayName is not string.         |
| 14000001   | if type displayName invalid.         |

H
huweiqi 已提交
325 326 327 328 329 330 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 356 357 358 359 360 361 362 363 364 365 366 367
**示例:**

```ts
async function example() {
  console.info('createPhotoAssetDemo');
  let testFileName = 'testFile' + Date.now() + '.jpg';
  let createOption = {
    subType: userFileManager.PhotoSubType.DEFAULT
  }
  mgr.createPhotoAsset(testFileName, createOption, (err, fileAsset) => {
    if (fileAsset != undefined) {
      console.info('createPhotoAsset file displayName' + fileAsset.displayName);
      console.info('createPhotoAsset successfully');
    } else {
      console.error('createPhotoAsset failed, message = ', err);
    }
  });
}
```

### createPhotoAsset

createPhotoAsset(displayName: string, createOption: PhotoCreateOptions): Promise<FileAsset>;

指定待创建的图片或者视频的文件名和创建选项,创建图片或视频资源,使用Promise方式返回结果。

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

**需要权限**:ohos.permission.WRITE_IMAGEVIDEO

**参数:**

| 参数名   | 类型                     | 必填 | 说明                      |
| -------- | ------------------------ | ---- | ------------------------- |
| displayName  | string        | 是   | 创建的图片或者视频文件名。              |
| createOption  |  [PhotoCreateOptions](#photocreateoptions10)       | 是   | 图片或视频的创建选项。              |

**返回值:**

| 类型                        | 说明           |
| --------------------------- | -------------- |
| Promise<[FileAsset](#fileasset)> | Promise对象,返回创建的图片和视频结果。 |

H
huweiqi 已提交
368 369 370 371 372 373 374 375
**错误码:**

接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 13900020   | if type displayName is not string.         |

H
huweiqi 已提交
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
**示例:**

```ts
async function example() {
  console.info('createPhotoAssetDemo');
  try {
    let testFileName = 'testFile' + Date.now() + '.jpg';
    let createOption = {
      subType: userFileManager.PhotoSubType.DEFAULT
    }
    let fileAsset = await mgr.createPhotoAsset(testFileName, createOption);
    console.info('createPhotoAsset file displayName' + fileAsset.displayName);
    console.info('createPhotoAsset successfully');
  } catch (err) {
    console.error('createPhotoAsset failed, message = ', err);
  }
}
```

### createAudioAsset<sup>10+</sup>

createAudioAsset(displayName: string, callback: AsyncCallback&lt;FileAsset&gt;): void;

创建音频文件资源,使用callback方式返回结果。

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

H
huweiqi 已提交
403
**需要权限**:ohos.permission.WRITE_AUDIO
H
huweiqi 已提交
404 405 406 407 408 409 410 411

**参数:**

| 参数名   | 类型                     | 必填 | 说明                      |
| -------- | ------------------------ | ---- | ------------------------- |
| displayName  | string        | 是   | 创建的音频文件名。              |
| callback |  AsyncCallback&lt;[FileAsset](#fileasset)&gt; | 是   | callback返回创建的音频资源结果。 |

H
huweiqi 已提交
412 413 414 415 416 417 418 419 420
**错误码:**

接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 13900020   | if type displayName is not string.         |
| 14000001   | if type displayName invalid.         |

H
huweiqi 已提交
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
**示例:**

```ts
async function example() {
  console.info('createAudioAssetDemo');
  let testFileName = 'testFile' + Date.now() + '.mp3';
  mgr.createAudioAsset(testFileName, (err, fileAsset) => {
    if (fileAsset != undefined) {
      console.info('createAudioAsset file displayName' + fileAsset.displayName);
      console.info('createAudioAsset successfully');
    } else {
      console.error('createAudioAsset failed, message = ', err);
    }
  });
}
```

### createAudioAsset<sup>10+</sup>

createAudioAsset(displayName: string): Promise&lt;FileAsset&gt;;

创建音频文件资源,使用Promise方式返回结果。

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

H
huweiqi 已提交
446
**需要权限**:ohos.permission.WRITE_AUDIO
H
huweiqi 已提交
447 448 449 450 451 452 453 454 455 456 457 458 459

**参数:**

| 参数名   | 类型                     | 必填 | 说明                      |
| -------- | ------------------------ | ---- | ------------------------- |
| displayName  | string        | 是   | 创建的音频文件名。              |

**返回值:**

| 类型                        | 说明           |
| --------------------------- | -------------- |
| Promise&lt;[FileAsset](#fileasset)&gt; | Promise对象,返回创建的音频资源结果。 |

H
huweiqi 已提交
460 461 462 463 464 465 466 467
**错误码:**

接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 13900020   | if type displayName is not string.         |

H
huweiqi 已提交
468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484
**示例:**

```ts
async function example() {
  console.info('createAudioAssetDemo');
  try {
    let testFileName = 'testFile' + Date.now() + '.mp3';
    let fileAsset = await mgr.createAudioAsset(testFileName);
    console.info('createAudioAsset file displayName' + fileAsset.displayName);
    console.info('createAudioAsset successfully');
  } catch (err) {
    console.error('createAudioAsset failed, message = ', err);
  }
}
```

### createAlbum<sup>10+</sup>
Y
yangbo 已提交
485

H
huweiqi 已提交
486
createAlbum(name: string, callback: AsyncCallback&lt;Album&gt;): void;
Y
yangbo 已提交
487

H
huweiqi 已提交
488 489 490 491 492 493 494
创建相册,使用callback方式返回结果。

待创建的相册名参数规格为:
- 相册名字符串长度为1~255。
- 不允许出现的非法英文字符,包括:<br> . .. \ / : * ? " ' ` < > | { } [ ]
- 英文字符大小写不敏感。
- 相册名不允许重名。
李云帆 已提交
495

Y
yangbo 已提交
496 497
**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

H
huweiqi 已提交
498
**需要权限**:ohos.permission.WRITE_IMAGEVIDEO
Y
yangbo 已提交
499 500 501

**参数:**

Z
zhang-daiyue 已提交
502 503
| 参数名   | 类型                     | 必填 | 说明                      |
| -------- | ------------------------ | ---- | ------------------------- |
H
huweiqi 已提交
504 505
| name  | string         | 是   | 待创建相册的相册名。              |
| callback |  AsyncCallback&lt;[Album](#album)&gt; | 是   | callback返回创建的相册实例。 |
Y
yangbo 已提交
506 507 508 509

**示例:**

```ts
Z
zhang-daiyue 已提交
510
async function example() {
H
huweiqi 已提交
511 512 513 514 515 516
  console.info('createAlbumDemo');
  let albumName = 'newAlbumName' + new Date().getTime();
  mgr.createAlbum(albumName, (err, album) => {
    if (err) {
      console.error('createAlbumCallback failed with err: ' + err);
      return;
Z
zhang-daiyue 已提交
517
    }
H
huweiqi 已提交
518
    console.info('createAlbumCallback successfully, album: ' + album.albumName + ' album uri: ' + album.albumUri);
Z
zhang-daiyue 已提交
519
  });
Y
yangbo 已提交
520 521 522
}
```

H
huweiqi 已提交
523
### createAlbum<sup>10+</sup>
Y
yangbo 已提交
524

H
huweiqi 已提交
525
createAlbum(name: string): Promise&lt;Album&gt;;
Y
yangbo 已提交
526

H
huweiqi 已提交
527
创建相册,使用Promise方式返回结果。
Y
yangbo 已提交
528

H
huweiqi 已提交
529 530 531 532 533
待创建的相册名参数规格为:
- 相册名字符串长度为1~255。
- 不允许出现的非法英文字符,包括:<br> . .. \ / : * ? " ' ` < > | { } [ ]
- 英文字符大小写不敏感。
- 相册名不允许重名。
李云帆 已提交
534

Y
yangbo 已提交
535 536
**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

H
huweiqi 已提交
537
**需要权限**:ohos.permission.WRITE_IMAGEVIDEO
Y
yangbo 已提交
538 539 540

**参数:**

Z
zhang-daiyue 已提交
541 542
| 参数名   | 类型                     | 必填 | 说明                      |
| -------- | ------------------------ | ---- | ------------------------- |
H
huweiqi 已提交
543
| name  | string         | 是   | 待创建相册的相册名。              |
Y
yangbo 已提交
544

Z
zengyawen 已提交
545
**返回值:**
Y
yangbo 已提交
546

Z
zhang-daiyue 已提交
547 548
| 类型                        | 说明           |
| --------------------------- | -------------- |
H
huweiqi 已提交
549
| Promise&lt;[Album](#album)&gt; | Promise对象,返回创建的相册实例。 |
Y
yangbo 已提交
550 551 552 553

**示例:**

```ts
Z
zhang-daiyue 已提交
554
async function example() {
H
huweiqi 已提交
555 556 557 558 559 560 561
  console.info('createAlbumDemo');
  let albumName = 'newAlbumName' + new Date().getTime();
  mgr.createAlbum(albumName).then((album) => {
    console.info('createAlbumPromise successfully, album: ' + album.albumName + ' album uri: ' + album.albumUri);
  }).catch((err) => {
    console.error('createAlbumPromise failed with err: ' + err);
  });
Y
yangbo 已提交
562 563 564
}
```

H
huweiqi 已提交
565
### deleteAlbums<sup>10+</sup>
Y
yangbo 已提交
566

H
huweiqi 已提交
567
deleteAlbums(albums: Array&lt;Album&gt;, callback: AsyncCallback&lt;void&gt;): void;
Y
yangbo 已提交
568

H
huweiqi 已提交
569 570 571
删除相册,使用callback方式返回结果。

删除相册前需先确保相册存在,只能删除用户相册。
李云帆 已提交
572

Y
yangbo 已提交
573 574
**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

H
huweiqi 已提交
575
**需要权限**:ohos.permission.WRITE_IMAGEVIDEO
Y
yangbo 已提交
576 577 578

**参数:**

Z
zhang-daiyue 已提交
579 580
| 参数名   | 类型                     | 必填 | 说明                      |
| -------- | ------------------------ | ---- | ------------------------- |
H
huweiqi 已提交
581 582
| albums  | Array&lt;[Album](#album)&gt;         | 是   | 待删除相册的数组。              |
| callback |  AsyncCallback&lt;void&gt; | 是   | callback返回void。 |
Y
yangbo 已提交
583 584 585 586

**示例:**

```ts
H
huweiqi 已提交
587 588
import dataSharePredicates from '@ohos.data.dataSharePredicates';

Z
zhang-daiyue 已提交
589
async function example() {
H
huweiqi 已提交
590
  // 示例代码为删除相册名为newAlbumName的相册。
H
huweiqi 已提交
591
  console.info('deleteAlbumsDemo');
Z
zhang-daiyue 已提交
592
  let predicates = new dataSharePredicates.DataSharePredicates();
H
huweiqi 已提交
593
  predicates.equalTo('album_name', 'newAlbumName');
Z
zhang-daiyue 已提交
594 595 596 597
  let fetchOptions = {
    fetchColumns: [],
    predicates: predicates
  };
H
huweiqi 已提交
598 599 600 601 602 603
  let fetchResult = await mgr.getAlbums(userFileManager.AlbumType.USER, userFileManager.AlbumSubType.USER_GENERIC, fetchOptions);
  let album = await fetchResult.getFirstObject();
  mgr.deleteAlbums([album], (err) => {
    if (err) {
      console.error('deletePhotoAlbumsCallback failed with err: ' + err);
      return;
Y
yangbo 已提交
604
    }
H
huweiqi 已提交
605
    console.info('deletePhotoAlbumsCallback successfully');
H
huweiqi 已提交
606
  });
H
huweiqi 已提交
607
  fetchResult.close();
Y
yangbo 已提交
608 609 610
}
```

H
huweiqi 已提交
611
### deleteAlbums<sup>10+</sup>
Y
yangbo 已提交
612

H
huweiqi 已提交
613
deleteAlbums(albums: Array&lt;Album&gt;): Promise&lt;void&gt;;
Y
yangbo 已提交
614

H
huweiqi 已提交
615 616 617
删除相册,使用Promise方式返回结果。

删除相册前需先确保相册存在,只能删除用户相册。
李云帆 已提交
618

Y
yangbo 已提交
619 620
**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

H
huweiqi 已提交
621
**需要权限**:ohos.permission.WRITE_IMAGEVIDEO
Y
yangbo 已提交
622 623 624

**参数:**

Z
zhang-daiyue 已提交
625 626
| 参数名   | 类型                     | 必填 | 说明                      |
| -------- | ------------------------ | ---- | ------------------------- |
H
huweiqi 已提交
627
| albums  |  Array&lt;[Album](#album)&gt;          | 是   | 待删除相册的数组。              |
Y
yangbo 已提交
628

Z
zengyawen 已提交
629
**返回值:**
Y
yangbo 已提交
630

Z
zhang-daiyue 已提交
631 632
| 类型                        | 说明           |
| --------------------------- | -------------- |
H
huweiqi 已提交
633
| Promise&lt;void&gt; | Promise对象,返回void。 |
Y
yangbo 已提交
634 635 636 637

**示例:**

```ts
H
huweiqi 已提交
638 639
import dataSharePredicates from '@ohos.data.dataSharePredicates';

Z
zhang-daiyue 已提交
640
async function example() {
H
huweiqi 已提交
641
  // 示例代码为删除相册名为newAlbumName的相册。
H
huweiqi 已提交
642
  console.info('deleteAlbumsDemo');
Z
zhang-daiyue 已提交
643
  let predicates = new dataSharePredicates.DataSharePredicates();
H
huweiqi 已提交
644
  predicates.equalTo('album_name', 'newAlbumName');
Z
zhang-daiyue 已提交
645 646 647 648
  let fetchOptions = {
    fetchColumns: [],
    predicates: predicates
  };
H
huweiqi 已提交
649 650 651 652 653 654 655 656
  let fetchResult = await mgr.getAlbums(userFileManager.AlbumType.USER, userFileManager.AlbumSubType.USER_GENERIC, fetchOptions);
  let album = await fetchResult.getFirstObject();
  mgr.deleteAlbums([album]).then(() => {
    console.info('deletePhotoAlbumsPromise successfully');
    }).catch((err) => {
      console.error('deletePhotoAlbumsPromise failed with err: ' + err);
  });
  fetchResult.close();
Y
yangbo 已提交
657 658
}
```
Z
zengyawen 已提交
659

H
huweiqi 已提交
660
### getAlbums<sup>10+</sup>
Y
yangbo 已提交
661

H
huweiqi 已提交
662
getAlbums(type: AlbumType, subType: AlbumSubType, options: FetchOptions, callback: AsyncCallback&lt;FetchResult&lt;Album&gt;&gt;): void;
Y
yangbo 已提交
663

H
huweiqi 已提交
664
根据检索选项和相册类型获取相册,使用callback方式返回结果。
Y
yangbo 已提交
665

H
huweiqi 已提交
666
获取相册前需先保证相册存在。
Y
yangbo 已提交
667

李云帆 已提交
668
**系统能力**:SystemCapability.FileManagement.UserFileManager.Core
Y
yangbo 已提交
669

H
huweiqi 已提交
670
**需要权限**:ohos.permission.READ_IMAGEVIDEO
Y
yangbo 已提交
671

H
huweiqi 已提交
672
**参数:**
Y
yangbo 已提交
673

H
huweiqi 已提交
674 675 676 677 678 679
| 参数名   | 类型                     | 必填 | 说明                      |
| -------- | ------------------------ | ---- | ------------------------- |
| type  | [AlbumType](#albumtype10)         | 是   | 相册类型。              |
| subType  | [AlbumSubType](#albumsubtype10)         | 是   | 相册子类型。              |
| options  | [FetchOptions](#fetchoptions)         | 是   |  检索选项。              |
| callback |  AsyncCallback&lt;[FetchResult](#fetchresult)&lt;[Album](#album)&gt;&gt; | 是   | callback返回获取相册的结果集。 |
Y
yangbo 已提交
680

H
huweiqi 已提交
681 682 683 684 685 686 687 688
**错误码:**

接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 13900020   | if type options is not FetchOption.         |

H
huweiqi 已提交
689
**示例:**
H
huweiqi 已提交
690

Y
yangbo 已提交
691
```ts
H
huweiqi 已提交
692 693
import dataSharePredicates from '@ohos.data.dataSharePredicates';

Z
zhang-daiyue 已提交
694
async function example() {
H
huweiqi 已提交
695
  // 示例代码中为获取相册名为newAlbumName的相册。
H
huweiqi 已提交
696
  console.info('getAlbumsDemo');
Z
zhang-daiyue 已提交
697
  let predicates = new dataSharePredicates.DataSharePredicates();
H
huweiqi 已提交
698
  predicates.equalTo('album_name', 'newAlbumName');
Z
zhang-daiyue 已提交
699 700 701 702
  let fetchOptions = {
    fetchColumns: [],
    predicates: predicates
  };
H
huweiqi 已提交
703 704 705 706 707 708 709 710 711 712 713 714 715 716 717
  mgr.getAlbums(userFileManager.AlbumType.USER, userFileManager.AlbumSubType.USER_GENERIC, fetchOptions, async (err, fetchResult) => {
    if (err) {
      console.error('getAlbumsCallback failed with err: ' + err);
      return;
    }
    if (fetchResult == undefined) {
      console.error('getAlbumsCallback fetchResult is undefined');
      return;
    }
    let album = await fetchResult.getFirstObject();
    console.info('getAlbumsCallback successfully, albumName: ' + album.albumName);
    fetchResult.close();
  });
}
```
Z
zhang-daiyue 已提交
718

H
huweiqi 已提交
719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738
### getAlbums<sup>10+</sup>

getAlbums(type: AlbumType, subType: AlbumSubType, callback: AsyncCallback&lt;FetchResult&lt;Album&gt;&gt;): void;

根据相册类型获取相册,使用callback方式返回结果。

获取相册前需先保证相册存在。

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

**需要权限**:ohos.permission.READ_IMAGEVIDEO

**参数:**

| 参数名   | 类型                     | 必填 | 说明                      |
| -------- | ------------------------ | ---- | ------------------------- |
| type  | [AlbumType](#albumtype10)         | 是   | 相册类型。              |
| subType  | [AlbumSubType](#albumsubtype10)         | 是   | 相册子类型。              |
| callback |  AsyncCallback&lt;[FetchResult](#fetchresult)&lt;[Album](#album)&gt;&gt; | 是   | callback返回获取相册的结果集。 |

H
huweiqi 已提交
739 740 741 742 743 744 745 746
**错误码:**

接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 13900020   | if type options is not FetchOption.         |

H
huweiqi 已提交
747 748 749 750 751 752 753 754 755 756
**示例:**

```ts
async function example() {
  // 示例代码中为获取统相册VIDEO,默认已预置。
  console.info('getAlbumsDemo');
  mgr.getAlbums(userFileManager.AlbumType.SYSTEM, userFileManager.AlbumSubType.VIDEO, async (err, fetchResult) => {
    if (err) {
      console.error('getAlbumsCallback failed with err: ' + err);
      return;
Z
zhang-daiyue 已提交
757
    }
H
huweiqi 已提交
758 759 760 761 762 763 764
    if (fetchResult == undefined) {
      console.error('getAlbumsCallback fetchResult is undefined');
      return;
    }
    let album = await fetchResult.getFirstObject();
    console.info('getAlbumsCallback successfully, albumUri: ' + album.albumUri);
    fetchResult.close();
Z
zhang-daiyue 已提交
765
  });
Y
yangbo 已提交
766 767
}
```
Z
zengyawen 已提交
768

H
huweiqi 已提交
769
### getAlbums<sup>10+</sup>
Y
yangbo 已提交
770

H
huweiqi 已提交
771
getAlbums(type: AlbumType, subType: AlbumSubType, options?: FetchOptions): Promise&lt;FetchResult&lt;Album&gt;&gt;;
Y
yangbo 已提交
772

H
huweiqi 已提交
773
根据检索选项和相册类型获取相册,使用Promise方式返回结果。
Y
yangbo 已提交
774

H
huweiqi 已提交
775
获取相册前需先保证相册存在。
Y
yangbo 已提交
776

李云帆 已提交
777 778
**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

H
huweiqi 已提交
779
**需要权限**:ohos.permission.READ_IMAGEVIDEO
Y
yangbo 已提交
780

H
huweiqi 已提交
781
**参数:**
Y
yangbo 已提交
782

H
huweiqi 已提交
783 784 785 786 787
| 参数名   | 类型                     | 必填 | 说明                      |
| -------- | ------------------------ | ---- | ------------------------- |
| type  | [AlbumType](#albumtype10)         | 是   | 相册类型。              |
| subType  | [AlbumSubType](#albumsubtype10)         | 是   | 相册子类型。              |
| options  | [FetchOptions](#fetchoptions)         | 否   |  检索选项,不填时默认根据相册类型检索。              |
Y
yangbo 已提交
788

Z
zengyawen 已提交
789
**返回值:**
Y
yangbo 已提交
790

H
huweiqi 已提交
791 792 793
| 类型                        | 说明           |
| --------------------------- | -------------- |
| Promise&lt;[FetchResult](#fetchresult)&lt;[Album](#album)&gt;&gt; | Promise对象,返回获取相册的结果集。 |
Y
yangbo 已提交
794

H
huweiqi 已提交
795 796 797 798 799 800 801 802
**错误码:**

接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 13900020   | if type options is not FetchOption.         |

H
huweiqi 已提交
803
**示例:**
Y
yangbo 已提交
804 805

```ts
H
huweiqi 已提交
806 807
import dataSharePredicates from '@ohos.data.dataSharePredicates';

Z
zhang-daiyue 已提交
808
async function example() {
H
huweiqi 已提交
809
  // 示例代码中为获取相册名为newAlbumName的相册。
H
huweiqi 已提交
810
  console.info('getAlbumsDemo');
Z
zhang-daiyue 已提交
811
  let predicates = new dataSharePredicates.DataSharePredicates();
H
huweiqi 已提交
812
  predicates.equalTo('album_name', 'newAlbumName');
Z
zhang-daiyue 已提交
813 814 815 816
  let fetchOptions = {
    fetchColumns: [],
    predicates: predicates
  };
H
huweiqi 已提交
817 818 819 820 821 822 823 824 825 826 827 828 829 830
  mgr.getAlbums(userFileManager.AlbumType.USER, userFileManager.AlbumSubType.USER_GENERIC, fetchOptions).then( async (fetchResult) => {
    if (fetchResult == undefined) {
      console.error('getAlbumsPromise fetchResult is undefined');
      return;
    }
    let album = await fetchResult.getFirstObject();
    console.info('getAlbumsPromise successfully, albumName: ' + album.albumName);
    fetchResult.close();
  }).catch((err) => {
    console.error('getAlbumsPromise failed with err: ' + err);
  });
}
```

H
huweiqi 已提交
831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 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
### getPhotoAlbums

getPhotoAlbums(options: AlbumFetchOptions, callback: AsyncCallback&lt;FetchResult&lt;Album&gt;&gt;): void;

获取相册,使用callback方式返回结果。

此接口即将废弃,请使用[getAlbums<sup>10+</sup>](#getalbums10)的新接口。

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

**需要权限**:ohos.permission.READ_IMAGEVIDEO

**参数:**

| 参数名   | 类型                     | 必填 | 说明                      |
| -------- | ------------------------ | ---- | ------------------------- |
| options  | [AlbumFetchOptions](#albumfetchoptions)        | 是   | 相册检索选项。              |
| callback |  AsyncCallback&lt;[FetchResult](#fetchresult)&lt;[Album](#album)&gt;&gt; | 是   | callback返回相册检索结果。 |

**错误码:**

接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 13900020   | if type options is not AlbumFetchOptions.         |

**示例:**

```ts
import dataSharePredicates from '@ohos.data.dataSharePredicates';

async function example() {
  console.info('getPhotoAlbumsDemo');
  let predicates = new dataSharePredicates.DataSharePredicates();
  let albumFetchOptions = {
    predicates: predicates
  };

  mgr.getPhotoAlbums(albumFetchOptions, (err, fetchResult) => {
    if (fetchResult != undefined) {
      console.info('albums.count = ' + fetchResult.getCount());
      fetchResult.getFirstObject((err, album) => {
        if (album != undefined) {
          console.info('first album.albumName = ' + album.albumName);
        } else {
          console.error('album is undefined, err = ', err);
        }
      });
    } else {
      console.error('getPhotoAlbums fail, message = ', err);
    }
  });
}
```

### getPhotoAlbums

getPhotoAlbums(options: AlbumFetchOptions): Promise&lt;FetchResult&lt;Album&gt;&gt;;

获取相册,使用Promise方式返回结果。

此接口即将废弃,请使用[getAlbums<sup>10+</sup>](#getalbums10)的新接口。

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

**需要权限**:ohos.permission.READ_IMAGEVIDEO

**参数:**

| 参数名   | 类型                     | 必填 | 说明                      |
| -------- | ------------------------ | ---- | ------------------------- |
| options  | [AlbumFetchOptions](#albumfetchoptions)        | 是   | 相册检索选项。              |

**返回值:**

| 类型                        | 说明           |
| --------------------------- | -------------- |
| Promise&lt;[FetchResult](#fetchresult)&lt;[Album](#album)&gt;&gt; | Promise对象,返回相册检索结果。 |

**错误码:**

接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 13900020   | if type options is not AlbumFetchOptions.         |

**示例:**

```ts
import dataSharePredicates from '@ohos.data.dataSharePredicates';

async function example() {
  console.info('getPhotoAlbumsDemo');
  let predicates = new dataSharePredicates.DataSharePredicates();
  let albumFetchOptions = {
    predicates: predicates
  };
  try {
    let fetchResult = await mgr.getPhotoAlbums(albumFetchOptions);
    console.info('album.count = ' + fetchResult.getCount());
    const album = await fetchResult.getFirstObject();
    console.info('first album.albumName = ' + album.albumName);
  } catch (err) {
    console.error('getPhotoAlbums fail, message = ' + err);
  }
}
```

H
huweiqi 已提交
941 942 943 944 945 946
### getPrivateAlbum

getPrivateAlbum(type: PrivateAlbumType, callback: AsyncCallback&lt;FetchResult&lt;PrivateAlbum&gt;&gt;): void;

获取系统相册,使用 callback 方式返回系统相册的数组。

H
huweiqi 已提交
947 948
此接口即将废弃,请使用[getAlbums<sup>10+</sup>](#getalbums10)的新接口。

H
huweiqi 已提交
949 950 951 952 953 954 955 956 957 958 959
**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

**需要权限**:ohos.permission.READ_IMAGEVIDEO

**参数:**

| 参数名   | 类型                     | 必填 | 说明                      |
| -------- | ------------------------ | ---- | ------------------------- |
| type  | [PrivateAlbumType](#privatealbumtype)        | 是   | 系统相册类型。              |
| callback |  AsyncCallback&lt;[FetchResult](#fetchresult)&lt;[PrivateAlbum](#privatealbum)&gt;&gt; | 是   | callback返回相册检索结果。 |

H
huweiqi 已提交
960 961 962 963 964 965 966 967
**错误码:**

接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 13900020   | if type type is not PrivateAlbumType.         |

H
huweiqi 已提交
968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989
**示例:**

```ts
async function example() {
  console.info('getPrivateAlbumDemo');
  mgr.getPrivateAlbum(userFileManager.PrivateAlbumType.TYPE_TRASH, async (err, fetchResult) => {
    if (fetchResult != undefined) {
      let trashAlbum = await fetchResult.getFirstObject();
      console.info('first album.albumName = ' + trashAlbum.albumName);
    } else {
      console.error('getPrivateAlbum failed. message = ', err);
    }
  });
}
```

### getPrivateAlbum

getPrivateAlbum(type: PrivateAlbumType): Promise&lt;FetchResult&lt;PrivateAlbum&gt;&gt;;

获取系统相册,使用Promise方式返回结果。

H
huweiqi 已提交
990 991
此接口即将废弃,请使用[getAlbums<sup>10+</sup>](#getalbums10)的新接口。

H
huweiqi 已提交
992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007
**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

**需要权限**:ohos.permission.READ_IMAGEVIDEO

**参数:**

| 参数名   | 类型                     | 必填 | 说明                      |
| -------- | ------------------------ | ---- | ------------------------- |
| type  | [PrivateAlbumType](#privatealbumtype)        | 是   | 系统相册类型。              |

**返回值:**

| 类型                        | 说明           |
| --------------------------- | -------------- |
| Promise&lt;[FetchResult](#fetchresult)&lt;[PrivateAlbum](#privatealbum)&gt;&gt; | Promise对象,返回相册检索结果。 |

H
huweiqi 已提交
1008 1009 1010 1011 1012 1013 1014 1015
**错误码:**

接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 13900020   | if type type is not PrivateAlbumType.         |

H
huweiqi 已提交
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047
**示例:**

```ts
async function example() {
  console.info('getPrivateAlbumDemo');
  try {
    let fetchResult = await mgr.getPrivateAlbum(userFileManager.PrivateAlbumType.TYPE_TRASH);
    let trashAlbum = await fetchResult.getFirstObject();
    console.info('first album.albumName = ' + trashAlbum.albumName);
  } catch (err) {
    console.error('getPrivateAlbum failed. message = ', err);
  }
}
```

### getAudioAssets

getAudioAssets(options: FetchOptions, callback: AsyncCallback&lt;FetchResult&lt;FileAsset&gt;&gt;): void;

获取音频文件,使用callback方式返回结果。

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

**需要权限**:ohos.permission.READ_AUDIO

**参数:**

| 参数名   | 类型                     | 必填 | 说明                      |
| -------- | ------------------------ | ---- | ------------------------- |
| options  | [FetchOptions](#fetchoptions)        | 是   | 检索选项。              |
| callback |  AsyncCallback&lt;[FetchResult](#fetchresult)&lt;[FileAsset](#fileasset)&gt;&gt; | 是   | callback返回音频检索结果。 |

H
huweiqi 已提交
1048 1049 1050 1051 1052 1053 1054 1055
**错误码:**

接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 13900020   | if type options is not FetchOptions.         |

H
huweiqi 已提交
1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105
**示例:**

```ts
import dataSharePredicates from '@ohos.data.dataSharePredicates';

async function example() {
  console.info('getAudioAssets');
  let predicates = new dataSharePredicates.DataSharePredicates();
  let fetchOptions = {
    fetchColumns: [],
    predicates: predicates
  };

  mgr.getAudioAssets(fetchOptions, async (err, fetchResult) => {
    if (fetchResult != undefined) {
      console.info('fetchFileResult success');
      let fileAsset = await fetchResult.getFirstObject();
      if (fileAsset != undefined) {
        console.info('fileAsset.displayName :' + fileAsset.displayName);
      }
    } else {
      console.error('fetchFileResult fail' + err);
    }
  });
}
```

### getAudioAssets

getAudioAssets(options: FetchOptions): Promise&lt;FetchResult&lt;FileAsset&gt;&gt;;


获取音频文件,使用callback方式返回结果。

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

**需要权限**:ohos.permission.READ_AUDIO

**参数:**

| 参数名   | 类型                     | 必填 | 说明                      |
| -------- | ------------------------ | ---- | ------------------------- |
| options  | [FetchOptions](#fetchoptions)        | 是   | 检索选项。              |

**返回值:**

| 类型                        | 说明           |
| --------------------------- | -------------- |
| Promise&lt;[FetchResult](#fetchresult)&lt;[FileAsset](#fileasset)&gt;&gt; | Promise对象,返回音频检索结果。 |

H
huweiqi 已提交
1106 1107 1108 1109 1110 1111 1112 1113
**错误码:**

接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 13900020   | if type options is not FetchOptions.         |

H
huweiqi 已提交
1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158
**示例:**

```ts
import dataSharePredicates from '@ohos.data.dataSharePredicates';

async function example() {
  console.info('getAudioAssets');
  let predicates = new dataSharePredicates.DataSharePredicates();
  let fetchOptions = {
    fetchColumns: [],
    predicates: predicates
  };
  try {
    var fetchResult = await mgr.getAudioAssets(fetchOptions);
  } catch (err) {
    console.error('getAudioAssets failed, message = ', err);
  }

  if (fetchResult != undefined) {
    console.info('fetchFileResult success');
    let fileAsset = await fetchResult.getFirstObject();
    if (fileAsset != undefined) {
      console.info('fileAsset.displayName :' + fileAsset.displayName);
    }
  }
}
```

### delete

delete(uri: string, callback: AsyncCallback&lt;void&gt;): void;

删除媒体文件,删除的文件进入到回收站。

**需要权限**:ohos.permission.READ_IMAGEVIDEO 和 ohos.permission.WRITE_IMAGEVIDEO 或 ohos.permission.READ_AUDIO 和 ohos.permission.WRITE_AUDIO

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

**参数:**

| 参数名   | 类型                      | 必填 | 说明       |
| -------- | ------------------------- | ---- | ---------- |
| uri | string | 是   | 媒体文件uri。 |
| callback | AsyncCallback&lt;void&gt; | 是   | callback返回void。 |

H
huweiqi 已提交
1159 1160 1161 1162 1163 1164 1165 1166
**错误码:**

接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 13900020   | if type uri is not string.         |

H
huweiqi 已提交
1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221
**示例:**

```ts
import dataSharePredicates from '@ohos.data.dataSharePredicates';

async function example() {
  console.info('deleteAssetDemo');
  let predicates = new dataSharePredicates.DataSharePredicates();
  let fetchOptions = {
    fetchColumns: [],
    predicates: predicates
  };
  try {
    const fetchResult = await mgr.getPhotoAssets(fetchOptions);
    var asset = await fetchResult.getFirstObject();
  } catch (err) {
    console.info('fetch failed, message =', err);
  }

  if (asset == undefined) {
    console.error('asset not exist');
    return;
  }
  mgr.delete(asset.uri, (err) => {
    if (err == undefined) {
      console.info('delete successfully');
    } else {
      console.error('delete failed with error: ' + err);
    }
  });
}
```

### delete

delete(uri: string): Promise&lt;void&gt;;

删除媒体文件,删除的文件进入到回收站。

**需要权限**:ohos.permission.READ_IMAGEVIDEO 和 ohos.permission.WRITE_IMAGEVIDEO 或 ohos.permission.READ_AUDIO 和 ohos.permission.WRITE_AUDIO

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

**参数:**

| 参数名   | 类型                      | 必填 | 说明       |
| -------- | ------------------------- | ---- | ---------- |
| uri | string | 是   | 媒体文件uri。 |

**返回值:**

| 类型                                    | 说明              |
| --------------------------------------- | ----------------- |
| Promise&lt;void&gt;| Promise对象,返回void。 |

H
huweiqi 已提交
1222 1223 1224 1225 1226 1227 1228 1229
**错误码:**

接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 13900020   | if type uri is not string.         |

H
huweiqi 已提交
1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243
**示例:**

```ts
import dataSharePredicates from '@ohos.data.dataSharePredicates';

async function example() {
  console.info('deleteDemo');
  let predicates = new dataSharePredicates.DataSharePredicates();
  let fetchOptions = {
    fetchColumns: [],
    predicates: predicates
  };
  try {
    const fetchResult = await mgr.getPhotoAssets(fetchOptions);
Z
zhang-daiyue 已提交
1244 1245
    var asset = await fetchResult.getFirstObject();
  } catch (err) {
H
huweiqi 已提交
1246
    console.info('fetch failed, message =', err);
Z
zhang-daiyue 已提交
1247 1248 1249
  }

  if (asset == undefined) {
H
huweiqi 已提交
1250
    console.error('asset not exist');
Z
zhang-daiyue 已提交
1251 1252 1253 1254
    return;
  }
  try {
    await mgr.delete(asset.uri);
H
huweiqi 已提交
1255
    console.info('delete successfully');
Z
zhang-daiyue 已提交
1256
  } catch (err) {
H
huweiqi 已提交
1257
    console.error('delete failed with error: ' + err);
Z
zhang-daiyue 已提交
1258
  }
Y
yangbo 已提交
1259 1260 1261 1262 1263
}
```

### getActivePeers

Z
zhang-daiyue 已提交
1264
getActivePeers(callback: AsyncCallback&lt;Array&lt;PeerInfo&gt;&gt;): void;
Y
yangbo 已提交
1265 1266 1267 1268 1269 1270 1271 1272 1273

获取在线对端设备的信息,使用callback方式返回异步结果。

**系统能力**:SystemCapability.FileManagement.UserFileManager.DistributedCore

**参数:**

| 参数名   | 类型                              | 必填 | 说明         |
| -------- | --------------------------------- | ---- | ------------ |
H
huweiqi 已提交
1274
| callback | AsyncCallback&lt;Array&lt;[PeerInfo](#peerinfo)&gt;&gt; | 是   | 返回在线设备列表。 |
Y
yangbo 已提交
1275 1276 1277 1278

**示例:**

```ts
Z
zhang-daiyue 已提交
1279
async function example() {
H
huweiqi 已提交
1280
  console.info('getActivePeersDemo');
Z
zhang-daiyue 已提交
1281 1282
  mgr.getActivePeers((err, devicesInfo) => {
    if (devicesInfo != undefined) {
H
huweiqi 已提交
1283
      console.log('getActivePeers succeed.');
Z
zhang-daiyue 已提交
1284 1285 1286 1287
      for (let i = 0; i < devicesInfo.length; i++) {
        console.info('get distributed info ' + devicesInfo[i].deviceName + devicesInfo[i].networkId);
      }
    } else {
H
huweiqi 已提交
1288
      console.error('getActivePeers failed. message = ', err);
Z
zhang-daiyue 已提交
1289 1290
    }
  });
Y
yangbo 已提交
1291 1292 1293 1294 1295
}
```

### getActivePeers

Z
zhang-daiyue 已提交
1296
getActivePeers(): Promise&lt;Array&lt;PeerInfo&gt;&gt;;
Y
yangbo 已提交
1297 1298 1299 1300 1301 1302 1303 1304 1305

获取在线对端设备的信息,使用promise方式返回异步结果。

**系统能力**:SystemCapability.FileManagement.UserFileManager.DistributedCore

**返回值:**

| 类型                        | 说明                          |
| --------------------------- | ----------------------------- |
H
huweiqi 已提交
1306
| Promise&lt;Array&lt;[PeerInfo](#peerinfo)&gt;&gt; | Promise对象,返回在线设备列表。 |
Y
yangbo 已提交
1307 1308 1309 1310

**示例:**

```ts
Z
zhang-daiyue 已提交
1311
async function example() {
H
huweiqi 已提交
1312
  console.info('getActivePeersDemo');
Z
zhang-daiyue 已提交
1313 1314 1315
  try {
    var devicesInfo = await mgr.getActivePeers();
  } catch (err) {
H
huweiqi 已提交
1316
    console.error('getActivePeers failed. message = ', err);
Z
zhang-daiyue 已提交
1317 1318
  }
  if (devicesInfo != undefined) {
H
huweiqi 已提交
1319
    console.log('getActivePeers succeed.');
Z
zhang-daiyue 已提交
1320 1321
    for (let i = 0; i < devicesInfo.length; i++) {
      console.info('get distributed info ' + devicesInfo[i].deviceName + devicesInfo[i].networkId);
Y
yangbo 已提交
1322
    }
Z
zhang-daiyue 已提交
1323
  } else {
H
huweiqi 已提交
1324
    console.error('get distributed fail');
Z
zhang-daiyue 已提交
1325
  }
Y
yangbo 已提交
1326 1327 1328 1329 1330
}
```

### getAllPeers

Z
zhang-daiyue 已提交
1331
getAllPeers(callback: AsyncCallback&lt;Array&lt;PeerInfo&gt;&gt;): void;
Y
yangbo 已提交
1332 1333 1334 1335 1336 1337 1338 1339 1340

获取所有对端设备的信息,使用callback方式返回异步结果。

**系统能力**:SystemCapability.FileManagement.UserFileManager.DistributedCore

**参数:**

| 参数名   | 类型                              | 必填 | 说明         |
| -------- | --------------------------------- | ---- | ------------ |
H
huweiqi 已提交
1341
| callback | AsyncCallback&lt;Array&lt;[PeerInfo](#peerinfo)&gt;&gt; | 是   | 返回在线设备列表。 |
Y
yangbo 已提交
1342 1343 1344 1345

**示例:**

```ts
Z
zhang-daiyue 已提交
1346
async function example() {
H
huweiqi 已提交
1347
  console.info('getAllPeersDemo');
Z
zhang-daiyue 已提交
1348 1349
  mgr.getAllPeers((err, devicesInfo) => {
    if (devicesInfo != undefined) {
H
huweiqi 已提交
1350
      console.log('getAllPeers succeed.');
Z
zhang-daiyue 已提交
1351 1352 1353 1354
      for (let i = 0; i < devicesInfo.length; i++) {
        console.info('get distributed info ' + devicesInfo[i].deviceName + devicesInfo[i].networkId);
      }
    } else {
H
huweiqi 已提交
1355
      console.error('getAllPeers failed. message = ', err);
Z
zhang-daiyue 已提交
1356 1357
    }
  });
Y
yangbo 已提交
1358 1359 1360 1361 1362
}
```

### getAllPeers

Z
zhang-daiyue 已提交
1363
getAllPeers(): Promise&lt;Array&lt;PeerInfo&gt;&gt;;
Y
yangbo 已提交
1364 1365 1366 1367 1368 1369 1370 1371 1372

获取所有对端设备的信息,使用promise方式返回异步结果。

**系统能力**:SystemCapability.FileManagement.UserFileManager.DistributedCore

**返回值:**

| 类型                        | 说明                          |
| --------------------------- | ----------------------------- |
H
huweiqi 已提交
1373
| Promise&lt;Array&lt;[PeerInfo](#peerinfo)&gt;&gt; | Promise对象,返回所有设备列表。 |
Y
yangbo 已提交
1374 1375 1376 1377

**示例:**

```ts
Z
zhang-daiyue 已提交
1378
async function example() {
H
huweiqi 已提交
1379
  console.info('getAllPeersDemo');
Z
zhang-daiyue 已提交
1380 1381 1382
  try {
    var devicesInfo = await mgr.getAllPeers();
  } catch (err) {
H
huweiqi 已提交
1383
    console.error('getAllPeers failed. message = ', err);
Z
zhang-daiyue 已提交
1384 1385
  }
  if (devicesInfo != undefined) {
H
huweiqi 已提交
1386
    console.log('getAllPeers succeed.');
Z
zhang-daiyue 已提交
1387 1388
    for (let i = 0; i < devicesInfo.length; i++) {
      console.info('get distributed info ' + devicesInfo[i].deviceName + devicesInfo[i].networkId);
Y
yangbo 已提交
1389
    }
Z
zhang-daiyue 已提交
1390
  } else {
H
huweiqi 已提交
1391
    console.error('get distributed fail');
Z
zhang-daiyue 已提交
1392
  }
Y
yangbo 已提交
1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408
}
```

### release

release(callback: AsyncCallback&lt;void&gt;): void

释放UserFileManager实例。
当后续不需要使用UserFileManager实例中的方法时调用。

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

**参数:**

| 参数名   | 类型                      | 必填 | 说明                 |
| -------- | ------------------------- | ---- | -------------------- |
H
huweiqi 已提交
1409
| callback | AsyncCallback&lt;void&gt; | 是   | 回调表示成功还是失败。 |
Y
yangbo 已提交
1410 1411 1412 1413

**示例:**

```ts
Z
zhang-daiyue 已提交
1414 1415 1416 1417
async function example() {
  console.info('releaseDemo');
  mgr.release((err) => {
    if (err != undefined) {
H
huweiqi 已提交
1418
      console.error('release failed. message = ', err);
Z
zhang-daiyue 已提交
1419 1420 1421
    } else {
      console.info('release ok.');
    }
H
huweiqi 已提交
1422
  });
Y
yangbo 已提交
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432
}
```

### release

release(): Promise&lt;void&gt;

释放UserFileManager实例。
当后续不需要使用UserFileManager 实例中的方法时调用。

李云帆 已提交
1433
**系统能力**:SystemCapability.FileManagement.UserFileManager.Core
Y
yangbo 已提交
1434 1435 1436 1437 1438

**返回值:**

| 类型                | 说明                              |
| ------------------- | --------------------------------- |
H
huweiqi 已提交
1439
| Promise&lt;void&gt; | Promise对象,返回void。 |
Y
yangbo 已提交
1440 1441 1442 1443

**示例:**

```ts
Z
zhang-daiyue 已提交
1444 1445 1446 1447 1448 1449
async function example() {
  console.info('releaseDemo');
  try {
    await mgr.release();
    console.info('release ok.');
  } catch (err) {
H
huweiqi 已提交
1450
    console.error('release failed. message = ', err);
Z
zhang-daiyue 已提交
1451
  }
Y
yangbo 已提交
1452 1453 1454
}
```

C
caochuan 已提交
1455 1456 1457 1458
### on<sup>10+</sup>

on(uri: string, forSubUri: boolean, callback: Callback&lt;ChangeData&gt;) : void

H
huweiqi 已提交
1459
对指定uri注册监听,使用callback方式返回异步结果。
C
caochuan 已提交
1460 1461 1462 1463 1464 1465 1466

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

**参数:**

| 参数名    | 类型                                        | 必填 | 说明                                                         |
| --------- | ------------------------------------------- | ---- | ------------------------------------------------------------ |
1467
| uri       | string                                      | 是   | FileAsset的uri, Album的uri或[DefaultChangeUri](#defaultchangeuri10)的值。 |
1468 1469
| forSubUri | boolean                                     | 是   | 是否模糊监听,uri为相册uri时,forSubUri 为true能监听到相册中文件的变化,如果是false只能监听相册本身变化。uri为fileAsset时,forSubUri 为true、false没有区别,uri为DefaultChangeUri时,forSubUri必须为true,如果为false将找不到该uri,收不到任何消息。 |
| callback  | Callback&lt;[ChangeData](#changedata10)&gt; | 是   | 返回要监听的[ChangeData](#changedata10)。注:uri可以注册多个不同的callback监听,[off<sup>10+</sup>](#off10)可以关闭该uri所有监听,也可以关闭指定callback的监听。 |
C
caochuan 已提交
1470

H
huweiqi 已提交
1471 1472 1473 1474 1475 1476 1477 1478
**错误码:**

接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 13900020   | if parameter is invalid.         |

C
caochuan 已提交
1479 1480 1481
**示例:**

```ts
H
huweiqi 已提交
1482 1483
import dataSharePredicates from '@ohos.data.dataSharePredicates';

C
caochuan 已提交
1484
async function example() {
1485
  console.info('onDemo');
1486 1487 1488 1489 1490 1491 1492 1493 1494
  let predicates = new dataSharePredicates.DataSharePredicates();
  let fetchOptions = {
    fetchColumns: [],
    predicates: predicates
  };
  let fetchResult = await mgr.getPhotoAssets(fetchOptions);
  let fileAsset = await fetchResult.getFirstObject();
  if (fileAsset != undefined) {
    console.info('fileAsset.displayName : ' + fileAsset.displayName);
1495
  }
1496 1497 1498 1499 1500 1501
  let onCallback1 = (changeData) => {
      console.info('onCallback1 success, changData: ' + JSON.stringify(changeData));
    //file had changed, do something
  }
  let onCallback2 = (changeData) => {
      console.info('onCallback2 success, changData: ' + JSON.stringify(changeData));
1502 1503
    //file had changed, do something
  }
1504
  // 注册onCallback1监听
S
sunshenshen 已提交
1505
  mgr.on(fileAsset.uri, false, onCallback1);
1506 1507 1508 1509 1510 1511 1512 1513 1514 1515
  // 注册onCallback2监听
  mgr.on(fileAsset.uri, false, onCallback2);

  fileAsset.favorite(true, (err) => {
    if (err == undefined) {
      console.info('favorite successfully');
    } else {
      console.error('favorite failed with error:' + err);
    }
  });
C
caochuan 已提交
1516 1517 1518 1519 1520 1521 1522
}
```

### off<sup>10+</sup>

 off(uri: string, callback?: Callback&lt;ChangeData&gt;): void

H
huweiqi 已提交
1523
取消对指定uri的监听,一个uri可以注册多个监听,存在多个callback监听时,可以取消指定注册的callback的监听;不指定callback时解除该uri的所有监听。
C
caochuan 已提交
1524 1525 1526 1527 1528 1529 1530

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

**参数:**

| 参数名   | 类型                                        | 必填 | 说明                                                         |
| -------- | ------------------------------------------- | ---- | ------------------------------------------------------------ |
1531
| uri      | string                                      | 是   | FileAsset的uri, Album的uri或[DefaultChangeUri](#defaultchangeuri10)的值。 |
H
huweiqi 已提交
1532
| callback | Callback&lt;[ChangeData](#changedata10)&gt; | 否   | 取消[on<sup>10+</sup>](#on10)注册时的callback的监听,不填时,取消该uri的所有监听。注:off指定注册的callback后不会进入此回调。 |
C
caochuan 已提交
1533

H
huweiqi 已提交
1534 1535 1536 1537 1538 1539 1540 1541
**错误码:**

接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 13900020   | if parameter is invalid.         |

C
caochuan 已提交
1542 1543 1544
**示例:**

```ts
H
huweiqi 已提交
1545 1546
import dataSharePredicates from '@ohos.data.dataSharePredicates';

C
caochuan 已提交
1547
async function example() {
1548 1549 1550 1551 1552 1553 1554 1555 1556 1557
  console.info('offDemo');
  let predicates = new dataSharePredicates.DataSharePredicates();
  let fetchOptions = {
    fetchColumns: [],
    predicates: predicates
  };
  let fetchResult = await mgr.getPhotoAssets(fetchOptions);
  let fileAsset = await fetchResult.getFirstObject();
  if (fileAsset != undefined) {
    console.info('fileAsset.displayName : ' + fileAsset.displayName);
1558
  }
1559 1560
  let onCallback1 = (changeData) => {
    console.info('onCallback1 on');
1561
  }
1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577
  let onCallback2 = (changeData) => {
    console.info('onCallback2 on');
  }
  // 注册onCallback1监听
  mgr.on(fileAsset.uri, false, onCallback1);
  // 注册onCallback2监听
  mgr.on(fileAsset.uri, false, onCallback2);
  // 关闭onCallback1监听,onCallback2 继续监听
  mgr.off(fileAsset.uri, onCallback1);
  fileAsset.favorite(true, (err) => {
    if (err == undefined) {
      console.info('favorite successfully');
    } else {
      console.error('favorite failed with error:' + err);
    }
  });
C
caochuan 已提交
1578 1579 1580
}
```

H
huweiqi 已提交
1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676
### on

on(type: ChangeEvent, callback: Callback&lt;void&gt;): void

打开文件管理库变更通知,使用callback方式返回异步结果。

此接口即将废弃,请使用[on<sup>10+</sup>](#on10)的新接口。

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

**参数:**

| 参数名   | 类型                 | 必填 | 说明                                                         |
| -------- | -------------------- | ---- | ------------------------------------------------------------ |
| type     | [ChangeEvent](#changeevent)               | 是   | 媒体类型 <br/>'deviceChange':&nbsp;注册设备变更 <br/>'albumChange':&nbsp;相册变更<br/>'imageChange':&nbsp;图片文件变更<br/>'audioChange': &nbsp;音频文件变更<br/>'videoChange':  &nbsp;视频文件变更<br/>'remoteFileChange':&nbsp;注册设备上文件变更 |
| callback | Callback&lt;void&gt; | 是   | callback返回void                                                   |

**示例:**

```ts
async function example() {
  console.info('onDemo');
  let count = 0;
  mgr.on('imageChange', () => {
    count++;
    // image file had changed, do something
  });
  try {
    let testFileName = 'testFile' + Date.now() + '.jpg';
    let fileAsset = await mgr.createPhotoAsset(testFileName);
    console.info('createPhotoAsset file displayName' + fileAsset.displayName);
    console.info('createPhotoAsset successfully');
  } catch (err) {
    console.error('createPhotoAsset failed, message = ' + err);
  }
  //sleep 1s
  if (count > 0) {
    console.info('onDemo success');
  } else {
    console.error('onDemo fail');
  }
  mgr.off('imageChange', () => {
    // stop listening success
  });
}
```

### off

off(type: ChangeEvent, callback?: Callback&lt;void&gt;): void

关闭文件管理库变更通知,使用callback方式返回异步结果。

此接口即将废弃,请使用[off<sup>10+</sup>](#off10)的新接口。

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

**参数:**

| 参数名   | 类型                 | 必填 | 说明                                                         |
| -------- | -------------------- | ---- | ------------------------------------------------------------ |
| type     | [ChangeEvent](#changeevent)               | 是   | 媒体类型 <br/>'deviceChange':&nbsp;注册设备变更 <br/>'albumChange':&nbsp;相册变更<br/>'imageChange':&nbsp;图片文件变更<br/>'audioChange': &nbsp;音频文件变更<br/>'videoChange':  &nbsp;视频文件变更<br/>'remoteFileChange':&nbsp;注册设备上文件变更。 |
| callback | Callback&lt;void&gt; | 否   | callback返回void。                                                   |

**示例:**

```ts
async function example() {
  console.info('offDemo');
  let count = 0;
  mgr.on('imageChange', () => {
    count++;
    // image file had changed, do something
  });

  mgr.off('imageChange', () => {
    // stop listening success
  });

  try {
    let testFileName = 'testFile' + Date.now() + '.jpg';
    let fileAsset = await mgr.createPhotoAsset(testFileName);
    console.info('createPhotoAsset file displayName' + fileAsset.displayName);
    console.info('createPhotoAsset successfully');
  } catch (err) {
    console.error('createPhotoAsset failed, message = ' + err);
  }
  //sleep 1s
  if (count == 0) {
    console.info('offDemo success');
  } else {
    console.error('offDemo fail');
  }
}
```

Y
yangbo 已提交
1677 1678 1679 1680 1681 1682
## FileAsset

提供封装文件属性的方法。

### 属性

H
huweiqi 已提交
1683
**系统能力**:SystemCapability.FileManagement.UserFileManager.Core
Y
yangbo 已提交
1684 1685 1686

| 名称                      | 类型                     | 可读 | 可写 | 说明                                                   |
| ------------------------- | ------------------------ | ---- | ---- | ------------------------------------------------------ |
H
huweiqi 已提交
1687
| uri                       | string                   | 是   | 否   | 文件资源uri(如:file://media/image/2)。         |
Z
zhang-daiyue 已提交
1688
| fileType   | [FileType](#filetype) | 是   | 否   | 媒体文件类型                                               |
H
huweiqi 已提交
1689
| displayName               | string                   | 是   | 是   | 显示文件名,包含后缀名。                                 |
Y
yangbo 已提交
1690

Z
zhang-daiyue 已提交
1691
### get
Y
yangbo 已提交
1692

Z
zhang-daiyue 已提交
1693
get(member: string): MemberType;
Y
yangbo 已提交
1694

H
huweiqi 已提交
1695
获取FileAsset成员参数。
Y
yangbo 已提交
1696 1697 1698 1699 1700

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

**参数:**

Z
zhang-daiyue 已提交
1701 1702
| 参数名      | 类型                        | 必填   | 说明    |
| -------- | ------------------------- | ---- | ----- |
H
huweiqi 已提交
1703
| member | string | 是    | 成员参数名称例如:ImageVideoKey.URI。 |
Y
yangbo 已提交
1704 1705

**示例:**
H
huweiqi 已提交
1706

Z
zhang-daiyue 已提交
1707
```ts
H
huweiqi 已提交
1708 1709
import dataSharePredicates from '@ohos.data.dataSharePredicates';

Y
yangbo 已提交
1710
async function example() {
H
huweiqi 已提交
1711
  console.info('fileAssetGetDemo');
Z
zhang-daiyue 已提交
1712 1713 1714
  try {
    let predicates = new dataSharePredicates.DataSharePredicates();
    let fetchOption = {
H
huweiqi 已提交
1715
      fetchColumns: ['title'],
Z
zhang-daiyue 已提交
1716
      predicates: predicates
Y
yangbo 已提交
1717
    };
Z
zhang-daiyue 已提交
1718 1719
    let fetchResult = await mgr.getPhotoAssets(fetchOption);
    let fileAsset = await fetchResult.getFirstObject();
H
huweiqi 已提交
1720 1721
    let title = userFileManager.ImageVideoKey.TITLE;
    let fileAssetTitle = fileAsset.get(title.toString());
Z
zhang-daiyue 已提交
1722 1723
    console.info('fileAsset Get fileAssetTitle = ', fileAssetTitle);
  } catch (err) {
H
huweiqi 已提交
1724
    console.error('release failed. message = ', err);
Z
zhang-daiyue 已提交
1725
  }
Y
yangbo 已提交
1726 1727 1728
}
```

Z
zhang-daiyue 已提交
1729
### set
Y
yangbo 已提交
1730

Z
zhang-daiyue 已提交
1731
set(member: string, value: string): void;
Y
yangbo 已提交
1732

H
huweiqi 已提交
1733
设置FileAsset成员参数。
Y
yangbo 已提交
1734 1735 1736

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

Z
zhang-daiyue 已提交
1737
**参数:**
Y
yangbo 已提交
1738

Z
zhang-daiyue 已提交
1739 1740
| 参数名      | 类型                        | 必填   | 说明    |
| -------- | ------------------------- | ---- | ----- |
H
huweiqi 已提交
1741 1742
| member | string | 是    | 成员参数名称例如:ImageVideoKey.URI。 |
| value | string | 是    | 设置成员参数名称,只能修改ImageVideoKey.DISPLAY_NAME的值。 |
Y
yangbo 已提交
1743 1744

**示例:**
H
huweiqi 已提交
1745

Z
zhang-daiyue 已提交
1746
```ts
H
huweiqi 已提交
1747 1748
import dataSharePredicates from '@ohos.data.dataSharePredicates';

Y
yangbo 已提交
1749
async function example() {
H
huweiqi 已提交
1750
  console.info('fileAssetSetDemo');
Z
zhang-daiyue 已提交
1751 1752 1753 1754 1755
  try {
    let predicates = new dataSharePredicates.DataSharePredicates();
    let fetchOption = {
      fetchColumns: [],
      predicates: predicates
Y
yangbo 已提交
1756
    };
Z
zhang-daiyue 已提交
1757 1758
    let fetchResult = await mgr.getPhotoAssets(fetchOption);
    let fileAsset = await fetchResult.getFirstObject();
H
huweiqi 已提交
1759
    let displayName = userFileManager.ImageVideoKey.DISPLAY_NAME.toString();
H
huweiqi 已提交
1760
    fileAsset.set(displayName, 'newDisplayName1');
Z
zhang-daiyue 已提交
1761
  } catch (err) {
H
huweiqi 已提交
1762
    console.error('release failed. message = ', err);
Z
zhang-daiyue 已提交
1763
  }
Y
yangbo 已提交
1764 1765 1766 1767 1768 1769 1770 1771 1772
}
```

### commitModify

commitModify(callback: AsyncCallback&lt;void&gt;): void

修改文件的元数据,使用callback方式返回异步结果。

Z
zhang-daiyue 已提交
1773
**需要权限**:ohos.permission.WRITE_IMAGEVIDEO 或 ohos.permission.WRITE_AUDIO
Y
yangbo 已提交
1774 1775 1776 1777 1778 1779 1780

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

**参数:**

| 参数名      | 类型                        | 必填   | 说明    |
| -------- | ------------------------- | ---- | ----- |
H
huweiqi 已提交
1781
| callback | AsyncCallback&lt;void&gt; | 是    | callback返回void。 |
Y
yangbo 已提交
1782 1783 1784

**示例:**

Z
zhang-daiyue 已提交
1785
```ts
H
huweiqi 已提交
1786 1787
import dataSharePredicates from '@ohos.data.dataSharePredicates';

Y
yangbo 已提交
1788
async function example() {
H
huweiqi 已提交
1789
  console.info('commitModifyDemo');
Z
zhang-daiyue 已提交
1790 1791 1792 1793 1794 1795 1796
  let predicates = new dataSharePredicates.DataSharePredicates();
  let fetchOption = {
    fetchColumns: [],
    predicates: predicates
  };
  let fetchResult = await mgr.getPhotoAssets(fetchOption);
  let fileAsset = await fetchResult.getFirstObject();
H
huweiqi 已提交
1797
  let displayName = userFileManager.ImageVideoKey.DISPLAY_NAME.toString();
H
huweiqi 已提交
1798 1799 1800
  let fileAssetDisplayName = fileAsset.get(displayName);
  console.info('fileAsset get fileAssetDisplayName = ', fileAssetDisplayName);
  fileAsset.set(displayName, 'newDisplayName2');
Z
zhang-daiyue 已提交
1801 1802
  fileAsset.commitModify((err) => {
    if (err == undefined) {
H
huweiqi 已提交
1803 1804
      let newFileAssetDisplayName = fileAsset.get(displayName);
      console.info('fileAsset get newFileAssetDisplayName = ', newFileAssetDisplayName);
Z
zhang-daiyue 已提交
1805
    } else {
H
huweiqi 已提交
1806
      console.error('commitModify failed, message =', err);
Z
zhang-daiyue 已提交
1807 1808
    }
  });
Y
yangbo 已提交
1809 1810 1811 1812 1813 1814 1815 1816 1817
}
```

### commitModify

commitModify(): Promise&lt;void&gt;

修改文件的元数据,使用promise方式返回异步结果。

Z
zhang-daiyue 已提交
1818
**需要权限**:ohos.permission.WRITE_IMAGEVIDEO 或 ohos.permission.WRITE_AUDIO
Y
yangbo 已提交
1819 1820 1821 1822 1823 1824 1825

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

**返回值:**

| 类型                  | 说明         |
| ------------------- | ---------- |
H
huweiqi 已提交
1826
| Promise&lt;void&gt; | Promise对象,返回void。 |
Y
yangbo 已提交
1827

S
sunshenshen 已提交
1828
**示例:**
Y
yangbo 已提交
1829

Z
zhang-daiyue 已提交
1830
```ts
H
huweiqi 已提交
1831 1832
import dataSharePredicates from '@ohos.data.dataSharePredicates';

Y
yangbo 已提交
1833
async function example() {
H
huweiqi 已提交
1834
  console.info('commitModifyDemo');
Z
zhang-daiyue 已提交
1835 1836 1837 1838 1839 1840 1841
  let predicates = new dataSharePredicates.DataSharePredicates();
  let fetchOption = {
    fetchColumns: [],
    predicates: predicates
  };
  let fetchResult = await mgr.getPhotoAssets(fetchOption);
  let fileAsset = await fetchResult.getFirstObject();
H
huweiqi 已提交
1842
  let displayName = userFileManager.ImageVideoKey.DISPLAY_NAME.toString();
H
huweiqi 已提交
1843 1844 1845
  let fileAssetDisplayName = fileAsset.get(displayName);
  console.info('fileAsset get fileAssetDisplayName = ', fileAssetDisplayName);
  fileAsset.set(displayName, 'newDisplayName3');
Z
zhang-daiyue 已提交
1846
  try {
H
huweiqi 已提交
1847
    await fileAsset.commitModify();
H
huweiqi 已提交
1848 1849
    let newFileAssetDisplayName = fileAsset.get(displayName);
    console.info('fileAsset get newFileAssetDisplayName = ', newFileAssetDisplayName);
Z
zhang-daiyue 已提交
1850
  } catch (err) {
H
huweiqi 已提交
1851
    console.error('release failed. message = ', err);
Z
zhang-daiyue 已提交
1852
  }
Y
yangbo 已提交
1853 1854 1855 1856 1857 1858 1859 1860 1861
}
```

### open

open(mode: string, callback: AsyncCallback&lt;number&gt;): void

打开当前文件,使用callback方式返回异步结果。

H
huweiqi 已提交
1862
**注意**:当前写操作是互斥的操作,写操作完成后需要调用close进行释放。
Y
yangbo 已提交
1863

H
huweiqi 已提交
1864
**需要权限**:ohos.permission.READ_IMAGEVIDEO 或 ohos.permission.READ_AUDIO 或 ohos.permission.WRITE_IMAGEVIDEO 或 ohos.permission.WRITE_AUDIO
Y
yangbo 已提交
1865 1866 1867

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

H
huweiqi 已提交
1868
**参数:**
Y
yangbo 已提交
1869 1870 1871

| 参数名      | 类型                          | 必填   | 说明                                  |
| -------- | --------------------------- | ---- | ----------------------------------- |
H
huweiqi 已提交
1872 1873
| mode     | string                      | 是    | 打开文件方式,如:'r'(只读), 'w'(只写), 'rw'(读写)。 |
| callback | AsyncCallback&lt;number&gt; | 是    | callback返回文件描述符。                            |
Y
yangbo 已提交
1874 1875 1876

**示例:**

Z
zhang-daiyue 已提交
1877
```ts
Y
yangbo 已提交
1878
async function example() {
H
huweiqi 已提交
1879
  console.info('openDemo');
H
huweiqi 已提交
1880
   let testFileName = 'testFile' + Date.now() + '.jpg';
H
huweiqi 已提交
1881
  const fileAsset = await mgr.createPhotoAsset(testFileName);
Z
zhang-daiyue 已提交
1882 1883 1884
  fileAsset.open('rw', (err, fd) => {
    if (fd != undefined) {
      console.info('File fd' + fd);
H
huweiqi 已提交
1885
      fileAsset.close(fd);
Z
zhang-daiyue 已提交
1886
    } else {
H
huweiqi 已提交
1887
      console.error('File err' + err);
Z
zhang-daiyue 已提交
1888 1889
    }
  });
Y
yangbo 已提交
1890 1891 1892 1893 1894 1895 1896 1897 1898
}
```

### open

open(mode: string): Promise&lt;number&gt;

打开当前文件,使用promise方式返回异步结果。

H
huweiqi 已提交
1899
**注意**:当前写操作是互斥的操作,写操作完成后需要调用close进行释放。
Y
yangbo 已提交
1900

H
huweiqi 已提交
1901
**需要权限**:ohos.permission.READ_IMAGEVIDEO 或 ohos.permission.READ_AUDIO 或 ohos.permission.WRITE_IMAGEVIDEO 或 ohos.permission.WRITE_AUDIO
Y
yangbo 已提交
1902 1903 1904 1905 1906 1907 1908

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

**参数:**

| 参数名  | 类型     | 必填   | 说明                                  |
| ---- | ------ | ---- | ----------------------------------- |
H
huweiqi 已提交
1909
| mode | string | 是    | 打开文件方式,如:'r'(只读), 'w'(只写), 'rw'(读写)。 |
Y
yangbo 已提交
1910 1911 1912 1913 1914

**返回值:**

| 类型                    | 说明            |
| --------------------- | ------------- |
H
huweiqi 已提交
1915
| Promise&lt;number&gt; | Promise对象,返回文件描述符。 |
Y
yangbo 已提交
1916 1917 1918

**示例:**

Z
zhang-daiyue 已提交
1919
```ts
Y
yangbo 已提交
1920
async function example() {
H
huweiqi 已提交
1921
  console.info('openDemo');
Z
zhang-daiyue 已提交
1922
  try {
H
huweiqi 已提交
1923
    let testFileName = 'testFile' + Date.now() + '.jpg';
H
huweiqi 已提交
1924
    const fileAsset = await mgr.createPhotoAsset(testFileName);
H
huweiqi 已提交
1925
    let fd = await fileAsset.open('rw');
Z
zhang-daiyue 已提交
1926 1927
    if (fd != undefined) {
      console.info('File fd' + fd);
H
huweiqi 已提交
1928
      fileAsset.close(fd);
Z
zhang-daiyue 已提交
1929
    } else {
H
huweiqi 已提交
1930
      console.error(' open File fail');
Z
zhang-daiyue 已提交
1931 1932
    }
  } catch (err) {
H
huweiqi 已提交
1933
    console.error('open Demo err' + err);
Z
zhang-daiyue 已提交
1934
  }
Y
yangbo 已提交
1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949
}
```

### close

close(fd: number, callback: AsyncCallback&lt;void&gt;): void

关闭当前文件,使用callback方式返回异步结果。

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

**参数:**

| 参数名      | 类型                        | 必填   | 说明    |
| -------- | ------------------------- | ---- | ----- |
H
huweiqi 已提交
1950 1951
| fd       | number                    | 是    | 文件描述符。 |
| callback | AsyncCallback&lt;void&gt; | 是    | callback返回void。 |
Y
yangbo 已提交
1952 1953 1954

**示例:**

Z
zhang-daiyue 已提交
1955
```ts
H
huweiqi 已提交
1956 1957
import dataSharePredicates from '@ohos.data.dataSharePredicates';

Y
yangbo 已提交
1958
async function example() {
H
huweiqi 已提交
1959
  console.info('closeDemo');
Z
zhang-daiyue 已提交
1960 1961 1962 1963 1964
  try {
    let predicates = new dataSharePredicates.DataSharePredicates();
    let fetchOption = {
      fetchColumns: [],
      predicates: predicates
Y
yangbo 已提交
1965
    };
Z
zhang-daiyue 已提交
1966 1967 1968 1969 1970 1971 1972 1973
    let fetchResult = await mgr.getPhotoAssets(fetchOption);
    const fileAsset = await fetchResult.getFirstObject();
    let fd = await fileAsset.open('rw');
    console.info('file fd', fd);
    fileAsset.close(fd, (err) => {
      if (err == undefined) {
        console.info('asset close succeed.');
      } else {
H
huweiqi 已提交
1974
        console.error('close failed, message = ' + err);
Z
zhang-daiyue 已提交
1975
      }
Y
yangbo 已提交
1976
    });
Z
zhang-daiyue 已提交
1977
  } catch (err) {
H
huweiqi 已提交
1978
    console.error('close failed, message = ' + err);
Z
zhang-daiyue 已提交
1979
  }
Y
yangbo 已提交
1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994
}
```

### close

close(fd: number): Promise&lt;void&gt;

关闭当前文件,使用promise方式返回异步结果。

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

**参数:**

| 参数名  | 类型     | 必填   | 说明    |
| ---- | ------ | ---- | ----- |
H
huweiqi 已提交
1995
| fd   | number | 是    | 文件描述符。 |
Y
yangbo 已提交
1996 1997 1998 1999 2000

**返回值:**

| 类型                  | 说明         |
| ------------------- | ---------- |
H
huweiqi 已提交
2001
| Promise&lt;void&gt; | Promise对象,返回void。 |
Y
yangbo 已提交
2002 2003 2004

**示例:**

Z
zhang-daiyue 已提交
2005
```ts
H
huweiqi 已提交
2006 2007
import dataSharePredicates from '@ohos.data.dataSharePredicates';

Y
yangbo 已提交
2008
async function example() {
H
huweiqi 已提交
2009
  console.info('closeDemo');
Z
zhang-daiyue 已提交
2010 2011 2012 2013 2014
  try {
    let predicates = new dataSharePredicates.DataSharePredicates();
    let fetchOption = {
      fetchColumns: [],
      predicates: predicates
Y
yangbo 已提交
2015
    };
Z
zhang-daiyue 已提交
2016 2017 2018 2019
    let fetchResult = await mgr.getPhotoAssets(fetchOption);
    const asset = await fetchResult.getFirstObject();
    let fd = await asset.open('rw');
    console.info('file fd', fd);
H
huweiqi 已提交
2020
    await asset.close(fd);
Z
zhang-daiyue 已提交
2021 2022
    console.info('asset close succeed.');
  } catch (err) {
H
huweiqi 已提交
2023
    console.error('close failed, message = ' + err);
Z
zhang-daiyue 已提交
2024
  }
Y
yangbo 已提交
2025 2026 2027 2028 2029 2030 2031 2032 2033
}
```

### getThumbnail

getThumbnail(callback: AsyncCallback&lt;image.PixelMap&gt;): void

获取文件的缩略图,使用callback方式返回异步结果。

Z
zhang-daiyue 已提交
2034
**需要权限**:ohos.permission.READ_IMAGEVIDEO 或 ohos.permission.READ_AUDIO
Y
yangbo 已提交
2035 2036 2037 2038 2039 2040 2041

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

**参数:**

| 参数名      | 类型                                  | 必填   | 说明               |
| -------- | ----------------------------------- | ---- | ---------------- |
H
huweiqi 已提交
2042
| callback | AsyncCallback&lt;[image.PixelMap](js-apis-image.md#pixelmap7)&gt; | 是    | callback返回缩略图的PixelMap。 |
Y
yangbo 已提交
2043 2044 2045

**示例:**

Z
zhang-daiyue 已提交
2046
```ts
H
huweiqi 已提交
2047 2048
import dataSharePredicates from '@ohos.data.dataSharePredicates';

Y
yangbo 已提交
2049
async function example() {
H
huweiqi 已提交
2050
  console.info('getThumbnailDemo');
Z
zhang-daiyue 已提交
2051 2052 2053 2054 2055 2056 2057
  let predicates = new dataSharePredicates.DataSharePredicates();
  let fetchOption = {
    fetchColumns: [],
    predicates: predicates
  };
  let fetchResult = await mgr.getPhotoAssets(fetchOption);
  const asset = await fetchResult.getFirstObject();
H
huweiqi 已提交
2058
  console.info('asset displayName = ', asset.displayName);
Z
zhang-daiyue 已提交
2059 2060 2061 2062
  asset.getThumbnail((err, pixelMap) => {
    if (err == undefined) {
      console.info('getThumbnail successful ' + pixelMap);
    } else {
H
huweiqi 已提交
2063
      console.error('getThumbnail fail', err);
Z
zhang-daiyue 已提交
2064 2065
    }
  });
Y
yangbo 已提交
2066 2067 2068 2069 2070
}
```

### getThumbnail

H
huweiqi 已提交
2071
getThumbnail(size: image.Size, callback: AsyncCallback&lt;image.PixelMap&gt;): void
Y
yangbo 已提交
2072 2073 2074

获取文件的缩略图,传入缩略图尺寸,使用callback方式返回异步结果。

Z
zhang-daiyue 已提交
2075
**需要权限**:ohos.permission.READ_IMAGEVIDEO 或 ohos.permission.READ_AUDIO
Y
yangbo 已提交
2076 2077 2078 2079 2080 2081 2082

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

**参数:**

| 参数名      | 类型                                  | 必填   | 说明               |
| -------- | ----------------------------------- | ---- | ---------------- |
H
huweiqi 已提交
2083 2084
| size     | [image.Size](js-apis-image.md#size) | 是    | 缩略图尺寸。            |
| callback | AsyncCallback&lt;[image.PixelMap](js-apis-image.md#pixelmap7)&gt; | 是    | callback返回缩略图的PixelMap。 |
Y
yangbo 已提交
2085 2086 2087

**示例:**

Z
zhang-daiyue 已提交
2088
```ts
H
huweiqi 已提交
2089 2090
import dataSharePredicates from '@ohos.data.dataSharePredicates';

Y
yangbo 已提交
2091
async function example() {
H
huweiqi 已提交
2092
  console.info('getThumbnailDemo');
Z
zhang-daiyue 已提交
2093 2094 2095 2096 2097 2098 2099 2100
  let predicates = new dataSharePredicates.DataSharePredicates();
  let fetchOption = {
    fetchColumns: [],
    predicates: predicates
  };
  let size = { width: 720, height: 720 };
  let fetchResult = await mgr.getPhotoAssets(fetchOption);
  const asset = await fetchResult.getFirstObject();
H
huweiqi 已提交
2101
  console.info('asset displayName = ', asset.displayName);
Z
zhang-daiyue 已提交
2102 2103 2104 2105
  asset.getThumbnail(size, (err, pixelMap) => {
    if (err == undefined) {
      console.info('getThumbnail successful ' + pixelMap);
    } else {
H
huweiqi 已提交
2106
      console.error('getThumbnail fail', err);
Y
yangbo 已提交
2107
    }
Z
zhang-daiyue 已提交
2108
  });
Y
yangbo 已提交
2109 2110 2111
}
```

Z
zhang-daiyue 已提交
2112
### getThumbnail
Y
yangbo 已提交
2113

H
huweiqi 已提交
2114
getThumbnail(size?: image.Size): Promise&lt;image.PixelMap&gt;
Y
yangbo 已提交
2115

Z
zhang-daiyue 已提交
2116
获取文件的缩略图,传入缩略图尺寸,使用promise方式返回异步结果。
Y
yangbo 已提交
2117

Z
zhang-daiyue 已提交
2118
**需要权限**:ohos.permission.READ_IMAGEVIDEO 或 ohos.permission.READ_AUDIO
Y
yangbo 已提交
2119 2120 2121 2122 2123

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

**参数:**

Z
zhang-daiyue 已提交
2124 2125
| 参数名  | 类型             | 必填   | 说明    |
| ---- | -------------- | ---- | ----- |
H
huweiqi 已提交
2126
| size | [image.Size](js-apis-image.md#size) | 否    | 缩略图尺寸。 |
Y
yangbo 已提交
2127 2128 2129

**返回值:**

Z
zhang-daiyue 已提交
2130 2131
| 类型                            | 说明                    |
| ----------------------------- | --------------------- |
H
huweiqi 已提交
2132
| Promise&lt;[image.PixelMap](js-apis-image.md#pixelmap7)&gt; | Promise对象,返回缩略图的PixelMap。 |
Y
yangbo 已提交
2133 2134 2135

**示例:**

Z
zhang-daiyue 已提交
2136
```ts
H
huweiqi 已提交
2137 2138
import dataSharePredicates from '@ohos.data.dataSharePredicates';

Y
yangbo 已提交
2139
async function example() {
H
huweiqi 已提交
2140
  console.info('getThumbnailDemo');
Z
zhang-daiyue 已提交
2141 2142 2143 2144 2145 2146 2147 2148
  let predicates = new dataSharePredicates.DataSharePredicates();
  let fetchOption = {
    fetchColumns: [],
    predicates: predicates
  };
  let size = { width: 720, height: 720 };
  let fetchResult = await mgr.getPhotoAssets(fetchOption);
  const asset = await fetchResult.getFirstObject();
H
huweiqi 已提交
2149
  console.info('asset displayName = ', asset.displayName);
Z
zhang-daiyue 已提交
2150 2151 2152
  asset.getThumbnail(size).then((pixelMap) => {
    console.info('getThumbnail successful ' + pixelMap);
  }).catch((err) => {
H
huweiqi 已提交
2153
    console.error('getThumbnail fail' + err);
Z
zhang-daiyue 已提交
2154
  });
Y
yangbo 已提交
2155 2156 2157
}
```

Z
zhang-daiyue 已提交
2158 2159 2160
### favorite

favorite(isFavorite: boolean, callback: AsyncCallback&lt;void&gt;): void
Y
yangbo 已提交
2161

Z
zhang-daiyue 已提交
2162
将文件设置为收藏文件,使用callback方式返回异步结果。
Y
yangbo 已提交
2163

Z
zhang-daiyue 已提交
2164
**需要权限**:ohos.permission.WRITE_IMAGEVIDEO 或 ohos.permission.WRITE_AUDIO
Y
yangbo 已提交
2165 2166 2167 2168 2169

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

**参数:**

Z
zhang-daiyue 已提交
2170 2171
| 参数名        | 类型                        | 必填   | 说明                                 |
| ---------- | ------------------------- | ---- | ---------------------------------- |
H
huweiqi 已提交
2172 2173
| isFavorite | boolean                   | 是    | 是否设置为收藏文件, true:设置为收藏文件,false:取消收藏。 |
| callback   | AsyncCallback&lt;void&gt; | 是    | callback返回void。                              |
Y
yangbo 已提交
2174 2175 2176

**示例:**

Z
zhang-daiyue 已提交
2177
```ts
H
huweiqi 已提交
2178 2179
import dataSharePredicates from '@ohos.data.dataSharePredicates';

Y
yangbo 已提交
2180
async function example() {
H
huweiqi 已提交
2181
  console.info('favoriteDemo');
Z
zhang-daiyue 已提交
2182 2183 2184 2185 2186 2187 2188 2189 2190
  let predicates = new dataSharePredicates.DataSharePredicates();
  let fetchOption = {
    fetchColumns: [],
    predicates: predicates
  };
  let fetchResult = await mgr.getPhotoAssets(fetchOption);
  const asset = await fetchResult.getFirstObject();
  asset.favorite(true, (err) => {
    if (err == undefined) {
H
huweiqi 已提交
2191
      console.info('favorite successfully');
Z
zhang-daiyue 已提交
2192
    } else {
H
huweiqi 已提交
2193
      console.error('favorite failed with error:' + err);
Z
zhang-daiyue 已提交
2194 2195
    }
  });
Y
yangbo 已提交
2196 2197 2198
}
```

Z
zhang-daiyue 已提交
2199 2200 2201
### favorite

favorite(isFavorite: boolean): Promise&lt;void&gt;
Y
yangbo 已提交
2202

Z
zhang-daiyue 已提交
2203
将文件设置为收藏文件,使用promise方式返回异步结果。
Y
yangbo 已提交
2204

Z
zhang-daiyue 已提交
2205
**需要权限**:ohos.permission.WRITE_IMAGEVIDEO 或 ohos.permission.WRITE_AUDIO
Y
yangbo 已提交
2206 2207 2208

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

Z
zhang-daiyue 已提交
2209 2210 2211 2212
**参数:**

| 参数名        | 类型      | 必填   | 说明                                 |
| ---------- | ------- | ---- | ---------------------------------- |
H
huweiqi 已提交
2213
| isFavorite | boolean | 是    | 是否设置为收藏文件, true:设置为收藏文件,false:取消收藏。 |
Z
zhang-daiyue 已提交
2214

Y
yangbo 已提交
2215 2216
**返回值:**

Z
zhang-daiyue 已提交
2217 2218
| 类型                  | 说明         |
| ------------------- | ---------- |
H
huweiqi 已提交
2219
| Promise&lt;void&gt; | Promise对象,返回void。 |
Y
yangbo 已提交
2220 2221 2222

**示例:**

Z
zhang-daiyue 已提交
2223
```ts
H
huweiqi 已提交
2224 2225
import dataSharePredicates from '@ohos.data.dataSharePredicates';

Y
yangbo 已提交
2226
async function example() {
H
huweiqi 已提交
2227
  console.info('favoriteDemo');
Z
zhang-daiyue 已提交
2228 2229 2230 2231 2232 2233 2234 2235
  let predicates = new dataSharePredicates.DataSharePredicates();
  let fetchOption = {
    fetchColumns: [],
    predicates: predicates
  };
  let fetchResult = await mgr.getPhotoAssets(fetchOption);
  const asset = await fetchResult.getFirstObject();
  asset.favorite(true).then(function () {
H
huweiqi 已提交
2236
    console.info('favorite successfully');
Z
zhang-daiyue 已提交
2237
  }).catch(function (err) {
H
huweiqi 已提交
2238
    console.error('favorite failed with error:' + err);
Z
zhang-daiyue 已提交
2239
  });
Y
yangbo 已提交
2240 2241 2242
}
```

H
huweiqi 已提交
2243
### setHidden<sup>10+</sup>
Y
yangbo 已提交
2244

H
huweiqi 已提交
2245
setHidden(hiddenState: boolean, callback: AsyncCallback&lt;void&gt;): void
Y
yangbo 已提交
2246

H
huweiqi 已提交
2247
将文件设置为隐私文件,使用callback方式返回异步结果。
Y
yangbo 已提交
2248

H
huweiqi 已提交
2249
隐私文件存在隐私相册中,对三方应用不开放,用户通过隐私相册去获取隐私文件后可以通过设置hiddenState为false来从隐私相册中移除。
Y
yangbo 已提交
2250

H
huweiqi 已提交
2251
**需要权限**:ohos.permission.WRITE_IMAGEVIDEO
Y
yangbo 已提交
2252 2253 2254

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

H
huweiqi 已提交
2255 2256 2257 2258 2259 2260 2261
**参数:**

| 参数名        | 类型                        | 必填   | 说明                                 |
| ---------- | ------------------------- | ---- | ---------------------------------- |
| hiddenState | boolean                   | 是    | 是否设置为隐藏文件,true:将文件资产放入隐藏相册;false:从隐藏相册中恢复。 |
| callback   | AsyncCallback&lt;void&gt; | 是    | callback返回void。                              |

H
huweiqi 已提交
2262 2263 2264 2265 2266 2267 2268 2269 2270
**错误码:**

接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)[通用错误码](../errorcodes/errorcode-universal.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202   | Called by non-system application.                |
| 13900020   | if parameter is invalid.         |

H
huweiqi 已提交
2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318
**示例:**

```ts
import dataSharePredicates from '@ohos.data.dataSharePredicates';

async function example() {
  console.info('setHiddenDemo');
  let predicates = new dataSharePredicates.DataSharePredicates();
  let fetchOption = {
    fetchColumns: [],
    predicates: predicates
  };
  let fetchResult = await mgr.getPhotoAssets(fetchOption);
  const asset = await fetchResult.getFirstObject();
  asset.setHidden(true, (err) => {
    if (err == undefined) {
      console.info('setHidden successfully');
    } else {
      console.error('setHidden failed with error:' + err);
    }
  });
}
```

### setHidden<sup>10+</sup>

setHidden(hiddenState: boolean): Promise&lt;void&gt;

将文件设置为隐私文件,使用promise方式返回异步结果。

隐私文件存在隐私相册中,对三方应用不开放,用户通过隐私相册去获取隐私文件后可以通过设置hiddenState为false来从隐私相册中移除。

**需要权限**:ohos.permission.WRITE_IMAGEVIDEO

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

**参数:**

| 参数名        | 类型      | 必填   | 说明                                 |
| ---------- | ------- | ---- | ---------------------------------- |
| hiddenState | boolean | 是    | 是否设置为隐藏文件,true:将文件资产放入隐藏相册;false:从隐藏相册中恢复。 |

**返回值:**

| 类型                  | 说明         |
| ------------------- | ---------- |
| Promise&lt;void&gt; | Promise对象,返回void。 |

H
huweiqi 已提交
2319 2320 2321 2322 2323 2324 2325 2326 2327
**错误码:**

接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)[通用错误码](../errorcodes/errorcode-universal.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202   | Called by non-system application.                |
| 13900020   | if parameter is invalid.         |

H
huweiqi 已提交
2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348
**示例:**

```ts
import dataSharePredicates from '@ohos.data.dataSharePredicates';

async function example() {
  // 示例代码为将文件从隐藏相册中恢复,需要先在隐藏相册预置资源
  console.info('setHiddenDemo');
  let predicates = new dataSharePredicates.DataSharePredicates();
  let fetchOption = {
    fetchColumns: [],
    predicates: predicates
  };
  let albumList = await mgr.getAlbums(userFileManager.AlbumType.SYSTEM, userFileManager.AlbumSubType.HIDDEN);
  const album = await albumList.getFirstObject();
  let fetchResult = await album.getPhotoAssets(fetchOption);
  const asset = await fetchResult.getFirstObject();
  asset.setHidden(false).then(() => {
    console.info('setHidden successfully');
  }).catch((err) => {
    console.error('setHidden failed with error:' + err);
Z
zhang-daiyue 已提交
2349
  });
Y
yangbo 已提交
2350 2351 2352
}
```

Z
zhang-daiyue 已提交
2353
## FetchResult
Y
yangbo 已提交
2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364

文件检索结果集。

### getCount

getCount(): number

获取文件检索结果中的文件总数。

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

Z
zengyawen 已提交
2365
**返回值:**
Y
yangbo 已提交
2366 2367 2368

| 类型     | 说明       |
| ------ | -------- |
H
huweiqi 已提交
2369
| number | 检索到的文件总数。 |
Y
yangbo 已提交
2370

H
huweiqi 已提交
2371
**示例:**
Y
yangbo 已提交
2372

Z
zhang-daiyue 已提交
2373
```ts
H
huweiqi 已提交
2374 2375
import dataSharePredicates from '@ohos.data.dataSharePredicates';

Y
yangbo 已提交
2376
async function example() {
H
huweiqi 已提交
2377
  console.info('getCountDemo');
Z
zhang-daiyue 已提交
2378 2379 2380 2381 2382 2383 2384
  let predicates = new dataSharePredicates.DataSharePredicates();
  let fetchOption = {
    fetchColumns: [],
    predicates: predicates
  };
  let fetchResult = await mgr.getPhotoAssets(fetchOption);
  const fetchCount = fetchResult.getCount();
H
huweiqi 已提交
2385
  console.info('fetchCount = ', fetchCount);
Y
yangbo 已提交
2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396
}
```

### isAfterLast

isAfterLast(): boolean

检查结果集是否指向最后一行。

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

Z
zengyawen 已提交
2397
**返回值:**
Y
yangbo 已提交
2398 2399 2400 2401 2402

| 类型      | 说明                                 |
| ------- | ---------------------------------- |
| boolean | 当读到最后一条记录后,后续没有记录返回true,否则返回false。 |

H
huweiqi 已提交
2403
**示例:**
Y
yangbo 已提交
2404

Z
zhang-daiyue 已提交
2405
```ts
H
huweiqi 已提交
2406 2407
import dataSharePredicates from '@ohos.data.dataSharePredicates';

Y
yangbo 已提交
2408
async function example() {
Z
zhang-daiyue 已提交
2409 2410 2411 2412 2413 2414 2415 2416 2417
  let predicates = new dataSharePredicates.DataSharePredicates();
  let fetchOption = {
    fetchColumns: [],
    predicates: predicates
  };
  let fetchResult = await mgr.getPhotoAssets(fetchOption);
  const fetchCount = fetchResult.getCount();
  console.info('count:' + fetchCount);
  let fileAsset = await fetchResult.getLastObject();
H
huweiqi 已提交
2418
  if (fetchResult.isAfterLast()) {
Z
zhang-daiyue 已提交
2419 2420 2421 2422
    console.info('fileAsset isAfterLast displayName = ', fileAsset.displayName);
  } else {
    console.info('fileAsset  not isAfterLast ');
  }
Y
yangbo 已提交
2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433
}
```

### close

close(): void

释放 FetchFileResult 实例并使其失效。无法调用其他方法。

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

H
huweiqi 已提交
2434
**示例:**
Y
yangbo 已提交
2435

Z
zhang-daiyue 已提交
2436
```ts
H
huweiqi 已提交
2437 2438
import dataSharePredicates from '@ohos.data.dataSharePredicates';

Y
yangbo 已提交
2439
async function example() {
H
huweiqi 已提交
2440
  console.info('fetchResultCloseDemo');
Z
zhang-daiyue 已提交
2441 2442 2443 2444 2445
  let predicates = new dataSharePredicates.DataSharePredicates();
  let fetchOption = {
    fetchColumns: [],
    predicates: predicates
  };
H
huweiqi 已提交
2446 2447 2448 2449 2450
  try {
    let fetchResult = await mgr.getPhotoAssets(fetchOption);
    await fetchResult.close();
    console.info('close succeed.');
  } catch (err) {
H
huweiqi 已提交
2451
    console.error('close fail. message = ' + err);
H
huweiqi 已提交
2452
  }
Y
yangbo 已提交
2453 2454 2455 2456 2457
}
```

### getFirstObject

Z
zhang-daiyue 已提交
2458
getFirstObject(callback: AsyncCallback&lt;T&gt;): void
Y
yangbo 已提交
2459

Z
zhang-daiyue 已提交
2460
获取文件检索结果中的第一个文件资产。此方法使用callback形式返回结果。
Y
yangbo 已提交
2461 2462 2463

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

H
huweiqi 已提交
2464
**参数:**
Y
yangbo 已提交
2465 2466 2467

| 参数名   | 类型                                          | 必填 | 说明                                        |
| -------- | --------------------------------------------- | ---- | ------------------------------------------- |
H
huweiqi 已提交
2468
| callback | AsyncCallback&lt;T&gt; | 是   | 异步获取结果集中的第一个完成后的回调。 |
Y
yangbo 已提交
2469

H
huweiqi 已提交
2470
**示例:**
Y
yangbo 已提交
2471

Z
zhang-daiyue 已提交
2472
```ts
H
huweiqi 已提交
2473 2474
import dataSharePredicates from '@ohos.data.dataSharePredicates';

Y
yangbo 已提交
2475
async function example() {
H
huweiqi 已提交
2476
  console.info('getFirstObjectDemo');
Z
zhang-daiyue 已提交
2477 2478 2479 2480 2481 2482 2483 2484
  let predicates = new dataSharePredicates.DataSharePredicates();
  let fetchOption = {
    fetchColumns: [],
    predicates: predicates
  };
  let fetchResult = await mgr.getPhotoAssets(fetchOption);
  fetchResult.getFirstObject((err, fileAsset) => {
    if (fileAsset != undefined) {
H
huweiqi 已提交
2485
      console.info('fileAsset displayName: ', fileAsset.displayName);
Z
zhang-daiyue 已提交
2486
    } else {
H
huweiqi 已提交
2487
      console.error('fileAsset failed with err:' + err);
Z
zhang-daiyue 已提交
2488 2489
    }
  });
Y
yangbo 已提交
2490 2491 2492 2493 2494
}
```

### getFirstObject

Z
zhang-daiyue 已提交
2495
getFirstObject(): Promise&lt;T&gt;
Y
yangbo 已提交
2496

Z
zhang-daiyue 已提交
2497
获取文件检索结果中的第一个文件资产。此方法使用promise方式来异步返回。
Y
yangbo 已提交
2498 2499 2500

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

Z
zengyawen 已提交
2501
**返回值:**
Y
yangbo 已提交
2502 2503 2504

| 类型                                    | 说明                       |
| --------------------------------------- | -------------------------- |
H
huweiqi 已提交
2505
| Promise&lt;T&gt; | Promise对象,返回结果集中第一个对象。 |
Y
yangbo 已提交
2506

H
huweiqi 已提交
2507
**示例:**
Y
yangbo 已提交
2508

Z
zhang-daiyue 已提交
2509
```ts
H
huweiqi 已提交
2510 2511
import dataSharePredicates from '@ohos.data.dataSharePredicates';

Y
yangbo 已提交
2512
async function example() {
H
huweiqi 已提交
2513
  console.info('getFirstObjectDemo');
Z
zhang-daiyue 已提交
2514 2515 2516 2517 2518 2519 2520
  let predicates = new dataSharePredicates.DataSharePredicates();
  let fetchOption = {
    fetchColumns: [],
    predicates: predicates
  };
  let fetchResult = await mgr.getPhotoAssets(fetchOption);
  let fileAsset = await fetchResult.getFirstObject();
H
huweiqi 已提交
2521
  console.info('fileAsset displayName: ', fileAsset.displayName);
Y
yangbo 已提交
2522 2523 2524 2525 2526
}
```

### getNextObject

Z
zhang-daiyue 已提交
2527
 getNextObject(callback: AsyncCallback&lt;T&gt;): void
Y
yangbo 已提交
2528 2529 2530 2531 2532

获取文件检索结果中的下一个文件资产。此方法使用callback形式返回结果。

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

H
huweiqi 已提交
2533
**参数:**
Y
yangbo 已提交
2534 2535 2536

| 参数名    | 类型                                          | 必填 | 说明                                      |
| --------- | --------------------------------------------- | ---- | ----------------------------------------- |
H
huweiqi 已提交
2537
| callbacke | AsyncCallback&lt;T&gt; | 是   | 异步返回结果集中下一个之后的回调。 |
Y
yangbo 已提交
2538

H
huweiqi 已提交
2539
**示例:**
Y
yangbo 已提交
2540

Z
zhang-daiyue 已提交
2541
```ts
H
huweiqi 已提交
2542 2543
import dataSharePredicates from '@ohos.data.dataSharePredicates';

Y
yangbo 已提交
2544
async function example() {
H
huweiqi 已提交
2545
  console.info('getNextObjectDemo');
Z
zhang-daiyue 已提交
2546 2547 2548 2549 2550 2551 2552 2553 2554 2555
  let predicates = new dataSharePredicates.DataSharePredicates();
  let fetchOption = {
    fetchColumns: [],
    predicates: predicates
  };
  let fetchResult = await mgr.getPhotoAssets(fetchOption);
  await fetchResult.getFirstObject();
  if (fetchResult.isAfterLast()) {
    fetchResult.getNextObject((err, fileAsset) => {
      if (fileAsset != undefined) {
H
huweiqi 已提交
2556
        console.info('fileAsset displayName: ', fileAsset.displayName);
Z
zhang-daiyue 已提交
2557
      } else {
H
huweiqi 已提交
2558
        console.error('fileAsset failed with err: ' + err);
Z
zhang-daiyue 已提交
2559 2560 2561
      }
    });
  }
Y
yangbo 已提交
2562 2563 2564 2565 2566
}
```

### getNextObject

Z
zhang-daiyue 已提交
2567
 getNextObject(): Promise&lt;T&gt;
Y
yangbo 已提交
2568

Z
zhang-daiyue 已提交
2569
获取文件检索结果中的下一个文件资产。此方法使用promise方式来异步返回。
Y
yangbo 已提交
2570 2571 2572

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

Z
zengyawen 已提交
2573
**返回值:**
Y
yangbo 已提交
2574 2575 2576

| 类型                                    | 说明              |
| --------------------------------------- | ----------------- |
H
huweiqi 已提交
2577
| Promise&lt;T&gt; | Promise对象,返回结果集中下一个对象。 |
Y
yangbo 已提交
2578

H
huweiqi 已提交
2579
**示例:**
Y
yangbo 已提交
2580

Z
zhang-daiyue 已提交
2581
```ts
H
huweiqi 已提交
2582 2583
import dataSharePredicates from '@ohos.data.dataSharePredicates';

Y
yangbo 已提交
2584
async function example() {
H
huweiqi 已提交
2585
  console.info('getNextObjectDemo');
Z
zhang-daiyue 已提交
2586 2587 2588 2589 2590 2591 2592 2593 2594
  let predicates = new dataSharePredicates.DataSharePredicates();
  let fetchOption = {
    fetchColumns: [],
    predicates: predicates
  };
  let fetchResult = await mgr.getPhotoAssets(fetchOption);
  await fetchResult.getFirstObject();
  if (fetchResult.isAfterLast()) {
    let fileAsset = await fetchResult.getNextObject();
H
huweiqi 已提交
2595
    console.info('fileAsset displayName: ', fileAsset.displayName);
Z
zhang-daiyue 已提交
2596
  }
Y
yangbo 已提交
2597 2598 2599 2600 2601
}
```

### getLastObject

Z
zhang-daiyue 已提交
2602
getLastObject(callback: AsyncCallback&lt;T&gt;): void
Y
yangbo 已提交
2603

Z
zhang-daiyue 已提交
2604
获取文件检索结果中的最后一个文件资产。此方法使用callback回调来返回。
Y
yangbo 已提交
2605 2606 2607

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

H
huweiqi 已提交
2608
**参数:**
Y
yangbo 已提交
2609 2610 2611

| 参数名   | 类型                                          | 必填 | 说明                        |
| -------- | --------------------------------------------- | ---- | --------------------------- |
H
huweiqi 已提交
2612
| callback | AsyncCallback&lt;T&gt; | 是   | 异步返回结果集中最后一个的回调。 |
Y
yangbo 已提交
2613

H
huweiqi 已提交
2614
**示例:**
Y
yangbo 已提交
2615

Z
zhang-daiyue 已提交
2616
```ts
H
huweiqi 已提交
2617 2618
import dataSharePredicates from '@ohos.data.dataSharePredicates';

Y
yangbo 已提交
2619
async function example() {
H
huweiqi 已提交
2620
  console.info('getLastObjectDemo');
Z
zhang-daiyue 已提交
2621 2622 2623 2624 2625 2626 2627 2628
  let predicates = new dataSharePredicates.DataSharePredicates();
  let fetchOption = {
    fetchColumns: [],
    predicates: predicates
  };
  let fetchResult = await mgr.getPhotoAssets(fetchOption);
  fetchResult.getLastObject((err, fileAsset) => {
    if (fileAsset != undefined) {
H
huweiqi 已提交
2629
      console.info('fileAsset displayName: ', fileAsset.displayName);
Z
zhang-daiyue 已提交
2630
    } else {
H
huweiqi 已提交
2631
      console.error('fileAsset failed with err: ' + err);
Z
zhang-daiyue 已提交
2632 2633
    }
  });
Y
yangbo 已提交
2634 2635 2636 2637 2638
}
```

### getLastObject

Z
zhang-daiyue 已提交
2639
getLastObject(): Promise&lt;T&gt;
Y
yangbo 已提交
2640

Z
zhang-daiyue 已提交
2641
获取文件检索结果中的最后一个文件资产。此方法使用Promise方式来返回。
Y
yangbo 已提交
2642 2643 2644

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

Z
zengyawen 已提交
2645
**返回值:**
Y
yangbo 已提交
2646 2647 2648

| 类型                                    | 说明              |
| --------------------------------------- | ----------------- |
H
huweiqi 已提交
2649
| Promise&lt;T&gt; | Promise对象,返回结果集中最后一个对象。 |
Y
yangbo 已提交
2650

H
huweiqi 已提交
2651
**示例:**
Y
yangbo 已提交
2652

Z
zhang-daiyue 已提交
2653
```ts
H
huweiqi 已提交
2654 2655
import dataSharePredicates from '@ohos.data.dataSharePredicates';

Y
yangbo 已提交
2656
async function example() {
H
huweiqi 已提交
2657
  console.info('getLastObjectDemo');
Z
zhang-daiyue 已提交
2658 2659 2660 2661 2662 2663 2664
  let predicates = new dataSharePredicates.DataSharePredicates();
  let fetchOption = {
    fetchColumns: [],
    predicates: predicates
  };
  let fetchResult = await mgr.getPhotoAssets(fetchOption);
  let fileAsset = await fetchResult.getLastObject();
H
huweiqi 已提交
2665
  console.info('fileAsset displayName: ', fileAsset.displayName);
Y
yangbo 已提交
2666 2667 2668 2669 2670
}
```

### getPositionObject

Z
zhang-daiyue 已提交
2671
getPositionObject(index: number, callback: AsyncCallback&lt;T&gt;): void
Y
yangbo 已提交
2672

Z
zhang-daiyue 已提交
2673
获取文件检索结果中具有指定索引的文件资产。此方法使用callback来返回。
Y
yangbo 已提交
2674 2675 2676

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

H
huweiqi 已提交
2677 2678 2679 2680 2681 2682 2683
**参数:**

| 参数名       | 类型                                       | 必填   | 说明                 |
| -------- | ---------------------------------------- | ---- | ------------------ |
| index    | number                                   | 是    | 要获取的文件的索引,从0开始。     |
| callback | AsyncCallback&lt;T&gt; | 是    | 异步返回指定索引的文件资产的回调。 |

H
huweiqi 已提交
2684 2685 2686 2687 2688 2689 2690 2691
**错误码:**

接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 13900020   | if type index is not number.         |

H
huweiqi 已提交
2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734
**示例:**

```ts
import dataSharePredicates from '@ohos.data.dataSharePredicates';

async function example() {
  console.info('getPositionObjectDemo');
  let predicates = new dataSharePredicates.DataSharePredicates();
  let fetchOption = {
    fetchColumns: [],
    predicates: predicates
  };
  let fetchResult = await mgr.getPhotoAssets(fetchOption);
  fetchResult.getPositionObject(0, (err, fileAsset) => {
    if (fileAsset != undefined) {
      console.info('fileAsset displayName: ', fileAsset.displayName);
    } else {
      console.error('fileAsset failed with err: ' + err);
    }
  });
}
```

### getPositionObject

getPositionObject(index: number): Promise&lt;T&gt;

获取文件检索结果中具有指定索引的文件资产。此方法使用Promise形式返回文件Asset。

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

**参数:**

| 参数名    | 类型     | 必填   | 说明             |
| ----- | ------ | ---- | -------------- |
| index | number | 是    | 要获取的文件的索引,从0开始。 |

**返回值:**

| 类型                                    | 说明              |
| --------------------------------------- | ----------------- |
| Promise&lt;T&gt; | Promise对象,返回结果集中指定索引的一个对象。 |

H
huweiqi 已提交
2735 2736 2737 2738 2739 2740 2741 2742
**错误码:**

接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 13900020   | if type index is not number.         |

H
huweiqi 已提交
2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839
**示例:**

```ts
import dataSharePredicates from '@ohos.data.dataSharePredicates';

async function example() {
  console.info('getPositionObjectDemo');
  let predicates = new dataSharePredicates.DataSharePredicates();
  let fetchOption = {
    fetchColumns: [],
    predicates: predicates
  };
  let fetchResult = await mgr.getPhotoAssets(fetchOption);
  let fileAsset = await fetchResult.getPositionObject(0);
  console.info('fileAsset displayName: ', fileAsset.displayName);
}
```

### getAllObject<sup>10+</sup>

getAllObject(callback: AsyncCallback&lt;Array&lt;T&gt;&gt;): void

获取文件检索结果中的所有文件资产。此方法使用callback形式返回结果。

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

**参数:**

| 参数名   | 类型                                          | 必填 | 说明                                        |
| -------- | --------------------------------------------- | ---- | ------------------------------------------- |
| callback | AsyncCallback&lt;Array&lt;T&gt;&gt; | 是   | 异步获取结果集中的所有文件资产完成后的回调。 |

**示例:**

```ts
import dataSharePredicates from '@ohos.data.dataSharePredicates';

async function example() {
  console.info('getAllObjectDemo');
  let predicates = new dataSharePredicates.DataSharePredicates();
  let fetchOption = {
    fetchColumns: [],
    predicates: predicates
  };
  let fetchResult = await mgr.getPhotoAssets(fetchOption);
  fetchResult.getAllObject((err, fileAssetList) => {
    if (fileAssetList != undefined) {
      console.info('fileAssetList length: ', fileAssetList.length);
    } else {
      console.error('fileAssetList failed with err:' + err);
    }
  });
}
```

### getAllObject<sup>10+</sup>

getAllObject(): Promise&lt;Array&lt;T&gt;&gt;

获取文件检索结果中的所有文件资产。此方法使用promise方式来异步返回。

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

**返回值:**

| 类型                                    | 说明                       |
| --------------------------------------- | -------------------------- |
| Promise&lt;Array&lt;T&gt;&gt; | Promise对象,返回结果集中所有文件资产数组。 |

**示例:**

```ts
import dataSharePredicates from '@ohos.data.dataSharePredicates';

async function example() {
  console.info('getAllObjectDemo');
  let predicates = new dataSharePredicates.DataSharePredicates();
  let fetchOption = {
    fetchColumns: [],
    predicates: predicates
  };
  let fetchResult = await mgr.getPhotoAssets(fetchOption);
  let fileAssetList = await fetchResult.getAllObject();
  console.info('fileAssetList length: ', fileAssetList.length);
}
```

## Album

实体相册

### 属性

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

| 名称           | 类型    | 可读   | 可写  | 说明   |
| ------------ | ------ | ---- | ---- | ------- |
H
huweiqi 已提交
2840 2841
| albumType<sup>10+</sup> | [AlbumType]( #albumtype10) | 是    | 否    | 相册类型。    |
| albumSubType<sup>10+</sup> | [AlbumSubType]( #albumsubtype10) | 是    | 否   | 相册子类型。    |
H
huweiqi 已提交
2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863
| albumName | string | 是    | 用户相册可写,预置相册不可写   | 相册名称。    |
| albumUri | string | 是    | 否    | 相册Uri。   |
| count | number | 是    | 否    |  相册中文件数量。 |
| coverUri | string | 是    | 用户相册可写,预置相册不可写	    | 封面文件Uri。 |

### getPhotoAssets

getPhotoAssets(options: FetchOptions, callback: AsyncCallback&lt;FetchResult&lt;FileAsset&gt;&gt;): void;

获取相册中的文件。该方法使用callback形式来返回文件。

**需要权限**:ohos.permission.READ_IMAGEVIDEO

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

**参数:**

| 参数名   | 类型                      | 必填 | 说明       |
| -------- | ------------------------- | ---- | ---------- |
| options | [FetchOptions](#fetchoptions) | 是   | 检索选项。 |
| callback | AsyncCallback&lt;[FetchResult](#fetchresult)&lt;[FileAsset](#fileasset)&gt;&gt; | 是   | callback返回图片和视频数据结果集。 |

H
huweiqi 已提交
2864 2865 2866 2867 2868 2869 2870 2871
**错误码:**

接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 13900020   | if type options is not FetchOptions.         |

H
huweiqi 已提交
2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921
**示例:**

```ts
import dataSharePredicates from '@ohos.data.dataSharePredicates';

async function example() {
  console.info('albumGetFileAssetsDemoCallback');

  let predicates = new dataSharePredicates.DataSharePredicates();
  let albumFetchOptions = {
    predicates: predicates
  };
  let fetchOption = {
    fetchColumns: [],
    predicates: predicates
  };
  const albumList = await mgr.getPhotoAlbums(albumFetchOptions);
  const album = await albumList.getFirstObject();
  album.getPhotoAssets(fetchOption, (err, albumFetchResult) => {
    if (albumFetchResult != undefined) {
      console.info('album getPhotoAssets successfully, getCount: ' + albumFetchResult.getCount());
    } else {
      console.error('album getPhotoAssets failed with error: ' + err);
    }
  });
}
```

### getPhotoAssets

getPhotoAssets(options: FetchOptions): Promise&lt;FetchResult&lt;FileAsset&gt;&gt;;

获取相册中的文件。该方法使用Promise来返回文件。

**需要权限**:ohos.permission.READ_IMAGEVIDEO

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

**参数:**

| 参数名   | 类型                      | 必填 | 说明       |
| -------- | ------------------------- | ---- | ---------- |
| options | [FetchOptions](#fetchoptions) | 是   | 检索选项。 |

**返回值:**

| 类型                                    | 说明              |
| --------------------------------------- | ----------------- |
| Promise&lt;[FetchResult](#fetchresult)&lt;[FileAsset](#fileasset)&gt;&gt; | Promise对象,返回图片和视频数据结果集。 |

H
huweiqi 已提交
2922 2923 2924 2925 2926 2927 2928 2929
**错误码:**

接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 13900020   | if type options is not FetchOptions.         |

H
huweiqi 已提交
2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054
**示例:**

```ts
import dataSharePredicates from '@ohos.data.dataSharePredicates';

async function example() {
  console.info('albumGetFileAssetsDemoPromise');

  let predicates = new dataSharePredicates.DataSharePredicates();
  let albumFetchOptions = {
    predicates: predicates
  };
  let fetchOption = {
    fetchColumns: [],
    predicates: predicates
  };
  const albumList = await mgr.getPhotoAlbums(albumFetchOptions);
  const album = await albumList.getFirstObject();
  album.getPhotoAssets(fetchOption).then((albumFetchResult) => {
    console.info('album getFileAssets successfully, getCount: ' + albumFetchResult.getCount());
  }).catch((err) => {
    console.error('album getFileAssets failed with error: ' + err);
  });
}
```

### commitModify

commitModify(callback: AsyncCallback&lt;void&gt;): void;

更新相册属性修改到数据库中。该方法使用callback形式来返回结果。

**需要权限**:ohos.permission.WRITE_IMAGEVIDEO

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

**参数:**

| 参数名   | 类型                      | 必填 | 说明       |
| -------- | ------------------------- | ---- | ---------- |
| callback | AsyncCallback&lt;void&gt; | 是   | callback返回void。 |

**示例:**

```ts
import dataSharePredicates from '@ohos.data.dataSharePredicates';

async function example() {
  console.info('albumCommitModifyDemo');
  let predicates = new dataSharePredicates.DataSharePredicates();
  let albumFetchOptions = {
    predicates: predicates
  };
  const albumList = await mgr.getPhotoAlbums(albumFetchOptions);
  const album = await albumList.getFirstObject();
  album.albumName = 'hello';
  album.commitModify((err) => {
    if (err != undefined) {
      console.error('commitModify failed with error: ' + err);
    } else {
      console.info('commitModify successfully');
    }
  });
}
```

### commitModify

commitModify(): Promise&lt;void&gt;;

更新相册属性修改到数据库中。该方法使用Promise来返回结果。

**需要权限**:ohos.permission.WRITE_IMAGEVIDEO

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

**返回值:**

| 类型                  | 说明           |
| ------------------- | ------------ |
| Promise&lt;void&gt; | Promise对象,返回void。 |

**示例:**

```ts
import dataSharePredicates from '@ohos.data.dataSharePredicates';

async function example() {
  console.info('albumCommitModifyDemo');
  let predicates = new dataSharePredicates.DataSharePredicates();
  let albumFetchOptions = {
    predicates: predicates
  };
  try {
    var albumList = await mgr.getPhotoAlbums(albumFetchOptions);
  } catch (err) {
    console.error('getPhotoAlbums failed. message = ', err);
  }
  const album = await albumList.getFirstObject();
  album.albumName = 'hello';
  album.commitModify().then(() => {
    console.info('commitModify successfully');
  }).catch((err) => {
    console.error('commitModify failed with error: ' + err);
  });
}
```

### addPhotoAssets<sup>10+</sup>

addPhotoAssets(assets: Array&lt;FileAsset&gt;, callback: AsyncCallback&lt;void&gt;): void;

往相册中添加图片或者视频,需要先预置相册和文件资源。该方法使用callback形式来返回结果。

**需要权限**:ohos.permission.WRITE_IMAGEVIDEO

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

**参数:**

| 参数名   | 类型                      | 必填 | 说明       |
| -------- | ------------------------- | ---- | ---------- |
| assets | Array&lt;[FileAsset](#fileasset)&gt; | 是   | 待添加到相册中的图片或视频数组。 |
| callback | AsyncCallback&lt;void&gt; | 是   | callback返回void。 |

H
huweiqi 已提交
3055 3056 3057 3058 3059 3060 3061 3062
**错误码:**

接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 13900020   | if PhotoAssets is invalid.         |

H
huweiqi 已提交
3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114
**示例:**

```ts
import dataSharePredicates from '@ohos.data.dataSharePredicates';

async function example() {
  try {
    console.info('addPhotoAssetsDemoCallback');
    let predicates = new dataSharePredicates.DataSharePredicates();
    let fetchOption = {
      fetchColumns: [],
      predicates: predicates
    };
    let albumFetchResult = await mgr.getAlbums(userFileManager.AlbumType.USER, userFileManager.AlbumSubType.USER_GENERIC);
    let album = await albumFetchResult.getFirstObject();
    let fetchResult = await mgr.getPhotoAssets(fetchOption);
    let asset = await fetchResult.getFirstObject();
    album.addPhotoAssets([asset], (err) => {
      if (err === undefined) {
        console.info('album addPhotoAssets successfully');
      } else {
        console.error('album addPhotoAssets failed with error: ' + err);
      }
    });
  } catch (err) {
    console.error('addPhotoAssetsDemoCallback failed with error: ' + err);
  }
}
```

### addPhotoAssets<sup>10+</sup>

addPhotoAssets(assets: Array&lt;FileAsset&gt;): Promise&lt;void&gt;;

往相册中添加图片或者视频,需要先预置相册和文件资源。该方法使用Promise来返回结果。

**需要权限**:ohos.permission.WRITE_IMAGEVIDEO

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

**参数:**

| 参数名   | 类型                      | 必填 | 说明       |
| -------- | ------------------------- | ---- | ---------- |
| assets | Array&lt;[FileAsset](#fileasset)&gt; | 是   | 待添加到相册中的图片或视频数组。 |

**返回值:**

| 类型                                    | 说明              |
| --------------------------------------- | ----------------- |
|Promise&lt;void&gt; | Promise对象,返回void。 |

H
huweiqi 已提交
3115 3116 3117 3118 3119 3120 3121 3122
**错误码:**

接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 13900020   | if PhotoAssets is invalid.         |

H
huweiqi 已提交
3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161
**示例:**

```ts
import dataSharePredicates from '@ohos.data.dataSharePredicates';

async function example() {
  try {
    console.info('addPhotoAssetsDemoPromise');
    let predicates = new dataSharePredicates.DataSharePredicates();
    let fetchOption = {
      fetchColumns: [],
      predicates: predicates
    };
    let albumFetchResult = await mgr.getAlbums(userFileManager.AlbumType.USER, userFileManager.AlbumSubType.USER_GENERIC);
    let album = await albumFetchResult.getFirstObject();
    let fetchResult = await mgr.getPhotoAssets(fetchOption);
    let asset = await fetchResult.getFirstObject();
    album.addPhotoAssets([asset]).then(() => {
      console.info('album addPhotoAssets successfully');
    }).catch((err) => {
      console.error('album addPhotoAssets failed with error: ' + err);
    });
  } catch (err) {
    console.error('addPhotoAssetsDemoPromise failed with error: ' + err);
  }
}
```

### removePhotoAssets<sup>10+</sup>

removePhotoAssets(assets: Array&lt;FileAsset&gt;, callback: AsyncCallback&lt;void&gt;): void;

从相册中移除图片或者视频,需要先预置相册和文件资源。该方法使用callback形式来返回结果。

**需要权限**:ohos.permission.WRITE_IMAGEVIDEO

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

**参数:**
Y
yangbo 已提交
3162

H
huweiqi 已提交
3163 3164 3165 3166
| 参数名   | 类型                      | 必填 | 说明       |
| -------- | ------------------------- | ---- | ---------- |
| assets | Array&lt;[FileAsset](#fileasset)&gt; | 是   | 相册中待移除的图片或视频数组。 |
| callback | AsyncCallback&lt;void&gt; | 是   | callback返回void。 |
Y
yangbo 已提交
3167

H
huweiqi 已提交
3168 3169 3170 3171 3172 3173 3174 3175
**错误码:**

接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 13900020   | if PhotoAssets is invalid.         |

H
huweiqi 已提交
3176
**示例:**
Y
yangbo 已提交
3177

Z
zhang-daiyue 已提交
3178
```ts
H
huweiqi 已提交
3179 3180
import dataSharePredicates from '@ohos.data.dataSharePredicates';

Y
yangbo 已提交
3181
async function example() {
H
huweiqi 已提交
3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202
  try {
    console.info('removePhotoAssetsDemoCallback');
    let predicates = new dataSharePredicates.DataSharePredicates();
    let fetchOption = {
      fetchColumns: [],
      predicates: predicates
    };
    let albumFetchResult = await mgr.getAlbums(userFileManager.AlbumType.USER, userFileManager.AlbumSubType.USER_GENERIC);
    let album = await albumFetchResult.getFirstObject();
    let fetchResult = await album.getPhotoAssets(fetchOption);
    let asset = await fetchResult.getFirstObject();
    album.removePhotoAssets([asset], (err) => {
      if (err === undefined) {
        console.info('album removePhotoAssets successfully');
      } else {
        console.error('album removePhotoAssets failed with error: ' + err);
      }
    });
  } catch (err) {
    console.error('removePhotoAssetsDemoCallback failed with error: ' + err);
  }
Y
yangbo 已提交
3203 3204 3205
}
```

H
huweiqi 已提交
3206
### removePhotoAssets<sup>10+</sup>
Y
yangbo 已提交
3207

H
huweiqi 已提交
3208
removePhotoAssets(assets: Array&lt;FileAsset&gt;): Promise&lt;void&gt;;
Y
yangbo 已提交
3209

H
huweiqi 已提交
3210 3211 3212
从相册中移除图片或者视频,需要先预置相册和文件资源。该方法使用Promise来返回结果。

**需要权限**:ohos.permission.WRITE_IMAGEVIDEO
Y
yangbo 已提交
3213 3214 3215

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

H
huweiqi 已提交
3216
**参数:**
Y
yangbo 已提交
3217

H
huweiqi 已提交
3218 3219 3220
| 参数名   | 类型                      | 必填 | 说明       |
| -------- | ------------------------- | ---- | ---------- |
| assets | Array&lt;[FileAsset](#fileasset)&gt; | 是   | 相册中待移除的图片或视频数组。 |
Y
yangbo 已提交
3221

Z
zengyawen 已提交
3222
**返回值:**
Y
yangbo 已提交
3223 3224 3225

| 类型                                    | 说明              |
| --------------------------------------- | ----------------- |
H
huweiqi 已提交
3226
|Promise&lt;void&gt; | Promise对象,返回void。 |
Y
yangbo 已提交
3227

H
huweiqi 已提交
3228 3229 3230 3231 3232 3233 3234 3235
**错误码:**

接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 13900020   | if PhotoAssets is invalid.         |

H
huweiqi 已提交
3236
**示例:**
Y
yangbo 已提交
3237

Z
zhang-daiyue 已提交
3238
```ts
H
huweiqi 已提交
3239 3240
import dataSharePredicates from '@ohos.data.dataSharePredicates';

Y
yangbo 已提交
3241
async function example() {
H
huweiqi 已提交
3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260
  try {
    console.info('removePhotoAssetsDemoPromise');
    let predicates = new dataSharePredicates.DataSharePredicates();
    let fetchOption = {
      fetchColumns: [],
      predicates: predicates
    };
    let albumFetchResult = await mgr.getAlbums(userFileManager.AlbumType.USER, userFileManager.AlbumSubType.USER_GENERIC);
    let album = await albumFetchResult.getFirstObject();
    let fetchResult = await album.getPhotoAssets(fetchOption);
    let asset = await fetchResult.getFirstObject();
    album.removePhotoAssets([asset]).then(() => {
      console.info('album removePhotoAssets successfully');
    }).catch((err) => {
      console.error('album removePhotoAssets failed with error: ' + err);
    });
  } catch (err) {
    console.error('removePhotoAssetsDemoPromise failed with error: ' + err);
  }
Y
yangbo 已提交
3261 3262 3263
}
```

H
huweiqi 已提交
3264
### recoverPhotoAssets<sup>10+</sup>
Y
yangbo 已提交
3265

H
huweiqi 已提交
3266
recoverPhotoAssets(assets: Array&lt;FileAsset&gt;, callback: AsyncCallback&lt;void&gt;): void;
Z
zhang-daiyue 已提交
3267

H
huweiqi 已提交
3268
从回收站中恢复图片或者视频,需要先在回收站中预置文件资源。该方法使用callback形式来返回结果。
Z
zhang-daiyue 已提交
3269

H
huweiqi 已提交
3270
**需要权限**:ohos.permission.WRITE_IMAGEVIDEO
Z
zhang-daiyue 已提交
3271 3272 3273

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

H
huweiqi 已提交
3274
**参数:**
Z
zhang-daiyue 已提交
3275 3276 3277

| 参数名   | 类型                      | 必填 | 说明       |
| -------- | ------------------------- | ---- | ---------- |
H
huweiqi 已提交
3278 3279
| assets | Array&lt;[FileAsset](#fileasset)&gt; | 是   | 回收站中待恢复图片或者视频数组。 |
| callback | AsyncCallback&lt;void&gt; | 是   | callback返回void。 |
Z
zhang-daiyue 已提交
3280

H
huweiqi 已提交
3281 3282 3283 3284 3285 3286 3287 3288
**错误码:**

接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 13900020   | if PhotoAssets is invalid.         |

H
huweiqi 已提交
3289
**示例:**
Z
zhang-daiyue 已提交
3290 3291

```ts
H
huweiqi 已提交
3292 3293
import dataSharePredicates from '@ohos.data.dataSharePredicates';

Z
zhang-daiyue 已提交
3294
async function example() {
H
huweiqi 已提交
3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315
  try {
    console.info('recoverPhotoAssetsDemoCallback');
    let predicates = new dataSharePredicates.DataSharePredicates();
    let fetchOption = {
      fetchColumns: [],
      predicates: predicates
    };
    let albumFetchResult = await mgr.getAlbums(userFileManager.AlbumType.SYSTEM, userFileManager.AlbumSubType.TRASH);
    let album = await albumFetchResult.getFirstObject();
    let fetchResult = await album.getPhotoAssets(fetchOption);
    let asset = await fetchResult.getFirstObject();
    album.recoverPhotoAssets([asset], (err) => {
      if (err === undefined) {
        console.info('album recoverPhotoAssets successfully');
      } else {
        console.error('album recoverPhotoAssets failed with error: ' + err);
      }
    });
  } catch (err) {
    console.error('recoverPhotoAssetsDemoCallback failed with error: ' + err);
  }
Z
zhang-daiyue 已提交
3316 3317
}
```
Z
zengyawen 已提交
3318

H
huweiqi 已提交
3319
### recoverPhotoAssets<sup>10+</sup>
Z
zhang-daiyue 已提交
3320

H
huweiqi 已提交
3321
recoverPhotoAssets(assets: Array&lt;FileAsset&gt;): Promise&lt;void&gt;;
Z
zhang-daiyue 已提交
3322

H
huweiqi 已提交
3323
从回收站中恢复图片或者视频,需要先在回收站中预置文件资源。该方法使用Promise来返回结果。
Z
zhang-daiyue 已提交
3324

H
huweiqi 已提交
3325
**需要权限**:ohos.permission.WRITE_IMAGEVIDEO
Z
zhang-daiyue 已提交
3326 3327 3328

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

H
huweiqi 已提交
3329
**参数:**
Z
zhang-daiyue 已提交
3330 3331 3332

| 参数名   | 类型                      | 必填 | 说明       |
| -------- | ------------------------- | ---- | ---------- |
H
huweiqi 已提交
3333 3334 3335
| assets | Array&lt;[FileAsset](#fileasset)&gt; | 是   | 回收站中待恢复图片或者视频数组。 |

**返回值:**
Z
zhang-daiyue 已提交
3336

H
huweiqi 已提交
3337 3338 3339
| 类型                                    | 说明              |
| --------------------------------------- | ----------------- |
|Promise&lt;void&gt; | Promise对象,返回void。 |
Z
zhang-daiyue 已提交
3340

H
huweiqi 已提交
3341 3342 3343 3344 3345 3346 3347 3348
**错误码:**

接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 13900020   | if PhotoAssets is invalid.         |

H
huweiqi 已提交
3349
**示例:**
Z
zhang-daiyue 已提交
3350 3351

```ts
H
huweiqi 已提交
3352 3353
import dataSharePredicates from '@ohos.data.dataSharePredicates';

Z
zhang-daiyue 已提交
3354
async function example() {
H
huweiqi 已提交
3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373
  try {
    console.info('recoverPhotoAssetsDemoPromise');
    let predicates = new dataSharePredicates.DataSharePredicates();
    let fetchOption = {
      fetchColumns: [],
      predicates: predicates
    };
    let albumFetchResult = await mgr.getAlbums(userFileManager.AlbumType.SYSTEM, userFileManager.AlbumSubType.TRASH);
    let album = await albumFetchResult.getFirstObject();
    let fetchResult = await album.getPhotoAssets(fetchOption);
    let asset = await fetchResult.getFirstObject();
    album.recoverPhotoAssets([asset]).then(() => {
      console.info('album recoverPhotoAssets successfully');
    }).catch((err) => {
      console.error('album recoverPhotoAssets failed with error: ' + err);
    });
  } catch (err) {
    console.error('recoverPhotoAssetsDemoPromise failed with error: ' + err);
  }
Z
zhang-daiyue 已提交
3374 3375 3376
}
```

H
huweiqi 已提交
3377
### deletePhotoAssets<sup>10+</sup>
Y
yangbo 已提交
3378

H
huweiqi 已提交
3379
deletePhotoAssets(assets: Array&lt;FileAsset&gt;, callback: AsyncCallback&lt;void&gt;): void;
Y
yangbo 已提交
3380

H
huweiqi 已提交
3381
从回收站中彻底删除图片或者视频,需要先在回收站中预置文件资源。该方法使用callback形式来返回结果。
Y
yangbo 已提交
3382

H
huweiqi 已提交
3383
**注意**:此操作不可逆,执行此操作后文件资源将彻底删除,请谨慎操作。
Y
yangbo 已提交
3384

Z
zhang-daiyue 已提交
3385
**需要权限**:ohos.permission.WRITE_IMAGEVIDEO
Y
yangbo 已提交
3386 3387 3388

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

H
huweiqi 已提交
3389
**参数:**
Y
yangbo 已提交
3390 3391 3392

| 参数名   | 类型                      | 必填 | 说明       |
| -------- | ------------------------- | ---- | ---------- |
H
huweiqi 已提交
3393 3394
| assets | Array&lt;[FileAsset](#fileasset)&gt; | 是   | 回收站中待彻底删除图片或者视频数组。 |
| callback | AsyncCallback&lt;void&gt; | 是   | callback返回void。 |
Y
yangbo 已提交
3395

H
huweiqi 已提交
3396 3397 3398 3399 3400 3401 3402 3403
**错误码:**

接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 13900020   | if PhotoAssets is invalid.         |

H
huweiqi 已提交
3404
**示例:**
Y
yangbo 已提交
3405 3406

```ts
H
huweiqi 已提交
3407 3408
import dataSharePredicates from '@ohos.data.dataSharePredicates';

Z
zhang-daiyue 已提交
3409
async function example() {
H
huweiqi 已提交
3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430
  try {
    console.info('deletePhotoAssetsDemoCallback');
    let predicates = new dataSharePredicates.DataSharePredicates();
    let fetchOption = {
      fetchColumns: [],
      predicates: predicates
    };
    let albumFetchResult = await mgr.getAlbums(userFileManager.AlbumType.SYSTEM, userFileManager.AlbumSubType.TRASH);
    let album = await albumFetchResult.getFirstObject();
    let fetchResult = await album.getPhotoAssets(fetchOption);
    let asset = await fetchResult.getFirstObject();
    album.deletePhotoAssets([asset], (err) => {
      if (err === undefined) {
        console.info('album deletePhotoAssets successfully');
      } else {
        console.error('album deletePhotoAssets failed with error: ' + err);
      }
    });
  } catch (err) {
    console.error('deletePhotoAssetsDemoCallback failed with error: ' + err);
  }
Y
yangbo 已提交
3431 3432 3433
}
```

H
huweiqi 已提交
3434
### deletePhotoAssets<sup>10+</sup>
Y
yangbo 已提交
3435

H
huweiqi 已提交
3436
deletePhotoAssets(assets: Array&lt;FileAsset&gt;): Promise&lt;void&gt;;
Y
yangbo 已提交
3437

H
huweiqi 已提交
3438
从回收站中彻底删除图片或者视频,需要先在回收站中预置文件资源。该方法使用Promise来返回结果。
Y
yangbo 已提交
3439

H
huweiqi 已提交
3440
**注意**:此操作不可逆,执行此操作后文件资源将彻底删除,请谨慎操作。
Y
yangbo 已提交
3441

Z
zhang-daiyue 已提交
3442
**需要权限**:ohos.permission.WRITE_IMAGEVIDEO
Y
yangbo 已提交
3443 3444 3445

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

H
huweiqi 已提交
3446 3447 3448 3449 3450 3451
**参数:**

| 参数名   | 类型                      | 必填 | 说明       |
| -------- | ------------------------- | ---- | ---------- |
| assets | Array&lt;[FileAsset](#fileasset)&gt; | 是   | 回收站中待彻底删除图片或者视频数组。 |

Z
zengyawen 已提交
3452
**返回值:**
Y
yangbo 已提交
3453

H
huweiqi 已提交
3454 3455 3456
| 类型                                    | 说明              |
| --------------------------------------- | ----------------- |
|Promise&lt;void&gt; | Promise对象,返回void。 |
Y
yangbo 已提交
3457

H
huweiqi 已提交
3458 3459 3460 3461 3462 3463 3464 3465
**错误码:**

接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 13900020   | if PhotoAssets is invalid.         |

H
huweiqi 已提交
3466
**示例:**
Y
yangbo 已提交
3467 3468

```ts
H
huweiqi 已提交
3469 3470
import dataSharePredicates from '@ohos.data.dataSharePredicates';

Z
zhang-daiyue 已提交
3471 3472
async function example() {
  try {
H
huweiqi 已提交
3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487
    console.info('deletePhotoAssetsDemoPromise');
    let predicates = new dataSharePredicates.DataSharePredicates();
    let fetchOption = {
      fetchColumns: [],
      predicates: predicates
    };
    let albumFetchResult = await mgr.getAlbums(userFileManager.AlbumType.SYSTEM, userFileManager.AlbumSubType.TRASH);
    let album = await albumFetchResult.getFirstObject();
    let fetchResult = await album.getPhotoAssets(fetchOption);
    let asset = await fetchResult.getFirstObject();
    album.deletePhotoAssets([asset]).then(() => {
      console.info('album deletePhotoAssets successfully');
    }).catch((err) => {
      console.error('album deletePhotoAssets failed with error: ' + err);
    });
Z
zhang-daiyue 已提交
3488
  } catch (err) {
H
huweiqi 已提交
3489
    console.error('deletePhotoAssetsDemoPromise failed with error: ' + err);
Z
zhang-daiyue 已提交
3490
  }
Y
yangbo 已提交
3491 3492 3493
}
```

Z
zhang-daiyue 已提交
3494
## PrivateAlbum
H
huweiqi 已提交
3495 3496

系统相册。
Z
zhang-daiyue 已提交
3497

H
huweiqi 已提交
3498 3499
此接口即将废弃,请使用[Album](#album)接口替代。

Z
zhang-daiyue 已提交
3500 3501
### 属性

H
huweiqi 已提交
3502
**系统能力**:SystemCapability.FileManagement.UserFileManager.Core
Z
zhang-daiyue 已提交
3503 3504 3505

| 名称           | 类型    | 可读   | 可写   | 说明      |
| ------------ | ------ | ---- | ---- | ------- |
H
huweiqi 已提交
3506 3507 3508 3509 3510
| albumName | string | 是    | 是    | 相册名称。    |
| albumUri | string | 是    | 否    | 相册Uri。   |
| dateModified | number | 是    | 否    | 修改日期。    |
| count | number | 是    | 否    | 相册中文件数量。 |
| coverUri | string | 是    | 否    | 封面文件Uri。 |
Z
zhang-daiyue 已提交
3511 3512

### getPhotoAssets
Y
yangbo 已提交
3513

Z
zhang-daiyue 已提交
3514
getPhotoAssets(options: FetchOptions, callback: AsyncCallback&lt;FetchResult&lt;FileAsset&gt;&gt;): void;
Y
yangbo 已提交
3515

H
huweiqi 已提交
3516
获取系统相册中的文件。该方法使用callback形式来返回文件。
Y
yangbo 已提交
3517

H
huweiqi 已提交
3518 3519
此接口即将废弃,请使用[Album.getPhotoAssets](#getphotoassets-2)接口替代。

H
huweiqi 已提交
3520
**需要权限**:ohos.permission.READ_IMAGEVIDEO
Y
yangbo 已提交
3521 3522 3523

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

H
huweiqi 已提交
3524
**参数:**
Y
yangbo 已提交
3525

Z
zhang-daiyue 已提交
3526 3527
| 参数名   | 类型                      | 必填 | 说明       |
| -------- | ------------------------- | ---- | ---------- |
H
huweiqi 已提交
3528 3529
| options | [FetchOptions](#fetchoptions) | 是   | 检索选项。 |
| callback | AsyncCallback&lt;[FetchResult](#fetchresult)&lt;[FileAsset](#fileasset)&gt;&gt; | 是   | callback返回图片和视频数据结果集。 |
Y
yangbo 已提交
3530

H
huweiqi 已提交
3531 3532 3533 3534 3535 3536 3537 3538
**错误码:**

接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 13900020   | if type options is not FetchOptions.         |

H
huweiqi 已提交
3539
**示例:**
Y
yangbo 已提交
3540 3541

```ts
H
huweiqi 已提交
3542 3543
import dataSharePredicates from '@ohos.data.dataSharePredicates';

Z
zhang-daiyue 已提交
3544
async function example() {
H
huweiqi 已提交
3545
  console.info('privateAlbumGetFileAssetsDemoCallback');
Z
zhang-daiyue 已提交
3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557
  let albumList = await mgr.getPrivateAlbum(userFileManager.PrivateAlbumType.TYPE_TRASH);
  let predicates = new dataSharePredicates.DataSharePredicates();
  let fetchOption = {
    fetchColumns: [],
    predicates: predicates
  };
  const trashAlbum = await albumList.getFirstObject();
  trashAlbum.getPhotoAssets(fetchOption, (err, fetchResult) => {
    if (fetchResult != undefined) {
      let count = fetchResult.getCount();
      console.info('fetchResult.count = ', count);
    } else {
H
huweiqi 已提交
3558
      console.error('getFileAssets failed, message = ', err);
Z
zhang-daiyue 已提交
3559 3560
    }
  });
Y
yangbo 已提交
3561 3562
}

Z
zhang-daiyue 已提交
3563
```
Z
zengyawen 已提交
3564

Z
zhang-daiyue 已提交
3565
### getPhotoAssets
Y
yangbo 已提交
3566

Z
zhang-daiyue 已提交
3567
getPhotoAssets(options: FetchOptions): Promise&lt;FetchResult&lt;FileAsset&gt;&gt;;
Y
yangbo 已提交
3568

H
huweiqi 已提交
3569
获取系统相册中的文件。该方法使用Promise来返回文件。
Y
yangbo 已提交
3570

H
huweiqi 已提交
3571 3572
此接口即将废弃,请使用[Album.getPhotoAssets](#getphotoassets-3)接口替代。

H
huweiqi 已提交
3573
**需要权限**:ohos.permission.READ_IMAGEVIDEO
Y
yangbo 已提交
3574 3575 3576

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

H
huweiqi 已提交
3577
**参数:**
Y
yangbo 已提交
3578

Z
zhang-daiyue 已提交
3579 3580
| 参数名   | 类型                      | 必填 | 说明       |
| -------- | ------------------------- | ---- | ---------- |
H
huweiqi 已提交
3581
| options | [FetchOptions](#fetchoptions) | 是   | 检索选项。 |
Z
zhang-daiyue 已提交
3582

Z
zengyawen 已提交
3583
**返回值:**
Z
zhang-daiyue 已提交
3584 3585 3586

| 类型                                    | 说明              |
| --------------------------------------- | ----------------- |
H
huweiqi 已提交
3587
| Promise:[FetchResult](#fetchresult)&lt;[FileAsset](#fileasset)&gt;| Promise对象,返回图片和视频数据结果集。 |
Y
yangbo 已提交
3588

H
huweiqi 已提交
3589 3590 3591 3592 3593 3594 3595 3596
**错误码:**

接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 13900020   | if type options is not FetchOptions.         |

H
huweiqi 已提交
3597
**示例:**
Y
yangbo 已提交
3598 3599

```ts
H
huweiqi 已提交
3600 3601
import dataSharePredicates from '@ohos.data.dataSharePredicates';

Z
zhang-daiyue 已提交
3602
async function example() {
H
huweiqi 已提交
3603
  console.info('privateAlbumGetFileAssetsDemoPromise');
Z
zhang-daiyue 已提交
3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614
  let albumList = await mgr.getPrivateAlbum(userFileManager.PrivateAlbumType.TYPE_TRASH);
  let predicates = new dataSharePredicates.DataSharePredicates();
  let fetchOption = {
    fetchColumns: [],
    predicates: predicates
  };
  const trashAlbum = await albumList.getFirstObject();
  let fetchResult = await trashAlbum.getPhotoAssets(fetchOption);
  let count = fetchResult.getCount();
  console.info('fetchResult.count = ', count);
}
Y
yangbo 已提交
3615
```
Z
zengyawen 已提交
3616

Z
zhang-daiyue 已提交
3617 3618 3619
### delete

delete(uri: string, callback: AsyncCallback&lt;void&gt;): void;
Y
yangbo 已提交
3620

H
huweiqi 已提交
3621
删除系统相册中的文件。
Y
yangbo 已提交
3622

H
huweiqi 已提交
3623 3624
此接口即将废弃,请使用[Album.deletePhotoAssets](#deletephotoassets10)接口替代。

Z
zhang-daiyue 已提交
3625 3626 3627 3628
**需要权限**:ohos.permission.READ_IMAGEVIDEO 和 ohos.permission.WRITE_IMAGEVIDEO 或 ohos.permission.READ_AUDIO 和 ohos.permission.WRITE_AUDIO

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

H
huweiqi 已提交
3629
**参数:**
Z
zhang-daiyue 已提交
3630 3631 3632

| 参数名   | 类型                      | 必填 | 说明       |
| -------- | ------------------------- | ---- | ---------- |
H
huweiqi 已提交
3633 3634
| uri | string | 是   | 相册uri。 |
| callback | AsyncCallback&lt;void&gt; | 是   | callback返回void。 |
Z
zhang-daiyue 已提交
3635

H
huweiqi 已提交
3636
**示例:**
Z
zhang-daiyue 已提交
3637 3638

```ts
H
huweiqi 已提交
3639 3640
import dataSharePredicates from '@ohos.data.dataSharePredicates';

Z
zhang-daiyue 已提交
3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654
async function example() {
  console.info('privateAlbumDeleteCallback');
  let albumList = await mgr.getPrivateAlbum(userFileManager.PrivateAlbumType.TYPE_TRASH);
  let predicates = new dataSharePredicates.DataSharePredicates();
  let fetchOption = {
    fetchColumns: [],
    predicates: predicates
  };
  const trashAlbum = await albumList.getFirstObject();
  let fetchResult = await trashAlbum.getPhotoAssets(fetchOption);
  const fileAsset = await fetchResult.getFirstObject();
  let deleteFileUri = fileAsset.uri;
  trashAlbum.delete(deleteFileUri, (err) => {
    if (err != undefined) {
H
huweiqi 已提交
3655
      console.error('trashAlbum.delete failed, message = ', err);
Z
zhang-daiyue 已提交
3656 3657 3658 3659 3660 3661
    } else {
      console.info('trashAlbum.delete successfully');
    }
  });
}
```
Z
zengyawen 已提交
3662

Z
zhang-daiyue 已提交
3663
### delete
Y
yangbo 已提交
3664

Z
zhang-daiyue 已提交
3665
delete(uri: string): Promise&lt;void&gt;;
Y
yangbo 已提交
3666

H
huweiqi 已提交
3667
删除系统相册中的文件。
Y
yangbo 已提交
3668

H
huweiqi 已提交
3669 3670
此接口即将废弃,请使用[Album.deletePhotoAssets](#deletephotoassets10)接口替代。

Z
zhang-daiyue 已提交
3671
**需要权限**:ohos.permission.READ_IMAGEVIDEO 和 ohos.permission.WRITE_IMAGEVIDEO 或 ohos.permission.READ_AUDIO 和 ohos.permission.WRITE_AUDIO
Y
yangbo 已提交
3672 3673 3674

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

H
huweiqi 已提交
3675
**参数:**
Y
yangbo 已提交
3676

Z
zhang-daiyue 已提交
3677 3678
| 参数名   | 类型                      | 必填 | 说明       |
| -------- | ------------------------- | ---- | ---------- |
H
huweiqi 已提交
3679
| uri | string | 是   | 相册uri。 |
Y
yangbo 已提交
3680

Z
zengyawen 已提交
3681
**返回值:**
Y
yangbo 已提交
3682

Z
zhang-daiyue 已提交
3683 3684
| 类型                                    | 说明              |
| --------------------------------------- | ----------------- |
H
huweiqi 已提交
3685
| Promise&lt;void&gt;| Promise对象,返回void。 |
Y
yangbo 已提交
3686

H
huweiqi 已提交
3687
**示例:**
Y
yangbo 已提交
3688 3689

```ts
H
huweiqi 已提交
3690 3691
import dataSharePredicates from '@ohos.data.dataSharePredicates';

Z
zhang-daiyue 已提交
3692
async function example() {
H
huweiqi 已提交
3693
  console.info('privateAlbumDeleteDemoPromise');
Z
zhang-daiyue 已提交
3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706
  let albumList = await mgr.getPrivateAlbum(userFileManager.PrivateAlbumType.TYPE_TRASH);
  let predicates = new dataSharePredicates.DataSharePredicates();
  let fetchOption = {
    fetchColumns: [],
    predicates: predicates
  };
  const trashAlbum = await albumList.getFirstObject();
  let fetchResult = await trashAlbum.getPhotoAssets(fetchOption);
  const fileAsset = await fetchResult.getFirstObject();
  let deleteFileUri = fileAsset.uri;
  trashAlbum.delete(deleteFileUri).then(() => {
    console.info('trashAlbum.delete successfully');
  }).catch((err) => {
H
huweiqi 已提交
3707
    console.error('trashAlbum.delete failed, message = ', err);
Z
zhang-daiyue 已提交
3708
  });
S
sunshenshen 已提交
3709
}
Y
yangbo 已提交
3710 3711
```

Z
zhang-daiyue 已提交
3712
### recover
Y
yangbo 已提交
3713

Z
zhang-daiyue 已提交
3714
recover(uri: string, callback: AsyncCallback&lt;void&gt;): void;
李云帆 已提交
3715

H
huweiqi 已提交
3716
恢复系统相册中的文件。
Y
yangbo 已提交
3717

H
huweiqi 已提交
3718 3719
此接口即将废弃,请使用[Album.recoverPhotoAssets](#recoverphotoassets10)接口替代。

H
huweiqi 已提交
3720
**需要权限**:ohos.permission.READ_IMAGEVIDEO 和 ohos.permission.WRITE_IMAGEVIDEO 或 ohos.permission.READ_AUDIO 和 ohos.permission.WRITE_AUDIO
Y
yangbo 已提交
3721 3722 3723

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

H
huweiqi 已提交
3724
**参数:**
Z
zhang-daiyue 已提交
3725 3726 3727

| 参数名   | 类型                      | 必填 | 说明       |
| -------- | ------------------------- | ---- | ---------- |
H
huweiqi 已提交
3728 3729
| uri | string | 是   | 相册uri。 |
| callback | AsyncCallback&lt;void&gt; | 是   | callback返回void。 |
Y
yangbo 已提交
3730

H
huweiqi 已提交
3731
**示例:**
Y
yangbo 已提交
3732 3733

```ts
H
huweiqi 已提交
3734 3735
import dataSharePredicates from '@ohos.data.dataSharePredicates';

Z
zhang-daiyue 已提交
3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749
async function example() {
  console.info('privateAlbumRecoverDemoCallback');
  let albumList = await mgr.getPrivateAlbum(userFileManager.PrivateAlbumType.TYPE_TRASH);
  let predicates = new dataSharePredicates.DataSharePredicates();
  let fetchOption = {
    fetchColumns: [],
    predicates: predicates
  };
  const trashAlbum = await albumList.getFirstObject();
  let fetchResult = await trashAlbum.getPhotoAssets(fetchOption);
  const fileAsset = await fetchResult.getFirstObject();
  let recoverFileUri = fileAsset.uri;
  trashAlbum.recover(recoverFileUri, (err) => {
    if (err != undefined) {
H
huweiqi 已提交
3750
      console.error('trashAlbum.recover failed, message = ', err);
Z
zhang-daiyue 已提交
3751 3752
    } else {
      console.info('trashAlbum.recover successfully');
Y
yangbo 已提交
3753
    }
Z
zhang-daiyue 已提交
3754
  });
Y
yangbo 已提交
3755 3756
}
```
Z
zengyawen 已提交
3757

Z
zhang-daiyue 已提交
3758
### recover
Y
yangbo 已提交
3759

Z
zhang-daiyue 已提交
3760
recover(uri: string): Promise&lt;void&gt;;
Y
yangbo 已提交
3761

H
huweiqi 已提交
3762
恢复系统相册中的文件。
李云帆 已提交
3763

H
huweiqi 已提交
3764 3765
此接口即将废弃,请使用[Album.recoverPhotoAssets](#recoverphotoassets10)接口替代。

H
huweiqi 已提交
3766
**需要权限**:ohos.permission.READ_IMAGEVIDEO 和 ohos.permission.WRITE_IMAGEVIDEO 或 ohos.permission.READ_AUDIO 和 ohos.permission.WRITE_AUDIO
Y
yangbo 已提交
3767 3768 3769

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

H
huweiqi 已提交
3770
**参数:**
Y
yangbo 已提交
3771

Z
zhang-daiyue 已提交
3772 3773
| 参数名   | 类型                      | 必填 | 说明       |
| -------- | ------------------------- | ---- | ---------- |
H
huweiqi 已提交
3774
| uri | string | 是   | 相册uri。 |
Y
yangbo 已提交
3775

Z
zengyawen 已提交
3776
**返回值:**
Y
yangbo 已提交
3777

Z
zhang-daiyue 已提交
3778 3779
| 类型                                    | 说明              |
| --------------------------------------- | ----------------- |
H
huweiqi 已提交
3780
| Promise&lt;void&gt;| Promise对象,返回void。 |
Y
yangbo 已提交
3781

H
huweiqi 已提交
3782
**示例:**
Y
yangbo 已提交
3783 3784

```ts
H
huweiqi 已提交
3785 3786
import dataSharePredicates from '@ohos.data.dataSharePredicates';

Z
zhang-daiyue 已提交
3787
async function example() {
H
huweiqi 已提交
3788
  console.info('privateAlbumRecoverDemoPromise');
Z
zhang-daiyue 已提交
3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801
  let albumList = await mgr.getPrivateAlbum(userFileManager.PrivateAlbumType.TYPE_TRASH);
  let predicates = new dataSharePredicates.DataSharePredicates();
  let fetchOption = {
    fetchColumns: [],
    predicates: predicates
  };
  const trashAlbum = await albumList.getFirstObject();
  let fetchResult = await trashAlbum.getPhotoAssets(fetchOption);
  const fileAsset = await fetchResult.getFirstObject();
  let recoverFileUri = fileAsset.uri;
  trashAlbum.recover(recoverFileUri).then(() => {
    console.info('trashAlbum.recover successfully');
  }).catch((err) => {
H
huweiqi 已提交
3802
    console.error('trashAlbum.recover failed, message = ', err);
Z
zhang-daiyue 已提交
3803
  });
Y
yangbo 已提交
3804 3805 3806
}
```

Z
zhang-daiyue 已提交
3807 3808 3809 3810
## MemberType

成员类型。

H
huweiqi 已提交
3811
**系统能力**:SystemCapability.FileManagement.UserFileManager.Core
zyjhandsome's avatar
zyjhandsome 已提交
3812

H
huweiqi 已提交
3813 3814
| 名称  |  类型 |  可读  |  可写  |  说明  |
| ----- |  ---- |  ---- |  ---- |  ---- |
H
huweiqi 已提交
3815 3816 3817
| number |  number | 是 | 是 | number类型。 |
| string |  string | 是 | 是 | string类型。|
| boolean |  boolean | 是 | 是 | boolean类型。 |
Z
zhang-daiyue 已提交
3818 3819 3820 3821 3822

## ChangeEvent

变更监听的媒体文件类型。

H
huweiqi 已提交
3823
**系统能力**:SystemCapability.FileManagement.UserFileManager.Core
Z
zhang-daiyue 已提交
3824

H
huweiqi 已提交
3825
| 名称  |  类型 |  可读  |  可写  |  说明 |
H
huweiqi 已提交
3826
| ----- |  ---- |  ---- |  ---- |  ---- |
H
huweiqi 已提交
3827 3828 3829 3830 3831 3832
| deviceChange |  string | 是 | 是 |  设备。 |
| albumChange |  string | 是 | 是 |  相册。 |
| imageChange |  string | 是 | 是 |  图片。 |
| audioChange |  string | 是 | 是 |  音频。 |
| videoChange |  string | 是 | 是 |  视频。 |
| remoteFileChange |  string | 是 | 是 |  远程文件。 |
Z
zhang-daiyue 已提交
3833

Y
yangbo 已提交
3834 3835 3836 3837
## PeerInfo

注册设备的信息。

H
huweiqi 已提交
3838
**系统能力**:SystemCapability.FileManagement.UserFileManager.DistributedCore
Y
yangbo 已提交
3839 3840 3841

| 名称       | 类型                       | 可读 | 可写 | 说明             |
| ---------- | -------------------------- | ---- | ---- | ---------------- |
H
huweiqi 已提交
3842 3843 3844
| deviceName | string                     | 是   | 否   | 注册设备的名称。   |
| networkId  | string                     | 是   | 否   | 注册设备的网络ID。 |
| isOnline   | boolean                    | 是   | 否   | 是否在线。         |
Y
yangbo 已提交
3845

Z
zhang-daiyue 已提交
3846 3847 3848
## FileType

枚举,媒体文件类型。
Y
yangbo 已提交
3849

H
huweiqi 已提交
3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897
**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

| 名称  |  值 |  说明 |
| ----- |  ---- |  ---- |
| IMAGE |  1 |  图片。 |
| VIDEO |  2 |  视频。 |
| AUDIO |  3 |  音频。 |

## PhotoSubType<sup>10+</sup>

枚举,不同[FileAsset](#fileasset)的类型。

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

| 名称  |  值 |  说明 |
| ----- |  ---- |  ---- |
| DEFAULT |  0 |  默认照片类型。 |
| SCREENSHOT |  1 |  截屏录屏文件类型。 |
| CAMERA |  2 |  相机拍摄的照片和视频类型。 |

## PositionType<sup>10+</sup>

枚举,文件位置,表示文件在本地或云端。

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

| 名称  |  值 |  说明 |
| ----- |  ---- |  ---- |
| LOCAL |  1 |  文件只存在于本端设备。 |
| CLOUD |  2 |  文件只存在于云端。 |
| BOTH |  3 |  文件在本地和云中都存在。 |

## AlbumType<sup>10+</sup>

枚举,相册类型,表示是用户相册还是系统预置相册。

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

| 名称  |  值 |  说明 |
| ----- |  ---- |  ---- |
| USER |  0 |  用户相册。 |
| SYSTEM |  1024 |  系统预置相册。 |

## AlbumSubType<sup>10+</sup>

枚举,相册子类型,表示具体的相册类型。

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core
Y
yangbo 已提交
3898

H
huweiqi 已提交
3899 3900
| 名称  |  值 |  说明 |
| ----- |  ---- |  ---- |
H
huweiqi 已提交
3901 3902 3903 3904 3905 3906 3907 3908
| USER_GENERIC |  1 |  用户相册。 |
| FAVORITE |  1025 |  收藏夹。 |
| VIDEO |  1026 |  视频相册。 |
| HIDDEN |  1027 |  隐藏相册。 |
| TRASH |  1028 |  回收站。 |
| SCREENSHOT |  1029 |  截屏和录屏相册。 |
| CAMERA |  1030 |  相机拍摄的照片和视频相册。 |
| ANY |  2147483647 |  任意相册。 |
Y
yangbo 已提交
3909

Z
zhang-daiyue 已提交
3910
## PrivateAlbumType
Y
yangbo 已提交
3911

Z
zhang-daiyue 已提交
3912
枚举,系统相册类型。
Y
yangbo 已提交
3913

H
huweiqi 已提交
3914 3915
此接口即将废弃,请使用[AlbumType](#albumtype10)[AlbumSubType](#albumsubtype10)和接口替代。

H
huweiqi 已提交
3916
**系统能力**:SystemCapability.FileManagement.UserFileManager.Core
Y
yangbo 已提交
3917

H
huweiqi 已提交
3918 3919
| 名称    |  值 |   说明   |
| -----   |  ----  |   ----  |
H
huweiqi 已提交
3920 3921
| TYPE_FAVORITE |  0 |  收藏夹相册。 |
| TYPE_TRASH |  1 |  回收站相册。 |
Z
zhang-daiyue 已提交
3922

Y
yangbo 已提交
3923 3924 3925 3926
## AudioKey

枚举,音频文件关键信息。

H
huweiqi 已提交
3927
**系统能力**:SystemCapability.FileManagement.UserFileManager.Core
Y
yangbo 已提交
3928

H
huweiqi 已提交
3929
| 名称          |   值              | 说明                                                       |
Y
yangbo 已提交
3930
| ------------- | ------------------- | ---------------------------------------------------------- |
H
huweiqi 已提交
3931 3932 3933 3934 3935 3936 3937 3938 3939
| URI           | uri                 | 文件uri。                                                   |
| DISPLAY_NAME  | display_name        | 显示名字。                                                   |
| DATE_ADDED    | date_added          | 添加日期(添加文件时间距1970年1月1日的秒数值)。             |
| DATE_MODIFIED | date_modified       | 修改日期(修改文件时间距1970年1月1日的秒数值,修改文件名不会改变此值,当文件内容发生修改时才会更新)。 |
| TITLE         | title               | 文件标题。                                                   |
| ARTIST        | artist              | 作者。                                                   |
| AUDIOALBUM    | audio_album         | 专辑。                                                   |
| DURATION      | duration            | 持续时间(单位:毫秒)。                                    |
| FAVORITE      | favorite            | 收藏。                                                   |
Y
yangbo 已提交
3940 3941 3942 3943 3944

## ImageVideoKey

枚举,图片和视频文件关键信息。

H
huweiqi 已提交
3945
**系统能力**:SystemCapability.FileManagement.UserFileManager.Core
Y
yangbo 已提交
3946

H
huweiqi 已提交
3947
| 名称          | 值              | 说明                                                       |
Y
yangbo 已提交
3948
| ------------- | ------------------- | ---------------------------------------------------------- |
H
huweiqi 已提交
3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963
| URI           | uri                 | 文件uri。                                                   |
| FILE_TYPE     | file_type           | 媒体文件类型。                                              |
| DISPLAY_NAME  | display_name        | 显示名字。                                                   |
| DATE_ADDED    | date_added          | 添加日期(添加文件时间距1970年1月1日的秒数值)。             |
| DATE_MODIFIED | date_modified       | 修改日期(修改文件时间距1970年1月1日的秒数值,修改文件名不会改变此值,当文件内容发生修改时才会更新)。 |
| TITLE         | title               | 文件标题。                                                   |
| DURATION      | duration            | 持续时间(单位:毫秒)。                                    |
| WIDTH         | width               | 图片宽度(单位:像素)。                                    |
| HEIGHT        | height              | 图片高度(单位:像素)。                                      |
| DATE_TAKEN    | date_taken          | 拍摄日期(文件拍照时间距1970年1月1日的秒数值)。                |
| ORIENTATION   | orientation         | 图片文件的方向。                                             |
| FAVORITE      | favorite            | 收藏。                                                    |
| POSITION<sup>10+</sup>  | position            | 文件位置类型。                               |
| DATE_TRASHED<sup>10+</sup>  | date_trashed  | 删除日期(删除文件时间距1970年1月1日的秒数值)。                 |
| HIDDEN<sup>10+</sup>  | hidden            | 文件的隐藏状态。                               |
S
sunshenshen 已提交
3964
| CAMERA_SHOT_KEY<sup>10+</sup>    | camera_shot_key           | 锁屏相机拍照或录像的标记字段(仅开放给系统相机,其key值由系统相机定义)。    |
Y
yangbo 已提交
3965 3966 3967 3968 3969

## AlbumKey

枚举,相册关键信息。

H
huweiqi 已提交
3970
**系统能力**:SystemCapability.FileManagement.UserFileManager.Core
Y
yangbo 已提交
3971

H
huweiqi 已提交
3972
| 名称          | 值              | 说明                                                       |
Y
yangbo 已提交
3973
| ------------- | ------------------- | ---------------------------------------------------------- |
H
huweiqi 已提交
3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988
| URI           | uri                 | 相册uri。                                                   |
| FILE_TYPE     | file_type           | 媒体文件类型。                                              |
| ALBUM_NAME    | album_name          | 相册名字。                                                   |
| DATE_ADDED    | date_added          | 添加日期(添加文件时间距1970年1月1日的秒数值)。             |
| DATE_MODIFIED | date_modified       | 修改日期(修改文件时间距1970年1月1日的秒数值,修改文件名不会改变此值,当文件内容发生修改时才会更新)。 |

## PhotoCreateOptions<sup>10+</sup>

图片或视频的创建选项。

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

| 名称                   | 类型                | 必填 | 说明                                              |
| ---------------------- | ------------------- | ---- | ------------------------------------------------ |
| subType           | [PhotoSubType](#photosubtype10) | 否  | 图片或者视频的子类型。  |
S
sunshenshen 已提交
3989
| cameraShotKey           | string | 否  | 锁屏相机拍照或录像的标记字段(仅开放给系统相机,其key值由系统相机定义)。  |
Y
yangbo 已提交
3990

Z
zhang-daiyue 已提交
3991
## FetchOptions
Y
yangbo 已提交
3992 3993 3994

检索条件。

H
huweiqi 已提交
3995
**系统能力**:SystemCapability.FileManagement.UserFileManager.Core
Y
yangbo 已提交
3996

H
huweiqi 已提交
3997 3998
| 名称                   | 类型                | 可读 | 可写 | 说明                                              |
| ---------------------- | ------------------- | ---- |---- | ------------------------------------------------ |
H
huweiqi 已提交
3999 4000
| fetchColumns           | Array&lt;string&gt; | 是   | 是   | 检索条件,指定列名查询,如果该参数为空时默认查询uri、name、fileType(具体字段名称以检索对象定义为准)。示例:<br />fetchColumns: ['uri', 'title']。 |
| predicates           | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md) | 是   | 是   | 谓词查询,显示过滤条件。 |
Y
yangbo 已提交
4001

Z
zhang-daiyue 已提交
4002
## AlbumFetchOptions
Y
yangbo 已提交
4003

Z
zhang-daiyue 已提交
4004
相册检索条件。
李云帆 已提交
4005

H
huweiqi 已提交
4006
**系统能力**:SystemCapability.FileManagement.UserFileManager.Core
Y
yangbo 已提交
4007

H
huweiqi 已提交
4008 4009
| 名称                   | 类型                | 可读 | 可写 | 说明                                              |
| ---------------------- | ------------------- | ---- |---- | ------------------------------------------------ |
H
huweiqi 已提交
4010
| predicates           | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md) | 是   | 是   | 谓词查询,显示过滤条件。 |
Y
yangbo 已提交
4011

C
caochuan 已提交
4012 4013 4014 4015 4016 4017 4018 4019
## ChangeData<sup>10+</sup>

监听器回调函数的值。

**系统能力**:SystemCapability.FileManagement.UserFileManager.Core

| 名称    | 类型                        | 可读 | 可写 | 说明                                                         |
| ------- | --------------------------- | ---- | ---- | ------------------------------------------------------------ |
4020 4021 4022
| type    | [NotifyType](#notifytype10) | 是   | 否   | ChangeData的通知类型。                                       |
| uris    | Array&lt;string&gt;         | 是   | 否   | 相同[NotifyType](#notifytype10)的所有uri,可以是FileAsset或Album。 |
| subUris | Array&lt;string&gt;         | 是   | 否   | 相册中变动文件的uri数组。                                    |
C
caochuan 已提交
4023 4024 4025

## NotifyType<sup>10+</sup>

4026
枚举,通知事件的类型。
C
caochuan 已提交
4027

4028
**系统能力**:SystemCapability.FileManagement.UserFileManager.Core
C
caochuan 已提交
4029

4030 4031 4032 4033 4034 4035 4036
| 名称                      | 值   | 说明                             |
| ------------------------- | ---- | -------------------------------- |
| NOTIFY_ADD                | 0    | 添加文件集或相册通知的类型。     |
| NOTIFY_UPDATE             | 1    | 文件集或相册的更新通知类型。     |
| NOTIFY_REMOVE             | 2    | 删除文件集或相册的通知类型。     |
| NOTIFY_ALBUM_ADD_ASSET    | 3    | 在相册中添加的文件集的通知类型。 |
| NOTIFY_ALBUM_REMOVE_ASSET | 4    | 在相册中删除的文件集的通知类型。 |
C
caochuan 已提交
4037 4038 4039 4040 4041

## DefaultChangeUri<sup>10+</sup>

枚举,DefaultChangeUri子类型。

4042
**系统能力**:SystemCapability.FileManagement.UserFileManager.Core
C
caochuan 已提交
4043

4044 4045 4046 4047 4048 4049
| 名称              | 值                      | 说明                                                         |
| ----------------- | ----------------------- | ------------------------------------------------------------ |
| DEFAULT_PHOTO_URI | file://media/Photo      | 默认PhotoAsset的Uri,与forSubUri{true}一起使用,将接收所有PhotoAsset的更改通知。 |
| DEFAULT_ALBUM_URI | file://media/PhotoAlbum | 默认相册的Uri,与forSubUri{true}一起使用,将接收所有相册的更改通知。 |
| DEFAULT_AUDIO_URI | file://media/Audio      | 默认AudioAsset的Uri,与forSubUri{true}一起使用,将接收所有AudioAsset的更改通知。 |