NavigationRoute

class NavigationRoute

Wraps a route object used across the Navigation SDK features.

Parameters

directionsRoute

DirectionsRoute that this NavigationRoute represents

waypoints

waypoints associated with the route. Nav SDK retrieves waypoints from various sources depending on the situation, such as DirectionsRoute, DirectionsResponse, or MapMatchingResponse. Prefer using waypoints instead of DirectionsRoute.waypoints from directionsRoute.

responseOriginAPI

describes API which generated data for NavigationRoute.

overriddenTraffic

describes a segment of NavigationRoute with overridden congestion_numeric.

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

Link copied to clipboard
open override fun hashCode(): Int

Returns a hash code value for the object.

Link copied to clipboard
open override fun toString(): String

Returns a string representation of the object.

Properties

Link copied to clipboard
val directionsRoute: DirectionsRoute
Link copied to clipboard
val evMaxCharge: Int?

Maximum possible charge of vehicle this route was requested for. It's null for non ev routes.

Link copied to clipboard
val id: String

Unique local identifier of the route instance.

Link copied to clipboard
val origin: String

Describes which router type generated the route.

Link copied to clipboard
val responseOriginAPI: String
Link copied to clipboard
val responseUUID: String

Id of the response from which this NavigationRoute is created

Link copied to clipboard
val routeIndex: Int

The index of the route that this wrapper tracks from the collection of routes returned in the original response.

Link copied to clipboard
val upcomingRoadObjects: List<UpcomingRoadObject>

Returns a list of UpcomingRoadObject present in a route.

Link copied to clipboard
val waypoints: List<DirectionsWaypoint>?

Extensions

Link copied to clipboard
fun NavigationRoute.exclusionViolations(): List<ExclusionViolation>

Returns all violated exclusions for this route.