What is FileBox
FileBox is an async file downloader library for Android.
Before we develop filebox, we though that URL content changes very rarely. So basically this library downloads a given URL, and if it is already downloaded, it provides downloaded content directly.
FileBox;
- Shares ongoing download requests to the observers. So It reduces Data Usage.
- Has TTL(Time To Live) duration. Filebox re-download the URL if TTL is expired.
- Supports both Cache and External directory.
- Supports the File Encryption for sensitive URL(images, videos, any file).
- Allows you to create a custom folder destination.
- Clears unreliable data automagically.
- Does Etag Check. Filebox doesn't download the file again If the file's TLL(Time To Live) is up but the file has not changed.
- Supports Multiple Download. If you have N file and want to get notified when all completed.
- Runs on application scope. There is no pause/resume continuation support.
Flow Diagram
Modules
Basic Usage
val fileBoxRequest = FileBoxRequest("https://url1.png")
val filebox= FileBoxProvider.newInstance(applicationContext, FileBoxConfig.createDefault())
filebox.get(fileBoxRequest)
.subscribeOn(Schedulers.io())
.observeOn(AndroidSchedulers.mainThread())
.subscribe { fileBoxResponse ->
when (fileBoxResponse) {
is FileBoxResponse.Downloading -> {
val progress: Float = fileBoxResponse.progress
val ongoingRecord: Record = fileBoxResponse.record
}
is FileBoxResponse.Complete -> {
val savedRecord: Record = fileBoxResponse.record
val savedPath = fileBoxResponse.record.getReadableFilePath()
}
is FileBoxResponse.Error -> {
val savedRecord: Record = fileBoxResponse.record
val error = fileBoxResponse.throwable
}
}
}
Customize Config
val fileBoxConfig = FileBoxConfig.FileBoxConfigBuilder()
.setCryptoType(CryptoType.CONCEAL) // Default is CryptoType.NONE
.setTTLInMillis(TimeUnit.DAYS.toMillis(7)) // Default is 7 Days
.setDirectory(DirectoryType.CACHE) // Default is External
.setFolderName("MyPhotos") // Default is none
.build()
Multiple Download Request
val fileBoxMultipleRequest = FileBoxMultiRequest(
arrayListOf(
FileBoxRequest("https://url1.png"),
FileBoxRequest("https://url2.zip"),
FileBoxRequest("https://url3.json"),
FileBoxRequest("https://url4.mp4")
)
)
val filebox = FileBoxProvider.newInstance(applicationContext, FileBoxConfig.createDefault())
filebox.get(fileBoxMultipleRequest)
.subscribeOn(Schedulers.io())
.observeOn(AndroidSchedulers.mainThread())
.subscribe { fileBoxResponse ->
when (fileBoxResponse) {
is FileBoxMultiResponse.Downloading -> {
val progress = fileBoxResponse.progress
val ongoingFileResponseList = fileBoxResponse.fileBoxResponseList
}
is FileBoxMultiResponse.Complete -> {
val ongoingFileResponseList = fileBoxResponse.fileBoxResponseList
ongoingFileResponseList.forEach { it.record.getReadableFilePath() }
}
is FileBoxMultiResponse.Error -> {
val error = fileBoxResponse.throwable
val ongoingFileResponseList = fileBoxResponse.fileBoxResponseList
}
}
}
Destroy
Don't forget to destroy the filebox when your initialized scope is destroyed. If you create a filebox in your application class, It is application scoped. If you create a filebox in your activity class, It is activity scoped. Be aware of your lifecycle.
filebox.destroy()
Setup
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
dependencies {
implementation 'com.github.lyrebirdstudio:filebox:0.1'
}
License
Copyright 2020 Lyrebird Studio.
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.
43.4k Jan 5, 2023
1.5k Jan 6, 2023
61 Jun 24, 2022
75 Nov 29, 2022
614 Nov 15, 2022
270 Dec 5, 2022
750 Dec 29, 2022
5.5k Dec 27, 2022
36 May 14, 2022
5 Mar 31, 2022
1 Jun 13, 2022
57 Sep 20, 2022
4 Apr 12, 2022
2 Aug 29, 2022
3k Dec 30, 2022
104 Dec 12, 2022
13 Sep 30, 2022
6.3k Dec 27, 2022