Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rampo/UpdateChecker

Increase your app's updates
https://github.com/rampo/UpdateChecker

Last synced: 3 months ago
JSON representation

Increase your app's updates

Awesome Lists containing this project

README

        

# NO LONGER MAINTAINED

# UPDATED CHECKER

> Android User, never miss an Update.

![image](https://raw.github.com/rampo/UpdateChecker/master/arts/flow_dialog_small.png)

## Overview

`UpdateChecker` is a class that can be used by Android Developers to increase the number of their apps' updates by showing a *"New update available"* Notification or Dialog.

It checks for new updates downloadable parsing the Store desktop page of your app.

[XDA Thread](http://forum.xda-developers.com/showthread.php?t=2412385)

[Featured on XDA Portal](http://www.xda-developers.com/android/prod-your-apps-users-to-update-with-updatechecker-library/)

### Changelog
##### Current version: 2.1.8

See [complete ChangeLog](https://github.com/rampo/UpdateChecker/blob/master/CHANGELOG.md).

## Example
Due to Play Store problems, I can't publish the demo app on Play Store, so the demo has the same package of [ActionBarSherlock: Demos](https://github.com/JakeWharton/ActionBarSherlock/tree/master/actionbarsherlock-samples/demos) because the library needs a published app on Play Store to work.

Check out the [source code of the demo](https://github.com/rampo/UpdateChecker/tree/master/demo) or download directly [the apk](https://github.com/rampo/UpdateChecker/tree/master/apk).

## Usage

- In your `build.gradle` file:

```groovy
dependencies {
compile 'com.github.rampo.updatechecker:library:2.1.8'
}
```

- Then, add **INTERNET** and **ACCESS_NETWORK_STATE** permissions to your app's Manifest:

```xml


```

- Start using UpdateChecker: a **dialog** will be shown if a new update is found:

```java
UpdateChecker checker = new UpdateChecker(this); // If you are in a Activity or a FragmentActivity
UpdateChecker checker = new UpdateChecker(getActivity()); // If you are in a Fragment
checker.start();
```

##Important!

- If there is a new update available when your app is launched, **the Notification / Dialog will not be shown every time.**
The Notification/Dialog will be shown every 5 times the app ascertains that a new update is available.
It's a precaution to make the library not too invasive. To modify this, see [Customization/setSuccessfulChecksRequired()](https://github.com/rampo/UpdateChecker/blob/master/CUSTOMIZATION.md#setsuccessfulchecksrequiredint-checksrequired).

- See [Issue #1](https://github.com/rampo/UpdateChecker/issues/1)

##Customization
You can set the store where your app is published on, the successful checks necessary to show notice, modify the notice (Dialog or Notification) and modify the notice icon.
Check out [Customization doc](https://github.com/rampo/UpdateChecker/blob/master/CUSTOMIZATION.md) for more infos.
Example: show a **notification** instead of a dialog

```java
UpdateChecker checker = new UpdateChecker(this);
checker.setNotice(Notice.NOTIFICATION);
checker.start();
```
See [Custom implementation](https://github.com/rampo/UpdateChecker/blob/master/CUSTOMIZATION.md#custom-implementation) if you don't want to use these Notices and manage the result by yourself.

##Contribution

### Questions

If you have any questions regarding UpdateChecker, [create an issue](https://github.com/rampo/UpdateChecker/issues/new).

### Feature request

To create a new Feature request, open an issue [here](https://github.com/rampo/UpdateChecker/issues?labels=optimization%2Crequest&page=1&state=open).

I'll try to answer as soon as I find the time.

### Pull requests welcome

Feel free to contribute to UpdateChecker.

Either you found a bug or have created a new and awesome feature, just create a pull request.

Please note, if you're working on a pull request, make sure to use the [develop branch](https://github.com/rampo/UpdateChecker/tree/develop) as your base.

### Discuss

Join in the conversation, check out the [XDA Thread](http://forum.xda-developers.com/showthread.php?t=2412385).

## Coming soon
- Stackoverflow tag for more specific code problems
- Preference to disable UpdateChecker
- *Changelog* Functions
- *Rate this app* Functions

## Credits

Written and maintained by: Pietro Rampini

The UpdateChecker logo has been created by [Michael Cook](https://plus.google.com/+michaelcook/posts)
## License

[Apache Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html)