com.radiusnetworks.proximity

Interface ProximityKitMonitorNotifier

public interface ProximityKitMonitorNotifier

Defines events for major updates about beacon region visibility.

This interface should be implemented by classes that want to receive updates about coarse level transitions (for example entering or exiting) for beacon regions. These events apply to a beacon region and not to a single beacon (unless the region is defined such that it would fully qualify a single beacon).

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

When frequent fine level details about individual beacons are necessary use ProximityKitRangeNotifier instead. For equivalent geofence related events use ProximityKitGeofenceNotifier

Since:

0.1.0

See Also:

ProximityKitBeaconRegion, ProximityKitGeofenceNotifier, ProximityKitRangeNotifier, ProximityKitManager.getProximityKitMonitorNotifier(), ProximityKitManager.setProximityKitMonitorNotifier(ProximityKitMonitorNotifier)

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
void	didDetermineStateForRegion(int state, ProximityKitBeaconRegion region) Provides major state events for a beacon region.
void	didEnterRegion(ProximityKitBeaconRegion region) Called when at least one beacon matching the region criteria is visible.
void	didExitRegion(ProximityKitBeaconRegion region) Called when no beacons matching the region criteria are visible.

Field Detail

INSIDE

static final int INSIDE

Indicates the Android device is inside the defined region.

See Also:

Constant Field Values

OUTSIDE

static final int OUTSIDE

Indicates the Android device is outside the defined region.

See Also:

Constant Field Values

Method Detail

didDetermineStateForRegion

void didDetermineStateForRegion(int state,
                                ProximityKitBeaconRegion region)

Provides major state events for a beacon region.

This is called with a value of ProximityKitMonitorNotifier.INSIDE when at least one beacon matching the region criteria is visible. Conversely, this is called with a value of ProximityKitMonitorNotifier.OUTSIDE when no beacons defined by the region are visible.

Parameters:

state - Major state of region. Either ProximityKitMonitorNotifier.INSIDE or ProximityKitMonitorNotifier.OUTSIDE.

region - A ProximityKitBeaconRegion defining the beacon boundary criteria.

didEnterRegion

void didEnterRegion(ProximityKitBeaconRegion region)

Called when at least one beacon matching the region criteria is visible.

Parameters:

region - A ProximityKitBeaconRegion defining the beacon boundary criteria.

didExitRegion

void didExitRegion(ProximityKitBeaconRegion region)

Called when no beacons matching the region criteria are visible.

Parameters:

region - A ProximityKitBeaconRegion defining the beacon boundary criteria.