SearchOptions

data class SearchOptions(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) : Parcelable

Search options, used for forward geocoding.

Constructors

SearchOptions

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)

Types

Builder

class Builder

Builder for comfortable creation of SearchOptions instance.

Functions

component1

operator fun component1(): Point?

component10

operator fun component10(): SearchNavigationOptions?

component11

operator fun component11(): RouteOptions?

component12

operator fun component12(): Map<String, String>?

component13

operator fun component13(): Boolean

component2

operator fun component2(): BoundingBox?

component3

operator fun component3(): List<Country>?

component4

operator fun component4(): Boolean?

component5

operator fun component5(): List<Language>?

component6

operator fun component6(): Int?

component7

operator fun component7(): List<QueryType>?

component8

operator fun component8(): Int?

component9

operator fun component9(): Point?

copy

fun copy(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): SearchOptions

describeContents

abstract fun describeContents(): Int

equals

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

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String

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.

languages

val languages: List<Language>?

Specify the user’s language.

limit

val limit: Int? = null

Specify the maximum number of results to return.

navigationOptions

val navigationOptions: SearchNavigationOptions? = null

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