PreferencesKeys

Added in 1.0.0

---

Kotlin |Java

public final class PreferencesKeys

---

Summary

Public methods
static final @NonNull Preferences.Key<@NonNull Boolean>	booleanKey(@NonNull String name) Get a key for a Boolean preference.
static final @NonNull Preferences.Key<@NonNull byte[]>	byteArrayKey(@NonNull String name) Get a key for an ByteArray preference.
static final @NonNull Preferences.Key<@NonNull Double>	doubleKey(@NonNull String name) Get a key for a Double preference.
static final @NonNull Preferences.Key<@NonNull Float>	floatKey(@NonNull String name) Get a key for a Float preference.
static final @NonNull Preferences.Key<@NonNull Integer>	intKey(@NonNull String name) Get a key for an Int preference.
static final @NonNull Preferences.Key<@NonNull Long>	longKey(@NonNull String name) Get a key for an Long preference.
static final @NonNull Preferences.Key<@NonNull String>	stringKey(@NonNull String name) Get a key for a String preference.
static final @NonNull Preferences.Key<@NonNull Set<@NonNull String>>	stringSetKey(@NonNull String name) Get a key for a String Set preference.

Public methods

booleanKey

Artifact: androidx.datastore:datastore-preferences-core

View Source

Added in 1.0.0

public static final @NonNull Preferences.Key<@NonNull Boolean> booleanKey(@NonNull String name)

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.

Parameters
@NonNull String name	the name of the preference

Returns
@NonNull Preferences.Key<@NonNull Boolean>	the Preferences.Key for name

byteArrayKey

Artifact: androidx.datastore:datastore-preferences-core

View Source

Added in 1.1.1

public static final @NonNull Preferences.Key<@NonNull byte[]> byteArrayKey(@NonNull String name)

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.

Note: ByteArrays returned by DataStore are copies. Mutating their state will do nothing to the underlying data store. They must be set explicitly.

Parameters
@NonNull String name	the name of the preference

Returns
@NonNull Preferences.Key<@NonNull byte[]>	the Preferences.Key for name

doubleKey

Artifact: androidx.datastore:datastore-preferences-core

View Source

Added in 1.0.0

public static final @NonNull Preferences.Key<@NonNull Double> doubleKey(@NonNull String name)

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.

Parameters
@NonNull String name	the name of the preference

Returns
@NonNull Preferences.Key<@NonNull Double>	the Preferences.Key for name

floatKey

Artifact: androidx.datastore:datastore-preferences-core

View Source

Added in 1.0.0

public static final @NonNull Preferences.Key<@NonNull Float> floatKey(@NonNull String name)

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.

Parameters
@NonNull String name	the name of the preference

Returns
@NonNull Preferences.Key<@NonNull Float>	the Preferences.Key for name

intKey

Artifact: androidx.datastore:datastore-preferences-core

View Source

Added in 1.0.0

public static final @NonNull Preferences.Key<@NonNull Integer> intKey(@NonNull String name)

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.

Parameters
@NonNull String name	the name of the preference

Returns
@NonNull Preferences.Key<@NonNull Integer>	the Preferences.Key for name

longKey

Artifact: androidx.datastore:datastore-preferences-core

View Source

Added in 1.0.0

public static final @NonNull Preferences.Key<@NonNull Long> longKey(@NonNull String name)

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.

Parameters
@NonNull String name	the name of the preference

Returns
@NonNull Preferences.Key<@NonNull Long>	the Preferences.Key for name

stringKey

Artifact: androidx.datastore:datastore-preferences-core

View Source

Added in 1.0.0

public static final @NonNull Preferences.Key<@NonNull String> stringKey(@NonNull String name)

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.

Parameters
@NonNull String name	the name of the preference

Returns
@NonNull Preferences.Key<@NonNull String>	the Preferences.Key for name

stringSetKey

Artifact: androidx.datastore:datastore-preferences-core

View Source

Added in 1.0.0

public static final @NonNull Preferences.Key<@NonNull Set<@NonNull String>> stringSetKey(@NonNull String name)

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.

Note: sets returned by DataStore are unmodifiable and will throw exceptions if mutated.

Parameters
@NonNull String name	the name of the preference

Returns
@NonNull Preferences.Key<@NonNull Set<@NonNull String>>	the Preferences.Key> for name