com.tomtom.online.sdk.search.api.autocomplete

Interface AutocompleteSearchApi

All Superinterfaces:

com.tomtom.online.sdk.common.rx.RxContext

public interface AutocompleteSearchApi
extends com.tomtom.online.sdk.common.rx.RxContext

Defines the Autocomplete Search API.

Method Summary

Modifier and Type	Method and Description
Single<AutocompleteSearchResponse>	autocompleteSearch(AutocompleteSearchQuery query) Performs a reactive Autocomplete search action based on the provided query object, and returns the result to Observers subscribed to the returned Observable.
void	autocompleteSearch(AutocompleteSearchQuery query, AutocompleteSearchResultListener listener) Performs an Autocomplete search action based on the provided AutocompleteSearchQuery object and returns the result with usage of a callback implementation.
void	cancelSearchIfRunning() Cancels the current Autocomplete search Request.

Methods inherited from interface com.tomtom.online.sdk.common.rx.RxContext

getResultScheduler, getWorkingScheduler

Method Detail

autocompleteSearch

void autocompleteSearch(AutocompleteSearchQuery query,
                        AutocompleteSearchResultListener listener)

Performs an Autocomplete search action based on the provided AutocompleteSearchQuery object and returns the result with usage of a callback implementation.

Parameters:

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

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

cancelSearchIfRunning

void cancelSearchIfRunning()

Cancels the current Autocomplete search Request.

autocompleteSearch

Single<AutocompleteSearchResponse> autocompleteSearch(AutocompleteSearchQuery query)

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

Parameters:

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

Returns:

The search Response Observable object.