co.roverlabs.estimote

Class RegionManager

java.lang.Object

co.roverlabs.estimote.RegionManager

public class RegionManager
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RegionManager.IRegionManagerListener

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SHARED_PREFS_KEY_CURRENT_REGIONS
static java.lang.String	TAG

Constructor Summary

Constructors

Constructor and Description
RegionManager(android.content.Context context) Constructs a RegionManager instance.

Method Summary

Modifier and Type	Method and Description
java.util.Set<RVBeaconRegion>	getCurrentRegions()
boolean	isMonitoringStarted() Checks if monitoring has been started.
void	removeListener() Removes the listener so the caller no longer listens for RegionManager events.
void	setCurrentRegions(java.util.Set<RVBeaconRegion> currentRegions)
void	setListener(RegionManager.IRegionManagerListener listener) Sets the listener so the caller can listen for RegionManager events.
void	setMonitoringListeners() Sets the callbacks to be invoked when beacons are discovered during monitoring.
void	setMonitoringScanRate(long scanTimeMillis, long waitTimeMillis) Changes default scanning periods when monitoring is being preformed.
void	setRangingListeners()
void	setRangingScanRate(long scanTimeMillis, long waitTimeMillis) Change default scanning periods when ranging is being performed.
void	setUuid() Sets the UUID of the beacons to monitor for.
void	startMonitoring()
void	startRanging() Starts ranging for beacons with specified UUID and major number.
void	stopMonitoring()
void	stopRanging() Stops ranging for beacons with specified UUID and major number.

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public static final java.lang.String TAG

SHARED_PREFS_KEY_CURRENT_REGIONS

public static final java.lang.String SHARED_PREFS_KEY_CURRENT_REGIONS

See Also:

Constant Field Values

Constructor Detail

RegionManager

public RegionManager(android.content.Context context)

Constructs a RegionManager instance.

Parameters:

context - The context of the application.

Method Detail

setListener

public void setListener(RegionManager.IRegionManagerListener listener)

Sets the listener so the caller can listen for RegionManager events.

Parameters:

listener - New listener to be attached to this instance of RegionManager.

removeListener

public void removeListener()

Removes the listener so the caller no longer listens for RegionManager events.

setUuid

public void setUuid()

Sets the UUID of the beacons to monitor for.

setMonitoringScanRate

public void setMonitoringScanRate(long scanTimeMillis,
                                  long waitTimeMillis)

Changes default scanning periods when monitoring is being preformed. Default value of scan time is 5s, and default value of wait time is 25s. This means Rover will perform BLE scanning for 5s every 25s.

Parameters:

scanTimeMillis - The length of time for BLE scanning (in ms).

waitTimeMillis - The length of wait time in between each BLE scanning (in ms).

setRangingScanRate

public void setRangingScanRate(long scanTimeMillis,
                               long waitTimeMillis)

Change default scanning periods when ranging is being performed. Default value of scan time is 1s, and default value of wait time is 0s. This means Rover will perform BLE scanning every 1s continuously.

Parameters:

scanTimeMillis - The length of time for BLE scanning (in ms).

waitTimeMillis - The length of wait time in between each BLE scanning (in ms).

getCurrentRegions

public java.util.Set<RVBeaconRegion> getCurrentRegions()

setCurrentRegions

public void setCurrentRegions(java.util.Set<RVBeaconRegion> currentRegions)

setMonitoringListeners

public void setMonitoringListeners()

Sets the callbacks to be invoked when beacons are discovered during monitoring.

setRangingListeners

public void setRangingListeners()

startMonitoring

public void startMonitoring()

stopMonitoring

public void stopMonitoring()

isMonitoringStarted

public boolean isMonitoringStarted()

Checks if monitoring has been started.

Returns:

True if monitoring has started, false otherwise.

startRanging

public void startRanging()

Starts ranging for beacons with specified UUID and major number.

stopRanging

public void stopRanging()

Stops ranging for beacons with specified UUID and major number.