Skip to content

Document Settings Preferences result types #578

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jonathanpeppers wants to merge 2 commits into
base: main
Choose a base branch
from
+97 −42
Open

Document Settings Preferences result types #578

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8965eac
Document settings preference result types
jonathanpeppers Aug 15, 2026
c121a2d
Address settings preference docs review
jonathanpeppers Aug 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 20 additions & 9 deletions docs/xml/Android.Service.Settings.Preferences/GetValueResultType.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,19 @@
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Specifies the result code returned for a preference value request.</summary>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/service/settings/preferences/GetValueResult" title="Reference documentation">Java documentation for <code>android.service.settings.preferences.GetValueResult</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
<Members>
<Member MemberName="Disallow">
Expand Down Expand Up @@ -40,7 +51,7 @@
</ReturnValue>
<MemberValue>4</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The requested preference is not allowed under the current device policy. Retrying may succeed if conditions change.</summary>
</Docs>
</Member>
<Member MemberName="InternalError">
Expand Down Expand Up @@ -68,7 +79,7 @@
</ReturnValue>
<MemberValue>6</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The API call failed because of a service binding issue. Retrying may succeed.</summary>
</Docs>
</Member>
<Member MemberName="InvalidRequest">
Expand Down Expand Up @@ -96,7 +107,7 @@
</ReturnValue>
<MemberValue>5</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The request object is not valid. Retrying with the current parameters is not advised.</summary>
</Docs>
</Member>
<Member MemberName="Ok">
Expand Down Expand Up @@ -124,7 +135,7 @@
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The request succeeded.</summary>
</Docs>
</Member>
<Member MemberName="RequireAppPermission">
Expand Down Expand Up @@ -152,7 +163,7 @@
</ReturnValue>
<MemberValue>3</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The calling application lacks permissions required by the requested preference. Retrying may succeed after obtaining them.</summary>
</Docs>
</Member>
<Member MemberName="Unavailable">
Expand Down Expand Up @@ -180,7 +191,7 @@
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The preference is currently unavailable, likely because of device state or a dependency. Retrying may succeed if conditions change.</summary>
</Docs>
</Member>
<Member MemberName="Unsupported">
Expand Down Expand Up @@ -208,7 +219,7 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The requested preference is not supported by this API. Retrying is not advised.</summary>
</Docs>
</Member>
</Members>
Expand Down
21 changes: 16 additions & 5 deletions docs/xml/Android.Service.Settings.Preferences/MetadataResultType.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,19 @@
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Specifies the result code returned for a preference metadata request.</summary>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/service/settings/preferences/MetadataResult" title="Reference documentation">Java documentation for <code>android.service.settings.preferences.MetadataResult</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
<Members>
<Member MemberName="InternalError">
Expand Down Expand Up @@ -40,7 +51,7 @@
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The API call failed because of a service binding issue. Retrying may succeed.</summary>
</Docs>
</Member>
<Member MemberName="Ok">
Expand Down Expand Up @@ -68,7 +79,7 @@
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The request succeeded.</summary>
</Docs>
</Member>
<Member MemberName="Unsupported">
Expand Down Expand Up @@ -96,7 +107,7 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>No preferences in the application support this API. Retrying is not advised.</summary>
</Docs>
</Member>
</Members>
Expand Down
35 changes: 23 additions & 12 deletions docs/xml/Android.Service.Settings.Preferences/SetValueResultType.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,19 @@
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Specifies the result code returned when setting a preference value.</summary>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/service/settings/preferences/SetValueResult" title="Reference documentation">Java documentation for <code>android.service.settings.preferences.SetValueResult</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
<Members>
<Member MemberName="Disabled">
Expand Down Expand Up @@ -40,7 +51,7 @@
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The requested preference is disabled and cannot be set in its current state. Retrying may succeed if conditions change.</summary>
</Docs>
</Member>
<Member MemberName="Disallow">
Expand Down Expand Up @@ -68,7 +79,7 @@
</ReturnValue>
<MemberValue>7</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The requested preference is not allowed under the current device policy. Retrying may succeed if conditions change.</summary>
</Docs>
</Member>
<Member MemberName="InternalError">
Expand Down Expand Up @@ -96,7 +107,7 @@
</ReturnValue>
<MemberValue>9</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The API call failed because of a service binding issue. Retrying may succeed.</summary>
</Docs>
</Member>
<Member MemberName="InvalidRequest">
Expand Down Expand Up @@ -124,7 +135,7 @@
</ReturnValue>
<MemberValue>8</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The request object is not valid. Retrying with the current parameters is not advised.</summary>
</Docs>
</Member>
<Member MemberName="Ok">
Expand Down Expand Up @@ -152,7 +163,7 @@
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The request succeeded and the value was set.</summary>
</Docs>
</Member>
<Member MemberName="RequireAppPermission">
Expand Down Expand Up @@ -180,7 +191,7 @@
</ReturnValue>
<MemberValue>5</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The calling application lacks permissions required by the requested preference. Retrying may succeed after obtaining them.</summary>
</Docs>
</Member>
<Member MemberName="RequireUserConsent">
Expand Down Expand Up @@ -208,7 +219,7 @@
</ReturnValue>
<MemberValue>6</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>User consent was not approved for this operation. Retrying may succeed after consent is provided.</summary>
</Docs>
</Member>
<Member MemberName="Restricted">
Expand Down Expand Up @@ -236,7 +247,7 @@
</ReturnValue>
<MemberValue>3</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The requested preference is restricted and cannot be set under the current policy. Retrying may succeed if conditions change.</summary>
</Docs>
</Member>
<Member MemberName="Unavailable">
Expand Down Expand Up @@ -264,7 +275,7 @@
</ReturnValue>
<MemberValue>4</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The preference is currently unavailable, likely because of device state or a dependency. Retrying may succeed if conditions change.</summary>
</Docs>
</Member>
<Member MemberName="Unsupported">
Expand Down Expand Up @@ -292,7 +303,7 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The requested preference is not supported by this API. Retrying is not advised.</summary>
</Docs>
</Member>
</Members>
Expand Down
23 changes: 17 additions & 6 deletions docs/xml/Android.Service.Settings.Preferences/SettingsPreferenceMetadataType.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,19 @@
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Specifies the write sensitivity of a Settings preference.</summary>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceMetadata" title="Reference documentation">Java documentation for <code>android.service.settings.preferences.SettingsPreferenceMetadata</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
<Members>
<Member MemberName="DeeplinkOnly">
Expand Down Expand Up @@ -40,7 +51,7 @@
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The preference is write-sensitive and must be opened through its deeplink rather than changed through this API.</summary>
</Docs>
</Member>
<Member MemberName="ExpectPostConfirmation">
Expand Down Expand Up @@ -68,7 +79,7 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The preference is mildly write-sensitive; after changing it, the user should be offered a chance to revert it.</summary>
</Docs>
</Member>
<Member MemberName="NoDirectAccess">
Expand Down Expand Up @@ -96,7 +107,7 @@
</ReturnValue>
<MemberValue>3</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The preference is highly write-sensitive and cannot be changed or opened through a direct deeplink with this API.</summary>
</Docs>
</Member>
<Member MemberName="NoSensitivity">
Expand Down Expand Up @@ -124,7 +135,7 @@
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The preference is not write-sensitive and can be written without explicit consent when required permissions are granted.</summary>
</Docs>
</Member>
</Members>
Expand Down
6 changes: 3 additions & 3 deletions docs/xml/Android.Service.Settings.Preferences/SettingsPreferenceService.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,9 +225,9 @@
</Parameter>
</Parameters>
<Docs>
<param name="intent">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="intent">The intent used to bind to the service. Extras included when binding are not available here.</param>
<summary>Returns the communication channel for the service, or <see langword="null"/> if clients cannot bind.</summary>
<returns>The <c>IBinder</c> that clients use to communicate with the service, or <see langword="null"/> if clients cannot bind.</returns>
<remarks>
<para>
<format type="text/html">
Expand Down
25 changes: 18 additions & 7 deletions docs/xml/Android.Service.Settings.Preferences/SettingsPreferenceValueType.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,19 @@
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Specifies the data type of a Settings preference value.</summary>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/service/settings/preferences/SettingsPreferenceValue" title="Reference documentation">Java documentation for <code>android.service.settings.preferences.SettingsPreferenceValue</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
<Members>
<Member MemberName="Boolean">
Expand Down Expand Up @@ -40,7 +51,7 @@
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The value is a Boolean. Access it through the <c>BooleanValue</c> property.</summary>
</Docs>
</Member>
<Member MemberName="Double">
Expand Down Expand Up @@ -68,7 +79,7 @@
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The value is a double. Access it through the <c>DoubleValue</c> property.</summary>
</Docs>
</Member>
<Member MemberName="Int">
Expand Down Expand Up @@ -96,7 +107,7 @@
</ReturnValue>
<MemberValue>4</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The value is an integer. Access it through the <c>IntValue</c> property.</summary>
</Docs>
</Member>
<Member MemberName="Long">
Expand Down Expand Up @@ -124,7 +135,7 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The value is a long integer. Access it through the <c>LongValue</c> property.</summary>
</Docs>
</Member>
<Member MemberName="String">
Expand Down Expand Up @@ -152,7 +163,7 @@
</ReturnValue>
<MemberValue>3</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The value is a string. Access it through the <c>StringValue</c> property.</summary>
</Docs>
</Member>
</Members>
Expand Down