Tracking Options Reference

For background tracking, the SDK supports custom tracking options as well as three presets: EFFICIENT, RESPONSIVE, and CONTINUOUS.

Though we recommend using presets for most use cases, you can modify them.

The SDK has two states: stopped and moving. stopDuration and stopDistance determine whether a location update is considered stopped, and the other options determine tracking behavior depending on state.

iOS#

iOS options#

desiredStoppedUpdateInterval: Determines the desired location update interval in seconds when stopped. Use 0 to shut down when stopped.
desiredMovingUpdateInterval: Determines the desired location update interval in seconds when moving. Note that location updates may be delayed significantly by Low Power Mode, or if the device has connectivity issues, low battery, or wi-fi disabled.
desiredSyncInterval: Determines the desired sync interval in seconds.
desiredAccuracy: Determines the desired accuracy of location updates. .high uses kCLLocationAccuracyBest, .medium uses kCLLocationAccuracyHundredMeters, .low uses kCLLocationAccuracyKilometer.
stopDuration: With stopDistance, determines the duration in seconds after which the device is considered stopped.
stopDistance: With stopDuration, determines the distance in meters within which the device is considered stopped.
startTrackingAfter: Determines when to start tracking. Use nil to start tracking when startTracking is called.
stopTrackingAfter: Determines when to stop tracking. Use nil to track until stopTracking is called.
replay: Determines which failed location updates to replay to the server. .replayStops replays failed stops, .replayNone replays no location updates.
syncLocations: Determines which location updates to sync to the server. .all syncs all location updates to the server, .stopsAndExits syncs only stops and exits to the server, .none syncs no location updates to the server.
showBlueBar: Determines whether the flashing blue status bar is shown when tracking.
useStoppedGeofence: Determines whether to use the iOS region monitoring service (geofencing) to create a client-side geofence "bubble" around the device's current location when stopped.
stoppedGeofenceRadius: Determines the radius in meters of the client-side geofence "bubble" around the device's current location when stopped. Use smaller values (e.g., 100 meters) for faster exit events or larger values (e.g., 200 meters) to avoid jumpy exits while stopped.
useMovingGeofence: Determines whether to use the iOS region monitoring service (geofencing) to create a client-side geofence "bubble" around the device's current location when moving.
movingGeofenceRadius: Determines the radius in meters of the client-side geofence "bubble" around the device's current location when moving.
syncGeofences: Determines whether to sync nearby geofences from the server to the client to improve responsiveness.
useVisits: Determines whether to use the iOS visit monitoring service.
useSignificantLocationChanges: Determines whether to use the iOS significant location change service.
beacons: Determines whether to monitor beacons.

iOS presets#

RadarTrackingOptions.presetContinuous: Updates about every 30 seconds while moving or stopped. Moderate battery usage. Shows the flashing blue status bar during tracking.
RadarTrackingOptions.presetResponsive: Updates about every 2.5 minutes when moving and shuts down when stopped to save battery. Once stopped, the device will need to move more than 100 meters to wake up and start moving again. Low battery usage. Requires the location background mode.
RadarTrackingOptions.presetEfficient: Uses the iOS visit monitoring service to update only on stops and exits. Once stopped, the device will need to move several hundred meters and trigger a visit departure to wake up and start moving again. Lowest battery usage.

Option	Efficient	Responsive	Continuous
`desiredStoppedUpdateInterval`	`0`	`0`	`30`
`desiredMovingUpdateInterval`	`0`	`150`	`30`
`desiredSyncInterval`	`0`	`20`	`20`
`desiredAccuracy`	`.medium`	`.medium`	`.high`
`stopDuration`	`0`	`140`	`140`
`stopDistance`	`0`	`70`	`70`
`startTrackingAfter`	`nil`	`nil`	`nil`
`stopTrackingAfter`	`nil`	`nil`	`nil`
`replay`	`.stops`	`.stops`	`.none`
`syncLocations`	`.all`	`.all`	`.all`
`showBlueBar`	`false`	`false`	`true`
`useStoppedGeofence`	`false`	`true`	`false`
`stoppedGeofenceRadius`	`0`	`100`	`0`
`useMovingGeofence`	`false`	`false`	`false`
`movingGeofenceRadius`	`0`	`0`	`0`
`syncGeofences`	`true`	`true`	`false`
`useVisits`	`true`	`true`	`false`
`useSignificantLocationChanges`	`false`	`true`	`false`
`beacons`	`false`	`false`	`false`

Android#

Android options#

