com.tomtom.online.sdk.search.api.geometry

Interface GeometrySearchApi

All Superinterfaces:

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

All Known Implementing Classes:

GeometrySearchApiImpl

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

Defines the geometry search api.

Method Summary

Modifier and Type	Method and Description
void	cancelSearchIfRunning() Cancels the current geometry search request.
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.

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

getResultScheduler, getWorkingScheduler

Method Detail

geometrySearch

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.

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.

geometrySearch

void geometrySearch(GeometrySearchQuery query,
                    GeometrySearchResultListener listener)

Performs geometry search action based on provided GeometrySearchQuery object and returns the result with usage of GeometrySearchResultListener implementation.

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 GeometrySearchResult object

cancelSearchIfRunning

void cancelSearchIfRunning()

Cancels the current geometry search request.