How to remove some key/value pair from SharedPreferences?

Question

How to remove some key/value pair from SharedPreferences ? I have put and I to remove that from prefs.

score 247 · Accepted Answer · edited Nov 05 '19 at 12:22

247

SharedPreferences mySPrefs = PreferenceManager.getDefaultSharedPreferences(this);
SharedPreferences.Editor editor = mySPrefs.edit();
editor.remove(key);
editor.apply();

Here editor is the sharedPreferences editor.

edited Nov 05 '19 at 12:22

Alex Mamo

130,605
17
163
193

answered Nov 07 '11 at 08:22

Yashwanth Kumar

28,931
15
65
69

12

A small addition to this answer. From the android documentation: "If you don't care about the return value and you're using this from your application's main thread, consider using apply() instead." – Sreedevi J Nov 15 '13 at 04:46
3

@silwar , why have you reedited the apply() back to a commit() ? knowing that the documentation says to use apply() unless we want to work with the return value, and neither the question or the answer fits into that case – Salim Mahboubi Aug 17 '15 at 10:00

score 13 · Answer 2 · answered Jan 21 '15 at 17:05

It is important to note that, unless you're planning on doing something with the return value of the commit() call, there is absolutely no reason for using the synchronous commit() call instead of the asynchronous apply() call.

Keep in mind that if you're calling this from the main/UI thread, the UI is blocked until the commit() has completed. This can take upwards of around 100ms as apposed to about 5ms for the apply. That may not seem like much, but if done continually throughout an application, it will certainly add up.

So, unless you're planning on doing something like this, hopefully on a separate thread:

editor.remove(String key); 
boolean success = editor.commit();
if (!success) { 
    // do something 
}

You should instead be doing this:

editor.remove(String key); 
editor.apply();

I've been looking all over for a good (real world) explanation of when to use commit vs apply. This drives the point across clearly. — XMAN, Sep 08 '18 at 04:10

Antônio Sérgio Ferraz · Answer 3 · 2018-01-19T00:21:04.047

10

It's very simple:

private SharedPreferences sharedPreferences() {
    return PreferenceManager.getDefaultSharedPreferences(mContext);
}

public void clearSharedPreferences() {
    sharedPreferences()
            .edit()
            .remove(SOME_KEY_1)
            .remove(SOME_KEY_2)
            .remove(SOME_KEY_3)
            .apply();
}

edited Jan 19 '18 at 00:21

answered Jan 19 '18 at 00:10

Antônio Sérgio Ferraz

187
2
8

score 9 · Answer 4 · edited Mar 18 '15 at 21:31

9

SharedPreferences.Editor.remove(key) 
commit();

edited Mar 18 '15 at 21:31

jvperrin

3,368
1
23
33

answered Nov 07 '11 at 08:25

Shailendra Singh Rajawat

8,172
3
35
40

1

If you don't use the return value from remove method, and you're using this from your application's main thread, consider using apply() instead. – kartik srivastava Aug 11 '19 at 08:57

score 3 · Answer 5 · answered Mar 04 '17 at 09:07

Here is how I tacked this issue.

First I created an instance of SharedPreference as

SharedPreferences mobilePreference;

then I used this sharedPreference as

mobilePreference = this.getSharedPreferences("in.bhartisoftwares.amit.allamitappsthree", Context.MODE_PRIVATE);

Here "in.bhartisoftwares.amit.allamitappsthree" is my package name and I am using Context.MODE_PRIVATE, because I want to manipulate this shared preference only for this package name.

Then I am deleting the selected sharedPreference (key of my sharedPreference is mobileString) as follows:

mobilePreference.edit().remove("mobileString").commit();

See the code as full below:

SharedPreferences mobilePreference = this.getSharedPreferences("in.bhartisoftwares.amit.allamitappsthree", Context.MODE_PRIVATE);
    mobilePreference.edit().remove("mobileString").commit();

score 1 · Answer 6 · answered Sep 14 '16 at 04:51

Information

Just check sharedpref class is extended to Map that's why there is remove method

SharedPreferences prefs = PreferenceManager.getDefaultSharedPreferences(this);
SharedPreferences.Editor editor = prefs.edit();
editor.remove(String key);
editor.apply();

Here editor is the sharedPreferences editor.

How to remove some key/value pair from SharedPreferences?

6 Answers6

Linked