sdk/com.mapbox.search/SearchEngine/search

search

abstract fun search(query: String, options: SearchOptions, executor: Executor, callback: SearchSuggestionsCallback): AsyncOperationTask

The first step of forward geocoding. Returns a list of SearchSuggestion without coordinates.

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

The callback to retrieve list of SearchSuggestion.

open fun search(query: String, options: SearchOptions, callback: SearchSuggestionsCallback): AsyncOperationTask

The first step of forward geocoding. Returns a list of SearchSuggestion without coordinates.

Return

AsyncOperationTask object representing pending completion of the request.

Parameters

query

Search query.

options

Search options.

callback

The callback to retrieve list of SearchSuggestion. Events are dispatched on the main thread.

open fun search(categoryName: String, options: CategorySearchOptions, executor: Executor, callback: SearchCallback): AsyncOperationTask

Performs a search request for places based on a category.

Return

AsyncOperationTask object representing pending completion of the request.

Parameters

categoryName

Name of category to search.

options

Category search options.

executor

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

callback

Search callback to retrieve results.

open fun search(categoryName: String, options: CategorySearchOptions, callback: SearchCallback): AsyncOperationTask

Performs a search request for places based on a category.

Return

AsyncOperationTask object representing pending completion of the request.

Parameters

categoryName

Name of category to search.

options

Category search options.

callback

Search callback to retrieve results. Events are dispatched on the main thread.

abstract fun search(categoryNames: List<String>, options: CategorySearchOptions, executor: Executor, callback: SearchCallback): AsyncOperationTask

Performs a search request for places based on multiple categories.

Return

AsyncOperationTask object representing pending completion of the request.

Parameters

categoryNames

Multiple categories to search.

options

Category search options.

executor

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

callback

Search callback to retrieve results.

open fun search(categoryNames: List<String>, options: CategorySearchOptions, callback: SearchCallback): AsyncOperationTask

Performs a search request for places based on multiple categories.

Return

AsyncOperationTask object representing pending completion of the request.

Parameters

categoryNames

Multiple categories to search.

options

Category search options.

callback

Search callback to retrieve results. Events are dispatched on the main thread.

abstract fun search(options: ReverseGeoOptions, executor: Executor, callback: SearchCallback): AsyncOperationTask

Performs reverse geocoding.

Return

AsyncOperationTask object representing pending completion of the request.

Parameters

options

Reverse geocoding options.

executor

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

callback

Search result callback.

open fun search(options: ReverseGeoOptions, callback: SearchCallback): AsyncOperationTask

Performs reverse geocoding.

Return

AsyncOperationTask object representing pending completion of the request.

Parameters

options

Reverse geocoding options.

callback

Search result callback, delivers results on the main thread.