HistoryDataProvider

interface HistoryDataProvider : LocalDataProvider<HistoryRecord>

LocalDataProvider typed to store HistoryRecord items.

Instance of HistoryDataProvider can be retrieved from MapboxSearchSdk.serviceProvider.

Functions

add

open fun add(record: HistoryRecord, callback: CompletionCallback<Unit>): AsyncOperationTask

Adds a record to this data provider.

abstract fun add(record: HistoryRecord, executor: Executor, callback: CompletionCallback<Unit>): AsyncOperationTask

Adds a record to this data provider.

addAll

open fun addAll(records: List<HistoryRecord>, callback: CompletionCallback<Unit>): AsyncOperationTask

Add multiple records to this data provider.

abstract fun addAll(records: List<HistoryRecord>, executor: Executor, callback: CompletionCallback<Unit>): AsyncOperationTask

Add multiple records to this data provider.

addOnDataChangedListener

open fun addOnDataChangedListener(listener: LocalDataProvider.OnDataChangedListener<HistoryRecord>)

Adds a listener to be notified of data provider changes.

abstract fun addOnDataChangedListener(executor: Executor, listener: LocalDataProvider.OnDataChangedListener<HistoryRecord>)

Adds a listener to be notified of data provider changes.

clear

open fun clear(callback: CompletionCallback<Unit>): AsyncOperationTask

Removes all the records in this data provider.

abstract fun clear(executor: Executor, callback: CompletionCallback<Unit>): AsyncOperationTask

Removes all the records in this data provider.

contains

open fun contains(id: String, callback: CompletionCallback<Boolean>): AsyncOperationTask

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

abstract fun contains(id: String, executor: Executor, callback: CompletionCallback<Boolean>): AsyncOperationTask

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

get

open fun get(id: String, callback: CompletionCallback<in HistoryRecord?>): AsyncOperationTask

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

abstract fun get(id: String, executor: Executor, callback: CompletionCallback<in HistoryRecord?>): AsyncOperationTask

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

getAll

open fun getAll(callback: CompletionCallback<List<HistoryRecord>>): AsyncOperationTask

Retrieves all records from this provider.

abstract fun getAll(executor: Executor, callback: CompletionCallback<List<HistoryRecord>>): AsyncOperationTask

Retrieves all records from this provider.

registerIndexableDataProviderEngineLayer

open fun registerIndexableDataProviderEngineLayer(dataProviderEngineLayer: IndexableDataProviderEngineLayer, callback: CompletionCallback<Unit>): AsyncOperationTask

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

abstract fun registerIndexableDataProviderEngineLayer(dataProviderEngineLayer: IndexableDataProviderEngineLayer, executor: Executor, callback: CompletionCallback<Unit>): AsyncOperationTask

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

remove

open fun remove(id: String, callback: CompletionCallback<Boolean>): AsyncOperationTask

Removes the record with specified id.

abstract fun remove(id: String, executor: Executor, callback: CompletionCallback<Boolean>): AsyncOperationTask

Removes the record with specified id.

removeOnDataChangedListener

abstract fun removeOnDataChangedListener(listener: LocalDataProvider.OnDataChangedListener<HistoryRecord>)

Removes listener to stop being notified of data provider changes.

unregisterIndexableDataProviderEngineLayer

open fun unregisterIndexableDataProviderEngineLayer(dataProviderEngineLayer: IndexableDataProviderEngineLayer, callback: CompletionCallback<Boolean>): AsyncOperationTask

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

abstract fun unregisterIndexableDataProviderEngineLayer(dataProviderEngineLayer: IndexableDataProviderEngineLayer, executor: Executor, callback: CompletionCallback<Boolean>): AsyncOperationTask

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

update

open fun update(record: HistoryRecord, callback: CompletionCallback<Unit>): AsyncOperationTask

Updates record in this data provider.

abstract fun update(record: HistoryRecord, executor: Executor, callback: CompletionCallback<Unit>): AsyncOperationTask

Updates record in this data provider.

Properties

dataProviderName

abstract val dataProviderName: String

Data provider name.

HistoryDataProvider

See also

Functions

Properties