js-apis-fileAccess.md 21.2 KB
Newer Older
1 2 3 4
# 公共文件访问与管理

fileAccess模块是基于extension机制实现的一个对公共文件访问和操作的框架。该模块一方面对接各类文件管理服务,如媒体库、外置存储管理服务等,另一方面为系统应用提供一套统一的文件访问管理接口。其中,媒体库服务提供本地设备、分布式设备等公共文件访问服务;外置存储管理服务可以提供共享盘、U盘、SD卡等设备的公共文件访问服务。

O
onexiaomin 已提交
5
>**说明:**
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
>
>- 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>- 本模块接口为系统接口,三方应用不支持调用,当前只支持filepicker、文件管理器调用。

## 导入模块

```js
import fileAccess from '@ohos.data.fileAccess';
```

## fileAccess.getFileAccessAbilityInfo

getFileAccessAbilityInfo( ) : Promise<Array<Want>>

以异步方法获取系统内extension配置为fileAcesss类型的所有Want信息。使用Promise异步回调。

**系统能力**:SystemCapability.FileManagement.UserFileService

O
onexiaomin 已提交
24
**需要权限**:ohos.permission.FILE_ACCESS_MANAGER 和 ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53

**返回值:**

  | 类型 | 说明 |
  | --- | -- |
  | Promise<Array<Want>> | 表示当前系统配置fileAccess的所有文件管理类服务 |

**示例:**

  ```js
  async getFileAccessAbilityInfo() {
    let wantInfos = [];
    try {
      wantInfos = await fileAccess.getFileAccessAbilityInfo();
      console.log("getFileAccessAbilityInfo data " + JSON.stringify(wantInfos));
    } catch (error) {
      console.error("getFileAccessAbilityInfo failed, error " + error);
    }
  }
  ```

## fileAccess.createFileAccessHelper

createFileAccessHelper(context: Context, wants: Array<Want>) : FileAccessHelper

以同步方法创建连接指定wants的helper对象。

**系统能力**:SystemCapability.FileManagement.UserFileService

O
onexiaomin 已提交
54
**需要权限**:ohos.permission.FILE_ACCESS_MANAGER 和 ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73

**参数:**

  | 参数名 | 类型 | 必填 | 说明 |
  | --- | --- | --- | -- |
  | context | Context | 是 | 代表ability的上下文的能力 |
  | wants | Array<Want> | 是 | Want是一种基本通信组件,主要用于服务拉起 |

**返回值:**

  | 类型 | 说明 |
  | --- | -- |
  | FileAccessHelper | 提供文件访问和操作能力的helper对象 |

**示例:**

  ```js
  createFileAccessHelper() {
    let fileAccesssHelper = null;
O
onexiaomin 已提交
74
    // wantInfos 从getFileAccessAbilityInfo()获取
75
    // 创建只连接媒体库服务的helper对象
O
onexiaomin 已提交
76 77 78 79 80 81
    let wantInfos = [
      {
        "bundleName": "com.ohos.medialibrary.medialibrarydata",
        "abilityName": "FileExtensionAbility",
      },
    ]
82
    try {
O
onexiaomin 已提交
83
      // this.context 是MainAbility 传过来的context
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
      fileAccesssHelper = fileAccess.createFileAccessHelper(this.context, wantInfos);
      if (!fileAccesssHelper)
        console.error("createFileAccessHelper interface returns an undefined object");
    } catch (error) {
      console.error("createFileAccessHelper failed, error " + error);
    }
  }
  ```

## fileAccess.createFileAccessHelper

createFileAccessHelper(context: Context) : FileAccessHelper

以同步方法创建连接当前系统内所有文件管理服务的helper对象。

**系统能力**:SystemCapability.FileManagement.UserFileService

O
onexiaomin 已提交
101
**需要权限**:ohos.permission.FILE_ACCESS_MANAGER 和 ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121

**参数:**

  | 参数名 | 类型 | 必填 | 说明 |
  | --- | --- | --- | -- |
  | context | Context | 是 | ability的上下文的能力 |

