android

Class LocalNotificationHelper

java.lang.Object

android.LocalNotificationHelper

public class LocalNotificationHelper
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
LocalNotificationHelper()

Method Summary

Modifier and Type	Method and Description
static void	cancel(int notificationId) Cancels a notification with particular
static void	cancel(LocalNotification notification) Cancels the given
static void	cancelAll() Cancels all the scheduled notifications
static void	destroy() Deprecated.
static void	getAll(LocalNotificationHandler callback) Returns the list of all LocalNotifications which are scheduled and going to trigger in future in
static java.util.List<LocalNotification>	getAllSync() Returns the list of all LocalNotifications which are scheduled and going to trigger in future in
static void	init(java.lang.String defaultTitle, int defaultIcon) call this method in 'onCreate' of your Application or Activity class
static void	isScheduled(int notificationId, LocalNotificationStatusHandler callback) Returns the status of a notification scheduled on
static boolean	isScheduledSync(int notificationId) Returns the status of a notification scheduled on
static void	schedule(int notificationId, java.lang.String channelId, int smallIcon, int largeIcon, java.lang.String textTitle, java.lang.String textContent, long delay, boolean isRepeat) Schedules a new local notification and overrides if the same notification is scheduled with same 'notificationId'
static void	schedule(int notificationId, java.lang.String textContent, long delay, boolean isRepeat) Schedules a new local notification and overrides if the same notification is scheduled with same 'notificationId'

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalNotificationHelper

public LocalNotificationHelper()

Method Detail

init

public static void init(java.lang.String defaultTitle,
                        @DrawableRes
                        int defaultIcon)

call this method in 'onCreate' of your Application or Activity class

Parameters:

defaultTitle - - Text you want to show by default on Title of Local Notification

defaultIcon - - Icon you want to show by default with Local Notification

schedule

public static void schedule(int notificationId,
                            java.lang.String textContent,
                            long delay,
                            boolean isRepeat)

Schedules a new local notification and overrides if the same notification is scheduled with same 'notificationId'

Parameters:

notificationId - - Unique int id of LocalNotification

textContent - - Body text of your LocalNotification

delay - - Delay time in millis after which your LocalNotification should be triggered

isRepeat - - boolean to indicate if LocalNotification should repeat after 'delay' interval or not

schedule

public static void schedule(int notificationId,
                            java.lang.String channelId,
                            @DrawableRes
                            int smallIcon,
                            @DrawableRes
                            int largeIcon,
                            java.lang.String textTitle,
                            java.lang.String textContent,
                            long delay,
                            boolean isRepeat)

Schedules a new local notification and overrides if the same notification is scheduled with same 'notificationId'

Parameters:

notificationId - - Unique int id of LocalNotification

channelId - - Channel name on which you want to display your LocalNotification

smallIcon - - Small monochrome png icon drawable you want to show with your LocalNotification

largeIcon - - Colored icon image drawable you want to show with your LocalNotification

textTitle - - Title text of your LocalNotification

textContent - - Body text of your LocalNotification

delay - - Delay time in millis after which your LocalNotification should be triggered

isRepeat - - boolean to indicate if LocalNotification should repeat after 'delay' interval or not

getAll

public static void getAll(LocalNotificationHandler callback)

Returns the list of all LocalNotifications which are scheduled and going to trigger in future in

Parameters:

callback - - object of interface LocalNotificationHandler

getAllSync

public static java.util.List<LocalNotification> getAllSync()

Returns the list of all LocalNotifications which are scheduled and going to trigger in future in

Returns:

list of local notifications which are scheduled

cancel

public static void cancel(int notificationId)

Cancels a notification with particular

Parameters:

notificationId - of LocalNotification

cancel

public static void cancel(LocalNotification notification)

Cancels the given

Parameters:

notification - to cancel

cancelAll

public static void cancelAll()

Cancels all the scheduled notifications

isScheduled

public static void isScheduled(int notificationId,
                               LocalNotificationStatusHandler callback)

Returns the status of a notification scheduled on

Parameters:

notificationId - in a

callback - object of interface LocalNotificationStatusHandler

isScheduledSync

public static boolean isScheduledSync(int notificationId)

Returns the status of a notification scheduled on

Parameters:

notificationId - in a

Returns:

boolean true of notification is scheduled

destroy

@Deprecated
public static void destroy()

Deprecated.