NavigationConfiguration

public struct NavigationConfiguration : NavigationConfigurable

A NavigationConfiguration that helps to construct NavigationConfiguration.

Important

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

Lifecycle

  • Creates a configuration with the specified navigation key, location provider and route replanner.

    Tip

    Default tables.

    Declaration

    Swift

    public init(
        apiKey: String,
        locationProvider: LocationProvider,
        routeReplanner: TomTomSDKRouteReplanner.RouteReplanner,
        apiPath: URLComponents? = nil,
        mapMatchingEngine: MapMatchingEngine? = nil,
        routeProgressProviderEngine: RouteProgressProviderEngine? = nil,
        guidanceEngine: GuidanceEngine? = nil,
        routeTrackingEngine: RouteTrackingEngine? = nil,
        arrivalDetectionEngine: ArrivalDetectionEngine? = nil,
        locationContextProviderEngine: LocationContextProviderEngine? = nil,
        routeReplanningEngine: RouteReplanningEngine? = nil,
        routeProjectionEngine: RouteProjectionEngine? = nil,
        horizonEngine: HorizonEngine? = nil,
        routeReplanningRetryPolicy: ReplanningRetryPolicy = TomTomReplanningRetryPolicy(),
        routeDeviationReplanningRetryPolicy: ReplanningRetryPolicy = TomTomReplanningRetryPolicy(forDeviation: true),
        continuousReplanningMode: ContinuousReplanningMode = ContinuousReplanningMode.default,
        deviationReplanningMode: DeviationReplanningMode = DeviationReplanningMode.default
    )

    Parameters

    apiKey

    API key used to access the navigation services.

    locationProvider

    LocationProvider that will be used by navigation

    routeReplanner

    Route replanner to be used when replanning.

    apiPath

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

    mapMatchingEngine

    Specifies a custom MapMatchingEngine that will be used by navigation.

    routeProgressProviderEngine

    Specifies a custom RouteProgressProviderEngine that will be used by navigation.

    guidanceEngine

    Specifies a custom GuidanceEngine that will be used by navigation.

    routeTrackingEngine

    Specifies a custom RouteTrackingEngine that will be used by navigation.

    arrivalDetectionEngine

    Specifies a custom ArrivalDetectionEngine that will be used by navigation.

    locationContextProviderEngine

    Specifies a custom LocationContextProviderEngine that will be used by navigation.

    routeReplanningEngine

    Specifies a custom RouteReplanningEngine that will be used by navigation.

    routeProjectionEngine

    Specifies a custom RouteProjectionEngine that will be used by navigation.

    horizonEngine

    Specifies a custom HorizonEngine that will be used by navigation.

    routeReplanningRetryPolicy

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

    routeDeviationReplanningRetryPolicy

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

    continuousReplanningMode

    Specifies a custom ContinuousReplanningMode that will be used by navigation.

    deviationReplanningMode

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

Public

  • LocationProvider that will be used by navigation.

    Declaration

    Swift

    public let locationProvider: LocationProvider
  • Route replanner to be used when replanning.

    Declaration

    Swift

    public let routeReplanner: TomTomSDKRouteReplanner.RouteReplanner
  • Specifies a custom ReplanningRetryPolicy to be used by navigation to decide if a failed replan should be retried.

    Declaration

    Swift

    public let routeReplanningRetryPolicy: ReplanningRetryPolicy
  • Specifies a custom ReplanningRetryPolicy to be used by navigation to decide if a failed deviation replan should be retried.

    Declaration

    Swift

    public let routeDeviationReplanningRetryPolicy: ReplanningRetryPolicy
  • Specifies a custom ContinuousReplanningMode that will be used by navigation.

    Declaration

    Swift

    public let continuousReplanningMode: ContinuousReplanningMode
  • Specifies if RouteReplanningEngine should try to replan a RoutePlan after deviation. Flag specifying if automatic route replanning after deviation should be enabled.

    Declaration

    Swift

    public let deviationReplanningMode: DeviationReplanningMode
  • Specifies a custom api path URLComponents that will be used by navigation. Configuration parameters for the navigation service.

    Declaration

    Swift

    public let parameters: URLComponents?
  • The NavigationEngines protocol defines all engines that can be used by the TomTomSDKNavigation module.

    Declaration

    Swift

    public let navigationEngines: NavigationEngines