普通小游戏开发
API
开放能力
数据分析
视频拍摄器
多端支持

FileSystemManager.renameSync

基础库 1.15.0 开始支持本方法。

重命名文件,可以把文件从 oldPath 移动到 newPath。

语法

FileSystemManager.renameSync(oldPath, newPath)

参数说明

oldPath

string 类型, 必须以 ttfile://user 开头 源文件路径,可以是普通文件或目录

newPath

string 类型, string 类型, 必须以 ttfile://user 开头 新文件路径

返回值

同步 API,调用失败会 throw Error

错误码

错误码说明:

errNoerrMsg说明最低支持版本
20000renameSync:fail oldPath is invalidoldPath 参数错误1.99.0
20000renameSync:fail newPath is invalidnewPath 参数错误1.99.0
20001renameSync:fail param should be xxx, but got xxx参数校验错误1.99.0
21101renameSync:fail newPath is invalid无操作权限(源路径不可读/目标路径不可写)1.99.0
21102renameSync:fail no such file or directory, renameSync {oldPath_value} -> {newPath_value}源文件不存在或目标文件的父级目录不存在1.99.0
21103renameSync:fail operation not permitted, renameSync {oldPath_value}类型错误(类型不一致)1.99.0
21104renameSync:fail user dir saved file size limit exceeded大小超出限制1.99.0

代码示例

开发者工具中预览

将所有保存的文件移除拓展标识

const fileSystemManager = tt.getFileSystemManager();

fileSystemManager.getSavedFileList({
  success(res) {
    res.fileList.forEach(removeExt);
  },
  fail(res) {
    console.log("获取失败", res.errMsg);
  },
});

/**
 * @param {*} fileItem
 * @param {string} fileItem.filePath
 * @param {number} fileItem.createTime
 * @param {number} fileItem.size
 */
function removeExt(fileItem) {
  console.log(`移除 ${fileItem.filePath} 的 ext`);
  const newPath = fileItem.filePath.replace(/(\..+)?$/, "");

  try {
    fileSystemManager.renameSync(fileItem.filePath, newPath);
    console.log("重命名成功");
  } catch (err) {
    console.log("重命名失败", err);
  }
}

Bug & Tip

  • Tip: 因为开发者只有在 ttfile://user 目录下才有写的权限, 因此 rename 只能在用户目录下进行。
点击纠错
评价此篇文档