FileSystemManager.writeFile
收藏我的收藏
基础库 1.15.0 开始支持本方法,这是一个异步方法。
写文件,只能写入用户目录(ttfile://user)。
前提条件 | 无 |
业务背景 | 无 |
使用限制 | 无 |
注意事项 | filePath 必须以 ttfile://user 开头 |
相关教程 | 无 |
语法
FileSystemManager.writeFile(options)
参数说明
options 为 object 类型,属性如下:
属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
---|---|---|---|---|---|
filePath | string | 是 | 要写入的文件路径, 必须以 ttfile://user 开头 | 1.15.0 | |
data | string | 是 | string 或 ArrayBuffer 类型。要写入的文本或二进制数据 | 1.15.0 | |
encoding | enum | utf8 | 否 | 指定写入文件的字符编码 | 1.15.0 |
success | function | 否 | 接口调用成功的回调函数 | 1.15.0 | |
fail | function | 否 | 接口调用失败的回调函数 | 1.15.0 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | 1.15.0 |
encoding 的合法值
值 | 说明 | 最低支持版本 |
---|---|---|
ascii | - | 1.15.0 |
base64 | - | 1.15.0 |
binary | 二进制 | 1.15.0 |
hex | 十六进制 | 1.15.0 |
ucs2 | 以小端序读取 | 1.15.0 |
ucs-2 | 以小端序读取 | 1.15.0 |
utf16le | 以小端序读取 | 1.15.0 |
utf-8/utf8 | utf8 格式 | 1.15.0 |
latin1 | - | 1.15.0 |
回调成功
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
errMsg | string | "writeFile:ok" | 1.15.0 |
回调失败
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
errNo | number | 错误码 | 1.15.0 |
errMsg | string | "writeFile: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 | |
20000 | data is invalid | 1.15.0 | |
21104 | operation failed | 小游戏框架内部错误,有需要请创建工单咨询 | 1.15.0 |
20000 | internal error | 小游戏框架内部 错误,有需要请创建工单咨询 | 1.15.0 |
代码示例
const fileSystemManager = tt.getFileSystemManager(); const filePath = `ttfile://user/example.txt`; fileSystemManager.writeFile({ filePath, encoding: "utf8", data: "example content", success(_res) { console.log("调用成功"); const data = fileSystemManager.readFileSync(filePath); console.log("写入的内容为:", data); }, fail(res) { console.log("调用失败", res.errMsg); }, });