DynamicRoutingApi

interface DynamicRoutingApi

Entry point to plan routes that can be dynamically updated, for example through continuous replanning as the route is driven.

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

Functions

Link copied to clipboard
abstract fun backToRoute(options: BackToRouteOptions): Result<RoutePlanningResult, RoutingError>

Plans a back to route using the provided BackToRouteOptions object.

Link copied to clipboard
abstract fun incrementRouteContents(options: RouteIncrementOptions): Result<Route, RoutingError>

Calculates route contents (instructions, lane guidance) within its certain part using the provided RouteIncrementOptions object.

Link copied to clipboard
abstract fun update(options: RouteUpdateOptions): Result<RoutePlanningResult, RoutingError>

Updates a route using the provided RouteUpdateOptions object.