公共文件访问与管理

说明：

• 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
• 本模块接口为系统接口，三方应用不支持调用，当前只支持filepicker调用。

该模块提供公共文件访问和管理的服务接口，向下对接底层文件管理服务，如媒体库、外卡管理；向上对应用程序提供公共文件查询、创建的能力。

导入模块

import filemanager from '@ohos.fileManager';

filemanager.getRoot

getRoot(options? : {dev? : DevInfo}) : Promise<FileInfo[]>

以异步方法获取第一层相册，目录信息。使用promise形式返回结果。

系统能力：SystemCapability.FileManagement.FileManagerService

• 参数

• 返回值

• 示例

  filemanager.getRoot().then((fileInfo) => {
      if(Array.isArray(fileInfo)) {
          for (var i = 0; i < fileInfo.length; i++) {
              console.log("file:"+JSON.stringify(fileInfo));
          }
      }
  }).catch((err) => {
      console.log(err)
  });
  

filemanager.getRoot

getRoot(options? : {dev? : DevInfo}, callback : AsyncCallback<FileInfo[]>) : void

以异步方法获取第一层相册，目录信息。使用callback形式返回结果。

系统能力：SystemCapability.FileManagement.FileManagerService

• 参数

• 示例

  filemanager.getRoot((err, fileInfo) => {
      if(Array.isArray(fileInfo)) {
          for (var i = 0; i < fileInfo.length; i++) {
              console.log("file:"+JSON.stringify(fileInfo));
          }
      }
  });
  

filemanager.listFile

listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : number, count? : number}) : Promise<FileInfo[]>

以异步方法获取第二层相册，文件信息。使用promise形式返回结果。

系统能力：SystemCapability.FileManagement.FileManagerService

• 参数

• 返回值

• 异常

• 示例

  // 获取目录下所有文件
  // 通过listFile、getRoot获取的文件uri
  let media_path = file.uri
  filemanager.listFile(media_path, "file")
  .then((fileInfo) => {
      if(Array.isArray(fileInfo)) {
          for (var i = 0; i < fileInfo.length; i++) {
              console.log("file:"+JSON.stringify(fileInfo));
          }
      }
  }).catch((err) => {
      console.log(err)
  });
  

filemanager.listFile

listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : number, count? : number}, callback : AsyncCallback<FileInfo[]>) : void

以异步方法获取第二层相册，文件信息。使用callback形式返回结果。

系统能力：SystemCapability.FileManagement.FileManagerService

• 参数

• 异常

• 示例

  // 通过listFile、getRoot获取的文件uri
  let media_path = file.uri
  filemanager.listFile(media_path, "file", (err, fileInfo) => {
      if(Array.isArray(fileInfo)) {
          for (var i = 0; i < fileInfo.length; i++) {
              console.log("file:"+JSON.stringify(fileInfo));
          }
      }
  });
  

filemanager.createFile

createFile(path : string, filename : string, options? : {dev? : DevInfo}) : Promise<string>

以异步方法创建文件到指定路径，返回文件uri。使用promise形式返回结果。

系统能力：SystemCapability.FileManagement.FileManagerService

• 参数

• 返回值

• 异常

• 示例

  // 创建文件，返回文件uri
  let media_path = file.uri // 通过listFile、getRoot获取的文件uri
  let name = "xxx.jpg" // 待保存文件的后缀
  filemanager.createFile(media_path, name).then((uri) => {
      // 返回uri给应用
      console.log("file uri:"+uri);
  }).catch((err) => {
      console.log(err);
  });
  

filemanager.createFile

createFile(path : string, filename: string, options? : {dev? : DevInfo}, callback : AsyncCallback<string>) : void

以异步方法创建文件到指定路径，返回文件uri。使用callback形式返回结果。

系统能力：SystemCapability.FileManagement.FileManagerService

• 参数

• 异常

• 示例

  // 创建文件，返回文件uri
  // 通过listFile、getRoot获取的文件uri
  let media_path = file.uri
  // 待保存文件的后缀
  let name = "xxx.jpg"
  filemanager.createFile(media_path, name, (err, uri) => {
      // 返回uri给应用
      console.log("file uri:"+uri);
  });
  

FileInfo

文件信息类型，通过getRoot, listFile等接口返回的类型。

系统能力：以下各项对应的系统能力均为SystemCapability.FileManagement.FileManagerService。

属性

DevInfo

设备类型，配置接口访问的设备类型。

系统能力：以下各项对应的系统能力均为SystemCapability.FileManagement.FileManagerService。

属性