Skip to content

Document Android.Window APIs #554

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

Merged
jonathanpeppers merged 5 commits into from
Aug 16, 2026
Merged

Document Android.Window APIs #554

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
63042b1
Document Android.Window APIs
jonathanpeppers Aug 15, 2026
9771018
Restrict Android.Window docs to source-backed APIs
jonathanpeppers Aug 15, 2026
4a826d9
Correct Android.Window callback docs
jonathanpeppers Aug 16, 2026
1f4d7b1
Correct Android.Window contract docs
jonathanpeppers Aug 16, 2026
49c3ede
Clarify Android.Window completion contracts
jonathanpeppers Aug 16, 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
10 changes: 5 additions & 5 deletions docs/xml/Android.Window/InputTransferToken.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,8 +123,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Describes the special objects in this token's marshaled representation.</summary>
<returns>A bitmask of special object types in the marshaled representation.</returns>
<remarks>
<para>
<format type="text/html">
Expand Down Expand Up @@ -267,9 +267,9 @@
</Parameter>
</Parameters>
<Docs>
<param name="dest">To be added.</param>
<param name="flags">To be added.</param>
<summary>To be added.</summary>
<param name="dest">The parcel that receives the token.</param>
<param name="flags">Additional flags describing how the token is written.</param>
<summary>Flattens this token into a parcel.</summary>
<remarks>
<para>
<format type="text/html">
Expand Down
8 changes: 4 additions & 4 deletions docs/xml/Android.Window/SplashScreenStyle.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Specifies the visual style of a launched activity's splash screen.</summary>
<remarks>Use these values with the splash screen style APIs on <c>ActivityOptions</c>.</remarks>
</Docs>
<Members>
<Member MemberName="Icon">
Expand Down Expand Up @@ -40,7 +40,7 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Shows the launched activity's splash screen icon.</summary>
</Docs>
</Member>
<Member MemberName="SolidColor">
Expand Down Expand Up @@ -68,7 +68,7 @@
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Uses a solid-color splash screen without showing the launched activity's icon.</summary>
</Docs>
</Member>
</Members>
Expand Down
6 changes: 3 additions & 3 deletions docs/xml/Android.Window/SplashScreenView.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@
</ReturnValue>
<Docs>
<summary>Returns the duration of the icon animation if icon is animatable.</summary>
<value>To be added.</value>
<value>The icon animation duration, or <see langword="null" /> or a non-null zero duration when the icon is not animatable.</value>
<remarks>
<para>Returns the duration of the icon animation if icon is animatable.

