Skip to content

Document Android.Views.ContentCaptures #434

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
Open

Document Android.Views.ContentCaptures #434

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
caed915
Document Android.Views.ContentCaptures
jonathanpeppers Aug 14, 2026
31d65b2
Correct ContentCaptures documentation
jonathanpeppers Aug 14, 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
15 changes: 11 additions & 4 deletions docs/xml/Android.Views.ContentCaptures/ContentCaptureConditionFlags.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,15 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Flags that control how a content capture condition matches a <c>LocusId</c>.</summary>
<remarks>
<para>Flags that control how a content capture condition matches a <c>LocusId</c>.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/view/contentcapture/ContentCaptureCondition#FLAG_IS_REGEX" title="Reference documentation">Java documentation for <code>ContentCaptureCondition.FLAG_IS_REGEX</code>.</a>
</format>
</para>
</remarks>
</Docs>
<Members>
<Member MemberName="FlagIsRegex">
Expand Down Expand Up @@ -46,7 +53,7 @@
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Interprets the condition's <c>LocusId</c> as a regular expression.</summary>
</Docs>
</Member>
<Member MemberName="None">
Expand All @@ -70,7 +77,7 @@
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Specifies no matching flags.</summary>
</Docs>
</Member>
</Members>
Expand Down
16 changes: 12 additions & 4 deletions docs/xml/Android.Views.ContentCaptures/ContentCaptureContext+Builder.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,10 +191,18 @@
<Parameter Name="extras" Type="Android.OS.Bundle" />
</Parameters>
<Docs>
<param name="extras">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="extras">Extra options associated with the context.</param>
<summary>Sets extra options associated with this context.</summary>
<returns>This builder.</returns>
<remarks>
<para>Sets extra options associated with this context. The options can provide vendor-specific data that can be modified and examined.</para>
<para>
Portions of this documentation are derived from the Android Open Source Project.
<format type="text/html">
<a href="https://android.googlesource.com/platform/frameworks/base/+/refs/heads/main/core/java/android/view/contentcapture/ContentCaptureContext.java" title="Android Open Source Project source">ContentCaptureContext.java</a>
</format>
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="ThresholdClass">
Expand Down
14 changes: 7 additions & 7 deletions docs/xml/Android.Views.ContentCaptures/ContentCaptureContext.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,9 @@
<ReturnType>Android.OS.IParcelableCreator</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Creates <c>ContentCaptureContext</c> instances from a <c>Parcel</c>.</summary>
<value>A factory for this parcelable type.</value>
<remarks>Required by the Android <c>Parcelable</c> contract.</remarks>
</Docs>
</Member>
<Member MemberName="DescribeContents">
Expand Down Expand Up @@ -148,7 +148,7 @@
</ReturnValue>
<Docs>
<summary>Gets the (optional) extras set by the app (through <c>Builder#setExtras(Bundle)</c>).</summary>
<value>To be added.</value>
<value>Optional extras provided by the app for this context.</value>
<remarks>
<para>Gets the (optional) extras set by the app (through <c>Builder#setExtras(Bundle)</c>).</para>
<para>It can be used to provide vendor-specific data that can be modified and examined.</para>
Expand Down Expand Up @@ -192,9 +192,9 @@
<Parameter Name="id" Type="System.String" />
</Parameters>
<Docs>
<param name="id">To be added.</param>
<param name="id">The identifier associated with the new context.</param>
<summary>Helper that creates a <c>ContentCaptureContext</c> associated with the given <c>id</c>.</summary>
<returns>To be added.</returns>
<returns>A context associated with <paramref name="id" />.</returns>
<remarks>
<para>Helper that creates a <c>ContentCaptureContext</c> associated with the given <c>id</c>.</para>
<para>
Expand Down Expand Up @@ -271,7 +271,7 @@
</ReturnValue>
<Docs>
<summary>Gets the context id.</summary>
<value>To be added.</value>
<value>The context identifier, or <see langword="null" /> when this context has no identifier.</value>
<remarks>
<para>Gets the context id.</para>
<para>
Expand Down
8 changes: 4 additions & 4 deletions docs/xml/Android.Views.ContentCaptures/ContentCaptureManager.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@
</ReturnValue>
<Docs>
<summary>Checks whether content capture is enabled for this activity. -or- Called by apps to explicitly enable or disable content capture.</summary>
<value>To be added.</value>
<value><see langword="true" /> when content capture is enabled for the activity; otherwise, <see langword="false" />.</value>
<remarks>
<para>Property getter documentation:</para>
<para>Checks whether content capture is enabled for this activity.</para>
Expand Down Expand Up @@ -528,7 +528,7 @@
<Docs>
<summary>Returns the component name of the system service that is consuming the captured events for
the current user.</summary>
<value>To be added.</value>
<value>The component name of the service consuming captured events for the current user.</value>
<remarks>
<para>Returns the component name of the system service that is consuming the captured events for
the current user.</para>
Expand Down Expand Up @@ -574,8 +574,8 @@
<Parameter Name="dataShareWriteAdapter" Type="Android.Views.ContentCaptures.IDataShareWriteAdapter" />
</Parameters>
<Docs>
<param name="executor">To be added.</param>
<param name="dataShareWriteAdapter">To be added.</param>
<param name="executor">The executor through which callback and listener events are dispatched.</param>
<param name="dataShareWriteAdapter">The adapter that writes the shared data.</param>
<param name="request">object specifying details of the data being shared.</param>
<summary>Called by the app to request data sharing via writing to a file.</summary>
<remarks>
Expand Down
14 changes: 7 additions & 7 deletions docs/xml/Android.Views.ContentCaptures/ContentCaptureSession.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Closes this session and relinquishes its underlying resources.</summary>
<remarks>
<para>
<format type="text/html">
Expand Down Expand Up @@ -208,7 +208,7 @@
</ReturnValue>
<Docs>
<summary>Gets the id used to identify this session.</summary>
<value>To be added.</value>
<value>The identifier used to identify this session.</value>
<remarks>
<para>Gets the id used to identify this session.</para>
<para>
Expand Down Expand Up @@ -251,9 +251,9 @@
<Parameter Name="context" Type="Android.Views.ContentCaptures.ContentCaptureContext" />
</Parameters>
<Docs>
<param name="context">To be added.</param>
<param name="context">The context associated with the new session.</param>
<summary>Creates a new <c>ContentCaptureSession</c>.</summary>
<returns>To be added.</returns>
<returns>A new content capture session.</returns>
<remarks>
<para>Creates a new <c>ContentCaptureSession</c>.</para>
<para>See <c>View#setContentCaptureSession(ContentCaptureSession)</c> for more info.</para>
Expand Down Expand Up @@ -477,9 +477,9 @@
<Parameter Name="view" Type="Android.Views.View" />
</Parameters>
<Docs>
<param name="view">To be added.</param>
<param name="view">The standard view for which to create a structure.</param>
<summary>Creates a <c>ViewStructure</c> for a "standard" view.</summary>
<returns>To be added.</returns>
<returns>A view structure for <paramref name="view" />.</returns>
<remarks>
<para>Creates a <c>ViewStructure</c> for a "standard" view.</para>
<para>This method should be called after a visible view is laid out; the view then must populate
Expand Down Expand Up @@ -776,7 +776,7 @@
<Parameter Name="viewInsets" Type="Android.Graphics.Insets" />
</Parameters>
<Docs>
<param name="viewInsets">To be added.</param>
<param name="viewInsets">The view's updated insets.</param>
<summary>Notifies the Intelligence Service that the insets of a view have changed.</summary>
<remarks>
<para>Notifies the Intelligence Service that the insets of a view have changed.</para>
Expand Down
30 changes: 22 additions & 8 deletions docs/xml/Android.Views.ContentCaptures/DataRemovalRequest+Builder.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,11 +102,18 @@
</Parameter>
</Parameters>
<Docs>
<param name="locusId">To be added.</param>
<param name="flags">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="locusId">The <c>LocusId</c> associated with the data to remove.</param>
<param name="flags">Either <see cref="F:Android.Views.ContentCaptures.DataRemovalRequestFlags.FlagIsPrefix" /> or <c>0</c>.</param>
<summary>Requests removal of data associated with a <c>LocusId</c>.</summary>
<returns>This builder.</returns>
<remarks>
<para>
Portions of this documentation are derived from the Android Open Source Project.
<format type="text/html">
<a href="https://android.googlesource.com/platform/frameworks/base/+/refs/heads/main/core/java/android/view/contentcapture/DataRemovalRequest.java" title="Android Open Source Project source">DataRemovalRequest.java</a>
</format>
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Build">
Expand Down Expand Up @@ -176,9 +183,16 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<summary>Requests removal of all content capture data associated with the app's package.</summary>
<returns>This builder.</returns>
<remarks>
<para>
Portions of this documentation are derived from the Android Open Source Project.
<format type="text/html">
<a href="https://android.googlesource.com/platform/frameworks/base/+/refs/heads/main/core/java/android/view/contentcapture/DataRemovalRequest.java" title="Android Open Source Project source">DataRemovalRequest.java</a>
</format>
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="JniPeerMembers">
Expand Down
2 changes: 1 addition & 1 deletion docs/xml/Android.Views.ContentCaptures/DataRemovalRequest+LocusIdRequest.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@
</ReturnValue>
<Docs>
<summary>Gets the <c>LocusId</c> per se.</summary>
<value>To be added.</value>
<value>The <c>LocusId</c> associated with this removal request.</value>
<remarks>
<para>Gets the <c>LocusId</c> per se.</para>
<para>
Expand Down
16 changes: 8 additions & 8 deletions docs/xml/Android.Views.ContentCaptures/DataRemovalRequest.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,9 @@
<ReturnType>Android.OS.IParcelableCreator</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Creates <c>DataRemovalRequest</c> instances from a <c>Parcel</c>.</summary>
<value>A factory for this parcelable type.</value>
<remarks>Required by the Android <c>Parcelable</c> contract.</remarks>
</Docs>
</Member>
<Member MemberName="DescribeContents">
Expand Down Expand Up @@ -196,7 +196,7 @@
</ReturnValue>
<Docs>
<summary>Checks if app is requesting to remove content capture data associated with its package.</summary>
<value>To be added.</value>
<value><see langword="true" /> when the request removes data for the app's package; otherwise, <see langword="false" />.</value>
<remarks>
<para>Checks if app is requesting to remove content capture data associated with its package.</para>
<para>
Expand Down Expand Up @@ -268,10 +268,10 @@
<ReturnType>System.Collections.Generic.IList&lt;Android.Views.ContentCaptures.DataRemovalRequest+LocusIdRequest&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the list of <c>LousId</c>s the apps is requesting to remove.</summary>
<value>To be added.</value>
<summary>Gets the list of <c>LocusId</c>s the app is requesting to remove.</summary>
<value>The requested <c>LocusId</c> values and their matching flags.</value>
<remarks>
<para>Gets the list of <c>LousId</c>s the apps is requesting to remove.</para>
<para>Gets the list of <c>LocusId</c>s the app is requesting to remove.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/view/contentcapture/DataRemovalRequest#getLocusIdRequests()" title="Reference documentation">Java documentation for <code>android.view.contentcapture.DataRemovalRequest.getLocusIdRequests()</code>.</a>
Expand Down Expand Up @@ -310,7 +310,7 @@
</ReturnValue>
<Docs>
<summary>Gets the name of the app that's making the request.</summary>
<value>To be added.</value>
<value>The name of the app making the request.</value>
<remarks>
<para>Gets the name of the app that's making the request.</para>
<para>
Expand Down
15 changes: 11 additions & 4 deletions docs/xml/Android.Views.ContentCaptures/DataRemovalRequestFlags.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,15 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Flags that control how a data-removal request matches a <c>LocusId</c>.</summary>
<remarks>
<para>Flags that control how a data-removal request matches a <c>LocusId</c>.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/view/contentcapture/DataRemovalRequest#FLAG_IS_PREFIX" title="Reference documentation">Java documentation for <code>DataRemovalRequest.FLAG_IS_PREFIX</code>.</a>
</format>
</para>
</remarks>
</Docs>
<Members>
<Member MemberName="FlagIsPrefix">
Expand Down Expand Up @@ -46,7 +53,7 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Matches data whose <c>LocusId</c> begins with the requested identifier.</summary>
</Docs>
</Member>
<Member MemberName="None">
Expand All @@ -70,7 +77,7 @@
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Specifies no matching flags.</summary>
</Docs>
</Member>
</Members>
Expand Down
16 changes: 8 additions & 8 deletions docs/xml/Android.Views.ContentCaptures/DataShareRequest.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,8 @@
<Parameter Name="mimeType" Type="System.String" />
</Parameters>
<Docs>
<param name="locusId">To be added.</param>
<param name="mimeType">To be added.</param>
<param name="locusId">An optional identifier for the data being shared.</param>
<param name="mimeType">The MIME type of the data being shared.</param>
<summary>Constructs a request to share data with the Content Capture Service.</summary>
<remarks>
<para>Constructs a request to share data with the Content Capture Service.</para>
Expand Down Expand Up @@ -129,9 +129,9 @@
<ReturnType>Android.OS.IParcelableCreator</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Creates <c>DataShareRequest</c> instances from a <c>Parcel</c>.</summary>
<value>A factory for this parcelable type.</value>
<remarks>Required by the Android <c>Parcelable</c> contract.</remarks>
</Docs>
</Member>
<Member MemberName="DescribeContents">
Expand Down Expand Up @@ -228,7 +228,7 @@
</ReturnValue>
<Docs>
<summary>Locus id helping to identify what data is being shared.</summary>
<value>To be added.</value>
<value>The identifier that helps identify the data being shared, or <see langword="null" /> when none was supplied.</value>
<remarks>
<para>Locus id helping to identify what data is being shared.</para>
<para>
Expand Down Expand Up @@ -269,7 +269,7 @@
</ReturnValue>
<Docs>
<summary>MIME type of the data being shared.</summary>
<value>To be added.</value>
<value>The MIME type of the data being shared.</value>
<remarks>
<para>MIME type of the data being shared.</para>
<para>
Expand Down Expand Up @@ -310,7 +310,7 @@
</ReturnValue>
<Docs>
<summary>Name of the package making the request.</summary>
<value>To be added.</value>
<value>The name of the package making the request.</value>
<remarks>
<para>Name of the package making the request.</para>
<para>
Expand Down