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

NdsStoreUpdaterConfiguration

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, mapDiskUsageQuota: Memory? = null)

Constructs a NdsStoreUpdaterConfiguration object with the given parameters.

constructor(updateStoragePath: File, persistentStoragePath: File, updateServerUri: Uri? = null, updateServerApiKey: String? = null, locale: Locale = DEFAULT_LOCALE, automaticUpdates: AutomaticNdsStoreUpdaterConfiguration? = null, mapDiskUsageQuota: Memory? = null)

Constructs a NdsStoreUpdaterConfiguration object with the given parameters.

Types

Companion

object Companion

Represents default values for NdsStoreUpdaterConfiguration constructor.

Properties

automaticUpdates

val automaticUpdates: AutomaticNdsStoreUpdaterConfiguration?

Configuration for automatic map operations.

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.

mapDiskUsageQuota

val mapDiskUsageQuota: Memory?

The maximum disk space to use by the NDS map. If not specified, the NDS map size is only limited by available disk space.

persistentStoragePath

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

updateServerApiKey

val updateServerApiKey: String?

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?

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, automaticUpdates: AutomaticNdsStoreUpdaterConfiguration? = this.automaticUpdates, mapDiskUsageQuota: Memory? = this.mapDiskUsageQuota): NdsStoreUpdaterConfiguration

Returns a copy calling the NdsStoreUpdaterConfiguration object with possibilities to override every properties.

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String