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

@JvmOverloads()

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

Functions

cancel

fun cancel()

Invoke the function to cancel any job invoked through other APIs

equals

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

getManeuvers

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

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

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

hashCode

open fun hashCode(): Int

toString

open fun toString(): String