setDefaultValues

open fun setDefaultValues(@NonNull context: Context, resId: Int, readAgain: Boolean)(source)

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

The context of the shared preferences

resId

The resource ID of the preference XML file

readAgain

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 getDefaultSharedPreferences and clear it followed by a call to this method with this parameter set to true.


open fun setDefaultValues(@NonNull context: Context, sharedPreferencesName: String, sharedPreferencesMode: Int, resId: Int, readAgain: Boolean)(source)

Similar to setDefaultValues but allows the client to provide the filename and mode of the shared preferences file.

Parameters

context

The context of the shared preferences

sharedPreferencesName

A custom name for the shared preferences file

sharedPreferencesMode

The file creation mode for the shared preferences file, such as MODE_PRIVATE or MODE_PRIVATE.

resId

The resource ID of the preference XML file

readAgain

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 getDefaultSharedPreferences and clear it followed by a call to this method with this parameter set to true.

See also