Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

Update dart doc for forceSafariVC for the usage of universal links on iOS #1058

Merged
merged 2 commits into from
Jan 10, 2019

Conversation

cyanglaz
Copy link
Contributor

There are numbers of users having problem on launch universal links on iOS.

It is most likely due to the unawareness of forceSafariVC is true by default and safariVC will not handle universal links.

Adding document to explain this particular usage.

@@ -20,9 +20,10 @@ const MethodChannel _channel = MethodChannel('plugins.flutter.io/url_launcher');
/// [forceSafariVC] is only used in iOS. If unset, the launcher opens web URLs
/// in the safari VC, anything else is opened using the default handler on the
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While you're here, consider replacing safari VC with Safari view controller.

@@ -20,9 +20,10 @@ const MethodChannel _channel = MethodChannel('plugins.flutter.io/url_launcher');
/// [forceSafariVC] is only used in iOS. If unset, the launcher opens web URLs
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To make it a tiny bit more obvious, maybe: By default (when unset), the launcher opens HTTP/HTTPS URLs...

/// If false, the URL is opened in the default browser of the phone. Note that
/// to work with universal links on iOS, this must be set to false to let
/// the platform's system handle the URL. Set this to false if you want to
/// use the cookies/context of the main browser of the app(such as SSO flows).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a space between app and (such as SSO flows).

Copy link
Member

@cbracken cbracken left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM modulo a couple minor nitpicks.

@cyanglaz cyanglaz merged commit 74ef787 into flutter:master Jan 10, 2019
@cyanglaz cyanglaz deleted the url_launcher_document branch January 11, 2019 01:49
andreidiaconu pushed a commit to andreidiaconu/plugins that referenced this pull request Feb 17, 2019
… iOS (flutter#1058)

Update dart document to explain forceSafariVC flag regarding universal link on IOS

There are numbers of users having problem on launch universal links on iOS.
It is most likely due to the unawareness of forceSafariVC is true by default and safariVC will not handle universal links.
andreidiaconu added a commit to andreidiaconu/plugins that referenced this pull request Feb 17, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
3 participants