SITLocationRequest Class Reference
Inherits from | NSObject |
---|---|
Conforms to | NSCopying |
Declared in | SITLocationRequest.h |
priority
One of SITLocationPriority (coming soon).
@property (nonatomic, readwrite) SITLocationPriority priority
Declared In
SITLocationRequest.h
provider
One of SITLocationProvider (coming soon).
@property (nonatomic, readwrite) DEPRECATED_MSG_ATTRIBUTE ( "Location provider is no longer selectable. Provider will always be kSITInPhoneProvider" ) SITLocationProvider provider
Declared In
SITLocationRequest.h
updateInterval
The time interval indicating how often the position should be uploaded to realtime. Deprecated, use realtimeUpdateInterval instead.
@property (nonatomic, readwrite) DEPRECATED_MSG_ATTRIBUTE ( "Use realtimeUpdateInterval instead" ) NSInteger updateInterval
Declared In
SITLocationRequest.h
realtimeUpdateInterval
The time interval indicating how often the position should be uploaded to realtime.
@property (nonatomic, readonly) SITRealtimeUpdateInterval realtimeUpdateInterval
Declared In
SITLocationRequest.h
useDeadReckoning
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.
@property (nonatomic, readwrite) BOOL useDeadReckoning
Declared In
SITLocationRequest.h
useGps
Set if you want to use Gps for positioning indoor.
@property (nonatomic, readwrite) BOOL useGps
Declared In
SITLocationRequest.h
buildingID
Unique identifier of the building in which you want to locate a user. (This property is mandatory).
@property (nonatomic, strong) NSString *buildingID
Declared In
SITLocationRequest.h
operationQueue
The thread where the location updates will be provided. If not provided, the main thread will be used.
@property (nonatomic, strong) NSOperationQueue *operationQueue
Declared In
SITLocationRequest.h
options
Additional options to modify the internal operation of the Location provider (private usage only).
@property (nonatomic, strong) NSDictionary *options
Declared In
SITLocationRequest.h
beaconFilters
Custom UUIDs. The system will scan beacons with those uuids
@property (nonatomic, strong) NSArray<SITBeaconFilter*> *beaconFilters
Declared In
SITLocationRequest.h
interval
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.
@property (nonatomic) int interval
Declared In
SITLocationRequest.h
smallestDisplacement
Minimum displacement between location updates
@property (nonatomic) float smallestDisplacement
Declared In
SITLocationRequest.h
useBarometer
Set if you want to use barometer data for positioning.
@property (nonatomic, readwrite) BOOL useBarometer
Declared In
SITLocationRequest.h
– initWithBuildingId:
Constructor.
- (instancetype)initWithBuildingId:(NSString *)buildingId
Parameters
buildingId |
Unique identifier of the building in which you want to locate a user. |
---|
Return Value
Initialized SITLocationRequest object.
Declared In
SITLocationRequest.h
– setUseGps:
Setter.
- (void)setUseGps:(BOOL)useGps
Parameters
useGps |
Boolean value indicating if gps positioning should be used. |
---|
Declared In
SITLocationRequest.h
– setUpdateInterval:
Setter.
- (void)setUpdateInterval:(NSInteger)updateInterval
Parameters
updateInterval |
Integer value indicating how often the position should be upload to realtime. Deprecated, use setRealtimeUpdateInterval instead. |
---|
Declared In
SITLocationRequest.h
– setRealtimeUpdateInterval:
Setter.
- (void)setRealtimeUpdateInterval:(SITRealtimeUpdateInterval)realtimeUpdateInterval
Parameters
realtimeUpdateInterval |
SITRealtimeUpdateInterval value indicating how often the position should be upload to realtime. |
---|
Declared In
SITLocationRequest.h
– setInterval:
Setter. This parameter is incompatible with dead reckoning. If set, dead reckoning will be deactivated for this request.
- (void)setInterval:(int)interval
Parameters
interval |
Integer value (in milliseconds) with the desired time interval for location updates. |
---|
Declared In
SITLocationRequest.h
– setSmallestDisplacement:
Setter. This parameter is incompatible with dead reckoning. If set, dead reckoning will be deactivated for this request.
- (void)setSmallestDisplacement:(float)displacement
Parameters
smallestDisplacement |
Float value (in meters) with the minimum displacement between location updates. |
---|
Discussion
Keep in mind that if you set a custom value for {@link #interval(int)} you may not receive updates at the desired interval if the other condition isn’t met.
If this value is set the Dead Reckoning will be disabled
Declared In
SITLocationRequest.h
– setUseBarometer:
Setter.
- (void)setUseBarometer:(BOOL)useBarometer
Parameters
useBarometer |
Boolean value indicating if barometer should be used for positioning. |
---|
Declared In
SITLocationRequest.h
– initWithPriority:provider:updateInterval:buildingID:operationQueue:options:
Constructor.
- (instancetype)initWithPriority:(SITLocationPriority)priority provider:(SITLocationProvider)provider updateInterval:(NSInteger)updateInterval buildingID:(NSString *)buildingID operationQueue:(NSOperationQueue *)operationQueue options:(NSDictionary *)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.
Declared In
SITLocationRequest.h
– initWithPriority:provider:updateInterval:buildingID:operationQueue:useDeadReckoning:options:
Constructor.
- (instancetype)initWithPriority:(SITLocationPriority)priority provider:(SITLocationProvider)provider updateInterval:(NSInteger)updateInterval buildingID:(NSString *)buildingID operationQueue:(NSOperationQueue *)operationQueue useDeadReckoning:(BOOL)useDeadReckoning options:(NSDictionary *)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.
Declared In
SITLocationRequest.h
– isValid
Check if the request is valid.
- (BOOL)isValid
Return Value
BOOL value that indicates if the request is valid (YES) or not (NO).
Declared In
SITLocationRequest.h