SearchOptions

class SearchOptions @JvmOverloads() constructor(proximity: Point?, boundingBox: BoundingBox?, countries: List<IsoCountryCode>?, fuzzyMatch: Boolean?, languages: List<IsoLanguageCode>?, 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.

See also

Constructors

SearchOptions
Link copied to clipboard
fun SearchOptions(proximity: Point? = null, boundingBox: BoundingBox? = null, countries: List<IsoCountryCode>? = null, fuzzyMatch: Boolean? = null, languages: List<IsoLanguageCode>? = 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
Link copied to clipboard
class Builder
Builder for comfortable creation of SearchOptions instance.

Functions

copy
Link copied to clipboard
fun copy(proximity: Point? = this.proximity, boundingBox: BoundingBox? = this.boundingBox, countries: List<IsoCountryCode>? = this.countries, fuzzyMatch: Boolean? = this.fuzzyMatch, languages: List<IsoLanguageCode>? = 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
Link copied to clipboard
abstract fun describeContents(): Int
toBuilder
Link copied to clipboard
fun toBuilder(): SearchOptions.Builder
Creates new SearchOptions.Builder from current SearchOptions instance.
writeToParcel
Link copied to clipboard
abstract fun writeToParcel(p0: Parcel, p1: Int)

Properties

boundingBox
Link copied to clipboard
val boundingBox: BoundingBox? = null
Limit results to only those contained within the supplied bounding box.
countries
Link copied to clipboard
val countries: List<IsoCountryCode>? = null
Limit results to one or more countries.
fuzzyMatch
Link copied to clipboard
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
Link copied to clipboard
val ignoreIndexableRecords: Boolean = false
Specify whether to ignore com.mapbox.search.record.IndexableRecord results or not, default is false.
indexableRecordsDistanceThresholdMeters
Link copied to clipboard
val indexableRecordsDistanceThresholdMeters: Double? = null
Allows to look up for indexable records only within specified distance threshold, i.e.
languages
Link copied to clipboard
val languages: List<IsoLanguageCode>?
Specify the user’s language.
limit
Link copied to clipboard
val limit: Int? = null
Specify the maximum number of results to return, including results from com.mapbox.search.record.IndexableDataProvider.
navigationOptions
Link copied to clipboard
val navigationOptions: SearchNavigationOptions? = null
Navigation options used for proper calculation of ETA and results ranking.
origin
Link copied to clipboard
val origin: Point? = null
Point for ETA calculation from it to search result.
proximity
Link copied to clipboard
val proximity: Point? = null
Bias the response to favor results that are closer to this location, provided as Point.
requestDebounce
Link copied to clipboard
val requestDebounce: Int? = null
Request debounce value in milliseconds.
routeOptions
Link copied to clipboard
val routeOptions: RouteOptions? = null
Options to configure Route for search along the route functionality.
types
Link copied to clipboard
val types: List<QueryType>? = null
Filter results to include only a subset (one or more) of the available feature types.
unsafeParameters
Link copied to clipboard
val unsafeParameters: Map<String, String>? = null
Non-verified query parameters, that will be added to the server API request.