SearchEngine

interface SearchEngine

Used for forward geocoding (looking up a place by name to retrieve its geographic coordinates). Instance of it can be retrieved from MapboxSearchSdk. Results will be delivered on the main thread.

Functions

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

abstract fun search(query: String, options: SearchOptions, callback: SearchSuggestionsCallback): SearchRequestTask

The first step of forward geocoding.

select

abstract fun select(suggestion: SearchSuggestion, callback: SearchSelectionCallback): SearchRequestTask

The second step of forward geocoding.

abstract fun select(suggestions: List<SearchSuggestion>, callback: SearchMultipleSelectionCallback): SearchRequestTask

Function to select multiple suggestions at once.

toString

open fun toString(): String

Properties

apiType

abstract val apiType: ApiType

Experimental API, can be changed or removed in the next SDK releases.