forward

abstract fun forward(query: String, options: ForwardSearchOptions, executor: Executor, callback: SearchCallback): AsyncOperationTask

One-off search request to get a list of search results with coordinates and metadata. In contrast to Interactive Search (search and select functions), the forward request will not provide type-ahead suggestions, e.g., brand and category suggestions, but will only provide relevant search results. See the Text Search documentation page for more details.

This function makes a request to Search Box '/forward' endpoint.

Please note that this function is supported only for ApiType.SEARCH_BOX. If this SearchEngine was created with another ApiType, the SearchCallback.onError will be triggered immediately.

Return

AsyncOperationTask object representing pending completion of the request.

Parameters

query

Search query.

options

Search options.

executor

Executor used for events dispatching. By default events are dispatched on the main thread.

callback

Search result callback, delivers results using the provided executor.


open fun forward(query: String, options: ForwardSearchOptions, callback: SearchCallback): AsyncOperationTask

One-off search request to get a list of search results with coordinates and metadata. In contrast to Interactive Search (search and select functions), the forward request will not provide type-ahead suggestions, e.g., brand and category suggestions, but will only provide relevant search results. See the Text Search documentation page for more details.

This function makes a request to Search Box '/forward' endpoint.

Please note that this function is supported only for ApiType.SEARCH_BOX. If this SearchEngine was created with another ApiType, the SearchCallback.onError will be triggered immediately.

Return

AsyncOperationTask object representing pending completion of the request.

Parameters

query

Search query.

options

Search options.

callback

Search result callback, delivers results on the main thread.