NaikSoftware/android-upload-service

Easily upload files in the background with progress indication notification

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.NaikSoftware:android-upload-service:3.1.5'
	}

	dependencies {
		implementation("com.github.NaikSoftware:android-upload-service:3.1.5")
	}

	<dependency>
	    <groupId>com.github.NaikSoftware</groupId>
	    <artifactId>android-upload-service</artifactId>
	    <version>3.1.5</version>
	</dependency>


                            
    libraryDependencies += "com.github.NaikSoftware" % "android-upload-service" % "3.1.5"


                            
    :dependencies [[com.github.NaikSoftware/android-upload-service "3.1.5"]]

Readme

Android Upload Service

Upload Notification

Easily upload files in the background with automatic Android Notification Center progress indication.

Purpose

have a tiny library (less than 60KB)
upload files to a server with HTTP
support upload through path from ContentProvider Uri (pass Uri.toString as parameter) or absolute file path
be able to easily implement other upload protocols as plugins
handle multiple concurrent uploads in the background, even if the device is idle
automatically retry failed uploads, with a configurable exponential backoff
possibility to automatically delete uploaded files when the upload is successful
show status in the Android Notification Center (with support for stacking notifications).
be able to change the underlying HTTP stack. Currently HttpURLConnection (the default) and OkHttp are supported. You can also implement your own.
be able to set library log level and to provide custom logger implementation

At the core of the library there is a Service which handles multiple concurrent upload tasks in the background. It publishes broadcast intents to notify status. This way the logic is completely decoupled from the UI. Read further to learn how you can use it in your App.

Getting started <a name="setup"></a>

Read this page for full setup instructions with Maven and Gradle.

Check the wiki to discover how to get started.

Check JavaDocs for a complete reference of the library's API

Do you need help? Read this

Apps powered by Android Upload Service <a name="powered"></a>

To be included in the following list, simply create an issue and provide the app name and a link.

Contributing <a name="contribute"></a>

Do you have a new feature in mind?
Do you know how to improve existing docs or code?
Have you found a bug?

Contributions are welcome and encouraged! Just fork the project and then send a pull request. Be ready to discuss your code and design decisions.

License <a name="license"></a>

Copyright (C) 2013-2016 Aleksandar Gotev, Nickolay Savchenko

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.