sdk-search / com.tomtom.online.sdk.search.autocomplete / AutocompleteSpecification

AutocompleteSpecification

@PublicPreview("2021.06") data class AutocompleteSpecification

Represents parameters that will be used for the Autocomplete search.

Parameters

term - The searched term.

language - Language in which the autocomplete results should be returned. Should be one of the TomTom supported IETF language tags. See https://developer.tomtom.com/search-api/search-api/supported-languages for more details.

searchEngineDescriptor - Describes the configuration of the Autocomplete search engine.

locationDescriptor - Describes the location that will be used for the Autocomplete search.

Types

Builder

class Builder

Builder used to create an instance of AutocompleteSpecification. Once constructed, the user cannot change the field values.

Properties

language

val language: String

Language in which the autocomplete results should be returned. Should be one of the TomTom supported IETF language tags. See https://developer.tomtom.com/search-api/search-api/supported-languages for more details.

locationDescriptor

val locationDescriptor: AutocompleteLocationDescriptor?

Describes the location that will be used for the Autocomplete search.

searchEngineDescriptor

val searchEngineDescriptor: AutocompleteSearchEngineDescriptor?

Describes the configuration of the Autocomplete search engine.

term

val term: String

The searched term.