TomTom SDK for iOS AutomaticUpdatesConfiguration

AutomaticUpdatesConfiguration

public struct AutomaticUpdatesConfiguration

Configuration of automatic updates parameters of the NDSStore.

Important

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


                    
                    
                    init(allRegionsEnabled:relevantRegionsEnabled:relevantRegionsRadius:relevantRegionsUpdateInterval:regionsAlongRouteEnabled:regionsAlongRouteRadius:)

Creates an instance of NDSStoreUpdateConfig/AutomaticUpdatesConfiguration.

Declaration

Swift

public init(
    allRegionsEnabled: Bool = Defaults.allRegionsEnabled,
    relevantRegionsEnabled: Bool = Defaults.relevantRegionsEnabled,
    relevantRegionsRadius: Measurement<UnitLength> = Defaults.relevantRegionsRadius,
    relevantRegionsUpdateInterval: Measurement<UnitDuration> = Defaults.relevantRegionsUpdateInterval,
    regionsAlongRouteEnabled: Bool = Defaults.regionsAlongRouteEnabled,
    regionsAlongRouteRadius: Measurement<UnitLength> = Defaults.regionsAlongRouteRadius
)

Parameters

`allRegionsEnabled`	See `allRegionsEnabled`.
`relevantRegionsEnabled`	See `relevantRegionsEnabled`.
`relevantRegionsRadius`	See `relevantRegionsRadius`.
`relevantRegionsUpdateInterval`	See `relevantRegionsUpdateInterval`.
`regionsAlongRouteEnabled`	See `regionsAlongRouteEnabled`.
`regionsAlongRouteRadius`	See `regionsAlongRouteRadius`.

Defaults
Default values used in the AutomaticUpdatesConfiguration.
See more
Declaration
Swift

public enum Defaults
allRegionsEnabled
Indicates if the automatic update is enabled for all regions in the map.

Update regions will not be updated in any specific order.
Declaration
Swift

public var allRegionsEnabled: Bool
relevantRegionsEnabled
Indicates if the 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.
Declaration
Swift

public var relevantRegionsEnabled: Bool
relevantRegionsRadius
Indicates the distance within which regions around the current position would be considered for an update.

This is only used when relevantRegionsEnabled is true.

Note
Must not be negative.

Note
Radius is rounded to the nearest meter.
Declaration
Swift

public var relevantRegionsRadius: Measurement<UnitLength>
relevantRegionsUpdateInterval
Indicates the time interval at which relevant regions will be updated.

This is only used when relevantRegionsEnabled is true.

Value of 0 means that periodic updates are disabled.

Note
Must not be negative.

Note
Interval is rounded to the nearest minute.
Declaration
Swift

public var relevantRegionsUpdateInterval: Measurement<UnitDuration>
regionsAlongRouteEnabled
Indicates if the automatic update of regions in a given distance to the current active route is enabled.

If enabled, the distance should be specified using regionsAlongRouteRadius.
Declaration
Swift

public var regionsAlongRouteEnabled: Bool
regionsAlongRouteRadius
Set the distance within which regions around the current route would be considered for an update.

This is only used when regionsAlongRouteEnabled is true.

Note
Must not be negative.

Note
Radius is rounded to the nearest meter.
Declaration
Swift

public var regionsAlongRouteRadius: Measurement<UnitLength>