update

abstract fun update(navigationOptions: NavigationOptions)

Updates the navigation session with a Route from a provided NavigationOptions. If the navigation was started with a Route then this method will replace the current Route with the provided one. If the navigation was started without a Route then this method will start navigating on the provided Route. Note that the initial instances of navigation engines will be used in the new navigation session.

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

Parameters

navigationOptions

Details of the navigation options for updating the navigation session.

Throws

if vehicle used for navigation is incompatible with the given route plan.