GetValueRequest
public final class GetValueRequest
extends Object implements Parcelable
| java.lang.Object | |
| ↳ | android.service.settings.preferences.GetValueRequest |
Request parameters to retrieve the current value of a Settings Preference.
This object passed to SettingsPreferenceService.onGetPreferenceValue will result in a GetValueResult.
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 withgetScreenKey()to ensure this request matches the intended target.
Summary
Nested classes | |
|---|---|
class | GetValueRequest.Builder Builder to construct |
Inherited constants |
|---|
Fields | |
|---|---|
public static final Creator<GetValueRequest> | CREATOR Parcelable Creator for |
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. |
String | getScreenKey() Returns the screen key of requested Preference. |
void | writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel. |
Inherited methods | |
|---|---|
Fields
CREATOR
public static final Creator<GetValueRequest> CREATOR
Parcelable Creator for GetValueRequest.
Public methods
describeContents
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(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 |
getPreferenceKey
public String getPreferenceKey ()
Returns the key of requested Preference.
| Returns | |
|---|---|
String | |
getScreenKey
public String getScreenKey ()
Returns the screen key of requested Preference.
| Returns | |
|---|---|
String | |
writeToParcel
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: |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2026-02-26 UTC.