微信小程序开发文档 微信小程序云开发SDK文档 文件存储·下载文件

2024-02-25 开发教程 微信小程序开发文档 匿名 3

Cloud.downloadFile()

支持端:小程序 , 云函数 , Web

从云存储空间下载文件


wx.cloud.downloadFile

从云存储空间下载文件

请求参数

字段说明数据类型默认值必填
fileID云文件 IDString-Y
config配置Object-N
success成功回调
fail失败回调
complete结束回调

config 对象定义

字段说明数据类型
env使用的环境 ID,填写后忽略 init 指定的环境String

success 返回参数

字段说明数据类型
tempFilePath临时文件路径String
statusCode服务器返回的 HTTP 状态码Number
errMsg成功为 downloadFile:ok,失败为失败原因String

fail 返回参数

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

使用示例

Callback 风格

wx.cloud.downloadFile({
fileID: 'a7xzcb',
success: res => {
// get temp file path
console.log(res.tempFilePath)
},
fail: err => {
// handle error
}
})

Promise 风格

wx.cloud.downloadFile({
fileID: 'a7xzcb'
}).then(res => {
// get temp file path
console.log(res.tempFilePath)
}).catch(error => {
// handle error
})

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


downloadFile

从云存储空间下载文件

请求参数

字段说明数据类型默认值必填
fileID云文件 IDString-Y

Promise 返回参数

字段说明数据类型
fileContent文件内容Buffer
statusCode服务器返回的 HTTP 状态码Number

错误返回参数

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

使用示例

Promise 风格

const cloud = require('wx-server-sdk')
cloud.init({
env: cloud.DYNAMIC_CURRENT_ENV
})
exports.main = async (event, context) => {
const fileID = 'xxxx'
const res = await cloud.downloadFile({
fileID: fileID,
})
const buffer = res.fileContent
return buffer.toString('utf8')
}