586

How do I delete SharedPreferences data for my application?

I'm creating an application that uses a lot of web services to sync data. For testing purposes, I need to wipe out some SharedPreferences values when I restart the app.

Samet ÖZTOPRAK
  • 3,112
  • 3
  • 32
  • 33
Andrew
  • 20,756
  • 32
  • 99
  • 177

29 Answers29

985

To remove specific values: SharedPreferences.Editor.remove() followed by a commit()

To remove them all SharedPreferences.Editor.clear() followed by a commit()

If you don't care about the return value and you're using this from your application's main thread, consider using apply() instead.

sam9046
  • 566
  • 1
  • 7
  • 14
Mark B
  • 183,023
  • 24
  • 297
  • 295
  • 288
    context.getSharedPreferences("YOUR_PREFS", 0).edit().clear().commit(); //remove all your prefs :) – rubdottocom Mar 17 '12 at 07:55
  • 3
    @yoshi there is definitely a remove() as well as a clear(). You use remove() to remove specific preferences, you use clear() to remove them all. The original question wasn't clear if they needed to remove them all or not. – Mark B Jul 23 '12 at 16:38
  • 11
    Clearing the preferences file does not appear to actually delete it. In my own tests by watching the "Data" usage listed in the App Info panel, creating a new SharedPreference file adds 4KB to this value but using editor.clear().commit() does not reduce the number. – Code Commander Nov 21 '12 at 07:08
  • 2
    @rubdottocom Why don't you put your comment as a separate answer? – technophyle Aug 26 '15 at 20:36
  • @technophyle wow this comment has more than hundred votes! I added the answer below with a slightly improvement ;-) – rubdottocom Aug 27 '15 at 08:26
  • 13
    @rubdottocom better using .apply() instead of .commit() – Juan Aguilar Guisado Sep 22 '15 at 10:55
  • In kotlin that is sharedPreferences.edit().clear().apply() – YanSte Jan 27 '21 at 12:43
213

My solution:

SharedPreferences preferences = getSharedPreferences("Mypref", 0);
preferences.edit().remove("text").commit();
OneCricketeer
  • 179,855
  • 19
  • 132
  • 245
vaibhav vijay
  • 2,155
  • 1
  • 12
  • 2
155

Removing all preferences:

SharedPreferences settings = context.getSharedPreferences("PreferencesName", Context.MODE_PRIVATE);
settings.edit().clear().commit();

Removing single preference:

SharedPreferences settings = context.getSharedPreferences("PreferencesName", Context.MODE_PRIVATE);
settings.edit().remove("KeyName").commit();
sz12345
  • 1,559
  • 1
  • 9
  • 3
75

If it's not necessary to be removed every time, you can remove it manually from:

Settings -> Applications -> Manage applications -> (choose your app) -> Clear data or Uninstall

Newer versions of Android:

Settings -> Applications -> (choose your app) -> Storage -> Clear data and Clear cache

bonafernando
  • 1,048
  • 12
  • 14
Nobu
  • 9,965
  • 4
  • 40
  • 47
28

Deleting Android Shared Preferences in one line :-)

context.getSharedPreferences("YOUR_PREFS", 0).edit().clear().commit();

Or apply for non-blocking asynchronous operation:

this.getSharedPreferences("YOUR_PREFS", 0).edit().clear().apply();
rubdottocom
  • 8,110
  • 10
  • 39
  • 59
25

Seems that all solution is not completely working or out-dead

to clear all SharedPreferences in an Activity

PreferenceManager.getDefaultSharedPreferences(getBaseContext()).edit().clear().apply();

Call this from the Main Activity after onCreate

note* i used .apply() instead of .commit(), you are free to choose commit();

Manaus
  • 407
  • 5
  • 9
Shady Keshk
  • 540
  • 6
  • 16
17

As of API 24 (Nougat) you can just do:

context.deleteSharedPreferences("YOUR_PREFS");

However, there is no backward compatibility, so if you're supporting anything less than 24, stick with:

context.getSharedPreferences("YOUR_PREFS", Context.MODE_PRIVATE).edit().clear().apply(); 
afathman
  • 5,993
  • 2
  • 20
  • 28
