TomTom SDK for iOS DefaultTomTomNavigation

DefaultTomTomNavigation

@available(*, deprecated, message: "This API is deprecated and will be removed with the next major release.")
public class DefaultTomTomNavigation : TomTomNavigation

The DefaultTomTomNavigation object defines the functionality of the navigation.

Important

DefaultTomTomNavigation isn’t thread-safe and it’s recommended to make API calls always on the same thread.


                    
                    
                    init(locationProvider:dataSourceSelectionEngine:dataStoreMaintenanceEngine:mapMatchingEngine:routeProgressEngine:guidanceEngine:routeTrackingEngine:arrivalDetectionEngine:horizonEngine:routeReplanner:routeReplanningEngine:routeReplanningRetryPolicy:betterProposalAcceptanceMode:deviationReplanningMode:vehicleProvider:usePredictions:)

Creates an instance of DefaultTomTomNavigation.

Important

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

Declaration

Swift

public init( // swiftlint:disable:this function_body_length
    locationProvider: LocationProvider,
    dataSourceSelectionEngine: DataSourceSelectionEngine?,
    dataStoreMaintenanceEngine: DataStoreMaintenanceEngine?,
    mapMatchingEngine: MapMatchingEngine,
    routeProgressEngine: RouteProgressEngine,
    guidanceEngine: GuidanceEngine,
    routeTrackingEngine: RouteTrackingEngine?,
    arrivalDetectionEngine: ArrivalDetectionEngine,
    horizonEngine: HorizonEngine?,
    routeReplanner: TomTomSDKRouteReplanner.RouteReplanner,
    routeReplanningEngine: RouteReplanningEngine,
    routeReplanningRetryPolicy: ReplanningRetryPolicy,
    betterProposalAcceptanceMode: BetterProposalAcceptanceMode,
    deviationReplanningMode: DeviationReplanningMode,
    vehicleProvider: VehicleProvider,
    usePredictions: Bool
)

Parameters

`locationProvider`	The `LocationProvider` to be used during navigation.
`dataSourceSelectionEngine`	The `DataSourceSelectionEngine` to be used during navigation.
`dataStoreMaintenanceEngine`	The `DataStoreMaintenanceEngine` to be used during navigation.
`mapMatchingEngine`	The `MapMatchingEngine` to be used during navigation.
`routeProgressEngine`	The `RouteProgressEngine` to be used during navigation.
`guidanceEngine`	The `GuidanceEngine` to be used during navigation.
`routeTrackingEngine`	The `RouteTrackingEngine` to be used during navigation.
`arrivalDetectionEngine`	The `ArrivalDetectionEngine` to be used during navigation.
`horizonEngine`	The `HorizonEngine` to be used during navigation.
`routeReplanner`	The `TomTomSDKRouteReplanner.RouteReplanner` to be used during navigation.
`routeReplanningEngine`	The `RouteReplanningEngine` to be used during navigation.
`routeReplanningRetryPolicy`	The `ReplanningRetryPolicy` to be used during navigation for replanning.
`betterProposalAcceptanceMode`	The `BetterProposalAcceptanceMode` to be used during navigation.
`deviationReplanningMode`	The `DeviationReplanningMode` to be used during navigation.
`vehicleProvider`	The `VehicleProvider` to be used during navigation.
`usePredictions`	Use predictions during navigation.


                    
                    
                    init(locationProvider:dataSourceSelectionEngine:dataStoreMaintenanceEngine:mapMatchingEngine:routeProgressEngine:guidanceEngine:routeTrackingEngine:arrivalDetectionEngine:horizonEngine:routeReplanner:routeReplanningEngine:routeReplanningRetryPolicy:betterProposalAcceptanceMode:deviationReplanningMode:vehicleProvider:)

Creates an instance of DefaultTomTomNavigation.

Important

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

Declaration

Swift

public convenience init(
    locationProvider: LocationProvider,
    dataSourceSelectionEngine: DataSourceSelectionEngine?,
    dataStoreMaintenanceEngine: DataStoreMaintenanceEngine?,
    mapMatchingEngine: MapMatchingEngine,
    routeProgressEngine: RouteProgressEngine,
    guidanceEngine: GuidanceEngine,
    routeTrackingEngine: RouteTrackingEngine?,
    arrivalDetectionEngine: ArrivalDetectionEngine,
    horizonEngine: HorizonEngine?,
    routeReplanner: TomTomSDKRouteReplanner.RouteReplanner,
    routeReplanningEngine: RouteReplanningEngine,
    routeReplanningRetryPolicy: ReplanningRetryPolicy,
    betterProposalAcceptanceMode: BetterProposalAcceptanceMode,
    deviationReplanningMode: DeviationReplanningMode,
    vehicleProvider: VehicleProvider
)

