TomTomNavigation Protocol Reference


                    
                    
                    navigationEngineRegistry

Provides access to current registered engines and allows updating them.

Important

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

Declaration

Swift

var navigationEngineRegistry: NavigationEngineRegistry { get set }


                    
                    
                    vehicleProvider

The VehicleProvider used by the TomTomNavigation 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

var vehicleProvider: VehicleProvider { get }


                    
                    
                    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

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

var locationProvider: LocationProvider { get set }


                    
                    
                    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.

Declaration

Swift

var deviationReplanningMode: DeviationReplanningMode { 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 resolves to SpecificUnitSystem/imperialFeet.
for “GBR” it resolves to SpecificUnitSystem/imperialYards.
for other countries it resolves to SpecificUnitSystem/metric.

The default value is UnitSystemType.default.

Declaration

Swift

var unitSystem: UnitSystemType { get set }


                    
                    
                    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(_:).

Declaration

Swift

var preferredLanguage: Locale { 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.

Declaration

Swift

var language: Locale { get }


                    
                    
                    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

var eventPublisher: AnyPublisher<NavigationEvent, Never> { get }


                    
                    
                    navigationState

The current NavigationState within TomTomNavigation.

The initial value is set to NavigationState.idle.

To change navigationState, see start(), start(navigationOptions:), stop(), TomTomNavigation/resume(navigationResumeSnapshot:) and selectActiveRoute(routeId:).

To observe changes to navigationState see NavigationStateChangeObserver.

Important

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

Declaration

Swift

var navigationState: NavigationState { get }


                    
                    
                    start()

Starts navigation without Route and didChangeNavigationState(navigationState:) is notified with the state set to freeDriving.

Important

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

Declaration

Swift

func start()


                    
                    
                    start(navigationOptions:)

Starts navigation with a navigation plan. The following listeners are notified:

didChangeNavigationState(navigationState:) is notified with the state set to activeGuidance.
didAddRoute(route:options:reason:) with the Route, RoutePlanniningOptions and navigationStarted.
didChangeActiveRoute(route:) with Route.

Important

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

Declaration

Swift

func start(navigationOptions: NavigationOptions)

Parameters


                                navigationOptions

NavigationOptions to be used during the navigation session.


                    
                    
                    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.

Important

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

Declaration

Swift

func setActiveRoutePlan(_ routePlan: RoutePlan)

Parameters


                                routePlan

The RoutePlan to be set as active.


                    
                    
                    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

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

func departFromWaypoint(waypoint: RouteStop) throws

Parameters


                                waypoint

The waypoint to depart from.


                    
                    
                    stop()

Stops the current navigation session if it is running and clears data related to it. didChangeNavigationState(navigationState:) is notified with the state set to idle.

Important

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

Declaration

Swift

func stop()


                    
                    
                    addNavigationStateChangeObserver(_:)

Adds a NavigationStateChangeObserver to TomTomNavigation. The call is expected on the main queue.

Important

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

Declaration

Swift

func addNavigationStateChangeObserver(_ observer: NavigationStateChangeObserver)

Parameters


                                observer

A class that can handle navigation state changes.


                    
                    
                    removeNavigationStateChangeObserver(_:)

Removes the NavigationStateChangeObserver from TomTomNavigation. The call is expected on the main queue.

Important

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

Declaration

Swift

func removeNavigationStateChangeObserver(_ observer: NavigationStateChangeObserver)

Parameters


                                observer

A class that can handle navigation state changes.


                    
                    
                    addNavigationObserver(_:)

Adds a NavigationObserver to TomTomNavigation. The call is expected on the main queue.

Important

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

Declaration

Swift

func addNavigationObserver(_ observer: NavigationObserver)

Parameters


                                observer

A class that can handle all navigation events except for error events.


                    
                    
                    removeNavigationObserver(_:)

Removes the NavigationObserver from TomTomNavigation. The call is expected on the main queue.

Important

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

Declaration

Swift

func removeNavigationObserver(_ observer: NavigationObserver)

Parameters


                                observer

A class that can handle all navigation events except for error events.


                    
                    
                    addLocationMapMatchingObserver(_:)

Adds a LocationMapMatchingObserver to TomTomNavigation. The call is expected on the main queue.

Declaration

Swift

func addLocationMapMatchingObserver(_ observer: LocationMapMatchingObserver)

Parameters


                                observer

A class that can handle navigation map matching events.


                    
                    
                    removeLocationMapMatchingObserver(_:)

Removes the LocationMapMatchingObserver from TomTomNavigation. The call is expected on the main queue.

Declaration

Swift

func removeLocationMapMatchingObserver(_ observer: LocationMapMatchingObserver)

Parameters


                                observer

A class that can handle navigation map matching events.


                    
                    
                    addProgressObserver(_:)

Adds a NavigationProgressObserver to TomTomNavigation. The call is expected on the main queue.

Important

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

Declaration

Swift

func addProgressObserver(_ observer: NavigationProgressObserver)

Parameters


                                observer

A class that can handle navigation start events.


                    
                    
                    removeProgressObserver(_:)

Removes the NavigationProgressObserver from TomTomNavigation. The call is expected on the main queue.

Important

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

Declaration

Swift

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.

Important

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

Declaration

Swift

func addRouteAddObserver(_ observer: NavigationRouteAddObserver)

Parameters


                                observer

A class that can handle navigation route added events.


                    
                    
                    removeRouteAddObserver(_:)

Removes the NavigationRouteAddObserver from Navigation. The call is expected on the main queue.

Important

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

Declaration

Swift

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.

Important

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

Declaration

Swift

func addRouteRemoveObserver(_ observer: NavigationRouteRemoveObserver)

Parameters


                                observer

A class that can handle navigation route removed events.


                    
                    
                    removeRouteRemoveObserver(_:)

Removes the NavigationRouteRemoveObserver from Navigation. The call is expected on the main queue.

Important

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

Declaration

Swift

func removeRouteRemoveObserver(_ observer: NavigationRouteRemoveObserver)

Parameters


                                observer

A class that can handle navigation route removed events.


                    
                    
                    addRouteUpdateObserver(_:)

Adds a NavigationRouteUpdateObserver 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

func addRouteUpdateObserver(_ observer: NavigationRouteUpdateObserver)

Parameters


                                observer

A class that can handle navigation route updated events.


                    
                    
                    removeRouteUpdateObserver(_:)

Removes the NavigationRouteUpdateObserver from TomTomNavigation. There is no need to remove the observer. If the observer is not removed, the system cleans 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

func removeRouteUpdateObserver(_ observer: NavigationRouteUpdateObserver)

Parameters


                                observer

A class that can handle navigation route updated events.


                    
                    
                    addGuidanceUpdateObserver(_:)

Adds a GuidanceUpdateObserver that notifies of new TomTomSDKNavigationEngines.Guidance instances. This is notified whenever there is a change in location and the TomTomSDKNavigationEngines.GuidanceEngine successfully generates a new TomTomSDKNavigationEngines.Guidance.

Precondition

The call is expected on the main queue.

Declaration

Swift

func addGuidanceUpdateObserver(_ observer: GuidanceUpdateObserver)

Parameters


                                observer

The GuidanceUpdateObserver to be added.


                    
                    
                    removeGuidanceUpdateObserver(_:)

Removes a previously added GuidanceUpdateObserver. This method allows you to stop receiving updates about guidance changes.

Precondition

The call is expected on the main queue.

Declaration

Swift

func removeGuidanceUpdateObserver(_ observer: GuidanceUpdateObserver)

Parameters


                                observer

The GuidanceUpdateObserver to be removed.


                    
                    
                    addLaneGuidanceUpdateObserver(_:)

Adds a LaneGuidanceUpdateObserver to observe and handle new TomTomSDKNavigationEngines.LaneGuidance instances. This is notified whenever there is a change in location and the TomTomSDKNavigationEngines.GuidanceEngine successfully generates a new lane guidance.

Precondition

The call is expected on the main queue.

Declaration

Swift

func addLaneGuidanceUpdateObserver(_ observer: LaneGuidanceUpdateObserver)

Parameters


                                observer

The LaneGuidanceUpdateObserver to be added.


                    
                    
                    removeLaneGuidanceUpdateObserver(_:)

Removes a previously added LaneGuidanceUpdateObserver. This method allows you to stop receiving updates about lane guidance changes.

Precondition

The call is expected on the main queue.

Declaration

Swift

func removeLaneGuidanceUpdateObserver(_ observer: LaneGuidanceUpdateObserver)

Parameters


                                observer

The LaneGuidanceUpdateObserver to be removed.


                    
                    
                    addActiveRouteChangeObserver(_:)

Adds a NavigationActiveRouteChangeObserver to Navigation. The call is expected on the main queue.

Important

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

Declaration

Swift

func addActiveRouteChangeObserver(_ observer: NavigationActiveRouteChangeObserver)

Parameters


                                observer

A class that can handle navigation active route changed events.


                    
                    
                    removeActiveRouteChangeObserver(_:)

Removes the NavigationActiveRouteChangeObserver from Navigation. The call is expected on the main queue.

Important

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

Declaration

Swift

func removeActiveRouteChangeObserver(_ observer: NavigationActiveRouteChangeObserver)

Parameters


                                observer

A class that can handle navigation active route changed events.


                    
                    
                    addGuidanceObserver(_:)

Adds a NavigationGuidanceObserver to Navigation. The call is expected on the main queue.

Declaration

Swift

@available(*, deprecated, message: "This API is deprecated and will be removed with the next major release.\nPlease use TomTomNavigation.addGuidanceUpdateObserver(_:﹚ and TomTomNavigation.addLaneGuidanceUpdateObserver(_:﹚ instead.")
func addGuidanceObserver(_ observer: NavigationGuidanceObserver)

Parameters


                                observer

A class that can handle navigation guidance events.


                    
                    
                    removeGuidanceObserver(_:)

Removes the NavigationGuidanceObserver from TomTomNavigation. The call is expected on the main queue.

Declaration

Swift

@available(*, deprecated, message: "This API is deprecated and will be removed with the next major release.\nPlease use TomTomNavigation.removeGuidanceUpdateObserver(_:﹚ and TomTomNavigation.removeLaneGuidanceUpdateObserver(_:﹚ instead.")
func removeGuidanceObserver(_ observer: NavigationGuidanceObserver)

Parameters


                                observer

A class that can handle navigation guidance events.


                    
                    
                    addLocationContextObserver(_:)

Adds a NavigationLocationContextObserver to TomTomNavigation. The call is expected on the main queue.

Declaration

Swift

func addLocationContextObserver(_ observer: NavigationLocationContextObserver)

Parameters


                                observer

A class that can handle navigation location context events.


                    
                    
                    removeLocationContextObserver(_:)

Removes the NavigationLocationContextObserver from TomTomNavigation. The call is expected on the main queue.

Declaration

Swift

func removeLocationContextObserver(_ observer: NavigationLocationContextObserver)

Parameters


                                observer

A class that can handle navigation location context events.


                    
                    
                    addDestinationArrivalObserver(_:)

Adds a NavigationDestinationArrivalObserver to TomTomNavigation. The call is expected on the main queue.

Declaration

Swift

func addDestinationArrivalObserver(_ observer: NavigationDestinationArrivalObserver)

Parameters


                                observer

A class that can handle navigation destination arrival events.


                    
                    
                    removeDestinationArrivalObserver(_:)

Removes the NavigationDestinationArrivalObserver from TomTomNavigation. The call is expected on the main queue.

Declaration

Swift

func removeDestinationArrivalObserver(_ observer: NavigationDestinationArrivalObserver)

Parameters


                                observer

A class that can handle navigation destination arrival events.


                    
                    
                    addWaypointArrivalObserver(_:)

Adds a NavigationWaypointArrivalObserver to TomTomNavigation. The call is expected on the main queue.

Declaration

Swift

func addWaypointArrivalObserver(_ observer: NavigationWaypointArrivalObserver)

Parameters


                                observer

A class that can handle navigation waypoint arrival events.


                    
                    
                    removeWaypointArrivalObserver(_:)

Removes the NavigationWaypointArrivalObserver from TomTomNavigation. The call is expected on the main queue.

Declaration

Swift

func removeWaypointArrivalObserver(_ observer: NavigationWaypointArrivalObserver)

Parameters


                                observer

A class that can handle navigation waypoint arrival events.


                    
                    
                    addHorizonObserver(_:options:)

Adds a NavigationHorizonObserver to TomTomNavigation. The call is expected on the main queue.

Throws

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

Declaration

Swift

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 TomTomNavigation. 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.

Declaration

Swift

func removeHorizonObserver(_ observer: NavigationHorizonObserver) throws

Parameters


                                observer

A class that can handle navigation trip events.


                    
                    
                    addRouteTrackingStateUpdateObserver(_:)

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

Declaration

Swift

func addRouteTrackingStateUpdateObserver(_ observer: NavigationRouteTrackingStateUpdateObserver)

Parameters


                                observer

A class that can handle navigation follow the route events.


                    
                    
                    removeRouteTrackingStateUpdateObserver(_:)

Removes the TomTomSDKNavigation/NavigationRouteTrackingStateUpdateObserver from TomTomNavigation. The call is expected on the main queue.

Declaration

Swift

func removeRouteTrackingStateUpdateObserver(_ observer: NavigationRouteTrackingStateUpdateObserver)

Parameters


                                observer

A class that can handle navigation follow the route events.


                    
                    
                    addLanguageChangeObserver(_:)

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

Declaration

Swift

func addLanguageChangeObserver(_ observer: NavigationLanguageChangeObserver)

Parameters


                                observer

A class that can handle navigation language change events.


                    
                    
                    removeLanguageChangeObserver(_:)

Removes the NavigationLanguageChangeObserver from TomTomNavigation. There is no need to remove the observer. If the observer is not removed, the system cleans 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

func removeLanguageChangeObserver(_ observer: NavigationLanguageChangeObserver)

Parameters


                                observer

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


                    
                    
                    betterProposalAcceptanceMode

The current BetterProposalAcceptanceMode.

Declaration

Swift

var betterProposalAcceptanceMode: BetterProposalAcceptanceMode { get set }


                    
                    
                    navigationSnapshot

The current TomTomSDKNavigationEngines/NavigationSnapshot.

The snapshot is nil if the navigation is not yet started or has already been stopped.

Complexity

The property demonstrates O(n).

Important

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

Declaration

Swift

var navigationSnapshot: NavigationSnapshot? { get }

Return Value

The current NavigationSnapshot if navigation is not stopped.