SearchOptions

class SearchOptions @JvmOverloads() constructor(proximity: Point?, boundingBox: BoundingBox?, countries: List<Country>?, fuzzyMatch: Boolean?, languages: List<Language>?, limit: Int?, types: List<QueryType>?, requestDebounce: Int?, origin: Point?, navigationOptions: SearchNavigationOptions?, routeOptions: RouteOptions?, unsafeParameters: Map<String, String>?, ignoreIndexableRecords: Boolean, indexableRecordsDistanceThresholdMeters: Double?) : Parcelable

Search options, used for forward geocoding.

Constructors

SearchOptions

@JvmOverloads()

fun SearchOptions(proximity: Point? = null, boundingBox: BoundingBox? = null, countries: List<Country>? = null, fuzzyMatch: Boolean? = null, languages: List<Language>? = defaultSearchOptionsLanguage(), limit: Int? = null, types: List<QueryType>? = null, requestDebounce: Int? = null, origin: Point? = null, navigationOptions: SearchNavigationOptions? = null, routeOptions: RouteOptions? = null, unsafeParameters: Map<String, String>? = null, ignoreIndexableRecords: Boolean = false, indexableRecordsDistanceThresholdMeters: Double? = null)

Types

Builder

class Builder

Builder for comfortable creation of SearchOptions instance.

Functions

copy

fun copy(proximity: Point? = this.proximity, boundingBox: BoundingBox? = this.boundingBox, countries: List<Country>? = this.countries, fuzzyMatch: Boolean? = this.fuzzyMatch, languages: List<Language>? = this.languages, limit: Int? = this.limit, types: List<QueryType>? = this.types, requestDebounce: Int? = this.requestDebounce, origin: Point? = this.origin, navigationOptions: SearchNavigationOptions? = this.navigationOptions, routeOptions: RouteOptions? = this.routeOptions, unsafeParameters: Map<String, String>? = this.unsafeParameters, ignoreIndexableRecords: Boolean = this.ignoreIndexableRecords, indexableRecordsDistanceThresholdMeters: Double? = this.indexableRecordsDistanceThresholdMeters): SearchOptions

Creates new SearchOptions from current instance.

describeContents

abstract fun describeContents(): Int

toBuilder

fun toBuilder(): SearchOptions.Builder

Creates new SearchOptions.Builder from current SearchOptions instance.

writeToParcel

abstract fun writeToParcel(p0: Parcel, p1: Int)

Properties

boundingBox

val boundingBox: BoundingBox? = null

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

countries

val countries: List<Country>? = null

Limit results to one or more countries.

fuzzyMatch

val 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

val ignoreIndexableRecords: Boolean = false

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

indexableRecordsDistanceThresholdMeters

val indexableRecordsDistanceThresholdMeters: Double? = null

Allows to look up for indexable records only within specified distance threshold, i.e.

languages

val languages: List<Language>?

Specify the user’s language.

limit

val limit: Int? = null

Specify the maximum number of results to return.