kotlin-components-docs/mozilla.appservices.remotesettings/RemoteSettingsClientInterface

RemoteSettingsClientInterface

interface RemoteSettingsClientInterface

Client for a single Remote Settings collection

Use RemoteSettingsService::make_client to create these.

Inheritors

RemoteSettingsClient

Types

object Companion

Functions

abstract fun collectionName(): String

Collection this client is for

abstract fun getAttachment(record: RemoteSettingsRecord): ByteArray

Get attachment data for a remote settings record

abstract fun getRecords(syncIfEmpty: Boolean = false): List<RemoteSettingsRecord>?

Get the current set of records.

abstract fun getRecordsMap(syncIfEmpty: Boolean = false): Map<String, RemoteSettingsRecord>?

Get the current set of records as a map of record_id -> record.

abstract fun resetStorage()

abstract fun shutdown()

Shutdown the client, releasing the SQLite connection used to cache records.

abstract fun sync()