Expand Down Expand Up @@ -122,7 +122,7 @@
</ReturnValue>
<Docs>
<summary>If the replaced icon is animatable, return the animation start time based on system clock.</summary>
<value>To be added.</value>
<value>The icon animation start time, or <see langword="null" /> when no animatable icon is available.</value>
<remarks>
<para>If the replaced icon is animatable, return the animation start time based on system clock.</para>
<para>
Expand Down Expand Up @@ -163,7 +163,7 @@
</ReturnValue>
<Docs>
<summary>Get the view containing the Splash Screen icon and its background.</summary>
<value>To be added.</value>
<value>The view containing the splash screen icon and its background, or <see langword="null" /> when no icon view exists.</value>
<remarks>
<para>Get the view containing the Splash Screen icon and its background.</para>
<para>
Expand Down
33 changes: 19 additions & 14 deletions docs/xml/Android.Window/SurfaceSyncGroup.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,12 +120,9 @@
<Docs>
<param name="attachedSurfaceControl">The AttachedSurfaceControl that will be add to this
SurfaceSyncGroup.</param>
<param name="runnable">This is run on the same thread that the call was made on, but
after the rendering is paused and before continuing to render
the next frame. This method will not return until the
execution of the runnable completes. This can be used to make
changes to the AttachedSurfaceControl, ensuring that the
changes are included in the sync.</param>
<param name="runnable">Runs synchronously on the calling thread after rendering is paused
and before the next frame is rendered. This method blocks until the runnable completes.
Use it to make changes to the AttachedSurfaceControl that are included in the sync.</param>
<summary>Add an AttachedSurfaceControl to the SurfaceSyncGroup.</summary>
<returns>true if the AttachedSurfaceControl was successfully added to the SurfaceSyncGroup,
false otherwise.</returns>
Expand Down Expand Up @@ -181,11 +178,14 @@
</Parameter>
</Parameters>
<Docs>
<param name="surfacePackage">To be added.</param>
<param name="runnable">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="surfacePackage">The surface package to add to this synchronization group.</param>
<param name="runnable">An optional operation that runs synchronously on the calling thread
after rendering is paused and before the next frame is rendered. This method blocks
until the operation completes, allowing its changes to the hosted surface to be
included in the sync.</param>
<summary>Adds a surface package to this synchronization group.</summary>
<returns><see langword="true" /> if the surface package was added; otherwise, <see langword="false" />.</returns>
<remarks>Rendering is paused while the optional operation executes so its changes can be included in the synchronized frame.</remarks>
</Docs>
</Member>
<Member MemberName="AddTransaction">
Expand Down Expand Up @@ -215,9 +215,14 @@
<Parameter Name="transaction" Type="Android.Views.SurfaceControl+Transaction" />
</Parameters>
<Docs>
<param name="transaction">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="transaction">The transaction to synchronize with the group's other
transactions while the group is active. If the group has completed, the transaction
is applied immediately.</param>
<summary>Adds a transaction to an active synchronization group; applies it immediately
when the group has completed.</summary>
<remarks>The transaction is synchronized with the group's other transactions only while
the group is active. Once the group has completed, Android applies the transaction
immediately.</remarks>
</Docs>
</Member>
<Member MemberName="JniPeerMembers">
Expand Down
9 changes: 5 additions & 4 deletions docs/xml/Android.Window/SystemOnBackInvokedCallbacks.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,10 @@
</Parameters>
<Docs>
<param name="activity">The associated <c>Activity</c></param>
<summary>Get a callback to triggers <c>Activity#finishAndRemoveTask()</c> on the associated
<c>Activity</c>.</summary>
<returns>To be added.</returns>
<summary>Get a callback that finishes the associated <c>Activity</c>, removing its task from
Recents when the activity is the task root.</summary>
<returns>A callback that finishes the activity when back is invoked and removes its task from
Recents only when the activity is the task root.</returns>
<remarks>
<para>Get a callback to triggers <c>Activity#finishAndRemoveTask()</c> on the associated
<c>Activity</c>. If the activity is the root activity of its task, the entire task
Expand Down Expand Up @@ -161,7 +162,7 @@
<param name="activity">The associated <c>Activity</c></param>
<summary>Get a callback to triggers <c>Activity#moveTaskToBack(boolean)</c> on the associated
<c>Activity</c>, moving the task containing the activity to the background.</summary>
<returns>To be added.</returns>
<returns>A callback that moves the activity's task to the background when back is invoked.</returns>
<remarks>
<para>Get a callback to triggers <c>Activity#moveTaskToBack(boolean)</c> on the associated
<c>Activity</c>, moving the task containing the activity to the background. The system
Expand Down
36 changes: 18 additions & 18 deletions docs/xml/Android.Window/TrustedPresentationThresholds.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,14 +85,14 @@
<Parameter Name="stabilityRequirementMs" Type="System.Int32" />
</Parameters>
<Docs>
<param name="minAlpha">The min alpha the Window is required to
have to be considered inside the
threshold.</param>
<param name="minFractionRendered">The min fraction of the Window that was presented
to the user to be considered
inside the threshold.</param>
<param name="stabilityRequirementMs">The time in milliseconds required for the
Window to be in the threshold.</param>
<param name="minAlpha">The minimum alpha the Window must have to be considered inside the
threshold. Must be greater than 0.0 and no greater than 1.0.</param>
<param name="minFractionRendered">The minimum fraction of the Window presented to the
user to be considered inside the threshold. Must be greater than 0.0 and no greater
than 1.0.</param>
<param name="stabilityRequirementMs">The time in milliseconds required for the Window to
be in the threshold. Must be at least 1 millisecond; zero or negative values cause
this constructor to throw <c>IllegalArgumentException</c>.</param>
<summary>Creates a new TrustedPresentationThresholds.</summary>
<remarks>
<para>Creates a new TrustedPresentationThresholds.</para>
Expand Down Expand Up @@ -166,9 +166,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<summary>Describes the special objects in this threshold object's marshaled representation.</summary>
<returns>A bitmask of special object types in the marshaled representation.</returns>
<remarks>The bitmask indicates whether the parcel representation contains special objects such as file descriptors.</remarks>
</Docs>
</Member>
<Member MemberName="JniPeerMembers">
Expand Down Expand Up @@ -229,7 +229,7 @@
<Docs>
<summary>The min alpha the Window is required to have to be considered inside the
threshold.</summary>
<value>To be added.</value>
<value>A value greater than 0.0 and no greater than 1.0.</value>
<remarks>
<para>The min alpha the Window is required to have to be considered inside the
threshold.</para>
Expand Down Expand Up @@ -272,7 +272,7 @@
<Docs>
<summary>The min fraction of the Window that was presented to the user to be considered
inside the threshold.</summary>
<value>To be added.</value>
<value>A value greater than 0.0 and no greater than 1.0.</value>
<remarks>
<para>The min fraction of the Window that was presented to the user to be considered
inside the threshold.</para>
Expand Down Expand Up @@ -314,7 +314,7 @@
</ReturnValue>
<Docs>
<summary>The time in milliseconds required for the Window to be in the threshold.</summary>
<value>To be added.</value>
<value>A value of at least 1 millisecond.</value>
<remarks>
<para>The time in milliseconds required for the Window to be in the threshold.</para>
<para>
Expand Down Expand Up @@ -426,10 +426,10 @@
</Parameter>
</Parameters>
<Docs>
<param name="dest">To be added.</param>
<param name="flags">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="dest">The parcel that receives the threshold values.</param>
<param name="flags">Additional flags describing how the threshold values are written.</param>
<summary>Flattens these threshold values into a parcel.</summary>
<remarks>The parcel representation can be used to transfer threshold values across process boundaries.</remarks>
</Docs>
</Member>
</Members>
Expand Down
4 changes: 2 additions & 2 deletions docs/xml/ns-Android.Window.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<Namespace Name="Android.Window">
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Provides APIs for predictive back navigation, splash screens, surface synchronization, input transfer, and trusted presentation thresholds.</summary>
<remarks>These APIs support Android window behavior that is coordinated with the system.</remarks>
</Docs>
</Namespace>