com.tomtom.online.sdk.search.api.alongroute

Interface AlongRouteSearchApi

All Superinterfaces:

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

All Known Implementing Classes:

AlongRouteSearchApiImpl

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

Defines the along route search api.

Method Summary

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 the current along route search request.

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

getResultScheduler, getWorkingScheduler

Method Detail

alongRouteSearch

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.

Parameters:

query - Object which contains data necessary to execute search action

Returns:

Search response's Observable 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.

cancelSearchIfRunning

void cancelSearchIfRunning()

Cancels the current along route search request.