com.atakmap.android.util

Class NotificationUtil

java.lang.Object

com.atakmap.android.util.NotificationUtil

public class NotificationUtil
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NotificationUtil.GeneralIcon Plugins using the NotificationUtil will need to use resources that are built into ATAK.
static class	NotificationUtil.NotificationColor Class used to represent the color of the icon backed by the integer representation in ARGB format.
static interface	NotificationUtil.NotificationListener

Field Summary

Fields

Modifier and Type	Field and Description
static NotificationUtil.NotificationColor	BLUE
static int	DEFAULT_NOTIFY_ID
static NotificationUtil.NotificationColor	GREEN Color choices for icons.
static NotificationUtil.NotificationColor	RED
static java.lang.String	TAG
static NotificationUtil.NotificationColor	WHITE
static NotificationUtil.NotificationColor	YELLOW

Method Summary

Modifier and Type	Method and Description
void	addOnRemoveListener(MapItem marker) Add a listener to remove a notification should the marker be removed.
void	cancelAll() Cancels all notification managed by the notification manager.
void	clearNotification(int notifyId) Clears a notification managed referenced by its notification identifier.
void	dispose()
static NotificationUtil	getInstance()
android.app.Notification.Builder	getNotificationBuilder(int notifyId) Obtains the notification builder currently being used by the specified Notification Identifier.
void	initialize(android.content.Context svc)
void	postMarkerNotification(MapItem mapItem, int notifyId, int icon, NotificationUtil.NotificationColor color, java.lang.String title, java.lang.String ticker, java.lang.String msg, android.content.Intent notificationIntent, boolean user) Essentially a wrapper to postNotification in NotificationUtils.
void	postNotification(int notifyId, int icon, NotificationUtil.NotificationColor color, java.lang.String title, java.lang.String msg, android.content.Intent notificationIntent, boolean user) Produces a standard notification without a ticker, no sound, vibrate, or flashing.
void	postNotification(int notifyId, int icon, NotificationUtil.NotificationColor color, java.lang.String title, java.lang.String ticker, java.lang.String msg) Produces a standard notification without a ticker, no sound, vibrate, or flashing.
void	postNotification(int notifyId, int icon, NotificationUtil.NotificationColor color, java.lang.String title, java.lang.String ticker, java.lang.String msg, android.content.Intent notificationIntent, boolean user) Produces a standard notification with a ticker, no sound, vibrate, or flashing.
void	postNotification(int notifyId, int icon, NotificationUtil.NotificationColor color, java.lang.String title, java.lang.String ticker, java.lang.String msg, android.content.Intent notificationIntent, boolean vibrate, boolean chime, boolean blink, boolean user) Produces a standard notification with or without a ticker.
void	postNotification(int notifyId, int icon, java.lang.String title, java.lang.String msg, android.content.Intent notificationIntent, boolean user) Produces a standard notification without a ticker, no sound, vibrate, or flashing.
void	postNotification(int notifyId, int icon, java.lang.String title, java.lang.String ticker, java.lang.String msg) Produces a standard notification without a ticker, no sound, vibrate, or flashing.
void	postNotification(int notifyId, int icon, java.lang.String title, java.lang.String ticker, java.lang.String msg, android.content.Intent notificationIntent, boolean user) Produces a standard notification with a ticker, no sound, vibrate, or flashing without a specified color.
void	postNotification(int notifyId, int icon, java.lang.String title, java.lang.String ticker, java.lang.String msg, android.content.Intent notificationIntent, boolean vibrate, boolean chime, boolean blink, boolean user) Produces a standard notification with a ticker, no sound, vibrate, or flashing without a specified color.
void	postNotification(int notifyId, android.app.Notification notification, boolean fade) Given a notification, post it either under the control of the notification fader or not.
int	postNotification(int icon, NotificationUtil.NotificationColor color, java.lang.String title, java.lang.String ticker, java.lang.String msg) Produces a standard notification without a ticker, no sound, vibrate, or flashing.
int	postNotification(int icon, NotificationUtil.NotificationColor color, java.lang.String title, java.lang.String ticker, java.lang.String msg, android.content.Intent notificationIntent) Produces a standard notification without a ticker, no sound, vibrate, or flashing.
int	postNotification(int icon, java.lang.String title, java.lang.String ticker, java.lang.String msg) Produces a standard notification without a ticker, no sound, vibrate, or flashing.
int	postNotification(int icon, java.lang.String title, java.lang.String ticker, java.lang.String msg, android.content.Intent notificationIntent) Produces a standard notification without a ticker, no sound, vibrate, or flashing.
void	registerNotificationListener(NotificationUtil.NotificationListener listener) Registers a notification listener with the centralized notification class.
int	reserveNotifyId() Reserves a notification identifier that is unique for the current run of the application.
void	unregisterNotificationListener(NotificationUtil.NotificationListener listener) Unregisters a notification listener with the centralized notification class.

