SITLocationRequest Class Reference

Inherits from NSObject
Declared in SITLocationRequest.h

Overview

A data object that contains parameters for the location service (SITLocationManager)

  priority

One of SITLocationPriority (coming soon).

@property (nonatomic, readwrite) SITLocationPriority priority

Declared In

SITLocationRequest.h

  provider

One of SITLocationProvider (coming soon).

@property (nonatomic, readwrite) SITLocationProvider provider

Declared In

SITLocationRequest.h

  updateInterval

The time interval at which location will be delivered, default is 1 second (coming soon).

@property (nonatomic, readwrite) NSInteger updateInterval

Declared In

SITLocationRequest.h

  useDeadReckoning

(EXPERIMENTAL) Set if you want to use dead reckoning to get fast position updates using only the inertial sensors, between the server position updates.

@property (nonatomic, readwrite) BOOL useDeadReckoning

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

– 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

– setUseDeadReckoning:

Setter.

- (void)setUseDeadReckoning:(BOOL)useDeadReckoning

Parameters

useDeadReckoning

Boolean value indicating if deadReckoning should be used.

Declared In

SITLocationRequest.h

– setUpdateInterval:

Setter.

- (void)setUpdateInterval:(NSInteger)updateInterval

Parameters

updateInterval

Boolean value indicating how often the position should be upload to realtime.

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 delivered

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 delivered

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