SPTelemetryConfig

@interface SPTelemetryConfig : NSObject

Used for configuring what kind of telemetry data the SDK should gather and at what interval data should be gathered.

If you want to configure these options, you must do that before starting positioning with SPLocationManager.

Telemetry features are disabled by default. Contact support@steerpath.com to learn how to gather telemetry data.

  • Declaration

    Objective-C

    + (nonnull instancetype)sharedInstance;

    Swift

    class func sharedInstance() -> Self

    Return Value

    Singleton instance of SPTelemetryConfig

  • Unavailable

    call sharedInstance instead

    unavailable methods, do not use these

    Declaration

    Objective-C

    - (nonnull instancetype)init;
  • Remote URL for telemetry services.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSURL *_Nonnull telemetryURL;

    Swift

    var telemetryURL: URL { get set }
  • Access token for telemetry services. Contact support@steerpath.com to learn how to gather telemetry data.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSString *_Nonnull telemetryAccessToken;

    Swift

    var telemetryAccessToken: String { get set }
  • The level of beacon information that is collected.

    By default SPTelemetryBeaconLevelAll

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) SPTelemetryBeaconLevel beacons;

    Swift

    var beacons: SPTelemetryBeaconLevel { get set }
  • The level of location information that is collected.

    By default SPTelemetryLocationLevelIndoor

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) SPTelemetryLocationLevel location;

    Swift

    var location: SPTelemetryLocationLevel { get set }
  • Limits the frequency of collecting location data eg. users current location in seconds.

    By default 30 seconds.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) NSTimeInterval locationInterval;

    Swift

    var locationInterval: TimeInterval { get set }
  • Frequency for sending telemetry data to remote services in seconds. Minimum transmission interval is 30 seconds which cannot be overridden.

    By default 30 minutes (1800 seconds)

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) NSTimeInterval transmissionInterval;

    Swift

    var transmissionInterval: TimeInterval { get set }
  • Identifier that will be sent along with telemetry data.

    By default uses [UIDevice currentDevice].identifierForVendor.UUIDString

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSString *_Nonnull userIdentifier;

    Swift

    var userIdentifier: String { get set }