incrementRouteContents
abstract fun incrementRouteContents(routeIncrementOptions: RouteIncrementOptions): Result<Route, RoutingError>
Content copied to clipboard
Synchronously calculates route contents (instructions, lane guidance) within its certain part using the provided RouteIncrementOptions object. If the call succeeds, returns a Route. If it fails, returns a RoutingError.
Note: Route ETA should be updated outside the incrementRouteContents call
Note: It's currently expected that only following Route contents will be updated: Route.legs(i).instructions Route.sections.laneSections
Important: This is a Public Preview API. It may be changed or removed at any time.
Return
If the call succeeds, returns a Route. If it fails, returns a RoutingError.
Parameters
routeIncrementOptions
Route options needed to calculate route contents.