# UploadTask 对象

# UploadTask.onProgressUpdate

upoadFile的调用结果在通过回调传递的同时会返回一个uploadTask对象，通过onProgressUpdate方法监听上传进度。

# 支持说明

应用能力	Android	iOS	PC	预览效果
小程序	3.3.0	3.3.0	3.4.0	扫码预览用BoosHi扫码或PC端点击
网页应用	X	X	X	/

# 输入

function listener 下载进度变化事件的监听函数

# 输出

回调函数返回对象的属性：

名称	数据类型	描述
progress	number	上传进度
totalBytesSent	number	已经上传的数据长度，单位 byte
totalBytesExpectedToSend	number	预期需要上传的数据总长度，单位 byte

# 示例代码

const uploadTask = bz.uploadFile({
  "url": "https://ship-qa.weizhipin.com/wapi/zphibpm/common/img/upload.json",
  "filePath": filePath,
  "name": "test.jpeg"
})
uploadTask.onProgressUpdate(function(res) {
  console.log("uploading")
  if (res.progress == 100) {
  // upload complete
    console.log(res)
  }
})

1
2
3
4
5
6
7
8
9
10
11
12

回调函数返回对象示例：

{
    "totalBytesExpectedToSend": 118561,
    "totalBytesSent": 118561,
    "progress": 100
}

1
2
3
4
5

# UploadTask.offProgressUpdate()

upoadFile的调用结果在通过回调传递的同时会返回一个uploadTask对象，可以通过该对象的offProgressUpdate方法取消监听下载。

# 支持说明

应用能力	Android	iOS	PC	预览效果
小程序	3.3.0	3.3.0	3.4.0	扫码预览用BoosHi扫码或PC端点击
网页应用	X	X	X	/

# 输入

function listener 取消下载进度变化事件的监听函数

# 输出

无

# 示例代码

const uploadTask = bz.uploadFile({
  "url": "https://ship-qa.weizhipin.com/wapi/zphibpm/common/img/upload.json",
  "filePath": filePath,
  "name": "test.jpeg"
})
uploadTask.offProgressUpdate(function(res) {
  console.log("uploading", res)
})

1
2
3
4
5
6
7
8

# UploadTask.abort()

uplaodFile调用结果在通过回调传递的同时会返回一个uploadTask对象，可以通过该对象的abort方法中断请求任务。

# 支持说明

应用能力	Android	iOS	PC	预览效果
小程序	3.3.0	3.3.0	3.4.0	扫码预览用BoosHi扫码或PC端点击
网页应用	X	X	X	/

# 输入

无

# 输出

无

# 示例代码

const uploadTask = bz.uploadFile({
    "url": "https://ship-qa.weizhipin.com/wapi/zphibpm/common/img/upload.json",
    "filePath": filePath,
    "name": "test.jpeg"
  })
  uploadTask.onProgressUpdate(function(res) {
    console.log("uploading")
    console.log(res)
    uploadTask.abort()
  })

1
2
3
4
5
6
7
8
9
10

← uploadFile connectSocket →