Provides methods which facilitate usage of offline map data capabilities. Some calls made to SYMapLoader are asynchronous and return results through the SYMapLoaderDelegate protocol.
More...
#import <SYMapLoader.h>
Provides methods which facilitate usage of offline map data capabilities. Some calls made to SYMapLoader are asynchronous and return results through the SYMapLoaderDelegate protocol.
◆ checkForUpdatesWithCompletion:()
| - (nonnull SYTask*) checkForUpdatesWithCompletion: |
|
(nonnull SYMapLoaderMapArrayCompletionBlock) |
completion |
|
Checks for map updates.
- Parameters
-
| completion | block is called with the check result and list of ISO codes, representing the maps for which an update is available. |
- Returns
- SYTask cancelation object
◆ convertLoaderResult:()
| + (SYMapLoaderResult) convertLoaderResult: |
|
(const sygm_maploader_result_e) |
result |
|
|
implementation |
◆ convertLoaderStatus:()
| + (SYMapLoaderMapStatus) convertLoaderStatus: |
|
(const sygm_maploader_map_status_e) |
status |
|
|
implementation |
◆ detectCurrentCountry:withCompletion:()
| - (nonnull SYTask*) detectCurrentCountry: |
|
(nullable NSString *) |
country |
| withCompletion: |
|
(nonnull SYMapLoaderOneMapCompletionBlock) |
completion |
|
|
| |
Detects the country of current location.
- Parameters
-
| country | Optional identifier of the country (e.g. "SVK"), pass an empty string in case no identifier should be used. |
| completion | block is called after the detection process finishes, called with ISO code of the detected country. |
- Returns
- SYTask cancelation object
◆ getAvailableCountries:withCompletion:()
| - (nonnull SYTask*) getAvailableCountries: |
|
(SYMapLoaderMapFilter) |
filter |
| withCompletion: |
|
(nonnull SYMapLoaderMapArrayCompletionBlock) |
completion |
|
|
| |
Fetches available maps matching the requested filter. When finished, it calls the callback with the list of available map ISO codes.
- Parameters
-
| filter | SYMapLoaderMapFilterAll - includes already installed maps and maps available for download SYMapLoaderMapFilterInstalled - includes only already installed maps |
| completion | block used as a callback for this function |
- Returns
- SYTask cancelation object
◆ getCountryDetails:installedOnly:withResult:()
| - (nullable SYCountryDetails*) getCountryDetails: |
|
(nonnull SYCountryIso *) |
map |
| installedOnly: |
|
(BOOL) |
installed |
| withResult: |
|
(nonnull SYMapLoaderResult *) |
result |
|
|
| |
Fetch details about a country.
- Parameters
-
| map | ISO code of the requested country. |
| result | Pointer to SYMapLoaderResult struct, where the operation result will be stored |
- Returns
- SYCountryDetails value of country details
◆ getMapStatus:()
| - (SYMapLoaderMapStatus) getMapStatus: |
|
(nonnull SYCountryIso *) |
map |
|
Fetches the status of requested map(country or region).
- Parameters
-
- Returns
- SYMapLoaderMapStatus enum value.
◆ getRegionDetails:installedOnly:withResult:()
| - (nullable SYRegionDetails*) getRegionDetails: |
|
(nonnull SYCountryIso *) |
map |
| installedOnly: |
|
(BOOL) |
installed |
| withResult: |
|
(nonnull SYMapLoaderResult *) |
result |
|
|
| |
Fetch details about a country region.
- Parameters
-
| map | ISO code of the requested region. |
| result | Pointer to SYMapLoaderResult struct, where the operation result will be stored |
- Returns
- SYRegionDetails value of region details
◆ installMap:withCompletion:()
| - (nonnull SYTask*) installMap: |
|
(nonnull SYCountryIso *) |
map |
| withCompletion: |
|
(nonnull SYMapLoaderOneMapCompletionBlock) |
completion |
|
|
| |
Downloads and installs the requested map. If the installation progress should be reported, use the "maploader_register_on_progress_callback" function to register it.
- Parameters
-
| map | ISO code of map to be downloaded and installed. |
| completion | block is called after the installation finishes, called with ISO code and installation result |
- Returns
- SYTask cancelation object
◆ loadMap:()
| - (SYMapLoaderResult) loadMap: |
|
(nonnull SYCountryIso *) |
map |
|
Loads installed map(country or region).
- Parameters
-
| map | ISO code of the map to be loaded. |
- Returns
- SYMapLoaderResult value indicating whether the load was successful
◆ resumePendingInstallations()
| - (void) resumePendingInstallations |
|
|
|
Resumes all pending map installations. If the installation progress should be reported, use the "maploader_register_on_progress_callback" function to register it. If the notification about finished installation is needed, use the "maploader_register_on_resumed_install_done_callback" function to register it.
◆ stringFromUtf8:()
| + (nonnull NSString*) stringFromUtf8: |
|
(nonnull const sygm_iso_t) |
iso |
|
|
implementation |
◆ uninstallMap:withCompletion:()
| - (nonnull SYTask*) uninstallMap: |
|
(nonnull SYCountryIso *) |
map |
| withCompletion: |
|
(nonnull SYMapLoaderOneMapCompletionBlock) |
completion |
|
|
| |
Uninstalls the requested map.
- Parameters
-
| map | ISO code of map to be uninstalled. |
| completion | block is called after the completion of the uninstall process. Called with map ISO code and uninstall result. |
- Returns
- SYTask cancelation object
◆ unloadMap:()
| - (SYMapLoaderResult) unloadMap: |
|
(nonnull SYCountryIso *) |
map |
|
Unloads loaded map.
- Parameters
-
| map | ISO code of the map to be unloaded. |
- Returns
- maploader_result_e value indicating whether the unload was successful
◆ updateMap:withCompletion:()
| - (nonnull SYTask*) updateMap: |
|
(nonnull SYCountryIso *) |
map |
| withCompletion: |
|
(nonnull SYMapLoaderOneMapCompletionBlock) |
completion |
|
|
| |
Updates map with given ISO code. If the update progress should be reported, use the "maploader_register_on_progress_callback" function to register it.
- Parameters
-
| map | ISO code of map, for which an update should be performed. |
| completion | block is called after the update is complete, called with ISO code of the map and status. |
- Returns
- SYTask cancelation object
◆ delegate
The documentation for this class was generated from the following file:
1.8.16 