com.tomtom.sdk:onboard-nds-store/com.tomtom.sdk.datamanagement.nds/NdsStoreUpdateConfig

NdsStoreUpdateConfig

class NdsStoreUpdateConfig(val updateStoragePath: File, val persistentStoragePath: File, val updateServerUri: Uri? = null, val updateServerApiKey: String? = null, val automaticUpdatesConfiguration: NdsStoreUpdateConfig.AutomaticUpdatesConfiguration = AutomaticUpdatesConfiguration( allRegionsEnabled = false, relevantRegionsEnabled = false, relevantRegionsRadius = Distance.ZERO, relevantRegionsUpdateInterval = Duration.ZERO, regionsAlongRouteEnabled = false, regionsAlongRouteRadius = Distance.ZERO ))

Configuration of updates of the NdsStore.

Parameters

updateStoragePath

The local path to the update packages directory. The directory provided must be writable. After a successful update of an update region, all update files for that update region are deleted.

Free disk space is required to download and install updates, and to perform optimizations on the map. If not enough space is available to download and install, then nothing is downloaded.

In some cases, the MapUpdate logic may determine that the update storage and the map are on different disks, when they are in fact not. This may result in a download that fills up the extra space required for installation. In that case, the download will succeed, but the install will fail. This can happen on Android, for example, where the internal SD card is part of the main filesystem.

persistentStoragePath

: File, The path to the persistent directory for map updates. For some functionality (e.g. recovery from unexpected failures) data may have to be persisted at this location.

updateServerUri

: Uri, The URI of the server to download updates from. Defaults to the TomTom production update server.

updateServerApiKey

The API key used for requests to the map updates server that was specified in updateServerUri. If not specified, the key parameter will not be present in requests.

automaticUpdatesConfiguration

Configuration of automatic updates parameters

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

Constructors

NdsStoreUpdateConfig

constructor(updateStoragePath: File, persistentStoragePath: File, updateServerUri: Uri? = null, updateServerApiKey: String? = null, automaticUpdatesConfiguration: NdsStoreUpdateConfig.AutomaticUpdatesConfiguration = AutomaticUpdatesConfiguration( allRegionsEnabled = false, relevantRegionsEnabled = false, relevantRegionsRadius = Distance.ZERO, relevantRegionsUpdateInterval = Duration.ZERO, regionsAlongRouteEnabled = false, regionsAlongRouteRadius = Distance.ZERO ))

Types

AutomaticUpdatesConfiguration

class AutomaticUpdatesConfiguration(val allRegionsEnabled: Boolean = false, val relevantRegionsEnabled: Boolean = false, val relevantRegionsRadius: Distance = Distance.ZERO, val relevantRegionsUpdateInterval: Duration = Duration.ZERO, val regionsAlongRouteEnabled: Boolean = false, val regionsAlongRouteRadius: Distance = Distance.ZERO)

Configuration of automatic updates parameters of the NdsStore.

Functions

copy

fun copy(updateStoragePath: File = this.updateStoragePath, persistentStoragePath: File = this.persistentStoragePath, updateServerUri: Uri? = this.updateServerUri, updateServerApiKey: String? = this.updateServerApiKey, automaticUpdatesConfiguration: NdsStoreUpdateConfig.AutomaticUpdatesConfiguration = this.automaticUpdatesConfiguration): NdsStoreUpdateConfig

Returns a copy of calling NdsStoreUpdateConfig object with possibilities to override every properties.

Properties

automaticUpdatesConfiguration

val automaticUpdatesConfiguration: NdsStoreUpdateConfig.AutomaticUpdatesConfiguration

persistentStoragePath

val persistentStoragePath: File

updateServerApiKey

val updateServerApiKey: String? = null

updateServerUri

val updateServerUri: Uri? = null

updateStoragePath

val updateStoragePath: File