PreferenceManager

fun <T : Preference?> findPreference(key: CharSequence): T?

Finds a Preference with the given key. Returns null if no Preference could be found with the given key.

fun getContext(): Context

Returns the context.

java-static fun getDefaultSharedPreferences(context: Context): SharedPreferences!

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

fun getOnNavigateToScreenListener(): PreferenceManager.OnNavigateToScreenListener?

Returns the PreferenceManager.OnNavigateToScreenListener, if one has been set.

fun getPreferenceDataStore(): PreferenceDataStore?

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

fun getPreferenceScreen(): PreferenceScreen!

Returns the root of the preference hierarchy managed by this class.

fun getSharedPreferences(): SharedPreferences?

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

fun getSharedPreferencesMode(): Int

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

fun getSharedPreferencesName(): String!

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

fun isStorageDefault(): Boolean

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

fun isStorageDeviceProtected(): Boolean

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

java-static fun setDefaultValues(context: Context, resId: Int, readAgain: Boolean): Unit

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.

java-static fun setDefaultValues(
    context: Context,
    sharedPreferencesName: String!,
    sharedPreferencesMode: Int,
    resId: Int,
    readAgain: Boolean
): Unit

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

fun setOnNavigateToScreenListener(
    listener: PreferenceManager.OnNavigateToScreenListener?
): Unit

Sets the callback to be invoked when a PreferenceScreen in the hierarchy rooted at this PreferenceManager is clicked.

fun setOnPreferenceTreeClickListener(
    listener: PreferenceManager.OnPreferenceTreeClickListener?
): Unit

Sets the callback to be invoked when a Preference in the hierarchy rooted at this PreferenceManager is clicked.

fun setPreferenceDataStore(dataStore: PreferenceDataStore?): Unit

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

fun setPreferences(preferenceScreen: PreferenceScreen!): Boolean

Sets the root of the preference hierarchy.

fun setSharedPreferencesMode(sharedPreferencesMode: Int): Unit

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

fun setSharedPreferencesName(sharedPreferencesName: String!): Unit

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.

fun setStorageDefault(): Unit

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

fun setStorageDeviceProtected(): Unit

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.

Prior to API 24 this method has no effect, since device-protected storage is not available.

fun showDialog(preference: Preference): Unit

Called when a preference requests that a dialog be shown to complete a user interaction.