GetValueRequest


class GetValueRequest : Parcelable
kotlin.Any
   ↳ 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

Builder to construct GetValueRequest.

Inherited constants
Public methods
String

Returns the key of requested Preference.

String

Returns the screen key of requested Preference.

Properties
static Parcelable.Creator<GetValueRequest!>

Parcelable Creator for GetValueRequest.

Public methods

getPreferenceKey

fun getPreferenceKey(): String

Returns the key of requested Preference.

getScreenKey

fun getScreenKey(): String

Returns the screen key of requested Preference.

Properties

CREATOR

static val CREATOR: Parcelable.Creator<GetValueRequest!>

Parcelable Creator for GetValueRequest.