com.tomtom.sdk.navigation:navigation-hybrid/com.tomtom.sdk.navigation.hybrid/Configuration

Configuration

data class Configuration(val context: Context, val locationProvider: LocationProvider, val hybridNavigationDataStore: HybridNavigationDataStore? = null, val ndsStore: NdsStore? = null, val apiKey: String? = null, val navigationTileStore: NavigationTileStore? = null, val dataStoreMaintenanceEngine: DataStoreMaintenanceEngine? = null, val dataStoreSelectionEngine: DataStoreSelectionEngine? = null, val onlineRoutePlanner: RoutePlanner? = null, val offlineRoutePlanner: RoutePlanner? = null, val routeReplanner: RouteReplanner? = null, val routeReplanningEngine: RouteReplanningEngine? = null, val replanningRetryPolicy: ReplanningRetryPolicy = TomTomReplanningRetryPolicy(), val betterProposalAcceptanceMode: BetterProposalAcceptanceMode = BetterProposalAcceptanceMode.Manual, val deviationReplanningMode: DeviationReplanningMode = DeviationReplanningMode.Automatic, val guidanceEngine: GuidanceEngine = GuidanceEngineFactory.createStaticGuidanceEngine( context, GuidanceEngineOptions() ), val horizonEngine: HorizonEngine? = null, val mapMatchingEngine: MapMatchingEngine? = null, val locationContextProviderEngine: LocationContextProviderEngine? = null, val routeProjectionEngine: RouteProjectionEngine? = null, val routeTrackingEngine: RouteTrackingEngine = RouteTrackingEngineFactory.create(), val routeProgressEngine: RouteProgressEngine = RouteProgressEngineFactory.create(), val arrivalDetectionEngine: ArrivalDetectionEngine = DefaultArrivalDetectionEngineFactory.create(), val vehicleProvider: VehicleProvider = DefaultVehicleProvider(), val telemetry: Telemetry? = null)

The configuration used to set up Navigation SDK to work in hybrid mode.

At least one of the following properties or combinations of properties must be specified:

At least one of the following properties must be specified:

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

Constructors

Configuration

constructor(context: Context, locationProvider: LocationProvider, hybridNavigationDataStore: HybridNavigationDataStore? = null, ndsStore: NdsStore? = null, apiKey: String? = null, navigationTileStore: NavigationTileStore? = null, dataStoreMaintenanceEngine: DataStoreMaintenanceEngine? = null, dataStoreSelectionEngine: DataStoreSelectionEngine? = null, onlineRoutePlanner: RoutePlanner? = null, offlineRoutePlanner: RoutePlanner? = null, routeReplanner: RouteReplanner? = null, routeReplanningEngine: RouteReplanningEngine? = null, replanningRetryPolicy: ReplanningRetryPolicy = TomTomReplanningRetryPolicy(), betterProposalAcceptanceMode: BetterProposalAcceptanceMode = BetterProposalAcceptanceMode.Manual, deviationReplanningMode: DeviationReplanningMode = DeviationReplanningMode.Automatic, guidanceEngine: GuidanceEngine = GuidanceEngineFactory.createStaticGuidanceEngine( context, GuidanceEngineOptions() ), horizonEngine: HorizonEngine? = null, mapMatchingEngine: MapMatchingEngine? = null, locationContextProviderEngine: LocationContextProviderEngine? = null, routeProjectionEngine: RouteProjectionEngine? = null, routeTrackingEngine: RouteTrackingEngine = RouteTrackingEngineFactory.create(), routeProgressEngine: RouteProgressEngine = RouteProgressEngineFactory.create(), arrivalDetectionEngine: ArrivalDetectionEngine = DefaultArrivalDetectionEngineFactory.create(), vehicleProvider: VehicleProvider = DefaultVehicleProvider(), telemetry: Telemetry? = null)

Properties

apiKey

val apiKey: String? = null

API key needed for navigation.

arrivalDetectionEngine

val arrivalDetectionEngine: ArrivalDetectionEngine

The default ArrivalDetectionEngine during navigation. If it's not provided, an instance created by DefaultArrivalDetectionEngineFactory.create is used.

betterProposalAcceptanceMode

val betterProposalAcceptanceMode: BetterProposalAcceptanceMode

The default BetterProposalAcceptanceMode during navigation. If it's not provided, the mode is set to BetterProposalAcceptanceMode.Manual

context

val context: Context

Initializes Android dependencies.

dataStoreMaintenanceEngine

val dataStoreMaintenanceEngine: DataStoreMaintenanceEngine? = null

Engine that updates the data store. If it's not provided, an instance created by DataStoreMaintenanceEngineFactory is used.

dataStoreSelectionEngine

val dataStoreSelectionEngine: DataStoreSelectionEngine? = null

The default DataStoreSelectionEngine during navigation. If it's not provided, an instance created by DefaultDataStoreSelectionEngineFactory is used (in OfflineFirst mode).

deviationReplanningMode

val deviationReplanningMode: DeviationReplanningMode

Defines whether RouteReplanningEngine should try to replan the active RoutePlan after deviation. If it's not provided, the deviation replanning mode is set to DeviationReplanningMode.Automatic.

guidanceEngine

val guidanceEngine: GuidanceEngine

The default GuidanceEngine during navigation. If it's not provided, an instance created by GuidanceEngineFactory.createStaticGuidanceEngine is used.

horizonEngine

val horizonEngine: HorizonEngine? = null

The default HorizonEngine during navigation.

hybridNavigationDataStore

val hybridNavigationDataStore: HybridNavigationDataStore? = null

Hybrid data store used during initialization of navigation engines.

locationContextProviderEngine

val locationContextProviderEngine: LocationContextProviderEngine? = null

The default LocationContextProviderEngine during navigation. If it's not provided, an instance created by HybridLocationContextProviderEngineFactory.create is used.