Base/com.mapbox.navigation.base.route/NavigationRoute

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

directionsRoute

DirectionsRoute that this NavigationRoute represents

Types

Companion

object Companion

Functions

equals

open operator override fun equals(other: Any?): Boolean

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

hashCode

open override fun hashCode(): Int

Returns a hash code value for the object.

toString

open override fun toString(): String

Returns a string representation of the object.

Properties

directionsResponse

val directionsResponse: DirectionsResponse

directionsRoute

val directionsRoute: DirectionsRoute

val id: String

Unique local identifier of the route instance.

origin

val origin: RouterOrigin

Describes which router type generated the route.

routeIndex

val routeIndex: Int

routeOptions

val routeOptions: RouteOptions

upcomingRoadObjects

val upcomingRoadObjects: List<UpcomingRoadObject>

Returns a list of UpcomingRoadObject present in a route.

waypoints

val waypoints: List<DirectionsWaypoint>?

Compatibility function to always access the valid DirectionsWaypoints collection.

Extensions

exclusionViolations

fun NavigationRoute.exclusionViolations(): List<ExclusionViolation>

Returns all violated exclusions for this route.