NavigationConfiguration

data class NavigationConfiguration constructor(    val context: Context,     val apiKey: String,     val locationEngine: LocationEngine,     val mapMatchingEngine: MapMatchingEngine,     val dataStoreUpdateContextEngine: DataStoreUpdateContextEngine?,     val guidanceEngine: GuidanceEngine,     val routeTrackingEngine: RouteTrackingEngine,     val routeProgressCalculationEngine: RouteProgressCalculationEngine,     val locationContextProviderEngine: LocationContextProviderEngine,     val arrivalDetectionEngine: ArrivalDetectionEngine,     val routeReplanningEngine: RouteReplanningEngine,     val replanningRetryPolicy: ReplanningRetryPolicy,     val continuousReplanningMode: ContinuousReplanningMode,     val deviationReplanningMode: DeviationReplanningMode,     val maintainRoutesMode: MaintainRoutesMode,     val routingApi: RoutingApi,     val apiPath: URI? = null,     val apiKeyParamName: String? = null,     val telemetryApi: TelemetryApi? = null)

Configuration of the Navigation SDK.

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

Parameters

context

Used to initialize Android dependencies.

apiKey

API key needed for navigation.

locationEngine

Used as default LocationEngine during navigating.

mapMatchingEngine

Used as default MapMatchingEngine during navigating.

guidanceEngine

Used as default GuidanceEngine during navigating.

routeTrackingEngine

Used as default RouteTrackingEngine during navigating.

routeProgressCalculationEngine

Used as default RouteProgressCalculationEngine during navigating.

locationContextProviderEngine

Used as default LocationContextProviderEngine during navigating.

arrivalDetectionEngine

Used as default ArrivalDetectionEngine during navigating.

routeReplanningEngine

Used as default RouteReplanningEngine during navigating.

replanningRetryPolicy

Used as default ReplanningRetryPolicy during navigating.

continuousReplanningMode

Used as default ContinuousReplanningMode during navigating.

deviationReplanningMode

Defines if RouteReplanningEngine should try to replan a RoutePlan after deviation.

maintainRoutesMode

Used as default MaintainRoutesMode during navigation.

routingApi

Used as default RoutingApi during navigating.

apiPath

Path used to download navigation tiles.

apiKeyParamName

Name of the request parameter to use for the key.

telemetryApi

Used to send telemetry data.

Constructors

Link copied to clipboard
fun NavigationConfiguration(    context: Context,     apiKey: String,     locationEngine: LocationEngine,     mapMatchingEngine: MapMatchingEngine,     dataStoreUpdateContextEngine: DataStoreUpdateContextEngine?,     guidanceEngine: GuidanceEngine,     routeTrackingEngine: RouteTrackingEngine,     routeProgressCalculationEngine: RouteProgressCalculationEngine,     locationContextProviderEngine: LocationContextProviderEngine,     arrivalDetectionEngine: ArrivalDetectionEngine,     routeReplanningEngine: RouteReplanningEngine,     replanningRetryPolicy: ReplanningRetryPolicy,     continuousReplanningMode: ContinuousReplanningMode,     deviationReplanningMode: DeviationReplanningMode,     maintainRoutesMode: MaintainRoutesMode,     routingApi: RoutingApi,     apiPath: URI? = null,     apiKeyParamName: String? = null,     telemetryApi: TelemetryApi? = null)

Types

Link copied to clipboard
class Builder constructor(    context: Context,     navigationApiKey: String,     locationEngine: LocationEngine,     routingApi: RoutingApi,     telemetryApi: TelemetryApi? = null)

Responsible for creation of NavigationConfiguration.

Properties

Link copied to clipboard
val apiKey: String
Link copied to clipboard
val apiKeyParamName: String? = null
Link copied to clipboard
val apiPath: URI? = null
Link copied to clipboard
val arrivalDetectionEngine: ArrivalDetectionEngine
Link copied to clipboard
val context: Context
Link copied to clipboard
val continuousReplanningMode: ContinuousReplanningMode
Link copied to clipboard
Link copied to clipboard
val deviationReplanningMode: DeviationReplanningMode
Link copied to clipboard
val guidanceEngine: GuidanceEngine
Link copied to clipboard
Link copied to clipboard
val locationEngine: LocationEngine
Link copied to clipboard
val maintainRoutesMode: MaintainRoutesMode
Link copied to clipboard
val mapMatchingEngine: MapMatchingEngine
Link copied to clipboard
val replanningRetryPolicy: ReplanningRetryPolicy
Link copied to clipboard
Link copied to clipboard
val routeReplanningEngine: RouteReplanningEngine
Link copied to clipboard
val routeTrackingEngine: RouteTrackingEngine
Link copied to clipboard
val routingApi: RoutingApi
Link copied to clipboard
val telemetryApi: TelemetryApi? = null