NavigationRoute

class NavigationRoute
Content copied to clipboard

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
Content copied to clipboard

Functions

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

Properties

directionsResponse
Link copied to clipboard
val directionsResponse: DirectionsResponse
Content copied to clipboard
the original response that returned this route object.
directionsRoute
Link copied to clipboard
val directionsRoute: DirectionsRoute
Content copied to clipboard
DirectionsRoute that this NavigationRoute represents.
routeIndex
Link copied to clipboard
val routeIndex: Int
Content copied to clipboard
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
Content copied to clipboard
options used to generate the directionsResponse

Extensions

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