Parameters

`locationProvider`	The `LocationProvider` to be used during navigation.
`dataSourceSelectionEngine`	The `DataSourceSelectionEngine` to be used during navigation.
`dataStoreMaintenanceEngine`	The `DataStoreMaintenanceEngine` to be used during navigation.
`mapMatchingEngine`	The `MapMatchingEngine` to be used during navigation.
`routeProgressEngine`	The `RouteProgressEngine` to be used during navigation.
`guidanceEngine`	The `GuidanceEngine` to be used during navigation.
`routeTrackingEngine`	The `RouteTrackingEngine` to be used during navigation.
`arrivalDetectionEngine`	The `ArrivalDetectionEngine` to be used during navigation.
`horizonEngine`	The `HorizonEngine` to be used during navigation.
`routeReplanner`	The `TomTomSDKRouteReplanner.RouteReplanner` to be used during navigation.
`routeReplanningEngine`	The `RouteReplanningEngine` to be used during navigation.
`routeReplanningRetryPolicy`	The `ReplanningRetryPolicy` to be used during navigation for replanning.
`betterProposalAcceptanceMode`	The `BetterProposalAcceptanceMode` to be used during navigation.
`deviationReplanningMode`	The `DeviationReplanningMode` to be used during navigation.
`vehicleProvider`	The `VehicleProvider` to be used during navigation.

HorizonError
Errors that are thrown when removing/adding horizon observer.

Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public enum HorizonError : Error
navigationEngineRegistry
Provides access to currently added engines and allows updating them.

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

public var navigationEngineRegistry: NavigationEngineRegistry
vehicleProvider
The VehicleProvider used by the DefaultTomTomNavigation for providing vehicle updates to the navigation.

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

public let vehicleProvider: VehicleProvider
navigationState
The current NavigationState within DefaultTomTomNavigation.

The initial value is set to idle.

To change DefaultTomTomNavigation/navigationState, see start(), start(navigationOptions:), stop() and setActiveRoutePlan(_:).

To observe changes to DefaultTomTomNavigation/navigationState see NavigationStateChangeObserver.

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

public var navigationState: NavigationState { get }
betterProposalAcceptanceMode
The current BetterProposalAcceptanceMode.

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

public var betterProposalAcceptanceMode: TomTomSDKNavigationEngines.BetterProposalAcceptanceMode { get set }
unitSystem
The unit system to be used within TomTomNavigation.

Once set, it is propagated to other components (e.g. GuidanceEngine) and used for the generation of guidance announcements.

If the UnitSystemType instance is dynamic then unitSystem is resolved based on the country attribute of the current location:
- for “USA” and “PRI” it will resolve to SpecificUnitSystem/imperialFeet.
- for “GBR” it will resolve to SpecificUnitSystem/imperialYards.
- for other countries it will resolve to SpecificUnitSystem/metric.
The default value is UnitSystemType.default.

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

public var unitSystem: UnitSystemType { get set }
language
The current language used within TomTomNavigation in guidance instructions and announcement language. The initial value is Locale.current. To change language, see preferredLanguage.

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

public var language: Locale { get }
preferredLanguage
The preferred language to be used within TomTomNavigation in guidance instructions and announcement language.

The initial value is Locale.current. If the initial language is not supported, en-US will be used instead. Supported languages can be acquired from GuidanceEngine.availableLanguages.

Setting the preferred language updates the route. You can check the updated route language using language. If the specified language is not supported, en-US will be used instead.

To observe language changes, add:
- NavigationLanguageChangeObserver using addLanguageChangeObserver(_:).
Important
This is a Public Preview API. It may be changed or removed at any time.
Declaration
Swift

public var preferredLanguage: Locale { get set }
mapMatchedLocationProvider
Provides a CLLocation for map matching.

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

public var mapMatchedLocationProvider: LocationProvider { get }
locationProvider
Provides a CLLocation for raw GPS position.

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

