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

SearchApi

interface SearchApi : Disposable
Content copied to clipboard

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 additionalDataSearch(additionalDataSearchOptions: AdditionalDataSearchOptions): Result<AdditionalDataSearchResponse, AdditionalDataSearchError>
Content copied to clipboard

Performs a synchronous additional data search described by the provided AdditionalDataSearchOptions object. Delivers the Result containing an AdditionalDataSearchResponse, or an AdditionalDataSearchError if the action fails.

abstract fun additionalDataSearch(additionalDataSearchOptions: AdditionalDataSearchOptions, additionalDataSearchCallback: AdditionalDataSearchCallback): Cancellable
Content copied to clipboard

Performs an asynchronous additional data search described by the provided AdditionalDataSearchOptions object. Returns the result using the provided AdditionalDataSearchCallback.

Link copied to clipboard
abstract fun alongRouteSearch(alongRouteSearchOptions: AlongRouteSearchOptions): Result<AlongRouteSearchResponse, AlongRouteSearchError>
Content copied to clipboard

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

abstract fun alongRouteSearch(alongRouteSearchOptions: AlongRouteSearchOptions, alongRouteSearchCallback: AlongRouteSearchCallback): Cancellable
Content copied to clipboard

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(autocompleteSearchOptions: AutocompleteSearchOptions): Result<AutocompleteSearchResponse, AutocompleteSearchError>
Content copied to clipboard

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

abstract fun autocompleteSearch(autocompleteSearchOptions: AutocompleteSearchOptions, autocompleteSearchCallback: AutocompleteSearchCallback): Cancellable
Content copied to clipboard

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

Link copied to clipboard
abstract fun dispose()
Content copied to clipboard
Link copied to clipboard
abstract fun evChargingStationSearch(evChargingStationsAvailabilityOptions: EvChargingStationsAvailabilityOptions): Result<EvChargingStationsAvailabilityResponse, EvChargingStationsAvailabilityError>
Content copied to clipboard

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

abstract fun evChargingStationSearch(evChargingStationsAvailabilityOptions: EvChargingStationsAvailabilityOptions, evChargingStationsAvailabilityCallback: EvChargingStationsAvailabilityCallback): Cancellable
Content copied to clipboard

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 fuzzySearch(fuzzySearchOptions: FuzzySearchOptions): Result<FuzzySearchResponse, FuzzySearchError>
Content copied to clipboard

Performs a synchronous Fuzzy Search computing action based on the provided FuzzySearchOptions object and delivers the Result by the provided an FuzzySearchResponse or a FuzzySearchError if the action fails.

abstract fun fuzzySearch(fuzzySearchOptions: FuzzySearchOptions, fuzzySearchCallback: FuzzySearchCallback): Cancellable
Content copied to clipboard

Performs an asynchronous Fuzzy Search computing action based on the provided FuzzySearchOptions object and returns the result by the provided FuzzySearchCallback.

Link copied to clipboard
abstract fun geometrySearch(geometrySearchOptions: GeometrySearchOptions): Result<GeometrySearchResponse, GeometrySearchError>
Content copied to clipboard

Performs a synchronous Geometry Search based on the provided GeometrySearchOptions object and delivers the Result by the provided GeometrySearchResponse or a GeometrySearchError if the search fails.

abstract fun geometrySearch(geometrySearchOptions: GeometrySearchOptions, geometrySearchCallback: GeometrySearchCallback): Cancellable
Content copied to clipboard

Performs an asynchronous Geometry Search based on the provided GeometrySearchOptions object and returns the result by the provided GeometrySearchCallback.

Link copied to clipboard
abstract fun poiCategoriesSearch(poiCategoriesSearchOptions: PoiCategoriesSearchOptions): Result<PoiCategoriesSearchResponse, PoiCategoriesSearchError>
Content copied to clipboard

Performs a synchronous POI categories search using the provided PoiCategoriesSearchOptions object. Delivers a Result containing a PoiCategoriesSearchResponse, or a PoiCategoriesSearchError if the call fails.

abstract fun poiCategoriesSearch(poiCategoriesSearchOptions: PoiCategoriesSearchOptions, poiCategoriesSearchCallback: PoiCategoriesSearchCallback): Cancellable
Content copied to clipboard

Performs an asynchronous POI categories search using the provided PoiCategoriesSearchOptions object. Returns the result using the provided PoiCategoriesSearchCallback.