Document embedded Photo Picker APIs - #433
Conversation
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
|
@dalexsoto review |
1 similar comment
|
@dalexsoto review |
dalexsoto
left a comment
There was a problem hiding this comment.
The builder parameter docs omit constraints that the platform enforces with IllegalArgumentException: SetMaxSelectionLimit accepts 1–100, SetMimeTypes accepts only image/video MIME types, and SetThemeNightMode accepts only the managed equivalents of UNDEFINED, NO, and YES (not every UI_MODE_NIGHT_* constant). Please document these accepted domains.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
|
@dalexsoto Addressed the requested platform-enforced domains from the AOSP |
|
@dalexsoto review |
There was a problem hiding this comment.
Pull request overview
This PR replaces a subset of To be added. XML documentation placeholders in Android.Widget.PhotoPicker with source-backed descriptions for the embedded Photo Picker surface/session, client callbacks, provider factory creation, feature-info builder configuration, and Parcelable behavior.
Changes:
- Documented the embedded session
SurfacePackageproperty and clarified how callers attach it. - Filled in parameter/return documentation for embedded client callbacks and provider factory creation.
- Added documentation for
EmbeddedPhotoPickerFeatureInfo’sCREATOR,DescribeContents, andWriteToParcel, plus multipleEmbeddedPhotoPickerFeatureInfo.Builderconfiguration APIs.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/xml/Android.Widget.PhotoPicker/IEmbeddedPhotoPickerSession.xml | Documents the embedded session surface package returned to hosts. |
| docs/xml/Android.Widget.PhotoPicker/IEmbeddedPhotoPickerClient.xml | Adds parameter docs for session error/open and URI permission grant/revoke callbacks. |
| docs/xml/Android.Widget.PhotoPicker/EmbeddedPhotoPickerProviderFactory.xml | Documents provider creation parameter and return value. |
| docs/xml/Android.Widget.PhotoPicker/EmbeddedPhotoPickerFeatureInfo+Builder.xml | Documents builder configuration methods and build return value. |
| docs/xml/Android.Widget.PhotoPicker/EmbeddedPhotoPickerFeatureInfo.xml | Documents Parcelable creator and parceling-related methods. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| <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> |
dalexsoto
left a comment
There was a problem hiding this comment.
The platform-enforced builder input domains are now documented; no blocking issues remain.
Documents 44 source-backed placeholders for embedded Photo Picker builder configuration, Parcelable behavior, provider creation, callbacks, and session surface packages. The remaining 57 scoped placeholders are namespace, generated binding infrastructure, or undocumented platform getters without safe authoritative descriptions.
Sources
Validation
git diff --checkand confirmed the diff is limited to five files indocs/xml/Android.Widget.PhotoPicker/.To be added.placeholders from 101 to 57; the remaining entries have no safe authoritative coverage in the consulted Android reference and AOSP sources.Refs #215