com.tomtom.sdk.search:search/com.tomtom.sdk.search.autocomplete/AutocompleteOptions

AutocompleteOptions

data class AutocompleteOptions(val query: String, val locale: Locale = Locale.getDefault(), @IntRange(from = 1, to = 10) val limit: Int = DEFAULT_LIMIT, val position: GeoPoint? = null, val radius: Distance? = null, val countries: Set<String> = emptySet(), val resultTypes: Set<AutoCompleteResultType> = emptySet(), val sessionId: UUID? = null)

Used for building an Autocomplete search request. Contains the parameters to use in an autocomplete search.

Constructors

AutocompleteOptions

constructor(query: String, locale: Locale = Locale.getDefault(), @IntRange(from = 1, to = 10) limit: Int = DEFAULT_LIMIT, position: GeoPoint? = null, radius: Distance? = null, countries: Set<String> = emptySet(), resultTypes: Set<AutoCompleteResultType> = emptySet(), sessionId: UUID? = null)

Types

Companion

object Companion

Contains the default values for the AutocompleteOptions class.

Properties

countries

val countries: Set<String>

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

limit

val limit: Int

The maximum number of autocomplete results that will be returned. It defaults to DEFAULT_LIMIT. The maximum value for limit is MAX_LIMIT_VALUE.

locale

val locale: Locale

The language in which search results should be returned. If not specified, language is set to the system default language.

position

val position: GeoPoint? = null

The position around which results should be biased.

query

val query: String

The search query. Required parameter.

radius

val radius: Distance? = null

The search radius in meters.

resultTypes

val resultTypes: Set<AutoCompleteResultType>

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

val sessionId: UUID? = null

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. It must be a valid UUIDv4. If it is not provided, no feedback is sent.