public var locationProvider: LocationProvider { get set }
eventPublisher
A publishable variable that can be used to receive the same events that the delegate presents

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

public var eventPublisher: AnyPublisher<NavigationEvent, Never> { get }
deviationReplanningMode
Controls how the route deviations are handled.

When set to TomTomSDKNavigationEngines/DeviationReplanningMode/automatic the navigation replans the route automatically. When set to TomTomSDKNavigationEngines/DeviationReplanningMode/none the navigation does not replan the route.

The default value is TomTomSDKNavigationEngines/DeviationReplanningMode/automatic.

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

public var deviationReplanningMode: DeviationReplanningMode { get set }
navigationSnapshot
The current TomTomSDKNavigationEngines/NavigationSnapshot.

navigationSnapshot is nil at the start of navigation in the following situations:
- If the location provider is disabled.
- If the location provider is enabled but unable to find the location.
Note
Once navigationSnapshot is defined, it remains defined throughout the navigation session.

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

public var navigationSnapshot: NavigationSnapshot? { get }


                    
                    
                    addNavigationStateChangeObserver(_:)

Adds a NavigationStateChangeObserver to DefaultTomTomNavigation. The observer is notified of changes to the navigationState.

The call is expected on the main queue. The system keeps a weak reference to the observer.

Important

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

Declaration

Swift

public func addNavigationStateChangeObserver(_ observer: NavigationStateChangeObserver)

Parameters


                                observer

A class that can handle navigation state changes.


                    
                    
                    removeNavigationStateChangeObserver(_:)

Removes the NavigationStateChangeObserver from DefaultTomTomNavigation. There is no need to remove the observer. If the observer is not removed, the system will clean up when the next event is posted. The call is expected on the main queue. Do not call this method from the deinitializer of the observer, unless you are certain that the observer will be destroyed on the main queue.

Important

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

Declaration

Swift

public func removeNavigationStateChangeObserver(_ observer: NavigationStateChangeObserver)

Parameters


                                observer

A class that can handle navigation state changes.


                    
                    
                    addLocationMapMatchingObserver(_:)

Adds a LocationMapMatchingObserver to DefaultTomTomNavigation. The call is expected on the main queue. The system keeps a weak reference to the observer.

Important

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

Declaration

Swift

public func addLocationMapMatchingObserver(_ observer: LocationMapMatchingObserver)

Parameters


                                observer

A class that can handle navigation map matching events.


                    
                    
                    removeLocationMapMatchingObserver(_:)

Removes the LocationMapMatchingObserver from DefaultTomTomNavigation. There is no need to remove the observer. If the observer is not removed, the system will clean up when the next event is posted. The call is expected on the main queue. Do not call this method from the deinitializer of the observer, unless you are certain that the observer will be destroyed on the main queue.

Important

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

Declaration

Swift

public func removeLocationMapMatchingObserver(_ observer: LocationMapMatchingObserver)

Parameters


                                observer

A class that can handle navigation map matching events.


                    
                    
                    addProgressObserver(_:)

Adds a NavigationProgressObserver to DefaultTomTomNavigation. The call is expected on the main queue. The system keeps a weak reference to the observer.

Important

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

Declaration

Swift

public func addProgressObserver(_ observer: NavigationProgressObserver)

Parameters


                                observer

A class that can handle navigation start events.


                    
                    
                    removeProgressObserver(_:)

Removes the NavigationProgressObserver from DefaultTomTomNavigation. There is no need to remove the observer. If the observer is not removed, the system will clean up when the next event is posted. The call is expected on the main queue. Do not call this method from the deinitializer of the observer, unless you are certain that the observer will be destroyed on the main queue.

Important

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

Declaration

Swift

public func removeProgressObserver(_ observer: NavigationProgressObserver)

Parameters


                                observer

A class that can handle navigation progress events.


                    
                    
                    addRouteAddObserver(_:)

Adds a NavigationRouteAddObserver to Navigation. The call is expected on the main queue. The system keeps a weak reference to the observer.

Important

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

Declaration

Swift

public func addRouteAddObserver(_ observer: NavigationRouteAddObserver)

Parameters


                                observer

A class that can handle navigation route added events.


                    
                    
                    removeRouteAddObserver(_:)

