SearchApiParameters

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
data class SearchApiParameters(val limit: Int = 10, val typeAhead: Boolean = true, val position: GeoPoint? = null, val radius: Float? = null, val language: Locale? = null) : Parcelable

Deprecated

This will be removed from future releases after 2026-07-26.

Parameters used to configure the Search API query.

Constructors

Link copied to clipboard
constructor(limit: Int = 10, typeAhead: Boolean = true, position: GeoPoint? = null, radius: Float? = null, language: Locale? = null)

Properties

Link copied to clipboard
val language: Locale? = null

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

Link copied to clipboard
val limit: Int = 10

Specifies the maximum number of search results.

Link copied to clipboard
val position: GeoPoint? = null

Specifies the position toward which results should be biased.

Link copied to clipboard
val radius: Float? = null

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

Link copied to clipboard
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.

Inherited functions

Link copied to clipboard
abstract fun describeContents(): Int
Link copied to clipboard
abstract fun writeToParcel(p0: Parcel, p1: Int)