宜信同城网交流论坛技术专版技术专区Downloader模块管理网络文件下载任务Downloader模块管理网络文件下载任务，用于从服务器下载各种文件，并支持跨域访问操作。通过plus.d ...

admin 发表于 2023-2-16 18:54:54

Downloader模块管理网络文件下载任务

<div id="article_content" class="article_content clearfix">
 <link rel="stylesheet" href="https://csdnimg.cn/release/blogv2/dist/mdeditor/css/editerView/kdoc_html_views-1a98987dfd.css">
 <link rel="stylesheet" href="https://csdnimg.cn/release/blogv2/dist/mdeditor/css/editerView/ck_htmledit_views-6e43165c0a.css">
 <div id="content_views" class="htmledit_views">
 Downloader模块管理网络文件下载任务，用于从服务器下载各种文件，并支持跨域访问操作。通过plus.downloader获取下载管理对象。Downloader下载使用HTTP的GET/POST方式请求下载文件，符合标准HTTP/HTTPS传输协议。
<h2 style="margin-left:.8em;">方法：</h2>
<ul><li><ahref="https://blog.csdn.net/qq_40575646/article/details/122686072#plus.downloader.createDownload">createDownload</a>: 新建下载任务</li><li><ahref="https://blog.csdn.net/qq_40575646/article/details/122686072#plus.downloader.enumerate">enumerate</a>: 枚举下载任务</li><li><ahref="https://blog.csdn.net/qq_40575646/article/details/122686072#plus.downloader.clear">clear</a>: 清除下载任务</li><li><ahref="https://blog.csdn.net/qq_40575646/article/details/122686072#plus.downloader.startAll">startAll</a>: 开始所有下载任务</li></ul>
<h2 style="margin-left:.8em;">对象：</h2>
<ul><li><ahref="https://www.html5plus.org/doc/zh_cn/downloader.html#plus.downloader.Download">Download</a>: Download对象管理一个下载任务</li><li><ahref="https://www.html5plus.org/doc/zh_cn/downloader.html#plus.downloader.DownloadEvent">DownloadEvent</a>: 下载任务事件类型</li><li><ahref="https://www.html5plus.org/doc/zh_cn/downloader.html#plus.downloader.DownloadState">DownloadState</a>: 下载任务状态</li><li><ahref="https://www.html5plus.org/doc/zh_cn/downloader.html#plus.downloader.DownloadOptions">DownloadOptions</a>: 下载任务参数</li></ul>
<h2 style="margin-left:.8em;">回调方法：</h2>
<ul><li><ahref="https://www.html5plus.org/doc/zh_cn/downloader.html#plus.downloader.DownloadCompletedCallback">DownloadCompletedCallback</a>: 下载任务完成时的回调</li><li><ahref="https://www.html5plus.org/doc/zh_cn/downloader.html#plus.downloader.DownloadStateChangedCallback">DownloadStateChangedCallback</a>: 下载任务状态变化回调</li><li><ahref="https://www.html5plus.org/doc/zh_cn/downloader.html#plus.downloader.DownloadEnumerateCallback">DownloadEnumerateCallback</a>: 枚举下载任务回调</li></ul>
<h2 style="margin-left:.8em;">权限：</h2>
5+功能模块（permissions）
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
{
// ...
"permissions":{
// ...
"Downloader": {
"description": "文件下载，管理文件下载任务"
}
}
}
</code></code></pre>
<h1 style="margin-left:0;">createDownload</h1>
新建下载任务
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
Download plus.downloader.createDownload(url, options, completedCB);
</code></code></pre>
<h2 style="margin-left:.8em;">说明：</h2>
请求下载管理创建新的下载任务，创建成功则返回Download对象，用于管理下载任务。
<h2 style="margin-left:.8em;">参数：</h2>
<ul><li>url: ( String ) 必选 要下载文件资源地址 要下载文件的url地址，仅支持网络资源地址，支持http或https协议。允许创建多个相同url地址的下载任务。注意：如果url地址中包含中文或空格等，需要进行urlencode转换。 </li><li>options: ( <ahref="https://www.html5plus.org/doc/zh_cn/downloader.html#plus.downloader.DownloadOptions">DownloadOptions</a> ) 可选 下载任务的参数 可通过此参数设置下载任务属性，如保存文件路径、下载优先级等。 </li><li>completedCB: ( <ahref="https://blog.csdn.net/qq_40575646/article/details/122686072#plus.downloader.DownloadCompletedCallback">DownloadCompletedCallback</a> ) 可选 下载任务完成回调函数 当下载任务下载完成时触发，成功或失败都会触发。 </li></ul>
<h2 style="margin-left:.8em;">返回值：</h2>
<ahref="https://blog.csdn.net/qq_40575646/article/details/122686072#plus.downloader.Download">Download</a> : 新建的下载任务对象
<h2 style="margin-left:.8em;">示例：</h2>
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
// 创建下载任务
function createDownload() {
var dtask = plus.downloader.createDownload("http://www.abc.com/a.doc", {}, function(d, status){
// 下载完成
if(status == 200){
console.log("Download success: " + d.filename);
} else {
console.log("Download failed: " + status);
}
});
//dtask.addEventListener("statechanged", onStateChanged, false);
dtask.start();
}
</code></code></pre>
<ahref="https://uniapp.dcloud.io/use-html5plus">uni-app使用plus注意事项</a>
<h1 style="margin-left:0;">enumerate</h1>
枚举下载任务
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
plus.downloader.enumerate( enumCB, state );
</code></code></pre>
<h2 style="margin-left:.8em;">说明：</h2>
枚举指定状态的下载任务列表，通过enumCB回调函数返回结果。
<h2 style="margin-left:.8em;">参数：</h2>
<ul><li>enumCB: ( <ahref="https://blog.csdn.net/qq_40575646/article/details/122686072#plus.downloader.DownloadEnumerateCallback">DownloadEnumerateCallback</a> ) 必选 枚举下载任务回调函数 枚举下载任务完成时触发。 </li><li>state: ( <ahref="https://www.html5plus.org/doc/zh_cn/downloader.html#plus.downloader.DownloadState">DownloadState</a> ) 可选 枚举下载任务的状态 如果未指定state值，则枚举所有未完成的下载任务。 </li></ul>
<h2 style="margin-left:.8em;">返回值：</h2>
void : 无
<h2 style="margin-left:.8em;">示例：</h2>
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
// 枚举下载任务 
function enumerateDwonload() {
plus.downloader.enumerate(function(tasks){
console.log("Unfinished task count: " + tasks.length);
});
}
</code></code></pre>
<ahref="https://uniapp.dcloud.io/use-html5plus">uni-app使用plus注意事项</a>
<h1 style="margin-left:0;">clear</h1>
清除下载任务
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
plus.downloader.clear(state);
</code></code></pre>
<h2 style="margin-left:.8em;">说明：</h2>
清除指定状态的下载任务。
<h2 style="margin-left:.8em;">参数：</h2>
<ul><li>state: ( <ahref="https://www.html5plus.org/doc/zh_cn/downloader.html#plus.downloader.DownloadState">DownloadState</a> ) 可选 清除下载任务的状态 如果未指定state值，则清除所有未完成的下载任务。 </li></ul>
<h2 style="margin-left:.8em;">返回值：</h2>
void : 无
<h2 style="margin-left:.8em;">示例：</h2>
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
// 清除下载任务 
function onPlusReady() {
plus.downloader.clear();
}
</code></code></pre>
<ahref="https://uniapp.dcloud.io/use-html5plus">uni-app使用plus注意事项</a>
<h1 style="margin-left:0;">startAll</h1>
开始所有下载任务
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
plus.downloader.startAll();
</code></code></pre>
<h2 style="margin-left:.8em;">说明：</h2>
开始所有处于为开始调度或暂停状态的下载任务。若下载任务数超过可并发处理的总数，超出的任务处于调度状态（等待下载），当有任务完成时根据调度状态任务的优先级选择任务开始下载。
<h2 style="margin-left:.8em;">参数：</h2>
<h2 style="margin-left:.8em;">返回值：</h2>
void : 无
<h2 style="margin-left:.8em;">示例：</h2>
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
// 开始所有下载任务
function onPlusReady() {
plus.downloader.startAll();
}
</code></code></pre>
<ahref="https://uniapp.dcloud.io/use-html5plus">uni-app使用plus注意事项</a>
<h1 style="margin-left:0;">Download</h1>
Download对象管理一个下载任务
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
interface plus.downloader.Download {
readonly attribute String id;
readonly attribute String url;
readonly attribute Number state;
readonly attribute DownloadOptions options;
readonly attribute String filename;
readonly attribute Number downloadedSize;
readonly attribute Number totalSize;
function void abort();
function void addEventListener(String event, function Callback listener, Boolean capture);
function String getAllResponseHeaders();
function String getResponseHeader(String headerName);
function void pause();
function void resume();
function void setRequestHeader(String headerName, String headerValue);
function void start();
}
</code></code></pre>
<h2 style="margin-left:.8em;">属性：</h2>
<ul><li><ahref="https://blog.csdn.net/qq_40575646/article/details/122686072#plus.downloader.Download.id">id</a>: 下载任务的标识</li><li><ahref="https://blog.csdn.net/qq_40575646/article/details/122686072#plus.downloader.Download.url">url</a>: 下载文件的地址</li><li><ahref="https://blog.csdn.net/qq_40575646/article/details/122686072#plus.downloader.Download.state">state</a>: 任务的状态</li><li><ahref="https://blog.csdn.net/qq_40575646/article/details/122686072#plus.downloader.Download.options">options</a>: 下载任务的参数</li><li><ahref="https://blog.csdn.net/qq_40575646/article/details/122686072#plus.downloader.Download.filename">filename</a>: 下载的文件名称</li><li><ahref="https://blog.csdn.net/qq_40575646/article/details/122686072#plus.downloader.Download.downloadedSize">downloadedSize</a>: 已完成下载文件的大小</li><li><ahref="https://blog.csdn.net/qq_40575646/article/details/122686072#plus.downloader.Download.totalSize">totalSize</a>: 下载任务文件的总大小</li></ul>
<h2 style="margin-left:.8em;">方法：</h2>
<ul><li><ahref="https://blog.csdn.net/qq_40575646/article/details/122686072#plus.downloader.Download.abort">abort</a>: 取消下载任务</li><li><ahref="https://blog.csdn.net/qq_40575646/article/details/122686072#plus.downloader.Download.addEventListener">addEventListener</a>: 添加下载任务事件监听器</li><li><ahref="https://blog.csdn.net/qq_40575646/article/details/122686072#plus.downloader.Download.getAllResponseHeaders">getAllResponseHeaders</a>: 获取下载请求HTTP响应头部信息</li><li><ahref="https://blog.csdn.net/qq_40575646/article/details/122686072#plus.downloader.Download.getResponseHeader">getResponseHeader</a>: 获取下载请求指定的HTTP响应头部的值</li><li><ahref="https://blog.csdn.net/qq_40575646/article/details/122686072#plus.downloader.Download.pause">pause</a>: 暂停下载任务</li><li><ahref="https://blog.csdn.net/qq_40575646/article/details/122686072#plus.downloader.Download.resume">resume</a>: 恢复暂停的下载任务</li><li><ahref="https://blog.csdn.net/qq_40575646/article/details/122686072#plus.downloader.Download.setRequestHeader">setRequestHeader</a>: 设置下载请求的HTTP头数据</li><li><ahref="https://blog.csdn.net/qq_40575646/article/details/122686072#plus.downloader.Download.start">start</a>: 开始下载任务</li></ul>
<h1 style="margin-left:0;">id</h1>
下载任务的标识
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
download.id;
</code></code></pre>
<h2 style="margin-left:.8em;">说明：</h2>
String 类型只读属性
在创建任务时系统自动分配，用于标识下载任务的唯一性。
<h1 style="margin-left:0;">url</h1>
下载文件的地址
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
download.url;
</code></code></pre>
<h2 style="margin-left:.8em;">说明：</h2>
String 类型只读属性
调用plus.donwloader.createDownload()方法创建下载任务时设置的值。
<h1 style="margin-left:0;">state</h1>
任务的状态
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
download.state;
</code></code></pre>
<h2 style="margin-left:.8em;">说明：</h2>
<ahref="https://blog.csdn.net/qq_40575646/article/details/122686072#plus.downloader.DownloadState">DownloadState</a> 类型只读属性
表示当前下载任务的状态，可通过addEventListener()方法监听statechanged事件监听任务状态的变化。
<h1 style="margin-left:0;">options</h1>
下载任务的参数
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
download.options;
</code></code></pre>
<h2 style="margin-left:.8em;">说明：</h2>
<ahref="https://blog.csdn.net/qq_40575646/article/details/122686072#plus.downloader.DownloadOptions">DownloadOptions</a> 类型只读属性
调用plus.donwloader.createDownload()方法创建下载任务时设置的参数。
<h1 style="margin-left:0;">filename</h1>
下载的文件名称
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
download.filename;
</code></code></pre>
<h2 style="margin-left:.8em;">说明：</h2>
String 类型只读属性
下载任务在本地保存的文件路径，下载任务完成时更新，可通过此值访问下载的文件。
<h1 style="margin-left:0;">downloadedSize</h1>
已完成下载文件的大小
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
download.downloadedSize;
</code></code></pre>
<h2 style="margin-left:.8em;">说明：</h2>
Number 类型只读属性
整数类型，单位为字节（byte），下载任务开始传输数据时，每次触发statechanged事件或下载任务完成时更新。
<h1 style="margin-left:0;">totalSize</h1>
下载任务文件的总大小
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
download.totalSize;
</code></code></pre>
<h2 style="margin-left:.8em;">说明：</h2>
Number 类型只读属性
整数类型，单位为字节（byte），下载任务开始传输数据时更新，在此之前其值为0。此值是从HTTP协议的Content-Length中获取，如果服务器未返回Content-Length数据则此值始终为0。
<h1 style="margin-left:0;">abort</h1>
取消下载任务
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
void download.abort();
</code></code></pre>
<h2 style="margin-left:.8em;">说明：</h2>
如果任务未完成，则终止下载，并从任务列表中删除。如下载未完成，将删除已下载的临时文件，如果下载已完成，将不删除已下载的文件。
<h2 style="margin-left:.8em;">参数：</h2>
<h2 style="margin-left:.8em;">返回值：</h2>
void : 无
<h2 style="margin-left:.8em;">示例：</h2>
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
var dtask = null;
// 创建下载任务
function createDownload() {
dtask = plus.downloader.createDownload("http://www.abc.com/a.doc", {}, function(d, status){
// 下载完成
if(status == 200){
console.log("Download success: " + d.filename);
}else{
console.log("Download failed: " + status);
}
});
//dtask.addEventListener("statechanged", onStateChanged, false);
dtask.start();
}
// 暂停下载任务 
function pauseDownload() {
dtask.pause();
}
// 取消下载任务 
function abortDownload() {
dtask.abort();
}
</code></code></pre>
<ahref="https://uniapp.dcloud.io/use-html5plus">uni-app使用plus注意事项</a>
<h1 style="margin-left:0;">addEventListener</h1>
添加下载任务事件监听器
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
void download.addEventListener(type, listener, capture);
</code></code></pre>
<h2 style="margin-left:.8em;">说明：</h2>
下载任务添加事件监听器后，当监听的事件发生时触发listener回调。
<h2 style="margin-left:.8em;">参数：</h2>
<ul><li>type: ( <ahref="https://blog.csdn.net/qq_40575646/article/details/122686072#plus.downloader.DownloadEvent">DownloadEvent</a> ) 必选 事件类型 </li><li>listener: ( <ahref="https://blog.csdn.net/qq_40575646/article/details/122686072#plus.downloader.DownloadStateChangedCallback">DownloadStateChangedCallback</a> ) 可选 事件监听器回调 当监听的事件发生时，触发设置的回调函数。 </li><li>capture: ( Boolean ) 可选 事件流处理顺序，暂不支持 </li></ul>
<h2 style="margin-left:.8em;">返回值：</h2>
void : 无
<h2 style="margin-left:.8em;">示例：</h2>
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
var dtask = null;
// 监听下载任务状态 
function onStateChanged(download, status) {
if(download.state == 4 && status == 200){
// 下载完成 
console.log("Download success: " + download.getFileName());
}
}
// 创建下载任务
function createDownload() {
dtask = plus.downloader.createDownload("http://www.abc.com/a.doc");
dtask.addEventListener("statechanged", onStateChanged, false);
dtask.start();
}
// 暂停下载任务 
function pauseDownload() {
dtask.pause();
}
// 取消下载任务 
function abortDownload() {
dtask.abort();
}
</code></code></pre>
<ahref="https://uniapp.dcloud.io/use-html5plus">uni-app使用plus注意事项</a>
<h1 style="margin-left:0;">getAllResponseHeaders</h1>
获取下载请求HTTP响应头部信息
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
String download.getAllResponseHeaders();
</code></code></pre>
<h2 style="margin-left:.8em;">说明：</h2>
HTTP响应头部全部内容作为未解析的字符串返回，如果没有接收到这个HTTP响应头数据或者下载请求未完成则为空字符串。
<h2 style="margin-left:.8em;">参数：</h2>
无
<h2 style="margin-left:.8em;">返回值：</h2>
String : HTTP响应头数据
<h2 style="margin-left:.8em;">示例：</h2>
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
var dtask = null;
// 创建下载任务
function createDownload() {
var dtask = plus.downloader.createDownload("http://www.abc.com/a.doc", {}, function(d, status){
// 下载完成
if(status == 200){
console.log(dtask.getAllResponseHeaders()); // 获取下载请求响应头数据
console.log("Download success: " + d.filename);
}else{
console.log("Download failed: " + status);
}
});
dtask.start();
}
</code></code></pre>
<ahref="https://uniapp.dcloud.io/use-html5plus">uni-app使用plus注意事项</a>
<h1 style="margin-left:0;">getResponseHeader</h1>
获取下载请求指定的HTTP响应头部的值
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
String download.getResponseHeader(String headerName);
</code></code></pre>
<h2 style="margin-left:.8em;">说明：</h2>
其参数是要返回的HTTP响应头部的名称，可以使用任何大小写来制定这个头部名字，和响应头部的比较是不区分大小写的。如果没有接收到这个头部或者下载请求未完成则为空字符串；如果接收到多个有指定名称的头部，这个头部的值被连接起来并返回，使用逗号和空格分隔开各个头部的值。
<h2 style="margin-left:.8em;">参数：</h2>
<ul><li>headerName: ( String ) 可选 HTTP响应头数据名称 </li></ul>
<h2 style="margin-left:.8em;">返回值：</h2>
String : HTTP响应头数据值
<h2 style="margin-left:.8em;">示例：</h2>
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
var dtask = null;
// 创建下载任务
function createDownload() {
var dtask = plus.downloader.createDownload("http://www.abc.com/a.doc", {}, function(d, status){
// 下载完成
if ( status == 200 ) {
console.log(dtask.getResponseHeader("Content-Type"));
} else {
console.log("Download failed: " + status);
}
});
dtask.start();
}
</code></code></pre>
<ahref="https://uniapp.dcloud.io/use-html5plus">uni-app使用plus注意事项</a>
<h1 style="margin-left:0;">pause</h1>
暂停下载任务
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
void download.pause();
</code></code></pre>
<h2 style="margin-left:.8em;">说明：</h2>
暂停下载任务，如果任务已经处于初始状态或暂停状态则无任何响应。通常在任务已开始后暂停任务。
<h2 style="margin-left:.8em;">参数：</h2>
<h2 style="margin-left:.8em;">返回值：</h2>
void : 无
<h2 style="margin-left:.8em;">示例：</h2>
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
var dtask = null;
// 创建下载任务
function createDownload() {
dtask = plus.downloader.createDownload("http://www.abc.com/a.doc", {}, function(d, status){
// 下载完成
if(status == 200){
console.log("Download success: " + d.filename);
} else {
console.log("Download failed: " + status);
}
});
//dtask.addEventListener("statechanged", onStateChanged, false);
dtask.start();
}
// 暂停下载任务 
function pauseDownload() {
dtask.pause();
}
</code></code></pre>
<ahref="https://uniapp.dcloud.io/use-html5plus">uni-app使用plus注意事项</a>
<h1 style="margin-left:0;">resume</h1>
恢复暂停的下载任务
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
void download.resume();
</code></code></pre>
<h2 style="margin-left:.8em;">说明：</h2>
继续暂停的下载任务，如果任务处于非暂停状态则无任何响应。
<h2 style="margin-left:.8em;">参数：</h2>
<h2 style="margin-left:.8em;">返回值：</h2>
void : 无
<h2 style="margin-left:.8em;">示例：</h2>
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
var dtask = null;
// 创建下载任务
function createDownload() {
dtask = plus.downloader.createDownload("http://www.abc.com/a.doc", {}, function(d, status){
// 下载完成
if(status == 200){
console.log("Download success: " + d.filename);
}else{
console.log("Download failed: " + status);
}
});
//dtask.addEventListener("statechanged", onStateChanged, false);
dtask.start();
}
// 暂停下载任务
function pauseDownload() {
dtask.pause();
}
// 恢复下载任务
function resumeDownload() {
dtask.resume();
}
</code></code></pre>
<ahref="https://uniapp.dcloud.io/use-html5plus">uni-app使用plus注意事项</a>
<h1 style="margin-left:0;">setRequestHeader</h1>
设置下载请求的HTTP头数据
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
void download.setRequestHeader( headerName, headerValue );
</code></code></pre>
<h2 style="margin-left:.8em;">说明：</h2>
Http的Header应该包含在通过后续start()调用而发起的请求中，此方法必需在调用start()之前设置才能生效。如果带有指定名称的头部已经被指定了，这个头部的新值就是：之前指定的值，加上逗号、以及这个调用指定的值（形成一个数组）。
<h2 style="margin-left:.8em;">参数：</h2>
<ul><li>headerName: ( String ) 必选 HTTP请求的头数据名称 </li><li>headerValue: ( String ) 必选 HTTP请求的头数据值 </li></ul>
<h2 style="margin-left:.8em;">返回值：</h2>
void : 无
<h2 style="margin-left:.8em;">平台支持：</h2>
<ul><li>Android - 2.2+ (支持) : 不支持设置“User-Agent”、“Cookie”的值。 </li><li>iOS - 5.1+ (支持) : 不支持设置“User-Agent”的值。 </li></ul>
<h2 style="margin-left:.8em;">示例：</h2>
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
var dtask = null;
// 创建下载任务
function createDownload() {
var dtask = plus.downloader.createDownload("http://www.abc.com/a.doc", {method:"POST",data:"{name:'test',id:'1234567890'}"}, function(d, status){
// 下载完成
if(status == 200){
console.log("Download success: " + d.filename);
}else{
console.log("Download failed: " + status);
}
});// POST请求提交数据
dtask.setRequestHeader('Content-Type','application/json');// 设置POST请求提交的数据类型为JSON字符串
dtask.start();
}
</code></code></pre>
<ahref="https://uniapp.dcloud.io/use-html5plus">uni-app使用plus注意事项</a>
<h1 style="margin-left:0;">start</h1>
开始下载任务
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
void download.start();
</code></code></pre>
<h2 style="margin-left:.8em;">说明：</h2>
开始下载任务，如果任务已经处于开始状态则无任何响应。在创建任务或任务下载失败后调用可重新开始下载。
<h2 style="margin-left:.8em;">参数：</h2>
无
<h2 style="margin-left:.8em;">返回值：</h2>
void : 无
<h2 style="margin-left:.8em;">示例：</h2>
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
var dtask = null;
// 创建下载任务
function createDownload() {
var dtask = plus.downloader.createDownload("http://www.abc.com/a.doc", {}, function(d, status){
// 下载完成
if(status == 200){
console.log("Download success: " + d.filename);
}else{
console.log("Download failed: " + status);
}
});
//dtask.addEventListener("statechanged", onStateChanged, false);
dtask.start();
}
</code></code></pre>
<ahref="https://uniapp.dcloud.io/use-html5plus">uni-app使用plus注意事项</a>
<h1 style="margin-left:0;">DownloadEvent</h1>
下载任务事件类型
<h2 style="margin-left:.8em;">常量：</h2>
<ul><li>"statechanged": (String 类型 )下载任务状态变化事件 当下载任务状态发生变化时触发此事件，事件原型参考DownloadStateChangedCallback。 </li></ul>
<h2 style="margin-left:.8em;">示例：</h2>
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
var dtask = null;
// 扩展API加载完毕，现在可以正常调用扩展API 
function onPlusReady() {
}
// 监听下载任务状态 
function onStateChanged(download, status) {
if(download.state == 4 && status == 200){
// 下载完成 
console.log("Download success: " + download.getFileName());
}
}
// 创建下载任务
function createDownload() {
dtask = plus.downloader.createDownload("http://www.abc.com/a.doc");
dtask.addEventListener("statechanged", onStateChanged, false);
dtask.start();
}
// 暂停下载任务 
function pauseDownload() {
dtask.pause();
}
// 取消下载任务 
function abortDownload() {
dtask.abort();
}
</code></code></pre>
<ahref="https://uniapp.dcloud.io/use-html5plus">uni-app使用plus注意事项</a>
<h1 style="margin-left:0;">DownloadState</h1>
下载任务状态
<h2 style="margin-left:.8em;">常量：</h2>
<ul><li>undefined: (undefined 类型 )下载任务未开始 通过plus.downloader.createDownload()方法创建下载任务后的初始状态，此时可调用其start()方法开始下载。 </li><li>0: (Number 类型 )下载任务开始调度 调用下载任务的start()方法之后处于此状态，此时下载任务处于可调度下载状态。 </li><li>1: (Number 类型 )下载任务开始请求 下载任务建立网络连接，发送请求到服务器并等待服务器的响应。 </li><li>2: (Number 类型 )下载任务请求已经接收 下载任务网络连接已建立，服务器返回响应，准备传输数据内容。 </li><li>3: (Number 类型 )下载任务接收数据 下载任务接收数据，监听statechanged事件时可多次触发此状态。 </li><li>4: (Number 类型 )下载任务已完成 下载任务完成数据传输并断开连接，下载成功或失败都会设置为此状态。 </li><li>5: (Number 类型 )下载任务已暂停 调用下载任务的pause()方法将任务暂停，此时可调用其resume()方法重新开始下载。 </li><li>-1: (Number 类型 )枚举任务状态 非下载任务状态，泛指所有下载任务的状态，用于enumerate()和clear()操作时指定作用于所有下载任务。 </li></ul>
<h1 style="margin-left:0;">DownloadOptions</h1>
下载任务参数
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
interface plus.downloader.DownloadOptions {
readonly attribute String method;
readonly attribute String data;
readonly attribute String filename;
readonly attribute Number priority;
readonly attribute Number timeout;
readonly attribute Number retry;
readonly attribute Number retryInterval;
}
</code></code></pre>
<h2 style="margin-left:.8em;">说明：</h2>
在创建下载任务时设置的参数，如设置下载任务使用的HTTP协议类型、优先级等。
<h2 style="margin-left:.8em;">属性：</h2>
<ul><li>method: (String 类型 )网络请求类型 支持http协议的“GET”、“POST”，默认为“GET”请求。 </li><li>data: (String 类型 )POST请求时提交的数据 仅在网络请求类型method设置为"POST"时有效，"GET"请求时忽略此数据。 </li><li>filename: (String 类型 )下载文件保存的路径 保存文件路径仅支持以"_downloads/"、"_doc/"、"_documents/"开头的字符串。文件路径以文件后缀名结尾（如"_doc/download/a.doc"）表明指定保存文件目录及名称，以“/”结尾则认为指定保存文件的目录（此时程序自动生成文件名）。如果指定的文件已经存在，则自动在文件名后面加"(i)"，其中i为数字，如果文件名称后面已经是此格式，则数字i递增，如"download(1).doc"。默认保存目录为（"_downloads"），并自动生成文件名称。 </li><li>priority: (Number 类型 )下载任务的优先级 数值类型，数值越大优先级越高，默认优先级值为0。 </li><li>timeout: (Number 类型 )下载任务超时时间 数值类型，单位为s(秒)，默认值为120s。超时时间为服务器响应请求的时间（不是下载任务完成的总时间），如果设置为0则表示永远不超时。 </li><li>retry: (Number 类型 )下载任务重试次数 数值类型，默认为重试3次。 </li><li>retryInterval: (Number 类型 )下载任务重试间隔时间 数值类型，单位为s(秒)，默认值为30s。 </li></ul>
<h1 style="margin-left:0;">DownloadCompletedCallback</h1>
下载任务完成时的回调
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
vaoid onCompleted(Download download, Number status) {
// Download file complete code
}
</code></code></pre>
<h2 style="margin-left:.8em;">说明：</h2>
下载任务完成时的回调函数，在下载任务完成时调用。下载任务失败也将触发此回调。
<h2 style="margin-left:.8em;">参数：</h2>
<ul><li>download : ( <ahref="https://www.html5plus.org/doc/zh_cn/downloader.html#plus.downloader.Download">Download</a> ) 必选 下载任务对象 </li><li>status: ( Number ) 必选 下载结果状态码 HTTP传输协议状态码，如果未获取传输状态则其值则为0，如下载成功其值通常为200。 </li></ul>
<h2 style="margin-left:.8em;">返回值：</h2>
void : 无
<h1 style="margin-left:0;">DownloadStateChangedCallback</h1>
下载任务状态变化回调
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
void onStateChanged( Download download, status ) {
// Download state changed code.
}
</code></code></pre>
<h2 style="margin-left:.8em;">参数：</h2>
<ul><li>download : ( <ahref="https://www.html5plus.org/doc/zh_cn/downloader.html#plus.downloader.Download">Download</a> ) 必选 下载任务对象 </li><li>status: ( Number ) 必选 下载结果状态码 HTTP传输协议状态码，如果未获取传输状态则其值则为0，如下载成功其值通常为200。 </li></ul>
<h2 style="margin-left:.8em;">返回值：</h2>
void : 无
<h1 style="margin-left:0;">DownloadEnumerateCallback</h1>
枚举下载任务回调
<pre class="has" style="margin-left:0;"><code class="language-prettyprint"><code>
void onEnumerated( Download[] downloads ) {
// Enumerate success code
}
</code></code></pre>
<h2 style="margin-left:.8em;">参数：</h2>
<ul><li>downloads: ( Array[<ahref="https://www.html5plus.org/doc/zh_cn/downloader.html#plus.downloader.Download">Download</a>] ) 必选 枚举到的下载任务对象数组 </li></ul>
<h2 style="margin-left:.8em;">返回值：</h2>
void : 无
 </div>
 </div>
 <div id="treeSkill"></div>

页: [1]

宜信同城网交流论坛's Archiver

Downloader模块管理网络文件下载任务