15

In the class definitions:

private static final String PREFERENCES = "shared_prefs";

private static final SharedPreferences sharedPreferences  = getApplicationContext().getSharedPreferences(PREFERENCES, MODE_PRIVATE);

Inside the class:

public static void deleteAllSharedPrefs(){
    sharedPreferences.edit().clear().commit();
}
Manaus
  • 407
  • 5
  • 9
sivi
  • 10,654
  • 2
  • 52
  • 51
11

You can use the adb shell to do this even without a rooted phone. The only catch is that the app must be debuggable.

run-as <your package name> <command>

For example:

run-as com.asdf.blah rm /data/data/com.asdf.blah/databases/myDB.db

Alternatively, you can just do the above but without the command which will direct you to the app package root and allow you to execute more commands in the app's context.

Johnson Wong
  • 4,233
  • 1
  • 15
  • 6
11
Editor editor = getSharedPreferences("clear_cache", Context.MODE_PRIVATE).edit();
editor.clear();
editor.commit();
Vaishali Sutariya
  • 5,093
  • 30
  • 32
11

Clear them all:

PreferenceManager.getDefaultSharedPreferences(context).edit().clear().apply()
Dan Alboteanu
  • 9,404
  • 1
  • 52
  • 40
10

You can also just manually uninstall your app using your device. Then when you re-install your app, shared preferences have been reset.

wizurd
  • 3,541
  • 3
  • 33
  • 50
  • Thanks - i did not want to programmatically remove sharedPreferences so this worked for me. – Simon May 06 '15 at 18:47
  • On my device I have the option to "clear data" on the uninstall option, which worked for me and removed the need to reinstall my app. – G O'Rilla Aug 11 '15 at 06:42
9

For Kotlin users it is fairly easy:

val sharedPref = context.getSharedPreferences("myPref", Context.MODE_PRIVATE)
 sharedPref.edit().clear().apply()
Saurabh Dhage
  • 1,478
  • 5
  • 17
  • 31
7

Try this code:

SharedPreferences sharedPreferences = getSharedPreferences("fake", Context.MODE_PRIVATE);
SharedPreferences.Editor edit = sharedPreferences.edit();
edit.clear().commit();
svarog
  • 9,477
  • 4
  • 61
  • 77
Mubashshir
  • 171
  • 3
  • 10
7

If it is for your testing. You can use adb commands.

adb shell pm clear <package name>
Prakash
  • 7,794
  • 4
  • 48
  • 44
6

You can always do it programmatically as suggested by the other answers over here. But for development purpose, I find this Plugin very helpful as it speeds up my development significantly.

PLUGIN: ADB Idea

It provides you with features to Clear App Data and Revoke Permission from your Android Studio itself, just with click of a button.

enter image description here

Vishist Varugeese
  • 1,500
  • 1
  • 17
  • 30
5

To remove the key-value pairs from preference, you can easily do the following

getActivity().getSharedPreference().edit().remove("key").apply();

I have also developed a library for easy manipulation of shared preferences. You may find the following link

https://github.com/farruhha/SimplePrefs

Kishan Donga
  • 2,851
  • 2
  • 23
  • 35
Farruh Habibullaev
  • 2,342
  • 1
  • 26
  • 33
5
String prefTag = "someTag";
SharedPreferences prefs = PreferenceManager.getDefaultSharedPreferences(applicationContext);
prefs.edit().remove(prefTag).commit();

This will delete the saved shared preferences with the name "someTag".

Kiran k g
  • 946
  • 11
  • 19
4

To clear all SharedPreferences centrally from any class:

public static SharedPreferences.Editor getEditor(Context context) {
    return getPreferences(context).edit();
}

And then from any class: (commit returns a Boolean where you can check whether your Preferences cleared or not)

Navigation.getEditor(this).clear().commit();

Or you can use apply; it returns void

Navigation.getEditor(this).clear().apply();
Manaus
  • 407
  • 5
  • 9
Sufiyan Ansari
  • 1,780
  • 20
  • 22
3
  • To remove a particular value,

