Added in API level 1
Deprecated in API level 29

Summary: Nested Classes | Constants | Methods | Inherited Methods

PreferenceManager

Kotlin |Java

public class PreferenceManager
extends Object

java.lang.Object
↳	android.preference.PreferenceManager

This class was deprecated in API level 29.
Use the AndroidX Preference Library for consistent behavior across all devices. For more information on using the AndroidX Preference Library see Settings.

Used to help create Preference hierarchies from activities or XML.

In most cases, clients should use PreferenceActivity.addPreferencesFromIntent or PreferenceActivity.addPreferencesFromResource(int).

See also:

PreferenceActivity

Summary

Nested classes
`interface`	`PreferenceManager.OnActivityDestroyListener` This interface was deprecated in API level 29. Use the AndroidX Preference Library for consistent behavior across all devices. For more information on using the AndroidX Preference Library see Settings.
`interface`	`PreferenceManager.OnActivityResultListener` This interface was deprecated in API level 29. Use the AndroidX Preference Library for consistent behavior across all devices. For more information on using the AndroidX Preference Library see Settings.
`interface`	`PreferenceManager.OnActivityStopListener` This interface was deprecated in API level 29. Use the AndroidX Preference Library for consistent behavior across all devices. For more information on using the AndroidX Preference Library see Settings.

Constants
`String`	`KEY_HAS_SET_DEFAULT_VALUES`
`String`	`METADATA_KEY_PREFERENCES` The Activity meta-data key for its XML preference hierarchy.

Public methods
`PreferenceScreen`	`createPreferenceScreen(Context context)`
`Preference`	`findPreference(CharSequence key)` Finds a `Preference` based on its key.
`static SharedPreferences`	`getDefaultSharedPreferences(Context context)` Gets a `SharedPreferences` instance that points to the default file that is used by the preference framework in the given context.
`static String`	`getDefaultSharedPreferencesName(Context context)` Returns the name used for storing default shared preferences.
`PreferenceDataStore`	`getPreferenceDataStore()` Returns the `PreferenceDataStore` associated with this manager or `null` if the default `SharedPreferences` are used instead.
`SharedPreferences`	`getSharedPreferences()` Gets a `SharedPreferences` instance that preferences managed by this will use.
`int`	`getSharedPreferencesMode()` Returns the current mode of the SharedPreferences file that preferences managed by this will use.
`String`	`getSharedPreferencesName()` Returns the current name of the SharedPreferences file that preferences managed by this will use.
`boolean`	`isStorageDefault()` Indicates if the storage location used internally by this class is the default provided by the hosting `Context`.
`boolean`	`isStorageDeviceProtected()` Indicates if the storage location used internally by this class is backed by device-protected storage.
`static void`	`setDefaultValues(Context context, String sharedPreferencesName, int sharedPreferencesMode, int resId, boolean readAgain)` Similar to `setDefaultValues(android.content.Context, int, boolean)` but allows the client to provide the filename and mode of the shared preferences file.
`static void`	`setDefaultValues(Context context, int resId, boolean readAgain)` Sets the default values from an XML preference file by reading the values defined by each `Preference` item's `android:defaultValue` attribute.
`void`	`setPreferenceDataStore(PreferenceDataStore dataStore)` Sets a `PreferenceDataStore` to be used by all Preferences associated with this manager that don't have a custom `PreferenceDataStore` assigned via `Preference.setPreferenceDataStore(PreferenceDataStore)`.
`void`	`setSharedPreferencesMode(int sharedPreferencesMode)` Sets the mode of the SharedPreferences file that preferences managed by this will use.
`void`	`setSharedPreferencesName(String sharedPreferencesName)` Sets the name of the SharedPreferences file that preferences managed by this will use.
`void`	`setStorageDefault()` Sets the storage location used internally by this class to be the default provided by the hosting `Context`.
`void`	`setStorageDeviceProtected()` Explicitly set the storage location used internally by this class to be device-protected storage.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Constants

KEY_HAS_SET_DEFAULT_VALUES

Added in API level 1

