LocalDataProvider

interface LocalDataProvider<R : IndexableRecord> : IndexableDataProvider<R>

IndexableDataProvider that represents stored locally by the SDK user data.

Types

OnDataChangedListener

interface OnDataChangedListener<R : IndexableRecord>

Listener to be notified of data provider changes.

OnDataProviderEngineRegisterListener

interface OnDataProviderEngineRegisterListener

Listener to be notified when IndexableDataProviderEngine registered in this data provider.

Functions

addOnDataChangedListener

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

Adds a listener to be notified of data provider changes.

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

Adds a listener to be notified of data provider changes.

addOnDataProviderEngineRegisterListener

open fun addOnDataProviderEngineRegisterListener(listener: LocalDataProvider.OnDataProviderEngineRegisterListener)

Adds a listener to be notified when IndexableDataProviderEngine registered in this data provider.

abstract fun addOnDataProviderEngineRegisterListener(executor: Executor, listener: LocalDataProvider.OnDataProviderEngineRegisterListener)

Adds a listener to be notified when IndexableDataProviderEngine registered in this data provider.

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 R?>): 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 R?>): AsyncOperationTask

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

getAll

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

Retrieves all records from this provider.

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

Retrieves all records from this provider.

registerIndexableDataProviderEngine

open fun registerIndexableDataProviderEngine(dataProviderEngine: IndexableDataProviderEngine, callback: CompletionCallback<Unit>): AsyncOperationTask

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

abstract fun registerIndexableDataProviderEngine(dataProviderEngine: IndexableDataProviderEngine, 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<R>)

Removes a previously added listener.

removeOnDataProviderEngineRegisterListener

abstract fun removeOnDataProviderEngineRegisterListener(listener: LocalDataProvider.OnDataProviderEngineRegisterListener)

Removes a previously added listener.

unregisterIndexableDataProviderEngine

open fun unregisterIndexableDataProviderEngine(dataProviderEngine: IndexableDataProviderEngine, callback: CompletionCallback<Boolean>): AsyncOperationTask

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

abstract fun unregisterIndexableDataProviderEngine(dataProviderEngine: IndexableDataProviderEngine, executor: Executor, callback: CompletionCallback<Boolean>): AsyncOperationTask

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

upsert

open fun upsert(record: R, callback: CompletionCallback<Unit>): AsyncOperationTask

Insert or update a record to this data provider.

abstract fun upsert(record: R, executor: Executor, callback: CompletionCallback<Unit>): AsyncOperationTask

Insert or update a record in this data provider.

upsertAll

open fun upsertAll(records: List<R>, callback: CompletionCallback<Unit>): AsyncOperationTask

Upsert (insert or update) multiple records to this data provider.

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

Upsert (insert or update) multiple records to this data provider.

Properties

dataProviderName

abstract val dataProviderName: String

Data provider name.

priority

abstract val priority: Int

Data provider priority.

Inheritors

FavoritesDataProvider

HistoryDataProvider

LocalDataProvider

See also

Types

Functions

Properties

Inheritors