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

Builder

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

Responsible for creation of NavigationConfiguration.

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

Parameters

context

Used to initialize Android dependencies.

navigationApiKey

API key needed for navigation.

locationEngine

Used as default LocationEngine during navigating.

routingApi

Routing that will be used during route replanning.

telemetryApi

Used to send telemetry data.

Constructors

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

Functions

Link copied to clipboard
fun apiKeyParamName(apiKeyParamName: String): NavigationConfiguration.Builder
Content copied to clipboard

Specifies String which will be used as the param name of the key when calling the navigation tile server.

Link copied to clipboard
fun apiPath(apiPath: Uri): NavigationConfiguration.Builder
Content copied to clipboard

Specifies Uri which will be used to obtain navigation tiles.

Link copied to clipboard
fun arrivalDetectionEngine(arrivalDetectionEngine: ArrivalDetectionEngine): NavigationConfiguration.Builder
Content copied to clipboard

Specifies ArrivalDetectionEngine which will be used during navigating.

Link copied to clipboard
fun build(): NavigationConfiguration
Content copied to clipboard

Create new instance of NavigationConfiguration.

Link copied to clipboard
fun continuousReplanningMode(continuousReplanningMode: ContinuousReplanningMode): NavigationConfiguration.Builder
Content copied to clipboard

Specifies ContinuousReplanningMode which will be used during navigation.

Link copied to clipboard
fun dataStoreUpdateContextEngine(dataStoreUpdateContextEngine: DataStoreUpdateContextEngine?): NavigationConfiguration.Builder
Content copied to clipboard

Specifies DataStoreUpdateContextEngine which will be used during navigating.

Link copied to clipboard
fun deviationReplanningMode(deviationReplanningMode: DeviationReplanningMode): NavigationConfiguration.Builder
Content copied to clipboard

Specifies if RouteReplanningEngine should try to replan a RoutePlan on deviation.

Link copied to clipboard
fun guidanceEngine(guidanceEngine: GuidanceEngine): NavigationConfiguration.Builder
Content copied to clipboard

Specifies GuidanceEngine which will be used during navigating.

Link copied to clipboard
fun locationContextProviderEngine(locationContextProviderEngine: LocationContextProviderEngine): NavigationConfiguration.Builder
Content copied to clipboard

Specifies LocationContextProviderEngine which will be used during navigating.

Link copied to clipboard
fun maintainRoutesMode(maintainRoutesMode: MaintainRoutesMode): NavigationConfiguration.Builder
Content copied to clipboard

Specifies MaintainRoutesMode which will be used during navigation.

Link copied to clipboard
fun mapMatchingEngine(mapMatchingEngine: MapMatchingEngine): NavigationConfiguration.Builder
Content copied to clipboard

Specifies MapMatchingEngine which will be used during navigating.

Link copied to clipboard
fun replanningRetryPolicy(replanningRetryPolicy: ReplanningRetryPolicy): NavigationConfiguration.Builder
Content copied to clipboard

Specifies ReplanningRetryPolicy which will be used during navigation.

Link copied to clipboard
fun routeProgressCalculationEngine(routeProgressCalculationEngine: RouteProgressCalculationEngine): NavigationConfiguration.Builder
Content copied to clipboard

Specifies RouteProgressCalculationEngine which will be used during navigating.

Link copied to clipboard
fun routeReplanningEngine(routeReplanningEngine: RouteReplanningEngine): NavigationConfiguration.Builder
Content copied to clipboard

Specifies RouteReplanningEngine which will be used during navigation.

Link copied to clipboard
fun routeTrackingEngine(routeTrackingEngine: RouteTrackingEngine): NavigationConfiguration.Builder
Content copied to clipboard

Specifies RouteTrackingEngine which will be used during navigating.