sdk-search / com.tomtom.online.sdk.search / SearchApi

SearchApi

interface SearchApi : RxSearchApi

Defines the TomTom Search API main object. It contains methods to use TomTom's search engine, and it provides support for standard callback calls.

Properties

DEFAULT_ONLINE_SEARCH_ENDPOINT	`static val DEFAULT_ONLINE_SEARCH_ENDPOINT: String` Default TomTom's Search API endpoint.
DEFAULT_ONLINE_SEARCH_SERVICE_API_VERSION	`static val DEFAULT_ONLINE_SEARCH_SERVICE_API_VERSION: String` Default TomTom's Search API service version.

Functions

additionalDataSearch	`abstract fun additionalDataSearch(query: AdditionalDataSearchQuery!, listener: AdditionalDataSearchResultListener!): Unit` Performs an additional data search action based on the provided query object, and returns the result with usage of the callback implementation.
alongRouteSearch	`abstract fun alongRouteSearch(query: AlongRouteSearchQuery!, listener: AlongRouteSearchResultListener!): Unit` Performs along route search action based on provided query object and returns the result with usage of callback implementation.
autocompleteSearch	`abstract fun autocompleteSearch(query: AutocompleteSearchQuery!, listener: AutocompleteSearchResultListener!): Unit` Performs an Autocomplete search action based on the provided query object, and returns the result using the callback implementation.
batchSearch	`abstract fun batchSearch(query: BatchSearchQuery!, listener: BatchSearchResultListener!): Unit` Performs a Batch Search action based on the provided query object, and returns the result with usage of the callback implementation. The number of batch items is limited to 100.
cancelSearchIfRunning	`abstract fun cancelSearchIfRunning(): Unit` Cancels all current search requests.
geometrySearch	`abstract fun geometrySearch(query: GeometrySearchQuery!, listener: GeometrySearchResultListener!): Unit` Performs geometry search action based on provided `GeometrySearchQuery` object and returns the result with usage of `GeometrySearchResultListener` implementation.
isInternetAvailable	`abstract fun isInternetAvailable(): Boolean` Checks if the internet is available.
poiCategoriesSearch	`abstract fun poiCategoriesSearch(query: PoiCategoriesQuery!, listener: PoiCategoriesSearchResultListener!): Unit` Performs a POI Categories search action based on the provided query object, and returns the result with usage of the callback implementation.
reverseGeocoding	`abstract fun reverseGeocoding(query: ReverseGeocoderSearchQuery!, listener: RevGeoSearchResultListener!): Unit` Performs reverse geocoding search action based on provided `ReverseGeocoderSearchQuery` object and returns the result with usage of `RevGeoSearchResultListener` implementation.
search	`abstract fun search(searchQuery: FuzzySearchQuery!, listener: FuzzySearchResultListener!): Unit` Performs search action based on provided `FuzzySearchQuery` object and returns the result with usage of `FuzzySearchResultListener` implementation.

Inherited Functions

additionalDataSearch	`abstract fun additionalDataSearch(query: AdditionalDataSearchQuery!): Single<AdditionalDataSearchResponse!>!` Performs a reactive additional data search action based on the provided query object, and returns the result to Observers subscribed to the returned Observable.
alongRouteSearch	`abstract fun alongRouteSearch(query: AlongRouteSearchQuery!): Single<AlongRouteSearchResponse!>!` Performs reactive search along route action based on provided query object and returns the result to Observers subscribed to returned Observable.
autocompleteSearch	`abstract fun autocompleteSearch(query: AutocompleteSearchQuery!): Single<AutocompleteSearchResponse!>!` Performs a reactive Autocomplete search action based on the provided query object, and returns the result to Observers subscribed to the returned Observable.
batchSearch	`abstract fun batchSearch(query: BatchSearchQuery!): Single<BatchSearchResponse!>!` Performs a reactive Batch Search action based on the provided query object, and returns the result to Observers subscribed to the returned Observable. The number of batch items is limited to 100.
geometrySearch	`abstract fun geometrySearch(query: GeometrySearchQuery!): Single<GeometrySearchResponse!>!` Performs a reactive geometry search action based on the provided query object and returns the result to Observers subscribed to returned Single.
poiCategoriesSearch	`abstract fun poiCategoriesSearch(query: PoiCategoriesQuery!): Single<PoiCategoriesResponse!>!` Performs a reactive POI Categories search action based on the provided query object, and returns the result to Observers subscribed to the returned Observable.
reverseGeocoding	`abstract fun reverseGeocoding(query: ReverseGeocoderSearchQuery!): Single<ReverseGeocoderSearchResponse!>!` Performs a reactive reverse geocoding search action based on the provided query object and returns the result to Observers subscribed to returned Single.
search	`abstract fun search(searchQuery: FuzzySearchQuery!): Single<FuzzySearchResponse!>!` Performs a reactive search action based on the provided query object, and returns the result to Observers subscribed to the returned Observable.

Inheritors

OnlineSearchApi	`open class OnlineSearchApi : SearchApi` Default TomTom implementation of the entry point to perform a search / reverse geocoding action based on TomTom's Search API.
SearchService	`open class SearchService : Service, SearchApi` TomTom Search API wrapped within Android service. It contains methods to use Tomtom's search engine and it provides support for both: standard callback calls and RxJava2 Observables. It allows to create a single search instance across an application.