Stay organized with collections
Save and categorize content based on your preferences.
OnSharedPreferenceChangeListener
interface OnSharedPreferenceChangeListener
Interface definition for a callback to be invoked when a shared preference is changed.
Summary
| Public methods |
| abstract Unit |
Called when a shared preference is changed, added, or removed.
|
Public methods
onSharedPreferenceChanged
abstract fun onSharedPreferenceChanged(
sharedPreferences: SharedPreferences!,
key: String?
): Unit
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 android.os.Build.VERSION_CODES#R on devices running OS versions Android R or later.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# SharedPreferences.OnSharedPreferenceChangeListener\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nOnSharedPreferenceChangeListener\n================================\n\n*** ** * ** ***\n\nKotlin \\|[Java](/reference/android/content/SharedPreferences.OnSharedPreferenceChangeListener \"View this page in Java\") \n\n```\ninterface OnSharedPreferenceChangeListener\n```\n\n|-------------------------------------------------------------------------|\n| [android.content.SharedPreferences.OnSharedPreferenceChangeListener](#) |\n\nInterface definition for a callback to be invoked when a shared preference is changed.\n\nSummary\n-------\n\n| Public methods ||\n|---------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| abstract [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [onSharedPreferenceChanged](#onSharedPreferenceChanged(android.content.SharedPreferences,%20kotlin.String))`(`sharedPreferences:` `[SharedPreferences](/reference/kotlin/android/content/SharedPreferences)!`, `key:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?`)` Called when a shared preference is changed, added, or removed. |\n\nPublic methods\n--------------\n\n### onSharedPreferenceChanged\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nabstract fun onSharedPreferenceChanged(\n sharedPreferences: SharedPreferences!, \n key: String?\n): Unit\n```\n\nCalled when a shared preference is changed, added, or removed. This may 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 via [Editor.clear()](/reference/kotlin/android/content/SharedPreferences.Editor#clear()), unless targeting [android.os.Build.VERSION_CODES#R](../os/Build.VERSION_CODES.html#R:kotlin.Int) on devices running OS versions [Android R](../os/Build.VERSION_CODES.html#R:kotlin.Int) or later.*\n\n| Parameters ||\n|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `sharedPreferences` | [SharedPreferences](/reference/kotlin/android/content/SharedPreferences)!: The [SharedPreferences](/reference/kotlin/android/content/SharedPreferences) that received the change. |\n| `key` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?: The key of the preference that was changed, added, or removed. Apps targeting [android.os.Build.VERSION_CODES#R](../os/Build.VERSION_CODES.html#R:kotlin.Int) on devices running OS versions [Android R](../os/Build.VERSION_CODES.html#R:kotlin.Int) or later, will receive a `null` value when preferences are cleared. |"]]
