search:search-client-api/com.tomtom.sdk.search.autocomplete/AutocompleteSearchOptions/AutocompleteSearchOptions

AutocompleteSearchOptions

fun AutocompleteSearchOptions(query: String, locale: Locale? = null, @IntRange(from = 1, to = 10) limit: Int = 5, position: GeoPoint? = null, radius: Distance? = null, countries: Set<String> = emptySet(), resultTypes: Set<AutoCompleteResultType> = emptySet(), sessionId: String = "")

Parameters

query

The search query.

locale

The language in which search results should be returned.

limit

The maximum number of autocomplete results that will be returned.

position

The position around which results should be biased.

radius

The search radius in meters.

countries

A set of ISO 3166-1 alpha3 country codes. (e.g., FRA,ESP). This limits the autocomplete results to the specified countries.

resultTypes

Restricts the results to a specific result type. Valid result types are AutoCompleteResultType.Category and AutoCompleteResultType.Brand. An empty set implies restricting search results to both brand and category suggestions.

sessionId

A search session is a user session during which a user performs multiple search requests to find a specific address ot point of interest. This is needed for sending feedback to the online search.