@ohos.file.fileAccess (User File Access and Management)

The fileAccess module provides a framework for accessing and operating user files based on the ExtensionAbility mechanism. This module interacts with file management services, such as the media library and external storage management service, and provides a set of unified interfaces for system applications to access and manage files. The media library service allows access to user files on local and distributed devices. The external storage management service allows access to the user files stored on devices, such as shared disks, USB flash drives, and SD cards.

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 provided by this module are system APIs and cannot be called by third-party applications. Currently, the APIs can be called only by FilePicker and FileManager.

Modules to Import

import fileAccess from '@ohos.file.fileAccess';

fileAccess.getFileAccessAbilityInfo

getFileAccessAbilityInfo() : Promise<Array<Want>>

Obtains information about all Wants with extension set to fileAccess in the system. A Want contains information for starting an ability. This API uses a promise to return the result.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.FileManagement.UserFileService

Required permissions: ohos.permission.FILE_ACCESS_MANAGER and ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

Return value

Error codes

For details about error codes, see File Management Error Codes.

Example

async getFileAccessAbilityInfo() {
  let wantInfos = [];
  try {
    wantInfos = await fileAccess.getFileAccessAbilityInfo();
    console.log("getFileAccessAbilityInfo data " + JSON.stringify(wantInfos));
  } catch (error) {
    console.error("getFileAccessAbilityInfo failed, errCode:" + error.code + ", errMessage:" + error.message);
  }
}

fileAccess.getFileAccessAbilityInfo

getFileAccessAbilityInfo(callback: AsyncCallback<Array<Want>>): void

Obtains information about all Wants with extension set to fileAccess in the system. A Want contains information for starting an ability. This API uses an asynchronous callback to return the result.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.FileManagement.UserFileService

Required permissions: ohos.permission.FILE_ACCESS_MANAGER and ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

Parameters

Error codes

For details about error codes, see File Management Error Codes.

Example

async getFileAccessAbilityInfo() {
  try {
    fileAccess.getFileAccessAbilityInfo(function (err, wantInfos) {
      if (err) {
        console.error("Failed to getFileAccessAbilityInfo in async, errCode:" + err.code + ", errMessage:" + err.message);
        return;
      }
      console.log("getFileAccessAbilityInfo data " + JSON.stringify(wantInfos));
    });
  } catch (error) {
    console.error("getFileAccessAbilityInfo failed, errCode:" + error.code + ", errMessage:" + error.message);
  }
}

fileAccess.createFileAccessHelper

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

Synchronously creates a Helper object to connect to the specified wants. The Helper object provides file access and management capabilities.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.FileManagement.UserFileService

Required permissions: ohos.permission.FILE_ACCESS_MANAGER and ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

Parameters

Return value

Error codes

For details about error codes, see File Management Error Codes.

Example

createFileAccessHelper() {
  let fileAccessHelper = null;
  / / Obtain wantInfos by using getFileAccessAbilityInfo().
  // Create a helper object to interact with the media library service only.
  let wantInfos = [
    {
      "bundleName": "com.ohos.medialibrary.medialibrarydata",
      "abilityName": "FileExtensionAbility",
    },
  ]
  try {
    // this.context is passed by EntryAbility.
    fileAccessHelper = fileAccess.createFileAccessHelper(this.context, wantInfos);
    if (!fileAccessHelper)
      console.error("createFileAccessHelper interface returns an undefined object");
  } catch (error) {
    console.error("createFileAccessHelper failed, errCode:" + error.code + ", errMessage:" + error.message);
  }
}

fileAccess.createFileAccessHelper

createFileAccessHelper(context: Context) : FileAccessHelper

Synchronously creates a Helper object to connect to all file management services in the system.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.FileManagement.UserFileService

Required permissions: ohos.permission.FILE_ACCESS_MANAGER and ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

Parameters

Return value

Error codes

For details about error codes, see File Management Error Codes.

Example

