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

OwnVehicleLeg

data class OwnVehicleLeg(distance: Distance, travelDuration: Duration?, vehicleType: VehicleType, instructionSegments: List<InstructionSegment>?, pathAnnotations: List<PathAnnotation>?, path: PathGeometry) : SelfPilotedLeg

A leg where the user drives or rides a vehicle of their own

Constructors

fun OwnVehicleLeg(distance: Distance, travelDuration: Duration?, vehicleType: VehicleType, instructionSegments: List<InstructionSegment>? = null, pathAnnotations: List<PathAnnotation>? = null, path: PathGeometry)

Properties

open override val distance: Distance

The total distance along the path of this leg

val distanceMeters: Double

instructionSegments

open override val instructionSegments: List<InstructionSegment>? = null

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

open override val path: PathGeometry

The geographic path this leg traverses

pathAnnotations

open override val pathAnnotations: List<PathAnnotation>? = null

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

open override val travelDuration: Duration?

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

travelDurationSeconds

val travelDurationSeconds: Int?

open override val vehicleType: VehicleType