IntersectionLanes

@Serializable
data class IntersectionLanes(val valid: Boolean? = null, val active: Boolean? = null, val validIndication: String? = null, val indications: List<String>? = null)

Object representing lanes in an intersection.

Since

2.0.0

Constructors

Link copied to clipboard
constructor(valid: Boolean? = null, active: Boolean? = null, validIndication: String? = null, indications: List<String>? = null)

Types

Link copied to clipboard
class Builder

Builder class for creating IntersectionLanes instances.

Properties

Link copied to clipboard
val active: Boolean? = null

Indicates whether this lane is a preferred lane (true) or not (false). A preferred lane is a lane that is recommended if there are multiple lanes available. For example, if guidance indicates that the driver must turn left at an intersection and there are multiple left turn lanes, the left turn lane that will better prepare the driver for the next maneuver will be marked as active. Only available on the mapbox/driving profile.

Link copied to clipboard
val indications: List<String>? = null

Array that can be made up of multiple signs such as left, right, etc. There can be multiple signs. For example, a turning lane can have a sign with an arrow pointing left and another sign with an arrow pointing straight.

Link copied to clipboard
val valid: Boolean? = null

Provides a boolean value you can use to determine if the given lane is valid for the user to complete the maneuver. For instance, if the lane array has four objects and the first two are marked as valid, then the driver can take either of the left lanes and stay on the route.

Link copied to clipboard
@SerialName(value = "valid_indication")
val validIndication: String? = null

When either valid or active is set to true, this property shows which of the lane indications is applicable to the current route, when there is more than one. For example, if a lane allows you to go left or straight but your current route is guiding you to the left, then this value will be set to left. See indications for possible values. When both active and valid are false, this property will not be included in the response. Only available on the mapbox/driving profile.

Functions

Link copied to clipboard

Creates a builder initialized with the current values of the IntersectionLanes instance.