Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Nested Classes](https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata#nestedclasses) \| [Constants](https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata#constants) \| [Inherited Constants](https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata#inhconstants) \| [Fields](https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata#lfields) \| [Methods](https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata#inhmethods)

# SettingsPreferenceMetadata

*** ** * ** ***


`
public

final

class
SettingsPreferenceMetadata
`


`

extends https://developer.android.com/reference/java/lang/Object


`

`


implements

https://developer.android.com/reference/android/os/Parcelable


`

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.service.settings.preferences.SettingsPreferenceMetadata |

<br />

*** ** * ** ***

Data object representation of a Settings Preference definition and state.

## Summary

| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata.Builder` Builder to construct `https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata`. |

| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata#DEEPLINK_ONLY` Indicates preference is write-sensitive. |
| `int` | `https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata#EXPECT_POST_CONFIRMATION` Indicates preference is mildly write-sensitive. |
| `int` | `https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata#NO_DIRECT_ACCESS` Indicates preference is highly write-sensitivity and carries significant user-risk. |
| `int` | `https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata#NO_SENSITIVITY` Indicates preference is not write-sensitive. |

| ### Inherited constants |
|---|
| From interface `https://developer.android.com/reference/android/os/Parcelable` |---|---| | `int` | `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor. | | `int` | `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`: 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)`". | |

| ### Fields ||
|---|---|
| ` public static final https://developer.android.com/reference/android/os/Parcelable.Creator<https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata>` | `https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata#CREATOR` Parcelable Creator for `https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata`. |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` https://developer.android.com/reference/android/os/Bundle` | ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata#getExtras()() ` Returns any additional fields specific to this preference. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata#getKey()() ` Returns the key of Preference. |
| ` https://developer.android.com/reference/android/content/Intent` | ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata#getLaunchIntent()() ` Returns the intent to launch the host app page for this Preference. |
| ` https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/java/lang/String>` | ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata#getReadPermissions()() ` Returns the permissions required to read this Preference's value. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata#getScreenKey()() ` Returns the screen key of Preference. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata#getSummary()() ` Returns the summary of Preference. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata#getTitle()() ` Returns the title of Preference. |
| ` https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/java/lang/String>` | ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata#getWritePermissions()() ` Returns the permissions required to write this Preference's value. |
| ` int` | ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata#getWriteSensitivity()() ` Returns the write-level sensitivity of Preference. |
| ` boolean` | ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata#isAvailable()() ` Returns whether Preference is available. |
| ` boolean` | ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata#isEnabled()() ` Returns whether Preference is enabled. |
| ` boolean` | ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata#isRestricted()() ` Returns whether Preference is restricted. |
| ` boolean` | ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata#isWritable()() ` Returns whether Preference is writable. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata#toString()() ` Returns a string representation of the object. |
| ` void` | ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. |

| ### Inherited methods |
|---|---|
| From class ` https://developer.android.com/reference/java/lang/Object ` |---|---| | ` https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/java/lang/Object#clone()() ` Creates and returns a copy of this object. | | ` boolean` | ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` https://developer.android.com/reference/java/lang/Object#finalize()() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final https://developer.android.com/reference/java/lang/Class<?>` | ` https://developer.android.com/reference/java/lang/Object#getClass()() ` Returns the runtime class of this `Object`. | | ` int` | ` https://developer.android.com/reference/java/lang/Object#hashCode()() ` Returns a hash code value for the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notify()() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notifyAll()() ` Wakes up all threads that are waiting on this object's monitor. | | ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/Object#toString()() ` Returns a string representation of the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(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` | ` https://developer.android.com/reference/java/lang/Object#wait(long)(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` | ` https://developer.android.com/reference/java/lang/Object#wait()() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||
| From interface ` https://developer.android.com/reference/android/os/Parcelable ` |---|---| | ` abstract int` | ` https://developer.android.com/reference/android/os/Parcelable#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. | | ` abstract void` | ` https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. | ||

## Constants

### DEEPLINK_ONLY

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int DEEPLINK_ONLY
```

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 `https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata#getLaunchIntent()`.

<br />

Constant Value:

2
(0x00000002)


### EXPECT_POST_CONFIRMATION

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int EXPECT_POST_CONFIRMATION
```

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.

<br />

Constant Value:

1
(0x00000001)


### NO_DIRECT_ACCESS

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int NO_DIRECT_ACCESS
```

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.

<br />

Constant Value:

3
(0x00000003)


### NO_SENSITIVITY

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int NO_SENSITIVITY
```

Indicates preference is not write-sensitive.

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

<br />

Constant Value:

0
(0x00000000)


## Fields

### CREATOR

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Creator<SettingsPreferenceMetadata> CREATOR
```

Parcelable Creator for `https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata`.

<br />

## Public methods

### describeContents

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int describeContents ()
```

Describe the kinds of special objects contained in this Parcelable
instance's marshaled representation. For example, if the object will
include a file descriptor in the output of `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`,
the return value of this method must include the
`https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` bit.

<br />

| Returns ||
|---|---|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or - `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` |

### getExtras

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public Bundle getExtras ()
```

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.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/os/Bundle` | <br /> |

### getKey

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String getKey ()
```

Returns the key of Preference.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | <br /> |

### getLaunchIntent

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public Intent getLaunchIntent ()
```

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

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/content/Intent` | <br /> |

### getReadPermissions

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public List<String> getReadPermissions ()
```

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

May be empty.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/java/lang/String>` | <br /> |

### getScreenKey

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String getScreenKey ()
```

Returns the screen key of Preference.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | <br /> |

### getSummary

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String getSummary ()
```

Returns the summary of Preference.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | <br /> |

### getTitle

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String getTitle ()
```

Returns the title of Preference.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | <br /> |

### getWritePermissions

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public List<String> getWritePermissions ()
```

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

May be empty.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/java/lang/String>` | <br /> |

### getWriteSensitivity

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getWriteSensitivity ()
```

Returns the write-level sensitivity of Preference.

<br />

| Returns ||
|---|---|
| `int` | Value is one of the following: - `https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata#NO_SENSITIVITY` - `https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata#EXPECT_POST_CONFIRMATION` - `https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata#DEEPLINK_ONLY` - `https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata#NO_DIRECT_ACCESS` |

### isAvailable

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean isAvailable ()
```

Returns whether Preference is available.

<br />

| Returns ||
|---|---|
| `boolean` | <br /> |

### isEnabled

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean isEnabled ()
```

Returns whether Preference is enabled.

<br />

| Returns ||
|---|---|
| `boolean` | <br /> |

### isRestricted

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean isRestricted ()
```

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.

<br />

| Returns ||
|---|---|
| `boolean` | <br /> |

### isWritable

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean isWritable ()
```

Returns whether Preference is writable.

<br />

| Returns ||
|---|---|
| `boolean` | <br /> |

### toString

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String toString ()
```

Returns a string representation of the object.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string representation of the object. <br /> |

### writeToParcel

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void writeToParcel (Parcel dest, 
                int flags)
```

Flatten this object in to a Parcel.

<br />

| Parameters ||
|---|---|
| `dest` | `Parcel`: The Parcel in which the object should be written. This value cannot be `null`. <br /> |
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |