sdk / com.mapbox.search / SearchOptions / Builder

Builder

class Builder

Builder for comfortable creation of SearchOptions instance.

Constructors

<init>

Builder for comfortable creation of SearchOptions instance.

Builder()

Properties

boundingBox

Limit results to only those contained within the supplied bounding box. The bounding box cannot cross the 180th meridian.

var boundingBox: BoundingBox?

countries

Limit results to one or more countries.

var countries: List<Country>?

fuzzyMatch

Specify whether the Geocoding API should attempt approximate, as well as exact, matching when performing searches (true, default), or whether it should opt out of this behavior and only attempt exact matching (false). For example, the default setting might return Washington, DC for a query of wahsington, even though the query was misspelled.

var fuzzyMatch: Boolean?

languages

Specify the user’s language. This parameter controls the language of the text supplied in responses, and also affects result scoring, with results matching the user’s query in the requested language being preferred over results that match in another language. For example, an autocomplete query for things that start with Frank might return Frankfurt as the first result with an English (en) language parameter, but Frankreich (“France”) with a German (de) language parameter. If language is not set explicitly, then language from default system locale will be used.

var languages: List<Language>?

limit

Specify the maximum number of results to return. The maximum supported is 10.

var limit: Int?

proximity

Bias the response to favor results that are closer to this location, provided as Point class instance.

var proximity: Point?

requestDebounce

Request debounce value in milliseconds. Previous request will be cancelled if the new one made within specified by requestDebounce time interval.

var requestDebounce: Int?

types

Filter results to include only a subset (one or more) of the available feature types. Options are country, region, postcode, district, place, locality, neighborhood, address, and poi.

var types: List<QueryType>?

Functions

boundingBox

Set bounding box for builder.

fun boundingBox(boundingBox: BoundingBox): Builder

build

Create SearchOptions instance from builder data.

fun build(): SearchOptions

countries

Set countries for builder.

fun countries(vararg countries: Country): Builder
fun countries(countries: List<Country>): Builder

fuzzyMatch

Set fuzzy match flag for builder.

fun fuzzyMatch(fuzzyMatch: Boolean): Builder

languages

Set languages for builder.

fun languages(vararg languages: Language): Builder
fun languages(languages: List<Language>): Builder

limit

Set limit for builder.

fun limit(limit: Int): Builder

proximity

Set proximity for builder.

fun proximity(proximity: Point?): Builder

requestDebounce

Set debounce for builder.

fun requestDebounce(debounce: Int): Builder

types

Set types for builder.

fun types(vararg types: QueryType): Builder
fun types(types: List<QueryType>): Builder