@ohos.file.fileAccess (公共文件访问与管理)

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

说明：

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

导入模块

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

fileAccess.getFileAccessAbilityInfo

getFileAccessAbilityInfo() : Promise<Array<Want>>

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

模型约束：此接口仅可在Stage模型下使用。

系统能力：SystemCapability.FileManagement.UserFileService

需要权限：ohos.permission.FILE_ACCESS_MANAGER 和 ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

返回值：

错误码：

接口抛出错误码的详细介绍请参见文件管理错误码。

示例：

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

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

模型约束：此接口仅可在Stage模型下使用。

系统能力：SystemCapability.FileManagement.UserFileService

需要权限：ohos.permission.FILE_ACCESS_MANAGER 和 ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

参数：

错误码：

接口抛出错误码的详细介绍请参见文件管理错误码。

示例：

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

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

模型约束：此接口仅可在Stage模型下使用。

系统能力：SystemCapability.FileManagement.UserFileService

需要权限：ohos.permission.FILE_ACCESS_MANAGER 和 ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见文件管理错误码。

示例：

createFileAccessHelper() {
  let fileAccessHelper = null;
  // wantInfos 从getFileAccessAbilityInfo()获取
  // 创建只连接媒体库服务的helper对象
  let wantInfos = [
    {
      "bundleName": "com.ohos.medialibrary.medialibrarydata",
      "abilityName": "FileExtensionAbility",
    },
  ]
  try {
    // this.context 是EntryAbility 传过来的context
    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

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

模型约束：此接口仅可在Stage模型下使用。

系统能力：SystemCapability.FileManagement.UserFileService

需要权限：ohos.permission.FILE_ACCESS_MANAGER 和 ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见文件管理错误码。

示例：

createFileAccessHelper() {
  let fileAccessHelperAllServer = null;
  // 创建连接系统内所有配置fileAccess的文件管理类服务的helper对象
  try {
    // this.context 是EntryAbility 传过来的context
    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

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

模型约束：此接口仅可在Stage模型下使用。

系统能力：SystemCapability.FileManagement.UserFileService。

需要权限：ohos.permission.FILE_ACCESS_MANAGER

属性

listFile

listFile(filter?: Filter) : FileIterator

以同步方法从某个目录，基于过滤器，获取下一级符合条件的文件(夹)信息的迭代器对象FileIterator，然后通过next方法返回FileInfo。目前仅支持内置存储设备过滤，外置存储设备不支持过滤。

模型约束：此接口仅可在Stage模型下使用。

系统能力：SystemCapability.FileManagement.UserFileService

需要权限：ohos.permission.FILE_ACCESS_MANAGER

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见文件管理错误码。

示例：

// 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);
  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

以同步方法从某个目录，基于过滤器，递归获取符合条件的文件信息的迭代器对象FileIterator，然后通过next方法返回FileInfo。目前仅支持内置存储设备。

模型约束：此接口仅可在Stage模型下使用。

系统能力：SystemCapability.FileManagement.UserFileService

需要权限：ohos.permission.FILE_ACCESS_MANAGER

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见文件管理错误码。

示例：

// 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);
  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

表示文件夹的迭代器对象。

模型约束：此接口仅可在Stage模型下使用。

系统能力：SystemCapability.FileManagement.UserFileService

需要权限：ohos.permission.FILE_ACCESS_MANAGER

next

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

可以通过next同步方法获取下一级文件(夹)信息。

模型约束：此接口仅可在Stage模型下使用。

系统能力：SystemCapability.FileManagement.UserFileService。

需要权限：ohos.permission.FILE_ACCESS_MANAGER

返回值：

错误码：

接口抛出错误码的详细介绍请参见文件管理错误码。

RootInfo

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

模型约束：此接口仅可在Stage模型下使用。

系统能力：SystemCapability.FileManagement.UserFileService。

需要权限：ohos.permission.FILE_ACCESS_MANAGER

属性

listFile

listFile(filter?: Filter) : FileIterator

以同步方法从某设备根节点开始，基于过滤器，获取第一级符合条件的文件(夹)信息的迭代器对象FileIterator，然后通过next方法返回FileInfo。目前仅支持内置存储设备过滤，外置存储设备不支持过滤。

模型约束：此接口仅可在Stage模型下使用。

系统能力：SystemCapability.FileManagement.UserFileService

需要权限：ohos.permission.FILE_ACCESS_MANAGER

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见文件管理错误码。

示例：

// 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);
  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

以同步方法从某设备根节点开始，基于过滤器，递归获取符合条件的文件信息的迭代器对象FileIterator，然后通过next方法返回FileInfo。目前仅支持内置存储设备。

模型约束：此接口仅可在Stage模型下使用。

系统能力：SystemCapability.FileManagement.UserFileService

需要权限：ohos.permission.FILE_ACCESS_MANAGER

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见文件管理错误码。

示例：

// 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);
  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

表示设备根目录的迭代器对象。

模型约束：此接口仅可在Stage模型下使用。

系统能力：SystemCapability.FileManagement.UserFileService

需要权限：ohos.permission.FILE_ACCESS_MANAGER

next

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

通过next同步方法获取下一级设备根目录。

模型约束：此接口仅可在Stage模型下使用。

系统能力：SystemCapability.FileManagement.UserFileService。

需要权限：ohos.permission.FILE_ACCESS_MANAGER

返回值：

错误码：

接口抛出错误码的详细介绍请参见文件管理错误码。

FileAccessHelper

FileAccessHelper对象。

模型约束：此接口仅可在Stage模型下使用。

系统能力：SystemCapability.FileManagement.UserFileService

需要权限：ohos.permission.FILE_ACCESS_MANAGER

getRoots

getRoots() : Promise<RootIterator>

以异步方法获取helper对象连接的文件管理服务类的设备根节点信息。使用Promise异步回调。 该方法返回迭代器对象RootIterator，然后通过next方法返回RootInfo。

模型约束：此接口仅可在Stage模型下使用。

系统能力：SystemCapability.FileManagement.UserFileService

需要权限：ohos.permission.FILE_ACCESS_MANAGER

返回值：

错误码：

接口抛出错误码的详细介绍请参见文件管理错误码。

示例：

async getRoots() {
  let rootIterator = null;
  let rootinfos = [];
  let isDone = false;
  try {
    // fileAccessHelper 参考 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

以异步方法获取helper对象连接的文件管理服务类的设备根节点信息。使用callback异步回调。 callback带回迭代器对象RootIterator，然后通过next方法返回RootInfo。

模型约束：此接口仅可在Stage模型下使用。

系统能力：SystemCapability.FileManagement.UserFileService

需要权限：ohos.permission.FILE_ACCESS_MANAGER

参数：

错误码：

接口抛出错误码的详细介绍请参见文件管理错误码。

示例：

async getRoots() {
  let rootinfos = [];
  let isDone = false;
  try {
    // fileAccessHelper 参考 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>

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

模型约束：此接口仅可在Stage模型下使用。

系统能力：SystemCapability.FileManagement.UserFileService

需要权限：ohos.permission.FILE_ACCESS_MANAGER

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见文件管理错误码。

示例：

// 以媒体库uri为例
// 示例代码sourceUri表示Download目录，该uri是对应的fileInfo中uri
// 开发者应根据自己实际获取的uri进行开发
let sourceUri = "datashare:///media/file/6";
let displayName = "file1"
let fileUri = null;
try {
  // fileAccessHelper 参考 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

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

模型约束：此接口仅可在Stage模型下使用。

系统能力：SystemCapability.FileManagement.UserFileService

需要权限：ohos.permission.FILE_ACCESS_MANAGER

参数：

错误码：

接口抛出错误码的详细介绍请参见文件管理错误码。

示例：

// 以媒体库uri为例
// 示例代码sourceUri表示Download目录，该uri是对应的fileInfo中uri
// 开发者应根据自己实际获取的uri进行开发
let sourceUri = "datashare:///media/file/6";
let displayName = "file1"
try {
  // fileAccessHelper 参考 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>

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

模型约束：此接口仅可在Stage模型下使用。

系统能力：SystemCapability.FileManagement.UserFileService

需要权限：ohos.permission.FILE_ACCESS_MANAGER

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见文件管理错误码。

示例：

// 以媒体库uri为例
// 示例代码sourceUri表示Download目录，该uri是对应的fileInfo中uri
// 开发者应根据自己实际获取的uri进行开发
let sourceUri = "datashare:///media/file/6";
let dirName = "dirTest"
let dirUri = null;
try {
  // fileAccessHelper 参考 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

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

模型约束：此接口仅可在Stage模型下使用。

系统能力：SystemCapability.FileManagement.UserFileService

需要权限：ohos.permission.FILE_ACCESS_MANAGER

参数：

错误码：

接口抛出错误码的详细介绍请参见文件管理错误码。

示例：

// 以媒体库uri为例
// 示例代码sourceUri表示Download目录，该uri是对应的fileInfo中uri
// 开发者应根据自己实际获取的uri进行开发
let sourceUri = "datashare:///media/file/6";
let dirName = "dirTest"
try {
  // fileAccessHelper 参考 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>

以异步方法打开文件，返回文件描述符。使用Promise异步回调。

模型约束：此接口仅可在Stage模型下使用。

系统能力：SystemCapability.FileManagement.UserFileService

需要权限：ohos.permission.FILE_ACCESS_MANAGER

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见文件管理错误码。

示例：

// 以媒体库uri为例
// 示例代码targetUri表示Download目录下文件，该uri是对应的fileInfo中uri
// 开发者应根据自己实际获取的uri进行开发
let targetUri  = "datashare:///media/file/100";
try {
  // fileAccessHelper 参考 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

以异步方法打开文件，返回文件描述符。使用callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

系统能力：SystemCapability.FileManagement.UserFileService

需要权限：ohos.permission.FILE_ACCESS_MANAGER

参数：

错误码：

接口抛出错误码的详细介绍请参见文件管理错误码。

示例：

// 以媒体库uri为例
// 示例代码targetUri表示Download目录下文件，该uri是对应的fileInfo中uri
// 开发者应根据自己实际获取的uri进行开发
let targetUri  = "datashare:///media/file/100";
try {
  // fileAccessHelper 参考 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>

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

模型约束：此接口仅可在Stage模型下使用。

系统能力：SystemCapability.FileManagement.UserFileService

需要权限：ohos.permission.FILE_ACCESS_MANAGER

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见文件管理错误码。

示例：

// 以媒体库uri为例
// 示例代码targetUri表示Download目录下文件，该uri是对应的fileInfo中uri
// 开发者应根据自己实际获取的uri进行开发
let targetUri = "datashare:///media/file/100";
try {
  // fileAccessHelper 参考 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

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

模型约束：此接口仅可在Stage模型下使用。

系统能力：SystemCapability.FileManagement.UserFileService

需要权限：ohos.permission.FILE_ACCESS_MANAGER

参数：

错误码：

接口抛出错误码的详细介绍请参见文件管理错误码。

示例：

// 以媒体库uri为例
// 示例代码targetUri表示Download目录下文件，该uri是对应的fileInfo中uri
// 开发者应根据自己实际获取的uri进行开发
let targetUri = "datashare:///media/file/100";
try {
  // fileAccessHelper 参考 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>

以异步方法移动文件(夹)，返回移动后文件(夹)的uri。使用Promise异步回调。目前仅支持设备内移动，跨设备不支持移动。

模型约束：此接口仅可在Stage模型下使用。

系统能力：SystemCapability.FileManagement.UserFileService

需要权限：ohos.permission.FILE_ACCESS_MANAGER

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见文件管理错误码。

示例：

// 以媒体库uri为例
// 示例代码sourceFile destFile表示Download目录下文件或文件夹，该uri是对应的fileInfo中uri
// 开发者应根据自己实际获取的uri进行开发
let sourceFile = "datashare:///media/file/102";
let destFile = "datashare:///media/file/101";
try {
  // fileAccessHelper 参考 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

以异步方法移动文件(夹)，返回移动后文件(夹)的uri。使用callback异步回调。目前仅支持设备内移动，跨设备不支持移动。

模型约束：此接口仅可在Stage模型下使用。

系统能力：SystemCapability.FileManagement.UserFileService

需要权限：ohos.permission.FILE_ACCESS_MANAGER

参数：

错误码：

接口抛出错误码的详细介绍请参见文件管理错误码。

示例：

// 以媒体库uri为例
// 示例代码sourceFile destFile表示Download目录下文件或文件夹，该uri是对应的fileInfo中uri
// 开发者应根据自己实际获取的uri进行开发
let sourceFile = "datashare:///media/file/102";
let destFile = "datashare:///media/file/101";
try {
  // fileAccessHelper 参考 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>

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

模型约束：此接口仅可在Stage模型下使用。

系统能力：SystemCapability.FileManagement.UserFileService

需要权限：ohos.permission.FILE_ACCESS_MANAGER

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见文件管理错误码。

示例：

// 以媒体库uri为例
// 示例代码sourceDir表示Download目录下文件，该uri是对应的fileInfo中uri
// 开发者应根据自己实际获取的uri进行开发
let sourceDir = "datashare:///media/file/100";
try {
  // fileAccessHelper 参考 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

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

模型约束：此接口仅可在Stage模型下使用。

系统能力：SystemCapability.FileManagement.UserFileService

需要权限：ohos.permission.FILE_ACCESS_MANAGER

参数：

错误码：

接口抛出错误码的详细介绍请参见文件管理错误码。

示例：

// 以媒体库uri为例
// 示例代码sourceDir表示Download目录下文件，该uri是对应的fileInfo中uri
// 开发者应根据自己实际获取的uri进行开发
let sourceDir = "datashare:///media/file/100";
try {
  // fileAccessHelper 参考 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>

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

模型约束：此接口仅可在Stage模型下使用。

系统能力：SystemCapability.FileManagement.UserFileService

需要权限：ohos.permission.FILE_ACCESS_MANAGER

参数：

返回值：

错误码：

接口抛出错误码的详细介绍请参见文件管理错误码。

示例：

// 以媒体库uri为例
// 示例代码sourceDir表示Download目录下文件，该uri是对应的fileInfo中uri
// 开发者应根据自己实际获取的uri进行开发
let sourceDir = "datashare:///media/file/100";
try {
  // fileAccessHelper 参考 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

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

模型约束：此接口仅可在Stage模型下使用。

系统能力：SystemCapability.FileManagement.UserFileService

需要权限：ohos.permission.FILE_ACCESS_MANAGER

参数：

错误码：

接口抛出错误码的详细介绍请参见文件管理错误码。

示例：

// 以媒体库uri为例
// 示例代码sourceDir表示Download目录下文件，该uri是对应的fileInfo中uri
// 开发者应根据自己实际获取的uri进行开发
let sourceDir = "datashare:///media/file/100";
try {
  // fileAccessHelper 参考 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

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

系统能力： SystemCapability.FileManagement.UserFileService