MapboxRestAreaApi

class MapboxRestAreaApi @JvmOverloads constructor(val accessToken: String, val options: MapboxRestAreaOptions = MapboxRestAreaOptions.Builder().build())

Mapbox Rest Area Api allows you to generate service area and parking area information for select maneuvers.

Constructors

Link copied to clipboard
fun MapboxRestAreaApi(accessToken: String, options: MapboxRestAreaOptions = MapboxRestAreaOptions.Builder().build())

Functions

Link copied to clipboard
fun cancelAll()

Invoke the method to cancel all ongoing requests to generate a sapa guide map.

Link copied to clipboard
fun generateRestAreaGuideMap(instructions: BannerInstructions, consumer: MapboxNavigationConsumer<Expected<RestAreaGuideMapError, RestAreaGuideMapValue>>)

The method takes in BannerInstructions and generates rest area guide map based on the presence of BannerComponents of type BannerComponents.GUIDANCE_VIEW and subType BannerComponents.SAPAGUIDEMAP

Link copied to clipboard
fun generateUpcomingRestAreaGuideMap(routeProgress: RouteProgress, consumer: MapboxNavigationConsumer<Expected<RestAreaGuideMapError, RestAreaGuideMapValue>>)

The method takes in RouteProgress and generates rest area guide map based on the presence of RestStop.guideMapUri.

Properties

Link copied to clipboard
val accessToken: String

String

Link copied to clipboard
val options: MapboxRestAreaOptions

MapboxRestAreaOptions