SdkStepRoute

data class SdkStepRoute(val rawStepDistance: RoutingDistance? = null, val rawStepDuration: RoutingDuration? = null, val rawStartLocation: SdkLatLngDTO, val rawEndLocation: SdkLatLngDTO, val endInsidePlace1: Boolean, val startInsidePlace: String?, val startInsideFloor: String?, val endInsidePlace: String?, val endInsideFloor: String?, val htmlInstructions: String, val travelMode: TravelMode, val polyline: Polyline, var maneuver: String?, var elevatorStep: Boolean = false, val showPopup: Boolean? = null, val iconPrefix: String? = null, val autoGeneratedMessage: Boolean = true, val plainInstructions: String = Jsoup.parse(htmlInstructions)

    .text())

Represents a single navigation step within a route leg.

A step is the smallest navigable unit in the Lazarillo routing model. It defines a segment of the route between a start and end location, along with turn-by-turn instructions, distance, duration, and indoor context (building/floor information for both endpoints).

Steps are deserialized from the Lazarillo routing API via Jackson. The indoor context fields (startInsidePlace, startInsideFloor, endInsidePlace, endInsideFloor) enable the SDK to handle floor transitions and render floor-specific route segments on the map.

See also

Constructors

Properties

announcedText

var announcedText: String?

autoGeneratedMessage

val autoGeneratedMessage: Boolean = true

true if the instruction text was auto-generated by the API.

elevatorStep

var elevatorStep: Boolean

true if this step involves an elevator transition between floors.

endInsideFloor

val endInsideFloor: String?

Floor identifier at the end of this step, or null if outdoors.

endInsidePlace

val endInsidePlace: String?

Building/place identifier at the end of this step, or null if outdoors.

endInsidePlace1

val endInsidePlace1: Boolean

Whether the end location is inside a place (legacy field).

htmlInstructions

val htmlInstructions: String

Turn-by-turn instruction text in HTML format.

iconPrefix

val iconPrefix: String? = null

instruction

val instruction: Instruction

Types: Instruction

maneuver

var maneuver: String?

Navigation maneuver identifier (e.g., “turn-left”, “turn-right”), or null.

plainInstructions

val plainInstructions: String

Plain-text version of htmlInstructions with HTML tags stripped.

polyline

val polyline: Polyline

Types: Polyline

Encoded Polyline geometry for this step’s path.

rawEndLocation

val rawEndLocation: SdkLatLngDTO

End coordinates of this step as a SdkLatLngDTO.

rawStartLocation

val rawStartLocation: SdkLatLngDTO

Start coordinates of this step as a SdkLatLngDTO.

rawStepDistance

val rawStepDistance: RoutingDistance? = null

Types: RoutingDistance

Distance of this step as returned by the API, or null if not provided (in which case distance is computed from start/end coordinates).

rawStepDuration

val rawStepDuration: RoutingDuration? = null

Types: RoutingDuration

Duration of this step as returned by the API, or null if not provided (in which case duration is estimated from distance and travel mode).

showPopup

val showPopup: Boolean? = null

startInsideFloor

val startInsideFloor: String?

Floor identifier at the start of this step, or null if outdoors.

startInsidePlace

val startInsidePlace: String?

Building/place identifier at the start of this step, or null if outdoors.

travelMode

val travelMode: TravelMode

Types: TravelMode

The TravelMode for this step (e.g., walking, elevator).

Functions

announceString

fun announceString(): Spanned

copy

fun copy(_stepDistance: RoutingDistance, _stepDuration: RoutingDuration, htmlInstructions: String, maneuver: String, startLocation: LzLocation, polyline: Polyline): SdkStepRoute?

Types: RoutingDistance, RoutingDuration, LzLocation, Polyline

getCleanInstruction

fun getCleanInstruction(htmlInstruction: String): String

Clean the instruction from html tags and return a safe visible instruction

getDistanceAsInt

fun getDistanceAsInt(): Int

getProcessedEndLocation

fun getProcessedEndLocation(): LzLocation

Types: LzLocation

getProcessedStartLocation

fun getProcessedStartLocation(): LzLocation

Types: LzLocation

getStepDuration

fun getStepDuration(): RoutingDuration

Types: RoutingDuration

getStepDurationAsInt

fun getStepDurationAsInt(): Int