README.md

Badges

Small library to show badges in app icons for unread messages on most common manufacturers: LG, Sony, Samsung and HTC.

Screenshots

LG

Sony

Samsung

HTC

Usage

  try {
      Badges.setBadge(context, 5);
  } catch (BadgesNotSupportedException badgesNotSupportedException) {
      Log.d(TAG, badgesNotSupportedException.getMessage());
  }

To remove the badge you can call to Badges.removeBadge(context) or set badges count to 0 with Badges.setBadge(context, 0);

  try {
      Badges.removeBadge(context);
      // Alternative way
      Badges.setBadge(context, 0);
  } catch (BadgesNotSupportedException badgesNotSupportedException) {
      Log.d(TAG, badgesNotSupportedException.getMessage());
  }

The following permissions are added to the AndroidManifest.xml of the library, Android Studio should add them to your app AndroidManifest.xml but you can prefer adding them manually to avoid possible problems:

    <!-- Samsung -->
    <uses-permission android:name="com.sec.android.provider.badge.permission.READ" />
    <uses-permission android:name="com.sec.android.provider.badge.permission.WRITE" />

    <!-- Sony -->
    <uses-permission android:name="com.sonyericsson.home.permission.BROADCAST_BADGE" />

    <!-- HTC -->
    <uses-permission android:name="com.htc.launcher.permission.READ_SETTINGS" />
    <uses-permission android:name="com.htc.launcher.permission.UPDATE_SHORTCUT" />

Download

Download the project, compile it using maven or gradle or add it as dependency from maven central repository adding to your pom.xml

<dependency>
  <groupId>com.github.arturogutierrez</groupId>
  <artifactId>badges</artifactId>
  <version>1.0</version>
  <type>aar</type>
</dependency>

Or into your build.gradle

dependencies {
    compile 'com.github.arturogutierrez:badges:1.0.5@aar'
}

Supported Launchers

• LG
• Sony
• Samsung
• HTC

Developed By

• Arturo Gutiérrez Díaz-Guerra - [email protected]

License

Copyright 2014 Arturo Gutiérrez Díaz-Guerra

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.