抖音开放平台Logo
开发者文档
“/”唤起搜索
控制台

FileSystemManager.writeFile
收藏
我的收藏

基础库 1.15.0 开始支持本方法,这是一个异步方法。

写文件,只能写入用户目录(ttfile://user)。

前提条件
业务背景
使用限制
注意事项
filePath 必须以 ttfile://user 开头
相关教程

语法

FileSystemManager.writeFile(options)

参数说明

options 为 object 类型,属性如下:

属性名类型默认值必填说明最低支持版本
filePathstring
要写入的文件路径, 必须以 ttfile://user 开头
1.15.0
datastring
string 或 ArrayBuffer 类型。要写入的文本或二进制数据
1.15.0
encodingenumutf8
指定写入文件的字符编码
1.15.0
successfunction
接口调用成功的回调函数
1.15.0
failfunction
接口调用失败的回调函数
1.15.0
completefunction
接口调用结束的回调函数(调用成功、失败都会执行)
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 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring
"writeFile:ok"
1.15.0

回调失败

object 类型,属性如下:

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

错误码

errNoerrMsg说明最低支持版本
20001invalid param
参数错误
1.15.0
10401error stack
小游戏框架内部错误,有需要请创建工单咨询
1.15.0
21101permission denied, $apiName $dirPath
1.15.0
21102no such file or directory, $apiName $dirPath
1.15.0
21103user dir saved file size limit exceeded
1.15.0
20000data is invalid
1.15.0
21104operation failed
小游戏框架内部错误,有需要请创建工单咨询
1.15.0
20000internal 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); }, });