ISLocationProvider Class Reference
| Inherits from | NSObject |
|---|---|
| Declared in | ISLocationProvider.h |
Overview
Class used to provide and get user locations.
Warning: When using this class, you will need to tag your implementor as C++ class (*.mm extension OR specific compiler settings).
lastLocation
Last computed location.
@property (nonatomic, readonly) ISLocation *lastLocationDeclared In
ISLocationProvider.h
delegate
Location delegate.
@property (weak) id<ISLocationDelegate> delegateDeclared In
ISLocationProvider.h
isStarted
Boolean used to know if the location provider is started.
@property (nonatomic, readonly) Boolean isStartedDeclared In
ISLocationProvider.h
sessionId
Last location session identifier (-1 if failed, 0 if fake, >0 otherwise).
@property (nonatomic, readonly) int sessionIdDeclared In
ISLocationProvider.h
locationFlags
Current location flags
@property (nonatomic, readonly) int locationFlagsDeclared In
ISLocationProvider.h
renderer
Location Renderer.
@property (nonatomic, readonly) ISLocationRenderer *rendererDeclared In
ISLocationProvider.h
+ getLocationPackageVersion
Static method used to know the current location package version.
+ (int)getLocationPackageVersionReturn Value
Current location package version.
Declared In
ISLocationProvider.h
+ getVersion
Static method used to know the current location library version.
+ (NSString *)getVersionReturn Value
Current location library version.
Declared In
ISLocationProvider.h
+ sharedInstance
Static method used to get the ISLocationProvider shared instance.
+ (instancetype)sharedInstanceReturn Value
The ISLocationProvider shared instance. Could be nil if no user is authenticated.
Declared In
ISLocationProvider.h
– getLbsModule:
Method used to get a lbs module with a specifi type.
- (id)getLbsModule:(ISELbsModuleType)lbsModuleTypeParameters
lbsModuleType |
Lbs module type. |
|---|
Return Value
Return the corresponding lbs module or nil if a needed package is missing.
Declared In
ISLocationProvider.h
– startWithFlags:andDelegate:andScanFrequency:andDefaultMapId:andForceDefaultMap:andLocationPath:andUUIDService:
Method used to start the location with specific configuration.
- (void)startWithFlags:(int)locationFlags andDelegate:(id<ISLocationDelegate>)delegate andScanFrequency:(int)scanFrequency andDefaultMapId:(int)defaultMapId andForceDefaultMap:(Boolean)forceDefaultMap andLocationPath:(NSString *)locationPath andUUIDService:(NSString *)uuidServiceParameters
locationFlags |
Location flags. |
|---|---|
delegate |
Location events delegate. |
scanFrequency |
Location scan frequency. |
defaultMapId |
Default map identifier to use |
forceDefaultMap |
Boolean used to know if we force the default map. |
locationPath |
The location package directory. |
uuidService |
UUID service to scan for (could be nil). |
Declared In
ISLocationProvider.h
– startWithFlags:andDelegate:andScanFrequency:andDefaultMapId:andForceDefaultMap:
Method used to start the location with specific configuration.
- (void)startWithFlags:(int)locationFlags andDelegate:(id<ISLocationDelegate>)delegate andScanFrequency:(int)scanFrequency andDefaultMapId:(int)defaultMapId andForceDefaultMap:(Boolean)forceDefaultMapParameters
locationFlags |
Location flags. |
|---|---|
delegate |
Location events delegate. |
scanFrequency |
Location scan frequency. |
defaultMapId |
Default map identifier to use |
forceDefaultMap |
Boolean used to know if we force the default map. |
Declared In
ISLocationProvider.h
– startWithFlags:andDelegate:andScanFrequency:
Method used to start the location with specific configuration.
- (void)startWithFlags:(int)locationFlags andDelegate:(id<ISLocationDelegate>)delegate andScanFrequency:(int)scanFrequencyParameters
locationFlags |
Location flags. |
|---|---|
delegate |
Location events delegate. |
scanFrequency |
Location scan frequency. |
Declared In
ISLocationProvider.h
– startWithFlags:andDelegate:
Method used to start the location with specific configuration.
- (void)startWithFlags:(int)locationFlags andDelegate:(id<ISLocationDelegate>)delegateParameters
locationFlags |
Location flags. |
|---|---|
delegate |
Location events delegate. |
Declared In
ISLocationProvider.h
– startWithDelegate:
Method used to start the location using a default configuration and flags specified in a .plist file.
- (void)startWithDelegate:(id<ISLocationDelegate>)delegateParameters
delegate |
Location events delegate. |
|---|
Declared In
ISLocationProvider.h
– stopLocation
Method used to stop the location.
- (void)stopLocationDeclared In
ISLocationProvider.h
– changeLocationWithFlags:
Method used to change the location flags.
- (void)changeLocationWithFlags:(int)flagsParameters
flags |
New location flags. |
|---|
Declared In
ISLocationProvider.h
– requestUniqueLocationWithLocationRequestDelegate:andLocationFlags:
Method called to get a one shot location (After a timeout of 10 seconds with no computed location, fail callback is called).
- (ISLocationRequest *)requestUniqueLocationWithLocationRequestDelegate:(id<ISLocationRequestDelegate>)locationRequestDelegate andLocationFlags:(int)locationFlagsParameters
locationRequestDelegate |
Delegate to notify when a location is computed. |
|---|---|
locationFlags |
Location flags to used. |
Return Value
The related location request to identify callers.
Declared In
ISLocationProvider.h
– deleteLogs
Method used to delete the location logs directory.
- (Boolean)deleteLogsReturn Value
YES if the directory was successfuly deleted, otherwise NO.
Discussion
Warning: The ISLocationProvider needs to be stopped before calling this method.
Declared In
ISLocationProvider.h