Package com.mapbox.navigation.base.route

Types

ExclusionViolation
Link copied to clipboard
data class ExclusionViolation(type: String, route: DirectionsRoute, legIndex: Int, leg: RouteLeg, stepIndex: Int, step: LegStep, intersectionIndex: Int, intersection: StepIntersection)
Violated road type.
NavigationRoute
Link copied to clipboard
class NavigationRoute
Wraps a route object used across the Navigation SDK features.
NavigationRouter
Link copied to clipboard
interface NavigationRouter : Router
Extends Router to also provide ability for fetching and refreshing NavigationRoutes.
NavigationRouterCallback
Link copied to clipboard
interface NavigationRouterCallback
Interface definition for a callback associated with routes request.
NavigationRouterRefreshCallback
Link copied to clipboard
interface NavigationRouterRefreshCallback
Interface definition for a callback associated with routes refresh.
NavigationRouterRefreshError
Link copied to clipboard
class NavigationRouterRefreshError
Provides information about the route refresh failure.
RouteAlternativesOptions
Link copied to clipboard
class RouteAlternativesOptions
The options available for observing alternative routes.
Router
Link copied to clipboard
interface Router
Router provides API to fetch route and cancel route-fetching request.
RouterCallback
Link copied to clipboard
interface RouterCallback
Interface definition for a callback associated with routes request.
RouteRefreshCallback
Link copied to clipboard
interface RouteRefreshCallback
Interface definition for a callback associated with routes refresh.
RouteRefreshError
Link copied to clipboard
data class RouteRefreshError(message: String?, throwable: Throwable?)
Route refresh Error
RouteRefreshOptions
Link copied to clipboard
class RouteRefreshOptions
The options available for refreshing the active DirectionsRoute.
RouterFactory
Link copied to clipboard
object RouterFactory
Provides components needed for base router capabilities.
RouterFailure
Link copied to clipboard
data class RouterFailure @JvmOverloads() constructor(url: URL, routerOrigin: RouterOrigin, message: String, code: Int?, throwable: Throwable?)
Describes a reason for a route request failure.
RouterOrigin
Link copied to clipboard
sealed class RouterOrigin
Describes which kind of router presents response.

Functions

exclusionViolations
Link copied to clipboard
fun DirectionsRoute.exclusionViolations(): List<ExclusionViolation>
Returns all violated exclusions for this route.
fun NavigationRoute.exclusionViolations(): List<ExclusionViolation>
Returns all violated exclusions for this route.
toDirectionsRoutes
Link copied to clipboard
fun List<NavigationRoute>.toDirectionsRoutes(): List<DirectionsRoute>
toNavigationRoute
Link copied to clipboard
fun DirectionsRoute.toNavigationRoute(): NavigationRoute
Maps DirectionsRoute to NavigationRoute.
fun DirectionsRoute.toNavigationRoute(routerOrigin: RouterOrigin): NavigationRoute
Maps DirectionsRoute to NavigationRoute.
toNavigationRoutes
Link copied to clipboard
fun List<DirectionsRoute>.toNavigationRoutes(): List<NavigationRoute>
Maps DirectionsRoutes to NavigationRoutes.
fun List<DirectionsRoute>.toNavigationRoutes(routerOrigin: RouterOrigin): List<NavigationRoute>
Maps DirectionsRoutes to NavigationRoutes.