me.leolin.shortcutbadger

Class ShortcutBadger

java.lang.Object

me.leolin.shortcutbadger.ShortcutBadger

public final class ShortcutBadger
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
static boolean	applyCount(android.content.Context context, int badgeCount) Tries to update the notification count
static void	applyCountOrThrow(android.content.Context context, int badgeCount) Tries to update the notification count, throw a ShortcutBadgeException if it fails
static void	applyNotification(android.content.Context context, android.app.Notification notification, int badgeCount)
static boolean	isBadgeCounterSupported(android.content.Context context) Whether this platform launcher supports shortcut badges.
static boolean	removeCount(android.content.Context context) Tries to remove the notification count
static void	removeCountOrThrow(android.content.Context context) Tries to remove the notification count, throw a ShortcutBadgeException if it fails

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

applyCount

public static boolean applyCount(android.content.Context context,
                                 int badgeCount)

Tries to update the notification count

Parameters:

context - Caller context

badgeCount - Desired badge count

Returns:

true in case of success, false otherwise

applyCountOrThrow

public static void applyCountOrThrow(android.content.Context context,
                                     int badgeCount)
                              throws ShortcutBadgeException

Tries to update the notification count, throw a ShortcutBadgeException if it fails

Parameters:

context - Caller context

badgeCount - Desired badge count

Throws:

ShortcutBadgeException

removeCount

public static boolean removeCount(android.content.Context context)

Tries to remove the notification count

Parameters:

context - Caller context

Returns:

true in case of success, false otherwise

removeCountOrThrow

public static void removeCountOrThrow(android.content.Context context)
                               throws ShortcutBadgeException

Tries to remove the notification count, throw a ShortcutBadgeException if it fails

Parameters:

context - Caller context

Throws:

ShortcutBadgeException

isBadgeCounterSupported

public static boolean isBadgeCounterSupported(android.content.Context context)

Whether this platform launcher supports shortcut badges. Doing this check causes the side effect of resetting the counter if it's supported, so this method should be followed by a call that actually sets the counter to the desired value, if the counter is supported.

applyNotification

public static void applyNotification(android.content.Context context,
                                     android.app.Notification notification,
                                     int badgeCount)

Parameters:

context - Caller context

notification -

badgeCount -