com.tomtom.online.sdk.search

Interface RxSearchApi

All Known Subinterfaces:

SearchApi

All Known Implementing Classes:

OnlineSearchApi, SearchService

public interface RxSearchApi

Defines TomTom Search API main object. It contains methods to use Tomtom's search engine and it provides support for: reactive calls

Method Summary

Modifier and Type	Method and Description
Single<AdditionalDataSearchResponse>	additionalDataSearch(AdditionalDataSearchQuery query) Performs reactive additional data search action based on provided query object and returns the result to Observers subscribed to returned Observable.
Single<AlongRouteSearchResponse>	alongRouteSearch(AlongRouteSearchQuery query) Performs reactive search along route action based on provided query object and returns the result to Observers subscribed to returned Observable.
Single<BatchSearchResponse>	batchSearch(BatchSearchQuery query) Performs reactive batch search action based on provided query object and returns the result to Observers subscribed to returned Observable.
Single<GeometrySearchResponse>	geometrySearch(GeometrySearchQuery query) Performs reactive geometry search action based on provided query object and returns the result to Observers subscribed to returned Single.
Single<ReverseGeocoderSearchResponse>	reverseGeocoding(ReverseGeocoderSearchQuery query) Performs reactive reverse geocoding search action based on provided query object and returns the result to Observers subscribed to returned Single.
Single<FuzzySearchResponse>	search(FuzzySearchQuery searchQuery) Performs reactive search action based on provided query object and returns the result to Observers subscribed to returned Observable.

Method Detail

search

Single<FuzzySearchResponse> search(FuzzySearchQuery searchQuery)

Performs reactive search action based on provided query object and returns the result to Observers subscribed to returned Observable.

Parameters:

searchQuery - Object which contains data necessary to execute search action

Returns:

Search response's Observable object.

reverseGeocoding

Single<ReverseGeocoderSearchResponse> reverseGeocoding(ReverseGeocoderSearchQuery query)

Performs reactive reverse geocoding search action based on provided query object and returns the result to Observers subscribed to returned Single.

Parameters:

query - The object which contains data necessary to execute search action

Returns:

Search response's Single object.

geometrySearch

Single<GeometrySearchResponse> geometrySearch(GeometrySearchQuery query)

Performs reactive geometry search action based on provided query object and returns the result to Observers subscribed to returned Single.

Parameters:

query - The object which contains data necessary to execute search action

Returns:

Search response's Single object.

alongRouteSearch

Single<AlongRouteSearchResponse> alongRouteSearch(AlongRouteSearchQuery query)

Performs reactive search along route action based on provided query object and returns the result to Observers subscribed to returned Observable.

Parameters:

query - Object which contains data necessary to execute search action

Returns:

Search response's Observable object.

additionalDataSearch

Single<AdditionalDataSearchResponse> additionalDataSearch(AdditionalDataSearchQuery query)

Performs reactive additional data search action based on provided query object and returns the result to Observers subscribed to returned Observable.

Parameters:

query - Object which contains data necessary to execute additional data search action

Returns:

Search response's Observable object.

batchSearch

Single<BatchSearchResponse> batchSearch(BatchSearchQuery query)

Performs reactive batch search action based on provided query object and returns the result to Observers subscribed to returned Observable. A number of batch items is limited to 100

Parameters:

query - Object which contains data necessary to execute batch search action

Returns:

Search response's Observable object.