ProximityKitManager (Proximity Kit Android 0.3.1)

java.lang.Object
- com.radiusnetworks.proximity.ProximityKitManager

```
public class ProximityKitManager
extends Object
```
This is the main class for used for interacting with the Proximity Kit SDK. More information can be found at http://proximitykit.com

Since:

0.1.0

Min Android API:
4 - The ability to check the Android SDK level as an integer android.os.Build.VERSION.SDK_INT was added in this API level

Field Summary

Fields
Modifier and Type Field and Description

protected android.content.Context context

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)

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()` Turns debugging on for geofences and beacons.
`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
`int`	`getMaxRegionsBeforeRollup()` Gets the maximum number of regions that may be individually configured in ProximityKit before the regions will start being automatically combined.
`ProximityKitGeofenceNotifier`	`getProximityKitGeofenceNotifier()` Getter for the currently configured Geofence notification callback handler.
`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)` 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`	`setKit(Kit kit)` Used by the system when sync'ing data form the server.
`void`	`setMaxRegionsBeforeRollup(int regionCount)` Sets the maximum number of regions that may be individually configured in ProximityKit before the regions will start being automatically combined.
`void`	`setProximityKitGeofenceNotifier(ProximityKitGeofenceNotifier pkGeofenceNotifier)` Register the Geofence notification callback handler.
`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.
    
    Min Android API:
    9 - Google Play services requires this API level.
  - 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
    Min Android API:
    9 - Google Play services requires this API level.
  - 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:
    the beacon manager instance bound to this application
    Min Android API:
    18 - Beacon support is not available until this API level.
  - debugOn
```
public static void debugOn()
```
    Turns debugging on for geofences and beacons.
  - 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.
    Min Android API:
    9 - Geofences rely on Google Play services which requires this API level. For API's below this level a warning is issued and geofencing is disabled.
    18 - Beacon support is not available until this API level. For API's below this level a warning is issued and beacon support is disabled.
  - 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)
```
    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.
    
    Parameters:
    code - Custom code which is used to configure the sync
  - sync
```
public void sync()
```
  - getProximityKitGeofenceNotifier
```
public ProximityKitGeofenceNotifier getProximityKitGeofenceNotifier()
```
    Getter for the currently configured Geofence notification callback handler.
    
    Returns:
    the configured ProximityKitGeofenceNotifier or null if nothing has been configured.
    Min Android API:
    9 - Google Play services requires this API level.
  - setProximityKitGeofenceNotifier
```
public void setProximityKitGeofenceNotifier(ProximityKitGeofenceNotifier pkGeofenceNotifier)
```
    Register the Geofence notification callback handler. If a handler is already registered this overwrites it without warning.
    
    Parameters:
    pkGeofenceNotifier - The Geofence notification callback handler
    Min Android API:
    9 - Google Play services requires this API level.
  - 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()
```
    Min Android API:
    18 - Beacon support is not available until this API level.
  - 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.
  - setMaxRegionsBeforeRollup
```
public void setMaxRegionsBeforeRollup(int regionCount)
```
    Sets the maximum number of regions that may be individually configured in ProximityKit before the regions will start being automatically combined. By default, each beacon or region in the ProximityKit server results in one monitoring and ranging region. In cases of large numbers of individual beacons configured on the server, these beacons will be combined into a smaller number of matching regions for monitoring and ranging purposes. By default, this value is -1, which means that no rollup will occur.
    
    Parameters:
    regionCount -
  - getMaxRegionsBeforeRollup
```
public int getMaxRegionsBeforeRollup()
```
    Gets the maximum number of regions that may be individually configured in ProximityKit before the regions will start being automatically combined.
    
    Returns:
    region count
    See Also:
    ProximityKitManager.setMaxRegionsBeforeRollup(int)

Class ProximityKitManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

context

Constructor Detail

ProximityKitManager

ProximityKitManager

Method Detail

disableGeofences

enableGeofences

getInstanceForApplication

getBeaconManager

debugOn

start

stop

restart

restart

sync

getProximityKitGeofenceNotifier

setProximityKitGeofenceNotifier

setProximityKitMonitorNotifier

getProximityKitMonitorNotifier

setProximityKitRangeNotifier

getProximityKitRangeNotifier

setProximityKitSyncNotifier

getProximityKitSyncNotifier

getKit

setKit

getBeaconAdapter

setSyncInterval

setMaxRegionsBeforeRollup

getMaxRegionsBeforeRollup