OnlineSearchApi (Android Search SDK

java.lang.Object
- com.tomtom.online.sdk.search.OnlineSearchApi

All Implemented Interfaces:

RxSearchApi, 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 inherited from interface com.tomtom.online.sdk.search.SearchApi
  DEFAULT_ONLINE_SEARCH_ENDPOINT, DEFAULT_ONLINE_SEARCH_SERVICE_API_VERSION

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`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`	`cancelSearchIfRunning()` Cancels all current search requests.
`static SearchApi`	`create(android.content.Context context)` Creates new SearchAPI object which will use provided online search service api key.
`Single<GeometrySearchResponse>`	`geometrySearch(GeometrySearchQuery query)` Performs reactive geometry search action based on provided GeometrySearchQuery object and returns the result to Observers subscribed to returned Single.
`void`	`geometrySearch(GeometrySearchQuery query, GeometrySearchResultListener listener)` Performs geometry search action based on provided GeometrySearchQuery object and returns the result with usage of GeometrySearchResultListener implementation.
`protected AlongRouteSearchApi`	`getAlongRouteSearchApi()`
`protected FuzzySearchApi`	`getFuzzySearchApi()`
`protected GeometrySearchApi`	`getGeometrySearchApi()`
`protected RevGeoSearchApi`	`getRevgeoSearchApi()`
`boolean`	`isInternetAvailable()` Checks if the internet is available.
`Single<ReverseGeocoderSearchResult>`	`reverseGeocoding(ReverseGeocoderSearchQuery query)` Performs reactive reverse geocoding search action based on provided ReverseGeocoderSearchQueryBuilder object and returns the result to Observers subscribed to returned Single.
`void`	`reverseGeocoding(ReverseGeocoderSearchQuery query, RevGeoSearchResultListener listener)` Performs reverse geocoding search action based on provided ReverseGeocoderSearchQueryBuilder object and returns the result with usage of RevGeoSearchCallback implementation.
`Single<FuzzySearchResponse>`	`search(FuzzySearchQuery searchQuery)` Performs reactive search action based on provided FuzzySearchQuery object and returns the result to Observers subscribed to returned Observable.
`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 class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 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.
  - search
```
public void search(FuzzySearchQuery searchQuery,
                   FuzzySearchResultListener listener)
```
    Description copied from interface: SearchApi
    
    Performs search action based on provided FuzzySearchQuery object and returns the result with usage of FuzzySearchResultListener implementation.
    
    Specified by:
    
    search in interface SearchApi
    
    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
```
public void reverseGeocoding(ReverseGeocoderSearchQuery query,
                             RevGeoSearchResultListener listener)
```
    Description copied from interface: SearchApi
    
    Performs reverse geocoding search action based on provided ReverseGeocoderSearchQueryBuilder object and returns the result with usage of RevGeoSearchCallback implementation.
    
    Specified by:
    
    reverseGeocoding in interface SearchApi
    
    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 ReverseGeocoderSearchResult object
  - geometrySearch
```
public void geometrySearch(GeometrySearchQuery query,
                           GeometrySearchResultListener listener)
```
    Description copied from interface: SearchApi
    
    Performs geometry search action based on provided GeometrySearchQuery object and returns the result with usage of GeometrySearchResultListener implementation.
    
    Specified by:
    
    geometrySearch in interface SearchApi
    
    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
```
public void alongRouteSearch(AlongRouteSearchQuery query,
                             AlongRouteSearchResultListener listener)
```
    Description copied from interface: SearchApi
    
    Performs along route search action based on provided query object and returns the result with usage of callback implementation.
    
    Specified by:
    
    alongRouteSearch in interface SearchApi
    
    Parameters:
    
    query - The object which contains data necessary to execute search action.
    
    listener - The callback which informs the subscriber when search result is available.
  - search
```
public Single<FuzzySearchResponse> search(FuzzySearchQuery searchQuery)
```
    Description copied from interface: RxSearchApi
    
    Performs reactive search action based on provided FuzzySearchQuery object and returns the result to Observers subscribed to returned Observable.
    
    Specified by:
    
    search in interface RxSearchApi
    
    Parameters:
    
    searchQuery - Object which contains data necessary to execute search action
    
    Returns:
    
    FuzzySearchResponse's Observable object.
  - reverseGeocoding
```
public Single<ReverseGeocoderSearchResult> reverseGeocoding(ReverseGeocoderSearchQuery query)
```
    Description copied from interface: RxSearchApi
    
    Performs reactive reverse geocoding search action based on provided ReverseGeocoderSearchQueryBuilder object and returns the result to Observers subscribed to returned Single.
    
    Specified by:
    
    reverseGeocoding in interface RxSearchApi
    
    Parameters:
    
    query - The object which contains data necessary to execute search action
    
    Returns:
    
    ReverseGeocoderSearchResult's Single object.
  - geometrySearch
```
public Single<GeometrySearchResponse> geometrySearch(GeometrySearchQuery query)
```
    Description copied from interface: RxSearchApi
    
    Performs reactive geometry search action based on provided GeometrySearchQuery object and returns the result to Observers subscribed to returned Single.
    
    Specified by:
    
    geometrySearch in interface RxSearchApi
    
    Parameters:
    
    query - The object which contains data necessary to execute search action
    
    Returns:
    
    com.tomtom.online.sdk.search.data.geometry.response.Response's Single object.
  - alongRouteSearch
```
public Single<AlongRouteSearchResponse> alongRouteSearch(AlongRouteSearchQuery query)
```
    Description copied from interface: RxSearchApi
    
    Performs reactive search along route action based on provided query object and returns the result to Observers subscribed to returned Observable.
    
    Specified by:
    
    alongRouteSearch in interface RxSearchApi
    
    Parameters:
    
    query - Object which contains data necessary to execute search action
    
    Returns:
    
    Search response's Observable object.
  - isInternetAvailable
```
public boolean isInternetAvailable()
```
    Description copied from interface: SearchApi
    
    Checks if the internet is available.
    
    Specified by:
    
    isInternetAvailable in interface SearchApi
    
    Returns:
    
    true if device is online, false otherwise.
  - cancelSearchIfRunning
```
public void cancelSearchIfRunning()
```
    Description copied from interface: SearchApi
    
    Cancels all current search requests.
    
    Specified by:
    
    cancelSearchIfRunning in interface SearchApi
  - getFuzzySearchApi
```
protected FuzzySearchApi getFuzzySearchApi()
```
  - getRevgeoSearchApi
```
protected RevGeoSearchApi getRevgeoSearchApi()
```
  - getGeometrySearchApi
```
protected GeometrySearchApi getGeometrySearchApi()
```
  - getAlongRouteSearchApi
```
protected AlongRouteSearchApi getAlongRouteSearchApi()
```

Class OnlineSearchApi

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

search

reverseGeocoding

geometrySearch

alongRouteSearch

search

reverseGeocoding

geometrySearch

alongRouteSearch

isInternetAvailable

cancelSearchIfRunning

getFuzzySearchApi

getRevgeoSearchApi

getGeometrySearchApi

getAlongRouteSearchApi