com.radiusnetworks.proximity

Interface ProximityKitRangeNotifier

public interface ProximityKitRangeNotifier

Defines timely beacon observation events for configured regions.

This interface should be implemented by classes that want to receive frequent, fine level, updates about beacons visible to the device. A good use for implementing this interface is a class that needs to determine the closest beacon to the device. Or a class which needs to take action once the device comes within a specified distance of a beacon.

Use ProximityKitMonitorNotifier when only major, coarse level, updates about the visibility of a beacon region is required.

Since:

0.1.0

See Also:

ProximityKitBeacon, ProximityKitBeaconRegion, ProximityKitMonitorNotifier, ProximityKitManager.getProximityKitRangeNotifier(), ProximityKitManager.setProximityKitRangeNotifier(ProximityKitRangeNotifier)

Method Summary

Modifier and Type	Method and Description
void	didRangeBeaconsInRegion(Collection beacons, ProximityKitBeaconRegion region) Provides details for currently observed beacons within a region configured for ranging.

Method Detail

didRangeBeaconsInRegion

void didRangeBeaconsInRegion(Collection beacons,
                             ProximityKitBeaconRegion region)

Provides details for currently observed beacons within a region configured for ranging.

Called approximately once per second per beacon region configured for ranging.

This will always be called for every region even when no beacons have been observed. When no beacons have been observed for a region the provided beacons collection will simply be empty. Similarly if a specific beacon no longer appears in beacons, it may be assumed the beacon is no longer visible to the device.

Parameters:

beacons - Collection of ProximityKitBeacon objects seen in the past second which are part of the region defined by region. Collection may be empty but will not be null.

region - The ProximityKitBeaconRegion defining the criteria for the ranged beacons.