Methods inherited from class java.lang.Object

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

Field Detail

GREEN

public static NotificationUtil.NotificationColor GREEN

Color choices for icons.

RED

public static NotificationUtil.NotificationColor RED

YELLOW

public static NotificationUtil.NotificationColor YELLOW

WHITE

public static NotificationUtil.NotificationColor WHITE

BLUE

public static NotificationUtil.NotificationColor BLUE

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

DEFAULT_NOTIFY_ID

public static final int DEFAULT_NOTIFY_ID

See Also:

Constant Field Values

Method Detail

getInstance

public static NotificationUtil getInstance()

initialize

public void initialize(android.content.Context svc)

dispose

public void dispose()

cancelAll

public void cancelAll()

Cancels all notification managed by the notification manager.

addOnRemoveListener

public void addOnRemoveListener(MapItem marker)

Add a listener to remove a notification should the marker be removed.

Parameters:

marker - The marker that needs to be watched.

postNotification

public int postNotification(int icon,
                            java.lang.String title,
                            java.lang.String ticker,
                            java.lang.String msg)

Produces a standard notification without a ticker, no sound, vibrate, or flashing. The notificatiion can be dismissed. The notification identifier is automatically generated.

postNotification

public void postNotification(int notifyId,
                             int icon,
                             java.lang.String title,
                             java.lang.String ticker,
                             java.lang.String msg)

Produces a standard notification without a ticker, no sound, vibrate, or flashing. The notificatiion can be dismissed.

postNotification

public int postNotification(int icon,
                            java.lang.String title,
                            java.lang.String ticker,
                            java.lang.String msg,
                            android.content.Intent notificationIntent)

Produces a standard notification without a ticker, no sound, vibrate, or flashing. The notificatiion can be dismissed. The user supplied notification is honored within the application. The notification identifier is automatically generated.

postNotification

public void postNotification(int notifyId,
                             int icon,
                             java.lang.String title,
                             java.lang.String msg,
                             android.content.Intent notificationIntent,
                             boolean user)

Produces a standard notification without a ticker, no sound, vibrate, or flashing. The notificatiion can be dismissed. The user supplied notification is honored within the application.

postNotification

public int postNotification(int icon,
                            NotificationUtil.NotificationColor color,
                            java.lang.String title,
                            java.lang.String ticker,
                            java.lang.String msg)

Produces a standard notification without a ticker, no sound, vibrate, or flashing. The notificatiion can be dismissed. The notification identifier is automatically generated.

postNotification

public void postNotification(int notifyId,
                             int icon,
                             NotificationUtil.NotificationColor color,
                             java.lang.String title,
                             java.lang.String ticker,
                             java.lang.String msg)

Produces a standard notification without a ticker, no sound, vibrate, or flashing. The notificatiion can be dismissed.

postNotification

public int postNotification(int icon,
                            NotificationUtil.NotificationColor color,
                            java.lang.String title,
                            java.lang.String ticker,
                            java.lang.String msg,
                            android.content.Intent notificationIntent)

Produces a standard notification without a ticker, no sound, vibrate, or flashing. The notificatiion can be dismissed. The user supplied notification is honored within the application. The notification identifier is automatically generated.

postNotification

public void postNotification(int notifyId,
                             int icon,
                             NotificationUtil.NotificationColor color,
                             java.lang.String title,
                             java.lang.String msg,
                             android.content.Intent notificationIntent,
                             boolean user)

Produces a standard notification without a ticker, no sound, vibrate, or flashing. The notificatiion can be dismissed. The user supplied notification is honored within the application.

postMarkerNotification

