com.atakmap.android.geofence.alert

Class GeoFenceAlerting

java.lang.Object

com.atakmap.android.geofence.alert.GeoFenceAlerting

public class GeoFenceAlerting
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GeoFenceAlerting.Alert Container for alert details

Constructor Summary

Constructors

Constructor and Description
GeoFenceAlerting()

Method Summary

Modifier and Type	Method and Description
void	alert(GeoFenceMonitor monitor, java.util.List<GeoFenceAlerting.Alert> items, boolean bAutoDismiss)
void	dismiss(GeoFenceMonitor monitor) Removes a monitor from the alerting mechanism.
boolean	dismiss(GeoFenceMonitor monitor, boolean bStopMonitoring) Dismiss the alerts for specified monitor, optionally quit monitoring those alerts/items
boolean	dismiss(GeoFenceMonitor monitor, GeoFenceAlerting.Alert alert, boolean bStopMonitoring) Dismiss a specific alert for a given monitor
boolean	dismiss(GeoFenceMonitor monitor, PointMapItem item, boolean bStopMonitoring) Dismiss the alert, optionally quit monitoring
void	dismissAll() Cleans up the current ongoing alerts.
void	dispose()
int	getAlertCount()
java.util.Map<GeoFenceMonitor,java.util.List<GeoFenceAlerting.Alert>>	getAlerts() Get list of ongoing alerts
java.util.List<GeoFenceAlerting.Alert>	getAlerts(java.lang.String mapItemUID) Get list of ongoing alerts for monitor associated with the specified Shape Map Item UID

Methods inherited from class java.lang.Object

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

Constructor Detail

GeoFenceAlerting

public GeoFenceAlerting()

Method Detail

dispose

public void dispose()

alert

public void alert(GeoFenceMonitor monitor,
                  java.util.List<GeoFenceAlerting.Alert> items,
                  boolean bAutoDismiss)

dismissAll

public void dismissAll()

Cleans up the current ongoing alerts.

dismiss

public void dismiss(GeoFenceMonitor monitor)

Removes a monitor from the alerting mechanism. If it the monitor has any ongoing alerts they are cleaned up and removed.

dismiss

public boolean dismiss(GeoFenceMonitor monitor,
                       boolean bStopMonitoring)

Dismiss the alerts for specified monitor, optionally quit monitoring those alerts/items

Parameters:

monitor - the monitor to use

bStopMonitoring - if the monitor also needs to stop monitoring

Returns:

true if we quit monitoring, and it was the last item being monitored

dismiss

public boolean dismiss(GeoFenceMonitor monitor,
                       GeoFenceAlerting.Alert alert,
                       boolean bStopMonitoring)

Dismiss a specific alert for a given monitor

Parameters:

monitor - Monitor

alert - Alert

bStopMonitoring - True to stop monitoring the alert's item

Returns:

True if there are no more items being monitored

dismiss

public boolean dismiss(GeoFenceMonitor monitor,
                       PointMapItem item,
                       boolean bStopMonitoring)

Dismiss the alert, optionally quit monitoring

Parameters:

monitor - the monitor associated with the alert.

item - the item associated with the alert

bStopMonitoring - if the monitoring should stop when the alert is dismissed

Returns:

true if we quit monitoring, and it was the last item being monitored

getAlertCount

public int getAlertCount()

getAlerts

public java.util.Map<GeoFenceMonitor,java.util.List<GeoFenceAlerting.Alert>> getAlerts()

Get list of ongoing alerts

Returns:

the list of alerts

getAlerts

public java.util.List<GeoFenceAlerting.Alert> getAlerts(java.lang.String mapItemUID)

Get list of ongoing alerts for monitor associated with the specified Shape Map Item UID

Parameters:

mapItemUID - find an ongoing alert for a specific map item.

Returns:

the list of alerts for a map item.