Package com.mapbox.navigation.base.route

Types

Link copied to clipboard
class DirectionsResponseParsingException : Exception

An exception that is thrown when parsing Directions Response fails.

Link copied to clipboard
data class ExclusionViolation(    val type: String,     val route: DirectionsRoute,     val legIndex: Int,     val leg: RouteLeg,     val stepIndex: Int,     val step: LegStep,     val intersectionIndex: Int,     val intersection: StepIntersection)

Violated road type.

Link copied to clipboard
class LegWaypoint

The class contains information about a waypoint which breaks the route into legs (not the silent one).

Link copied to clipboard
class NavigationRoute

Wraps a route object used across the Navigation SDK features.

Link copied to clipboard
interface NavigationRouter : Router

Extends Router to also provide ability for fetching and refreshing NavigationRoutes.

Link copied to clipboard
interface NavigationRouterCallback

Interface definition for a callback associated with routes request.

Link copied to clipboard
interface NavigationRouterRefreshCallback

Interface definition for a callback associated with routes refresh.

Link copied to clipboard
class NavigationRouterRefreshError

Provides information about the route refresh failure.

Link copied to clipboard
class RouteAlternativesOptions

The options available for observing alternative routes. The RouteOptions used to set the current active route are updated according to the current route progress.

Link copied to clipboard
interface Router

Router provides API to fetch route and cancel route-fetching request.

Link copied to clipboard
interface RouterCallback

Interface definition for a callback associated with routes request.

Link copied to clipboard
interface RouteRefreshCallback

Interface definition for a callback associated with routes refresh.

Link copied to clipboard
data class RouteRefreshError(val message: String? = null, val throwable: Throwable? = null)

Route refresh Error

Link copied to clipboard
class RouteRefreshOptions

The options available for refreshing the current primary NavigationRoute, as well as the alternatives. Each refresh will update:

Link copied to clipboard
object RouterFactory

Provides components needed for base router capabilities.

Link copied to clipboard
data class RouterFailure @JvmOverloads constructor(    val url: URL,     val routerOrigin: RouterOrigin,     val message: String,     val code: Int? = null,     val throwable: Throwable? = null)

Describes a reason for a route request failure.

Link copied to clipboard
sealed class RouterOrigin

Describes which kind of router presents response.

Functions

Link copied to clipboard
fun DirectionsRoute.exclusionViolations(): List<ExclusionViolation>
fun NavigationRoute.exclusionViolations(): List<ExclusionViolation>

Returns all violated exclusions for this route.

Link copied to clipboard
fun List<NavigationRoute>.toDirectionsRoutes(): List<DirectionsRoute>
Link copied to clipboard
fun DirectionsRoute.toNavigationRoute(): NavigationRoute
fun DirectionsRoute.toNavigationRoute(routerOrigin: RouterOrigin): NavigationRoute

Maps DirectionsRoute to NavigationRoute.

Link copied to clipboard
fun List<DirectionsRoute>.toNavigationRoutes(): List<NavigationRoute>
fun List<DirectionsRoute>.toNavigationRoutes(routerOrigin: RouterOrigin): List<NavigationRoute>

Maps DirectionsRoutes to NavigationRoutes.

Properties

Link copied to clipboard
val List<RouterFailure>?.isRetryable: Boolean

Indicates if it makes sense to retry for this type of failures. If false, it doesn't make sense to retry route request