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

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.

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

Parameters

allRegionsEnabled

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

relevantRegionsEnabled

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

relevantRegionsRadius

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

relevantRegionsUpdateInterval

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

regionsAlongRouteEnabled

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

regionsAlongRouteRadius

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

Constructors

Link copied to clipboard
constructor(allRegionsEnabled: Boolean = false, relevantRegionsEnabled: Boolean = false, relevantRegionsRadius: Distance = Distance.ZERO, relevantRegionsUpdateInterval: Duration = Duration.ZERO, regionsAlongRouteEnabled: Boolean = false, regionsAlongRouteRadius: Distance = Distance.ZERO)

Properties

Link copied to clipboard
val allRegionsEnabled: Boolean = false
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
fun copy(allRegionsEnabled: Boolean = this.allRegionsEnabled, relevantRegionsEnabled: Boolean = this.relevantRegionsEnabled, relevantRegionsRadius: Distance = this.relevantRegionsRadius, relevantRegionsUpdateInterval: Duration = this.relevantRegionsUpdateInterval, regionsAlongRouteEnabled: Boolean = this.regionsAlongRouteEnabled, regionsAlongRouteRadius: Distance = this.regionsAlongRouteRadius): NdsStoreUpdateConfig.AutomaticUpdatesConfiguration

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

Link copied to clipboard
open override fun toString(): String