NavigationConfigurationBuilder

public class NavigationConfigurationBuilder

NavigationConfigurationBuilder builds the NavigationConfiguration object

Important

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

Lifecycle


                    
                    
                    init(navigationKey:locationProvider:routeReplanner:)

Initializer

Declaration

Swift

public init(
    navigationKey: String,
    locationProvider: LocationProvider,
    routeReplanner: TomTomSDKRouteReplanner.RouteReplanner
)

Parameters

`navigationKey`	API key used to access the navigation services.
`locationProvider`	`LocationProvider` that will be used by navigation
`routeReplanner`	Route replanner to be used when replanning.

Public


                    
                    
                    with(apiPath:)

Specifies a custom api path URLComponents that will be used by navigation

Declaration

Swift

public func with(apiPath: URLComponents) -> NavigationConfigurationBuilder

Parameters


                                apiPath

Configuration parameters for the navigation service


                    
                    
                    with(mapMatchingEngine:)

Specifies a custom MapMatchingEngine that will be used by navigation

Declaration

Swift

public func with(mapMatchingEngine: MapMatchingEngine) -> NavigationConfigurationBuilder

Parameters


                                mapMatchingEngine

Custom MapMatchingEngine that will be used by navigation


                    
                    
                    with(routeProgressEngine:)

Specifies a custom RouteProgressDetectionEngine that will be used by navigation

Declaration

Swift

public func with(routeProgressEngine: RouteProgressDetectionEngine) -> NavigationConfigurationBuilder

Parameters


                                routeProgressEngine

Custom RouteProgressDetectionEngine that will be used by navigation


                    
                    
                    with(guidanceEngine:)

Specifies a custom GuidanceEngine that will be used by navigation

Declaration

Swift

public func with(guidanceEngine: GuidanceEngine) -> NavigationConfigurationBuilder

Parameters


                                guidanceEngine

Custom GuidanceEngine that will be used by navigation


                    
                    
                    with(routeTrackingEngine:)

Specifies a custom RouteTrackingEngine that will be used by navigation

Declaration

Swift

public func with(routeTrackingEngine: RouteTrackingEngine) -> NavigationConfigurationBuilder

Parameters


                                routeTrackingEngine

Custom RouteTrackingEngine that will be used by navigation


                    
                    
                    with(arrivalDetectionEngine:)

Specifies a custom ArrivalDetectionEngine that will be used by navigation

Declaration

Swift

public func with(arrivalDetectionEngine: ArrivalDetectionEngine) -> NavigationConfigurationBuilder

Parameters


                                arrivalDetectionEngine

Custom ArrivalDetectionEngine that will be used by navigation


                    
                    
                    with(locationContextDetectionEngine:)

Specifies a custom LocationContextDetectionEngine that will be used by navigation

Declaration

Swift

public func with(locationContextDetectionEngine: LocationContextDetectionEngine) -> NavigationConfigurationBuilder

Parameters


                                locationContextDetectionEngine

Custom LocationContextDetectionEngine that will be used by navigation


                    
                    
                    with(routeReplanningEngine:)

Specifies a custom RouteReplanningEngine that will be used by navigation

Declaration

Swift

public func with(routeReplanningEngine: RouteReplanningEngine) -> NavigationConfigurationBuilder

Parameters


                                routeReplanningEngine

Custom RouteReplanningEngine that will be used by navigation


                    
                    
                    with(routeReplanningRetryPolicy:)

Specifies a custom ReplanningRetryPolicy to be used by navigation to decide if a failed replan should be retried.

Declaration

Swift

public func with(routeReplanningRetryPolicy: ReplanningRetryPolicy) -> NavigationConfigurationBuilder

Parameters


                                routeReplanningRetryPolicy

Custom ReplanningRetryPolicy that will be used by navigation


                    
                    
                    with(routeDeviationReplanningRetryPolicy:)

Specifies a custom ReplanningRetryPolicy to be used by navigation to decide if a failed deviation replan should be retried.

Declaration

Swift

public func with(routeDeviationReplanningRetryPolicy: ReplanningRetryPolicy) -> NavigationConfigurationBuilder

Parameters


                                routeReplanningRetryPolicy

Custom ReplanningRetryPolicy that will be used by navigation

with(routeReplanningMode:)
Specifies a custom ContinuousReplanningMode that will be used by navigation
Declaration
Swift

public func with(routeReplanningMode: ContinuousReplanningMode) -> NavigationConfigurationBuilder


                    
                    
                    with(deviationReplanningMode:)

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

Declaration

Swift

public func with(deviationReplanningMode: DeviationReplanningMode) -> NavigationConfigurationBuilder

Parameters


                                isReplanningOnDeviationEnabled

Flag specifying if automatic route replanning after deviation should be enabled.

build()
Builds the configuration based on the parameters passed to the builder.
Declaration
Swift

public func build() -> NavigationConfiguration
Return Value

built NavigationConfiguration object

NavigationConfigurationBuilder

Lifecycle

Declaration

Parameters

Public

Declaration

Parameters

Declaration

Parameters

Declaration

Parameters

Declaration

Parameters

Declaration

Parameters

Declaration

Parameters

Declaration

Parameters

Declaration

Parameters

Declaration

Parameters

Declaration

Parameters

Declaration

Declaration

Parameters

Declaration

Return Value