NavigationConfigurationBuilder Class Reference
NavigationConfigurationBuilder
public class NavigationConfigurationBuilderA builder that helps to construct NavigationConfiguration object.
Important
This is a Public Preview API. It may be changed or removed at any time.-
Creates a configuration builder with the specified navigation key, location provider and route replanner.
Declaration
Swift
public init( apiKey: String, locationProvider: LocationProvider, routeReplanner: TomTomSDKRouteReplanner.RouteReplanner )Parameters
apiKeyAPI key used to access the navigation services.
locationProviderLocationProviderthat will be used by navigationrouteReplannerRoute replanner to be used when replanning.
-
Specifies a custom api path
URLComponentsthat will be used by navigation.Declaration
Swift
public func with(apiPath: URLComponents) -> NavigationConfigurationBuilderParameters
apiPathConfiguration parameters for the navigation service.
-
Specifies a custom
MapMatchingEnginethat will be used by navigation.Declaration
Swift
public func with(mapMatchingEngine: MapMatchingEngine) -> NavigationConfigurationBuilderParameters
mapMatchingEngineCustom
MapMatchingEnginethat will be used by navigation. -
Specifies a custom
RouteProgressDetectionEnginethat will be used by navigation.Declaration
Swift
public func with(routeProgressEngine: RouteProgressDetectionEngine) -> NavigationConfigurationBuilderParameters
routeProgressEngineCustom
RouteProgressDetectionEnginethat will be used by navigation. -
Specifies a custom
GuidanceEnginethat will be used by navigation.The SDK provides the following engines that may be passed to this method:
Declaration
Swift
public func with(guidanceEngine: GuidanceEngine) -> NavigationConfigurationBuilderParameters
guidanceEngineCustom
GuidanceEnginethat will be used by navigation. -
Specifies a custom
RouteTrackingEnginethat will be used by navigation.Declaration
Swift
public func with(routeTrackingEngine: RouteTrackingEngine) -> NavigationConfigurationBuilderParameters
routeTrackingEngineCustom
RouteTrackingEnginethat will be used by navigation. -
Specifies a custom
ArrivalDetectionEnginethat will be used by navigation.Declaration
Swift
public func with(arrivalDetectionEngine: ArrivalDetectionEngine) -> NavigationConfigurationBuilderParameters
arrivalDetectionEngineCustom
ArrivalDetectionEnginethat will be used by navigation. -
Specifies a custom
LocationContextDetectionEnginethat will be used by navigationDeclaration
Swift
public func with(locationContextDetectionEngine: LocationContextDetectionEngine) -> NavigationConfigurationBuilderParameters
locationContextDetectionEngineCustom
LocationContextDetectionEnginethat will be used by navigation. -
Specifies a custom
RouteReplanningEnginethat will be used by navigationDeclaration
Swift
public func with(routeReplanningEngine: RouteReplanningEngine) -> NavigationConfigurationBuilderParameters
routeReplanningEngineCustom
RouteReplanningEnginethat will be used by navigation. -
Specifies a custom
ReplanningRetryPolicyto be used by navigation to decide if a failed replan should be retried.Declaration
Swift
public func with(routeReplanningRetryPolicy: ReplanningRetryPolicy) -> NavigationConfigurationBuilderParameters
routeReplanningRetryPolicyCustom
ReplanningRetryPolicythat will be used by navigation. -
Specifies a custom
ReplanningRetryPolicyto be used by navigation to decide if a failed deviation replan should be retried.Declaration
Swift
public func with(routeDeviationReplanningRetryPolicy: ReplanningRetryPolicy) -> NavigationConfigurationBuilderParameters
routeReplanningRetryPolicyCustom
ReplanningRetryPolicythat will be used by navigation. -
Specifies a custom
ContinuousReplanningModethat will be used by navigation.Declaration
Swift
public func with(routeReplanningMode: ContinuousReplanningMode) -> NavigationConfigurationBuilder -
Specifies if
RouteReplanningEngineshould try to replan aRoutePlanafter deviation.Declaration
Swift
public func with(deviationReplanningMode: DeviationReplanningMode) -> NavigationConfigurationBuilderParameters
isReplanningOnDeviationEnabledFlag specifying if automatic route replanning after deviation should be enabled.
-
Creates the configuration based on the parameters passed to the builder.
If some parameters are not provided before invoking this method, then a configuration object is initialized with default values.
Tip
Default tables.
New navigation processing | Parameter | Type | |—————————-|————————————————————| |
mapMatching| Internal type. | |routeProgress|StandaloneRouteProgressEngine| |guidance|TomTomGuidanceEngine| |routeTracking| Internal type. | |arrivalDetection|TomTomArrivalDetectionEngine| |locationContextDetection| Internal type. | |routeReplanning|TomTomRouteReplanningEngine|Primary navigation processing | Parameter | Type | |—————————-|————————————–| |
mapMatching|DefaultMapMatchingEngine| |routeProgress|NavKitRouteProgressDetectionEngine| |guidance|TomTomGuidanceEngine| |routeTracking|NavKitRouteTrackingEngine| |arrivalDetection|TomTomArrivalDetectionEngine| |locationContextDetection|NavKitLocationContextEngine| |routeReplanning|TomTomRouteReplanningEngine|
Declaration
Swift
public func build() -> NavigationConfigurationReturn Value
Configuration object that can be used to initialize
Navigation.