Instruction

interface Instruction

Interface for instructions. Contains a set of attributes common to all instructions.

Different types of instruction will implement this. They may also add extra attributes specific to their instruction type.

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

Properties

Link copied to clipboard
abstract val announcements: List<Announcement>

Fine-grained Announcements for the Instruction.

Link copied to clipboard
abstract val drivingSide: DrivingSide

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

Link copied to clipboard
abstract val id: UniqueId

The ID of the instruction.

Link copied to clipboard
abstract val intersectionName: String

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

Link copied to clipboard
abstract val isPossibleToCombineWithNext: Boolean

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

Link copied to clipboard
abstract val junctionType: JunctionType?

Type of junction at which the maneuver takes place, if present for this instruction.

Link copied to clipboard
abstract val maneuverPoint: GeoCoordinate

Location of the maneuver expressed as a GeoCoordinate.

Link copied to clipboard
abstract val maneuverType: Maneuver?

Type of maneuver.

Link copied to clipboard
abstract val nextSignificantRoad: RoadInformation?

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

Link copied to clipboard
abstract val previousSignificantRoad: RoadInformation?

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

Link copied to clipboard
abstract val routeOffset: Distance

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

Link copied to clipboard
abstract val routePath: List<RouteCoordinate>

A List of RouteCoordinates that represents a route path.

Link copied to clipboard
abstract val signpost: Signpost?

Signpost information, if present for this instruction.

Link copied to clipboard
abstract val startPointIndex: Int

Index of the first point of the maneuver.

Link copied to clipboard
abstract val travelTime: Duration

Estimated travel time to the point at routeOffset.

Inheritors

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard