Skip to Content

SdkRoute

data class SdkRoute(val legs: List<SdkLegRoute>, val overview: Polyline)

Represents a complete route returned by the Lazarillo routing API.

A route is composed of one or more SdkLegRoute instances (legs), each containing a sequence of SdkStepRoute instances (steps). The route also carries an overview polyline that provides a simplified geometry of the entire path, suitable for rendering a route preview on the map.

This model is deserialized directly from the Lazarillo API JSON response using Jackson annotations. Once obtained, it is consumed by RoutingStatusRepository to track the user’s progress along the route.

See also

SdkLegRoute
SdkStepRoute
RoutingStatusRepository

Constructors

SdkRouteconstructor(legs: List <SdkLegRoute>, overview: Polyline)

Properties

legs

val legs: List<SdkLegRoute>

Types: SdkLegRoute

Ordered list of route legs. Each leg represents a segment of the route, typically from one waypoint to the next. Most routes have a single leg.

overview

val overview: Polyline

Types: Polyline

A Polyline encoding the simplified geometry of the entire route, used for rendering a route overview on the map.

Functions

getSteps

fun getSteps(): List<SdkStepRoute>

Types: SdkStepRoute

Returns a flattened list of all SdkStepRoute instances across every leg in this route, including any custom last steps.

Last updated on