Builder

Builder for comfortable creation of SearchOptions instance.

Constructors

Builder

Functions

boundingBox

fun boundingBox(boundingBox: BoundingBox): SearchOptions.Builder

Set SearchOptions.boundingBox for builder.

build

fun build(): SearchOptions

Create SearchOptions instance from builder data.

countries

fun countries(vararg countries: Country): SearchOptions.Builder

Set SearchOptions.countries for builder.

fun countries(countries: List<Country>): SearchOptions.Builder

Set SearchOptions.countries for builder.

equals

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

fuzzyMatch

fun fuzzyMatch(fuzzyMatch: Boolean): SearchOptions.Builder

Set SearchOptions.fuzzyMatch for builder.

hashCode

open fun hashCode(): Int

ignoreIndexableRecords

fun ignoreIndexableRecords(ignoreIndexableRecords: Boolean): SearchOptions.Builder

Set SearchOptions.ignoreIndexableRecords for builder.

languages

fun languages(vararg languages: Language): SearchOptions.Builder

Set SearchOptions.languages for builder.

fun languages(languages: List<Language>): SearchOptions.Builder

Set SearchOptions.languages for builder.

limit

fun limit(limit: Int): SearchOptions.Builder

Set SearchOptions.limit for builder.

navigationOptions

fun navigationOptions(navigationOptions: SearchNavigationOptions): SearchOptions.Builder

Set SearchOptions.navigationOptions for builder.

origin

fun origin(origin: Point): SearchOptions.Builder

Set SearchOptions.origin for builder.

proximity

fun proximity(proximity: Point?): SearchOptions.Builder

Set SearchOptions.proximity for builder.

requestDebounce

fun requestDebounce(debounce: Int): SearchOptions.Builder

Set SearchOptions.requestDebounce for builder.

routeOptions

fun routeOptions(routeOptions: RouteOptions): SearchOptions.Builder

Set SearchOptions.routeOptions for builder.

toString

open fun toString(): String

types

fun types(vararg types: QueryType): SearchOptions.Builder

Set SearchOptions.types for builder.

fun types(types: List<QueryType>): SearchOptions.Builder

Set SearchOptions.types for builder.

unsafeParameters

fun unsafeParameters(unsafeParameters: Map<String, String>): SearchOptions.Builder

Set SearchOptions.unsafeParameters for builder.

Properties

boundingBox

var boundingBox: BoundingBox? = null

Limit results to only those contained within the supplied bounding box.

countries

var countries: List<Country>? = null

Limit results to one or more countries.

fuzzyMatch

var fuzzyMatch: Boolean? = null

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).

ignoreIndexableRecords

var ignoreIndexableRecords: Boolean = false

Specify whether to ignore com.mapbox.search.record.IndexableRecord results or not, default is false.

languages

var languages: List<Language>?

Specify the user’s language.

limit

var limit: Int? = null

Specify the maximum number of results to return.

navigationOptions

var navigationOptions: SearchNavigationOptions? = null

Navigation options used for proper calculation of ETA and results ranking.

origin

var origin: Point? = null

Point for ETA calculation from it to search result.

proximity

var proximity: Point? = null

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

requestDebounce

var requestDebounce: Int? = null

Request debounce value in milliseconds.

routeOptions

var routeOptions: RouteOptions? = null

Options to configure Route for search along the route functionality.

types

var types: List<QueryType>? = null

Filter results to include only a subset (one or more) of the available feature types.

unsafeParameters

var unsafeParameters: Map<String, String>? = null

Non-verified query parameters, that will be added to the server API request.