com.tomtom.sdk.datamanagement:navigation-tile-store/com.tomtom.sdk.datamanagement.navigationtile/NavigationTileStoreConfiguration

NavigationTileStoreConfiguration

class NavigationTileStoreConfiguration(val apiKey: String, val baseUri: URI = NAVIGATION_TILES_BASE_URL, val initialLanguage: Locale = LocaleProvider.preferredLocale(), val prefetchedAreaRadius: Distance = DEFAULT_RADIUS, val cacheMemoryMaxSize: Memory = DEFAULT_CACHE_MEMORY_MAX_SIZE, val cacheStorageConfiguration: CacheStorageConfiguration? = DEFAULT_CACHE_STORAGE_CONFIGURATION, val requestLaneTiles: Boolean = false, val prefetchedAreaAlongRoute: AreaAlongRoute? = DEFAULT_AREA_ALONG_ROUTE)

Configuration parameters for a NavigationTileStore.

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

Constructors

constructor(apiKey: String, baseUri: URI = NAVIGATION_TILES_BASE_URL, initialLanguage: Locale = LocaleProvider.preferredLocale(), prefetchedAreaRadius: Distance = DEFAULT_RADIUS, cacheMemoryMaxSize: Memory = DEFAULT_CACHE_MEMORY_MAX_SIZE, cacheStorageConfiguration: CacheStorageConfiguration? = DEFAULT_CACHE_STORAGE_CONFIGURATION, requestLaneTiles: Boolean = false, prefetchedAreaAlongRoute: AreaAlongRoute? = DEFAULT_AREA_ALONG_ROUTE)

Types

Companion

object Companion

Properties

apiKey

val apiKey: String

Token, or key, to use to authenticate to the cloud service.

baseUri

val baseUri: URI

A URI describing the location of the navigation tile cloud service.

cacheMemoryMaxSize

val cacheMemoryMaxSize: Memory

Size limit for in-memory tile store. The parameter defaults to DEFAULT_CACHE_MEMORY_MAX_SIZE.

cacheStorageConfiguration

val cacheStorageConfiguration: CacheStorageConfiguration?

Persistent cache storage configuration. If the parameter is omitted, the default persistent cache storage configuration will be used. If the parameter is set to null, persistent cache storage will NOT be used.

initialLanguage

val initialLanguage: Locale

Language to use for the navigation tiles. The parameter defaults to the user's preferred locale.

prefetchedAreaAlongRoute

val prefetchedAreaAlongRoute: AreaAlongRoute?

Area along the active route to prefetch navigation map data and keep it available. If the parameter is omitted, the default area along the active route will be used. If the parameter is set to null, NO navigation map data along the active route will be prefetched. The larger the area, the more robust the system is to temporary unavailability of the map data source, but at a greater memory and bandwidth cost.

prefetchedAreaRadius

val prefetchedAreaRadius: Distance

Radius around the current position defining the minimum area for which navigation map data is prefetched and kept available. The actual area fetched can be greater than the requested radius. The larger the radius, the more robust the system is to temporary unavailability of the map data source, but at a greater memory and bandwidth cost. The value must be non-negative integer. The parameter defaults to DEFAULT_RADIUS meters. The maximum value is EARTH_RADIUS_IN_METERS meters.

requestLaneTiles

val requestLaneTiles: Boolean = false

The toggle flag enabling access to lane tiles in the navigation tiles. When value is true lane level visualization can display the road network with enhanced lane geometry. The parameter defaults to false. WARNING: enabling lane tiles will result in increased data consumption.

Functions

copy

fun copy(apiKey: String = this.apiKey, baseUri: URI = this.baseUri, initialLanguage: Locale = this.initialLanguage, prefetchedAreaRadius: Distance = this.prefetchedAreaRadius, cacheMemoryMaxSize: Memory = this.cacheMemoryMaxSize, cacheStorageConfiguration: CacheStorageConfiguration? = this.cacheStorageConfiguration, requestLaneTiles: Boolean = this.requestLaneTiles, prefetchedAreaAlongRoute: AreaAlongRoute? = this.prefetchedAreaAlongRoute): NavigationTileStoreConfiguration

Creates a copy of this NavigationTileStoreConfiguration object with optional parameter overrides.

equals

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

Checks if this NavigationTileStoreConfiguration object is equal to another object.

hashCode

open override fun hashCode(): Int

Generates a hash code for this NavigationTileStoreConfiguration object.

toString

open override fun toString(): String

Returns a string representation of the object.