SharedPreferences.Editor remove(String key) followed by a commit() or a apply()

  • To remove all the values,

    SharedPreferences.Editor clear() followed by a commit() or a apply()

Palak Jain
  • 664
  • 6
  • 19
3

The Kotlin ktx way to clear all preferences:

val prefs: SharedPreferences = getSharedPreferences("prefsName", Context.MODE_PRIVATE)
prefs.edit(commit = true) {
    clear()
}

Click here for all Shared preferences operations with examples

Paritosh
  • 2,097
  • 3
  • 30
  • 42
3

One line of code in kotlin:

getSharedPreferences("MY_PREFS_NAME", MODE_PRIVATE).edit().clear().apply()
Biplob Das
  • 2,818
  • 21
  • 13
2

None of the answers work for me since I have many shared preferences keys.

Let's say you are running an Android Test instead of a unit test.

It is working for me loop and delete through all the shared_prefs files.

@BeforeClass will run before all the tests and ActivityTestRule

@BeforeClass
public static void setUp() {
    Context context = InstrumentationRegistry.getTargetContext();

    File root = context.getFilesDir().getParentFile();
    String[] sharedPreferencesFileNames = new File(root, "shared_prefs").list();
    for (String fileName : sharedPreferencesFileNames) {
        context.getSharedPreferences(fileName.replace(".xml", ""), Context.MODE_PRIVATE).edit().clear().commit();
    }
}
Allen
  • 2,979
  • 1
  • 29
  • 34
1
new File(context.getFilesDir(), fileName).delete();

I can delete file in shared preferences with it

0

My Answer:

In Java:

SharedPreferences myPrefs = context.getSharedPreferences("My_Pref", Context.MODE_PRIVATE);
myPrefs.edit().remove("my_key").apply();

In Kotlin:

val myPrefs = context.getSharedPreferences("My_Pref", Context.MODE_PRIVATE)
myPrefs.edit().remove("my_key").apply()
zen_of_kermit
  • 1,404
  • 2
  • 13
  • 19
0

Kotlin :

  var prefs2: SharedPreferences? = context!!.getSharedPreferences("loginFB", 0)
  prefs2!!.edit().remove("email").commit()
Kingsley Mitchell
  • 2,412
  • 2
  • 18
  • 25
-1

This is my Kotlin method:

      public fun clearAllSharedPrefs() {
            val sharedPreferences: SharedPreferences = MainApplication.applicationContext()
                .getSharedPreferences("MY_CUSTOME_KEY", Context.MODE_PRIVATE)
            sharedPreferences.edit().clear()
            sharedPreferences.edit().apply()
        }
Mohsen Emami
  • 2,709
  • 3
  • 33
  • 40
-2

You can use preferences.edit().remove("key").commit() to delete saved values from shared preferences.

Manaus
  • 407
  • 5
  • 9
Ashish Jaiswal
  • 804
  • 1
  • 9
  • 23
-5

Just did this this morning. From a command prompt:

adb shell
cd /data/data/YOUR_PACKAGE_NAME/shared_prefs
rm * // to remove all shared preference files
rm YOUR_PREFS_NAME.xml // to remove a specific shared preference file

NOTE: This requires a rooted device such as the stock Android virtual devices, a Genymotion device, or an actual rooted handset/tablet, etc.

yiati
  • 995
  • 1
  • 12
  • 27
kdahlhaus
  • 480
  • 5
  • 8
  • 11
    So whoever down voted this solution should maybe also explain why: You need a rooted phone to access `/data/data` directly! – nuala May 15 '12 at 16:33
  • 4
    You need to Remove the SharedPreferences form the Application and not the ADB Shell.It is done using: SharedPreferences.edit().clear().commit(); – ThePunisher Feb 06 '14 at 09:18
  • 1
    Asked never said they wanted a no root solution. There is a technical error here though; because this method requires root, you have to run `su` after `adb shell` to open up a privileged shell. – Anubian Noob Jul 14 '15 at 01:43
  • Why was this downvoted so much? This is a useful answer and the one I was looking for. – Matt Feb 03 '20 at 14:20