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

NdsStoreUpdateConfig

data class NdsStoreUpdateConfig(val updateStoragePath: File, val persistentStoragePath: File, val updateServerUri: Uri? = null, val updateServerApiKey: String? = null, val iqMapsAllRegionsEnabled: Boolean = false, val iqMapsRelevantRegionsEnabled: Boolean = false, val iqMapsRelevantRegionsRadius: Distance = Distance.ZERO, val iqMapsRelevantRegionsUpdateInterval: Duration = Duration.ZERO, val iqMapsRegionsAlongRouteEnabled: Boolean = false, val iqMapsRegionsAlongRouteRadius: Distance = 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.

iqMapsAllRegionsEnabled

Indicates whether automatic update is enabled for all regions in the map. Update regions will not be updated in any specific order.

iqMapsRelevantRegionsEnabled

Indicates whether automatic update within the radius around current position is enabled. If enabled, the radius should be specified in iqMapsRelevantRegionsRadius. Additionally, it is possible to configure periodic updates via iqMapsRelevantRegionsUpdateInterval. Update regions will not be updated in any specific order.

iqMapsRelevantRegionsRadius

Indicates the distance within which regions around the current position would be considered for an update. This is only used when iqMapsRelevantRegionsEnabled is enabled. Should not be negative.

iqMapsRelevantRegionsUpdateInterval

Indicates the time interval at which relevant regions will be updated. This is only used when iqMapsRelevantRegionsEnabled is enabled. Should not be negative. Value of 0, means periodic updates are disabled.

iqMapsRegionsAlongRouteEnabled

Enables the automatic update of regions in a given distance to the current active route. If enabled, the distance should be specified in iqMapsRegionsAlongRouteRadius.

iqMapsRegionsAlongRouteRadius

Indicates the distance within which regions around the current route would be considered for an update. This is only used when iqMapsRegionsAlongRouteEnabled is enabled. Should not be negative.

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

Constructors

NdsStoreUpdateConfig

fun NdsStoreUpdateConfig(updateStoragePath: File, persistentStoragePath: File, updateServerUri: Uri? = null, updateServerApiKey: String? = null, iqMapsAllRegionsEnabled: Boolean = false, iqMapsRelevantRegionsEnabled: Boolean = false, iqMapsRelevantRegionsRadius: Distance = Distance.ZERO, iqMapsRelevantRegionsUpdateInterval: Duration = Duration.ZERO, iqMapsRegionsAlongRouteEnabled: Boolean = false, iqMapsRegionsAlongRouteRadius: Distance = Distance.ZERO)