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

Configuration

data class Configuration(val context: Context, val locationProvider: LocationProvider, val apiKey: String? = null, val navigationTileStore: NavigationTileStore? = null, val dataStoreMaintenanceEngine: DataStoreMaintenanceEngine? = null, val routePlanner: 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 online mode.

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, apiKey: String? = null, navigationTileStore: NavigationTileStore? = null, dataStoreMaintenanceEngine: DataStoreMaintenanceEngine? = null, routePlanner: 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.

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.

locationContextProviderEngine

val locationContextProviderEngine: LocationContextProviderEngine? = null

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

locationProvider

val locationProvider: LocationProvider

The default LocationProvider during navigation.

mapMatchingEngine

val mapMatchingEngine: MapMatchingEngine? = null

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

navigationTileStore

val navigationTileStore: NavigationTileStore? = null

Online data store used to initialize navigation engines.

replanningRetryPolicy

val replanningRetryPolicy: ReplanningRetryPolicy

The default ReplanningRetryPolicy during navigation. If it's not provided, an instance of TomTomReplanningRetryPolicy is used.

routePlanner

val routePlanner: RoutePlanner? = null

Used during instantiation of a default RouteReplanningEngine.

routeProgressEngine

val routeProgressEngine: RouteProgressEngine

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

routeProjectionEngine

val routeProjectionEngine: RouteProjectionEngine? = null

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

routeReplanner

val routeReplanner: RouteReplanner? = null

Used during instantiation of a default RouteReplanningEngine.

routeReplanningEngine

val routeReplanningEngine: RouteReplanningEngine? = null

The default RouteReplanningEngine during navigation.

routeTrackingEngine

val routeTrackingEngine: RouteTrackingEngine

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

telemetry

val telemetry: Telemetry? = null

Used to send telemetry data.

vehicleProvider

val vehicleProvider: VehicleProvider

The default VehicleProvider during navigation. If it's not provided, an instance of DefaultVehicleProvider is used.