Added in API level 36

Builder

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

Builder to construct SettingsPreferenceMetadata.

Summary

Public constructors
Builder(screenKey: String, key: String)

Create Builder instance.
Public methods
SettingsPreferenceMetadata

Constructs an immutable SettingsPreferenceMetadata object.
SettingsPreferenceMetadata.Builder
setAvailable(available: Boolean)

Sets whether the preference is available.
SettingsPreferenceMetadata.Builder
setEnabled(enabled: Boolean)

Set whether the preference is enabled.
SettingsPreferenceMetadata.Builder
setExtras(extras: Bundle)

Sets additional fields specific to this preference.
SettingsPreferenceMetadata.Builder
setLaunchIntent(launchIntent: Intent?)

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

Sets the permissions required for reading this preference.
SettingsPreferenceMetadata.Builder
setRestricted(restricted: Boolean)

Sets whether the preference is restricted.
SettingsPreferenceMetadata.Builder
setSummary(summary: String?)

Sets the preference summary.
SettingsPreferenceMetadata.Builder
setTitle(title: String?)

Sets the preference title.
SettingsPreferenceMetadata.Builder
setWritable(writable: Boolean)

Sets whether the preference is writable.
SettingsPreferenceMetadata.Builder
setWritePermissions(writePermissions: MutableList<String!>)

Sets the permissions required for writing this preference.
SettingsPreferenceMetadata.Builder
setWriteSensitivity(sensitivity: Int)

Sets the preference write-level sensitivity.

Public constructors

Builder

Added in API level 36
Builder(
    screenKey: String, 
    key: String)

Create Builder instance.

Parameters
screenKey String: required to be not empty
key String: required to be not empty

Public methods

build

Added in API level 36
fun build(): SettingsPreferenceMetadata

Constructs an immutable SettingsPreferenceMetadata object.

setAvailable

Added in API level 36
fun setAvailable(available: Boolean): SettingsPreferenceMetadata.Builder

Sets whether the preference is available.

setEnabled

Added in API level 36
fun setEnabled(enabled: Boolean): SettingsPreferenceMetadata.Builder

Set whether the preference is enabled.

setExtras

Added in API level 36
fun setExtras(extras: Bundle): SettingsPreferenceMetadata.Builder

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

setLaunchIntent

Added in API level 36
fun setLaunchIntent(launchIntent: Intent?): SettingsPreferenceMetadata.Builder

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

setReadPermissions

Added in API level 36
fun setReadPermissions(readPermissions: MutableList<String!>): SettingsPreferenceMetadata.Builder

Sets the permissions required for reading this preference.

setRestricted

Added in API level 36
fun setRestricted(restricted: Boolean): SettingsPreferenceMetadata.Builder

Sets whether the preference is restricted.

setSummary

Added in API level 36
fun setSummary(summary: String?): SettingsPreferenceMetadata.Builder

Sets the preference summary.

setTitle

Added in API level 36
fun setTitle(title: String?): SettingsPreferenceMetadata.Builder

Sets the preference title.

setWritable

Added in API level 36
fun setWritable(writable: Boolean): SettingsPreferenceMetadata.Builder

Sets whether the preference is writable.

setWritePermissions

Added in API level 36
fun setWritePermissions(writePermissions: MutableList<String!>): SettingsPreferenceMetadata.Builder

Sets the permissions required for writing this preference.

setWriteSensitivity

Added in API level 36
fun setWriteSensitivity(sensitivity: Int): SettingsPreferenceMetadata.Builder

Sets the preference write-level sensitivity.

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