wx.cloud.downloadFile

从云存储空间下载文件

请求参数

字段 说明 数据类型 默认值 必填
fileID 云文件 ID String - Y
success 成功回调
fail 失败回调
complete 结束回调

success 返回参数

字段 说明 数据类型
tempFilePath 临时文件路径 String
statusCode 服务器返回的 HTTP 状态码 Number

fail 返回参数

字段 说明 数据类型
errCode 错误码 Number
errMsg 错误信息,格式 apiName:fail msg String

使用示例

Callback 风格

  1. wx.cloud.downloadFile({
  2. fileID: 'a7xzcb',
  3. success: res => {
  4. // get temp file path
  5. console.log(res.tempFilePath)
  6. },
  7. fail: err => {
  8. // handle error
  9. }
  10. })

Promise 风格

  1. wx.cloud.downloadFile({
  2. fileID: 'a7xzcb'
  3. }).then(res => {
  4. // get temp file path
  5. console.log(res.tempFilePath)
  6. }).catch(error => {
  7. // handle error
  8. })

返回值如果请求参数中带有 success/fail/complete 回调中的任一个,则会返回一个 downloadTask 对象,通过 downloadTask 对象可监听上传进度变化事件,以及取消上传任务。

downloadTask 对象的方法列表:

方法 参数 说明
onProgressUpdate callback onProgressUpdate
abort 中断上传任务

onProgressUpdate 返回参数说明:

字段 说明 数据类型
progress 上传进度百分比 Number
totalBytesSent 已经上传的数据长度,单位 Bytes Number
totalBytesExpectedToSend 预期需要上传的数据总长度,单位 Bytes Number

原文: https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-client-api/storage/downloadFile.html