com.tomtom.online.sdk.search

Class OnlineSearchAPI

java.lang.Object

com.tomtom.online.sdk.search.OnlineSearchAPI

All Implemented Interfaces:

RequiresInternetConnectivity, SearchAPI

public class OnlineSearchAPI
extends java.lang.Object
implements SearchAPI

Default TomTom implementation of the entry point to perform search / reverse geocoding action based on TomTom's Online Search services.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<com.tomtom.online.sdk.search.SearchEngine>	searchEngines

Fields inherited from interface com.tomtom.online.sdk.search.SearchAPI

DEFAULT_ONLINE_SEARCH_ENDPOINT, DEFAULT_ONLINE_SEARCH_SERVICE_API_VERSION

Method Summary

Modifier and Type	Method and Description
SearchAPI	callsRequireInternet(android.content.Context context) Turn on when you want to validate Internet connection when executing request.
void	cancelSearchIfRunning() Cancels the current search request
static SearchAPI	create(android.content.Context context) Creates new SearchAPI object which will use provided online search service api key.
boolean	isInternetAvailable() True if Internet connection available, false otherwise.
Single<ReverseGeocoderResult>	reverseGeocoding(ReverseGeocoderQuery query) Performs reactive reverse geocoding search action based on provided ReverseGeocoderQueryBuilder object and returns the result to Observers subscribed to returned Single.
void	reverseGeocoding(ReverseGeocoderQuery query, RevGeoSearchCallback callback) Performs reverse geocoding search action based on provided ReverseGeocoderQueryBuilder object and returns the result with usage of RevGeoSearchCallback implementation.
Observable<SearchResponse>	search(SearchQuery searchQuery) Performs reactive search action based on provided SearchQuery object and returns the result to Observers subscribed to returned Observable.
void	search(SearchQuery searchQuery, SearchCallback searchCallback) Performs search action based on provided SearchQuery object and returns the result with usage of SearchCallback implementation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

searchEngines

protected java.util.List<com.tomtom.online.sdk.search.SearchEngine> searchEngines

Method Detail

create

public static SearchAPI create(@NonNull
                               android.content.Context context)

Creates new SearchAPI object which will use provided online search service api key. It uses default values for online search service endpoint and online search service api version.

Returns:

Newly created SearchAPI object for further processing.

cancelSearchIfRunning

public void cancelSearchIfRunning()

Cancels the current search request

search

public void search(SearchQuery searchQuery,
                   SearchCallback searchCallback)

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

Parameters:

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

searchCallback - The callback which informs the subscriber when search result is available. It contains SearchResponse object.

search

public Observable<SearchResponse> search(SearchQuery searchQuery)

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

Parameters:

searchQuery - Object which contains data necessary to execute search action

Returns:

SearchResponse's Observable object.

reverseGeocoding

public Single<ReverseGeocoderResult> reverseGeocoding(ReverseGeocoderQuery query)

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

Parameters:

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

Returns:

ReverseGeocoderResult's Single object.

reverseGeocoding

public void reverseGeocoding(ReverseGeocoderQuery query,
                             RevGeoSearchCallback callback)

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

Parameters:

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

callback - The callback which informs the subscriber when search result is available. It contains ReverseGeocoderResult object

callsRequireInternet

public SearchAPI callsRequireInternet(android.content.Context context)

Description copied from interface: RequiresInternetConnectivity

Turn on when you want to validate Internet connection when executing request. If not used, it is assumed that Internet is turned on by default.

Specified by:

callsRequireInternet in interface RequiresInternetConnectivity

isInternetAvailable

public boolean isInternetAvailable()

Description copied from interface: RequiresInternetConnectivity

True if Internet connection available, false otherwise.

Specified by:

isInternetAvailable in interface RequiresInternetConnectivity