Package com.mapbox.navigation.base.route

Types

class DirectionsResponseParsingException : Exception

An exception that is thrown when parsing Directions Response fails.

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.

LegWaypoint

class LegWaypoint

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

NavigationRoute

class NavigationRoute

Wraps a route object used across the Navigation SDK features.

NavigationRouter

interface NavigationRouter : Router

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

NavigationRouterCallback

interface NavigationRouterCallback

Interface definition for a callback associated with routes request.

NavigationRouterRefreshCallback

interface NavigationRouterRefreshCallback

Interface definition for a callback associated with routes refresh.

NavigationRouterRefreshError

class NavigationRouterRefreshError

Provides information about the route refresh failure.

RouteAlternativesOptions

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.

Router

interface Router

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

RouterCallback

interface RouterCallback

Interface definition for a callback associated with routes request.

RouteRefreshCallback

interface RouteRefreshCallback

Interface definition for a callback associated with routes refresh.

RouteRefreshError

data class RouteRefreshError(val message: String? = null, val throwable: Throwable? = null)

Route refresh Error

RouteRefreshOptions

class RouteRefreshOptions

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

RouterFactory

object RouterFactory

Provides components needed for base router capabilities.

RouterFailure

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.

RouterOrigin

sealed class RouterOrigin

Describes which kind of router presents response.