PreferenceManager getDefaultSharedPreferences deprecated in Android Q

Question

PreferenceManager getDefaultSharedPreferences is deprecated in Android 10. How do I replace it?

score 371 · Accepted Answer · edited Nov 29 '22 at 12:59

371

You can use the Android 10 support library version of PreferenceManager, i.e., androidx.preference.PreferenceManager and not android.preference.PreferenceManager.

Remember to add the following to your build.gradle:

implementation 'androidx.preference:preference:1.2.0'

edited Nov 29 '22 at 12:59

Adam Burley

5,551
4
51
72

answered Jul 01 '19 at 10:06

laalto

150,114
66
286
303

1

@AbhinavSaxena Yes of course. That's implicit when using a support library. An earlier edit to this answer added the kotlin-only ktx depency; I rolled back that edit because it was kotlin-only. – laalto Feb 04 '20 at 17:03
This seems to have to be `implementation` not `dependency`? – Richard Barraclough Jun 27 '20 at 14:42
Not that that works either: Unable to resolve dependency for ':app@debugAndroidTest/compileClasspath': Could not find implementation "androidx.preference:preference:1.1.0. – Richard Barraclough Jun 27 '20 at 14:43
I'm curious; why did they deprecate that interface, and was some other way of obtaining shared preferences preferred, or was switching to androidx the intent? – Edward Falk Aug 03 '20 at 17:56
1

@EdwardFalk I don't know but to me it smells like `getDefaultSharedPreferences()` is collateral damage. Yes, many preferemces-related areas were fragmented so it makes sense to move them to a support library. `getDefaultSharedPreferences()` implementation itself is still the same in both Android platform and AndroidX libraries, so that function did not really need deprecation. – laalto Aug 03 '20 at 19:57
Where in the build.grandle I add this line? What happens with older mobile phones if I change "android." to "androidx."? – Chameleon Aug 26 '20 at 18:09
What about Xamarin.Android. I've tried AndroidX.Preferences; but it doesn't exist. – Pavlos Mavris Dec 28 '22 at 09:30

score 200 · Answer 2 · edited Jun 30 '20 at 17:38

200

Package preference provides the androidx PreferenceManager:

Java: implementation "androidx.preference:preference:1.1.1"

Kotlin: implementation "androidx.preference:preference-ktx:1.1.1"

i.e. change android.preference.PreferenceManager to androidx.preference.PreferenceManager

Also see PreferenceFragmentCompat, which is the current PreferenceFragment class to use.

edited Jun 30 '20 at 17:38

tronman

9,862
10
46
61

answered Jul 06 '19 at 05:30

Martin Zeitler

1
19
155
216

Added a direct link to `PreferenceFragmentCompat`, which didn't exist back then... it's usually then next one deprecation problem one might face, when trying to update preferences. The other linked answer was only valid for a limited amount of time. – Martin Zeitler Apr 12 '20 at 22:30
Can we use in APIs before API 29? – H.Karatsanov Jun 25 '20 at 18:20
@H.Karatsanov yes, you can. – Luis Jun 24 '21 at 17:55

Androidcoder · Answer 3 · 2021-09-24T14:06:14.300

23

If you're just saving and retrieving key-value pairs you can replace:

 prefs = PreferenceManager.getDefaultSharedPreferences(this);

with:

 prefs = getSharedPreferences(
            "my.app.packagename_preferences", Context.MODE_PRIVATE);

Be sure to use the right file name for the new implementation or your users will lose access to everything saved with getDefaultSharedPreferences(!). The following will get the file name getDefaultSharedPreferences uses:

getPackageName() + "_preferences"

edited Sep 24 '21 at 14:06

answered Jul 14 '20 at 14:34

Androidcoder

4,389
5
35
50

2

This is a good answer, as context.getPackageName() also works in modules and retrieves the application-id. – Robert Apr 19 '21 at 18:08
2

