抖音开放平台Logo
控制台

FileSystemManager.appendFile

更新时间 2024-07-24 06:03:16
收藏
我的收藏

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

在文件结尾追加内容,文件不存在时会新建。只有用户目录 ttfile://user 下的文件可以追加。

前提条件
业务背景
使用限制
注意事项
相关教程

语法

FileSystemManager.appendFile(options)

参数说明

options 为 object 类型,属性如下:

属性名类型默认值必填说明最低支持版本
encodingenumutf-8
指定写入文件的字符编码
3.1.0
datastring
要写入的文本或二进制数据。支持 string 和 arraybuffer 类型
3.1.0
filePathstring
要追加内容的文件路径,必须是用户目录,以 ttfile://user 开头
3.1.0
successfunction
接口调用成功的回调函数
3.1.0
failfunction
接口调用失败的回调函数
3.1.0
completefunction
接口调用结束的回调函数(调用成功、失败都会执行)
3.1.0

encoding 的合法值

说明最低支持版本
utf-83.1.0
ascii3.1.0
base643.1.0
binary

ISO-8859-1

3.1.0
hex

十六进制

3.1.0
ucs2

以小端序读取

3.1.0
ucs-2

以小端序读取

3.1.0
utf16le

以小端序读取

3.1.0
utf-16le

以小端序读取

3.1.0
utf83.1.0
latin1

ISO-8859-1

3.1.0

回调成功

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring
"FileSystemManager.appendFile:ok"
3.1.0

回调失败

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring
"FileSystemManager.appendFile:fail" + 详细错误信息
3.1.0

错误码

errNoerrMsg说明最低支持版本
20000appendFile:fail filePath is invalid

filePath 参数错误

3.1.0
21101appendFile:fail permission denied, appendFile %s

文件路径不可写

3.1.0
21102appendFile:fail no such file or directory, appendFile %s

filePath 文件不存在

3.1.0
21103appendFile:fail user dir saved file size limit exceeded

超出目录大小限制

3.1.0
21104appendFile:fail operation not permitted, appendFile %s

filePath 类型不是文件

3.1.0

代码示例

const fs = tt.getFileSystemManager()

fs.appendFile({
  filePath: `ttfile://user/example.txt`,
  data: "Hello World",
  encoding: "utf8",
  success(res) {
    console.log(res)
  },
  fail(res) {
    console.error(res)
  },
})

// 同步接口
try {
  fs.appendFileSync(`ttfile://user/example.txt`, "Hello World", "utf8")
} catch (e) {
  console.error(e)
}