desiredStoppedUpdateInterval: Determines the desired location update interval in seconds when stopped. Use 0 to shut down when stopped.
fastestStoppedUpdateInterval: Determines the fastest location update interval in seconds when stopped.
desiredMovingUpdateInterval: Determines the desired location update interval in seconds when moving. Note that location updates may be delayed significantly by Doze Mode, App Standby, and Background Location Limits, or if the device has connectivity issues, low battery, or wi-fi disabled. To avoid these restrictions, you can start a foreground service.
fastestMovingUpdateInterval: Determines the fastest location update interval in seconds when stopped.
desiredSyncInterval: Determines the desired sync interval in seconds.
desiredAccuracy: Determines the desired accuracy of location updates. HIGH uses PRIORITY_HIGH_ACCURACY, MEDIUM uses PRIORITY_BALANCED_POWER_ACCURACY, LOW uses PRIORITY_LOW_POWER, NONE uses PRIORITY_NO_POWER.
stopDuration: With stopDistance, determines the duration in seconds after which the device is considered stopped.
stopDistance: With stopDuration, determines the distance in meters within which the device is considered stopped.
startTrackingAfter: Determines when to start tracking. Use null to start tracking when startTracking() is called.
stopTrackingAfter: Determines when to stop tracking. Use null to track until stopTracking() is called.
replay: Determines which failed location updates to replay to the server. STOPS replays failed stops, NONE replays no location updates.
sync: Determines which location updates to sync to the server. ALL syncs all location updates to the server, STOPS_AND_EXITS syncs only stops and exits to the server, NONE syncs no location updates to the server.
useStoppedGeofence: Determines whether to create a client-side geofence "bubble" around the device's current location when stopped.
stoppedGeofenceRadius: Determines the radius in meters of the client-side geofence "bubble" around the device's current location when stopped. Use smaller values (e.g., 100 meters) for faster exit events or larger values (e.g., 200 meters) to avoid jumpy exits while stopped.
useMovingGeofence: Determines whether to create a client-side geofence "bubble" around the device's current location when moving.
movingGeofenceRadius: Determines the radius in meters of the client geofence around the device's current location when moving.
syncGeofences: Determines whether to sync nearby geofences from the server to the client to improve responsiveness.
syncGeofencesLimit: Determines how many nearby geofences to sync from the server to the client when syncGeofences is enabled.
foregroundService: If set, starts a foreground service and shows a notification during tracking.
beacons: Determines whether to monitor beacons.

Android foreground service options#

To avoid Background Location Limits, you can start a foreground service and show a notification during tracking. Set trackingOptions.foregroundService to an instance of RadarTrackingOptionsForegroundService.

text: Determines the notification text. Defaults to "Location tracking started".
title: Determines the notification title. Optional.
icon: Determines the notification icon, like R.drawable.ic_your_icon. Optional, defaults to applicationContext.applicationInfo.icon.
updatesOnly: Determines when to show the notification. Use false to show the notification always, use true to show the notification only during location updates. Optional, defaults to false.
activity: Determines the activity to start when the notification is tapped, like "com.yourapp.MainActivity". Optional.
importance: Determines the importance of the notification, one of android.app.NotificationManager.IMPORTANCE_*. Optional, defaults to android.app.NotificationManager.IMPORTANCE_DEFAULT.
id: Determines the id of the notification. Optional, defaults to 20160525.

Android presets#

RadarTrackingOptions.CONTINUOUS: Updates about every 30 seconds while moving or stopped. Starts a foreground service. Moderate battery usage.
RadarTrackingOptions.RESPONSIVE: Updates about every 2.5 minutes while moving and shuts down when stopped to save battery. Once stopped, the device will need to move more than 100 meters to wake up and start moving again. Low battery usage, but may exceed Android vitals bad behavior thresholds for excessive wakeups and excessive wi-fi scans.
RadarTrackingOptions.EFFICIENT: Updates as fast as every 6 minutes while moving and periodically when stopped. Once stopped, the device will need to move more than 100 meters and wait for at least 15 minutes to wake up and start moving again. Lowest battery usage and will not exceed Android vitals bad behavior thresholds.

Option	Efficient	Responsive	Continuous
`desiredStoppedUpdateInterval`	`3600`	`0`	`30`
`fastestStoppedUpdateInterval`	`1200`	`0`	`30`
`desiredMovingUpdateInterval`	`1200`	`150`	`30`
`fastestMovingUpdateInterval`	`360`	`30`	`30`
`desiredSyncInterval`	`140`	`20`	`20`
`desiredAccuracy`	`MEDIUM`	`MEDIUM`	`HIGH`
`stopDuration`	`140`	`140`	`0`
`stopDistance`	`70`	`70`	`0`
`startTrackingAfter`	`null`	`null`	`null`
`stopTrackingAfter`	`null`	`null`	`null`
`replay`	`STOPS`	`STOPS`	`NONE`
`sync`	`ALL`	`ALL`	`ALL`
`useStoppedGeofence`	`false`	`true`	`false`
`stoppedGeofenceRadius`	`0`	`100`	`0`
`useMovingGeofence`	`false`	`true`	`false`
`movingGeofenceRadius`	`0`	`100`	`0`
`syncGeofences`	`true`	`true`	`false`
`syncGeofencesLimit`	`10`	`10`	`0`
`foregroundService`	`null`	`null`	`null`
`beacons`	`false`	`false`	`false`