Added in API level 36

Summary: Nested Classes | Inherited Constants | Fields | Methods | Inherited Methods

SetValueRequest

Kotlin |Java

public final class SetValueRequest
extends Object implements Parcelable

java.lang.Object
↳	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
`class`	`SetValueRequest.Builder` Builder to construct `SetValueRequest`.

Inherited constants

From interface android.os.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(Parcel, int)`: 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 Creator<SetValueRequest>`	`CREATOR` Parcelable Creator for `SetValueRequest`.

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`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.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(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`	`wait(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`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 36

public static final Creator<SetValueRequest> CREATOR

Parcelable Creator for SetValueRequest.

Public methods

describeContents

Added in API level 36

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 writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
`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

public String getPreferenceKey ()

Returns the key of requested Preference.

Returns
`String`

getPreferenceValue

Added in API level 36

public SettingsPreferenceValue getPreferenceValue ()

Returns the value of requested Preference.

Returns
`SettingsPreferenceValue`

getScreenKey

Added in API level 36

public String getScreenKey ()

Returns the screen key of requested Preference.

Returns
`String`

writeToParcel

Added in API level 36

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

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.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`

SetValueRequest

Summary

Nested classes

Inherited constants

Fields

Public methods

Inherited methods

Fields

CREATOR

Public methods

describeContents

getPreferenceKey

getPreferenceValue

getScreenKey

writeToParcel