**返回值:**

  | 类型 | 说明 |
  | --- | -- |
  | FileAccessHelper | 提供文件访问和操作的能力的helper对象 |

**示例:**

  ```js
  createFileAccessHelper() {
    let fileAccesssHelperAllServer = null;
    // 创建连接系统内所有配置fileAccess的文件管理类服务的helper对象
    try {
O
onexiaomin 已提交
122
      // this.context 是MainAbility 传过来的context
123 124 125 126 127 128 129 130 131 132 133 134 135 136
      fileAccesssHelperAllServer = fileAccess.createFileAccessHelper(this.context);
      if (!fileAccesssHelperAllServer)
        console.error("createFileAccessHelper interface returns an undefined object");
    } catch (error) {
      console.error("createFileAccessHelper failed, error " + error);
    }
  }
  ```

## FileAccessHelper.getRoots

getRoots( ) : Promise<RootIterator>

以异步方法获取helper对象连接的文件管理服务类的设备根节点信息。使用Promise异步回调。
137
该方法返回迭代器对象RootIterator,然后通过[next](#rootiteratornext)方法返回[RootInfo](#rootinfo)
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156

**系统能力**:SystemCapability.FileManagement.UserFileService

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

**返回值:**

  | 类型 | 说明 |
  | --- | -- |
  | Promise<RootIterator> | 根设备目录信息组成迭代器对象 |

**示例:**

  ```js
  async getRoots() {
    let rootIterator = null;
    let rootinfos = [];
    let isDone = false;
    try {
O
onexiaomin 已提交
157
      rootIterator = await fileAccessHelper.getRoots();
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
      if (!rootIterator) {
        console.error("getRoots interface returns an undefined object");
        return;
      }
      while (!isDone) {
        let result = rootIterator.next();
        console.log("next result = " + JSON.stringify(result));
        isDone = result.done;
        if (!isDone)
          rootinfos.push(result.value);
      }
    } catch (error) {
      console.error("getRoots failed, error " + error);
    }
  }
  ```

## RootInfo.listfile

listFile(filter?: Filter) : FileIterator

179
以同步方法从某设备根节点开始,基于过滤器,获取第一级符合条件的文件(夹)信息的迭代器对象FileIterator,然后通过[next](#fileiteratornext)方法返回[FileInfo](#fileinfo)
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209

**系统能力**:SystemCapability.FileManagement.UserFileService

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

**参数:**

  | 参数名 | 类型 | 必填 | 说明 |
  | --- | --- | -- | -- |
  | filter | Filter | 否 | 过滤器对象  |


**返回值:**

  | 类型 | 说明 |
  | --- | -- |
  | FileIterator | 文件(夹)信息的迭代器对象FileIterator |

**示例:**

  ```js
  // rootinfos 从getRoots()获取
  // let filter = {suffix : [".txt", ".jpg", ".xlsx"]};
  let rootInfo = rootinfos[0];
  let fileInfos = [];
  let isDone = false;
  try {
    let fileIterator = rootInfo.listFile();
    // 含过滤器实现的listFile
    // let fileIterator = rootInfo.listFile(filter);
O
onexiaomin 已提交
210
    if (!fileIterator) {
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
      console.error("listFile interface returns an undefined object");
      return;
    }
    while (!isDone) {
      let result = fileIterator.next();
      console.log("next result = " + JSON.stringify(result));
      isDone = result.done;
      if (!isDone)
        fileInfos.push(result.value);
    }
  } catch (error) {
    console.log("listFile failed, error " + error);
  }
  ```

## RootInfo.scanFile

scanFile(filter?: Filter) : FileIterator

230
以同步方法从某设备根节点开始,基于过滤器,递归获取符合条件的文件信息的迭代器对象FileIterator,然后通过[next](#fileiteratornext)方法返回[FileInfo](#fileinfo)
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259

**系统能力**:SystemCapability.FileManagement.UserFileService

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

**参数:**

  | 参数名 | 类型 | 必填 | 说明 |
  | --- | --- | -- | -- |
  | filter | Filter | 否 | 过滤器对象  |

**返回值:**

  | 类型 | 说明 |
  | --- | -- |
  | FileIterator | 文件信息的迭代器对象FileIterator |

**示例:**

  ```js
  // rootinfos 从 getRoots()获取
  // let filter = {suffix : [".txt", ".jpg", ".xlsx"]};
  let rootInfo = rootinfos[0];
  let fileInfos = [];
  let isDone = false;
  try {
      let fileIterator = rootInfo.scanFile();
      // 含过滤器实现的scanFile
      // let fileIterator = rootInfo.scanFile(filter);
O
onexiaomin 已提交
260
      if (!fileIterator) {
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
        console.error("scanFile interface returns undefined object");
        return;
      }
      while (!isDone) {
        let result = fileIterator.next();
        console.log("next result = " + JSON.stringify(result));
        isDone = result.done;
        if (!isDone)
          fileInfos.push(result.value);
      }
  } catch (error) {
    console.error("scanFile failed, error " + error);
  }
  ```

## FileInfo.listfile

listFile(filter?: Filter) : FileIterator

280
以同步方法从某个目录,基于过滤器,获取下一级符合条件的文件(夹)信息的迭代器对象FileIterator,然后通过[next](#fileiteratornext)方法返回[FileInfo](#fileinfo)
281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309

**系统能力**:SystemCapability.FileManagement.UserFileService

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

**参数:**

  | 参数名 | 类型 | 必填 | 说明 |
  | --- | --- | -- | -- |
  | filter | Filter | 否 | 过滤器对象  |

**返回值:**

  | 类型 | 说明 |
  | --- | -- |
  | FileIterator | 文件(夹)信息的迭代器对象FileIterator |

**示例:**

  ```js
  // fileInfoDir 表示某个目录信息
  // let filter = { suffix : [".txt", ".jpg", ".xlsx"] };
  let fileInfoDir = fileInfos[0];
  let subfileInfos = [];
  let isDone = false;
  try {
    let fileIterator = fileInfoDir.listFile();
    // 含过滤器实现的listFile
    // let fileIterator = rootInfo.listFile(filter);
O
onexiaomin 已提交
310
    if (!fileIterator) {
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329
      console.error("listFile interface returns an undefined object");
      return;
    }
    while (!isDone) {
      let result = fileIterator.next();
      console.log("next result = " + JSON.stringify(result));
      isDone = result.done;
      if (!isDone)
        subfileInfos.push(result.value);
    }
  } catch (error) {
    console.error("listFile failed, error " + error);
  }
  ```

## FileInfo.scanfile

scanFile(filter?: Filter) : FileIterator;

330
以同步方法从某个目录,基于过滤器,递归获取符合条件的文件信息的迭代器对象FileIterator,然后通过[next](#fileiteratornext)方法返回[FileInfo](#fileinfo)
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

**系统能力**:SystemCapability.FileManagement.UserFileService

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

**参数:**

  | 参数名 | 类型 | 必填 | 说明 |
  | --- | --- | -- | -- |
  | filter | Filter | 否 | 过滤器对象  |


**返回值:**

  | 类型 | 说明 |
  | --- | -- |
  | FileIterator | 文件信息的迭代器对象FileIterator |

**示例:**

  ```js
  // fileInfoDir 表示某个目录信息
  // let filter = {suffix : [".txt", ".jpg", ".xlsx"]};
  let fileInfoDir = fileInfos[0];
  let subfileInfos = [];
  let isDone = false;
  try {
    let fileIterator = fileInfoDir.scanFile();
    // 含过滤器实现的scanFile
    // let fileIterator = rootInfo.scanFile(filter);
O
onexiaomin 已提交
361
    if (!fileIterator) {
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
      console.error("scanFile interface returns an undefined object");
      return;
    }
    while (!isDone) {
      let result = fileIterator.next();
      console.error("next result = " + JSON.stringify(result));
      isDone = result.done;
      if (!isDone)
        subfileInfos.push(result.value);
    }
  } catch (error) {
    console.error("scanFile-filter failed, error " + error);
  }
  ```

## FileAccessHelper.createFile

createFile(uri: string, displayName: string) : Promise<string>

以异步方法创建文件到指定目录,返回新文件uri。使用Promise异步回调。

**系统能力**:SystemCapability.FileManagement.UserFileService

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

**参数:**

  | 参数名 | 类型 | 必填 | 说明 |
  | --- | --- | --- | -- |
  | uri | string | 是 | 表示需要创建文件的父目录的Uri |
  | displayName | string | 是 | 待创建文件的名称,本地文件需要添加后缀,共享盘不要求|

**返回值:**

| 类型 | 说明 |
| --- | -- |
| Promise<string> | 新创建的文件的uri |

**示例:**

  ```js
O
onexiaomin 已提交
403 404 405 406
  // 以媒体库uri为例
  // 示例代码sourceUri表示Download目录,该uri是对应的fileInfo中uri
  // 开发者应根据自己实际获取的uri进行开发
  let sourceUri = "datashare:///media/file/6";
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446
  let displayName = "file1"
  let fileUri = null;
  try {
    fileUri = await fileAccessHelper.createFile(sourceUri, displayName)
    if (!fileUri) {
      console.error("createFile return undefined object");
      return;
    }
    console.log("createFile sucess, fileUri: " + JSON.stringify(fileUri));
  } catch (error) {
    console.error("createFile failed, error " + error);
  };
  ```

## FileAccessHelper.mkDir

mkDir(parentUri: string, displayName: string) : Promise<string>

以异步方法创建文件夹到指定目录,返回文件夹uri。使用Promise异步回调。

**系统能力**:SystemCapability.FileManagement.UserFileService

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

**参数:**

  | 参数名 | 类型 | 必填 | 说明 |
  | --- | --- | --- | -- |
  | parentUri | string | 是 | 表示需要创建文件夹的父目录的Uri |
  | displayName | string | 是 | 待创建文件夹的名称|

**返回值:**

| 类型 | 说明 |
| --- | -- |
| Promise<string> | 新创建的文件夹的uri |

**示例:**

  ```js
O
onexiaomin 已提交
447 448 449 450
  // 以媒体库uri为例
  // 示例代码sourceUri表示Download目录,该uri是对应的fileInfo中uri
  // 开发者应根据自己实际获取的uri进行开发
  let sourceUri = "datashare:///media/file/6";
451 452 453
  let dirName = "dirTest"
  let dirUri = null;
  try {
O
onexiaomin 已提交
454
    dirUri = await fileAccessHelper.mkDir(sourceUri, dirName)
455 456 457 458
    if (!dirUri) {
      console.error("mkDir return undefined object");
      return;
    }
O
onexiaomin 已提交
459
    console.log("mkDir sucess, dirUri: " + JSON.stringify(dirUri));
460 461 462 463 464 465 466
  } catch (error) {
    console.error("mkDir failed, error " + error);
  };
  ```

## FileAccessHelper.openFile

O
onexiaomin 已提交
467
openFile(uri: string, flags: OPENFLAGS) : Promise<number>
468 469 470 471 472 473 474 475 476 477 478 479

以异步方法打开文件,返回文件句柄。使用Promise异步回调。

**系统能力**:SystemCapability.FileManagement.UserFileService。

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

**参数:**

  | 参数名 | 类型 | 必填 | 说明 |
  | --- | --- | --- | -- |
  | uri | string | 是 | 待打开文件的uri |
O
onexiaomin 已提交
480
  | flags | [OPENFLAGS](#openflags) | 是 | 文件打开的标志 |
481 482 483 484 485 486 487 488 489 490

**返回值:**

| 类型 | 说明 |
| --- | -- |
| Promise<number&gt | 文件句柄 |

**示例:**

  ```js
O
onexiaomin 已提交
491 492 493 494
  // 以媒体库uri为例
  // 示例代码targetUri表示Download目录下文件,该uri是对应的fileInfo中uri
  // 开发者应根据自己实际获取的uri进行开发
  let targetUri  = "datashare:///media/file/100";
495 496
  try {
    let fd = await fileAccessHelper.openFile(targetUri, OPENFLAGS.READ);
O
onexiaomin 已提交
497
  } catch (error) {
498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526
    console.error("openFile failed, error " + error);
  };
  ```

## FileAccessHelper.delete

delete(uri: string) : Promise<number>

以异步方法删除文件(夹),返回错误码。使用Promise异步回调。

**系统能力**:SystemCapability.FileManagement.UserFileService。

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

**参数:**

  | 参数名 | 类型 | 必填 | 说明 |
  | --- | --- | --- | -- |
  | uri | string | 是 | 待删除文件(夹)的uri |

**返回值:**

| 类型 | 说明 |
| --- | -- |
| Promise<number&gt | 删除操作的错误码 |

**示例:**

  ```js
O
onexiaomin 已提交
527 528 529 530
  // 以媒体库uri为例
  // 示例代码targetUri表示Download目录下文件,该uri是对应的fileInfo中uri
  // 开发者应根据自己实际获取的uri进行开发
  let targetUri = "datashare:///media/file/100";
531 532 533 534
  try {
    let code = await fileAccessHelper.delete(targetUri);
    if (code != 0)
      console.error("delete failed, code " + code);
O
onexiaomin 已提交
535
  } catch (error) {
536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
    console.error("delete failed, error " + error);
  };
  ```

## FileAccessHelper.move

move(sourceFile: string, destFile: string) : Promise<string>

以异步方法移动文件(夹),返回移动后文件(夹)的uri。使用Promise异步回调。

**系统能力**:SystemCapability.FileManagement.UserFileService。

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

**参数:**

  | 参数名 | 类型 | 必填 | 说明 |
  | --- | --- | --- | -- |
  | sourceFile | string | 是 | 待移动的源文件(夹)的uri |
  | destFile | string | 是 | 目标文件夹的uri |

**返回值:**

| 类型 | 说明 |
| ----- | ------ |
| Promise<string> | 新路径下的文件(夹)的uri |

**示例:**

  ```js
O
onexiaomin 已提交
566 567 568 569 570
  // 以媒体库uri为例
  // 示例代码sourceFile destFile表示Download目录下文件或文件夹,该uri是对应的fileInfo中uri
  // 开发者应根据自己实际获取的uri进行开发
  let sourceFile = "datashare:///media/file/102";
  let destFile = "datashare:///media/file/101";
571 572 573
  try {
    let fileUri = await fileAccessHelper.move(sourceFile, destFile);
    console.log("move sucess, fileUri: " + JSON.stringify(fileUri));
O
onexiaomin 已提交
574
  } catch (error) {
575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604
    console.error("move failed, error " + error);
  };
  ```

## FileAccessHelper.rename

rename(uri: string, displayName: string) : Promise<string>

以异步方法重命名文件(夹),返回重命名后的文件(夹)的Uri。使用Promise异步回调。

**系统能力**:SystemCapability.FileManagement.UserFileService。

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

**参数:**

  | 参数名 | 类型 | 必填 | 说明 |
  | --- | --- | --- | -- |
  | uri | string | 是 | 源文件(夹)的uri |
  | displayName | string | 是 | 文件(夹)名,支持带后缀 |

**返回值:**

| 类型 | 说明 |
| --- | -- |
| Promise<string> | 重命名后的文件(夹)的uri |

**示例:**

  ```js
O
onexiaomin 已提交
605 606 607 608
  // 以媒体库uri为例
  // 示例代码sourceDir表示Download目录下文件,该uri是对应的fileInfo中uri
  // 开发者应根据自己实际获取的uri进行开发
  let sourceDir = "datashare:///media/file/100";
609 610 611
  try {
    let DestDir = await fileAccessHelper.rename(sourceDir, "testDir");
    console.log("rename sucess, DestDir: " + JSON.stringify(DestDir));
O
onexiaomin 已提交
612
  } catch (error) {
613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641
    console.error("rename failed, error " + error);
  };
  ```

## FileAccessHelper.access

access(sourceFileUri: string) : Promise<boolean>

以异步方法判断文件(夹)是否存在。使用Promise异步回调。

**系统能力**:SystemCapability.FileManagement.UserFileService。

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

**参数:**

  | 参数名 | 类型 | 必填 | 说明 |
  | --- | --- | --- | -- |
  | sourceFileUri | string | 是 | 文件(夹)的uri |

**返回值:**

| 类型 | 说明 |
| --- | -- |
| Promise<boolean> | 文件(夹)是否存在 |

**示例:**

  ```js
O
onexiaomin 已提交
642 643 644 645
  // 以媒体库uri为例
  // 示例代码sourceDir表示Download目录下文件,该uri是对应的fileInfo中uri
  // 开发者应根据自己实际获取的uri进行开发
  let sourceDir = "datashare:///media/file/100";
646 647 648 649 650 651
  try {
    let existJudgment = await fileAccessHelper.access(sourceDir);
    if (existJudgment)
      console.log("sourceDir exists");
    else
      console.log("sourceDir does not exist");
O
onexiaomin 已提交
652
  } catch (error) {
653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735
    console.error("rename failed, error " + error);
  };
  ```

## RootIterator.next

next( ) : { value: RootInfo, done: boolean }

RootIterator表示设备根目录的迭代器对象,可以通过next同步方法获取下一级设备根目录。

**系统能力**:SystemCapability.FileManagement.UserFileService。

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

**返回值:**

| 类型 | 说明 |
| --- | -- |
| {value: RootInfo, done: boolean} | 通过next遍历文件夹,直到done返回true结束;value字段返回rootInfo。|

## FileIterator.next

next( ) : { value: FileInfo, done: boolean }

FileIterator表示文件夹的迭代器对象,可以通过next同步方法获取下一级文件(夹)信息。

**系统能力**:SystemCapability.FileManagement.UserFileService。

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

**返回值:**

| 类型 | 说明 |
| --- | -- |
| {value: FileInfo, done: boolean} | 通过next遍历文件夹,直到done返回true结束;value字段返回fileInfo。|

## RootInfo

表示设备的根属性信息和接口能力。

**系统能力**:SystemCapability.FileManagement.UserFileService。

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

### 属性

| 名称 | 类型   | 可读 | 可写 | 说明     |
| ------ | ------ | -------- | ------ | -------- |
| deviceType | number | 是 | 否 |设备类型 |
| uri | string | 是 | 否 | 设备根目录Uri |
| displayName | string | 是 | 否 | 设备名称 |
| deviceFlags | number | 是 | 否 | 设备支持的能力 |

## FileInfo

表示文件(夹)属性信息和接口能力。

**系统能力**:SystemCapability.FileManagement.UserFileService。

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

### 属性

| 名称 | 类型   | 可读 | 可写 | 说明     |
| ------ | ------ | -------- | ------ | -------- |
| uri | string | 是 | 否 | 文件(夹)的uri |
| fileName | string | 是 | 否 | 文件(夹)的名称 |
| mode | number | 是 | 否 | 文件(夹)的权限信息 |
| size | number | 是 | 否 |  文件(夹)的大小 |
| mtime | number | 是 | 否 |  文件(夹)的修改时间 |
| mimeType | string | 是 | 否 |  文件(夹)的媒体资源类型 |

## OPENFLAGS

目前支持的文件打开的标志位。

**系统能力:** SystemCapability.FileManagement.UserFileService

| 名称 | 值 | 说明 |
| ----- | ------ | ------ |
| READ | 0o0 | 读模式。 |
| WRITE | 0o1 | 写模式。 |
| WRITE_READ | 0o2 | 读写模式。 |