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 with getScreenKey() to ensure this request matches the intended target.

Summary

Nested classes

class GetValueRequest.Builder

Builder to construct GetValueRequest

Inherited constants

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<GetValueRequest> CREATOR

Parcelable Creator for GetValueRequest.

Public methods

String getPreferenceKey()

Returns the key of requested Preference.

String getScreenKey()

Returns the screen key of requested Preference.

Inherited methods

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.

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

public static final Creator<GetValueRequest> CREATOR

Parcelable Creator for GetValueRequest.

Public methods

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