See: Description
This document is the API specification for the Radius Networks Proximity Kit SDK.
Usage of the Proximity Kit Android SDK implies agreement to abide by the license terms.
Designed to help developers build location aware apps. By providing a rich SDK built on top of the latest geofence and beacon technology, Proximity Kit gives you the events you need to keep your app relevant and useful to your users.
Upon entering or leaving an beacon or geofence region, Proximity Kit notifies your app of the proximity event along with region identifiers and associated metadata. While in an beacon region, Proximity Kit provides additional ranging services for continuous proximity updates relative to the phone's distance from the beacon.
Android 8.0 imposes new restrictions on BLE scanning while in the
background. This release changes the behavior on Android 8 to use the
JobScheduler to perform background scans. Due to limitations
of the OS these background scan jobs may not be scheduled faster than once
every 15 minutes. However, when a scan job completes, if no beacons are
detected a low power scan will begin. This scan will continue to run until
any beacon is detected at which point the JobScheduler will
start again.
Foreground behavior remains the same as prior releases even on Android 8. Additionally, these background changes only affects devices running Android 8.0 or newer. Devices running older Android versions will continue to use the existing legacy behavior.
For more details see Background Execution Limits and Background Location Limits.
ProximityKitGeofenceNotifier.didDetermineStateForGeofence
with a state of UNKNOWN when location services is disabled
after geofences have been registered
ProximityKitGeofenceNotifier#didDetermineStateForGeofence will
now be called with state RegionEvent.UNKNOWN
This also includes all fixes from the 0.13.1 release.
For general service questions and help consult the Radius Networks support knowledge base.
For further API reference and developer documentation, see the Proximity Kit documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
If you've found a problem in this library, perform a search on existing issues in case it has already been reported. If you do not find any issue addressing it, feel free to open a new one.
Your issue report should contain a title and a clear description of the issue at a minimum. Please provide as much relevant information as possible to replicate the issue. This should include the Java and library versions, a code sample demonstrating the issue, and device OS information. Providing a unit test that demonstrates the issue is greatly appreciated. Your goal should be to make it easy for yourself - and others - to replicate the bug and figure out a fix.