RadarTrackingOptions

data class RadarTrackingOptions(desiredStoppedUpdateInterval: Int, fastestStoppedUpdateInterval: Int, desiredMovingUpdateInterval: Int, fastestMovingUpdateInterval: Int, desiredSyncInterval: Int, desiredAccuracy: RadarTrackingOptions.RadarTrackingOptionsDesiredAccuracy, stopDuration: Int, stopDistance: Int, startTrackingAfter: Date?, stopTrackingAfter: Date?, replay: RadarTrackingOptions.RadarTrackingOptionsReplay, sync: RadarTrackingOptions.RadarTrackingOptionsSync, useStoppedGeofence: Boolean, stoppedGeofenceRadius: Int, useMovingGeofence: Boolean, movingGeofenceRadius: Int, syncGeofences: Boolean, syncGeofencesLimit: Int, foregroundServiceEnabled: Boolean, beacons: Boolean)

An options class used to configure background tracking.

See also

Constructors

RadarTrackingOptions

fun RadarTrackingOptions(desiredStoppedUpdateInterval: Int, fastestStoppedUpdateInterval: Int, desiredMovingUpdateInterval: Int, fastestMovingUpdateInterval: Int, desiredSyncInterval: Int, desiredAccuracy: RadarTrackingOptions.RadarTrackingOptionsDesiredAccuracy, stopDuration: Int, stopDistance: Int, startTrackingAfter: Date?, stopTrackingAfter: Date?, replay: RadarTrackingOptions.RadarTrackingOptionsReplay, sync: RadarTrackingOptions.RadarTrackingOptionsSync, useStoppedGeofence: Boolean, stoppedGeofenceRadius: Int, useMovingGeofence: Boolean, movingGeofenceRadius: Int, syncGeofences: Boolean, syncGeofencesLimit: Int, foregroundServiceEnabled: Boolean, beacons: Boolean)

Types

Companion

object Companion

RadarTrackingOptionsDesiredAccuracy

enum RadarTrackingOptionsDesiredAccuracy : Enum<RadarTrackingOptions.RadarTrackingOptionsDesiredAccuracy>

The location accuracy options.

RadarTrackingOptionsForegroundService

data class RadarTrackingOptionsForegroundService(text: String?, title: String?, icon: Int?, updatesOnly: Boolean, activity: String?, importance: Int?, id: Int?, channelName: String?)

RadarTrackingOptionsReplay

enum RadarTrackingOptionsReplay : Enum<RadarTrackingOptions.RadarTrackingOptionsReplay>

The replay options for failed location updates.

RadarTrackingOptionsSync

enum RadarTrackingOptionsSync : Enum<RadarTrackingOptions.RadarTrackingOptionsSync>

Functions

toJson

fun toJson(): JSONObject

Properties

beacons

var beacons: Boolean

Determines whether to monitor beacons.

desiredAccuracy

var desiredAccuracy: RadarTrackingOptions.RadarTrackingOptionsDesiredAccuracy

Determines the desired accuracy of location updates.

desiredMovingUpdateInterval

var desiredMovingUpdateInterval: Int

Determines the desired location update interval in seconds when moving.

desiredStoppedUpdateInterval

var desiredStoppedUpdateInterval: Int

Determines the desired location update interval in seconds when stopped.

desiredSyncInterval

var desiredSyncInterval: Int

Determines the desired sync interval in seconds.

fastestMovingUpdateInterval

var fastestMovingUpdateInterval: Int

Determines the fastest location update interval in seconds when moving.

fastestStoppedUpdateInterval

var fastestStoppedUpdateInterval: Int

Determines the fastest location update interval in seconds when stopped.

foregroundServiceEnabled

var foregroundServiceEnabled: Boolean

If set, starts a foreground service and shows a notification during tracking.

movingGeofenceRadius

var movingGeofenceRadius: Int

Determines the radius in meters of the client geofence around the device's current location when moving.

replay

var replay: RadarTrackingOptions.RadarTrackingOptionsReplay

Determines which failed location updates to replay to the server.

startTrackingAfter

var startTrackingAfter: Date?

Determines when to start tracking.

stopDistance

var stopDistance: Int

With stopDuration, determines the distance in meters within which the device is considered stopped.

stopDuration

var stopDuration: Int

With stopDistance, determines the duration in seconds after which the device is considered stopped.

stoppedGeofenceRadius

var stoppedGeofenceRadius: Int

Determines the radius in meters of the client geofence around the device's current location when stopped.

stopTrackingAfter

var stopTrackingAfter: Date?

Determines when to stop tracking.

sync

var sync: RadarTrackingOptions.RadarTrackingOptionsSync

Determines which location updates to sync to the server.

syncGeofences

var syncGeofences: Boolean

Determines whether to sync nearby geofences from the server to the client to improve responsiveness.

syncGeofencesLimit

var syncGeofencesLimit: Int

Determines how many nearby geofences to sync from the server to the client when syncGeofences is enabled.

useMovingGeofence

var useMovingGeofence: Boolean

Determines whether to create a client geofence around the device's current location when moving.

useStoppedGeofence

var useStoppedGeofence: Boolean

Determines whether to create a client geofence around the device's current location when stopped.