Added in API level 1

OnSharedPreferenceChangeListener

interface OnSharedPreferenceChangeListener
android.content.SharedPreferences.OnSharedPreferenceChangeListener

Interface definition for a callback to be invoked when a shared preference is changed.

Summary

Public methods
abstract Unit
onSharedPreferenceChanged(sharedPreferences: SharedPreferences!, key: String?)

Called when a shared preference is changed, added, or removed.

Public methods

onSharedPreferenceChanged

Added in API level 1
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.

Parameters
sharedPreferences SharedPreferences!: The SharedPreferences that received the change.
key String?: The key of the preference that was changed, added, or removed. Apps targeting android.os.Build.VERSION_CODES#R on devices running OS versions Android R or later, will receive a null value when preferences are cleared.