OfflineSearchEngine

interface OfflineSearchEngine

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

The API of this class is temporary and subject to change. Tiles loading functionality is available to selected customers only. Contact our team, to get early preview.

Types

Companion

object Companion

Companion object.

EngineReadyCallback

interface EngineReadyCallback

Interface definition for a callback to be invoked when the OfflineSearchEngine is ready for use.

OnIndexChangeListener

interface OnIndexChangeListener

Interface for a listener to be invoked when index data is changed in the OfflineSearchEngine.

Functions

addEngineReadyCallback

open fun addEngineReadyCallback(callback: OfflineSearchEngine.EngineReadyCallback)

Adds a callback to be notified when engine is ready.

abstract fun addEngineReadyCallback(executor: Executor, callback: OfflineSearchEngine.EngineReadyCallback)

Adds a callback to be notified when engine is ready.

addOnIndexChangeListener

open fun addOnIndexChangeListener(listener: OfflineSearchEngine.OnIndexChangeListener)

Adds a listener to be notified of index change events.

abstract fun addOnIndexChangeListener(executor: Executor, listener: OfflineSearchEngine.OnIndexChangeListener)

Adds a listener to be notified of index change events.

removeEngineReadyCallback

abstract fun removeEngineReadyCallback(callback: OfflineSearchEngine.EngineReadyCallback)

Removes a previously added callback.

removeOnIndexChangeListener

abstract fun removeOnIndexChangeListener(listener: OfflineSearchEngine.OnIndexChangeListener)

Removes a previously added listener.

reverseGeocoding

open fun reverseGeocoding(options: OfflineReverseGeoOptions, callback: OfflineSearchCallback): AsyncOperationTask

Performs reverse geocoding search request.

abstract fun reverseGeocoding(options: OfflineReverseGeoOptions, executor: Executor, callback: OfflineSearchCallback): AsyncOperationTask

Performs reverse geocoding search request.

open fun search(query: String, options: OfflineSearchOptions, callback: OfflineSearchCallback): AsyncOperationTask

Performs forward geocoding search request.

abstract fun search(query: String, options: OfflineSearchOptions, executor: Executor, callback: OfflineSearchCallback): AsyncOperationTask

Performs forward geocoding search request.

searchAddressesNearby

open fun searchAddressesNearby(street: String, proximity: Point, radiusMeters: Double, callback: OfflineSearchCallback): AsyncOperationTask

Searches for addresses nearby (around proximity point), matched with specified street name.

abstract fun searchAddressesNearby(street: String, proximity: Point, radiusMeters: Double, executor: Executor, callback: OfflineSearchCallback): AsyncOperationTask

Searches for addresses nearby (around proximity point), matched with specified street name.

selectTileset

abstract fun selectTileset(dataset: String?, version: String?)

Selects preferable tileset for offline search.

Properties

settings

abstract val settings: OfflineSearchEngineSettings

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