launch function

Future<bool> launch (String urlString, { bool forceSafariVC, bool forceWebView, bool enableJavaScript, bool enableDomStorage, bool universalLinksOnly, Map<String, String> headers, Brightness statusBarBrightness })

Parses the specified URL string and delegates handling of it to the underlying platform.

The returned future completes with a PlatformException on invalid URLs and schemes which cannot be handled, that is when canLaunch would complete with false.

forceSafariVC is only used in iOS with iOS version >= 9.0. By default (when unset), the launcher opens web URLs in the Safari View Controller, anything else is opened using the default handler on the platform. If set to true, it opens the URL in the Safari View Controller. 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). This setting will nullify universalLinksOnly and will always launch a web content in the built-in Safari View Controller regardless if the url is a universal link or not.

universalLinksOnly is only used in iOS with iOS version >= 10.0. This setting is only validated when forceSafariVC is set to false. The default value of this setting is false. By default (when unset), the launcher will either launch the url in a browser (when the url is not a universal link), or launch the respective native app content (when the url is a universal link). When set to true, the launcher will only launch the content if the url is a universal link and the respective app for the universal link is installed on the user's device; otherwise throw a PlatformException.

forceWebView is an Android only setting. If null or false, the URL is always launched with the default browser on device. If set to true, the URL is launched in a WebView. Unlike iOS, browser context is shared across WebViews. enableJavaScript is an Android only setting. If true, WebView enable javascript. enableDomStorage is an Android only setting. If true, WebView enable DOM storage. headers is an Android only setting that adds headers to the WebView.

Note that if any of the above are set to true but the URL is not a web URL, this will throw a PlatformException.

statusBarBrightness Sets the status bar brightness of the application after opening a link on iOS. Does nothing if no value is passed. This does not handle resetting the previous status bar style.

Returns true if launch url is successful; false is only returned when universalLinksOnly is set to true and the universal link failed to launch.

Implementation

Future<bool> launch(
  String urlString, {
  bool forceSafariVC,
  bool forceWebView,
  bool enableJavaScript,
  bool enableDomStorage,
  bool universalLinksOnly,
  Map<String, String> headers,
  Brightness statusBarBrightness,
}) async {
  assert(urlString != null);
  final Uri url = Uri.parse(urlString.trimLeft());
  final bool isWebURL = url.scheme == 'http' || url.scheme == 'https';
  if ((forceSafariVC == true || forceWebView == true) && !isWebURL) {
    throw PlatformException(
        code: 'NOT_A_WEB_SCHEME',
        message: 'To use webview or safariVC, you need to pass'
            'in a web URL. This $urlString is not a web URL.');
  }
  bool previousAutomaticSystemUiAdjustment;
  if (statusBarBrightness != null &&
      defaultTargetPlatform == TargetPlatform.iOS) {
    previousAutomaticSystemUiAdjustment =
        WidgetsBinding.instance.renderView.automaticSystemUiAdjustment;
    WidgetsBinding.instance.renderView.automaticSystemUiAdjustment = false;
    SystemChrome.setSystemUIOverlayStyle(statusBarBrightness == Brightness.light
        ? SystemUiOverlayStyle.dark
        : SystemUiOverlayStyle.light);
  }
  final bool result = await _channel.invokeMethod<bool>(
    'launch',
    <String, Object>{
      'url': urlString,
      'useSafariVC': forceSafariVC ?? isWebURL,
      'useWebView': forceWebView ?? false,
      'enableJavaScript': enableJavaScript ?? false,
      'enableDomStorage': enableDomStorage ?? false,
      'universalLinksOnly': universalLinksOnly ?? false,
      'headers': headers ?? <String, String>{},
    },
  );
  if (statusBarBrightness != null) {
    WidgetsBinding.instance.renderView.automaticSystemUiAdjustment =
        previousAutomaticSystemUiAdjustment;
  }
  return result;
}