public static final String KEY_HAS_SET_DEFAULT_VALUES

Constant Value: "_has_set_default_values"

METADATA_KEY_PREFERENCES

Added in API level 1

public static final String METADATA_KEY_PREFERENCES

The Activity meta-data key for its XML preference hierarchy.

Constant Value: "android.preference"

Public methods

createPreferenceScreen

Added in API level 1

public PreferenceScreen createPreferenceScreen (Context context)

Parameters
`context`	`Context`

Returns
`PreferenceScreen`

findPreference

Added in API level 1

public Preference findPreference (CharSequence key)

Finds a Preference based on its key.

Parameters
`key`	`CharSequence`: the key of the preference to retrieve

Returns
`Preference`	the `Preference` with the key, or `null`

See also:

PreferenceGroup.findPreference(CharSequence)

getDefaultSharedPreferences

Added in API level 1

public static SharedPreferences getDefaultSharedPreferences (Context context)

Gets a SharedPreferences instance that points to the default file that is used by the preference framework in the given context.

Parameters
`context`	`Context`: The context of the preferences whose values are wanted.

Returns
`SharedPreferences`	A `SharedPreferences` instance that can be used to retrieve and listen to values of the preferences.

getDefaultSharedPreferencesName

Added in API level 24
Deprecated in API level 29

public static String getDefaultSharedPreferencesName (Context context)

Returns the name used for storing default shared preferences.

Parameters
`context`	`Context`

Returns
`String`

See also:

getDefaultSharedPreferences(Context)

getPreferenceDataStore

Added in API level 26
Deprecated in API level 29

public PreferenceDataStore getPreferenceDataStore ()

Returns the PreferenceDataStore associated with this manager or null if the default SharedPreferences are used instead.

Returns
`PreferenceDataStore`	The `PreferenceDataStore` associated with this manager or `null` if none.

See also:

setPreferenceDataStore(PreferenceDataStore)

getSharedPreferences

Added in API level 1

public SharedPreferences getSharedPreferences ()

Gets a SharedPreferences instance that preferences managed by this will use.

Returns
`SharedPreferences`	a `SharedPreferences` instance pointing to the file that contains the values of preferences that are managed by this PreferenceManager. If a `PreferenceDataStore` has been set, this method returns `null`.

getSharedPreferencesMode

Added in API level 1

public int getSharedPreferencesMode ()

Returns the current mode of the SharedPreferences file that preferences managed by this will use.

Returns
`int`	The mode that can be passed to `Context.getSharedPreferences(String, int)`.

See also:

Context.getSharedPreferences(String, int)

getSharedPreferencesName

Added in API level 1

public String getSharedPreferencesName ()

Returns the current name of the SharedPreferences file that preferences managed by this will use.

Returns
`String`	The name that can be passed to `Context.getSharedPreferences(String, int)`.

See also:

Context.getSharedPreferences(String, int)

isStorageDefault

Added in API level 24
Deprecated in API level 29

public boolean isStorageDefault ()

Indicates if the storage location used internally by this class is the default provided by the hosting Context.

Returns
`boolean`

See also:

isStorageDeviceProtected

Added in API level 24
Deprecated in API level 29

public boolean isStorageDeviceProtected ()

Indicates if the storage location used internally by this class is backed by device-protected storage.

Returns
`boolean`

See also:

setDefaultValues

Added in API level 1

public static void setDefaultValues (Context context, 
                String sharedPreferencesName, 
                int sharedPreferencesMode, 
                int resId, 
                boolean readAgain)

Similar to setDefaultValues(android.content.Context, int, boolean) but allows the client to provide the filename and mode of the shared preferences file.

