com.tomtom.sdk.search:search-common/com.tomtom.sdk.search/Search

Search

The Search interface is a comprehensive set of APIs designed to seamlessly integrate advanced search functionality into your application.

Functions

autocompleteSearch

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

abstract 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.

evSearch

abstract fun evSearch(options: EvSearchOptions): Result<EvSearchResponse, SearchFailure>

Performs a synchronous Electric Vehicle (EV) search computing action based on the provided EvSearchOptions object and delivers the Result by the provided EvSearchResponse, or by a SearchFailure if the action fails.

abstract fun evSearch(options: EvSearchOptions, callback: EvSearchCallback): Cancellable

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

requestEvPoiDetails

open fun requestEvPoiDetails(options: EvPoiDetailsOptions): Result<EvPoiDetailsResponse, SearchFailure>

Synchronously, provides details of an Electric Vehicle (EV) Point of Interest (POI) by a given POI identifier. For accessing details for POIs belonging to other categories, use requestPoiDetails.

open fun requestEvPoiDetails(options: EvPoiDetailsOptions, callback: EvPoiDetailsCallback): Cancellable

Asynchronously, provides details of an Electric Vehicle (EV) Point of Interest (POI) by a given POI identifier. For accessing details for POIs belonging to other categories, use requestPoiDetails.

requestGeometryData

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

abstract 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.

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

abstract 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

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

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

abstract fun requestPoiCategories(options: PoiCategoryOptions, callback: PoiCategoryCallback): Cancellable

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

requestPoiDetails

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

Synchronously, provides POI details by a given POI identifier.

abstract fun requestPoiDetails(options: PoiDetailsOptions, callback: PoiDetailsCallback): Cancellable

Asynchronously, provides POI details by a given POI identifier.

abstract 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.

abstract 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

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

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

Synchronously sends a feedback event for the search.

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

abstract fun sendFeedback(feedbackEvent: FeedbackEvent, callback: FeedbackCallback): Cancellable

Asynchronously sends a feedback event for the search.

Inherited functions

abstract fun close()