FileSystemManager.readFile
收藏我的收藏
收藏基础库 1.15.0 开始支持本方法，这是一个异步方法。
读取本地文件内容。
| 前提条件 | 无 |
| 业务背景 | 无 |
| 使用限制 | 无 |
| 注意事项 | readFile 可以用于 用户目录(ttfile://user) 临时目录(ttfile://temp) 以及 包内目录(访问包内目录不需要加额外协议头) |
| 相关教程 | 无 |
语法
FileSystemManager.readFile(options)
参数说明
options 为 object 类型，属性如下：
| 属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
|---|---|---|---|---|---|
| encoding | enum | 否 | 指定读取文件的字符编码，如果不传 encoding，则以 ArrayBuffer 格式读取文件的二进制内容 | 1.15.0 | |
| filePath | string | 是 | 要读取的文件的路径 | 1.15.0 | |
| success | function | 否 | 接口调用成功的回调函数 | 1.15.0 | |
| fail | function | 否 | 接口调用失败的回调函数 | 1.15.0 | |
| complete | function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | 1.15.0 |
encoding 的合法值
| 值 | 说明 | 最低支持版本 |
|---|---|---|
| utf-8 | - | 1.15.0 |
| 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-16le | 以小端序读取 | 1.15.0 |
| utf8 | - | 1.15.0 |
| latin1 | - | 1.15.0 |
回调成功
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| data | string | 数据。string 或 ArrayBuffer 类型 | 1.15.0 |
| errMsg | string | "FileSystemManager.readFile:ok" | 1.15.0 |
回调失败
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "FileSystemManager.readFile:fail" + 详细错误信息 | 1.15.0 |
错误码
| errorCode | errMsg | errorType | 说明 | 最低支持版本 |
|---|---|---|---|---|
| 999999 | invalid param | D | 参数错误 | 1.15.0 |
| 999991 | error stack | F | 小游戏框架内部错误，有需要请创建工单咨询 | 1.15.0 |
| 112401 | permission denied, $apiName $filePath | D | 1.15.0 | |
| 112403 | operation not permitted, $apiName $filePath | D | 1.15.0 | |
| 112402 | no such file or directory, $apiName $filePath | D | 1.15.0 | |
| 999999 | params $paramName is required | D | 1.15.0 | |
| 999999 | params $paramName type is not $paramType type | D | 1.15.0 | |
| 999999 | $paramName is invalid | D | 1.15.0 | |
| 999993 | internal error | F | 小游戏框架内部错误，有需要请创建工单咨询 | 1.15.0 |
代码示例
const fileSystemManager = tt.getFileSystemManager(); tt.chooseImage({ success(res) { readFile(res.tempFilePaths[0]); }, }); function readFile(filePath) { fileSystemManager.readFile({ filePath, success(res) { // 输出读取的文件内容 console.log(res.data); }, fail(res) { console.log("调用失败", res.errMsg); }, }); }
