Package-level declarations

Module for updating NDS maps.

The NDS map is stored locally on the device and it is updated with new map data through an internet connection. The main features of this module include:

  • Keeping the map up-to-date automatically based on the position and/or active route.

  • Providing APIs to build a manual map management user interface.

  • Automatically limiting storage usage and expensive connection usage.

Instantiate the NdsStoreUpdater component using NdsStoreUpdaterConfiguration to (automatically) update the map.

Types

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
fun interface AutomaticMapUpdateFailureListener

Listener for errors in the automatic map update process.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
class CompletedMapOperation

The information about a completed map operation.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
class CurrentMapOperation

The information about the current map operation.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
value class InstallState

The install state of a RegionGraphNode.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
class MapOperation(val type: MapOperationType, val nodeId: RegionGraphNodeId)

Represents an operation on the onboard map.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
value class MapOperationType

Represents an operation that can be performed on an updatable map region.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
interface MapUpdateAvailabilityCheckListener

Listener for map update availability checks on the update server.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
abstract class MapUpdateError

Errors that can be reported from NdsStoreUpdater.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
class NdsStoreUpdater : NdsMapUpdater, AutoCloseable

Implementation of an NDS data store updater.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
class NdsStoreUpdaterConfiguration

Configuration of updates of the NdsStoreUpdater.

Link copied to clipboard
class NetworkConnectivityConfiguration(val regionAgeForMeteredConnections: Duration)

Configuration of the network connectivity for the NdsStoreUpdaterConfiguration.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
class RegionGraph

Hierarchical map structure. Leaf nodes represent updatable regions.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
interface RegionGraphListener

Listener for changes to the NDS map state. The map state is represented as a graph of regions.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
class RegionGraphNode

A node in the RegionGraph. It represents a region in the NDS map. It may be updatable.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
class RegionGraphNodeId

Unique region graph node identifier.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
class RegionGraphNodeState

The state of a node in the RegionGraph for which RegionGraphNode.isUpdatableRegion is 'true'.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
class RegionsAlongPolyline(val nodeIds: List<RegionGraphNodeId>)

A list of regions along a polyline.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
class RegionsAroundPosition(val nodeIds: List<RegionGraphNodeId>)

A list of regions around a position.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
class UpdateInfo

The information about an update.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
value class UpdateState

The Update state of a RegionGraphNode.