SearchEngine

Used for forward geocoding (looking up a place by name to retrieve its geographic coordinates).

Instantiating

To obtain SearchEngine instance, please, use MapboxSearchSdk.getSearchEngine.

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:

   • For SearchSuggestionType.SearchResultSuggestion additional network request will be executed and result will be passed to SearchSelectionCallback.onResult;

   • For SearchSuggestionType.Category additional network request will be executed and list of results will be passed to SearchSelectionCallback.onCategoryResult;

   • For SearchSuggestionType.Query additional network request will be executed and another list of suggestions will be passed to SearchSelectionCallback.onSuggestions. To get more information for provided suggestions you should use the same step (select);

   • For SearchSuggestionType.IndexableRecordItem extra information will be retrieved locally and result will be passed to SearchSelectionCallback.onResult.

   If you want to get coordinates of search suggestion (or more details about suggestion), you should use select method. You will receive more detailed information.

Error handling

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