SearchEngine

interface SearchEngine

Performs

SearchEngine API requires an online connection to execute the requests.

Instantiating

Call SearchEngine.createSearchEngine to get instance of a SearchEngine.

Forward geocoding algorithm

Forward geocoding consists of 2 steps:

  1. Retrieve suggestions (search). For giving query we provide a list of suggestions, which contain only basic information (name of a place/category/query, its description, its type and etc.). Provided suggestions will be passed to SearchSuggestionsCallback.onSuggestions. Note, that such information as coordinates of place is not available at this step. To get this information, proceed to next step;

  2. Get more details for suggestion (select). Depending on suggestion type, different logic might be applied:

Error handling

If invalid parameters are provided, RuntimeException is thrown immediately. Any other error will be propagated to SearchSuggestionsCallback.onError.

See also

Types

Companion
Link copied to clipboard
object Companion
Companion object.

Functions

registerDataProvider
Link copied to clipboard
open fun <R : IndexableRecord> registerDataProvider(dataProvider: IndexableDataProvider<R>, callback: CompletionCallback<Unit>): AsyncOperationTask
Registers dataProvider in this SearchEngine.
abstract fun <R : IndexableRecord> registerDataProvider(dataProvider: IndexableDataProvider<R>, executor: Executor, callback: CompletionCallback<Unit>): AsyncOperationTask
Registers dataProvider in this SearchEngine.
search
Link copied to clipboard
open fun search(options: ReverseGeoOptions, callback: SearchCallback): AsyncOperationTask
Performs reverse geocoding.
abstract fun search(options: ReverseGeoOptions, executor: Executor, callback: SearchCallback): AsyncOperationTask
Performs reverse geocoding.
open fun search(categoryName: String, options: CategorySearchOptions, callback: SearchCallback): AsyncOperationTask
Performs a search request for places based on a category.
open fun search(query: String, options: SearchOptions, callback: SearchSuggestionsCallback): AsyncOperationTask
The first step of forward geocoding.
abstract fun search(categoryName: String, options: CategorySearchOptions, executor: Executor, callback: SearchCallback): AsyncOperationTask
Performs a search request for places based on a category.
abstract fun search(query: String, options: SearchOptions, executor: Executor, callback: SearchSuggestionsCallback): AsyncOperationTask
The first step of forward geocoding.
select
Link copied to clipboard
open fun select(suggestion: SearchSuggestion, callback: SearchSelectionCallback): AsyncOperationTask
The second step of forward geocoding.
open fun select(suggestions: List<SearchSuggestion>, callback: SearchMultipleSelectionCallback): AsyncOperationTask
Function to select multiple suggestions at once.
open fun select(suggestion: SearchSuggestion, options: SelectOptions, callback: SearchSelectionCallback): AsyncOperationTask
The second step of forward geocoding.
abstract fun select(suggestions: List<SearchSuggestion>, executor: Executor, callback: SearchMultipleSelectionCallback): AsyncOperationTask
Function to select multiple suggestions at once.
abstract fun select(suggestion: SearchSuggestion, options: SelectOptions, executor: Executor, callback: SearchSelectionCallback): AsyncOperationTask
The second step of forward geocoding.
unregisterDataProvider
Link copied to clipboard
open fun <R : IndexableRecord> unregisterDataProvider(dataProvider: IndexableDataProvider<R>, callback: CompletionCallback<Unit>): AsyncOperationTask
Unregisters previously registered IndexableDataProvider.
abstract fun <R : IndexableRecord> unregisterDataProvider(dataProvider: IndexableDataProvider<R>, executor: Executor, callback: CompletionCallback<Unit>): AsyncOperationTask
Unregisters previously registered IndexableDataProvider.

Properties

analyticsService
Link copied to clipboard
abstract val analyticsService: AnalyticsService
AnalyticsService instance associated with this SearchEngine.
apiType
Link copied to clipboard
abstract val apiType: ApiType
The type of the API used by the Search Engine.
settings
Link copied to clipboard
abstract val settings: SearchEngineSettings
Settings used for SearchEngine initialization.