RxDownload

A multi-threaded download tool written with RxJava and Kotlin

Read this in other languages: 中文, English, Changelog

Prepare

Add jitpack repo:
```
maven { url 'https://jitpack.io' }
```

Add RxDownload dependency:

//Load on demand
implementation "com.github.ssseasonnn.RxDownload:rxdownload4:1.1.4"
implementation "com.github.ssseasonnn.RxDownload:rxdownload4-manager:1.1.4"
implementation "com.github.ssseasonnn.RxDownload:rxdownload4-notification:1.1.4"
implementation "com.github.ssseasonnn.RxDownload:rxdownload4-recorder:1.1.4"

or: 
//Add all dependencies of RxDownload4
implementation "com.github.ssseasonnn:RxDownload:1.1.4"

Basic Usage

Start download:

disposable = url.download()
        .observeOn(AndroidSchedulers.mainThread())
        .subscribeBy(
                onNext = { progress ->
                    //download progress
                    button.text = "${progress.downloadSizeStr()}/${progress.totalSizeStr()}"
                    button.setProgress(progress)
                },
                onComplete = {
                    //download complete
                    button.text = "Open"
                },
                onError = {
                    //download failed
                    button.text = "Retry"
                }
        )

Stop download:
```
disposable.dispose()    
```

Get download file:

val file = url.file()
// or
val file = task.file() 
// use file...

Delete download files:
```
url.delete()
// or
task.delete() 
```

Task Manager

Get a TaskManager object:
```
val taskManager = url.manager()
```

Subscribe to status update:

//keep this tag for dispose
val tag = taskManager.subscribe { status ->
    // Receive download status
    when (status) {
        is Normal -> {}
        is Started -> {}
        is Downloading -> {}
        is Paused -> {}
        is Completed -> {}
        is Failed -> {}
        is Deleted -> {}
    }
}

progress can be obtained from status, when status is Failed, you can get throwable from it, which is the reason for the failure.

Cancel status update subscription:
```
//dispose tag
taskManager.dispose(tag)
```
Start download:
```
taskManager.start()
```
Stop download:
```
taskManager.stop()
```
Delete download:
```
taskManager.delete()
```

Get download file:

val file = taskManager.file() 
// use file...

Task Recorder

Query single task:

 // Query task with url
 RxDownloadRecorder.getTask("url")
       .observeOn(AndroidSchedulers.mainThread())
       .subscribeBy { TaskEntity ->
           // TaskEntity                        
       }

Query a batch of tasks:

 // Query task with urls
 RxDownloadRecorder.getTaskList("url1","url2","url3")
       .observeOn(AndroidSchedulers.mainThread())
       .subscribeBy { list ->
           // list of TaskEntity                        
       }

Get a list of all downloads:

 RxDownloadRecorder.getAllTask()
       .observeOn(AndroidSchedulers.mainThread())
       .subscribeBy { list ->
           //list of TaskEntity                        
       }

Query all download records for a state:

 // Query all Completed records
 RxDownloadRecorder.getAllTaskWithStatus(Completed())
       .observeOn(AndroidSchedulers.mainThread())
       .subscribeBy { list ->
           //list of TaskEntity                        
       }

Paging query download record list:

 RxDownloadRecorder.getTaskList(page, pageSize)
       .observeOn(AndroidSchedulers.mainThread())
       .subscribeBy { list ->
           //list of TaskEntity                        
       }

Paging query list of download records in a certain state:

 // Get the list of pages that have been Completed
 RxDownloadRecorder.getTaskListWithStatus(Completed(), page, pageSize)
       .observeOn(AndroidSchedulers.mainThread())
       .subscribeBy { list ->
           //list of TaskEntity                        
       }

TaskEntity has a abnormalExit field, which is used to indicate whether the Task has paused by the APP forced close.

Start All:
```
 RxDownloadRecorder.startAll()
```
Stop All:
```
 RxDownloadRecorder.stopAll()
```
Delete All:
```
 RxDownloadRecorder.deleteAll()
```

License