SetValueRequest
class SetValueRequest : Parcelable
kotlin.Any | |
↳ | 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 withgetScreenKey
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 | |
---|---|
Builder to construct |
Inherited constants | |
---|---|
Public methods | |
---|---|
String |
Returns the key of requested Preference. |
SettingsPreferenceValue |
Returns the value of requested Preference. |
String |
Returns the screen key of requested Preference. |
Properties | |
---|---|
static Parcelable.Creator<SetValueRequest!> |
Parcelable Creator for |
Public methods
getPreferenceKey
fun getPreferenceKey(): String
Returns the key of requested Preference.
getPreferenceValue
fun getPreferenceValue(): SettingsPreferenceValue
Returns the value of requested Preference.
getScreenKey
fun getScreenKey(): String
Returns the screen key of requested Preference.
Properties
CREATOR
static val CREATOR: Parcelable.Creator<SetValueRequest!>
Parcelable Creator for SetValueRequest
.