MapboxManeuverApi

class MapboxManeuverApi

Mapbox Maneuver Api allows you to request Maneuver instructions given a DirectionsRoute (to get all maneuvers for the provided route) or RouteProgress (to get remaining maneuvers for the provided route).

You can use the default MapboxManeuverView to render the results of the functions exposed by this API.

Constructors

MapboxManeuverApi

androidJvm

@JvmOverloads()

fun MapboxManeuverApi(formatter: DistanceFormatter, maneuverOptions: ManeuverOptions = ManeuverOptions.Builder().build(), routeShieldApi: MapboxRouteShieldApi = MapboxRouteShieldApi())

Functions

cancel

androidJvm

fun cancel()

Invoke the function to cancel any job invoked through other APIs

equals

androidJvm

open operator fun equals(other: Any?): Boolean

getManeuvers

androidJvm

fun getManeuvers(routeProgress: RouteProgress): Expected<ManeuverError, List<Maneuver>>

Returns a list of Maneuvers which are wrappers on top of BannerInstructions that are in the provided route.

@JvmOverloads()

fun getManeuvers(route: DirectionsRoute, routeLegIndex: Int? = null): Expected<ManeuverError, List<Maneuver>>

Returns a list of Maneuvers which are wrappers on top of BannerInstructions that are in the provided route.

getRoadShields

androidJvm

fun getRoadShields(maneuvers: List<Maneuver>, callback: RoadShieldCallback)

Given a list of Maneuver the function requests legacy road shields (if available) using BannerComponents.imageBaseUrl associated in RoadShieldComponentNode.

fun getRoadShields(maneuvers: List<Maneuver>, shieldCallback: RouteShieldCallback)

Given a list of Maneuver the function requests legacy road shields (if available) using BannerComponents.imageBaseUrl associated in RoadShieldComponentNode.

fun getRoadShields(userId: String?, styleId: String?, accessToken: String?, maneuvers: List<Maneuver>, shieldCallback: RouteShieldCallback)

Given a list of Maneuver the function requests mapbox designed road shields (if available) using BannerComponents.mapboxShield associated in RoadShieldComponentNode.

hashCode

androidJvm

open fun hashCode(): Int

toString

androidJvm

open fun toString(): String