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

AutocompleteSearchEngineDescriptor

@PublicPreview("2021.06") data class AutocompleteSearchEngineDescriptor

Describes the configuration of the Autocomplete search engine.

Parameters

limit - The maximum number of autocomplete results that will be returned. Default value is 5, maximum value is 10.

resultTypes - Restricts the result space based on the segment types (e.g., "category", "brand", or "category,brand"). A result is only included if at least one segment is any of the indicated types.

Types

Builder

class Builder

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

Properties

limit

val limit: Int

The maximum number of autocomplete results that will be returned. Default value is 5, maximum value is 10.

resultTypes

val resultTypes: List<ResultType>

Restricts the result space based on the segment types (e.g., "category", "brand", or "category,brand"). A result is only included if at least one segment is any of the indicated types.