getCookie method

Future<Cookie?> getCookie({
  1. required WebUri url,
  2. required String name,
  3. @Deprecated("Use webViewController instead") PlatformInAppWebViewController? iosBelow11WebViewController,
  4. PlatformInAppWebViewController? webViewController,
})

Gets a cookie by its name for the given url.

webViewController is used for getting the cookie (also session-only cookie) using JavaScript (cookie with isHttpOnly enabled cannot be found, see: https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies#restrict_access_to_cookies) from the current context of the WebView managed by that controller when you need to target iOS below 11, MacOS below 10.13 and Web platform. JavaScript must be enabled in order to work. In this case the url parameter is ignored.

NOTE for iOS below 11.0 and MacOS below 10.13: All the cookies returned this way will have all the properties to null except for Cookie.name and Cookie.value. If webViewController is null or JavaScript is disabled for it, it will try to use a PlatformHeadlessInAppWebView to get the cookie (session-only cookie and cookie with isHttpOnly enabled won't be found!).

NOTE for Web: this method will have effect only if the iframe has the same origin. If webViewController is null or JavaScript is disabled for it, it will try to use a PlatformHeadlessInAppWebView to get the cookie (session-only cookie and cookie with isHttpOnly enabled won't be found!).

Officially Supported Platforms/Implementations:

  • Android native WebView
  • iOS
  • MacOS
  • Web
  • Windows

Implementation

Future<Cookie?> getCookie(
    {required WebUri url,
    required String name,
    @Deprecated("Use webViewController instead")
    PlatformInAppWebViewController? iosBelow11WebViewController,
    PlatformInAppWebViewController? webViewController}) {
  throw UnimplementedError(
      'getCookie is not implemented on the current platform');
}