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 alongRouteSearch(options: AlongRouteSearchOptions): Result<AlongRouteSearchResponse, SearchError>

Performs a synchronous search along the route described by the provided AlongRouteSearchOptions object. Delivers the Result containing an AlongRouteSearchResponse, or a SearchError if the action fails.

abstract fun alongRouteSearch(options: AlongRouteSearchOptions, callback: AlongRouteSearchCallback): Cancellable

Performs an asynchronous search along the route described by the provided AlongRouteSearchOptions object. Returns the result using the provided AlongRouteSearchCallback.

Link copied to clipboard
abstract fun autocompleteSearch(options: AutocompleteSearchOptions): Result<AutocompleteSearchResponse, SearchError>

Performs a synchronous Autocomplete Search using the provided AutocompleteSearchOptions object. Delivers the Result using an AutocompleteSearchResponse, or a SearchError if the action fails.

abstract fun autocompleteSearch(options: AutocompleteSearchOptions, callback: AutocompleteSearchCallback): Cancellable

Performs an asynchronous autocomplete search using the provided AutocompleteSearchOptions object. Returns the result using the provided AutocompleteSearchCallback.

Link copied to clipboard
abstract fun close()
Link copied to clipboard
abstract fun evChargingStationSearch(options: EvChargingStationsAvailabilityOptions): Result<EvChargingStationsAvailabilityResponse, SearchError>

Performs a synchronous EV Charging Stations Availability search using the provided EvChargingStationsAvailabilityOptions object. Delivers a Result containing an EvChargingStationsAvailabilityResponse, or a SearchError if the call fails.

abstract fun evChargingStationSearch(options: EvChargingStationsAvailabilityOptions, callback: EvChargingStationsAvailabilityCallback): Cancellable

Performs an asynchronous EV Charging Stations Availability search using the provided EvChargingStationsAvailabilityOptions object. Returns the result using the provided EvChargingStationsAvailabilityCallback.

Link copied to clipboard
abstract fun requestGeometryData(options: GeometryDataOptions): Result<GeometryDataResponse, SearchError>

Performs a synchronous geometry data request described by the provided GeometryDataOptions object. Delivers the Result containing a GeometryDataResponse, or a SearchError 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, SearchError>

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, SearchError>

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, SearchError>

Performs a synchronous search computing action based on the provided SearchOptions object and delivers the Result by the provided SearchResponse, or by a SearchError 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.