com.tomtom.sdk.datamanagement:nds-store-updater/com.tomtom.sdk.datamanagement.nds.update/NdsStoreUpdateConfig

NdsStoreUpdateConfig

class NdsStoreUpdateConfig(val updateStoragePath: File, val persistentStoragePath: File, val updateServerUri: Uri? = null, val updateServerApiKey: String? = null, val locale: Locale = DEFAULT_LOCALE, val automaticUpdatesConfiguration: NdsStoreUpdateConfig.AutomaticUpdatesConfiguration = DEFAULT_AUTOMATIC_UPDATES_CONFIGURATION)

Configuration of updates of the NdsStoreUpdater.

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

Constructors

constructor(updateStoragePath: File, persistentStoragePath: File, updateServerUri: Uri? = null, updateServerApiKey: String? = null, locale: Locale = DEFAULT_LOCALE, automaticUpdatesConfiguration: NdsStoreUpdateConfig.AutomaticUpdatesConfiguration = DEFAULT_AUTOMATIC_UPDATES_CONFIGURATION)

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 NdsStoreUpdater.

Companion

object Companion

Represents default values for NdsStoreUpdateConfig constructor.

Properties

automaticUpdatesConfiguration

val automaticUpdatesConfiguration: NdsStoreUpdateConfig.AutomaticUpdatesConfiguration

Configuration of automatic updates parameters

locale

val locale: Locale

The locale whose language will be used for names of map regions in region graph. If the map does not support the language, the best matched language in the map will be used.

persistentStoragePath

val persistentStoragePath: File

: 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.

updateServerApiKey

val updateServerApiKey: String? = null

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.

updateServerUri

val updateServerUri: Uri? = null

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

updateStoragePath

val updateStoragePath: File

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.

Functions

copy

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

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

toString

open override fun toString(): String