-
public final class RadarTrackingOptionsAn options class used to configure background tracking.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enumRadarTrackingOptions.RadarTrackingOptionsDesiredAccuracyThe location accuracy options.
public enumRadarTrackingOptions.RadarTrackingOptionsReplayThe replay options for failed location updates.
public enumRadarTrackingOptions.RadarTrackingOptionsSyncpublic enumRadarTrackingOptions.RadarTrackingOptionsSyncGeofencespublic final classRadarTrackingOptions.RadarTrackingOptionsForegroundServicepublic classRadarTrackingOptions.Companion
-
Field Summary
Fields Modifier and Type Field Description private IntegerdesiredStoppedUpdateIntervalprivate IntegerfastestStoppedUpdateIntervalprivate IntegerdesiredMovingUpdateIntervalprivate IntegerfastestMovingUpdateIntervalprivate IntegerdesiredSyncIntervalprivate RadarTrackingOptions.RadarTrackingOptionsDesiredAccuracydesiredAccuracyprivate IntegerstopDurationprivate IntegerstopDistanceprivate DatestartTrackingAfterprivate DatestopTrackingAfterprivate RadarTrackingOptions.RadarTrackingOptionsReplayreplayprivate RadarTrackingOptions.RadarTrackingOptionsSyncsyncprivate BooleanuseStoppedGeofenceprivate IntegerstoppedGeofenceRadiusprivate BooleanuseMovingGeofenceprivate IntegermovingGeofenceRadiusprivate RadarTrackingOptions.RadarTrackingOptionsSyncGeofencessyncGeofencesprivate IntegersyncGeofencesLimitprivate BooleanforegroundServiceEnabledprivate Booleanbeaconsprivate BooleanuseMotionprivate BooleanusePressure
-
Constructor Summary
Constructors Constructor Description RadarTrackingOptions(Integer desiredStoppedUpdateInterval, Integer fastestStoppedUpdateInterval, Integer desiredMovingUpdateInterval, Integer fastestMovingUpdateInterval, Integer desiredSyncInterval, RadarTrackingOptions.RadarTrackingOptionsDesiredAccuracy desiredAccuracy, Integer stopDuration, Integer stopDistance, Date startTrackingAfter, Date stopTrackingAfter, RadarTrackingOptions.RadarTrackingOptionsReplay replay, RadarTrackingOptions.RadarTrackingOptionsSync sync, Boolean useStoppedGeofence, Integer stoppedGeofenceRadius, Boolean useMovingGeofence, Integer movingGeofenceRadius, RadarTrackingOptions.RadarTrackingOptionsSyncGeofences syncGeofences, Integer syncGeofencesLimit, Boolean foregroundServiceEnabled, Boolean beacons, Boolean useMotion, Boolean usePressure)
-
Method Summary
Modifier and Type Method Description final IntegergetDesiredStoppedUpdateInterval()Determines the desired location update interval in seconds when stopped. final UnitsetDesiredStoppedUpdateInterval(Integer desiredStoppedUpdateInterval)Determines the desired location update interval in seconds when stopped. final IntegergetFastestStoppedUpdateInterval()Determines the fastest location update interval in seconds when stopped. final UnitsetFastestStoppedUpdateInterval(Integer fastestStoppedUpdateInterval)Determines the fastest location update interval in seconds when stopped. final IntegergetDesiredMovingUpdateInterval()Determines the desired location update interval in seconds when moving. final UnitsetDesiredMovingUpdateInterval(Integer desiredMovingUpdateInterval)Determines the desired location update interval in seconds when moving. final IntegergetFastestMovingUpdateInterval()Determines the fastest location update interval in seconds when moving. final UnitsetFastestMovingUpdateInterval(Integer fastestMovingUpdateInterval)Determines the fastest location update interval in seconds when moving. final IntegergetDesiredSyncInterval()Determines the desired sync interval in seconds. final UnitsetDesiredSyncInterval(Integer desiredSyncInterval)Determines the desired sync interval in seconds. final RadarTrackingOptions.RadarTrackingOptionsDesiredAccuracygetDesiredAccuracy()Determines the desired accuracy of location updates. final UnitsetDesiredAccuracy(RadarTrackingOptions.RadarTrackingOptionsDesiredAccuracy desiredAccuracy)Determines the desired accuracy of location updates. final IntegergetStopDuration()With stopDistance, determines the duration in seconds after which the device is considered stopped.final UnitsetStopDuration(Integer stopDuration)With stopDistance, determines the duration in seconds after which the device is considered stopped.final IntegergetStopDistance()With stopDuration, determines the distance in meters within which the device is considered stopped.final UnitsetStopDistance(Integer stopDistance)With stopDuration, determines the distance in meters within which the device is considered stopped.final DategetStartTrackingAfter()Determines when to start tracking. final UnitsetStartTrackingAfter(Date startTrackingAfter)Determines when to start tracking. final DategetStopTrackingAfter()Determines when to stop tracking. final UnitsetStopTrackingAfter(Date stopTrackingAfter)Determines when to stop tracking. final RadarTrackingOptions.RadarTrackingOptionsReplaygetReplay()Determines which failed location updates to replay to the server. final UnitsetReplay(RadarTrackingOptions.RadarTrackingOptionsReplay replay)Determines which failed location updates to replay to the server. final RadarTrackingOptions.RadarTrackingOptionsSyncgetSync()Determines which location updates to sync to the server. final UnitsetSync(RadarTrackingOptions.RadarTrackingOptionsSync sync)Determines which location updates to sync to the server. final BooleangetUseStoppedGeofence()Determines whether to create a client geofence around the device's current location when stopped. final UnitsetUseStoppedGeofence(Boolean useStoppedGeofence)Determines whether to create a client geofence around the device's current location when stopped. final IntegergetStoppedGeofenceRadius()Determines the radius in meters of the client geofence around the device's current location when stopped. final UnitsetStoppedGeofenceRadius(Integer stoppedGeofenceRadius)Determines the radius in meters of the client geofence around the device's current location when stopped. final BooleangetUseMovingGeofence()Determines whether to create a client geofence around the device's current location when moving. final UnitsetUseMovingGeofence(Boolean useMovingGeofence)Determines whether to create a client geofence around the device's current location when moving. final IntegergetMovingGeofenceRadius()Determines the radius in meters of the client geofence around the device's current location when moving. final UnitsetMovingGeofenceRadius(Integer movingGeofenceRadius)Determines the radius in meters of the client geofence around the device's current location when moving. final RadarTrackingOptions.RadarTrackingOptionsSyncGeofencesgetSyncGeofences()Determines whether to sync nearby geofences from the server to the client to improve responsiveness. final UnitsetSyncGeofences(RadarTrackingOptions.RadarTrackingOptionsSyncGeofences syncGeofences)Determines whether to sync nearby geofences from the server to the client to improve responsiveness. final IntegergetSyncGeofencesLimit()Determines how many nearby geofences to sync from the server to the client when syncGeofencesis enabled.final UnitsetSyncGeofencesLimit(Integer syncGeofencesLimit)Determines how many nearby geofences to sync from the server to the client when syncGeofencesis enabled.final BooleangetForegroundServiceEnabled()If set, starts a foreground service and shows a notification during tracking. final UnitsetForegroundServiceEnabled(Boolean foregroundServiceEnabled)If set, starts a foreground service and shows a notification during tracking. final BooleangetBeacons()Determines whether to monitor beacons. final UnitsetBeacons(Boolean beacons)Determines whether to monitor beacons. final BooleangetUseMotion()Determines whether to use motion detection and collect location metadata. final UnitsetUseMotion(Boolean useMotion)Determines whether to use motion detection and collect location metadata. final BooleangetUsePressure()Determines whether to collect pressure data. final UnitsetUsePressure(Boolean usePressure)Determines whether to collect pressure data. final JSONObjecttoJson()-
-
Constructor Detail
-
RadarTrackingOptions
RadarTrackingOptions(Integer desiredStoppedUpdateInterval, Integer fastestStoppedUpdateInterval, Integer desiredMovingUpdateInterval, Integer fastestMovingUpdateInterval, Integer desiredSyncInterval, RadarTrackingOptions.RadarTrackingOptionsDesiredAccuracy desiredAccuracy, Integer stopDuration, Integer stopDistance, Date startTrackingAfter, Date stopTrackingAfter, RadarTrackingOptions.RadarTrackingOptionsReplay replay, RadarTrackingOptions.RadarTrackingOptionsSync sync, Boolean useStoppedGeofence, Integer stoppedGeofenceRadius, Boolean useMovingGeofence, Integer movingGeofenceRadius, RadarTrackingOptions.RadarTrackingOptionsSyncGeofences syncGeofences, Integer syncGeofencesLimit, Boolean foregroundServiceEnabled, Boolean beacons, Boolean useMotion, Boolean usePressure)
-
-
Method Detail
-
getDesiredStoppedUpdateInterval
final Integer getDesiredStoppedUpdateInterval()
Determines the desired location update interval in seconds when stopped. Use 0 to shut down when stopped.
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.
-
setDesiredStoppedUpdateInterval
final Unit setDesiredStoppedUpdateInterval(Integer desiredStoppedUpdateInterval)
Determines the desired location update interval in seconds when stopped. Use 0 to shut down when stopped.
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.
-
getFastestStoppedUpdateInterval
final Integer getFastestStoppedUpdateInterval()
Determines the fastest location update interval in seconds when stopped.
-
setFastestStoppedUpdateInterval
final Unit setFastestStoppedUpdateInterval(Integer fastestStoppedUpdateInterval)
Determines the fastest location update interval in seconds when stopped.
-
getDesiredMovingUpdateInterval
final Integer getDesiredMovingUpdateInterval()
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.
-
setDesiredMovingUpdateInterval
final Unit setDesiredMovingUpdateInterval(Integer 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.
-
getFastestMovingUpdateInterval
final Integer getFastestMovingUpdateInterval()
Determines the fastest location update interval in seconds when moving.
-
setFastestMovingUpdateInterval
final Unit setFastestMovingUpdateInterval(Integer fastestMovingUpdateInterval)
Determines the fastest location update interval in seconds when moving.
-
getDesiredSyncInterval
final Integer getDesiredSyncInterval()
Determines the desired sync interval in seconds.
-
setDesiredSyncInterval
final Unit setDesiredSyncInterval(Integer desiredSyncInterval)
Determines the desired sync interval in seconds.
-
getDesiredAccuracy
final RadarTrackingOptions.RadarTrackingOptionsDesiredAccuracy getDesiredAccuracy()
Determines the desired accuracy of location updates.
-
setDesiredAccuracy
final Unit setDesiredAccuracy(RadarTrackingOptions.RadarTrackingOptionsDesiredAccuracy desiredAccuracy)
Determines the desired accuracy of location updates.
-
getStopDuration
final Integer getStopDuration()
With
stopDistance, determines the duration in seconds after which the device is considered stopped.
-
setStopDuration
final Unit setStopDuration(Integer stopDuration)
With
stopDistance, determines the duration in seconds after which the device is considered stopped.
-
getStopDistance
final Integer getStopDistance()
With
stopDuration, determines the distance in meters within which the device is considered stopped.
-
setStopDistance
final Unit setStopDistance(Integer stopDistance)
With
stopDuration, determines the distance in meters within which the device is considered stopped.
-
getStartTrackingAfter
final Date getStartTrackingAfter()
Determines when to start tracking. Use
nullto start tracking whenstartTracking()is called.
-
setStartTrackingAfter
final Unit setStartTrackingAfter(Date startTrackingAfter)
Determines when to start tracking. Use
nullto start tracking whenstartTracking()is called.
-
getStopTrackingAfter
final Date getStopTrackingAfter()
Determines when to stop tracking. Use
nullto track untilstopTracking()is called.
-
setStopTrackingAfter
final Unit setStopTrackingAfter(Date stopTrackingAfter)
Determines when to stop tracking. Use
nullto track untilstopTracking()is called.
-
getReplay
final RadarTrackingOptions.RadarTrackingOptionsReplay getReplay()
Determines which failed location updates to replay to the server.
-
setReplay
final Unit setReplay(RadarTrackingOptions.RadarTrackingOptionsReplay replay)
Determines which failed location updates to replay to the server.
-
getSync
final RadarTrackingOptions.RadarTrackingOptionsSync getSync()
Determines which location updates to sync to the server.
-
setSync
final Unit setSync(RadarTrackingOptions.RadarTrackingOptionsSync sync)
Determines which location updates to sync to the server.
-
getUseStoppedGeofence
final Boolean getUseStoppedGeofence()
-
setUseStoppedGeofence
final Unit setUseStoppedGeofence(Boolean useStoppedGeofence)
-
getStoppedGeofenceRadius
final Integer getStoppedGeofenceRadius()
Determines the radius in meters of the client geofence around the device's current location when stopped.
-
setStoppedGeofenceRadius
final Unit setStoppedGeofenceRadius(Integer stoppedGeofenceRadius)
Determines the radius in meters of the client geofence around the device's current location when stopped.
-
getUseMovingGeofence
final Boolean getUseMovingGeofence()
-
setUseMovingGeofence
final Unit setUseMovingGeofence(Boolean useMovingGeofence)
-
getMovingGeofenceRadius
final Integer getMovingGeofenceRadius()
Determines the radius in meters of the client geofence around the device's current location when moving.
-
setMovingGeofenceRadius
final Unit setMovingGeofenceRadius(Integer movingGeofenceRadius)
Determines the radius in meters of the client geofence around the device's current location when moving.
-
getSyncGeofences
final RadarTrackingOptions.RadarTrackingOptionsSyncGeofences getSyncGeofences()
Determines whether to sync nearby geofences from the server to the client to improve responsiveness.
-
setSyncGeofences
final Unit setSyncGeofences(RadarTrackingOptions.RadarTrackingOptionsSyncGeofences syncGeofences)
Determines whether to sync nearby geofences from the server to the client to improve responsiveness.
-
getSyncGeofencesLimit
final Integer getSyncGeofencesLimit()
Determines how many nearby geofences to sync from the server to the client when
syncGeofencesis enabled.
-
setSyncGeofencesLimit
final Unit setSyncGeofencesLimit(Integer syncGeofencesLimit)
Determines how many nearby geofences to sync from the server to the client when
syncGeofencesis enabled.
-
getForegroundServiceEnabled
final Boolean getForegroundServiceEnabled()
If set, starts a foreground service and shows a notification during tracking.
-
setForegroundServiceEnabled
final Unit setForegroundServiceEnabled(Boolean foregroundServiceEnabled)
If set, starts a foreground service and shows a notification during tracking.
-
getBeacons
final Boolean getBeacons()
Determines whether to monitor beacons.
-
setBeacons
final Unit setBeacons(Boolean beacons)
Determines whether to monitor beacons.
-
getUseMotion
final Boolean getUseMotion()
Determines whether to use motion detection and collect location metadata.
-
setUseMotion
final Unit setUseMotion(Boolean useMotion)
Determines whether to use motion detection and collect location metadata.
-
getUsePressure
final Boolean getUsePressure()
Determines whether to collect pressure data.
-
setUsePressure
final Unit setUsePressure(Boolean usePressure)
Determines whether to collect pressure data.
-
toJson
final JSONObject toJson()
-
-
-
-