Main class of the Navionics Mobile Services and is the entry point for all the available services. More...
#import <NavionicsMobileServices.h>
Class Methods | |
| (BOOL) | + initializeWithSettings:error: |
| Initialize the SDK accordingly with the settings. More... | |
| (void) | + shutDown |
| Shutdown the SDK. Reset all the previous initialization settings. After the shutdown the SDK needs to be initialized again. More... | |
| (BOOL) | + geoObjectsAtPoint: |
Retrieve cartographic objects in a given map view point. The results will be provided using the NSMGeoObjectResultsDelegate protocol. More... | |
| (BOOL) | + searchGeoObjectsByName: |
Search cartographic object by name. The results will be provided using the NSMGeoObjectResultsDelegate protocol. More... | |
| (BOOL) | + searchGeoObjectsByCategory: |
Search cartographic object by category. The results will be provided using the NSMGeoObjectResultsDelegate protocol. More... | |
| (BOOL) | + setGeoObjectsResultsDelegate: |
Set the object that implements NSMGeoObjectResultsDelegate protocol. This delegate will receive the results of cartographic objects retrieving APIs. More... | |
| (void) | + navionicsUser |
| Enable the login UI. If the user is already logged shown the user details. More... | |
| (BOOL) | + isNavionicsUserLoggedIn |
| Check User login status. More... | |
| (BOOL) | + enableDownloadAreaSelector |
| Enable the manual download UI on the map. The download UI will appear only on the active map (if any). More... | |
| (BOOL) | + disableDownloadAreaSelectorAndConfirm: |
| Disable the manual download UI on the map and confim of cancel the download. The download UI will disappear. The download procedure for the selected area will start only if the download confirmation flag is YES. More... | |
| (BOOL) | + enableGPSServices |
| Enable the GPS Services. The framework needs location update as required background modes. More... | |
| (BOOL) | + disableGPSServices |
| Disable the GPS Services. The framework needs location update as required background modes. More... | |
| (NSString *) | + version |
| Framework version. More... | |
Detailed Description
Main class of the Navionics Mobile Services and is the entry point for all the available services.
Definition at line 19 of file NavionicsMobileServices.h.
Method Documentation
◆ disableDownloadAreaSelectorAndConfirm:()
| + (BOOL) disableDownloadAreaSelectorAndConfirm: | (BOOL) | confirmDownload |
Disable the manual download UI on the map and confim of cancel the download. The download UI will disappear. The download procedure for the selected area will start only if the download confirmation flag is YES.
- Parameters
-
confirmDownload The download confirmation flag
- Returns
- YES if is possible to disable the download UI on an active map.
◆ disableGPSServices()
| + (BOOL) disableGPSServices |
Disable the GPS Services. The framework needs location update as required background modes.
- Returns
- YES if GPS services has been disabled.
◆ enableDownloadAreaSelector()
| + (BOOL) enableDownloadAreaSelector |
Enable the manual download UI on the map. The download UI will appear only on the active map (if any).
- Returns
- YES if is possible to enable the download UI on an active map.
◆ enableGPSServices()
| + (BOOL) enableGPSServices |
Enable the GPS Services. The framework needs location update as required background modes.
- Returns
- YES if GPS services has been enabled (the app has the user authorization).
◆ geoObjectsAtPoint:()
| + (BOOL) geoObjectsAtPoint: | (CGPoint) | point |
Retrieve cartographic objects in a given map view point. The results will be provided using the NSMGeoObjectResultsDelegate protocol.
- Parameters
-
point The map view point
- Returns
- YES if the functionality is available
◆ initializeWithSettings:error:()
| + (BOOL) initializeWithSettings: | (NMSSettings *) | settings | |
| error: | (NSError **) | error | |
Initialize the SDK accordingly with the settings.
- Parameters
-
settings The input SDK settings
- Returns
- YES if the SDK has been initialized succesfully.
◆ isNavionicsUserLoggedIn()
| + (BOOL) isNavionicsUserLoggedIn |
Check User login status.
- Returns
- YES if the user is logged in.
◆ navionicsUser()
| + (void) navionicsUser |
Enable the login UI. If the user is already logged shown the user details.
◆ searchGeoObjectsByCategory:()
| + (BOOL) searchGeoObjectsByCategory: | (NMSSearchCategory) | category |
Search cartographic object by category. The results will be provided using the NSMGeoObjectResultsDelegate protocol.
- Parameters
-
category The category of the objects to search
- Returns
- YES if the functionality is available
◆ searchGeoObjectsByName:()
| + (BOOL) searchGeoObjectsByName: | (NSString *) | name |
Search cartographic object by name. The results will be provided using the NSMGeoObjectResultsDelegate protocol.
- Parameters
-
name string to search
- Returns
- YES if the functionality is available
◆ setGeoObjectsResultsDelegate:()
| + (BOOL) setGeoObjectsResultsDelegate: | (id< NMSGeoObjectResultsDelegate >) | delegate |
Set the object that implements NSMGeoObjectResultsDelegate protocol. This delegate will receive the results of cartographic objects retrieving APIs.
- Parameters
-
delegate The delegate
- Returns
- YES if the delegate has been set succesfully.
◆ shutDown()
| + (void) shutDown |
Shutdown the SDK. Reset all the previous initialization settings. After the shutdown the SDK needs to be initialized again.
◆ version()
| + (NSString*) version |
Framework version.
- Returns
- The framework version string.
The documentation for this class was generated from the following file:
- /Users/jenkins/workspace/mobilesdk-ios/iOS/Deployment/NavionicsMobileSDK.framework/Headers/NavionicsMobileServices.h