Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Ctors](https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata.Builder#pubctors) \| [Methods](https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata.Builder#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata.Builder#inhmethods)

# SettingsPreferenceMetadata.Builder

*** ** * ** ***

` public static final class SettingsPreferenceMetadata.Builder `   
` extends https://developer.android.com/reference/java/lang/Object ` ` `

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

<br />

*** ** * ** ***

Builder to construct `https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata`.

## Summary

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata.Builder#Builder(java.lang.String,%20java.lang.String)(https://developer.android.com/reference/java/lang/String screenKey, https://developer.android.com/reference/java/lang/String key) ` Create Builder instance. |

| ### Public methods ||
|---|---|
| ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata` | ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata.Builder#build()() ` Constructs an immutable `https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata` object. |
| ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata.Builder` | ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata.Builder#setAvailable(boolean)(boolean available) ` Sets whether the preference is available. |
| ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata.Builder` | ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata.Builder#setEnabled(boolean)(boolean enabled) ` Set whether the preference is enabled. |
| ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata.Builder` | ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata.Builder#setExtras(android.os.Bundle)(https://developer.android.com/reference/android/os/Bundle extras) ` Sets additional fields specific to this preference. |
| ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata.Builder` | ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata.Builder#setLaunchIntent(android.content.Intent)(https://developer.android.com/reference/android/content/Intent launchIntent) ` Sets the intent to launch the host app page for this preference. |
| ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata.Builder` | ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata.Builder#setReadPermissions(java.util.List<java.lang.String>)(https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/java/lang/String> readPermissions) ` Sets the permissions required for reading this preference. |
| ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata.Builder` | ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata.Builder#setRestricted(boolean)(boolean restricted) ` Sets whether the preference is restricted. |
| ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata.Builder` | ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata.Builder#setSummary(java.lang.String)(https://developer.android.com/reference/java/lang/String summary) ` Sets the preference summary. |
| ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata.Builder` | ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata.Builder#setTitle(java.lang.String)(https://developer.android.com/reference/java/lang/String title) ` Sets the preference title. |
| ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata.Builder` | ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata.Builder#setWritable(boolean)(boolean writable) ` Sets whether the preference is writable. |
| ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata.Builder` | ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata.Builder#setWritePermissions(java.util.List<java.lang.String>)(https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/java/lang/String> writePermissions) ` Sets the permissions required for writing this preference. |
| ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata.Builder` | ` https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata.Builder#setWriteSensitivity(int)(int sensitivity) ` Sets the preference write-level sensitivity. |

### 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*.

## Public constructors

### Builder

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

```
public Builder (String screenKey, 
                String key)
```

Create Builder instance.

<br />

| Parameters ||
|---|---|
| `screenKey` | `String`: required to be not empty <br /> |
| `key` | `String`: required to be not empty <br /> |

## Public methods

### build

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

```
public SettingsPreferenceMetadata build ()
```

Constructs an immutable `https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata` object.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata` | <br /> |

### setAvailable

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

```
public SettingsPreferenceMetadata.Builder setAvailable (boolean available)
```

Sets whether the preference is available.

<br />

| Parameters ||
|---|---|
| `available` | `boolean` <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata.Builder` | <br /> |

### setEnabled

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

```
public SettingsPreferenceMetadata.Builder setEnabled (boolean enabled)
```

Set whether the preference is enabled.

<br />

| Parameters ||
|---|---|
| `enabled` | `boolean` <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata.Builder` | <br /> |

### setExtras

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

```
public SettingsPreferenceMetadata.Builder setExtras (Bundle extras)
```

Sets additional fields specific to this preference. Treat all data as optional.

<br />

| Parameters ||
|---|---|
| `extras` | `Bundle` <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata.Builder` | <br /> |

### setLaunchIntent

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

```
public SettingsPreferenceMetadata.Builder setLaunchIntent (Intent launchIntent)
```

Sets the intent to launch the host app page for this preference.

<br />

| Parameters ||
|---|---|
| `launchIntent` | `Intent` <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata.Builder` | <br /> |

### setReadPermissions

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

```
public SettingsPreferenceMetadata.Builder setReadPermissions (List<String> readPermissions)
```

Sets the permissions required for reading this preference.

<br />

| Parameters ||
|---|---|
| `readPermissions` | `List` <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata.Builder` | <br /> |

### setRestricted

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

```
public SettingsPreferenceMetadata.Builder setRestricted (boolean restricted)
```

Sets whether the preference is restricted.

<br />

| Parameters ||
|---|---|
| `restricted` | `boolean` <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata.Builder` | <br /> |

### setSummary

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

```
public SettingsPreferenceMetadata.Builder setSummary (String summary)
```

Sets the preference summary.

<br />

| Parameters ||
|---|---|
| `summary` | `String` <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata.Builder` | <br /> |

### setTitle

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

```
public SettingsPreferenceMetadata.Builder setTitle (String title)
```

Sets the preference title.

<br />

| Parameters ||
|---|---|
| `title` | `String` <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata.Builder` | <br /> |

### setWritable

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

```
public SettingsPreferenceMetadata.Builder setWritable (boolean writable)
```

Sets whether the preference is writable.

<br />

| Parameters ||
|---|---|
| `writable` | `boolean` <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata.Builder` | <br /> |

### setWritePermissions

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

```
public SettingsPreferenceMetadata.Builder setWritePermissions (List<String> writePermissions)
```

Sets the permissions required for writing this preference.

<br />

| Parameters ||
|---|---|
| `writePermissions` | `List` <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata.Builder` | <br /> |

### setWriteSensitivity

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

```
public SettingsPreferenceMetadata.Builder setWriteSensitivity (int sensitivity)
```

Sets the preference write-level sensitivity.

<br />

| Parameters ||
|---|---|
| `sensitivity` | `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` |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata.Builder` | <br /> |