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(onError:)

Starts navigation with the default routing.

Swift

func start(onError: NavigationStartErrorCompletion?)


                                onError

The NavigationStartErrorCompletion to call if any errors occur during navigation.


                    
                    
                    start(routePlan:onError:)

Starts navigation with a custom route plan.

Swift

func start(routePlan: RoutePlan, onError: NavigationStartErrorCompletion?)

`routePlan`	`RoutePlan` to be used during navigation session
`onError`	The NavigationStartErrorCompletion to call if any errors occur during navigation.


                    
                    
                    update(routePlan:onError:)

Updates the route plan during ongoing navigation.

Swift

func update(routePlan: RoutePlan, onError: NavigationStartErrorCompletion?)

`routePlan`	`RoutePlan` to be used during navigation session
`onError`	The NavigationStartErrorCompletion to call if any errors occur during navigation.