上传

接口定义

展开

接口

描述

qg.uploadFile(Object object)

将本地资源上传到服务器。

UploadTask.onProgressUpdate(Function callback)

监听上传进度变化。

UploadTask.offProgressUpdate(Function callback)

取消监听上传进度变化事件。

UploadTask.abort()

中断上传任务。

qg.uploadFile(Object object)

  • 描述

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

  • 参数
    展开

    参数

    类型

    必填(M)/选填(O)

    说明

    url

    string

    M

    开发者服务器地址。

    filePath

    string

    M

    要上传文件资源的路径。

    name

    string

    M

    文件对应的 key,开发者在服务端可以通过这个 key 获取文件的二进制内容。

    header

    object

    O

    HTTP 请求 Header,Header 中不能设置 Referer。

    formData

    object

    O

    HTTP 请求中其他额外的 form data。

    success

    function(object res)

    O

    接口调用成功的回调函数。

    fail

    function

    O

    接口调用失败的回调函数。

    complete

    function

    O

    若有函数传入,将在成功、失败后调用该函数。

    • success回调函数参数
      展开

      参数

      类型

      说明

      data

      string

      开发者服务器返回的数据。

      statusCode

      number

      开发者服务器返回的 HTTP 状态码。

  • 示例代码
    onClickUploadFile(event) {
        const that = this
        console.log("on onClickUploadFile" + qg.env.USER_DATA_PATH);
        let cb = {
            url:'https://testuploadurl.html', //your test url
            filePath:'proto-file://usr/video_file.mp4',
            name:'_file',
            success(res) {
                console.log("on onClickUploadFile: success : " + JSON.stringify(res));
                that.uploadResponse.string = "Success返回值:" + JSON.stringify(res)
            },
            fail(e) {
                console.log("on onClickUploadFile: fail : " + JSON.stringify(e));
                that.uploadResponse.string = "Fail返回值:" + JSON.stringify(e)
            },
            complete() {
                console.log("on onClickUploadFile: complete");
            }
        };
        this.uploadTask = qg.uploadFile(cb);
        this.progressFunc = function(res){
            console.log("Receive upload progress cp callback = " + JSON.stringify(res))
            that.uploadProgress.string = "当前上传进度:" + res.progress
        }
        this.uploadTask.onProgressUpdate(this.progressFunc)
    }

UploadTask.onProgressUpdate(Function callback)

  • 描述

    监听上传进度变化。

  • 参数
    展开

    参数

    类型

    必填(M)/选填(O)

    说明

    callback

    function

    M

    上传进度变化事件的回调函数。

    • callback回调函数参数
      展开

      参数

      类型

      说明

      progress

      number

      上传进度百分比。

      totalBytesSent

      number

      已经上传的数据长度,单位 Bytes。

      totalBytesExpectedToSend

      number

      预期需要上传的数据总长度,单位 Bytes。

  • 示例代码
    this.progressFunc = function(res){
            console.log("Receive upload progress cp callback = " + JSON.stringify(res))
            that.uploadProgress.string = "当前上传进度:" + res.progress
        }
    this.uploadTask.onProgressUpdate(this.progressFunc)

UploadTask.offProgressUpdate(Function callback)

  • 描述

    取消监听上传进度变化事件。

  • 参数
    展开

    参数

    类型

    必填(M)/选填(O)

    说明

    callback

    function

    M

    上传进度变化事件的回调函数。

UploadTask.abort()

  • 描述

    中断上传任务。