Android.Service.Settings.Preferences Namespace
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Provides services, clients, requests, and results for access to settings preference metadata and values.
Classes
| Name | Description |
|---|---|
| GetValueRequest |
Request parameters to retrieve the current value of a Settings Preference. |
| GetValueRequest.Builder |
Builder to construct |
| GetValueRequest.InterfaceConsts |
Contains inherited parcelable constants for GetValueRequest. |
| GetValueResult |
Result object given a corresponding |
| GetValueResult.Builder |
Builder to construct |
| GetValueResult.InterfaceConsts |
Contains inherited parcelable constants for GetValueResult. |
| MetadataRequest |
Request parameters to retrieve all metadata for all available settings preferences within this application. |
| MetadataRequest.Builder |
Builder to construct |
| MetadataRequest.InterfaceConsts |
Contains inherited parcelable constants for MetadataRequest. |
| MetadataResult |
Result object given a corresponding |
| MetadataResult.Builder |
Builder to construct |
| MetadataResult.InterfaceConsts |
Contains inherited parcelable constants for MetadataResult. |
| SettingsPreferenceMetadata |
Data object representation of a Settings Preference definition and state. |
| SettingsPreferenceMetadata.Builder |
Builder to construct |
| SettingsPreferenceMetadata.InterfaceConsts |
Contains inherited parcelable constants for SettingsPreferenceMetadata. |
| SettingsPreferenceService |
Base class for a service that exposes its settings preferences to external access. |
| SettingsPreferenceServiceClient |
Client class responsible for binding to and interacting with an instance of
|
| SettingsPreferenceValue |
This objects represents a value that can be used for a particular settings preference. |
| SettingsPreferenceValue.Builder |
Builder to construct |
| SettingsPreferenceValue.InterfaceConsts |
Contains inherited parcelable constants for SettingsPreferenceValue. |
| SetValueRequest |
Request parameters to set the current value to a Settings Preference. |
| SetValueRequest.Builder |
Builder to construct |
| SetValueRequest.InterfaceConsts |
Contains inherited parcelable constants for SetValueRequest. |
| SetValueResult |
Result object given a corresponding |
| SetValueResult.Builder |
Builder to construct |
| SetValueResult.InterfaceConsts |
Contains inherited parcelable constants for SetValueResult. |
Enums
| Name | Description |
|---|---|
| GetValueResultType |
Specifies the result code returned for a preference value request. |
| MetadataResultType |
Specifies the result code returned for a preference metadata request. |
| SettingsPreferenceMetadataType |
Specifies the write sensitivity of a Settings preference. |
| SettingsPreferenceValueType |
Specifies the data type of a Settings preference value. |
| SetValueResultType |
Specifies the result code returned when setting a preference value. |
Remarks
SettingsPreferenceService exposes preferences from a settings application. SettingsPreferenceServiceClient connects to that service to retrieve metadata, read values, or request value changes.
Metadata describes a preference's state, required permissions, and write sensitivity. These descriptions do not grant access. Check each result's status code to determine whether a request succeeded.
Use the type indicator on SettingsPreferenceValue to select the matching value property. Do not assume that a property for another type supplies a converted value or a default.
Android 16 source for the service contract.