sdk/com.mapbox.search/SearchOptions

SearchOptions

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

Search options, used for forward geocoding.

Constructors

SearchOptions

@JvmOverloads

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

class Builder

Builder for comfortable creation of SearchOptions instance.

Functions

copy

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

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. The bounding box cannot cross the 180th meridian (longitude +/-180.0 deg.) and North or South pole (latitude +/- 90.0 deg.).

countries

val countries: List<IsoCountryCode>? = 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). For example, the default setting might return Washington, DC for a query of Washington, even though the query was misspelled.

ignoreIndexableRecords

val ignoreIndexableRecords: Boolean = false

Specify whether to ignore com.mapbox.search.record.IndexableRecord results or not, default is false. When search by com.mapbox.search.record.IndexableRecord is enabled, the results can be matched only by query string, while other parameters like countries, languages, unsafeParameters (and some others) can be ignored.

indexableRecordsDistanceThresholdMeters

val indexableRecordsDistanceThresholdMeters: Double? = null

Allows to look up for indexable records only within specified distance threshold, i.e. within a circle with this radius. Threshold specified in meters.

languages

val languages: List<IsoLanguageCode>?

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.

limit

val limit: Int? = null

Specify the maximum number of results to return, including results from com.mapbox.search.record.IndexableDataProvider. The maximum number of search results returned from the server is 10.

navigationOptions

val navigationOptions: SearchNavigationOptions? = null

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

origin

val origin: Point? = null

Point for ETA calculation from it to search result.

proximity

val proximity: Point? = null

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

requestDebounce

val requestDebounce: Int? = null

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

routeOptions

val routeOptions: RouteOptions? = null

Options to configure Route for search along the route functionality.

types

val types: List<QueryType>? = null

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.

unsafeParameters

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

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

SearchOptions

See also

Constructors

Types

Functions

Properties