com.radiusnetworks.proximity

Interface ProximityKitGeofenceNotifier

public interface ProximityKitGeofenceNotifier

Defines events for major updates about geofence regions.

This interface should be implemented by classes that want to receive updates about coarse level transitions (for example entering or exiting) for geofence regions.

For example, a convention app can use these events to provide the user a notification with their purchased ticket as they near the venue.

Event Caveats

Be aware that the location services accuracy mode and network availability will have a direct impact on the enter and exit events. The accuracy of a location measurement can often vary from 5 - 50 meters. Ensure that you configure the geofence radius large enough to allow for less accurate measurements.

Per the Android geofence guide the underlying logic for how enter and exit events are calculated is as follows:

On most devices, the geofence service uses only network location for geofence triggering. The service uses this approach because network location consumes much less power, it takes less time to get discrete locations, and most importantly it's available indoors. Starting with Google Play services 3.2, the geofence service calculates the overlapping ratio of the location circle and the geofence circle and only generates the entrance alert when the ratio is at least 85% for a bigger geofence or 75% for a smaller geofence. For an exit alert, the ratio threshold used is 15% or 25%.

Since:

0.1.0

See Also:

ProximityKitGeofenceRegion, ProximityKitMonitorNotifier, ProximityKitManager.getProximityKitGeofenceNotifier(), ProximityKitManager.setProximityKitGeofenceNotifier(ProximityKitGeofenceNotifier), Creating and Monitoring Geofences > Use Best Practices for Geofencing: Choose the optimal radius for your geofence , Creating and Monitoring Geofences > Troubleshoot the Geofence Entrance Event

Min Android API:

9 - Google Play services requires this API level.

Field Summary

Fields

Modifier and Type	Field and Description
static int	INSIDE Indicates the Android device is inside the geofence region.
static int	OUTSIDE Indicates the Android device is outside the geofence region.

Method Summary

Modifier and Type	Method and Description
void	didDetermineStateForGeofence(int state, ProximityKitGeofenceRegion geofence) Provides major state events for a geofence region.
void	didEnterGeofence(ProximityKitGeofenceRegion geofence) Called when the Android device is inside the defined geofence region.
void	didExitGeofence(ProximityKitGeofenceRegion geofence) Called when the Android device transitions to outside the defined geofence region.

Field Detail

INSIDE

static final int INSIDE

Indicates the Android device is inside the geofence region.

See Also:

Constant Field Values

OUTSIDE

static final int OUTSIDE

Indicates the Android device is outside the geofence region.

See Also:

Constant Field Values

Method Detail

didDetermineStateForGeofence

void didDetermineStateForGeofence(int state,
                                  ProximityKitGeofenceRegion geofence)

Provides major state events for a geofence region.

This is called with a value of ProximityKitGeofenceNotifier.INSIDE when at the Android device determines that it is within the bounds of the geofence region. Conversely, this is called with a value of ProximityKitGeofenceNotifier.OUTSIDE when the device leaves the geofence region it was previously within.

Parameters:

state - Major state of geofence. Either ProximityKitGeofenceNotifier.INSIDE or ProximityKitGeofenceNotifier.OUTSIDE.

geofence - The ProximityKitGeofenceRegion defining the boundary criteria.

See Also:

Event Caveats

didEnterGeofence

void didEnterGeofence(ProximityKitGeofenceRegion geofence)

Called when the Android device is inside the defined geofence region.

Parameters:

geofence - The ProximityKitGeofenceRegion boundary the device is now within.

See Also:

Event Caveats

didExitGeofence

void didExitGeofence(ProximityKitGeofenceRegion geofence)

Called when the Android device transitions to outside the defined geofence region.

Parameters:

geofence - The ProximityKitGeofenceRegion boundary the device is no longer within.

See Also:

Event Caveats