BackToRouteOptions

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

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

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

Parameters

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

Link copied to clipboard
constructor(routePlanningOptions: RoutePlanningOptions, originalRoute: Route, deviationPoint: BackToRouteOptions.PointOnRoute, currentLocation: GeoLocation)

Types

Link copied to clipboard
data class PointOnRoute(val legIndex: Int, val pointIndex: Int)

Represents a point on a route.

Properties

Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String