下载文件资源到本地。客户端直接发起一个 HTTPS GET 请求，返回文件的本地临时路径 (本地路径)，单次下载允许的最大文件为 200MB。
注意：请在服务端响应的 header 中指定合理的
Content-Type字段，以保证客户端正确处理文件类型。
Object object
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| url | String | 是 | 下载资源的 url | |
| header | Object | 否 | HTTP 请求的 Header，Header 中不能设置 Referer | |
| timeout | Number | 60000 | 否 | 超时时间，单位为毫秒，默认值为 60000 即一分钟。 |
| filePath | String | 否 | 指定文件下载后存储的路径 (本地路径) | |
| success | Function | 否 | 接口调用成功的回调函数 | |
| fail | Function | 否 | 接口调用失败的回调函数 | |
| complete | Function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
| 属性 | 类型 | 说明 |
|---|---|---|
| tempFilePath | String | 临时文件路径 (本地路径)。没传入 filePath 指定文件存储路径时会返回，下载后的文件会存储到一个临时文件 |
| filePath | String | 用户文件路径 (本地路径)。传入 filePath 时会返回，跟传入的 filePath 一致 |
| statusCode | Number | 开发者服务器返回的 HTTP 状态码 |
qg.downloadFile({
url: "https://example.com/audio/123", //仅为示例，并非真实的资源
success(res) {
// 只要服务器有响应数据，就会把响应内容写入文件并进入 success 回调，业务需要自行判断是否下载到了想要的内容
if (res.statusCode === 200) {
qg.playVoice({
filePath: res.tempFilePath
});
}
}
});
一个可以监听下载进度变化事件，以及取消下载任务的对象
监听 HTTP Response Header 事件。会比请求完成事件更早
HTTP Response Header 事件的监听函数
| 属性 | 类型 | 说明 |
|---|---|---|
| header | Object | 开发者服务器返回的 HTTP Response Header |
监听下载进度变化事件
下载进度变化事件的监听函数
| 属性 | 类型 | 说明 |
|---|---|---|
| progress | Number | 下载进度百分比 |
| totalBytesWritten | Number | 已经下载的数据长度，单位 Bytes |
| totalBytesExpectedToWrite | Number | 预期需要下载的数据总长度，单位 Bytes |
移除下载进度变化事件的监听函数
onProgressUpdate 传入的监听函数。不传此参数则移除所有监听函数。
const listener = function(res) {
console.log(res);
};
DownloadTask.onProgressUpdate(listener);
DownloadTask.offProgressUpdate(listener); // 需传入与监听时同一个的函数对象
移除 HTTP Response Header 事件的监听函数
onHeadersReceived 传入的监听函数。不传此参数则移除所有监听函数。
const listener = function(res) {
console.log(res);
};
DownloadTask.onHeadersReceived(listener);
DownloadTask.offHeadersReceived(listener); // 需传入与监听时同一个的函数对象
中断下载任务
const downloadTask = qg.downloadFile({
url: "http://example.com/audio/123", //仅为示例，并非真实的资源
success(res) {
qg.playVoice({
filePath: res.tempFilePath
});
}
});
downloadTask.onProgressUpdate(res => {
console.log("下载进度", res.progress);
console.log("已经下载的数据长度", res.totalBytesWritten);
console.log("预期需要下载的数据总长度", res.totalBytesExpectedToWrite);
});
downloadTask.abort(); // 取消下载任务