BackToRouteOptions

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

class ~~BackToRouteOptions~~(val routePlanningOptions: RoutePlanningOptions, val originalRoute: Route, val deviationPoint: BackToRouteOptions.PointOnRoute, val currentLocation: GeoLocation)

This will be removed from future releases after 2025-12-16.

Options for a back-to-route request, which are passed to one of the various route planners.

routePlanningOptions

The route planning options from the initial planning. Note: For RoutePlanningOptions.mode, the only supported mode currently is RouteInformationMode.Complete.

originalRoute

The original route that the user deviated from.

deviationPoint

The point where the user deviated from the original route.

currentLocation

The current location of the user.

Constructors

constructor(routePlanningOptions: RoutePlanningOptions, originalRoute: Route, deviationPoint: BackToRouteOptions.PointOnRoute, currentLocation: GeoLocation)

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

data class PointOnRoute(val legIndex: Int, val pointIndex: Int)

Represents a point on a route.

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String