SetValueRequest

Kotlin |Java

class SetValueRequest : Parcelable

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

Request parameters to set the current value to a Settings Preference.

This object passed to SettingsPreferenceService.onSetPreferenceValue will result in a SetValueResult.

getScreenKey is a parameter to distinguish the container screen of a preference as a preference key may not be unique within its application.
getPreferenceKey is a parameter to identify the preference for which the value is being requested. These keys will be unique with their Preference Screen, but may not be unique within their application, so it is required to pair this with getScreenKey to ensure this request matches the intended target.
getPreferenceValue is a parameter to specify the value that this request aims to set. If this value is invalid (malformed or does not match the type of the preference) then this request will fail.

Summary

Nested classes
	`Builder` Builder to construct `SetValueRequest`.

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
Int	`describeContents()`
String	`getPreferenceKey()` Returns the key of requested Preference.
SettingsPreferenceValue	`getPreferenceValue()` Returns the value of requested Preference.
String	`getScreenKey()` Returns the screen key of requested Preference.
Unit	`writeToParcel(dest: Parcel, flags: Int)`

Properties
static Parcelable.Creator<SetValueRequest!>	`CREATOR` Parcelable Creator for `SetValueRequest`.

Public methods

describeContents

Added in API level 36

fun describeContents(): Int

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

getPreferenceKey

Added in API level 36

fun getPreferenceKey(): String

Returns the key of requested Preference.

getPreferenceValue

Added in API level 36

fun getPreferenceValue(): SettingsPreferenceValue

Returns the value of requested Preference.

getScreenKey

Added in API level 36

fun getScreenKey(): String

Returns the screen key of requested Preference.

writeToParcel

Added in API level 36

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Parameters
`dest`	Parcel: The Parcel in which the object should be written. This value cannot be `null`.
`flags`	Int: Additional flags about how the object should be written. May be 0 or `PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: `PARCELABLE_WRITE_RETURN_VALUE`

Properties

CREATOR

Added in API level 36

static val CREATOR: Parcelable.Creator<SetValueRequest!>

Parcelable Creator for SetValueRequest.