EILIndoorLocationManager Class Reference

Inherits from NSObject
Declared in EILIndoorLocationManager.h
EILIndoorLocationManager.m

Other Methods

  delegate

The delegate object to receive position update events.

@property (nonatomic, weak, nullable) id<EILIndoorLocationManagerDelegate> delegate

Declared In

EILIndoorLocationManager.h

– start

Starts Indoor Location Manager.

- (void)start

Discussion

Starting Indoor Location Manager early allows it to warm-up and later on deliver without delay Indoor Location status change and position updates.

Declared In

EILIndoorLocationManager.h

– stop

Completely stops Indoor Location Manager.

- (void)stop

Discussion

Invoking this method will stop all Indoor Location monitoring and position updates.

Declared In

EILIndoorLocationManager.h

  isRunning

Informs whether Indoor Location Manager is currently running.

@property (nonatomic, assign, readonly) BOOL isRunning

Declared In

EILIndoorLocationManager.h

Indoor Location Monitoring

– startMonitoringForLocation:

Starts monitoring the specified Indoor Location allowing you determine if you are inside or outside monitored location.

- (void)startMonitoringForLocation:(EILLocation *)location

Parameters

location

The Indoor Location object that defines the boundary to monitor. This parameter must not be nil.

Discussion

The current state, i.e., inside/outside, is available on-demand, by calling the stateForLocation: method.

If the Indoor Location Manager is not started this method will start it.

Starting monitoring for Indoor Location early allows position updates to be delivered without delay later on.

Starting monitoring for a location already monitored will do nothing.

Declared In

EILIndoorLocationManager.h

– stopMonitoringForLocation:

Stops monitoring the specified Indoor Location.

- (void)stopMonitoringForLocation:(EILLocation *)location

Parameters

location

The Indoor Location object currently being monitored. This parameter must not be nil. The object you specify need not be the exact same object that you registered, but its identifier or name should be the same.

Declared In

EILIndoorLocationManager.h

  monitoredLocations

The set of all monitored Indoor Locations.

@property (nonatomic, strong, readonly) NSSet<EILLocation*> *monitoredLocations

Declared In

EILIndoorLocationManager.h

– stateForLocation:

Determines state for the monitored location.

- (EILLocationState)stateForLocation:(EILLocation *)location

Parameters

location

An EILLocation object for which state should be determined.

Return Value

State in which the monitored location is.

Discussion

If the location is not monitored EILLocationStateUnknown will be returned.

Declared In

EILIndoorLocationManager.h

– stateForLocationWithIdentifier:

Determines state for the monitored location identified by its identifier.

- (EILLocationState)stateForLocationWithIdentifier:(NSString *)locationIdentifier

Parameters

locationIdentifier

An identifier of the location for which state should be determined.

Return Value

State in which the monitored location is.

Discussion

Each location saved in Estimote Cloud is given a unique string identifier that corresponds to the identifier property of EILLocation. You can find it on cloud.estimote.com, on the “Locations” screen, and use it with the Indoor SDK to, among other things, fetch your stored location from Estimote Cloud.

If the location is not monitored EILLocationStateUnknown will be returned.

Declared In

EILIndoorLocationManager.h

Indoor Location Position Updates

  mode

Mode of EILIndoorLocationManager position updates delivery.

@property (nonatomic, assign) EILIndoorLocationManagerMode mode

Discussion

Default mode of EILIndoorLocationManager is EILIndoorLocationManagerModeNormal.

Switching mode while delivery of position updates is in progress will effectively restart position updates with new mode.

Declared In

EILIndoorLocationManager.h

  provideOrientationForLightMode

Enables providing orientation for position updates in Light mode.

@property (nonatomic, assign) BOOL provideOrientationForLightMode

Discussion

Default value is NO.

If set to YES, for a brief moment after the start of positioning the orientation may be EIL_ORIENTATION_UNDEFINED.

Declared In

EILIndoorLocationManager.h

+ supportedModes

Supported modes (EILIndoorLocationManagerMode) for the device.

+ (NSArray<NSNumber*> *)supportedModes

Return Value

An array of supported modes (EILIndoorLocationManagerMode) encoded as NSNumber * objects.

Declared In

EILIndoorLocationManager.h

– startPositionUpdatesForLocation:

Starts the delivery of position updates for the specified location.

- (void)startPositionUpdatesForLocation:(EILLocation *)location

Parameters

location

The location.

Discussion

If the Indoor Location Manager is not started invoking this method will start it.

Only one location is supported at the same time. Calling this method without previously stopping position updates will have no effect.

Calling this method without calling start startMonitoringForLocation: will result in approximately 6 s delay before first position updates are provided. Starting monitoring earlier will reduce this time by the amount of time monitoring was running.

Declared In

EILIndoorLocationManager.h

– stopPositionUpdates

Stops the delivery of position updates.

- (void)stopPositionUpdates

Declared In

EILIndoorLocationManager.h