Citymapper SDK/com.citymapper.sdk.core.transit/WalkLeg

WalkLeg

data class WalkLeg(distance: Distance, travelDuration: Duration?, instructionSegments: List<InstructionSegment>?, pathAnnotations: List<PathAnnotation>?, path: PathGeometry, stationWalkType: StationWalkType, walkDetailsEnterStation: StationWalkDetails?, walkDetailsExitStation: StationWalkDetails?) : Leg, HasInstructions, HasPathAnnotations
Content copied to clipboard

A walking leg

Constructors

Link copied to clipboard
fun WalkLeg(distance: Distance, travelDuration: Duration?, instructionSegments: List<InstructionSegment>? = null, pathAnnotations: List<PathAnnotation>? = null, path: PathGeometry, stationWalkType: StationWalkType = StationWalkType.OutsideStation, walkDetailsEnterStation: StationWalkDetails? = null, walkDetailsExitStation: StationWalkDetails? = null)
Content copied to clipboard

Properties

Link copied to clipboard
open override val distance: Distance
Content copied to clipboard

The total distance along the path of this leg

Link copied to clipboard
val distanceMeters: Double
Content copied to clipboard
Link copied to clipboard
open override val instructionSegments: List<InstructionSegment>? = null
Content copied to clipboard

A list of turn-by-turn instructions where the user needs to navigate along this leg. Each segment represents a consecutive part of the path

Link copied to clipboard
val outOfStationWalkDuration: Duration?
Content copied to clipboard
Link copied to clipboard
open override val path: PathGeometry
Content copied to clipboard

The geographic path this leg traverses

Link copied to clipboard
open override val pathAnnotations: List<PathAnnotation>? = null
Content copied to clipboard

Extra metadata about sections of the path. For instance, in Legs with travel_mode of self_piloted, these annotations can indicate sections of the path where the user should dismount their vehicle and walk

Link copied to clipboard
val stationWalkType: StationWalkType
Content copied to clipboard
Link copied to clipboard
open override val travelDuration: Duration?
Content copied to clipboard

The time it should take to traverse the path of this leg. This does not include any time spent waiting or boarding at the start of the leg

Link copied to clipboard
val travelDurationSeconds: Int?
Content copied to clipboard
Link copied to clipboard
val walkDetailsEnterStation: StationWalkDetails? = null
Content copied to clipboard
Link copied to clipboard
val walkDetailsExitStation: StationWalkDetails? = null
Content copied to clipboard