com.tomtom.online.sdk.search

Interface SearchApi

All Superinterfaces:

RxSearchApi

All Known Implementing Classes:

OnlineSearchApi, SearchService

public interface SearchApi
extends RxSearchApi

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_ONLINE_SEARCH_ENDPOINT Default TomTom's Search API endpoint.
static java.lang.String	DEFAULT_ONLINE_SEARCH_SERVICE_API_VERSION Default TomTom's Search API service version.

Method Summary

Modifier and Type	Method and Description
void	additionalDataSearch(AdditionalDataSearchQuery query, AdditionalDataSearchResultListener listener) Performs additional data search action based on provided query object and returns the result with usage of callback implementation.
void	alongRouteSearch(AlongRouteSearchQuery query, AlongRouteSearchResultListener listener) Performs along route search action based on provided query object and returns the result with usage of callback implementation.
void	batchSearch(BatchSearchQuery query, BatchSearchResultListener listener) Performs batch search action based on provided query object and returns the result with usage of callback implementation.
void	cancelSearchIfRunning() Cancels all current search requests.
void	geometrySearch(GeometrySearchQuery query, GeometrySearchResultListener listener) Performs geometry search action based on provided GeometrySearchQuery object and returns the result with usage of GeometrySearchResultListener implementation.
boolean	isInternetAvailable() Checks if the internet is available.
void	reverseGeocoding(ReverseGeocoderSearchQuery query, RevGeoSearchResultListener listener) Performs reverse geocoding search action based on provided ReverseGeocoderSearchQuery object and returns the result with usage of RevGeoSearchResultListener implementation.
void	search(FuzzySearchQuery searchQuery, FuzzySearchResultListener listener) Performs search action based on provided FuzzySearchQuery object and returns the result with usage of FuzzySearchResultListener implementation.

Methods inherited from interface com.tomtom.online.sdk.search.RxSearchApi

additionalDataSearch, alongRouteSearch, batchSearch, geometrySearch, reverseGeocoding, search

Field Detail

DEFAULT_ONLINE_SEARCH_ENDPOINT

static final java.lang.String DEFAULT_ONLINE_SEARCH_ENDPOINT

Default TomTom's Search API endpoint.

See Also:

Constant Field Values

DEFAULT_ONLINE_SEARCH_SERVICE_API_VERSION

static final java.lang.String DEFAULT_ONLINE_SEARCH_SERVICE_API_VERSION

Default TomTom's Search API service version.

See Also:

Constant Field Values

Method Detail

search

void search(FuzzySearchQuery searchQuery,
            FuzzySearchResultListener listener)

Performs search action based on provided FuzzySearchQuery object and returns the result with usage of FuzzySearchResultListener implementation.

Parameters:

searchQuery - The object which contains data necessary to execute search action.

listener - The listener which informs the subscriber when search result is available. It contains FuzzySearchResponse object.

reverseGeocoding

void reverseGeocoding(ReverseGeocoderSearchQuery query,
                      RevGeoSearchResultListener listener)

Performs reverse geocoding search action based on provided ReverseGeocoderSearchQuery object and returns the result with usage of RevGeoSearchResultListener implementation.

Parameters:

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

listener - The listener which informs the subscriber when search result is available. It contains ReverseGeocoderSearchResponse object

geometrySearch

void geometrySearch(GeometrySearchQuery query,
                    GeometrySearchResultListener listener)

Performs geometry search action based on provided GeometrySearchQuery object and returns the result with usage of GeometrySearchResultListener implementation.

Parameters:

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

listener - The listener which informs the subscriber when search result is available. It contains Response object

alongRouteSearch

void alongRouteSearch(AlongRouteSearchQuery query,
                      AlongRouteSearchResultListener listener)

Performs along route search action based on provided query object and returns the result with usage of callback implementation.

Parameters:

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

listener - The callback which informs the subscriber when search result is available.

additionalDataSearch

void additionalDataSearch(AdditionalDataSearchQuery query,
                          AdditionalDataSearchResultListener listener)

Performs additional data search action based on provided query object and returns the result with usage of callback implementation.

Parameters:

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

listener - The callback which informs the subscriber when search result is available.

batchSearch

void batchSearch(BatchSearchQuery query,
                 BatchSearchResultListener listener)

Performs batch search action based on provided query object and returns the result with usage of callback implementation. A number of batch items is limited to 100.

Parameters:

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

listener - The callback which informs the subscriber when search result is available.

isInternetAvailable

boolean isInternetAvailable()

Checks if the internet is available.

Returns:

true if device is online, false otherwise.

cancelSearchIfRunning

void cancelSearchIfRunning()

Cancels all current search requests.