NavigationRouteObserver

public protocol NavigationRouteObserver : Observer

An observer that receives navigation route events.

Important

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

  • Reports that the driver has deviated from the current route.

    Declaration

    Swift

    func didDeviateFromRoute(currentRoute: Route, location: GeoLocation)

    Parameters

    currentRoute

    The current route.
    location

    The location at which the driver has deviated from the route.

  • Reports that an updated route plan is available.

    Declaration

    Swift

    func didProposeRoutePlan(routePlan: RoutePlan, reason: RouteReplanningReason)

    Parameters

    routePlan

    The updated route plan.
    reason

    The reason for the proposal, and how the new route is different from the previous route.

  • Reports that route has been replanned.

    Declaration

    Swift

    func didReplanRoute(replannedRoute: Route, reason: RouteReplanningReason)

    Parameters

    replannedRoute

    The replanned route.
    reason

    The reason for replanning, and how the new route is different from the previous route.

  • Reports that the set of routes in the current navigation session has changed. For example, additions of better proposals or replannings of a route will trigger it.

    Declaration

    Swift

    func didChangeRoutes(navigatedRoutes: NavigatedRoutes)

    Parameters

    navigatedRoutes

    The currently navigated routes.

  • Reports that route has been replanned due to Language change.

    Declaration

    Swift

    func didReplanRouteOnLanguageChange(replannedRoute: Route, reason: RouteReplanningReason, language: Locale)

    Parameters

    replannedRoute

    The replanned route.
    reason

    The reason for replanning, and how the new route is different from the previous route.
    language

    The new language in use.