IndexableDataProvider

interface IndexableDataProvider<R : IndexableRecord>

Defines an interface for external data indexing. Asynchronous operations callback functions are called on the main thread.

See also

com.mapbox.search.record.LocalDataProvider

com.mapbox.search.record.FavoritesDataProvider

com.mapbox.search.record.HistoryDataProvider

Types

CompletionCallback

interface CompletionCallback<T>

Interface definition for a callback to be invoked when asynchronous data provider operation completes.

Functions

add

abstract fun add(record: R, callback: IndexableDataProvider.CompletionCallback<Unit>): AsyncOperationTask

Adds a record to this data provider.

addAll

abstract fun addAll(records: List<R>, callback: IndexableDataProvider.CompletionCallback<Unit>): AsyncOperationTask

Add multiple records to this data provider.

clear

abstract fun clear(callback: IndexableDataProvider.CompletionCallback<Unit>): AsyncOperationTask

Removes all the records in this data provider.

contains

abstract fun contains(id: String, callback: IndexableDataProvider.CompletionCallback<Boolean>): AsyncOperationTask

Checks whether this data provider contains a record with specified id.

get

abstract fun get(id: String, callback: IndexableDataProvider.CompletionCallback<in R?>): AsyncOperationTask

Retrieves the record with specified id or null if there's no such record.

getAll

abstract fun getAll(callback: IndexableDataProvider.CompletionCallback<List<R>>): AsyncOperationTask

Retrieves all records from this provider.

remove

abstract fun remove(id: String, callback: IndexableDataProvider.CompletionCallback<Boolean>): AsyncOperationTask

Removes the record with specified id.

update

abstract fun update(record: R, callback: IndexableDataProvider.CompletionCallback<Unit>): AsyncOperationTask

Updates record in this data provider.

Properties

dataProviderName

abstract val dataProviderName: String

Data provider name.

Inheritors

LocalDataProvider