onlymash/RxDownload

A multi-threaded download tool written with RxJava and Kotlin

Download

Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.onlymash:RxDownload:1.2.6'
	}

	dependencies {
		implementation("com.github.onlymash:RxDownload:1.2.6")
	}

	<dependency>
	    <groupId>com.github.onlymash</groupId>
	    <artifactId>RxDownload</artifactId>
	    <version>1.2.6</version>
	</dependency>


                            
    libraryDependencies += "com.github.onlymash" % "RxDownload" % "1.2.6"


                            
    :dependencies [[com.github.onlymash/RxDownload "1.2.6"]]

Readme

RxDownload

A multi-threaded download tool written with RxJava and Kotlin

Read this in other languages: 中文, English

How to Use

Preparation

1.Add Gradle dependencies

dependencies{
    compile 'zlc.season:rxdownload3:x.y.z'
}

2.Configure the permissions

<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.MOUNT_UNMOUNT_FILESYSTEMS"/>
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>

Please note that Android 6.0 and above must also apply run-time permissions, if you are unable to download, check permissions

Download

1.Create a mission

Create a mission and receive the status of the download

val disposable = RxDownload.create(mission)
                .observeOn(AndroidSchedulers.mainThread())
                .subscribe { status ->
                    setProgress(status)
                    setActionText(status)
                }

Note: The download status is also received here, the received status will be automatically updated according to the different download status. Repeated calls DO NOT cause the task to be created more than once, so you can call this method wherever you want to receive the state to receive the downloaded state.

2.Start download

RxDownload.start(mission).subscribe()

3.Stop download

RxDownload.stop(mission).subscribe()

Just three steps that is so simple !!

Tip: Creating a mission is an asynchronous operation, so if you need to start the mission immediately after it is created, you have the following options:

In the create () completed callback, as follows

val disposable = RxDownload.create(mission)
                .observeOn(AndroidSchedulers.mainThread())
                .subscribe { status ->
                    //call start()
                    RxDownload.start(mission).subscribe()
                    setProgress(status)
                    setActionText(status)
                }

Or enable autoStart configuration, when autoStart is turned on, the mission will automatically start after created

DownloadConfig.Builder.create(context)
                  .enableAutoStart(true)
                  ...
                  
                  
DownloadConfig.init(builder)

For more APIs please move RxDownload.kt

Configuration

Add your configuration when APP starts up, like this:

class BaseApplication : Application() {

    override fun onCreate() {
        super.onCreate()

        val builder = DownloadConfig.Builder.create(this)
                .enableDb(true)
                .enableNotification(true)
				...

        DownloadConfig.init(builder)
    }
}

Have a wealth of configuration options to meet your needs:

DownloadConfig.Builder.create(this)
                .setFps(20)     //Set the update frequency
                .setDefaultPath("custom download path")     //Set the default download address
                .enableDb(true)     //Enable the database
                .setDbActor(CustomSqliteActor(this))    //Customize the database
                .enableService(true)    //Enable Service
                .enableNotification(true)   //Enable Notification
                .setNotificationFactory(NotificationFactoryImpl())      //Custom notification
                .setOkHttpClientFacotry(OkHttpClientFactoryImpl())      //Custom OKHTTP
                .addExtension(ApkInstallExtension::class.java)    //Add extension

Extension

Customize your exclusive operation

class CustomExtension:Extension {
    override fun init(mission: RealMission) {
        //Init
    }

    override fun action(): Maybe<Any> {
        //Your action
    }
}

Refer to the ApkInstallExtension code

Proguard

No special proguard, just add Retrofit and OKHTTP can be proguard

-dontnote retrofit2.Platform
-dontwarn retrofit2.Platform$Java8
-keepattributes Signature
-keepattributes Exceptions

-dontwarn okhttp3.**
-dontwarn okio.**
-dontwarn javax.annotation.**

License

Copyright 2017 Season.Zlc

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.