Removes the NavigationRouteAddObserver from Navigation. There is no need to remove the observer. If the observer is not removed, the system will clean up when the next event is posted. The call is expected on the main queue. Do not call this method from the deinitializer of the observer, unless you are certain that the observer will be destroyed on the main queue.

Important

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

Declaration

Swift

public func removeRouteAddObserver(_ observer: NavigationRouteAddObserver)

Parameters


                                observer

A class that can handle navigation route added events.


                    
                    
                    addRouteRemoveObserver(_:)

Adds a NavigationRouteRemoveObserver to Navigation. The call is expected on the main queue. The system keeps a weak reference to the observer.

Important

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

Declaration

Swift

public func addRouteRemoveObserver(_ observer: NavigationRouteRemoveObserver)

Parameters


                                observer

A class that can handle navigation route removed events.


                    
                    
                    removeRouteRemoveObserver(_:)

Removes the NavigationRouteRemoveObserver from Navigation. There is no need to remove the observer. If the observer is not removed, the system will clean up when the next event is posted. The call is expected on the main queue. Do not call this method from the deinitializer of the observer, unless you are certain that the observer will be destroyed on the main queue.

Important

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

Declaration

Swift

public func removeRouteRemoveObserver(_ observer: NavigationRouteRemoveObserver)

Parameters


                                observer

A class that can handle navigation route removed events.


                    
                    
                    addRouteUpdateObserver(_:)

Adds a NavigationRouteUpdateObserver to DefaultTomTomNavigation. The call is expected on the main queue. The system keeps a weak reference to the observer.

The system keeps a weak reference to the observer.

Important

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

Declaration

Swift

public func addRouteUpdateObserver(_ observer: NavigationRouteUpdateObserver)

Parameters


                                observer

A class that can handle navigation route updated events.


                    
                    
                    removeRouteUpdateObserver(_:)

Removes the NavigationRouteUpdateObserver from DefaultTomTomNavigation.

There is no need to remove the observer. If the observer is not removed, the system will clean up when the next event is posted. The call is expected on the main queue. Do not call this method from the deinitializer of the observer, unless you are certain that the observer will be destroyed on the main queue.

Important

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

Declaration

Swift

public func removeRouteUpdateObserver(_ observer: NavigationRouteUpdateObserver)

Parameters


                                observer

A class that can handle navigation route updated events.


                    
                    
                    addActiveRouteChangeObserver(_:)

Adds a NavigationActiveRouteChangeObserver to Navigation. The call is expected on the main queue. The system keeps a weak reference to the observer.

Important

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

Declaration

Swift

public func addActiveRouteChangeObserver(_ observer: NavigationActiveRouteChangeObserver)

Parameters


                                observer

A class that can handle navigation active route changed events.


                    
                    
                    removeActiveRouteChangeObserver(_:)

Removes the NavigationActiveRouteChangeObserver from Navigation. There is no need to remove the observer. If the observer is not removed, the system will clean up when the next event is posted. The call is expected on the main queue. Do not call this method from the deinitializer of the observer, unless you are certain that the observer will be destroyed on the main queue.

Important

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

Declaration

Swift

public func removeActiveRouteChangeObserver(_ observer: NavigationActiveRouteChangeObserver)

Parameters


                                observer

A class that can handle navigation active route changed events.


                    
                    
                    addGuidanceUpdateObserver(_:)

Adds a GuidanceUpdateObserver to TomTomNavigation. The call is expected on the main queue. The system keeps a weak reference to the observer.

Important

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

Declaration

Swift

public func addGuidanceUpdateObserver(_ observer: GuidanceUpdateObserver)

Parameters


                                observer

A class that can handle navigation guidance events.


                    
                    
                    removeGuidanceUpdateObserver(_:)

Removes the GuidanceUpdateObserver from TomTomNavigation. There is no need to remove the observer. If the observer is not removed, the system will clean up when the next event is posted. The call is expected on the main queue. Do not call this method from the deinitializer of the observer, unless you are certain that the observer will be destroyed on the main queue.

Important

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

Declaration

Swift

public func removeGuidanceUpdateObserver(_ observer: GuidanceUpdateObserver)

Parameters


                                observer

A class that can handle navigation guidance events.


                    
                    
                    addLaneGuidanceUpdateObserver(_:)

Adds a LaneGuidanceUpdateObserver to TomTomNavigation. The call is expected on the main queue. The system keeps a weak reference to the observer.

