SITLocationRequest
@interface SITLocationRequest : NSObject <NSCopying>
A data object that contains parameters for the location service (SITLocationManager)
-
Constructor.
Declaration
Objective-C
- (instancetype _Nonnull)initWithBuildingId:(NSString *_Nonnull)buildingId;
Parameters
buildingId
Unique identifier of the building in which you want to locate a user.
Return Value
Initialized SITLocationRequest object.
-
The time interval indicating how often the position should be uploaded to realtime.
Declaration
Objective-C
@property (readonly, nonatomic) SITRealtimeUpdateInterval realtimeUpdateInterval;
-
Set if you want to use dead reckoning to get fast position updates using only the inertial sensors, between the server position updates. This parameter is incompatible with interval. If interval is set, dead reckoning will be deactivated for this request.
Declaration
Objective-C
@property (assign, readwrite, nonatomic) BOOL useDeadReckoning;
-
Set if you want to use Gps for positioning indoor.
Declaration
Objective-C
@property (assign, readwrite, nonatomic) BOOL useGps;
-
Unique identifier of the building in which you want to locate a user. (This property is mandatory).
Declaration
Objective-C
@property (readwrite, strong, nonatomic) NSString *_Nonnull buildingID;
-
The thread where the location updates will be provided. If not provided, the main thread will be used.
Declaration
Objective-C
@property (readwrite, strong, nonatomic) NSOperationQueue *_Nullable operationQueue;
-
Additional options to modify the internal operation of the Location provider (private usage only).
Declaration
Objective-C
@property (readwrite, strong, nonatomic) NSDictionary *_Nullable options;
-
Custom UUIDs. The system will scan beacons with those uuids
Declaration
Objective-C
@property (readwrite, strong, nonatomic) NSArray<SITBeaconFilter *> *_Nullable beaconFilters;
-
Set the desired interval for location updates, in milliseconds. This interval is inexact, the service will try to keep this rate in a
best effort
way. This parameter is incompatible with dead reckoning. If set, dead reckoning will be deactivated for this request.Declaration
Objective-C
@property (assign, readwrite, nonatomic) int interval;
-
Minimum displacement between location updates
Declaration
Objective-C
@property (assign, readwrite, nonatomic) float smallestDisplacement;
-
Set if you want to use barometer data for positioning.
Declaration
Objective-C
@property (assign, readwrite, nonatomic) BOOL useBarometer;
-
Set to true if you want to use indoor/outdoor positioning.
Declaration
Objective-C
@property (assign, readwrite, nonatomic) BOOL useGlobalLocation;
-
Check if the request is valid.
Declaration
Objective-C
- (BOOL)isValid;
Return Value
BOOL value that indicates if the request is valid (YES) or not (NO).
-
Deprecated
Location provider is no longer selectable. Provider will always be kSITInPhoneProvider
One of SITLocationProvider.
Declaration
Objective-C
@property (assign, readwrite, nonatomic) SITLocationProvider provider;
-
Deprecated
Use realtimeUpdateInterval instead
The time interval indicating how often the position should be uploaded to realtime. Deprecated, use realtimeUpdateInterval instead.
Declaration
Objective-C
@property (assign, readwrite, nonatomic) NSInteger updateInterval;
-
Deprecated
Use base constructor instead
Constructor.
Declaration
Objective-C
- (instancetype _Nonnull)initWithPriority:(SITLocationPriority)priority provider:(SITLocationProvider)provider updateInterval:(NSInteger)updateInterval buildingID:(NSString *_Nonnull)buildingID operationQueue: (NSOperationQueue *_Nonnull)operationQueue options:(NSDictionary *_Nullable)options;
Parameters
priority
one of SITLocationPriority
provider
one of SITLocationProvider
updateInterval
The time interval at which location will be uploaded to realtime
buildingID
unique identifier of the building in which you want to locate a user. (This property is mandatory).
operationQueue
the thread where the location updates will be provided. If not provided, the main thread will be used.
options
additional options to modify the internal operation of the Location provider (private usage only).
Return Value
initialized object.
-
Deprecated
Use base constructor instead
Constructor.
Declaration
Objective-C
- (instancetype _Nonnull)initWithPriority:(SITLocationPriority)priority provider:(SITLocationProvider)provider updateInterval:(NSInteger)updateInterval buildingID:(NSString *_Nonnull)buildingID operationQueue: (NSOperationQueue *_Nonnull)operationQueue useDeadReckoning:(BOOL)useDeadReckoning options:(NSDictionary *_Nullable)options;
Parameters
priority
one of SITLocationPriority
provider
one of SITLocationProvider
updateInterval
The time interval at which location will be uploaded to realtime
buildingID
unique identifier of the building in which you want to locate a user. (This property is mandatory).
operationQueue
the thread where the location updates will be provided. If not provided, the main thread will be used.
useDeadReckoning
determines if dead reckoning should be used
options
additional options to modify the internal operation of the Location provider (private usage only).
Return Value
initialized object.