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

    Currently NavigationOptions.alternativeRoutePlans is not used as multi-route navigation is not yet 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()

  • Stops the current navigation.

    Declaration

    Swift

    func stop()