Important

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

Declaration

Swift

public func addLaneGuidanceUpdateObserver(_ observer: LaneGuidanceUpdateObserver)

Parameters


                                observer

A class that can handle navigation guidance events.


                    
                    
                    removeLaneGuidanceUpdateObserver(_:)

Removes a LaneGuidanceUpdateObserver from TomTomNavigation. There is no need to remove the observer. If the observer is not removed, the system will clean up when the next event is posted. The call is expected on the main queue. Do not call this method from the deinitializer of the observer, unless you are certain that the observer will be destroyed on the main queue.

Important

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

Declaration

Swift

public func removeLaneGuidanceUpdateObserver(_ observer: LaneGuidanceUpdateObserver)

Parameters


                                observer

A class that can handle navigation guidance events.


                    
                    
                    addGuidanceObserver(_:)

Adds a NavigationGuidanceObserver to Navigation. The call is expected on the main queue. The system keeps a weak reference to the observer.

Important

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

Declaration

Swift

public func addGuidanceObserver(_ observer: NavigationGuidanceObserver)

Parameters


                                observer

A class that can handle navigation guidance events.


                    
                    
                    removeGuidanceObserver(_:)

Removes the NavigationGuidanceObserver from DefaultTomTomNavigation. There is no need to remove the observer. If the observer is not removed, the system will clean up when the next event is posted. The call is expected on the main queue. Do not call this method from the deinitializer of the observer, unless you are certain that the observer will be destroyed on the main queue.

Important

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

Declaration

Swift

public func removeGuidanceObserver(_ observer: NavigationGuidanceObserver)

Parameters


                                observer

A class that can handle navigation guidance events.


                    
                    
                    addLocationContextObserver(_:)

Adds a NavigationLocationContextObserver to DefaultTomTomNavigation. The call is expected on the main queue. The system keeps a weak reference to the observer.

Important

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

Declaration

Swift

public func addLocationContextObserver(_ observer: NavigationLocationContextObserver)

Parameters


                                observer

A class that can handle navigation location context events.


                    
                    
                    removeLocationContextObserver(_:)

Removes the NavigationLocationContextObserver from DefaultTomTomNavigation. There is no need to remove the observer. If the observer is not removed, the system will clean up when the next event is posted. The call is expected on the main queue. Do not call this method from the deinitializer of the observer, unless you are certain that the observer will be destroyed on the main queue.

Important

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

Declaration

Swift

public func removeLocationContextObserver(_ observer: NavigationLocationContextObserver)

Parameters


                                observer

A class that can handle navigation location context events.


                    
                    
                    addDestinationArrivalObserver(_:)

Adds a NavigationDestinationArrivalObserver to DefaultTomTomNavigation. The call is expected on the main queue. The system keeps a weak reference to the observer.

Important

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

Declaration

Swift

public func addDestinationArrivalObserver(_ observer: NavigationDestinationArrivalObserver)

Parameters


                                observer

A class that can handle navigation arrival events.


                    
                    
                    removeDestinationArrivalObserver(_:)

Removes the NavigationDestinationArrivalObserver from DefaultTomTomNavigation. There is no need to remove the observer. If the observer is not removed, the system will clean up when the next event is posted. The call is expected on the main queue. Do not call this method from the deinitializer of the observer, unless you are certain that the observer will be destroyed on the main queue.

Important

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

Declaration

Swift

public func removeDestinationArrivalObserver(_ observer: NavigationDestinationArrivalObserver)

Parameters


                                observer

A class that can handle navigation arrival events.


                    
                    
                    addWaypointArrivalObserver(_:)

Adds a NavigationWaypointArrivalObserver to DefaultTomTomNavigation. The call is expected on the main queue. The system keeps a weak reference to the observer.

Important

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

Declaration

Swift

public func addWaypointArrivalObserver(_ observer: NavigationWaypointArrivalObserver)

Parameters


                                observer

A class that can handle navigation arrival events.


                    
                    
                    removeWaypointArrivalObserver(_:)

Removes the NavigationWaypointArrivalObserver from DefaultTomTomNavigation. There is no need to remove the observer. If the observer is not removed, the system will clean up when the next event is posted. The call is expected on the main queue. Do not call this method from the deinitializer of the observer, unless you are certain that the observer will be destroyed on the main queue.

