com.tomtom.sdk.search:search-hybrid/com.tomtom.sdk.search.hybrid/HybridSearch

HybridSearch

class HybridSearch : Search

Implementation of the TomTom's Hybrid Search API.

Important: This is a Public Preview API. It may be changed or removed at any time.

Types

Companion

object Companion

Contains factory methods for creating instances of HybridSearch.

Functions

autocompleteSearch

open override fun autocompleteSearch(options: AutocompleteOptions): Result<AutocompleteResponse, SearchFailure>

open override fun autocompleteSearch(options: AutocompleteOptions, callback: AutocompleteCallback): Cancellable

Autocomplete Search feature can predict what a user is searching for based on what they have already typed in. It can identify entities within a user's query and suggest them as potential search terms. This feature optimizes the accuracy of the search results by offering relevant suggestions and completing the user's query.

open override fun close()

Closes the search engine and releases all resources.

requestGeometryData

open override fun requestGeometryData(options: GeometryDataOptions): Result<GeometryDataResponse, SearchFailure>

Performs a synchronous geometry data request described by the provided GeometryDataOptions object. Delivers the Result containing a GeometryDataResponse, or a SearchFailure if the action fails.

open override fun requestGeometryData(options: GeometryDataOptions, callback: GeometryDataCallback): Cancellable

Performs an asynchronous geometry data request described by the provided GeometryDataOptions object. Returns the result using the provided GeometryDataCallback.

requestPoiCategories

open override fun requestPoiCategories(options: PoiCategoryOptions): Result<PoiCategoryResponse, SearchFailure>

Synchronously provides a full list of POI categories and subcategories together with their translations and synonyms.

open override fun requestPoiCategories(options: PoiCategoryOptions, callback: PoiCategoryCallback): Cancellable

Asynchronously provides a complete list of POI categories and subcategories with their translations and synonyms.

requestPoiDetails

open override fun requestPoiDetails(options: PoiDetailsOptions): Result<PoiDetailsResponse, SearchFailure>

Synchronously, provides POI details by a given POI identifier.

open override fun requestPoiDetails(options: PoiDetailsOptions, callback: PoiDetailsCallback): Cancellable

Asynchronously, provides POI details by a given POI identifier.

open override fun search(searchOptions: SearchOptions): Result<SearchResponse, SearchFailure>

Performs a synchronous search computing action based on the provided SearchOptions object and delivers the Result by the provided SearchResponse, or by a SearchFailure if the action fails.

open override fun search(options: SearchOptions, callback: SearchCallback): Cancellable

Performs an asynchronous search computing action based on the provided SearchOptions object and returns the result by the provided SearchCallback.

sendFeedback

open override fun sendFeedback(feedbackEvent: FeedbackEvent): Result<Unit, SearchFailure>

Synchronously sends a feedback event for the search.

open override fun sendFeedback(feedbackEvent: FeedbackEvent, callback: FeedbackCallback): Cancellable

Asynchronously sends a feedback event for the search.