BorderCrossingInstruction

data class BorderCrossingInstruction(val borderCrossing: BorderCrossing, val routeOffset: Distance, val maneuverPoint: GeoPoint, val drivingSide: DrivingSide, val combineWithNext: Boolean, val announcements: List<Announcement> = emptyList(), val previousSignificantRoad: Road? = null, val nextSignificantRoad: Road? = null, val routePath: List<InstructionPoint> = emptyList(), val intersectionName: TextWithPhonetics? = null, val signpost: Signpost? = null, val landmark: Landmark? = null, val sideStreetOffset: Distance? = null, val trafficLightOffset: Distance? = null, val id: UniqueId = UniqueId()) : Instruction

Instruction indicating that a border between two countries will be crossed.

Important: This is a Public Preview API. It may be changed or removed at any time.

See also

Parameters

borderCrossing

Border crossing information.

Constructors

Link copied to clipboard
fun BorderCrossingInstruction(borderCrossing: BorderCrossing, routeOffset: Distance, maneuverPoint: GeoPoint, drivingSide: DrivingSide, combineWithNext: Boolean, announcements: List<Announcement> = emptyList(), previousSignificantRoad: Road? = null, nextSignificantRoad: Road? = null, routePath: List<InstructionPoint> = emptyList(), intersectionName: TextWithPhonetics? = null, signpost: Signpost? = null, landmark: Landmark? = null, sideStreetOffset: Distance? = null, trafficLightOffset: Distance? = null, id: UniqueId = UniqueId())

Properties

Link copied to clipboard
open override val announcements: List<Announcement>

Fine-grained Announcements for the Instruction.

Link copied to clipboard
Link copied to clipboard
open override val combineWithNext: Boolean

Indicates if the instruction should be combined with the next one. This can be used to build messages like "Turn left and then turn right".

Link copied to clipboard
open override val drivingSide: DrivingSide

Indicates left-hand vs. right-hand side driving at the point of the maneuver.

Link copied to clipboard
open override val id: UniqueId

The ID of the instruction.

Link copied to clipboard
open override val intersectionName: TextWithPhonetics? = null

Name of the intersection at the maneuver point, if present for this instruction.

Link copied to clipboard
open override val landmark: Landmark? = null

Landmark information, if present in this instruction.

Link copied to clipboard
open override val maneuverPoint: GeoPoint

Location of the maneuver expressed as a GeoPoint.

Link copied to clipboard
open override val nextSignificantRoad: Road? = null

Information about the road the driver will be on immediately after completing the maneuver, if available for this instruction.

Link copied to clipboard
open override val previousSignificantRoad: Road? = null

Information about the road the driver will be on immediately before starting the maneuver, if available for this instruction.

Link copied to clipboard
open override val routeOffset: Distance

Distance from the start of the route to the instruction point.

Link copied to clipboard
open override val routePath: List<InstructionPoint>

A List of InstructionPoints that represents a route path.

Link copied to clipboard
open override val sideStreetOffset: Distance? = null

Distance to the maneuver point from the intermediate side street, if any.

Link copied to clipboard
open override val signpost: Signpost? = null

Signpost information, if present for this instruction.

Link copied to clipboard
open override val trafficLightOffset: Distance? = null

Distance to the maneuver point from the preceding traffic light, if any.

Extensions

Link copied to clipboard