IALocationManager Class Reference
Inherits from | NSObject |
---|---|
Declared in | IALocationManager.h |
Overview
The IALocationManager class is central point for configuring the delivery of indoor location related events to your app. You use and instance of this class to establish the parameters that determine when location events should be delivered and to start and stop the actual delivery of those events. You can also use a location manager object to retrieve the most recent location data.
Other Methods
calibration
The latest calibration quality value
@property (nonatomic, readonly) enum ia_calibration calibration
Declared In
IALocationManager.h
location
The latest location update.
@property (nonatomic, readwrite, nullable) IALocation *location
Discussion
This property can be set for a custom location.
Declared In
IALocationManager.h
attitude
The latest sample of device attitude.
@property (nonatomic, readwrite, nullable) IAAttitude *attitude
Declared In
IALocationManager.h
heading
The latest sample of device heading.
@property (nonatomic, readwrite, nullable) IAHeading *heading
Declared In
IALocationManager.h
distanceFilter
The minimum distance measured in meters that the device must move horizontally before an update event is generated. Default value is 0.7 meters. Uses CoreLocation CLLocationDistance.
@property (assign, nonatomic) CLLocationDistance distanceFilter
Declared In
IALocationManager.h
headingFilter
The minimum angular change in degrees required to generate new didUpdateHeading event. Default value is 1 degree.
@property (assign, nonatomic) CLLocationDegrees headingFilter
Declared In
IALocationManager.h
attitudeFilter
The minimum angular change in degrees required to generate new didUpdateAttitude event. Default value is 1 degree.
@property (assign, nonatomic) CLLocationDegrees attitudeFilter
Declared In
IALocationManager.h
extraInfo
The latest extra information dictionary.
@property (nonatomic, readonly, nullable) NSDictionary *extraInfo
Discussion
Used for debugging positioning.
Declared In
IALocationManager.h
Accessing the Delegate
delegate
The delegate object to receive update events.
@property (nullable, nonatomic, readwrite, weak) id<IALocationManagerDelegate> delegate
Declared In
IALocationManager.h
SDK version
+ versionString
Returns SDK version string.
+ (nonnull NSString *)versionString
Discussion
The version string returned is in format “major.minor.patch”. (see: Semantic Versioning)
Declared In
IALocationManager.h
+ sharedInstance
Returns the shared IALocationManager instance.
+ (nonnull IALocationManager *)sharedInstance
Declared In
IALocationManager.h
Authenticate your session
– setApiKey:andSecret:
Set IndoorAtlas API key and secret for authentication.
- (void)setApiKey:(nonnull NSString *)key andSecret:(nonnull NSString *)secret
Parameters
key |
API key used for authentication. |
---|---|
secret |
API secret used for authentication. |
Discussion
This method must be called before further requests with server requiring authentication.
Declared In
IALocationManager.h
– startUpdatingLocation
Starts the generation of updates that report the user’s current location.
- (void)startUpdatingLocation
Discussion
This method returns immediately. Calling this method causes the location manager to obtain an initial location fix (which may take several seconds) and notify your delegate by calling its <indoorLocationManager:didUpdateLocations:> method. After that, the receiver generates update events whenever there is new estimate.
Calling this method several times in succession does not automatically result in new events being generated. Calling stopUpdatingLocation in between, however, does cause a new initial event to be sent the next time you call this method.
If you start this service and your app is suspended, the system stops the delivery of events until your app starts running again (only in foreground). If your app is terminated, the delivery of new location events stops altogether.
Declared In
IALocationManager.h
– stopUpdatingLocation
Stops the generation of location updates.
- (void)stopUpdatingLocation
Discussion
Call this method whenever your code no longer needs to receive location-related events. Disabling event delivery gives the receiver the option of disabling the appropriate hardware (and thereby saving power) when no clients need location data. You can always restart the generation of location updates by calling the startUpdatingLocation method again.
Declared In
IALocationManager.h