datastore-preferences-core/androidx.datastore.preferences.core

Package-level declarations

Types

MutablePreferences

class MutablePreferences : Preferences

Mutable version of Preferences. Allows for creating Preferences with different key-value pairs.

PreferenceDataStoreFactory

expect object PreferenceDataStoreFactory

actual object PreferenceDataStoreFactory

Public factory for creating PreferenceDataStore instances.

actual object PreferenceDataStoreFactory

Preferences

abstract class Preferences

Preferences and MutablePreferences are a lot like a generic Map and MutableMap keyed by the Preferences.Key class. These are intended for use with DataStore. Construct a DataStore instance using PreferenceDataStoreFactory.create.

Functions

booleanPreferencesKey

fun booleanPreferencesKey(name: String): Preferences.Key<Boolean>

Get a key for a Boolean preference. You should not have multiple keys with the same name (for use with the same Preferences). Using overlapping keys with different types can result in ClassCastException.

byteArrayPreferencesKey

fun byteArrayPreferencesKey(name: String): Preferences.Key<ByteArray>

Get a key for an ByteArray preference. You should not have multiple keys with the same name (for use with the same Preferences). Using overlapping keys with different types can result in ClassCastException.

doublePreferencesKey

fun doublePreferencesKey(name: String): Preferences.Key<Double>

Get a key for a Double preference. You should not have multiple keys with the same name (for use with the same Preferences). Using overlapping keys with different types can result in ClassCastException.

edit

suspend fun DataStore<Preferences>.edit(transform: suspend (MutablePreferences) -> Unit): Preferences

Edit the value in DataStore transactionally in an atomic read-modify-write operation. All operations are serialized.

emptyPreferences

fun emptyPreferences(): Preferences

Get a new empty Preferences.

floatPreferencesKey

fun floatPreferencesKey(name: String): Preferences.Key<Float>

Get a key for a Float preference. You should not have multiple keys with the same name (for use with the same Preferences). Using overlapping keys with different types can result in ClassCastException.

intPreferencesKey

fun intPreferencesKey(name: String): Preferences.Key<Int>

Get a key for an Int preference. You should not have multiple keys with the same name (for use with the same Preferences). Using overlapping keys with different types can result in ClassCastException.

longPreferencesKey

fun longPreferencesKey(name: String): Preferences.Key<Long>

Get a key for an Long preference. You should not have multiple keys with the same name (for use with the same Preferences). Using overlapping keys with different types can result in ClassCastException.

mutablePreferencesOf

fun mutablePreferencesOf(vararg pairs: Preferences.Pair<*>): MutablePreferences

Construct a MutablePreferences object with a list of Preferences.Pair. Comparable to mapOf().

preferencesOf

fun preferencesOf(vararg pairs: Preferences.Pair<*>): Preferences

Construct a Preferences object with a list of Preferences.Pair. Comparable to mapOf().

stringPreferencesKey

fun stringPreferencesKey(name: String): Preferences.Key<String>

Get a key for a String preference. You should not have multiple keys with the same name (for use with the same Preferences). Using overlapping keys with different types can result in ClassCastException.

stringSetPreferencesKey

fun stringSetPreferencesKey(name: String): Preferences.Key<Set<String>>

Get a key for a String Set preference. You should not have multiple keys with the same name (for use with the same Preferences). Using overlapping keys with different types can result in ClassCastException.