User File Access and Management

The fileManager module provides APIs for accessing and managing user files. It interworks with the underlying file management services to implement media library and external card management, and provides capabilities for applications to query and create user files.

NOTE

• The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.
• The APIs of this module are system APIs and cannot be called by third-party applications. Currently, these APIs can be called only by filepicker.

Modules to Import

import filemanager from '@ohos.fileManager';

filemanager.getRoot

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

Obtains information about the root album or directory in asynchronous mode. This API uses a promise to return the result.

System capability: SystemCapability.FileManagement.UserFileService

Parameters

Return value

Example

filemanager.getRoot().then((fileInfos) => {
  for (var i = 0; i < fileInfos.length; i++) {
      console.log("files:"+JSON.stringify(fileInfos));
  }
}).catch((err) => {
    console.log(err)
});

filemanager.getRoot

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

Obtains information about the root album or directory in asynchronous mode. This API uses a callback to return the result.

System capability: SystemCapability.FileManagement.UserFileService

Parameters

Example

let options = {
  "dev":{
    "name":"local"
  }
};
filemanager.getRoot(options, (err, fileInfos)=>{
  for (var i = 0; i < fileInfos.length; i++) {
      console.log("files:"+JSON.stringify(fileInfos));
  }
});

filemanager.listFile

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

Obtains information about the second-level album or files in asynchronous mode. This API uses a promise to return the result.

System capability: SystemCapability.FileManagement.UserFileService

Parameters

Return value

Error

Example

// Obtain all files in the directory. You can use getRoot to obtain the directory URI.
filemanager.getRoot().then((fileInfos) => {
  let file = fileInfos.find(item => item.name == "file_folder");
  let path = file.path;
  filemanager.listFile(path, "file").then((files) => {
      console.log("files:" + JSON.stringify(files));
    }).catch((err) => {
      console.log("failed to get files" + err);
    });
}).catch((err) => {
    console.log("failed to get root" + err);
});

filemanager.listFile

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

Obtains information about the second-level album or files in asynchronous mode. This API uses a callback to return the result.

System capability: SystemCapability.FileManagement.UserFileService

Parameters

Error

Example

// Obtain all files in the directory. You can use getRoot to obtain the directory URI.
filemanager.getRoot().then((fileInfos) => {
  let file = fileInfos.find(item => item.name == "image_album");
  let path = file.path;
  filemanager.listFile(path, "image",function(err, files){
    console.log("files:" + JSON.stringify(files));
  })
}).catch((err) => {
    console.log("failed to get root" + err);
});

filemanager.createFile

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

Creates a file in the specified path in asynchronous mode. This API uses a promise to return the result.

System capability: SystemCapability.FileManagement.UserFileService

Parameters

Return value

Error

Example

// Create a file.
let media_path = "" // Obtain the file URI using listFile() and getRoot().
let name = "xxx.jpg" // File to be saved.
filemanager.createFile(media_path, name).then((uri) => {
    // The URI of the file created is returned.
    console.log("file uri:"+uri);
}).catch((err) => {
    console.log(err);
});

filemanager.createFile

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

Creates a file in the specified path in asynchronous mode. This API uses a callback to return the result.

System capability: SystemCapability.FileManagement.UserFileService

Parameters

Error

Example

// Create a file.
// Call listFile() and getRoot() to obtain the file URI.
let media_path = ""
// File to be saved.
let name = "xxx.jpg"
let options = {
  "dev":{
    "name":"local"
  }
};
filemanager.createFile(media_path, name, options, function(err, uri) {
  // The URI of the file created is returned.
  console.log("file uri:"+uri);
});

FileInfo

Defines the file information returned by getRoot() or listFile().

System capability: SystemCapability.FileManagement.UserFileService

Attributes

DevInfo

Defines the device type.

System capability: SystemCapability.FileManagement.UserFileService

Attributes