fonament-preferences/dev.sergiobelda.fonament.preferences/FonamentPreferences

FonamentPreferences

class FonamentPreferences(dataStore: DataStore<Preferences>)

A class that provides functions to set and get data from a DataStore<Preferences> instance.

Constructors

FonamentPreferences

constructor(dataStore: DataStore<Preferences>)

Functions

getBoolean

fun getBoolean(key: String): Flow<Boolean?>

Retrieves a Flow containing the value from the data store preferences given its key, or null otherwise.

getBooleanOrDefault

fun getBooleanOrDefault(key: String, default: Boolean): Flow<Boolean>

Retrieves a Flow containing the value from the data store preferences given its key, or default otherwise.

getByteArray

fun getByteArray(key: String): Flow<ByteArray?>

Retrieves a Flow containing the value from the data store preferences given its key, or null otherwise.

getByteArrayOrDefault

fun getByteArrayOrDefault(key: String, default: ByteArray): Flow<ByteArray>

Retrieves a Flow containing the value from the data store preferences given its key, or default otherwise.

getDouble

fun getDouble(key: String): Flow<Double?>

Retrieves a Flow containing the value from the data store preferences given its key, or null otherwise.

getDoubleOrDefault

fun getDoubleOrDefault(key: String, default: Double): Flow<Double>

Retrieves a Flow containing the value from the data store preferences given its key, or default otherwise.

getFloat

fun getFloat(key: String): Flow<Float?>

Retrieves a Flow containing the value from the data store preferences given its key, or null otherwise.

getFloatOrDefault

fun getFloatOrDefault(key: String, default: Float): Flow<Float>

Retrieves a Flow containing the value from the data store preferences given its key, or default otherwise.

getInt

fun getInt(key: String): Flow<Int?>

Retrieves a Flow containing the value from the data store preferences given its key, or null otherwise.

getIntOrDefault

fun getIntOrDefault(key: String, default: Int): Flow<Int>

Retrieves a Flow containing the value from the data store preferences given its key, or default otherwise.

getLong

fun getLong(key: String): Flow<Long?>

Retrieves a Flow containing the value from the data store preferences given its key, or null otherwise.

getLongOrDefault

fun getLongOrDefault(key: String, default: Long): Flow<Long>

Retrieves a Flow containing the value from the data store preferences given its key, or default otherwise.

getString

fun getString(key: String): Flow<String?>

Retrieves a Flow containing the value from the data store preferences given its key, or null otherwise.

getStringOrDefault

fun getStringOrDefault(key: String, default: String): Flow<String>

Retrieves a Flow containing the value from the data store preferences given its key, or default otherwise.

getStringSet

fun getStringSet(key: String): Flow<Set<String>?>

Retrieves a Flow containing the value from the data store preferences given its key, or null otherwise.

getStringSetOrDefault

fun getStringSetOrDefault(key: String, default: Set<String>): Flow<Set<String>>

Retrieves a Flow containing the value from the data store preferences given its key, or default otherwise.

set

suspend operator fun set(key: String, value: Boolean)

Sets a Boolean in the data store preferences.

suspend operator fun set(key: String, value: ByteArray)

Sets a ByteArray in the data store preferences.

suspend operator fun set(key: String, value: Double)

Sets a Double in the data store preferences.

suspend operator fun set(key: String, value: Float)

Sets a Float in the data store preferences.

suspend operator fun set(key: String, value: Int)

Sets an Int in the data store preferences.

suspend operator fun set(key: String, value: Long)

Sets a Long in the data store preferences.

suspend operator fun set(key: String, value: String)

Sets a String in the data store preferences.

suspend operator fun set(key: String, value: Set<String>)

Sets a Set<String>value in the data store preferences.