FileSystemManager.saveFile
收藏我的收藏
基础库 1.15.0 开始支持本方法,这是一个异步方法。
保存临时文件到用户目录, 用户目录以 ttfile://user 开头。
| 前提条件 | 无 |
| 业务背景 | 无 |
| 使用限制 | 无 |
| 注意事项 |
|
| 相关教程 | 无 |
语法
FileSystemManager.saveFile(options)
参数说明
options 为 object 类型,属性如下:
| 属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
|---|---|---|---|---|---|
| filePath | string | 否 | 要存储的路径, 必须以 ttfile://user 开头 | 1.15.0 | |
| tempFilePath | string | 是 | 文件临时路径 | 1.15.0 | |
| success | function | 否 | 接口调用成功的回调函数 | 1.15.0 | |
| fail | function | 否 | 接口调用失败的回调函数 | 1.15.0 | |
| complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | 1.15.0 |
回调成功
object 类型,属性如下:
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| savedFilePath | string | 保存后文件路径 | 1.15.0 |
| errMsg | string | "saveFile:ok" | 1.15.0 |
回调失败
object 类型,属性如下:
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "saveFile:fail " + 详细错误信息 | 1.15.0 |
错误码
| errNo | errMsg | 说明 | 最低支持版本 |
|---|---|---|---|
| 20001 | invalid param | 参数错误 | 1.15.0 |
| 10401 | error stack | 小游戏框架内部错误,有需要请创建工单咨询 | 1.15.0 |
| 21101 | permission denied, $apiName $dirPath | 1.15.0 | |
| 21102 | no such file or directory, $apiName $dirPath | 1.15.0 | |
| 21103 | user dir saved file size limit exceeded | 1.15.0 | |
| 21105 | operation not permitted, $apiName $filePath | 1.15.0 | |
| 20000 | params $paramName is required | 1.15.0 | |
| 20000 | params $paramName type is not $paramType type | 1.15.0 | |
| 20000 | $paramName is invalid | 1.15.0 | |
| 21104 | operation failed | 小游戏框架内部错误,有需要请创建工单咨询 | 1.15.0 |
| 20000 | internal error | 小游戏框架内部错误,有需要请创建工单咨询 | 1.15.0 |
代码示例
const fileSystemManager = tt.getFileSystemManager(); tt.chooseImage({ success(res) { // 获取图片, chooseImage 获取的文件在临时文件目录内 const tempFilePaths = res.tempFilePaths; if (tempFilePaths[0]) { // 保存到用户目录 saveFile(tempFilePaths[0]); } }, }); function saveFile(tempFilePath) { fileSystemManager.saveFile({ tempFilePath, success(res) { console.log(`文件已经从 ${tempFilePath} 移动到 ${savedFilePath}`); }, fail(res) { console.log("保存失败", res.errMsg); }, }); }
