OfflineSearchEngine

interface OfflineSearchEngine

The OfflineSearchEngine interface provides forward and reverse geocoding search that works offline. An instance of the OfflineSearchEngine can be obtained with MapboxSearchSdk.getOfflineSearchEngine.

Offline forward geocoding search works in a two-step manner, see SearchEngine for more details.

Functions

addOfflineRegion

abstract fun addOfflineRegion(path: String, mapsFileNames: List<String>, boundaryFileName: String)

Register offline region data for search index.

equals

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

hashCode

open fun hashCode(): Int

reverseGeocoding

abstract fun reverseGeocoding(options: OfflineReverseGeoOptions, callback: SearchCallback): SearchRequestTask

Performs reverse geocoding.

search

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

The first step of the offline forward geocoding.

select

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

The second step of the offline forward geocoding.

toString

open fun toString(): String