Navigation Class Reference


                    
                    
                    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 }


                    
                    
                    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.


                    
                    
                    addHorizonObserver(_:)

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

Warning

This is an experimental API. It may be changed or removed at any time without notice. Use of this API is strongly discouraged.

Declaration

Swift

public func addHorizonObserver(_ observer: NavigationHorizonObserver)

Parameters


                                observer

A class that can handle navigation horizon events.


                    
                    
                    removeHorizonObserver(_:)

Removes the NavigationHorizonObserver 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.

Warning

This is an experimental API. It may be changed or removed at any time without notice. Use of this API is strongly discouraged.

Declaration

Swift

public func removeHorizonObserver(_ observer: NavigationHorizonObserver)

Parameters


                                observer

A class that can handle navigation trip 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()

Declaration

Swift

public func start()


                    
                    
                    start(navigationOptions:)

Declaration

Swift

public func start(navigationOptions: NavigationOptions)


                    
                    
                    update(routePlan:)

Declaration

Swift

public func update(routePlan: RoutePlan)


                    
                    
                    stop()

Declaration

Swift

public func stop()


                    
                    
                    navigationSnapshot()

Declaration

Swift

public func navigationSnapshot() -> NavigationSnapshot?


                    
                    
                    NavigationMode

Important

This is a Public Preview API. It may be changed or removed at any time. The mode of navigation after start.

Declaration

Swift

public enum NavigationMode