Added in API level Baklava

SettingsPreferenceMetadata

---

Kotlin |Java

class SettingsPreferenceMetadata : Parcelable

kotlin.Any
↳	android.service.settings.preferences.SettingsPreferenceMetadata

Data object representation of a Settings Preference definition and state.

Summary

Nested classes
	Builder Builder to construct SettingsPreferenceMetadata.

Constants
static Int	DEEPLINK_ONLY Indicates preference is write-sensitive.
static Int	EXPECT_POST_CONFIRMATION Indicates preference is mildly write-sensitive.
static Int	NO_DIRECT_ACCESS Indicates preference is highly write-sensitivity and carries significant user-risk.
static Int	NO_SENSITIVITY Indicates preference is not write-sensitive.

Inherited constants

From class Parcelable Int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. Int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public methods
Bundle	getExtras() Returns any additional fields specific to this preference.
String	getKey() Returns the key of Preference.
Intent?	getLaunchIntent() Returns the intent to launch the host app page for this Preference.
MutableList<String!>	getReadPermissions() Returns the permissions required to read this Preference's value.
String	getScreenKey() Returns the screen key of Preference.
String?	getSummary() Returns the summary of Preference.
String?	getTitle() Returns the title of Preference.
MutableList<String!>	getWritePermissions() Returns the permissions required to write this Preference's value.
Int	getWriteSensitivity() Returns the write-level sensitivity of Preference.
Boolean	isAvailable() Returns whether Preference is available.
Boolean	isEnabled() Returns whether Preference is enabled.
Boolean	isRestricted() Returns whether Preference is restricted.
Boolean	isWritable() Returns whether Preference is writable.

Properties
static Parcelable.Creator<SettingsPreferenceMetadata!>	CREATOR Parcelable Creator for SettingsPreferenceMetadata.

Constants

DEEPLINK_ONLY

Added in API level Baklava

static val DEEPLINK_ONLY: Int

Indicates preference is write-sensitive.

This preference cannot be changed through this API; instead a deeplink to the Preference's page should be used instead, accessible via getLaunchIntent.

Value: 2

EXPECT_POST_CONFIRMATION

Added in API level Baklava

static val EXPECT_POST_CONFIRMATION: Int

Indicates preference is mildly write-sensitive.

In addition to necessary permissions, after writing its value the user should be given the option to revert back.

Value: 1

NO_DIRECT_ACCESS

Added in API level Baklava

static val NO_DIRECT_ACCESS: Int

Indicates preference is highly write-sensitivity and carries significant user-risk.

This Preference cannot be changed through this API and no direct deeplink is available. Other Metadata is still available.

Value: 3

NO_SENSITIVITY

Added in API level Baklava

static val NO_SENSITIVITY: Int

Indicates preference is not write-sensitive.

Its value is writable without explicit consent, assuming all necessary permissions are granted.

Value: 0

Public methods

getExtras

Added in API level Baklava

fun getExtras(): Bundle

Returns any additional fields specific to this preference.

Treat all data as optional. This may contain unstructured data for a given preference, where the type and format of this data may only known by inspecting the source code of that preference. As such, any access of this data must handle failures gracefully to account for changing or missing data.

getKey

Added in API level Baklava

fun getKey(): String

Returns the key of Preference.

getLaunchIntent

Added in API level Baklava

fun getLaunchIntent(): Intent?

Returns the intent to launch the host app page for this Preference.

getReadPermissions

Added in API level Baklava

fun getReadPermissions(): MutableList<String!>

Returns the permissions required to read this Preference's value.

May be empty.

getScreenKey

Added in API level Baklava

fun getScreenKey(): String

Returns the screen key of Preference.

getSummary

Added in API level Baklava

fun getSummary(): String?

Returns the summary of Preference.

getTitle

Added in API level Baklava

fun getTitle(): String?

Returns the title of Preference.

getWritePermissions

Added in API level Baklava

fun getWritePermissions(): MutableList<String!>

Returns the permissions required to write this Preference's value.

May be empty.

getWriteSensitivity

Added in API level Baklava

fun getWriteSensitivity(): Int

Returns the write-level sensitivity of Preference.

Return
Int	Value is android.service.settings.preferences.SettingsPreferenceMetadata#NO_SENSITIVITY, android.service.settings.preferences.SettingsPreferenceMetadata#EXPECT_POST_CONFIRMATION, android.service.settings.preferences.SettingsPreferenceMetadata#DEEPLINK_ONLY, or android.service.settings.preferences.SettingsPreferenceMetadata#NO_DIRECT_ACCESS

isAvailable

Added in API level Baklava

fun isAvailable(): Boolean

Returns whether Preference is available.

isEnabled

Added in API level Baklava

fun isEnabled(): Boolean

Returns whether Preference is enabled.

isRestricted

Added in API level Baklava

fun isRestricted(): Boolean

Returns whether Preference is restricted.

If true, this means the Preference is treated as a Restricted Preference which indicates that it could be conditionally disabled/unavailable due to admin settings.

isWritable

Added in API level Baklava

fun isWritable(): Boolean

Returns whether Preference is writable.

Properties

CREATOR

Added in API level Baklava

static val CREATOR: Parcelable.Creator<SettingsPreferenceMetadata!>

Parcelable Creator for SettingsPreferenceMetadata.