tt.saveFile

基础库 1.15.0 开始支持本方法,低版本需做兼容处理

保存临时文件到用户目录, 用户目录以 ttfile://user 开头

通过 tt.downloadFile 下载的文件会保存在以 ttfile://temp 开头的临时目录, 临时目录的文件会不定期清理, 如果希望下载的文件永久保留, 则可以通过 saveFile 将文件保存到以 ttfile://user 开头的用户目录下

语法

tt.saveFile(options)

参数说明

options 为 object 类型,属性描述如下:

名称数据类型默认值必填说明最低支持版本
tempFilePathstring文件临时路径1.15.0
filePathstring要存储的路径, 必须以 ttfile://user 开头1.15.0
successFunction接口调用成功的回调函数1.15.0
failFunction接口调用失败的回调函数1.15.0
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)1.15.0

回调成功

回调参数为 object 类型,属性如下:

属性类型说明最低支持版本
errMsgstring1.15.0
savedFilePathstring保存后文件路径

回调失败

回调参数为 object 类型,属性如下:

属性类型说明最低支持版本
errMsgstring"saveFile:fail " + 详细错误信息1.15.0

效果示例

扫码体验

请使用字节宿主APP扫码

代码示例

开发者工具中预览

tt.chooseImage({
  success(res) {
    // 获取图片, chooseImage 获取的文件在临时文件目录内
    const tempFilePaths = res.tempFilePaths;
    if (tempFilePaths[0]) {
      // 保存到用户目录
      saveFile(tempFilePaths[0]);
    }
  },
});

function saveFile(tempFilePath) {
  tt.saveFile({
    tempFilePath,
    success(res) {
      console.log(`文件已经从 ${tempFilePath} 移动到 ${savedFilePath}`);
    },
    fail(res) {
      console.log("保存失败", res.errMsg);
    },
  });
}

Bug & Tip

  • Tip:该 API 会把临时文件 移动 到用户, 所以在调用成功后原文件路径将访问失败。
  • Tip:每一个小程序的用户文件存储上限为 10M, 相互隔离。
  • Tip:卸载宿主(例如头条, 抖音), 或者使用系统的清理功能将清除用户目录内的文件。
点击纠错
评价此篇文档