接入指南 API 工具 其他

上传

qg.uploadFile(Object object)

将本地资源上传到服务器。客户端发起一个 HTTPS POST 请求,其中 content-typemultipart/form-data

参数

Object object

属性类型默认值必填说明
urlString开发者服务器地址
filePathString要上传文件资源的路径 (本地路径)
nameString文件对应的 key,开发者在服务端可以通过这个 key 获取文件的二进制内容
headerObjectHTTP 请求 Header,Header 中不能设置 Referer
formDataObjectHTTP 请求中其他额外的 form data
timeoutNumber超时时间,单位为毫秒
successFunction接口调用成功的回调函数
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)
object.success(Object res) 回调函数
属性类型说明
dataString开发者服务器返回的数据
statusCodeNumber开发者服务器返回的 HTTP 状态码

示例代码

qg.chooseImage({
  success(res) {
    const tempFilePaths = res.tempFilePaths;
    qg.uploadFile({
      url: "https://example.com/upload", //仅为示例,非真实的接口地址
      filePath: tempFilePaths[0],
      name: "file",
      formData: {
        user: "test"
      },
      success(res) {
        const data = res.data;
        //do something
      }
    });
  }
});

返回值 UploadTask

一个可以监听上传进度变化事件,以及取消上传任务的对象

方法

UploadTask.onHeadersReceived(Function listener)

监听 HTTP Response Header 事件。会比请求完成事件更早

参数 listener(Object res)

HTTP Response Header 事件的监听函数

属性类型说明
headerObject开发者服务器返回的 HTTP Response Header

UploadTask.onProgressUpdate(Function listener)

监听上传进度变化事件

参数 listener(Object res)

上传进度变化事件的监听函数

属性类型说明
progressNumber上传进度百分比
totalBytesSentNumber已经上传的数据长度,单位 Bytes
totalBytesExpectedToSendNumber预期需要上传的数据总长度,单位 Bytes

UploadTask.offProgressUpdate(Function listener)

移除上传进度变化事件的监听函数

参数 listener(Object res)

onProgressUpdate 传入的监听函数。不传此参数则移除所有监听函数。

示例代码

const listener = function(res) {
  console.log(res);
};

UploadTask.onProgressUpdate(listener);
UploadTask.offProgressUpdate(listener); // 需传入与监听时同一个的函数对象

UploadTask.offHeadersReceived(Function listener)

移除 HTTP Response Header 事件的监听函数

参数 listener(Object res)

onHeadersReceived 传入的监听函数。不传此参数则移除所有监听函数。

示例代码

const listener = function(res) {
  console.log(res);
};

UploadTask.onHeadersReceived(listener);
UploadTask.offHeadersReceived(listener); // 需传入与监听时同一个的函数对象

UploadTask.abort()

中断上传任务

条匹配 "" 的结果

    没有搜索到与 "" 相关的内容