https://github.com/mutkuensert/downloader
An Android downloader library supported with notifications.
https://github.com/mutkuensert/downloader
android android-development android-download android-downloader android-library android-notifications
Last synced: 8 months ago
JSON representation
An Android downloader library supported with notifications.
- Host: GitHub
- URL: https://github.com/mutkuensert/downloader
- Owner: mutkuensert
- License: apache-2.0
- Created: 2023-07-18T22:29:00.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-09-06T07:07:40.000Z (almost 3 years ago)
- Last Synced: 2023-09-06T08:25:47.651Z (almost 3 years ago)
- Topics: android, android-development, android-download, android-downloader, android-library, android-notifications
- Language: Kotlin
- Homepage:
- Size: 86.9 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Downloader
## Table of Contents
* [About The Library](#about-the-library)
* [Adding The Dependency](#adding-the-dependency)
* [How to Use](#how-to-use)
* [License](#license)
* [Contact](#contact)
## About The Library
With this library you can easily download the files in urls and show the download progress in notifications.
For the example implementation of this library, you can look at my [Pixabay Search Engine](https://github.com/mutkuensert/Pixabay-Search-Engine) project on Github.
## Adding The Dependency
Add jitpack into the repositories
```gradle
maven { url 'https://jitpack.io' }
```
Add the dependency in build.gradle file.
```gradle
implementation 'com.github.mutkuensert:downloader:v2.3.1'
```
**You can also add the library locally. To do that:**
Clone the project.
Run in the terminal:
```gradle
./gradlew build
```
Find generated aar file under build folder and copy & paste it into your project. You can create a directory called "libs" under your app module and paste the file into there.
Then you can add the dependency:
```gradle
implementation files('libs/Downloader.aar')
```
## How to Use
If you use Hilt in your project, you can initialize Downloader class like below. You should also implement a CoroutineScope and inject it. You mustn't provide it as a singleton.
```kotlin
@Module
@InstallIn(SingletonComponent::class)
object DownloaderModule {
@Provides
fun providesDownloader(scope: CoroutineScope, @ApplicationContext context: Context): Downloader {
return Downloader.Builder(context, scope)
.setNotificationsActive(true) //Default is false.
.build()
}
}
```
The notifications can be customized:
```kotlin
val downloader = Downloader.Builder()
.context(context)
.scope(scope)
.setNotificationsActive(true)
.build()
downloader.notificationBuilder.setAutoCancel(false)
return downloader
```
Inject the downloader somewhere, for example a ViewModel:
```kotlin
@HiltViewModel
class MyViewModel @Inject constructor(
...,
val downloader: Downloader,
) : ViewModel() { }
```
Initialize activity result launcher in a Fragment or an Activity:
```kotlin
viewModel.downloader.initActivityResultLauncher {
registerForActivityResult(ActivityResultContracts.StartActivityForResult()) { result ->
if (result.resultCode == Activity.RESULT_OK) {
val uri = result.data?.data
if (uri != null) this.writeToFile(uri)
}
}
}
```
The library uses functions of its own to extract the file name and file format from the url.
If a custom extractor is needed different from these default ones, you must set them:
```kotlin
downloader.setFileFormatExtractor { url ->
url.substringAfterLast(".").substringBefore("?")
}
```
```kotlin
downloader.setFileNameExtractor { url ->
url.substringAfterLast("/").substringBefore(".")
}
```
Finally, you can download the file on the url:
```kotlin
downloader.downloadUrl(url)
```
Notification and internet permissions have to be added in the manifest file.
## License
```xml
Copyright 2022 Mustafa Utku Ensert
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.
```
## Contact
[ensertyazilim@gmail.com](#)