com.tomtom.sdk.datamanagement:data-store/com.tomtom.sdk.datamanagement.nds

Package-level declarations

Types

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

Functor called by the client to signal it has stopped using the map.

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

A failure that occurs when the required NDS map is not available or inaccessible for some reason.

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

NDS map context consisting of an NdsStore and, optionally, an associated NdsMapUpdater to enable map updates.

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

Interface for updating NDS map data.

Link copied to clipboard
abstract class NdsStore : StoreAccessProvider, UpdatableDataStore

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

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

An abstract class defining the permit required for accessing the onboard NDS store. This class cannot be directly instantiated and requires a specific type of permit. Example:

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

Synchronizes access to an onboard NDS map.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
class NdsStoreConfiguration(var ndsStorePath: File, var keystorePath: File? = null, var accessPermit: NdsStoreAccessPermit? = null, var geopoliticalView: String? = null)

Configuration parameters for an NdsStore.

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

A failure inside the NDS data store.

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

Interface for components that rely on the onboard map. It is used to synchronise access/unavailability states for map files.

Functions

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
fun NdsStore(context: Context, ndsStorePath: File, apiKey: String, geopoliticalView: String = DEFAULT_GEOPOLITICAL_VIEW, init: NdsStoreConfiguration.() -> Unit = {}): NdsStore

Creates an instance of NdsStore with the default NdsStoreUpdateConfiguration. NdsStoreUpdateConfiguration.apiKey is set to the given apiKey. The paths NdsStoreUpdateConfiguration.updateStoragePath and NdsStoreUpdateConfiguration.persistentStoragePath are taken from the given context. The paths are inside the application's external files directory, or the files directory if the external files directory is not available.