createFileAccessHelper() {
  let fileAccessHelperAllServer = null;
  // Create a Helper object to interact with all file management services configured with fileAccess in the system.
  try {
    // this.context is passed by EntryAbility.
    fileAccessHelperAllServer = fileAccess.createFileAccessHelper(this.context);
    if (!fileAccessHelperAllServer)
      console.error("createFileAccessHelper interface returns an undefined object");
  } catch (error) {
    console.error("createFileAccessHelper failed, errCode:" + error.code + ", errMessage:" + error.message);
  }
}

FileInfo

Provides the file or directory attribute information and APIs.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.FileManagement.UserFileService

Required permissions: ohos.permission.FILE_ACCESS_MANAGER

Attributes

listFile

listFile(filter?: Filter) : FileIterator

Synchronously obtains a FileIterator object that lists the next-level files (directories) matching the conditions of the filter from a directory and returns FileInfo using next(). Currently, only built-in storage devices support the file filter.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.FileManagement.UserFileService

Required permissions: ohos.permission.FILE_ACCESS_MANAGER

Parameters

Return value

Error codes

For details about error codes, see File Management Error Codes.

Example

// fileInfoDir indicates information about a directory.
// let filter = { suffix : [".txt", ".jpg", ".xlsx"] };
let fileInfoDir = fileInfos[0];
let subfileInfos = [];
let isDone = false;
try {
  let fileIterator = fileInfoDir.listFile();
  // listFile() with the filter implementation.
  // let fileIterator = rootInfo.listFile(filter);
  if (!fileIterator) {
    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, errCode:" + error.code + ", errMessage:" + error.message);
}

scanFile

scanFile(filter?: Filter) : FileIterator

Synchronously obtains a FileIterator object that recursively retrieves the files matching the conditions of the filter from a directory and returns FileInfo using next(). Currently, this API supports only built-in storage devices.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.FileManagement.UserFileService

Required permissions: ohos.permission.FILE_ACCESS_MANAGER

Parameters

Return value

Error codes

For details about error codes, see File Management Error Codes.

Example

// fileInfoDir indicates information about a directory.
// let filter = {suffix : [".txt", ".jpg", ".xlsx"]};
let fileInfoDir = fileInfos[0];
let subfileInfos = [];
let isDone = false;
try {
  let fileIterator = fileInfoDir.scanFile();
  // scanFile() with the filter implementation.
  // let fileIterator = rootInfo.scanFile(filter);
  if (!fileIterator) {
    console.error("scanFile 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("scanFile failed, errCode:" + error.code + ", errMessage:" + error.message);
}

FileIterator

Provides the FileIterator object.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.FileManagement.UserFileService

Required permissions: ohos.permission.FILE_ACCESS_MANAGER

next

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

Obtains information about the next-level files or directories.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.FileManagement.UserFileService

Required permissions: ohos.permission.FILE_ACCESS_MANAGER

Return value

Error codes

For details about error codes, see File Management Error Codes.

RootInfo

Provides the device's root attribute information and APIs.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.FileManagement.UserFileService

Required permissions: ohos.permission.FILE_ACCESS_MANAGER

Attributes

listFile

listFile(filter?: Filter) : FileIterator

Synchronously obtains a FileIterator object that lists the first-level files (directories) matching the conditions of the filter from the device root directory and returns FileInfo using next(). Currently, only built-in storage devices support the file filter.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.FileManagement.UserFileService

Required permissions: ohos.permission.FILE_ACCESS_MANAGER

Parameters

Return value

Error codes

For details about error codes, see File Management Error Codes.

Example

// Obtain rootInfos by using getRoots().
// let filter = {suffix : [".txt", ".jpg", ".xlsx"]};
let rootInfo = rootinfos[0];
let fileInfos = [];
let isDone = false;
try {
  let fileIterator = rootInfo.listFile();
  // listFile() with the filter implementation.
  // let fileIterator = rootInfo.listFile(filter);
  if (!fileIterator) {
    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.error("listFile failed, errCode:" + error.code + ", errMessage:" + error.message);
}

scanFile

scanFile(filter?: Filter) : FileIterator

Synchronously obtains a FileIterator object that recursively retrieves the files matching the conditions of the filter from the device root directory and returns FileInfousing next(). Currently, this API supports only built-in storage devices.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.FileManagement.UserFileService

Required permissions: ohos.permission.FILE_ACCESS_MANAGER

Parameters

Return value

Error codes

For details about error codes, see File Management Error Codes.

Example

// Obtain rootInfos by using getRoots().
// let filter = {suffix : [".txt", ".jpg", ".xlsx"]};
let rootInfo = rootInfos[0];
let fileInfos = [];
let isDone = false;
try {
  let fileIterator = rootInfo.scanFile();
  // scanFile with the filter implementation.
  // let fileIterator = rootInfo.scanFile(filter);
  if (!fileIterator) {
    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, errCode:" + error.code + ", errMessage:" + error.message);
}

RootIterator

Provides an iterator object of the device root directory.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.FileManagement.UserFileService

Required permissions: ohos.permission.FILE_ACCESS_MANAGER

next

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

Obtains the root directory of the next-level device.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.FileManagement.UserFileService

Required permissions: ohos.permission.FILE_ACCESS_MANAGER

Return value

Error codes

For details about error codes, see File Management Error Codes.

FileAccessHelper

Provides a FileAccessHelper object.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.FileManagement.UserFileService

Required permissions: ohos.permission.FILE_ACCESS_MANAGER

getRoots

getRoots() : Promise<RootIterator>

Obtains information about the device root nodes of the file management service connected to the Helper object. This API uses a promise to return a RootIterator object, which returns RootInfo by using next.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.FileManagement.UserFileService

Required permissions: ohos.permission.FILE_ACCESS_MANAGER

Return value

Error codes

For details about error codes, see File Management Error Codes.

Example

async getRoots() {
  let rootIterator = null;
  let rootinfos = [];
  let isDone = false;
  try {
    // Obtain fileAccessHelper by referring to the sample code of fileAccess.createFileAccessHelper.
    rootIterator = await fileAccessHelper.getRoots();
    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, errCode:" + error.code + ", errMessage:" + error.message);
  }
}

getRoots

getRoots(callback:AsyncCallback<RootIterator>) : void

Obtains information about the device root nodes of the file management service connected to the Helper object. This API uses an asynchronous callback to return a RootIterator object, which returns RootInfo by using next.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.FileManagement.UserFileService

Required permissions: ohos.permission.FILE_ACCESS_MANAGER

Parameters

Error codes

For details about error codes, see File Management Error Codes.

Example

async getRoots() {
  let rootinfos = [];
  let isDone = false;
  try {
    // Obtain fileAccessHelper by referring to the sample code of fileAccess.createFileAccessHelper.
    fileAccessHelper.getRoots(function (err, rootIterator) {
      if (err) {
        console.error("Failed to getRoots in async, errCode:" + err.code + ", errMessage:" + err.message);
        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, errCode:" + error.code + ", errMessage:" + error.message);
  }
}

createFile

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

Creates a file in a directory. This API uses a promise to return the result.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.FileManagement.UserFileService

Required permissions: ohos.permission.FILE_ACCESS_MANAGER

Parameters

Return value

Error codes

For details about error codes, see File Management Error Codes.

Example

// The media library URI is used as an example.
// In the sample code, sourceUri indicates the Download directory. The URI is the URI in fileInfo.
// You can use the URI obtained.
let sourceUri = "datashare:///media/file/6";
let displayName = "file1"
let fileUri = null;
try {
  // Obtain fileAccessHelper by referring to the sample code of fileAccess.createFileAccessHelper.
  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, errCode:" + error.code + ", errMessage:" + error.message);
};

createFile

createFile(uri: string, displayName: string, callback: AsyncCallback<string>) : void

Creates a file in a directory. This API uses an asynchronous callback to return the result.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.FileManagement.UserFileService

Required permissions: ohos.permission.FILE_ACCESS_MANAGER

Parameters

Error codes

For details about error codes, see File Management Error Codes.

Example

// The media library URI is used as an example.
// In the sample code, sourceUri indicates the Download directory. The URI is the URI in fileInfo.
// You can use the URI obtained.
let sourceUri = "datashare:///media/file/6";
let displayName = "file1"
try {
  // Obtain fileAccessHelper by referring to the sample code of fileAccess.createFileAccessHelper.
  fileAccessHelper.createFile(sourceUri, displayName, function (err, fileUri) {
    if (err) {
      console.error("Failed to createFile in async, errCode:" + err.code + ", errMessage:" + err.message);
      return;
    }
    console.log("createFile sucess, fileUri: " + JSON.stringify(fileUri));
  });
} catch (error) {
  console.error("createFile failed, errCode:" + error.code + ", errMessage:" + error.message);
};

mkDir

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

Creates a directory. This API uses a promise to return the result.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.FileManagement.UserFileService

Required permissions: ohos.permission.FILE_ACCESS_MANAGER

Parameters

Return value

Error codes

For details about error codes, see File Management Error Codes.

Example

// The media library URI is used as an example.
// In the sample code, sourceUri indicates the Download directory. The URI is the URI in fileInfo.
// You can use the URI obtained.
let sourceUri = "datashare:///media/file/6";
let dirName = "dirTest"
let dirUri = null;
try {
  // Obtain fileAccessHelper by referring to the sample code of fileAccess.createFileAccessHelper.
  dirUri = await fileAccessHelper.mkDir(sourceUri, dirName)
  if (!dirUri) {
    console.error("mkDir return undefined object");
    return;
  }
  console.log("mkDir sucess, dirUri: " + JSON.stringify(dirUri));
} catch (error) {
  console.error("mkDir failed, errCode:" + error.code + ", errMessage:" + error.message);
};

mkDir

mkDir(parentUri: string, displayName: string, callback: AsyncCallback<string>) : void

Creates a directory. This API uses an asynchronous callback to return the result.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.FileManagement.UserFileService

Required permissions: ohos.permission.FILE_ACCESS_MANAGER

Parameters

Error codes

For details about error codes, see File Management Error Codes.

Example

// The media library URI is used as an example.
// In the sample code, sourceUri indicates the Download directory. The URI is the URI in fileInfo.
// You can use the URI obtained.
let sourceUri = "datashare:///media/file/6";
let dirName = "dirTest"
try {
  // Obtain fileAccessHelper by referring to the sample code of fileAccess.createFileAccessHelper.
  fileAccessHelper.mkDir(sourceUri, dirName, function (err, dirUri) {
    if (err) {
      console.error("Failed to mkDir in async, errCode:" + err.code + ", errMessage:" + err.message);
      return;
    }
    console.log("mkDir sucess, dirUri: " + JSON.stringify(dirUri));
  });
} catch (error) {
  console.error("mkDir failed, errCode:" + error.code + ", errMessage:" + error.message);
};

openFile

openFile(uri: string, flags: OPENFLAGS) : Promise<number>

Opens a file. This API uses a promise to return the result.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.FileManagement.UserFileService

Required permissions: ohos.permission.FILE_ACCESS_MANAGER

Parameters

Return value

Error codes

For details about error codes, see File Management Error Codes.

Example

// The media library URI is used as an example.
//In the sample code, targetUri indicates a file in the Download directory. The URI is the URI in fileInfo.
// You can use the URI obtained.
let targetUri  = "datashare:///media/file/100";
try {
  // Obtain fileAccessHelper by referring to the sample code of fileAccess.createFileAccessHelper.
  let fd = await fileAccessHelper.openFile(targetUri, fileAccess.OPENFLAGS.READ);
} catch (error) {
  console.error("openFile failed, errCode:" + error.code + ", errMessage:" + error.message);
};

openFile

openFile(uri: string, flags: OPENFLAGS, callback: AsyncCallback<number>) : void

Opens a file. This API uses an asynchronous callback to return the result.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.FileManagement.UserFileService

Required permissions: ohos.permission.FILE_ACCESS_MANAGER

Parameters

Error codes

For details about error codes, see File Management Error Codes.

Example

// The media library URI is used as an example.
//In the sample code, targetUri indicates a file in the Download directory. The URI is the URI in fileInfo.
// You can use the URI obtained.
let targetUri  = "datashare:///media/file/100";
try {
  // Obtain fileAccessHelper by referring to the sample code of fileAccess.createFileAccessHelper.
  fileAccessHelper.openFile(targetUri, fileAccess.OPENFLAGS.READ, function (err, fd) {
    if (err) {
      console.error("Failed to openFile in async, errCode:" + err.code + ", errMessage:" + err.message);
      return;
    }
    console.log("openFile sucess, fd: " + fd);
  });
} catch (error) {
  console.error("openFile failed, errCode:" + error.code + ", errMessage:" + error.message);
};

delete

delete(uri: string) : Promise<number>

Deletes a file or directory. This API uses a promise to return the result.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.FileManagement.UserFileService

Required permissions: ohos.permission.FILE_ACCESS_MANAGER

Parameters

Return value

Error codes

For details about error codes, see File Management Error Codes.

Example

// The media library URI is used as an example.
//In the sample code, targetUri indicates a file in the Download directory. The URI is the URI in fileInfo.
// You can use the URI obtained.
let targetUri = "datashare:///media/file/100";
try {
  // Obtain fileAccessHelper by referring to the sample code of fileAccess.createFileAccessHelper.
  let code = await fileAccessHelper.delete(targetUri);
  if (code != 0)
    console.error("delete failed, code " + code);
} catch (error) {
  console.error("delete failed, errCode:" + error.code + ", errMessage:" + error.message);
};

delete

delete(uri: string, callback: AsyncCallback<number>) : void

Deletes a file or directory. This API uses an asynchronous callback to return the result.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.FileManagement.UserFileService

Required permissions: ohos.permission.FILE_ACCESS_MANAGER

Parameters

Error codes

For details about error codes, see File Management Error Codes.

Example

// The media library URI is used as an example.
//In the sample code, targetUri indicates a file in the Download directory. The URI is the URI in fileInfo.
// You can use the URI obtained.
let targetUri = "datashare:///media/file/100";
try {
  // Obtain fileAccessHelper by referring to the sample code of fileAccess.createFileAccessHelper.
  fileAccessHelper.delete(targetUri, function (err, code) {
    if (err) {
      console.error("Failed to delete in async, errCode:" + err.code + ", errMessage:" + err.message);
      return;
    }
    console.log("delete sucess, code: " + code);
  });
} catch (error) {
  console.error("delete failed, errCode:" + error.code + ", errMessage:" + error.message);
};

move

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

Moves a file or directory. This API uses a promise to return the result. Currently, this API does not support move of files or directories across devices.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.FileManagement.UserFileService

Required permissions: ohos.permission.FILE_ACCESS_MANAGER

Parameters

Return value

Error codes

For details about error codes, see File Management Error Codes.

Example

// The media library URI is used as an example.
//In the sample code, sourceFile destFile indicates the file or directory in the Download directory. The URI is the URI in fileInfo.
// You can use the URI obtained.
let sourceFile = "datashare:///media/file/102";
let destFile = "datashare:///media/file/101";
try {
  // Obtain fileAccessHelper by referring to the sample code of fileAccess.createFileAccessHelper.
  let fileUri = await fileAccessHelper.move(sourceFile, destFile);
  console.log("move sucess, fileUri: " + JSON.stringify(fileUri));
} catch (error) {
  console.error("move failed, errCode:" + error.code + ", errMessage:" + error.message);
};

move

move(sourceFile: string, destFile: string, callback: AsyncCallback<string>) : void

Moves a file or directory. This API uses an asynchronous callback to return the result. Currently, this API does not support move of files or directories across devices.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.FileManagement.UserFileService

Required permissions: ohos.permission.FILE_ACCESS_MANAGER

Parameters

Error codes

For details about error codes, see File Management Error Codes.

Example

// The media library URI is used as an example.
//In the sample code, sourceFile destFile indicates the file or directory in the Download directory. The URI is the URI in fileInfo.
// You can use the URI obtained.
let sourceFile = "datashare:///media/file/102";
let destFile = "datashare:///media/file/101";
try {
  // Obtain fileAccessHelper by referring to the sample code of fileAccess.createFileAccessHelper.
  fileAccessHelper.move(sourceFile, destFile, function (err, fileUri) {
    if (err) {
      console.error("Failed to move in async, errCode:" + err.code + ", errMessage:" + err.message);
      return;
    }
    console.log("move sucess, fileUri: " + JSON.stringify(fileUri));
  });
} catch (error) {
  console.error("move failed, errCode:" + error.code + ", errMessage:" + error.message);
};

rename

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

Renames a file or directory. This API uses a promise to return the result.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.FileManagement.UserFileService

Required permissions: ohos.permission.FILE_ACCESS_MANAGER

Parameters

Return value

Error codes

For details about error codes, see File Management Error Codes.

Example

// The media library URI is used as an example.
// In the sample code, sourceDir indicates a file in the Download directory. The URI is the URI in fileInfo.
// You can use the URI obtained.
let sourceDir = "datashare:///media/file/100";
try {
  // Obtain fileAccessHelper by referring to the sample code of fileAccess.createFileAccessHelper.
  let DestDir = await fileAccessHelper.rename(sourceDir, "testDir");
  console.log("rename sucess, DestDir: " + JSON.stringify(DestDir));
} catch (error) {
  console.error("rename failed, errCode:" + error.code + ", errMessage:" + error.message);
};

rename

rename(uri: string, displayName: string, callback: AsyncCallback<string>) : void

Renames a file or directory. This API uses an asynchronous callback to return the result.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.FileManagement.UserFileService

Required permissions: ohos.permission.FILE_ACCESS_MANAGER

Parameters

Error codes

For details about error codes, see File Management Error Codes.

Example

// The media library URI is used as an example.
// In the sample code, sourceDir indicates a file in the Download directory. The URI is the URI in fileInfo.
// You can use the URI obtained.
let sourceDir = "datashare:///media/file/100";
try {
  // Obtain fileAccessHelper by referring to the sample code of fileAccess.createFileAccessHelper.
  fileAccessHelper.rename(sourceDir, "testDir", function (err, DestDir) {
    if (err) {
      console.error("Failed to rename in async, errCode:" + err.code + ", errMessage:" + err.message);
      return;
    }
    console.log("rename sucess, DestDir: " + JSON.stringify(DestDir));
  });
} catch (error) {
  console.error("rename failed, errCode:" + error.code + ", errMessage:" + error.message);
};

access

access(sourceFileUri: string) : Promise<boolean>

Checks whether a file or directory exists. This API uses a promise to return the result.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.FileManagement.UserFileService

Required permissions: ohos.permission.FILE_ACCESS_MANAGER

Parameters

Return value

Error codes

For details about error codes, see File Management Error Codes.

Example

// The media library URI is used as an example.
// In the sample code, sourceDir indicates a file in the Download directory. The URI is the URI in fileInfo.
// You can use the URI obtained.
let sourceDir = "datashare:///media/file/100";
try {
  // Obtain fileAccessHelper by referring to the sample code of fileAccess.createFileAccessHelper.
  let existJudgment = await fileAccessHelper.access(sourceDir);
  if (existJudgment)
    console.log("sourceDir exists");
  else
    console.log("sourceDir does not exist");
} catch (error) {
  console.error("access failed, errCode:" + error.code + ", errMessage:" + error.message);
};

access

access(sourceFileUri: string, callback: AsyncCallback<boolean>) : void

Checks whether a file or directory exists. This API uses an asynchronous callback to return the result.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.FileManagement.UserFileService

Required permissions: ohos.permission.FILE_ACCESS_MANAGER

Parameters

Error codes

For details about error codes, see File Management Error Codes.

Example

// The media library URI is used as an example.
// In the sample code, sourceDir indicates a file in the Download directory. The URI is the URI in fileInfo.
// You can use the URI obtained.
let sourceDir = "datashare:///media/file/100";
try {
  // Obtain fileAccessHelper by referring to the sample code of fileAccess.createFileAccessHelper.
  fileAccessHelper.access(sourceDir, function (err, existJudgment) {
    if (err) {
      console.error("Failed to access in async, errCode:" + err.code + ", errMessage:" + err.message);
      return;
    }
    if (existJudgment)
      console.log("sourceDir exists");
    else
      console.log("sourceDir does not exist");
  });
} catch (error) {
  console.error("access failed, errCode:" + error.code + ", errMessage:" + error.message);
};

OPENFLAGS

Enumerates the modes for opening a file.

System capability: SystemCapability.FileManagement.UserFileService