Package com.mapbox.navigation.base.route

Types

ExclusionViolation

androidJvm

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

Violated road type.

NavigationRoute

androidJvm

class NavigationRoute

Wraps a route object used across the Navigation SDK features.

NavigationRouter

androidJvm

interface NavigationRouter : Router

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

NavigationRouterCallback

androidJvm

interface NavigationRouterCallback

Interface definition for a callback associated with routes request.

NavigationRouterRefreshCallback

androidJvm

interface NavigationRouterRefreshCallback

Interface definition for a callback associated with routes refresh.

NavigationRouterRefreshError

androidJvm

class NavigationRouterRefreshError

Provides information about the route refresh failure.

RouteAlternativesOptions

androidJvm

class RouteAlternativesOptions

The options available for observing alternative routes.

Router

androidJvm

interface Router

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

RouterCallback

androidJvm

interface RouterCallback

Interface definition for a callback associated with routes request.

RouteRefreshCallback

androidJvm

interface RouteRefreshCallback

Interface definition for a callback associated with routes refresh.

RouteRefreshError

androidJvm

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

Route refresh Error

RouteRefreshOptions

androidJvm

class RouteRefreshOptions

The options available for refreshing the active DirectionsRoute.

RouterFactory

androidJvm

object RouterFactory

Provides components needed for base router capabilities.

RouterFailure

androidJvm

data class RouterFailure @JvmOverloads() constructor(url: URL, routerOrigin: RouterOrigin, message: String, code: Int?, throwable: Throwable?)

Describes a reason for a route request failure.

RouterOrigin

androidJvm

sealed class RouterOrigin

Describes which kind of router presents response.

Functions

exclusionViolations

androidJvm

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

androidJvm

fun List<NavigationRoute>.toDirectionsRoutes(): List<DirectionsRoute>

Returns all NavigationRoute.directionsRoutes.

toNavigationRoute

androidJvm

fun DirectionsRoute.toNavigationRoute(): NavigationRoute

Maps DirectionsRoute to NavigationRoute.

fun DirectionsRoute.toNavigationRoute(routerOrigin: RouterOrigin): NavigationRoute

Maps DirectionsRoute to NavigationRoute.

toNavigationRoutes

androidJvm

fun List<DirectionsRoute>.toNavigationRoutes(): List<NavigationRoute>

Maps DirectionsRoutes to NavigationRoutes.

fun List<DirectionsRoute>.toNavigationRoutes(routerOrigin: RouterOrigin): List<NavigationRoute>

Maps DirectionsRoutes to NavigationRoutes.