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

NavigationTileStoreConfiguration

class NavigationTileStoreConfiguration(val apiKey: String, val baseUrl: URL = NAVIGATION_TILES_BASE_URL, val initialLanguage: Locale = LocaleProvider.preferredLocale(), val cachingConfiguration: CachingConfiguration = DEFAULT_CACHING_CONFIGURATION, val prefetchingConfiguration: PrefetchingConfiguration = DEFAULT_PREFETCHING_CONFIGURATION)

Configuration parameters for a NavigationTileStore. It can configure the language of navigation tiles, as well as caching and prefetching mechanisms. These adjustments make the system more or less robust against temporary unavailability of the map data source, but they also increase memory and bandwidth costs.

Constructors

constructor(apiKey: String, baseUrl: URL = NAVIGATION_TILES_BASE_URL, initialLanguage: Locale = LocaleProvider.preferredLocale(), cachingConfiguration: CachingConfiguration = DEFAULT_CACHING_CONFIGURATION, prefetchingConfiguration: PrefetchingConfiguration = DEFAULT_PREFETCHING_CONFIGURATION)

Types

Companion

object Companion

Properties

apiKey

val apiKey: String

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

baseUrl

val baseUrl: URL

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

cachingConfiguration

val cachingConfiguration: CachingConfiguration

Configuration for caching mechanism. It configures the size of the in-memory tile store and the persistent cache.

initialLanguage

val initialLanguage: Locale

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

prefetchingConfiguration

val prefetchingConfiguration: PrefetchingConfiguration

Configuration for navigation map data prefetching mechanism. It defines area around the current position or around the active route for which navigation map data is prefetched and kept available.

Functions

copy

fun copy(apiKey: String = this.apiKey, baseUrl: URL = this.baseUrl, initialLanguage: Locale = this.initialLanguage, cachingConfiguration: CachingConfiguration = this.cachingConfiguration, prefetchingConfiguration: PrefetchingConfiguration = this.prefetchingConfiguration): 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.