com.github.kaiwinter.androidremotenotifications

Class RemoteNotifications

java.lang.Object

com.github.kaiwinter.androidremotenotifications.RemoteNotifications

public final class RemoteNotifications
extends java.lang.Object

The starting class of this library. Construct an instance with the URL to your JSON file on a server and call updateNotificationsFromServer(UpdatePolicy). This will load the configured notifications and store it in the libraries store. Call showPendingNotificationsToUser(boolean) to automatically show notifications to the user by an AlertDialog.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TAG

Constructor Summary

Constructors

Constructor and Description
RemoteNotifications(android.content.Context context, java.net.URL serverUrl) Constructs a new RemoteNotifications.
RemoteNotifications(android.content.Context context, java.net.URL serverUrl, java.lang.String sharedPreferenceName) Constructs a new RemoteNotifications.

Method Summary

Modifier and Type	Method and Description
NotificationStore	getPreferenceStore()
void	showPendingNotificationsToUser() Shows all due notifications.
void	showPendingNotificationsToUser(boolean showAll) Shows due notifications.
static void	start(android.content.Context context, java.net.URL url, UpdatePolicy updatePolicy) Convenience method to update and show notifications.
void	updateNotificationsFromServer(UpdatePolicy updatePolicy) Starts an AsyncTask which loads the notifications from the server, removes local notifications which doesn't exist anymore and adds new one.
void	updateNotificationsFromServer(UpdatePolicy updatePolicy, NotificationLoaderFinishListener listener) Starts an AsyncTask which loads the notifications from the server, removes local notifications which doesn't exist anymore and adds new one.

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

Constructor Detail

RemoteNotifications

public RemoteNotifications(android.content.Context context,
                           java.net.URL serverUrl)

Constructs a new RemoteNotifications. The Notifications from the server and the last server update timestamp will be stored in a Shared Preferences file with the name . To change the name use RemoteNotifications(Context, URL, String).

Parameters:

context - The application context

serverUrl - The absolute URL to the notification JSON on a server (or file system), not null.

RemoteNotifications

public RemoteNotifications(android.content.Context context,
                           java.net.URL serverUrl,
                           java.lang.String sharedPreferenceName)

Constructs a new RemoteNotifications.

Parameters:

context - The application context

serverUrl - The absolute URL to the notification JSON on a server (or file system), not null.

sharedPreferenceName - The file name to use for the Shared Preferences file.

Method Detail

showPendingNotificationsToUser

public void showPendingNotificationsToUser()

Shows all due notifications. If a server update of the notifications is running this call gets scheduled and is executed automatically after the update has finished.

See Also:

showPendingNotificationsToUser(boolean)

showPendingNotificationsToUser

public void showPendingNotificationsToUser(boolean showAll)

Shows due notifications. If a server update of the notifications is running this call gets scheduled and is executed automatically after the update has finished.

Parameters:

showAll - if true all pending notification dialogs will be shown (may result in bad user experience if several dialogs are popping up). If false only one dialog will be shown on each call of this method.

updateNotificationsFromServer

public void updateNotificationsFromServer(UpdatePolicy updatePolicy,
                                          NotificationLoaderFinishListener listener)

Starts an AsyncTask which loads the notifications from the server, removes local notifications which doesn't exist anymore and adds new one.

Parameters:

updatePolicy - Use this parameter to reduce the number of server calls, not null.

listener - a NotificationLoaderFinishListener which is called after the update of the notifications finished.

updateNotificationsFromServer

public void updateNotificationsFromServer(UpdatePolicy updatePolicy)

Starts an AsyncTask which loads the notifications from the server, removes local notifications which doesn't exist anymore and adds new one.

Parameters:

updatePolicy - Use this parameter to reduce the number of server calls, not null.

getPreferenceStore

public NotificationStore getPreferenceStore()

Returns:

the internally used store of the notifications

start

public static void start(android.content.Context context,
                         java.net.URL url,
                         UpdatePolicy updatePolicy)

Convenience method to update and show notifications.

Parameters:

context - the application context

url - the URL of the JSON file

updatePolicy - the time between server updates