search:search-client-api/com.tomtom.sdk.search/Search

Search

interface Search : AutoCloseable

Interface of the search API.

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

Functions

Link copied to clipboard
abstract fun autocompleteSearch(options: AutocompleteOptions): Result<AutocompleteResponse, SearchFailure>

Performs a synchronous Autocomplete Search using the provided AutocompleteOptions object. Delivers the Result using an AutocompleteResponse, or a SearchFailure if the action fails.

abstract fun autocompleteSearch(options: AutocompleteOptions, callback: AutocompleteCallback): Cancellable

Performs an asynchronous autocomplete search using the provided AutocompleteOptions object. Returns the result using the provided AutocompleteCallback.

Link copied to clipboard
abstract fun close()
Link copied to clipboard
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.

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.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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.