普通小游戏开发
开放能力(必读)
社交转发裂变
数据分析
视频拍摄器
API
多端支持
自2022年9月6日起,本文档站不再更新内容,相关文档已迁移至全新“抖音开放平台”前往

tt.uploadFile

从基础库 1.0.0 开始支持

将本地文件上传到网络。 网络相关的 API 在使用前需要配置域名白名单。客户端发起一个 HTTPS POST 请求,其中 content-typemultipart/form-data

语法

tt.uploadFile(options)

参数说明

options 为 Object 类型,属性如下:

属性名类型默认值必填说明最低支持版本
urlstring--目标地址1.0.0
filePathstring--本地文件路径1.0.0
namestring--HTTP 请求的文件名1.0.0
headerobject{'content-type': 'multipart/form-data'}请求 Header ,不能设置 referer 和 user-agent1.0.0
formDataobject--请求额外参数1.0.0
successfunction--接口调用成功的回调函数1.0.0
failfunction--接口调用失败的回调函数1.0.0
completefunction--接口调用结束的回调函数(调用成功、失败都会执行)1.0.0

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 类型,属性如下:

参数参数类型说明最低支持版本
datastring返回数据1.0.0
statusCodenumber返回 HTTP 状态码1.0.0

回调失败

Object 类型,属性如下:

参数参数类型类型最低支持版本
errMsgstring错误信息1.0.0

返回值

UploadTask(上传任务对象),调用 tt.uploadFile 后返回的请求对象。

代码示例

开发者工具中预览

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();
}

Bug & Tip

  • Tip:header 不支持设置 refereruser-agentcontent-type 字段字段。
  • Tip:目前 tt.uploadFile 上传文件大小限制为 10M。
  • Tip:目前 tt.uploadFile 暂不支持多文件上传,一次只能上传一个文件。
点击纠错
该文档是否对你的开发有所帮助?
有帮助
没帮助
该文档是否对你的开发有所帮助?
有帮助
没帮助