navigation:engine/com.tomtom.sdk.navigation/NavigationConfiguration

NavigationConfiguration

data class NavigationConfiguration constructor( val context: Context, val apiKey: String, val locationEngine: LocationEngine, val dynamicRoutingApi: DynamicRoutingApi, val mapMatchingEngine: MapMatchingEngine = TomTomMapMatchingEngine(context), val guidanceEngine: GuidanceEngine = GuidanceEngineFactory.createGuidanceEngine( context, GuidanceEngineOptions() ), val routeTrackingEngine: RouteTrackingEngine = RouteTrackingEngineFactory.create(context), val routeProgressCalculationEngine: RouteProgressCalculationEngine = RouteProgressCalculationEngineFactory.create(), val locationContextProviderEngine: LocationContextProviderEngine = TomTomLocationContextProviderEngine( context), val arrivalDetectionEngine: ArrivalDetectionEngine = TomTomArrivalDetectionEngine(), val routeReplanningEngine: RouteReplanningEngine = RouteReplanningEngineFactory .create(dynamicRoutingApi), val replanningRetryPolicy: ReplanningRetryPolicy = TomTomReplanningRetryPolicy(), val continuousReplanningMode: ContinuousReplanningMode = ContinuousReplanningMode.MANUAL, val deviationReplanningMode: DeviationReplanningMode = DeviationReplanningMode.AUTOMATIC, val maintainRoutesMode: MaintainRoutesMode = MaintainRoutesMode.ActiveRouteOnly, val apiPath: URI? = null, val apiKeyParamName: String? = null, val navigationProcessingThrottle: Duration = DEFAULT_LOCATION_UPDATE_THROTTLE, 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.

dynamicRoutingApi

Used as default DynamicRoutingApi 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 whether RouteReplanningEngine should try to replan an active RoutePlan after deviation.

maintainRoutesMode

Used as default MaintainRoutesMode during navigation.

apiPath

Path used to download navigation tiles.

apiKeyParamName

Name of the request parameter to use for the key.

navigationProcessingThrottle

Minimal throttle interval to handle location update.

telemetryApi

Used to send telemetry data. Location update will be ignored when the time difference between location updates is lower than the navigationProcessingThrottle.

Constructors

NavigationConfiguration

fun NavigationConfiguration( context: Context, apiKey: String, locationEngine: LocationEngine, dynamicRoutingApi: DynamicRoutingApi, mapMatchingEngine: MapMatchingEngine = TomTomMapMatchingEngine(context), guidanceEngine: GuidanceEngine = GuidanceEngineFactory.createGuidanceEngine( context, GuidanceEngineOptions() ), routeTrackingEngine: RouteTrackingEngine = RouteTrackingEngineFactory.create(context), routeProgressCalculationEngine: RouteProgressCalculationEngine = RouteProgressCalculationEngineFactory.create(), locationContextProviderEngine: LocationContextProviderEngine = TomTomLocationContextProviderEngine( context), arrivalDetectionEngine: ArrivalDetectionEngine = TomTomArrivalDetectionEngine(), routeReplanningEngine: RouteReplanningEngine = RouteReplanningEngineFactory .create(dynamicRoutingApi), replanningRetryPolicy: ReplanningRetryPolicy = TomTomReplanningRetryPolicy(), continuousReplanningMode: ContinuousReplanningMode = ContinuousReplanningMode.MANUAL, deviationReplanningMode: DeviationReplanningMode = DeviationReplanningMode.AUTOMATIC, maintainRoutesMode: MaintainRoutesMode = MaintainRoutesMode.ActiveRouteOnly, apiPath: URI? = null, apiKeyParamName: String? = null, navigationProcessingThrottle: Duration = DEFAULT_LOCATION_UPDATE_THROTTLE, telemetryApi: TelemetryApi? = null)