Navigation Class Reference
Navigation
public class Navigation : EngineActionsThe Navigation object defines the functionality of the navigation.
Important
This is a Public Preview API. It may be changed or removed at any time.-
The unit system used by the SDK.
Propagated to other components (e.g.
GuidanceEngine) withNavigationSnapshot.If the
UnitSystemTypeinstance 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 } - “USA” and “PRI” -
-
The language used by Navigation SDK, stored as a Locale. Propagated to other components (e.g.
GuidanceEngine) withNavigationSnapshot.Note
Defaults to current system locale.Declaration
Swift
public var language: Locale { get set } -
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 } -
Adds a
NavigationObservertoNavigation. 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
observerA class that can handle all navigation events except for error events.
-
Removes the
NavigationObserverfromNavigation. 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
observerA class that can handle all navigation events except for error events.
-
Adds a
NavigationStartObservertoNavigation. 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
observerA class that can handle navigation start events.
-
Removes the
NavigationStartObserverfromNavigation. 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
observerA class that can handle navigation start events.
-
Adds a
NavigationMapMatchingObservertoNavigation. 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
observerA class that can handle navigation map matching events.
-
Removes the
NavigationMapMatchingObserverfromNavigation. 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
observerA class that can handle navigation map matching events.
-
Adds a
NavigationProgressObservertoNavigation. 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
observerA class that can handle navigation start events.
-
Removes the
NavigationProgressObserverfromNavigation. 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
observerA class that can handle navigation progress events.
-
Adds a
NavigationRouteObservertoNavigation. 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
observerA class that can handle navigation route events.
-
Removes the
NavigationRouteObserverfromNavigation. 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
observerA class that can handle navigation route events.
-
Adds a
NavigationGuidanceObservertoNavigation. 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
observerA class that can handle navigation guidance events.
-
Removes the
NavigationGuidanceObserverfromNavigation. 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
observerA class that can handle navigation guidance events.
-
Adds a
NavigationLocationContextObservertoNavigation. 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
observerA class that can handle navigation location context events.
-
Removes the
NavigationLocationContextObserverfromNavigation. 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
observerA class that can handle navigation location context events.
-
Adds a
NavigationArrivalObservertoNavigation. 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
observerA class that can handle navigation arrival events.
-
Removes the
NavigationArrivalObserverfromNavigation. 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
observerA class that can handle navigation arrival events.
-
Adds a
NavigationErrorObservertoNavigation. 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
observerA class that can handle navigation error events.
-
Removes the
NavigationErrorObserverfromNavigation. 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
observerA class that can handle navigation error events.
-
Declaration
Swift
public func start() -
Declaration
Swift
public func start(navigationOptions: NavigationOptions) -
Declaration
Swift
public func update(navigationOptions: NavigationOptions) -
Declaration
Swift
public func acceptBetterProposal() -
Declaration
Swift
public func stop() -
Declaration
Swift
@available(*, deprecated, message: "This is an experimental API. It may be changed or removed at any time without notice. Use of this API is strongly discouraged.") public func navigationSnapshot() -> NavigationSnapshot?
-
The mode of navigation after start.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public enum NavigationMode
-
OptionsError contains information about any problems that occur during navigation . The detailed meaning of each error is provided via the
messagevariable.Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public enum OptionsError : Error