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

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

routeRefreshMetadata

contains data that describes refreshing of this route object. The field is null until the first refresh.

Types

object Companion

Properties

directionsRoute

val directionsRoute: DirectionsRoute

val evMaxCharge: Int?

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

Unique local identifier of the route instance.

val origin: String

Describes which router type generated the route.

responseOriginAPI

val responseOriginAPI: String

val responseUUID: String

Id of the response from which this NavigationRoute is created

val routeIndex: Int

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

routeRefreshMetadata

val routeRefreshMetadata: RouteRefreshMetadata?

upcomingRoadObjects

val upcomingRoadObjects: List<UpcomingRoadObject>

Returns a list of UpcomingRoadObject present in a route.

val waypoints: List<DirectionsWaypoint>?

Functions

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

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

exclusionViolations

fun NavigationRoute.exclusionViolations(): List<ExclusionViolation>

Returns all violated exclusions for this route.

open override fun hashCode(): Int

Returns a hash code value for the object.

open override fun toString(): String

Returns a string representation of the object.