SPTelemetryConfig
Objective-C
@interface SPTelemetryConfig : NSObject
Swift
class 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;
-
Convert string value to the enum equivalent valid values are “none”, “all” and “known”. Throw an exception otherwise
Declaration
Objective-C
+ (SPTelemetryBeaconLevel)convertStringValueToBeaconLevel: (nonnull NSString *)value;
Swift
class func convertStringValue(toBeaconLevel value: String) -> SPTelemetryBeaconLevel
-
Convert string value to the enum equivalent valid values are “indoor”, “none” and “all”. Throw an exception otherwise
Declaration
Objective-C
+ (SPTelemetryLocationLevel)convertStringValueToLocationLevel: (nonnull NSString *)value;
Swift
class func convertStringValue(toLocationLevel value: String) -> SPTelemetryLocationLevel
-
Remote URL for telemetry services.
Declaration
Objective-C
@property (nonatomic, strong) 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 (nonatomic, strong) NSString *_Nonnull telemetryAccessToken;
Swift
var telemetryAccessToken: String { get set }
-
The level of beacon information that is collected.
By default SPTelemetryBeaconLevelAll
Declaration
Objective-C
@property (nonatomic) SPTelemetryBeaconLevel beacons;
Swift
var beacons: SPTelemetryBeaconLevel { get set }
-
The level of location information that is collected.
By default SPTelemetryLocationLevelIndoor
Declaration
Objective-C
@property (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 (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 (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. This identifier cannot be tracked across devices and installation so this is safe for GDPR’s requirements
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nonnull userIdentifier;
Swift
var userIdentifier: String { get set }