search:search-ui/com.tomtom.sdk.search.ui.model/SearchApiParameters

SearchApiParameters

data class SearchApiParameters( val limit: Int = 10, val typeAhead: Boolean = true, val position: GeoCoordinate? = null, val radius: Float? = null, val minFuzzyLevel: Int? = null, val maxFuzzyLevel: Int? = null, val language: String? = null) : Parcelable

Parameters used to configure the Search API query.

Important: This is a Public Preview API. It may be changed or removed at any time.

Constructors

SearchApiParameters

fun SearchApiParameters( limit: Int = 10, typeAhead: Boolean = true, position: GeoCoordinate? = null, radius: Float? = null, minFuzzyLevel: Int? = null, maxFuzzyLevel: Int? = null, language: String? = null)

Functions

describeContents

abstract fun describeContents(): Int

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

Properties

val language: String? = null

Specifies the language of the search results. The list of supported languages can be found at: Supported Languages.

val limit: Int = 10

Specifies the maximum number of search results.

val maxFuzzyLevel: Int? = null

Specifies the maximum fuzziness level.

val minFuzzyLevel: Int? = null

Specifies the minimum fuzziness level.

val position: GeoCoordinate? = null

Specifies the position toward which results should be biased.

val radius: Float? = null

Specifies the search radius relative to position. This parameter is only used if position is provided.

val typeAhead: Boolean = true

If the typeAhead flag is set, the query is interpreted as a partial input and the search will enter predictive mode.