com.tomtom.sdk.traffic:client/com.tomtom.sdk.traffic.client/TrafficTpegConfiguration

TrafficTpegConfiguration

class TrafficTpegConfiguration(val apiKey: String, val initSessionUrl: Uri, val updateFrequency: Duration = DEFAULT_UPDATE_FREQUENCY, val innerRadius: Distance = DEFAULT_INNER_RADIUS, val outerRadius: Distance = DEFAULT_OUTER_RADIUS, val maxNumberOfEvents: Int = DEFAULT_MAX_EVENTS, val trafficCacheEnabled: Boolean = false, val webRequestDumpDirectory: String? = null, fileFeedDirectory: String? = null, fileFeedPattern: String = ".*")

Configuration for the TomTom TPEG traffic provider.

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

Constructors

constructor(apiKey: String, initSessionUrl: Uri, updateFrequency: Duration = DEFAULT_UPDATE_FREQUENCY, innerRadius: Distance = DEFAULT_INNER_RADIUS, outerRadius: Distance = DEFAULT_OUTER_RADIUS, maxNumberOfEvents: Int = DEFAULT_MAX_EVENTS, trafficCacheEnabled: Boolean = false, webRequestDumpDirectory: String? = null, fileFeedDirectory: String? = null, fileFeedPattern: String = ".*")

Types

Companion

object Companion

Properties

apiKey

val apiKey: String

API key used to create a session.

initSessionUrl

val initSessionUrl: Uri

The resource/page on the server requested in the InitSession request.

innerRadius

val innerRadius: Distance

The Inner Radius (defaults to 10km).

maxNumberOfEvents

val maxNumberOfEvents: Int

Maximum number of messages the client can handle at a time (defaults to 1000).

outerRadius

val outerRadius: Distance

Outer Radius (defaults to 150km).

trafficCacheEnabled

val trafficCacheEnabled: Boolean = false

Enable or disable the traffic cache feature. If enabled, onboard traffic information is persisted between sessions, providing faster access to road closure information after starting the app. Defaults to false (disabled).

updateFrequency

val updateFrequency: Duration

Time to wait before sending the next GetMessage request (defaults to 60s).

webRequestDumpDirectory

val webRequestDumpDirectory: String? = null

The path to the directory in which dumps are stored. If this setting is not provided, dumping is disabled.