NavigationRoute

class NavigationRoute

Wraps a route object used across the Navigation SDK features.

Parameters

directionsResponse

the original response that returned this route object.

routeIndex

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

routeOptions

options used to generate the directionsResponse

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 directionsResponse: DirectionsResponse
Link copied to clipboard
val directionsRoute: DirectionsRoute

DirectionsRoute that this NavigationRoute represents.

Link copied to clipboard
val id: String

Unique local identifier of the route instance.

Link copied to clipboard
val origin: RouterOrigin

Describes which router type generated the route.

Link copied to clipboard
val routeIndex: Int
Link copied to clipboard
val routeOptions: RouteOptions
Link copied to clipboard
val upcomingRoadObjects: List<UpcomingRoadObject>

Returns a list of UpcomingRoadObject present in a route.

Extensions

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

Returns all violated exclusions for this route.

Link copied to clipboard
suspend fun NavigationRoute.hasUnexpectedClosures(): Boolean

This function checks whether the NavigationRoute has unexpected closures, which could be a reason to re-route.