EngineActions

public protocol EngineActions

EngineActions defines the actions and properties provided by the the navigation service.

Important

This is a Public Preview API. It may be changed or removed at any time.
  • start() Default implementation

    Starts navigation with the default routing.

    Default Implementation

    Declaration

    Swift

    func start()
  • start(navigationOptions:) Default implementation

    Starts navigation with a navigation plan.

    Warning

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

    Default Implementation

    Declaration

    Swift

    func start(navigationOptions: NavigationOptions)

    Parameters

    navigationOptions

    NavigationOptions to be used during navigation session.
  • update(navigationOptions:) Default implementation

    Updates the route plan during ongoing navigation.

    Default Implementation

    Declaration

    Swift

    func update(navigationOptions: NavigationOptions)

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

    Declaration

    Swift

    func acceptBetterProposal()

  • Manually marks the Waypoint as visited. This action requires that 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 Waypoint as visited, and NavigationArrivalObserver is notified.

    • waypoint: The Waypoint of visitation.

    Declaration

    Swift

    func markWaypointAsVisited(waypoint: Waypoint) throws

  • Stops the current navigation.

    Declaration

    Swift

    func stop()