Package-level declarations

Types

Link copied to clipboard

An exception that is thrown when parsing Directions Response fails.

Link copied to clipboard
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

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

Link copied to clipboard

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.

Link copied to clipboard

Wraps a route object used across the Navigation SDK features.

Link copied to clipboard

Interface definition for a callback associated with routes request.

Link copied to clipboard
annotation class ResponseOriginAPI

Describes API which generated data for NavigationRoute.

Link copied to clipboard

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

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

Link copied to clipboard

Describes a reason for a route request failure.

Link copied to clipboard
annotation class RouterFailureType

Describes possible RouterFailure types.

Link copied to clipboard
annotation class RouterOrigin

Describes which kind of router presents response.

Properties

Link copied to clipboard

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

Functions

Link copied to clipboard

Returns all violated exclusions for this route.