README.md · wangyingjun02/okdownload

# okdownload

## 简介

>可靠，灵活，高性能以及强大的下载引擎。支持单任务下载，多任务串、并行下载，设置多种任务监听等。

## 效果展示：

![Image text](/screenshot/okdownload.gif)

## 安装教程

```shell
npm install @ohos/okdownload --save
```

OpenHarmony npm环境配置等更多内容，请参考 [如何安装OpenHarmony npm包](https://gitee.com/openharmony-tpc/docs/blob/master/OpenHarmony_npm_usage.md) 。

## 使用说明

1. 创建单个下载任务：

```
import {DownloadTask} from '@ohos/okdownload'

this.task = new DownloadTask.Builder(url, filename)
    .build()
this.task.execute(listener) //同步执行任务
```

2. 创建多个下载任务：

```
import {DownloadContextListener} from '@ohos/okdownload'
import {DownloadContext, QueueSet} from '@ohos/okdownload'
import {DownloadTask} from '@ohos/okdownload'

let queueSet = new QueueSet();
queueSet.setParentPath('queue')
let builder = queueSet.commit()

let url = "http://cdn.llsapp.com/yy/image/3b0430db-5ff4-455c-9c8d-0213eea7b6c4.jpg"
let boundTask = builder.bindUrl(url, 'task1.jpg')

url = "http://cdn.llsapp.com/yy/image/3b0430db-5ff4-455c-9c8d-0213eea7b6c4.jpg"
boundTask = builder.bindUrl(url, 'task2.jpg')

url = "https://dldir1.qq.com/qqfile/QQforMac/QQ_V6.2.0.dmg"
boundTask = builder.bindUrl(url, 'QQ_V6.2.0.dmg')

this.downloadContext = builder.build();
this.downloadContext.start(listener, false) //true为同步下载， false为异步下载
 ```

## 接口说明
`let builder = new DownloadTask.Builder(url, filename)`
1. 设置优先级
   `builder.setPriority(priority : number)`
2. 设置文件名
   `builder.setFilename(filename: string)`
3. 设置请求头
   `builder.setHeaderMapFields(headerMapFields: object)`
4. 创建DownloadTask
   `builder.build()`
5. 执行下载任务
   `task.execute(listener: DownloadListener)`
6. 异步执行下载任务
   `task.enqueue(listener: DownloadListener)`
7. 异步执行下载任务
   `static enqueueTasks(tasks: DownloadTask[], listener: DownloadListener)`
8. `DownloadContext`
   同步执行任务
   `startOnSerial(listener: DownloadListener)`
9. 异步执行任务
   `startOnParallel(listener: DownloadListener)`
10. 开启下载任务
    `start(listener: DownloadListener, isSerial: boolean)`

## 约束与限制

在下述版本验证通过：

OpenHarmony SDK版本：API version 9版本

## 版权和许可信息

本项目基于 [Apache License 2.0](https://gitee.com/openharmony-sig/okdownload/blob/master/LICENSE)，请自由地享受和参与开源。

wangyingjun02/okdownload

简介

发行版

贡献者

近期动态

wangyingjun02/okdownload .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

wangyingjun02/okdownload