Important

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

Declaration

Swift

public func removeWaypointArrivalObserver(_ observer: NavigationWaypointArrivalObserver)

Parameters


                                observer

A class that can handle navigation arrival events.


                    
                    
                    addHorizonObserver(_:options:)

Adds a NavigationHorizonObserver to DefaultTomTomNavigation. The call is expected on the main queue. The system keeps a weak reference to the observer.

Throws

HorizonError.observerAlreadyRegistered if this NavigationHorizonObserver object is already added for horizon updates. HorizonError.optionsAlreadyRegistered if these HorizonOptions are already being observed.

Important

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

Declaration

Swift

public func addHorizonObserver(_ observer: NavigationHorizonObserver, options: HorizonOptions) throws

Parameters

`observer`	A class that can handle navigation horizon events. To add a new observer with the same options, the previous one must be removed first. To add different options with the same observer, the previous one must be removed first.
`options`	The options that define the extent of the paths on the horizon and which map attributes to collect.


                    
                    
                    removeHorizonObserver(_:)

Removes the NavigationHorizonObserver from DefaultTomTomNavigation. This method should be called on the deinitialization of the observer. The call is expected on the main queue.

Throws

HorizonError.observerNotRegistered if NavigationHorizonObserver wasn’t added.

Important

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

Declaration

Swift

public func removeHorizonObserver(_ observer: NavigationHorizonObserver) throws

Parameters


                                observer

A class that can handle navigation trip events.


                    
                    
                    addRouteTrackingStateUpdateObserver(_:)

Adds a TomTomSDKNavigation/NavigationRouteTrackingStateUpdateObserver to DefaultTomTomNavigation. The call is expected on the main queue. The system keeps a weak reference to the observer.

Declaration

Swift

public func addRouteTrackingStateUpdateObserver(_ observer: NavigationRouteTrackingStateUpdateObserver)

Parameters


                                observer

A class that can handle navigation follow the route events.


                    
                    
                    removeRouteTrackingStateUpdateObserver(_:)

Removes the TomTomSDKNavigation/NavigationRouteTrackingStateUpdateObserver from DefaultTomTomNavigation. There is no need to remove the observer. If the observer is not removed, the system will clean up when the next event is posted. The call is expected on the main queue. Do not call this method from the deinitializer of the observer, unless you are certain that the observer will be destroyed on the main queue.

Declaration

Swift

public func removeRouteTrackingStateUpdateObserver(_ observer: NavigationRouteTrackingStateUpdateObserver)

Parameters


                                observer

A class that can handle navigation follow the route events.


                    
                    
                    addLanguageChangeObserver(_:)

Adds a NavigationLanguageChangeObserver to DefaultTomTomNavigation. The call is expected on the main queue. The system keeps a weak reference to the observer.

Important

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

Declaration

Swift

public func addLanguageChangeObserver(_ observer: NavigationLanguageChangeObserver)

Parameters


                                observer

A class that can handle navigation language change events.


                    
                    
                    removeLanguageChangeObserver(_:)

Removes the NavigationLanguageChangeObserver from DefaultTomTomNavigation. There is no need to remove the observer. If the observer is not removed, the system will clean up when the next event is posted. The call is expected on the main queue. Do not call this method from the deinitializer of the observer, unless you are certain that the observer will be destroyed on the main queue.

Important

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

Declaration

Swift

public func removeLanguageChangeObserver(_ observer: NavigationLanguageChangeObserver)

Parameters


                                observer

A class that can report on changes to the navigation language.

start()
Starts navigation without specifying a TomTomSDKRoute/Route.

Use this method to start the navigation in free driving mode.

Navigation goes through the following steps:
- Providing the TomTomSDKNavigationEngines/MapMatchingResult via LocationMapMatchingObserver.
- Providing the updated TomTomSDKNavigationEngines/LocationContext via NavigationLocationContextObserver.
- Providing the updated TomTomSDKNavigationEngines/HorizonSnapshot via NavigationHorizonObserver.
As a result of successful action, the following observer is notified:
- NavigationStateChangeObserver, with the state set to freeDriving.
Throws

An error if navigation has already started.

Important

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

public func start() throws


                    
                    
                    start(navigationOptions:)

Starts navigation with the provided NavigationOptions.

