DefaultTomTomNavigation Class Reference


                    
                    
                    navigationEngineRegistry

Provides access to current registered engines and allows updating them.

Declaration

Swift

public var navigationEngineRegistry: NavigationEngineRegistry


                    
                    
                    vehicleProvider

The VehicleProvider used by the Navigation for providing vehicle updates to the navigation.

Declaration

Swift

public let vehicleProvider: VehicleProvider


                    
                    
                    unitSystem

The unit system used by the SDK.

Propagated to other components (e.g., GuidanceEngine) with NavigationSnapshot.

If the UnitSystemType instance is dynamic, then unit system is resolved based on current location country:

“USA” and “PRI” - SpecificUnitSystem/imperialFeet.
“GBR” - SpecificUnitSystem/imperialYards.
Other countries - SpecificUnitSystem/metric.

Declaration

Swift

public var unitSystem: UnitSystemType { get set }


                    
                    
                    language

The language used by Navigation SDK, stored as a Locale. Propagated to other components (e.g. GuidanceEngine) with NavigationSnapshot.

Note

Defaults to current system locale.

Declaration

Swift

public var language: Locale { get set }


                    
                    
                    mapMatchedLocationProvider

Provides a CLLocation for map matching.

Declaration

Swift

public var mapMatchedLocationProvider: LocationProvider { get }


                    
                    
                    locationProvider

Provides a CLLocation for raw GPS position.

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

Declaration

Swift

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


                    
                    
                    addNavigationObserver(_:)

Adds a NavigationObserver to Navigation. Keeps a weak pointer to the observer. It is expected to be called on the main queue.

Declaration

Swift

public func addNavigationObserver(_ observer: NavigationObserver)

Parameters


                                observer

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


                    
                    
                    removeNavigationObserver(_:)

Removes the NavigationObserver from Navigation. There is no need to call this function from the deinit of the observer. It is expected to be called on the main queue.

Declaration

Swift

public func removeNavigationObserver(_ observer: NavigationObserver)

Parameters


                                observer

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


                    
                    
                    addStartObserver(_:)

Adds a NavigationStartObserver to Navigation. Keeps a weak pointer to the observer. It is expected to be called on the main queue.

Declaration

Swift

public func addStartObserver(_ observer: NavigationStartObserver)

Parameters


                                observer

A class that can handle navigation start events.


                    
                    
                    removeStartObserver(_:)

Removes the NavigationStartObserver from Navigation. There is no need to call this function from the deinit of the observer. It is expected to be called on the main queue.

Declaration

Swift

public func removeStartObserver(_ observer: NavigationStartObserver)

Parameters


                                observer

A class that can handle navigation start events.


                    
                    
                    addMapMatchingObserver(_:)

Adds a NavigationMapMatchingObserver to Navigation. Keeps a weak pointer to the observer. It is expected to be called on the main queue.

Declaration

Swift

public func addMapMatchingObserver(_ observer: NavigationMapMatchingObserver)

Parameters


                                observer

A class that can handle navigation map matching events.


                    
                    
                    removeMapMatchingObserver(_:)

Removes the NavigationMapMatchingObserver from Navigation. There is no need to call this function from the deinit of the observer. It is expected to be called on the main queue.

Declaration

Swift

public func removeMapMatchingObserver(_ observer: NavigationMapMatchingObserver)

Parameters


                                observer

A class that can handle navigation map matching events.


                    
                    
                    addProgressObserver(_:)

Adds a NavigationProgressObserver to Navigation. Keeps a weak pointer to the observer. It is expected to be called on the main queue.

Declaration

Swift

public func addProgressObserver(_ observer: NavigationProgressObserver)

Parameters


                                observer

A class that can handle navigation start events.


                    
                    
                    removeProgressObserver(_:)

Removes the NavigationProgressObserver from Navigation. There is no need to call this function from the deinit of the observer. It is expected to be called on the main queue.

Declaration

Swift

public func removeProgressObserver(_ observer: NavigationProgressObserver)

Parameters


                                observer

A class that can handle navigation progress events.


                    
                    
                    addRouteObserver(_:)

Adds a NavigationRouteObserver to Navigation. Keeps a weak pointer to the observer. It is expected to be called on the main queue.

Declaration

Swift

public func addRouteObserver(_ observer: NavigationRouteObserver)

Parameters


                                observer

A class that can handle navigation route events.


                    
                    
                    removeRouteObserver(_:)

Removes the NavigationRouteObserver from Navigation. There is no need to call this function from the deinit of the observer. It is expected to be called on the main queue.

Declaration

Swift

public func removeRouteObserver(_ observer: NavigationRouteObserver)

Parameters


                                observer

A class that can handle navigation route events.


                    
                    
                    addGuidanceObserver(_:)

Adds a NavigationGuidanceObserver to Navigation. Keeps a weak pointer to the observer. It is expected to be called on the main queue.

Declaration

