Base/com.mapbox.navigation.base.route

Package-level declarations

Types

class DirectionsResponseParsingException : Exception

An exception that is thrown when parsing Directions Response fails.

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).

MapMatchingMatch

class MapMatchingMatch

Represents the Match Object from Mapbox Map Matching API, which is a Route Object from Mapbox Directions API that has additional fields. Additional fields could be accessed here, while the part which matches the Route Object is available in navigationRoute.

NavigationRoute

class NavigationRoute

Wraps a route object used across the Navigation SDK features.

NavigationRouterCallback

interface NavigationRouterCallback

Interface definition for a callback associated with routes request.

ResponseOriginAPI

annotation class ResponseOriginAPI

Describes API which generated data for NavigationRoute.

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.

RouteRefreshMetadata

class RouteRefreshMetadata

Contains data that describes how route was refreshed.

RouteRefreshOptions

class RouteRefreshOptions

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

RouterFailure

class RouterFailure

Describes a reason for a route request failure.

RouterFailureType

annotation class RouterFailureType

Describes possible RouterFailure types.