Interface DirectionsResponse

Full Mapbox Directions API response envelope returned by MapboxNavigation.requestRoutes. Pass unchanged to MapboxNavigation.startActiveGuidance to reconstruct NavigationRoutes with proper RouteOptions for geometry decoding.

interface DirectionsResponse {
    code: string;
    routeOptions: DirectionsRouteOptions;
    routes: Route[];
    uuid?: string;
    waypoints: RouteWaypoint[];
}

Index

Properties

code routeOptions routes uuid? waypoints

Properties

code

code: string

'Ok' | 'NoRoute' | ...

routeOptions

routeOptions: DirectionsRouteOptions

routes

routes: Route[]

`Optional`uuid

uuid?: string

waypoints

waypoints: RouteWaypoint[]