Skip to content

An Android library supports badge notification like iOS in Samsung, LG, Sony and HTC launchers.

License

Notifications You must be signed in to change notification settings

jvdadda/ShortcutBadger

 
 

Repository files navigation

ShortcutBadger: Maven Central

The ShortcutBadger makes your Android App show the count of unread messages as a badge on your App shortcut!

Support launchers:

Sony


Samsung


LG


HTC


Xiaomi


ASUS


ADW


APEX


NOVA


Android

(before 4.4)
(Deprecated since 1.1.0)

Nova launcher with TeslaUnread,Apex launcher,Adw Launcher provided by notz</br/> Solid launcher provided by MajeurAndroid

USAGE


1. Add mavenCentral to your build script.

    repositories {
        mavenCentral()
    }


2. Add dependencies for ShortcutBadger, it's available from maven now.

    dependencies {
        compile 'me.leolin:ShortcutBadger:1.1.4@aar'
    }


3. Add the codes below:

    int badgeCount = 1;
    ShortcutBadger.applyCount(context, badgeCount); //for 1.1.4
    ShortcutBadger.with(getApplicationContext()).count(badgeCount); //for 1.1.3


4. If you want to remove the badge

    ShortcutBadger.removeCount(context); //for 1.1.4
    ShortcutBadger.with(getApplicationContext()).remove();  //for 1.1.3

or

    ShortcutBadger.applyCount(context, 0); //for 1.1.4
    ShortcutBadger.with(getApplicationContext()).count(0); //for 1.1.3




DEVELOP BY

Leo Lin - [email protected]

ABOUT Google Play Developer Term Violation

If you receive mail from Google contains message like :

    REASON FOR WARNING: Violation of section 4.4 of the Developer Distribution Agreement.

Please use version 1.1.0+

CHANGE LOG

1.1.4:
Changed ShortcutBadger.setBadge(context, badgeCount) to ShortcutBadger.applyCount(context, badgeCount);

1.1.3:
Deprecate SamsungBadger and LGBadger, those devices can use DefaultBadger

1.1.2:
Add support for 'com.miui.mihome2'

1.1.1:
Add DefaultBadger because some launchers use android.intent.action.BADGE_COUNT_UPDATE to update count.
Since the ShortcutBadgerException is helpless. So change api to set badge and never have to handle the exception again.

1.1.0:
Remove Android Launcher support due to Google Play Developer Term Violation since 4.4

1.0.10:
Add Asus launcher support.

1.0.9:
Add xiaomi launcher support.

LICENSE


    Copyright 2014 Leo Lin
    
    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.

About

An Android library supports badge notification like iOS in Samsung, LG, Sony and HTC launchers.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Java 100.0%