IndexableDataProvider

interface IndexableDataProvider<R : IndexableRecord>
Content copied to clipboard

Defines an interface for external data indexing.

See also

Functions

add
Link copied to clipboard
open fun add(record: R, callback: CompletionCallback<Unit>): AsyncOperationTask
Content copied to clipboard
Adds a record to this data provider.
abstract fun add(record: R, executor: Executor, callback: CompletionCallback<Unit>): AsyncOperationTask
Content copied to clipboard
Adds a record to this data provider.
addAll
Link copied to clipboard
open fun addAll(records: List<R>, callback: CompletionCallback<Unit>): AsyncOperationTask
Content copied to clipboard
Add multiple records to this data provider.
abstract fun addAll(records: List<R>, executor: Executor, callback: CompletionCallback<Unit>): AsyncOperationTask
Content copied to clipboard
Add multiple records to this data provider.
clear
Link copied to clipboard
open fun clear(callback: CompletionCallback<Unit>): AsyncOperationTask
Content copied to clipboard
Removes all the records in this data provider.
abstract fun clear(executor: Executor, callback: CompletionCallback<Unit>): AsyncOperationTask
Content copied to clipboard
Removes all the records in this data provider.
contains
Link copied to clipboard
open fun contains(id: String, callback: CompletionCallback<Boolean>): AsyncOperationTask
Content copied to clipboard
Checks whether this data provider contains a record with specified id.
abstract fun contains(id: String, executor: Executor, callback: CompletionCallback<Boolean>): AsyncOperationTask
Content copied to clipboard
Checks whether this data provider contains a record with specified id.
get
Link copied to clipboard
open fun get(id: String, callback: CompletionCallback<in R?>): AsyncOperationTask
Content copied to clipboard
Retrieves the record with specified id or null if there's no such record.
abstract fun get(id: String, executor: Executor, callback: CompletionCallback<in R?>): AsyncOperationTask
Content copied to clipboard
Retrieves the record with specified id or null if there's no such record.
getAll
Link copied to clipboard
open fun getAll(callback: CompletionCallback<List<R>>): AsyncOperationTask
Content copied to clipboard
Retrieves all records from this provider.
abstract fun getAll(executor: Executor, callback: CompletionCallback<List<R>>): AsyncOperationTask
Content copied to clipboard
Retrieves all records from this provider.
open fun registerIndexableDataProviderEngineLayer(dataProviderEngineLayer: IndexableDataProviderEngineLayer, callback: CompletionCallback<Unit>): AsyncOperationTask
Content copied to clipboard
Experimental API, can be changed or removed in the next SDK releases.
abstract fun registerIndexableDataProviderEngineLayer(dataProviderEngineLayer: IndexableDataProviderEngineLayer, executor: Executor, callback: CompletionCallback<Unit>): AsyncOperationTask
Content copied to clipboard
Experimental API, can be changed or removed in the next SDK releases.
remove
Link copied to clipboard
open fun remove(id: String, callback: CompletionCallback<Boolean>): AsyncOperationTask
Content copied to clipboard
Removes the record with specified id.
abstract fun remove(id: String, executor: Executor, callback: CompletionCallback<Boolean>): AsyncOperationTask
Content copied to clipboard
Removes the record with specified id.
open fun unregisterIndexableDataProviderEngineLayer(dataProviderEngineLayer: IndexableDataProviderEngineLayer, callback: CompletionCallback<Boolean>): AsyncOperationTask
Content copied to clipboard
Experimental API, can be changed or removed in the next SDK releases.
abstract fun unregisterIndexableDataProviderEngineLayer(dataProviderEngineLayer: IndexableDataProviderEngineLayer, executor: Executor, callback: CompletionCallback<Boolean>): AsyncOperationTask
Content copied to clipboard
Experimental API, can be changed or removed in the next SDK releases.
update
Link copied to clipboard
open fun update(record: R, callback: CompletionCallback<Unit>): AsyncOperationTask
Content copied to clipboard
Updates record in this data provider.
abstract fun update(record: R, executor: Executor, callback: CompletionCallback<Unit>): AsyncOperationTask
Content copied to clipboard
Updates record in this data provider.

Properties

dataProviderName
Link copied to clipboard
abstract val dataProviderName: String
Content copied to clipboard
Data provider name.

Inheritors

LocalDataProvider
Link copied to clipboard