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 int	getDefaultLargeIcon()
static int	getDefaultSmallIcon()
static java.lang.String	getDefaultTitle()
static void	init(android.content.Context context, java.lang.String defaultTitle, int defaultIcon) Deprecated.
static void	init(java.lang.String defaultTitle, int smallIcon, int largeIcon) 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 boolean	schedule(int notificationId, java.lang.String textContent, java.util.Date triggerTime) Schedules a new One-Time local notification and overrides if the same notification is scheduled with same 'notificationId'
static boolean	schedule(int notificationId, java.lang.String textContent, java.util.Date triggerTime, long repeatDelay) Schedules a new local notification and overrides if the same notification is scheduled with same 'notificationId'
static boolean	schedule(int notificationId, java.lang.String channelId, int smallIcon, int largeIcon, java.lang.String textTitle, java.lang.String textContent, long triggerDelay, long repeatDelay) Schedules a new local notification and overrides if the same notification is scheduled with same 'notificationId'
static boolean	schedule(int notificationId, java.lang.String textContent, long delay) Schedules a new One-Time local notification and overrides if the same notification is scheduled with same 'notificationId'
static boolean	schedule(int notificationId, java.lang.String textContent, long delay, boolean isRepeat) Deprecated.
static boolean	schedule(int notificationId, java.lang.String textContent, long triggerDelay, long repeatDelay) Schedules a new local notification and overrides if the same notification is scheduled with same 'notificationId'
static void	scheduleNotificationJob(LocalNotification notification)
static void	setDefaultLargeIcon(int icon)
static void	setDefaultSmallIcon(int icon)
static void	setDefaultTitle(java.lang.String title)

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

@Deprecated
public static void init(android.content.Context context,
                                     java.lang.String defaultTitle,
                                     @DrawableRes
                                     int defaultIcon)

Deprecated.

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

This method is Deprecated as Context is not required for upcoming versions. No need to call init, by default App Name will be used as Notification Title and default drawable will be shown as Notification smallIcon

Parameters:

context - - Application or Activity context

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

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

getDefaultTitle

public static java.lang.String getDefaultTitle()

Returns:

default title for Notifications. If NULL or BLANK, it will show Application name

setDefaultTitle

public static void setDefaultTitle(java.lang.String title)

Parameters:

title - - default text for Notifications title. If NULL or BLANK, it will show Application name

getDefaultSmallIcon

public static int getDefaultSmallIcon()

Returns:

default smallIcon for Notifications. If -1, it will show 'android.helper.R.drawable.lnh_ic_stat_default'

getDefaultLargeIcon

public static int getDefaultLargeIcon()

Returns:

default largeIcon for Notifications. If -1, it will show 'android.helper.R.drawable.lnh_ic_stat_default'

setDefaultSmallIcon

public static void setDefaultSmallIcon(int icon)

Parameters:

icon - - default resource for Notifications smallIcon. If -1, it will show 'android.helper.R.drawable.lnh_ic_stat_default'

setDefaultLargeIcon

public static void setDefaultLargeIcon(int icon)

Parameters:

icon - - default resource for Notifications largeIcon. If -1, it will show 'android.helper.R.drawable.lnh_ic_stat_default'

init

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

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

smallIcon - - Small Icon you want to show by default with Local Notification

largeIcon - - Large Icon you want to show by default with Local Notification

schedule

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

Deprecated.

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

This method will be removed in up coming version as it does not allow user to specify different values for DELAY and REPEAT Timings

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 - - True if notification need to be repeated after given delay

Returns:

true if notification scheduled successfully

schedule

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

Schedules a new One-Time 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

Returns:

true if notification scheduled successfully

schedule

public static boolean schedule(int notificationId,
                               java.lang.String textContent,
                               long triggerDelay,
                               long repeatDelay)

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

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

repeatDelay - - Repeats after time in millis after which your LocalNotification should be repeated

Returns:

true if notification scheduled successfully

schedule

public static boolean schedule(int notificationId,
                               java.lang.String textContent,
                               java.util.Date triggerTime)

Schedules a new One-Time 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

triggerTime - - Time on which your LocalNotification should be triggered

Returns:

true if notification scheduled successfully

schedule

public static boolean schedule(int notificationId,
                               java.lang.String textContent,
                               java.util.Date triggerTime,
                               long repeatDelay)

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

triggerTime - - Time on which your LocalNotification should be triggered

repeatDelay - - Repeats after time in millis after which your LocalNotification should be repeated

Returns:

true if notification scheduled successfully

schedule

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

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

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

repeatDelay - - Repeats after time in millis after which your LocalNotification should be repeated, must be greater than or equals to 'PeriodicWorkRequest.MIN_PERIODIC_INTERVAL_MILLIS'

Returns:

true if notification scheduled successfully

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

scheduleNotificationJob

public static void scheduleNotificationJob(LocalNotification notification)

Parameters:

notification - to Schedule. See LocalNotification for more details

destroy

@Deprecated
public static void destroy()

Deprecated.