maplibre-navigation-core/org.maplibre.navigation.core.models/RouteOptions/Builder

Builder

class Builder(baseUrl: String, user: String, profile: String, coordinates: List<@Serializable(with = PointSerializer::class) Point>, accessToken: String, requestUuid: String)

Builder class for creating RouteOptions instances.

Parameters

baseUrl

The same base URL which was used during the request that resulted in this root directions response.

user

The same user which was used during the request that resulted in this root directions response.

profile

The routing profile to use.

coordinates

A list of Points to visit in order.

accessToken

A valid Mapbox access token used to making the request.

requestUuid

A universally unique identifier (UUID) for identifying and executing a similar specific route in the future.

Constructors

Link copied to clipboard
constructor(baseUrl: String, user: String, profile: String, coordinates: List<@Serializable(with = PointSerializer::class) Point>, accessToken: String, requestUuid: String)

Functions

Link copied to clipboard
fun build(): RouteOptions

Builds a RouteOptions instance with the current builder values.

Link copied to clipboard
fun withAlternatives(alternatives: Boolean?): RouteOptions.Builder

Sets the alternatives.

Link copied to clipboard
fun withAnnotations(annotations: String?): RouteOptions.Builder

Sets the annotations.

Link copied to clipboard
fun withApproaches(approaches: String?): RouteOptions.Builder

Sets the approaches.

Link copied to clipboard
fun withBannerInstructions(bannerInstructions: Boolean?): RouteOptions.Builder

Sets the banner instructions option.

Link copied to clipboard
fun withBearings(bearings: String?): RouteOptions.Builder

Sets the bearings.

Link copied to clipboard
fun withContinueStraight(continueStraight: Boolean?): RouteOptions.Builder

Sets the continue straight option.

Link copied to clipboard
fun withExclude(exclude: String?): RouteOptions.Builder

Sets the exclude option.

Link copied to clipboard
fun withGeometries(geometries: String?): RouteOptions.Builder

Sets the geometries.

Link copied to clipboard
fun withLanguage(language: String?): RouteOptions.Builder

Sets the language.

Link copied to clipboard
fun withOverview(overview: String?): RouteOptions.Builder

Sets the overview.

Link copied to clipboard
fun withRadiuses(radiuses: String?): RouteOptions.Builder

Sets the radiuses.

Link copied to clipboard
fun withRoundaboutExits(roundaboutExits: Boolean?): RouteOptions.Builder

Sets the roundabout exits option.

Link copied to clipboard
fun withSnappingClosures(snappingClosures: String?): RouteOptions.Builder

Sets the snapping closures.

Link copied to clipboard
fun withSteps(steps: Boolean?): RouteOptions.Builder

Sets the steps option.

Link copied to clipboard
fun withVoiceInstructions(voiceInstructions: Boolean?): RouteOptions.Builder

Sets the voice instructions option.

Link copied to clipboard
fun withVoiceUnits(voiceUnits: UnitType?): RouteOptions.Builder

Sets the voice units.

Link copied to clipboard
fun withWalkingOptions(walkingOptions: WalkingOptions?): RouteOptions.Builder

Sets the walking options.

Link copied to clipboard
fun withWaypointIndices(waypointIndices: String?): RouteOptions.Builder

Sets the waypoint indices.

Link copied to clipboard
fun withWaypointNames(waypointNames: String?): RouteOptions.Builder

Sets the waypoint names.

Link copied to clipboard
fun withWaypointTargets(waypointTargets: String?): RouteOptions.Builder

Sets the waypoint targets.