[url_launcher] Improved documentation of the headers
parameter.
#3097
Conversation
Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). 📝 Please visit https://cla.developers.google.com/ to sign. Once you've signed (or fixed any issues), please reply here with What to do if you already signed the CLAIndividual signers
Corporate signers
ℹ️ Googlers: Go here for more info. |
@googlebot I signed it! |
CLAs look good, thanks! ℹ️ Googlers: Go here for more info. |
501e509
to
a25dbba
Compare
@@ -44,6 +44,9 @@ import 'package:url_launcher_platform_interface/url_launcher_platform_interface. | |||
/// [enableDomStorage] is an Android only setting. If true, WebView enable | |||
/// DOM storage. | |||
/// [headers] is an Android only setting that adds headers to the WebView. | |||
/// Adding headers without using a WebView is not fully supported. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that a reader of this comment is looking to understand whether and under what circumstances he can use this. Maybe something like:
When not using a WebView, the header information is passed to the browser, some Android browsers do not support the [Browser.EXTRA_HEADERS](https://developer.android.com/reference/android/provider/Browser#EXTRA_HEADERS) intent extra and will lose the header information.
a25dbba
to
a432894
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
…utter#3097) Added a clear documentation of the fact that the headers parameter at the launch method is not fully supported by all external browsers.
Description
Added a clear documentation of the fact that the
headers
parameter at thelaunch
method is not fully supported when using an external browser.Related Issues
Issue 61332.
Checklist
Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes (
[x]
). This will ensure a smooth and quick review process.///
).flutter analyze
) does not report any problems on my PR.Breaking Change
Does your PR require plugin users to manually update their apps to accommodate your change?