sdk/com.mapbox.search/RouteOptions

RouteOptions

class RouteOptions(val route: List<Point>, val deviation: RouteOptions.Deviation) : Parcelable

Options to configure Route for search along the route functionality.

Note: Supported for Single Box Search and Search Box APIs only. Reserved for internal and special use.

Constructors

Link copied to clipboard
fun RouteOptions(route: List<Point>, deviation: RouteOptions.Deviation)

Types

Link copied to clipboard
abstract class Deviation : Parcelable

Option describing maximum detour from route.

Functions

Link copied to clipboard
abstract fun describeContents(): Int
Link copied to clipboard
abstract fun writeToParcel(p0: Parcel, p1: Int)

Properties

Link copied to clipboard
val deviation: RouteOptions.Deviation

option describing maximum detour from route.

Link copied to clipboard
val route: List<Point>

route to search across; please note, at least 2 points should be provided.