tt.uploadFile
收藏我的收藏
收藏基础库 1.0.0 开始支持本方法，这是一个异步方法。
将本地文件上传到网络。客户端将发起一个 HTTPS POST 请求，其中 content-type 为 multipart/form-data。
| 前提条件 | 网络相关的 API 在使用前需要配置域名白名单，请前往开发者平台「开发 - 开发设置」，添加 uploadFile 合法域名 |
| 业务背景 | 无 |
| 使用限制 |
|
| 注意事项 | 无 |
| 相关教程 | 无 |
语法
tt.uploadFile(options)
参数说明
options 为 object 类型，属性如下：
| 属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
|---|---|---|---|---|---|
| url | string | 是 | 目标地址 | 1.0.0 | |
| filePath | string | 是 | 本地文件路径 | 1.0.0 | |
| name | string | 是 | HTTP 请求的文件名 | 1.0.0 | |
| header | object | {"content-type": "multipart/form-data"} | 是 | 请求 Header ，不能设置 referer 和 user-agent | 1.0.0 |
| formData | object | 是 | 请求额外参数 | 1.0.0 | |
| timeout | number | 否 | 接口超时时间，单位为毫秒，不传默认取 game.json 中的 networkTimeout 配置 | 3.83.0 | |
| enableProfile | boolean | true | 否 | 是否开启 profile，默认开启。开启后可在接口回调的 res.profile 中查看性能调试信息。PC 未支持该能力，请使用真机调试。 | 3.83.0 |
| success | function | 否 | 接口调用成功的回调函数 | 1.0.0 | |
| fail | function | 否 | 接口调用失败的回调函数 | 1.0.0 | |
| complete | function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | 1.0.0 |
header 参数说明
referer 说明
网络请求 header 中的 referer 不可设置。 其固定格式为：https://tmaservice.developer.toutiao.com?appid={appid}&version={appVersion}，其中 appid 为小游戏的 APPID，appVersion 为小游戏的版本号。
user-agent 说明
网络请求 header 中的 user-agent 不可设置。 其固定格式分为：
- IOS 系统：[系统user-agent] [宿主标识]/[宿主app版本] ToutiaoMicroApp/[基础库版本] webview/[插件版本]。
- Android 系统：[系统user-agent] [宿主标识]/[宿主app版本] ToutiaoMicroApp/[基础库版本] PluginVersion/[插件版本]。
回调成功
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| statusCode | number | 返回 HTTP 状态码 | 1.0.0 |
| data | string | 返回数据 | 1.0.0 |
| errMsg | string | "uploadFile:ok" | 1.0.0 |
回调失败
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "uploadFile:fail" + 详细错误信息 | 1.0.0 |
返回值
| 类型 | 说明 | 最低支持版本 |
|---|---|---|
| object | UploadTask 实例（上传任务对象） | 1.0.0 |
错误码
| errNo | errMsg | 说明 | 最低支持版本 |
|---|---|---|---|
| 21100 | url is not valid domain, url == %s | 1.0.0 | |
| 21100 | url is invalid, url == %s | 1.0.0 | |
| 21102 | no file exist, filePath == %s | 1.0.0 | |
| 21101 | permission denied, open | 1.0.0 | |
| 20000 | abort | 1.0.0 | |
| 20000 | no uploadTaskId | 小游戏框架内部错误，有需要请创建工单咨询 | 1.0.0 |
| 20000 | internal error | 小游戏框架内部错误，有需要请创建工单咨询 | 1.0.0 |
| 20000 | $paramName is invalid | 1.0.0 | |
| 10501 | app in background | 1.0.0 | |
| 20000 | filePath is illegal | 1.0.0 | |
| 21000 | file is empty | 1.0.0 | |
| 21000 | url is not valid domain, url == $url | 1.0.0 | |
| 20000 | url is not valid domain, url == $url | 小游戏框架内部错误，有需要请创建工单咨询 | 1.0.0 |
扫码体验
请使用字节宿主APP扫码
代码示例
let task = tt.uploadFile({ url: "someuploadurl", filePath: tempFilePath, name: "file", success(res) { if (res.statusCode === 200) { console.log(`uploadFile调用成功 ${res.data}`); } }, fail(res) { console.log(`uploadFile调用失败`); }, }); task.onProgressUpdate((res) => { this.setData({ progress: res.progress, }); }); if (someReason) { task.abort(); }
