PRDownloader - A file downloader library for Android with pause and resume support

Sample Download

Overview of PRDownloader library

• PRDownloader can be used to download any type of files like image, video, pdf, apk and etc.
• This file downloader library supports pause and resume while downloading a file.
• Supports large file download.
• This downloader library has a simple interface to make download request.
• We can check if the status of downloading with the given download Id.
• PRDownloader gives callbacks for everything like onProgress, onCancel, onStart, onError and etc while downloading a file.
• Supports proper request canceling.
• Many requests can be made in parallel.
• All types of customization are possible.

Using PRDownloader Library in your Android application

Add this in your build.gradle

implementation 'com.mindorks.android:prdownloader:0.5.0'

Do not forget to add internet permission in manifest if already not present

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

Then initialize it in onCreate() Method of application class :

PRDownloader.initialize(getApplicationContext());

Initializing it with some customization

// Enabling database for resume support even after the application is killed:PRDownloaderConfigconfig = PRDownloaderConfig.newBuilder()
.setDatabaseEnabled(true)
.build();
PRDownloader.initialize(getApplicationContext(), config);
// Setting timeout globally for the download network requests:PRDownloaderConfigconfig = PRDownloaderConfig.newBuilder()
.setReadTimeout(30_000)
.setConnectTimeout(30_000)
.build();
PRDownloader.initialize(getApplicationContext(), config); 

Make a download request

intdownloadId = PRDownloader.download(url, dirPath, fileName)
.build()
.setOnStartOrResumeListener(newOnStartOrResumeListener() {
@OverridepublicvoidonStartOrResume() {
}
})
.setOnPauseListener(newOnPauseListener() {
@OverridepublicvoidonPause() {
}
})
.setOnCancelListener(newOnCancelListener() {
@OverridepublicvoidonCancel() {
}
})
.setOnProgressListener(newOnProgressListener() {
@OverridepublicvoidonProgress(Progressprogress) {
}
})
.start(newOnDownloadListener() {
@OverridepublicvoidonDownloadComplete() {
}
@OverridepublicvoidonError(Errorerror) {
}
}); 

Pause a download request

PRDownloader.pause(downloadId);

Resume a download request

PRDownloader.resume(downloadId);

Cancel a download request

// Cancel with the download idPRDownloader.cancel(downloadId);
// The tag can be set to any request and then can be used to cancel the requestPRDownloader.cancel(TAG);
// Cancel all the requestsPRDownloader.cancelAll();

Status of a download request

Statusstatus = PRDownloader.getStatus(downloadId);

Clean up resumed files if database enabled

// Method to clean up temporary resumed files which is older than the given dayPRDownloader.cleanUp(days);

TODO

• Integration with other libraries like OkHttp, RxJava
• Test Cases
• And of course many many features and bug fixes

If this library helps you in anyway, show your love ❤️ by putting a ⭐ on this project ✌️

Check out Mindorks awesome open source projects here

License

 Copyright (C) 2017 MINDORKS NEXTGEN PRIVATE LIMITED
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.

Contributing to PRDownloader

All pull requests are welcome, make sure to follow the contribution guidelines when you submit pull request.