Parameters
`context`	`Context`: The context of the shared preferences.
`sharedPreferencesName`	`String`: A custom name for the shared preferences file.
`sharedPreferencesMode`	`int`: The file creation mode for the shared preferences file, such as `Context.MODE_PRIVATE` or `Context.MODE_PRIVATE`
`resId`	`int`: The resource ID of the preference XML file.
`readAgain`	`boolean`: Whether to re-read the default values. If false, this method will set the default values only if this method has never been called in the past (or if the `KEY_HAS_SET_DEFAULT_VALUES` in the default value shared preferences file is false). To attempt to set the default values again bypassing this check, set `readAgain` to true. Note: this will NOT reset preferences back to their default values. For that functionality, use `PreferenceManager.getDefaultSharedPreferences(Context)` and clear it followed by a call to this method with this parameter set to true.

See also:

setDefaultValues

Added in API level 1

public static void setDefaultValues (Context context, 
                int resId, 
                boolean readAgain)

Sets the default values from an XML preference file by reading the values defined by each Preference item's android:defaultValue attribute. This should be called by the application's main activity.

Parameters
`context`	`Context`: The context of the shared preferences.
`resId`	`int`: The resource ID of the preference XML file.
`readAgain`	`boolean`: Whether to re-read the default values. If false, this method sets the default values only if this method has never been called in the past (or if the `KEY_HAS_SET_DEFAULT_VALUES` in the default value shared preferences file is false). To attempt to set the default values again bypassing this check, set `readAgain` to true. Note: this will NOT reset preferences back to their default values. For that functionality, use `PreferenceManager.getDefaultSharedPreferences(Context)` and clear it followed by a call to this method with this parameter set to true.

setPreferenceDataStore

Added in API level 26
Deprecated in API level 29

public void setPreferenceDataStore (PreferenceDataStore dataStore)

Sets a PreferenceDataStore to be used by all Preferences associated with this manager that don't have a custom PreferenceDataStore assigned via Preference.setPreferenceDataStore(PreferenceDataStore). Also if the data store is set, the child preferences won't use SharedPreferences as long as they are assigned to this manager.

Parameters
`dataStore`	`PreferenceDataStore`: The `PreferenceDataStore` to be used by this manager.

See also:

Preference.setPreferenceDataStore(PreferenceDataStore)

setSharedPreferencesMode

Added in API level 1

public void setSharedPreferencesMode (int sharedPreferencesMode)

Sets the mode of the SharedPreferences file that preferences managed by this will use.

Parameters
`sharedPreferencesMode`	`int`: The mode of the SharedPreferences file.

See also:

Context.getSharedPreferences(String, int)

setSharedPreferencesName

Added in API level 1

public void setSharedPreferencesName (String sharedPreferencesName)

Sets the name of the SharedPreferences file that preferences managed by this will use.

If custom PreferenceDataStore is set, this won't override its usage.

Parameters
`sharedPreferencesName`	`String`: The name of the SharedPreferences file.

See also:

setStorageDefault

Added in API level 24
Deprecated in API level 29

public void setStorageDefault ()

Sets the storage location used internally by this class to be the default provided by the hosting Context.

setStorageDeviceProtected

Added in API level 24
Deprecated in API level 29

public void setStorageDeviceProtected ()

Explicitly set the storage location used internally by this class to be device-protected storage.

On devices with direct boot, data stored in this location is encrypted with a key tied to the physical device, and it can be accessed immediately after the device has booted successfully, both before and after the user has authenticated with their credentials (such as a lock pattern or PIN).

Because device-protected data is available without user authentication, you should carefully limit the data you store using this Context. For example, storing sensitive authentication tokens or passwords in the device-protected area is strongly discouraged.

See also:

Context.createDeviceProtectedStorageContext()

PreferenceManager

Summary

Nested classes

Constants

Public methods

Inherited methods

Constants

KEY_HAS_SET_DEFAULT_VALUES

METADATA_KEY_PREFERENCES

Public methods

createPreferenceScreen

findPreference

getDefaultSharedPreferences

getDefaultSharedPreferencesName

getPreferenceDataStore

getSharedPreferences

getSharedPreferencesMode

getSharedPreferencesName

isStorageDefault

isStorageDeviceProtected

setDefaultValues

setDefaultValues

setPreferenceDataStore

setSharedPreferencesMode

setSharedPreferencesName

setStorageDefault

setStorageDeviceProtected