下载任务

接口声明

在manifest.json文件的 features属性中增加如下配置。

{"name": "system.downloadtask"}

导入模块

在调用接口页面的<script>部分增加如下配置。

import downloadtask from '@system.downloadtask'

或

var downloadtask = require("@system.downloadtask")

使用限制

接口定义

downloadtask.downloadFile(OBJECT) (1078+，非厂商联盟规范)

描述

创建一个download请求，每次调用成功将返回一个新的DownloadTask对象。

参数

success返回值

fail返回值

示例代码

this.download_task = downloadtask.downloadFile({
    url: 'https://downloadtext.com',/*非真实地址*/
    success(res) {
        console.log("Download success. resp = " + JSON.stringify(res))
    },
    fail(res) {
        console.log("Download fail. resp = " + JSON.stringify(res))
    }
})

downloadTask.onProgressUpdate(function callback) (1078+，非厂商联盟规范)

描述

监听下载进度变化事件。

参数

下载进度变化事件的回调函数。

callback返回参数

Object类型。

示例代码

this.download_task.onProgressUpdate(res => {
    console.log("Download onProgressUpdate = " + JSON.stringify(res))
})

downloadTask.offProgressUpdate(function callback) (1078+，非厂商联盟规范)

描述

取消监听下载进度变化事件。

参数

下载进度变化事件的回调函数。

示例代码

this.download_task.offProgressUpdate()

downloadTask.onHeadersReceived(function callback) (1078+，非厂商联盟规范)

描述

监听 HTTP Response Header 事件。在文件下载成功回调之前触发。

参数

function callback HTTP Response Header 事件的回调函数

callback返回参数

Object类型。

示例代码

this.download_task.onHeadersReceived(res => {
    console.log("Download onHeaderReceived = " + JSON.stringify(res))
})

downloadTask.offHeadersReceived(OBJECT) (1078+，非厂商联盟规范)

描述

取消监听 HTTP Response Header 事件。

参数

HTTP Response Header 事件的回调函数。

示例代码

this.download_task.offHeadersReceived()

downloadTask.abort() (1078+，非厂商联盟规范)

描述

中断下载任务。

示例代码

this.download_task.abort()

安全要求

对于HTTPS请求，对证书要求如下：

• HTTPS证书必须有效。证书必须被系统信任，不支持自签名证书，部署SSL证书的网站域名必须与证书颁发的域名一致，证书必须在有效期内。
• 从1200版本开始，TLS必须支持1.2及以上版本，请确保HTTPS服务器的TLS版本能够同时支持TLS1.2及以下版本。

  从安全性考虑，建议也支持TLS1.3。1200及以上版本在配置加密套件时排除不安全算法：TEA/DES/DESX/DES40/RC2/RC4/RIPEMD/NULL/SHA0/MD2/MD4/MD5/ANON/TLS_EMPTY_RENEGOTIATION_INFO_SCSV；1200以下版本在配置加密套件时排除不安全算法：TEA/DES/DESX/DES40/RC2/RC4/RIPEMD/eNULL/aNULL/NULL/SHA0/MD2/MD4/MD5/ANON/TLS_EMPTY_RENEGOTIATION_INFO_SCSV。部分CA可能不被操作系统信任，请开发者在选择证书时注意操作系统的相关通告。

相关链接

案例

file.delete接口删除文件失败，返回错误码300