com.radiusnetworks.proximity

Class ProximityKitManager

java.lang.Object

com.radiusnetworks.proximity.ProximityKitManager

public class ProximityKitManager
extends Object

Since:

0.1.0

Field Summary

Fields

Modifier and Type	Field and Description
protected android.content.Context	context

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProximityKitManager()
protected	ProximityKitManager(android.content.Context context)

Method Summary

Methods

Modifier and Type	Method and Description
static void	debugOn()
void	disableGeofences() Explicitly disable geofence support.
void	enableGeofences() Explicitly enable geofence support.
com.radiusnetworks.proximity.proximitykit.BeaconAdapter	getBeaconAdapter()
BeaconManager	getBeaconManager() Convenience method to access the beacon manager
static ProximityKitManager	getInstanceForApplication(android.content.Context context) An accessor for the singleton instance of this class.
Kit	getKit() The local copy of the kit you have set up on ProximityKit.com
ProximityKitGeofenceNotifier	getProximityKitGeofenceNotifier()
ProximityKitMonitorNotifier	getProximityKitMonitorNotifier()
ProximityKitRangeNotifier	getProximityKitRangeNotifier()
ProximityKitSyncNotifier	getProximityKitSyncNotifier()
void	restart() This method is used to reconfigure the ProximityKit properties at runtime There is no need to call this method if you are configurng ProximityKit from a .properties file.
void	restart(String code)
void	setKit(Kit kit) Used by the system when sync'ing data form the server.
void	setProximityKitGeofenceNotifier(ProximityKitGeofenceNotifier pkGeofenceNotifier)
void	setProximityKitMonitorNotifier(ProximityKitMonitorNotifier pkMonitorNotifier)
void	setProximityKitRangeNotifier(ProximityKitRangeNotifier pkRangeNotifier)
void	setProximityKitSyncNotifier(ProximityKitSyncNotifier pkSyncNotifier)
void	setSyncInterval(long milliseconds) Sets the length of time between sync.
void	start() Start syncing with the cloud and monitoring for various regions.
void	stop() Stop all Proximity Kit activities.
void	sync()

Methods inherited from class java.lang.Object

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

Field Detail

context

protected android.content.Context context

Constructor Detail

ProximityKitManager

protected ProximityKitManager()

ProximityKitManager

protected ProximityKitManager(android.content.Context context)

Method Detail

disableGeofences

public void disableGeofences()

Explicitly disable geofence support. This is set by default (i.e. no geofence support). It is as a convenience method to allow apps to disable geofence support at a later time.

enableGeofences

public void enableGeofences()
                     throws GooglePlayServicesException

Explicitly enable geofence support. Apps wanting to use geofences must call this method before calling start(). It is the caller's responsibility to ensure that the application has properly included and configured the Google Play services library. Additionally, it is the caller's responsibility to ensure that the device supports Google Play services. Failure to ensure these will result in a GooglePlayServicesException.

Throws:

GooglePlayServicesException - It is the client's responsibility to ensure that Google Play services is properly listed as a dependency, configured, and then available on the device. This exception is thrown under several conditions:

• Google Play services library is not listed as dependencies by the calling app
• Google Play services are not properly configured in the calling app
• The calling app failed to disable geofence when Google Play services were not available on the device

See Also:

Setup Google Play services , Checking if Google Play services is available

getInstanceForApplication

public static ProximityKitManager getInstanceForApplication(android.content.Context context)

An accessor for the singleton instance of this class. A context must be provided, but if you need to use it from a non-Activity or non-Service class, you can attach it to another singleton or a subclass of the Android Application class.

getBeaconManager

public BeaconManager getBeaconManager()

Convenience method to access the beacon manager

Returns:

debugOn

public static void debugOn()

start

public void start()

Start syncing with the cloud and monitoring for various regions. This will:

• Start syncing data with the Proximity Kit cloud
• Start monitoring for beacons
• Start monitoring for geofences (if enabled)

Set any desired notification callbacks prior to starting the manager. Notifications are not queued. Any notifications which are received prior to a callback being configured will be dropped.

stop

public void stop()

Stop all Proximity Kit activities. This will:

• Disallow any further syncing
• Unregister all known geofences (if enabled)
• Disconnect from the geofence service (if enabled)
• Unregister all known beacons
• Disconnect from the beacon service

restart

public void restart()

This method is used to reconfigure the ProximityKit properties at runtime There is no need to call this method if you are configurng ProximityKit from a .properties file.

restart

public void restart(String code)

sync

public void sync()

getProximityKitGeofenceNotifier

public ProximityKitGeofenceNotifier getProximityKitGeofenceNotifier()

setProximityKitGeofenceNotifier

public void setProximityKitGeofenceNotifier(ProximityKitGeofenceNotifier pkGeofenceNotifier)

setProximityKitMonitorNotifier

public void setProximityKitMonitorNotifier(ProximityKitMonitorNotifier pkMonitorNotifier)

getProximityKitMonitorNotifier

public ProximityKitMonitorNotifier getProximityKitMonitorNotifier()

setProximityKitRangeNotifier

public void setProximityKitRangeNotifier(ProximityKitRangeNotifier pkRangeNotifier)

getProximityKitRangeNotifier

public ProximityKitRangeNotifier getProximityKitRangeNotifier()

setProximityKitSyncNotifier

public void setProximityKitSyncNotifier(ProximityKitSyncNotifier pkSyncNotifier)

getProximityKitSyncNotifier

public ProximityKitSyncNotifier getProximityKitSyncNotifier()

getKit

public Kit getKit()

The local copy of the kit you have set up on ProximityKit.com

Returns:

setKit

public void setKit(Kit kit)

Used by the system when sync'ing data form the server. Should not be called by end users.

Parameters:

kit -

getBeaconAdapter

public com.radiusnetworks.proximity.proximitykit.BeaconAdapter getBeaconAdapter()

setSyncInterval

public void setSyncInterval(long milliseconds)

Sets the length of time between sync. In the event that the proximity kit is updated, the app must sync in order to receive this new information. However, syncing does tax battery life significantly if performed too often, so we do not recommend setting this very low. This is set at one hour by default. The minimum setting is 5 minutes (300000 milliseconds).

Parameters:

milliseconds - Number of minutes to wait between each sync with Proximity Kit.