Use this method to start the navigation in active guidance mode with the provided TomTomSDKRoute/Route within the NavigationOptions.

Navigation goes through the following steps:

Providing the TomTomSDKNavigationEngines/MapMatchingResult via LocationMapMatchingObserver.
Providing the updated TomTomSDKNavigationEngines/LocationContext via NavigationLocationContextObserver.
Providing the updated TomTomSDKNavigationEngines/HorizonSnapshot via NavigationHorizonObserver.

Additionally, the system performs the following operations for the active, i.e., currently navigated TomTomSDKRoute/Route within the NavigationOptions:

Calculating TomTomSDKNavigationEngines/RouteProgress and updating via NavigationProgressObserver.
Checking all followed routes and deviations via NavigationRouteTrackingStateUpdateObserver.
Generating TomTomSDKNavigationEngines/Guidance via GuidanceUpdateObserver.
Detecting arrival, possibly calling NavigationDestinationArrivalObserver or NavigationWaypointArrivalObserver.

As a result of successful action, the following observer is notified:

NavigationStateChangeObserver, with the state set to activeGuidance.
NavigationRouteAddObserver, with the TomTomSDKRoute/Route and TomTomSDKRoutePlanner/RoutePlanningOptions set in activeRoutePlan, and navigationStarted.
NavigationActiveRouteChangeObserver, with the TomTomSDKRoute/Route set in activeRoutePlan.

Throws

An error if navigation has already started or if NavigationOptions are incompatible with navigation configuration.

Important

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

Declaration

Swift

public func start(navigationOptions: NavigationOptions) throws

Parameters


                                navigationOptions

Details of the navigation options for starting the navigation session. TomTomSDKCommon/Vehicle provided for navigation must be compatible with the given activeRoutePlan.


                    
                    
                    setActiveRoutePlan(_:)

Updates the route plan during ongoing navigation.

The following listeners are notified:

NavigationRouteUpdateObserver/didUpdateRoute(route:options:reason:) with the updated Route, RoutePlanniningOptions and RouteUpdatedReason/manuallyUpdated if current route does not contain the provided routeId, the method does not update the route.
didChangeActiveRoute(route:) with the Route if active route has changed.
didRemoveRoute(route:reason:) with all other routes except the active Route and manual.

Throws

An error if RoutePlan is incompatible with navigation configuration.

Important

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

Declaration

Swift

public func setActiveRoutePlan(_ routePlan: RoutePlan) throws

Parameters


                                routePlan

The RoutePlan to be set as active. TomTomSDKCommon/Vehicle provided for navigation must be compatible with the given RoutePlan.


                    
                    
                    selectActiveRoute(routeId:)

Selects the Route with provided routeID as active.

The navigation switches to navigate along the desired route and the following listeners are notified:

didChangeActiveRoute(route:) with Route selected by routeID.
didRemoveRoute(route:reason:) with the previously active Route and manual If theRoute corresponding to the given routeId is not available, changing does not occur.

Declaration

Swift

public func selectActiveRoute(routeId: UUID)

Parameters


                                routeId

UUID id of route that should be selected.


                    
                    
                    departFromWaypoint(waypoint:)

Marks a departure from the given waypoint independently from ArrivalDetectionEngine/hasArrivedAtWaypoint.

The specified waypoint is marked as having been departed from and NavigationWaypointArrivalObserver are notified about this via NavigationDestinationArrivalObserver/didArriveAtWaypoint(waypoint:on:). Notification via NavigationDestinationArrivalObserver/didArriveAtWaypoint(waypoint:on:) completes arrival detection for that particular waypoint. Navigation switches to arrival detection for the next waypoint, if one is present.

Prerequisites for this action:

A didArriveAtWaypoint(waypoint:on:) notification was previously issued for this waypoint.
No didDepartFromWaypoint(waypoint:on:) notification was previously issued for this waypoint.

Throws

nextWaypointError if calling requirements are not met.

Declaration

Swift

public func departFromWaypoint(waypoint: RouteStop) throws

Parameters


                                waypoint

The waypoint to depart from.

stop()
Stops current navigation session and clears data related to it.

If start has not been called previously, this method has no effect.

As a result of successful action, the following observer is notified:
- NavigationStateChangeObserver, with the state set to idle.
Important
This is a Public Preview API. It may be changed or removed at any time.
Declaration
Swift

public func stop()