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.Automatic, val deviationReplanningMode: DeviationReplanningMode = DeviationReplanningMode.Automatic, val guidanceEngine: GuidanceEngine = GuidanceEngineFactory.createDynamicGuidanceEngine( context, GuidanceEngineOptions() ), val horizonEngine: HorizonEngine? = null, val mapMatchingEngine: MapMatchingEngine? = null, val routeProjectionEngine: RouteProjectionEngine? = null, val routeTrackingEngine: RouteTrackingEngine = RouteTrackingEngineFactory.create(), val routeProgressEngine: RouteProgressEngine = RouteProgressEngineFactory.create(), val arrivalDetectionEngine: ArrivalDetectionEngine = DefaultArrivalDetectionEngineFactory.create(), val vehicleProvider: VehicleProvider = VehicleProviderFactory.create(), val telemetry: Telemetry? = null, val safetyLocations: SafetyLocations? = null)

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

At least one of the following 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

Link copied to clipboard
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.Automatic, deviationReplanningMode: DeviationReplanningMode = DeviationReplanningMode.Automatic, guidanceEngine: GuidanceEngine = GuidanceEngineFactory.createDynamicGuidanceEngine( context, GuidanceEngineOptions() ), horizonEngine: HorizonEngine? = null, mapMatchingEngine: MapMatchingEngine? = null, routeProjectionEngine: RouteProjectionEngine? = null, routeTrackingEngine: RouteTrackingEngine = RouteTrackingEngineFactory.create(), routeProgressEngine: RouteProgressEngine = RouteProgressEngineFactory.create(), arrivalDetectionEngine: ArrivalDetectionEngine = DefaultArrivalDetectionEngineFactory.create(), vehicleProvider: VehicleProvider = VehicleProviderFactory.create(), telemetry: Telemetry? = null, safetyLocations: SafetyLocations? = null)

Properties

Link copied to clipboard
val apiKey: String? = null

API key needed for navigation.

Link copied to clipboard
val arrivalDetectionEngine: ArrivalDetectionEngine

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

Link copied to clipboard
Link copied to clipboard
val context: Context

Initializes Android dependencies.

Link copied to clipboard
val dataStoreMaintenanceEngine: DataStoreMaintenanceEngine? = null

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

Link copied to clipboard
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.

Link copied to clipboard
val guidanceEngine: GuidanceEngine

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

Link copied to clipboard
val horizonEngine: HorizonEngine? = null

The default HorizonEngine during navigation.

Link copied to clipboard
val locationProvider: LocationProvider

The default LocationProvider during navigation.

Link copied to clipboard
val mapMatchingEngine: MapMatchingEngine? = null

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

Link copied to clipboard
val navigationTileStore: NavigationTileStore? = null

Online data store used to initialize navigation engines.

Link copied to clipboard
val replanningRetryPolicy: ReplanningRetryPolicy

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

Link copied to clipboard
val routePlanner: RoutePlanner? = null

Used during instantiation of a default RouteReplanningEngine.

Link copied to clipboard
val routeProgressEngine: RouteProgressEngine

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

Link copied to clipboard
val routeProjectionEngine: RouteProjectionEngine? = null

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

Link copied to clipboard
val routeReplanner: RouteReplanner? = null

Used during instantiation of a default RouteReplanningEngine.

Link copied to clipboard
val routeReplanningEngine: RouteReplanningEngine? = null

The default RouteReplanningEngine during navigation.

Link copied to clipboard
val routeTrackingEngine: RouteTrackingEngine

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

Link copied to clipboard
val safetyLocations: SafetyLocations? = null

Safety location data provider. It provides safety location data during navigation, which will be used by HorizonEngine. There is no safety location on Horizon if it is not specified. If customized horizonEngine is specified in configuration, safetyLocations can be injected to the customized horizonEngine, and this parameter will be ignored.

Link copied to clipboard
val telemetry: Telemetry? = null

Used to send telemetry data.

Link copied to clipboard
val vehicleProvider: VehicleProvider

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