data-management:onboard-nds-store/com.tomtom.sdk.datamanagement.nds/NdsStore

NdsStore

class NdsStore : DataStore, Disposable

Implementation of a DataStore which is based on an onboard NDS map.

Important: This is a Public Preview API. It may be changed or removed at any time.

Types

object Companion

Functions

addOnAutomaticUpdateFailureListener

fun addOnAutomaticUpdateFailureListener(listener: (error: UpdateErrorCode) -> Unit)

Adds listener that is called when an automatic update fails due to an irrecoverable error.

addOnUpdateListener

fun addOnUpdateListener(listener: () -> Unit)

Adds listener that is called when a region is successfully updated with new content.

addRegionGraphListener

fun addRegionGraphListener(listener: (regionGraphOrError: Result<RegionGraph, UpdateErrorCode>) -> Unit)

Add listener for the information about the state of the map.

open override fun dispose()

removeOnAutomaticUpdateFailureListener

fun removeOnAutomaticUpdateFailureListener(listener: (error: UpdateErrorCode) -> Unit): Boolean

Removes previously registered listener.

removeOnUpdateListener

fun removeOnUpdateListener(listener: () -> Unit): Boolean

Removes previously registered listener.

removeRegionGraphListener

fun removeRegionGraphListener(listener: (regionGraphOrError: Result<RegionGraph, UpdateErrorCode>) -> Unit)

Removes the given listener.

fun setActiveRoute(polyline: List<GeoCoordinate>)

Sets the active route.

fun setPosition(position: GeoCoordinate)

Sets current position.

setUpdatesEnabled

fun setUpdatesEnabled(enabled: Boolean)

Enables or disables map updates.

Properties

open override val storeAccess: NdsStoreAccess

val sync: NdsStoreAccessSync