Skip to content

Document embedded Photo Picker APIs #433

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 2 commits into from
Aug 15, 2026
+34 −44
Merged

Document embedded Photo Picker APIs #433

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
e4ff1c9
Document embedded Photo Picker APIs
jonathanpeppers Aug 14, 2026
fc031d0
Clarify Photo Picker builder constraints
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
44 changes: 19 additions & 25 deletions docs/xml/Android.Widget.PhotoPicker/EmbeddedPhotoPickerFeatureInfo+Builder.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@
<Parameters />
<Docs>
<summary>Build the class for desired feature info arguments</summary>
<returns>To be added.</returns>
<returns>An <c>EmbeddedPhotoPickerFeatureInfo</c> with the configured feature arguments.</returns>
<remarks>
<para>Build the class for desired feature info arguments</para>
<para>
Expand Down Expand Up @@ -153,10 +153,9 @@
<Parameter Name="accentColor" Type="System.Int64" />
</Parameters>
<Docs>
<param name="accentColor">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="accentColor">The desired accent color. By default, primary element colors follow the device theme.</param>
<summary>Sets the accent color used by primary picker elements, such as the Done button, selected media icons, and tabs.</summary>
<returns>This builder.</returns>
</Docs>
</Member>
<Member MemberName="SetMaxSelectionLimit">
Expand Down Expand Up @@ -186,10 +185,9 @@
<Parameter Name="maxSelectionLimit" Type="System.Int32" />
</Parameters>
<Docs>
<param name="maxSelectionLimit">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="maxSelectionLimit">The maximum selection count, from <c>1</c> through <c>100</c>. Pass <c>1</c> to open the picker in single-select mode.</param>
<summary>Sets the maximum number of items the user can select.</summary>
<returns>This builder.</returns>
</Docs>
</Member>
<Member MemberName="SetMimeTypes">
Expand Down Expand Up @@ -219,10 +217,9 @@
<Parameter Name="mimeTypes" Type="System.Collections.Generic.IList&lt;System.String&gt;" />
</Parameters>
<Docs>
<param name="mimeTypes">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="mimeTypes">The image or video MIME types to filter. Values can be concrete types, such as <c>image/png</c>, or partial types, such as <c>image/*</c> or <c>video/*</c>.</param>
<summary>Sets the MIME types used to filter media items.</summary>
<returns>This builder.</returns>
</Docs>
</Member>
<Member MemberName="SetOrderedSelection">
Expand Down Expand Up @@ -252,10 +249,9 @@
<Parameter Name="orderedSelection" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="orderedSelection">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="orderedSelection"><c>true</c> to preserve the user's selection order; the default is <c>false</c>.</param>
<summary>Sets whether selected media items are presented in the order in which the user selected them.</summary>
<returns>This builder.</returns>
</Docs>
</Member>
<Member MemberName="SetPreSelectedUris">
Expand Down Expand Up @@ -285,10 +281,9 @@
<Parameter Name="preSelectedUris" Type="System.Collections.Generic.IList&lt;Android.Net.Uri&gt;" />
</Parameters>
<Docs>
<param name="preSelectedUris">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="preSelectedUris">The URIs to preselect when the embedded picker opens.</param>
<summary>Sets the media item URIs that are preselected when the embedded picker opens.</summary>
<returns>This builder.</returns>
</Docs>
</Member>
<Member MemberName="SetThemeNightMode">
Expand Down Expand Up @@ -318,10 +313,9 @@
<Parameter Name="themeNightMode" Type="System.Int32" />
</Parameters>
<Docs>
<param name="themeNightMode">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="themeNightMode">One of <c>Configuration.UiModeNightUndefined</c>, <c>Configuration.UiModeNightNo</c>, or <c>Configuration.UiModeNightYes</c>. The default, <c>Configuration.UiModeNightUndefined</c>, uses the system theme.</param>
<summary>Sets the embedded picker theme to light or dark independently of the device theme.</summary>
<returns>This builder.</returns>
</Docs>
</Member>
<Member MemberName="ThresholdClass">
Expand Down
17 changes: 7 additions & 10 deletions docs/xml/Android.Widget.PhotoPicker/EmbeddedPhotoPickerFeatureInfo.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,9 +121,8 @@
<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>EmbeddedPhotoPickerFeatureInfo</c> instances from a <c>Parcel</c>.</summary>
<value>A <c>Parcelable.Creator</c> for <c>EmbeddedPhotoPickerFeatureInfo</c>.</value>
</Docs>
</Member>
<Member MemberName="DescribeContents">
Expand Down Expand Up @@ -154,9 +153,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<summary>Describes the special objects contained in this parcelable's marshaled representation.</summary>
<returns>A bitmask of the special object types in the marshaled representation, or <c>0</c>.</returns>
</Docs>
</Member>
<Member MemberName="IsOrderedSelection">
Expand Down Expand Up @@ -432,10 +430,9 @@
</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 <c>Parcel</c> in which to write this object.</param>
<param name="flags">Additional flags controlling how to write this object.</param>
<summary>Flattens this object into a <c>Parcel</c>.</summary>
</Docs>
</Member>
</Members>
Expand Down
4 changes: 2 additions & 2 deletions docs/xml/Android.Widget.PhotoPicker/EmbeddedPhotoPickerProviderFactory.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,9 +95,9 @@
<Parameter Name="context" Type="Android.Content.Context" />
</Parameters>
<Docs>
<param name="context">To be added.</param>
<param name="context">The context used to create the provider.</param>
<summary>Returns an implementation of <c>EmbeddedPhotoPickerProvider</c> class.</summary>
<returns>To be added.</returns>
<returns>An <c>EmbeddedPhotoPickerProvider</c> implementation.</returns>
<remarks>
<para>Returns an implementation of <c>EmbeddedPhotoPickerProvider</c> class.</para>
<para>
Expand Down
8 changes: 4 additions & 4 deletions docs/xml/Android.Widget.PhotoPicker/IEmbeddedPhotoPickerClient.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@
<Parameter Name="cause" Type="Java.Lang.Throwable" />
</Parameters>
<Docs>
<param name="cause">To be added.</param>
<param name="cause">The non-null error that terminated the session.</param>
<summary>Reports that terminal error has occurred in the session.</summary>
<remarks>
<para>Reports that terminal error has occurred in the session. Any further events
Expand Down Expand Up @@ -167,7 +167,7 @@
<Parameter Name="session" Type="Android.Widget.PhotoPicker.IEmbeddedPhotoPickerSession" />
</Parameters>
<Docs>
<param name="session">To be added.</param>
<param name="session">The non-null session established with the embedded Photo Picker.</param>
<summary>Reports that session of app with photopicker was established successfully.</summary>
<remarks>
<para>Reports that session of app with photopicker was established successfully.
Expand Down Expand Up @@ -213,7 +213,7 @@
<Parameter Name="uris" Type="System.Collections.Generic.IList&lt;Android.Net.Uri&gt;" />
</Parameters>
<Docs>
<param name="uris">To be added.</param>
<param name="uris">The non-null URI list for which permission was granted.</param>
<summary>Reports that URI permission has been granted to the item selected by the user.</summary>
<remarks>
<para>Reports that URI permission has been granted to the item selected by the user.</para>
Expand Down Expand Up @@ -261,7 +261,7 @@
<Parameter Name="uris" Type="System.Collections.Generic.IList&lt;Android.Net.Uri&gt;" />
</Parameters>
<Docs>
<param name="uris">To be added.</param>
<param name="uris">The non-null URI list for which permission was revoked.</param>
<summary>Reports that URI permission has been revoked of the item deselected by the
user.</summary>
<remarks>
Expand Down
5 changes: 2 additions & 3 deletions docs/xml/Android.Widget.PhotoPicker/IEmbeddedPhotoPickerSession.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -349,9 +349,8 @@
<ReturnType>Android.Views.SurfaceControlViewHost+SurfacePackage</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Returns the <c>SurfaceControlViewHost.SurfacePackage</c> containing the embedded picker view.</summary>
<value>A surface package callers can attach to their view hierarchy using <c>SurfaceView.setChildSurfacePackage</c>.</value>
Comment on lines +352 to +353
</Docs>
</Member>
</Members>
Expand Down