public void postMarkerNotification(MapItem mapItem,
                                   int notifyId,
                                   int icon,
                                   NotificationUtil.NotificationColor color,
                                   java.lang.String title,
                                   java.lang.String ticker,
                                   java.lang.String msg,
                                   android.content.Intent notificationIntent,
                                   boolean user)

Essentially a wrapper to postNotification in NotificationUtils. All it does is update the notifyID to the correct value, to prevent duplicates.

Parameters:

notifyId - the identifying number for the notification

icon - The resource id of the icon to put in the status bar.

color - The color used to display the icon.

title - The title that goes in the expanded entry.

ticker - The text that flows by in the status bar when the notification first activates or null, if no ticker is to be used.

msg - The text that goes in the expanded entry.

notificationIntent - the intent to fire when the notification is selected within ATAK. If ATAK is not in the front, it will bring ATAK to the front and pass the specified intent within the system.

user - specify if the user can dismiss the notification.

postNotification

public void postNotification(int notifyId,
                             int icon,
                             NotificationUtil.NotificationColor color,
                             java.lang.String title,
                             java.lang.String ticker,
                             java.lang.String msg,
                             android.content.Intent notificationIntent,
                             boolean user)

Produces a standard notification with a ticker, no sound, vibrate, or flashing. The notification can be dismissed. The user supplied notification is honored within the application.

postNotification

public void postNotification(int notifyId,
                             int icon,
                             java.lang.String title,
                             java.lang.String ticker,
                             java.lang.String msg,
                             android.content.Intent notificationIntent,
                             boolean user)

Produces a standard notification with a ticker, no sound, vibrate, or flashing without a specified color. The notification can be dismissed. The user supplied notification is honored within the application.

postNotification

public void postNotification(int notifyId,
                             int icon,
                             java.lang.String title,
                             java.lang.String ticker,
                             java.lang.String msg,
                             android.content.Intent notificationIntent,
                             boolean vibrate,
                             boolean chime,
                             boolean blink,
                             boolean user)

Produces a standard notification with a ticker, no sound, vibrate, or flashing without a specified color. The notification can be dismissed. The user supplied notification is honored within the application.

postNotification

public void postNotification(int notifyId,
                             int icon,
                             NotificationUtil.NotificationColor color,
                             java.lang.String title,
                             java.lang.String ticker,
                             java.lang.String msg,
                             android.content.Intent notificationIntent,
                             boolean vibrate,
                             boolean chime,
                             boolean blink,
                             boolean user)

Produces a standard notification with or without a ticker.

Parameters:

notifyId - the identifying number for the notification

icon - The resource id of the icon to put in the status bar.

color - The color that may be applied to the icon. Can be null to indicate that the default behavior should be used.

title - The title that goes in the expanded entry.

ticker - The text that flows by in the status bar when the notification first activates or null, if no ticker is to be used.

msg - The text that goes in the expanded entry.

notificationIntent - the intent to fire when the notification is selected within ATAK. If ATAK is not in the front, it will bring ATAK to the front and pass the specified intent within the system.

vibrate - true to vibrate false to not.

chime - true to chime false to not.

blink - true to blink false to not.

user - set true if the user can dismiss the notification.

getNotificationBuilder

public android.app.Notification.Builder getNotificationBuilder(int notifyId)

Obtains the notification builder currently being used by the specified Notification Identifier.

Parameters:

notifyId - the notification id used.

clearNotification

public void clearNotification(int notifyId)

Clears a notification managed referenced by its notification identifier.

Parameters:

notifyId - the notification id used.

reserveNotifyId

public int reserveNotifyId()

Reserves a notification identifier that is unique for the current run of the application.

postNotification

public void postNotification(int notifyId,
                             android.app.Notification notification,
                             boolean fade)

Given a notification, post it either under the control of the notification fader or not.

Parameters:

notifyId - the notification id used.

notification - the actual notification.

fade - false will remove this notification from the fader, true will begin or reset the time for this notification to be removed.

registerNotificationListener

public void registerNotificationListener(NotificationUtil.NotificationListener listener)

Registers a notification listener with the centralized notification class.

Parameters:

listener - the listener to register

unregisterNotificationListener

public void unregisterNotificationListener(NotificationUtil.NotificationListener listener)

Unregisters a notification listener with the centralized notification class.

Parameters:

listener - the listener to unregister