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

Companion
Link copied to clipboard
object Companion

Functions

equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Indicates whether some other object is "equal to" this one.
hashCode
Link copied to clipboard
open override fun hashCode(): Int
Returns a hash code value for the object.
toString
Link copied to clipboard
open override fun toString(): String
Returns a string representation of the object.

Properties

directionsResponse
Link copied to clipboard
val directionsResponse: DirectionsResponse
the original response that returned this route object.
directionsRoute
Link copied to clipboard
val directionsRoute: DirectionsRoute
DirectionsRoute that this NavigationRoute represents.
id
Link copied to clipboard
val id: String
Unique local identifier of the route instance.
origin
Link copied to clipboard
val origin: RouterOrigin
Describes which router type generated the route.
routeIndex
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.
routeOptions
Link copied to clipboard
val routeOptions: RouteOptions
options used to generate the directionsResponse

Extensions

exclusionViolations
Link copied to clipboard
fun NavigationRoute.exclusionViolations(): List<ExclusionViolation>
Returns all violated exclusions for this route.