public class OnlineSearchAPI extends java.lang.Object implements SearchAPI
Modifier and Type | Field and Description |
---|---|
protected java.util.List<com.tomtom.online.sdk.search.SearchEngine> |
searchEngines |
DEFAULT_ONLINE_SEARCH_ENDPOINT, DEFAULT_ONLINE_SEARCH_SERVICE_API_VERSION
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.
|
protected java.util.List<com.tomtom.online.sdk.search.SearchEngine> searchEngines
public static SearchAPI create(@NonNull android.content.Context context)
public void cancelSearchIfRunning()
public void search(SearchQuery searchQuery, SearchCallback searchCallback)
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.public Observable<SearchResponse> search(SearchQuery searchQuery)
searchQuery
- Object which contains data necessary to execute search actionpublic Single<ReverseGeocoderResult> reverseGeocoding(ReverseGeocoderQuery query)
query
- The object which contains data necessary to execute search actionpublic void reverseGeocoding(ReverseGeocoderQuery query, RevGeoSearchCallback callback)
query
- The object which contains data necessary to execute search actioncallback
- The callback which informs the subscriber when search result is available. It contains ReverseGeocoderResult objectpublic SearchAPI callsRequireInternet(android.content.Context context)
RequiresInternetConnectivity
callsRequireInternet
in interface RequiresInternetConnectivity
public boolean isInternetAvailable()
RequiresInternetConnectivity
isInternetAvailable
in interface RequiresInternetConnectivity