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(routePlan:) Default implementation

    Updates the route plan during ongoing navigation.

    Default Implementation

    Declaration

    Swift

    func update(routePlan: RoutePlan)

    Parameters

    routePlan

    RoutePlan to be used during navigation session.

  • Stops the current navigation.

    Declaration

    Swift

    func stop()

  • Returns the current NavigationSnapshot. The return value is nil when navigation is not yet started or already stopped.

    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

    func navigationSnapshot() -> NavigationSnapshot?