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

Types

object Companion

Functions

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

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

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.

Properties

directionsResponse

val directionsResponse: DirectionsResponse

directionsRoute

val directionsRoute: DirectionsRoute

DirectionsRoute that this NavigationRoute represents.

Unique local identifier of the route instance. For routes which contain server-side UUID it's equal to: UUID + "#" + routeIndex, for example: d77PcddF8rhGUc3ORYGfcwcDfS_8QW6r1iXugXD0HOgmr9CWL8wn0g==#0. For routes which were generated onboard and do not have a UUID it's equal to: "local@" + generateUuid() + "#" + routeIndex, for example: local@84438c3e-f608-47e9-88cc-cddf341d2fb1#0.

val origin: RouterOrigin

Describes which router type generated the route.

val routeIndex: Int

val routeOptions: RouteOptions

Extensions

exclusionViolations

fun NavigationRoute.exclusionViolations(): List<ExclusionViolation>

Returns all violated exclusions for this route.