Also note ; for java and not for Kotlin. Kotlin it would look like something like getSharedPreferences(applicationContext.packageName, Context.MODE_PRIVATE) – James Smith Apr 30 '21 at 18:36
3

Nice way to avoid unnecessarily using androidx.preference.PreferenceManager just to access getDefaultSharedPreferences. – A.J. Aug 22 '21 at 17:16
2

also If your are calling it from outside an activity, use "context.getSharedPreferences(context.packageName, Context.MODE_PRIVATE)" – Angel Koh Jun 07 '22 at 14:52

score 12 · Answer 4 · answered Sep 27 '21 at 10:50

12

Use Jetpack DataStore, It is a data storage solution that allows you to store key-value pairs or typed objects with protocol buffers. DataStore uses Kotlin coroutines and Flow to store data asynchronously, consistently, and transactionally.

If you're currently using SharedPreferences to store data, consider migrating to DataStore instead.

Setup

dependencies {
        implementation "androidx.datastore:datastore:1.0.0"
}

It also has support for RxJava2 & RxJava3.

answered Sep 27 '21 at 10:50

Ngima Sherpa

1,397
1
13
34

2

Sometimes we have one choice and it's only shareprefrences, for example when you use third party libraries that receive shareprefrences as parameter called on some method. open street map configuration load method is a case. – Reyhane Farshbaf Nov 25 '21 at 07:53

score 3 · Answer 5 · answered Jul 01 '19 at 10:04

3

Quote from PreferenceManager documentation:

This class was deprecated in API level 29.
Use the AndroidX Preference Library for consistent behavior across all devices. For more information on using the AndroidX Preference Library see Settings.

answered Jul 01 '19 at 10:04

Sergey Glotov

20,200
11
84
98

39

What wasn't consistent about the original one? – android developer Dec 10 '19 at 09:01

score 3 · Answer 6 · edited Mar 29 '21 at 13:58

3

Kotlin library

implementation 'androidx.preference:preference-ktx:1.1.1'

Kotlin use

Configuration.getInstance().load(this, androidx.preference.PreferenceManager.getDefaultSharedPreferences(this))

edited Mar 29 '21 at 13:58

Peter Mortensen

30,738
21
105
131

answered Nov 18 '20 at 08:12

developerjavad

315
1
2
10

score 2 · Answer 7 · edited Jul 07 '22 at 18:55

2

Yes, it is deprecated.

Use the AndroidX Preference Library for consistent behavior across all devices. For more information on using the AndroidX Preference Library see Settings.

Follow this -

PreferenceManager

edited Jul 07 '22 at 18:55

General Grievance

4,555
31
31
45

answered Jul 01 '19 at 10:06

Anupam

2,845
2
16
30

score 1 · Answer 8 · answered Sep 22 '21 at 08:38

You can import this library at app level gradle

implementation "androidx.preference:preference-ktx:1.1.1"

Then remove imported file from class where you create "PreferenceManager" Press Alt+Enter and import androidx hope you get latest version of preference manager.

score 1 · Answer 9 · answered Sep 23 '21 at 12:04

implementation "androidx.preference:preference-ktx:1.1.1"

class file PrivateSharedPreferences;

class PrivateSharedPreferences(context: Context) {
private val file = "com.example.com_shared"
private val key = "private_key"
private var sharedPreferences = context.getSharedPreferences(file, Context.MODE_PRIVATE)
private val editor = sharedPreferences.edit()

fun save(ok: Boolean) {
    editor.putBoolean(key, ok)
    editor.apply()
}

fun read() : Boolean {
    return sharedPreferences.getBoolean(key, false)
}

}

read from fragment or adapter;

PrivateSharedPreferences(context).read()

save

PrivateSharedPreferences(context).save(true)

PreferenceManager getDefaultSharedPreferences deprecated in Android Q

9 Answers9

If you're currently using SharedPreferences to store data, consider migrating to DataStore instead.

Kotlin library

Kotlin use

Linked

Related