RadarTrackingOptions

Objective-C

@interface RadarTrackingOptions : NSObject

Swift

class RadarTrackingOptions : NSObject

An options class used to configure background tracking.

  • Determines the desired location update interval in seconds when stopped. Use 0 to shut down when stopped.

    Warning

    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.

    Declaration

    Objective-C

    @property (nonatomic) int desiredStoppedUpdateInterval;

    Swift

    var desiredStoppedUpdateInterval: Int32 { get set }
  • Determines the desired location update interval in seconds when moving.

    Warning

    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.

    Declaration

    Objective-C

    @property (nonatomic) int desiredMovingUpdateInterval;

    Swift

    var desiredMovingUpdateInterval: Int32 { get set }
  • Determines the desired sync interval in seconds.

    Declaration

    Objective-C

    @property (nonatomic) int desiredSyncInterval;

    Swift

    var desiredSyncInterval: Int32 { get set }
  • Determines the desired accuracy of location updates.

    Declaration

    Objective-C

    @property (nonatomic) RadarTrackingOptionsDesiredAccuracy desiredAccuracy;

    Swift

    var desiredAccuracy: RadarTrackingOptionsDesiredAccuracy { get set }
  • With stopDistance, determines the duration in seconds after which the device is considered stopped.

    Declaration

    Objective-C

    @property (nonatomic) int stopDuration;

    Swift

    var stopDuration: Int32 { get set }
  • With stopDuration, determines the distance in meters within which the device is considered stopped.

    Declaration

    Objective-C

    @property (nonatomic) int stopDistance;

    Swift

    var stopDistance: Int32 { get set }
  • Determines when to start tracking. Use nil to start tracking when startTracking is called.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSDate *startTrackingAfter;

    Swift

    var startTrackingAfter: Date? { get set }
  • Determines when to stop tracking. Use nil to track until stopTracking is called.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSDate *stopTrackingAfter;

    Swift

    var stopTrackingAfter: Date? { get set }
  • Determines which failed location updates to replay to the server.

    Declaration

    Objective-C

    @property (nonatomic) RadarTrackingOptionsReplay replay;

    Swift

    var replay: RadarTrackingOptionsReplay { get set }
  • Determines which location updates to sync to the server.

    Declaration

    Objective-C

    @property (nonatomic) RadarTrackingOptionsSyncLocations syncLocations;

    Swift

    var syncLocations: RadarTrackingOptionsSyncLocations { get set }
  • Determines whether the flashing blue status bar is shown when tracking.

    Declaration

    Objective-C

    @property (nonatomic) BOOL showBlueBar;

    Swift

    var showBlueBar: Bool { get set }
  • Determines whether to use the iOS region monitoring service (geofencing) to create a client geofence around the device’s current location when stopped.

    Declaration

    Objective-C

    @property (nonatomic) BOOL useStoppedGeofence;

    Swift

    var useStoppedGeofence: Bool { get set }
  • Determines the radius in meters of the client geofence around the device’s current location when stopped.

    Declaration

    Objective-C

    @property (nonatomic) int stoppedGeofenceRadius;

    Swift

    var stoppedGeofenceRadius: Int32 { get set }
  • Determines whether to use the iOS region monitoring service (geofencing) to create a client geofence around the device’s current location when moving.

    Declaration

    Objective-C

    @property (nonatomic) BOOL useMovingGeofence;

    Swift

    var useMovingGeofence: Bool { get set }
  • Determines the radius in meters of the client geofence around the device’s current location when moving.

    Declaration

    Objective-C

    @property (nonatomic) int movingGeofenceRadius;

    Swift

    var movingGeofenceRadius: Int32 { get set }
  • Determines whether to sync nearby geofences from the server to the client to improve responsiveness.

    Declaration

    Objective-C

    @property (nonatomic) BOOL syncGeofences;

    Swift

    var syncGeofences: Bool { get set }
  • Declaration

    Objective-C

    @property (nonatomic) BOOL useVisits;

    Swift

    var useVisits: Bool { get set }
  • Declaration

    Objective-C

    @property (nonatomic) BOOL useSignificantLocationChanges;

    Swift

    var useSignificantLocationChanges: Bool { get set }
  • Determines whether to monitor beacons.

    Declaration

    Objective-C

    @property (nonatomic) BOOL beacons;

    Swift

    var beacons: Bool { get set }
  • Updates about every 30 seconds while moving or stopped. Moderate battery usage. Shows the flashing blue status bar during tracking.

    Declaration

    Objective-C

    @property (class, copy, readonly) RadarTrackingOptions *_Nonnull presetContinuous;

    Swift

    @NSCopying class var presetContinuous: RadarTrackingOptions { get }
  • 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. 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.

    Declaration

    Objective-C

    @property (class, copy, readonly) RadarTrackingOptions *_Nonnull presetResponsive;

    Swift

    @NSCopying class var presetResponsive: RadarTrackingOptions { get }
  • 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. 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.

    Declaration

    Objective-C

    @property (class, copy, readonly) RadarTrackingOptions *_Nonnull presetEfficient;

    Swift

    @NSCopying class var presetEfficient: RadarTrackingOptions { get }