跳到主要内容

DownloadFileTask mgtv.downloadFile(Object object)

下载文件资源到本地。客户端直接发起一个 HTTPS GET 请求,返回文件的本地临时路径 (本地路径),单次下载允许的最大文件为 200MB。 注意:请在服务端响应的 header 中指定合理的 Content-Type 字段,以保证客户端正确处理文件类型。

参数​

Object object​

属性类型默认值必填说明
urlstring是下载资源的url
headerObject否HTTP 请求的 Header,Header 中不能设置 Referer
timeoutnumber否超时时间,单位为毫秒
filePathstring否指定文件下载后存储的路径 (本地路径)(未实现)
successfunction否接口调用成功的回调函数
failfunction否接口调用失败的回调函数
completefunction否接口调用结束的回调函数(调用成功、失败都会执行)

object.success 回调函数​

参数

Object res​

属性类型说明
tempFilePathstring临时文件路径 (本地路径)。没传入 filePath 指定文件存储路径时会返回,下载后的文件会存储到一个临时文件
filePathstring用户文件路径 (本地路径)。传入 filePath 时会返回,跟传入的 filePath 一致
statusCodenumber开发者服务器返回的 HTTP 状态码

返回值​

DownloadTask​

一个可以监听下载进度变化事件和取消下载的对象

示例代码​

mgtv.downloadFile({
url: 'https://example.com/audio/123', //仅为示例,并非真实的资源
success (res) {
// 只要服务器有响应数据,就会把响应内容写入文件并进入 success 回调,业务需要自行判断是否下载到了想要的内容
if (res.statusCode === 200) {
mgtv.playVoice({
filePath: res.tempFilePath
})
}
}
})