HERE iOS SDK Developer's Guide

<NMAMapLoaderDelegate>

Protocol Summary

protocol <NMAMapLoaderDelegate>

Derived from: <NSObject>

The NMAMapLoaderDelegate responds to callback messages sent by the NMAMapLoader.

Include: NMAKit.framework/headers/NMAMapLoader.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for <NMAMapLoaderDelegate> – <NMAMapLoaderDelegate>

[For complete information, see the section Protocol Details]

Instance Method Summary

Table 1. Instance Methods
Instance Method Summary

- @optional (void) mapLoader:(nonnull NMAMapLoader *) mapLoader didFindUpdate:(BOOL) updateIsAvailable fromVersion:(nonnull NSString *) currentMapVersion toVersion:(nonnull NSString *) newestMapVersion withResult:( NMAMapLoaderResult ) mapLoaderResult

Callback associated with the NMAMapLoader checkForMapDataUpdate method call

- @optional (void) mapLoader:(nonnull NMAMapLoader *) mapLoader didGetMapPackage:(nullable NMAMapPackage *) package atGeoCoordinates:(nonnull NMAGeoCoordinates *) coordinates withResult:( NMAMapLoaderResult ) mapLoaderResult

Callback associated with the NMAMapLoader getMapPackageAtCoordinates: method

- @optional (void) mapLoader:(nonnull NMAMapLoader *) mapLoader didGetPackagesWithResult:( NMAMapLoaderResult ) mapLoaderResult

Callback associated with the NMAMapLoader getMapPackages method call

- @optional (void) mapLoader:(nonnull NMAMapLoader *) mapLoader didGetUpdateSize:(NSUInteger) size withResult:( NMAMapLoaderResult ) mapLoaderResult

Callback associated with the NMAMapLoader getMapDataUpdateSize method

- @optional (void) mapLoader:(nonnull NMAMapLoader *) mapLoader didInstallPackagesWithResult:( NMAMapLoaderResult ) mapLoaderResult

Callback associated with the NMAMapLoader installMapPackages method call

- @optional (void) mapLoader:(nonnull NMAMapLoader *) mapLoader didUninstallPackagesWithResult:( NMAMapLoaderResult ) mapLoaderResult

Callback associated with the NMAMapLoader uninstallMapPackages method call

- @optional (void) mapLoader:(nonnull NMAMapLoader *) mapLoader didUpdateProgress:(float) progress

Called during certain NMAMapLoader operations to indicate the current progress of that operation

- @optional (void) mapLoader:(nonnull NMAMapLoader *) mapLoader didUpdateWithResult:( NMAMapLoaderResult ) mapLoaderResult

Callback associated with the NMAMapLoader performMapDataUpdate method call

- @optional (void) mapLoaderDidFindConnection:(nonnull NMAMapLoader *) mapLoader

Callback sent when the NMAMapLoader reestablishes its connection to the data server

- @optional (void) mapLoaderDidLoseConnection:(nonnull NMAMapLoader *) mapLoader

Callback sent when the NMAMapLoader loses its server connection during an operation

Protocol Details

The NMAMapLoaderDelegate responds to callback messages sent by the NMAMapLoader. The callbacks correspond to specific map loader functionality. Only one delegate may be installed on the map loader at a time, using the setDelegate method.

Note:

Methods of this protocol will be called on the main queue.

Instance Method Details

- @optional (void) mapLoader:(nonnull NMAMapLoader *) mapLoader didFindUpdate:(BOOL) updateIsAvailable fromVersion:(nonnull NSString *) currentMapVersion toVersion:(nonnull NSString *) newestMapVersion withResult:( NMAMapLoaderResult ) mapLoaderResult

Callback associated with the NMAMapLoader checkForMapDataUpdate method call.

Parameters:

  • mapLoader

    The NMAMapLoader (singleton) instance sending the callback.

  • updateIsAvailable

    True if an update is available, false otherwise.

  • currentMapVersion

    Representation of the current map data version in the form "Major.Minor.Feature.Build" where each section is an unsigned integer.

  • newestMapVersion

    Representation of the newest map data version in the form "Major.Minor.Feature.Build" where each section is an unsigned integer.

  • mapLoaderResult

    TheNMAMapLoaderResult for this operation.

- @optional (void) mapLoader:(nonnull NMAMapLoader *) mapLoader didGetMapPackage:(nullable NMAMapPackage *) package atGeoCoordinates:(nonnull NMAGeoCoordinates *) coordinates withResult:( NMAMapLoaderResult ) mapLoaderResult

Callback associated with the NMAMapLoader getMapPackageAtCoordinates: method.

Parameters:

  • mapLoader

    The NMAMapLoader (singleton) instance sending the callback.

  • package

    The smallest package containing the specified NMAGeoCoordinates that could be found, or nil if a package could not be found.

  • coordinates

    The coordinates used to locate the package.

  • mapLoaderResult

    TheNMAMapLoaderResult of the operation.

- @optional (void) mapLoader:(nonnull NMAMapLoader *) mapLoader didGetPackagesWithResult:( NMAMapLoaderResult ) mapLoaderResult

Callback associated with the NMAMapLoader getMapPackages method call.

Parameters:

- @optional (void) mapLoader:(nonnull NMAMapLoader *) mapLoader didGetUpdateSize:(NSUInteger) size withResult:( NMAMapLoaderResult ) mapLoaderResult

Callback associated with the NMAMapLoader getMapDataUpdateSize method.

Parameters:

  • mapLoader

    The NMAMapLoader (singleton) instance sending the callback.

  • size

    The size of the map data update to the latest map data version in KB, or 0 if an update is not available.

  • mapLoaderResult

    TheNMAMapLoaderResult of the operation.

- @optional (void) mapLoader:(nonnull NMAMapLoader *) mapLoader didInstallPackagesWithResult:( NMAMapLoaderResult ) mapLoaderResult

Callback associated with the NMAMapLoader installMapPackages method call.

Parameters:

- @optional (void) mapLoader:(nonnull NMAMapLoader *) mapLoader didUninstallPackagesWithResult:( NMAMapLoaderResult ) mapLoaderResult

Callback associated with the NMAMapLoader uninstallMapPackages method call.

Parameters:

- @optional (void) mapLoader:(nonnull NMAMapLoader *) mapLoader didUpdateProgress:(float) progress

Called during certain NMAMapLoader operations to indicate the current progress of that operation.

Parameters:

  • mapLoader

    The NMAMapLoader (singleton) instance sending the callback.

  • progress

    The progress of the current operation from 0.0 (beginning) to 1.0 (complete).

- @optional (void) mapLoader:(nonnull NMAMapLoader *) mapLoader didUpdateWithResult:( NMAMapLoaderResult ) mapLoaderResult

Callback associated with the NMAMapLoader performMapDataUpdate method call.

Parameters:

  • mapLoader

    The NMAMapLoader (singleton) instance sending the callback.

  • mapLoaderResult

    TheNMAMapLoaderResult for this operation.

- @optional (void) mapLoaderDidFindConnection:(nonnull NMAMapLoader *) mapLoader

Callback sent when the NMAMapLoader reestablishes its connection to the data server.

The current operation will be automatically resumed.

- @optional (void) mapLoaderDidLoseConnection:(nonnull NMAMapLoader *) mapLoader

Callback sent when the NMAMapLoader loses its server connection during an operation.

If a map loader operation is interrupted by a loss of connection, it will automatically be resumed when the connection is restored. This callback is sent to give the client application or end user the option to cancel the current operation instead of waiting.