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

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

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