Stay organized with collections
Save and categorize content based on your preferences.
SharedPreferences.OnSharedPreferenceChangeListener
public
static
interface
SharedPreferences.OnSharedPreferenceChangeListener
| android.content.SharedPreferences.OnSharedPreferenceChangeListener
|
Interface definition for a callback to be invoked when a shared
preference is changed.
Summary
Public methods
onSharedPreferenceChanged
public abstract void onSharedPreferenceChanged (SharedPreferences sharedPreferences,
String key)
Called when a shared preference is changed, added, or removed. This
may be called even if a preference is set to its existing value.
This callback will be run on your main thread.
Note: This callback will not be triggered when preferences are cleared
via Editor.clear(), unless targeting Build.VERSION_CODES.R
on devices running OS versions Android R
or later.
| Parameters |
|---|
sharedPreferences |
SharedPreferences: The SharedPreferences that received the change. |
key |
String: The key of the preference that was changed, added, or removed. Apps targeting
Build.VERSION_CODES.R on devices running OS versions
Android R or later, will receive
a null value when preferences are cleared. |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[null,null,["Last updated 2025-02-10 UTC."],[],[],null,["# SharedPreferences.OnSharedPreferenceChangeListener\n\nAdded in [API level 1](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\nSharedPreferences.OnSharedPreferenceChangeListener\n==================================================\n\n*** ** * ** ***\n\n[Kotlin](/reference/kotlin/android/content/SharedPreferences.OnSharedPreferenceChangeListener \"View this page in Kotlin\") \\|Java\n\n\n`\npublic\nstatic\n\n\ninterface\nSharedPreferences.OnSharedPreferenceChangeListener\n`\n\n\n`\n\n\n`\n\n|--------------------------------------------------------------------|\n| android.content.SharedPreferences.OnSharedPreferenceChangeListener |\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nInterface definition for a callback to be invoked when a shared\npreference is changed.\n\nSummary\n-------\n\n| ### Public methods ||\n|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` abstract void` | ` `[onSharedPreferenceChanged](/reference/android/content/SharedPreferences.OnSharedPreferenceChangeListener#onSharedPreferenceChanged(android.content.SharedPreferences,%20java.lang.String))`(`[SharedPreferences](/reference/android/content/SharedPreferences)` sharedPreferences, `[String](/reference/java/lang/String)` key) ` Called when a shared preference is changed, added, or removed. |\n\nPublic methods\n--------------\n\n### onSharedPreferenceChanged\n\nAdded in [API level 1](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic abstract void onSharedPreferenceChanged (SharedPreferences sharedPreferences, \n String key)\n```\n\nCalled when a shared preference is changed, added, or removed. This\nmay be called even if a preference is set to its existing value.\n\nThis callback will be run on your main thread.\n\n*Note: This callback will not be triggered when preferences are cleared\nvia [Editor.clear()](/reference/android/content/SharedPreferences.Editor#clear()), unless targeting [Build.VERSION_CODES.R](/reference/android/os/Build.VERSION_CODES#R)\non devices running OS versions [Android R](/reference/android/os/Build.VERSION_CODES#R)\nor later.*\n\n\u003cbr /\u003e\n\n| Parameters ||\n|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `sharedPreferences` | `SharedPreferences`: The [SharedPreferences](/reference/android/content/SharedPreferences) that received the change. \u003cbr /\u003e |\n| `key` | `String`: The key of the preference that was changed, added, or removed. Apps targeting [Build.VERSION_CODES.R](/reference/android/os/Build.VERSION_CODES#R) on devices running OS versions [Android R](/reference/android/os/Build.VERSION_CODES#R) or later, will receive a `null` value when preferences are cleared. \u003cbr /\u003e |"]]