Swift

public func addGuidanceObserver(_ observer: NavigationGuidanceObserver)

Parameters


                                observer

A class that can handle navigation guidance events.


                    
                    
                    removeGuidanceObserver(_:)

Removes the NavigationGuidanceObserver from Navigation. There is no need to call this function from the deinit of the observer. It is expected to be called on the main queue.

Declaration

Swift

public func removeGuidanceObserver(_ observer: NavigationGuidanceObserver)

Parameters


                                observer

A class that can handle navigation guidance events.


                    
                    
                    addLocationContextObserver(_:)

Adds a NavigationLocationContextObserver to Navigation. Keeps a weak pointer to the observer. It is expected to be called on the main queue.

Declaration

Swift

public func addLocationContextObserver(_ observer: NavigationLocationContextObserver)

Parameters


                                observer

A class that can handle navigation location context events.


                    
                    
                    removeLocationContextObserver(_:)

Removes the NavigationLocationContextObserver from Navigation. There is no need to call this function from the deinit of the observer. It is expected to be called on the main queue.

Declaration

Swift

public func removeLocationContextObserver(_ observer: NavigationLocationContextObserver)

Parameters


                                observer

A class that can handle navigation location context events.


                    
                    
                    addArrivalObserver(_:)

Adds a NavigationArrivalObserver to Navigation. Keeps a weak pointer to the observer. It is expected to be called on the main queue.

Declaration

Swift

public func addArrivalObserver(_ observer: NavigationArrivalObserver)

Parameters


                                observer

A class that can handle navigation arrival events.


                    
                    
                    removeArrivalObserver(_:)

Removes the NavigationArrivalObserver from Navigation. There is no need to call this function from the deinit of the observer. It is expected to be called on the main queue.

Declaration

Swift

public func removeArrivalObserver(_ observer: NavigationArrivalObserver)

Parameters


                                observer

A class that can handle navigation arrival events.


                    
                    
                    addRouteTrackingStateUpdateObserver(_:)

Adds a NavigationRouteTrackingStateUpdateObserver to Navigation. Keeps a weak pointer to the observer. It is expected to be called on the main queue.

Important

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

Declaration

Swift

public func addRouteTrackingStateUpdateObserver(_ observer: NavigationRouteTrackingStateUpdateObserver)

Parameters


                                observer

A class that can handle navigation follow the route events.


                    
                    
                    removeRouteTrackingStateUpdateObserver(_:)

Removes the NavigationRouteTrackingStateUpdateObserver from Navigation. There is no need to call this function from the deinit of the observer. It is expected to be called on the main queue.

Important

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

Declaration

Swift

public func removeRouteTrackingStateUpdateObserver(_ observer: NavigationRouteTrackingStateUpdateObserver)

Parameters


                                observer

A class that can handle navigation follow the route events.


                    
                    
                    addErrorObserver(_:)

Adds a NavigationErrorObserver to Navigation. Keeps a weak pointer to the observer. It is expected to be called on the main queue.

Declaration

Swift

public func addErrorObserver(_ observer: NavigationErrorObserver)

Parameters


                                observer

A class that can handle navigation error events.


                    
                    
                    removeErrorObserver(_:)

Removes the NavigationErrorObserver from Navigation. There is no need to call this function from the deinit of the observer. It is expected to be called on the main queue.

Declaration

Swift

public func removeErrorObserver(_ observer: NavigationErrorObserver)

Parameters


                                observer

A class that can handle navigation error events.


                    
                    
                    start()

Starts navigation with the default routing.

Declaration

Swift

public func start()


                    
                    
                    start(navigationOptions:)

Starts navigation with a navigation plan.

Warning

NavigationOptions.alternativeRoutePlans is not used as multi-route navigation is not supported.

Declaration

Swift

public func start(navigationOptions: NavigationOptions)

Parameters


                                navigationOptions

NavigationOptions to be used during navigation session.


                    
                    
                    update(navigationOptions:)

Updates the route plan during ongoing navigation.

navigationOptions: NavigationOptions to be used during a navigation session.

Declaration

Swift

public func update(navigationOptions: NavigationOptions)


                    
                    
                    acceptBetterProposal()

Accept the better route proposed and update the route plan during navigation.

Declaration

Swift

public func acceptBetterProposal()


                    
                    
                    markWaypointAsVisited(waypoint:)

Manually marks the waypoint as visited. This action requires that the waypoint was previously announced as reached via NavigationArrivalObserver and that it has not been announced as visited via NavigationArrivalObserver. Throws NavigationProcessingError.nextWaypointError if calling requirements are not met. The navigation service marks the waypoint as visited, and NavigationArrivalObserver is notified.

waypoint: The waypoint to mark as visited.

Declaration

Swift

public func markWaypointAsVisited(waypoint: RouteStop) throws


                    
                    
                    stop()

Stops the current navigation.

Declaration

Swift

public func stop()