getCookie method

Future<Cookie?> getCookie({

required WebUri url,
required String name,
@Deprecated("Use webViewController instead") InAppWebViewController? iosBelow11WebViewController,
InAppWebViewController? webViewController,

})

Gets a cookie by its name for the given url.

Officially Supported Platforms/Implementations:

Android WebView (Official API - CookieManager.getCookie)
iOS WKWebView (Official API - WKHTTPCookieStore.getAllCookies):
- On iOS below 11.0, the 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. JavaScript must be enabled in order to work. In this case the url parameter is ignored. 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!).
macOS WKWebView (Official API - WKHTTPCookieStore.getAllCookies):
- On macOS below 10.13, the 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. JavaScript must be enabled in order to work. In this case the url parameter is ignored. 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!).
Web <iframe> but requires same origin:
- The 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. JavaScript must be enabled in order to work. In this case the url parameter is ignored. 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!).
Windows WebView2:
- The webViewController could be used to access cookies accessible only on the WebView managed by that controller, such as cookie with partition key.
Linux WPE WebKit (Official API - webkit_cookie_manager_get_cookies)

Parameters - Officially Supported Platforms/Implementations:

url: all platforms
name: all platforms
webViewController:
- macOS WKWebView
- iOS WKWebView
- Web <iframe> but requires same origin
- Windows WebView2

Use the PlatformCookieManager.isMethodSupported method to check if this method is supported at runtime.

Implementation

Future<Cookie?> getCookie({
  required WebUri url,
  required String name,
  @Deprecated("Use webViewController instead")
  InAppWebViewController? iosBelow11WebViewController,
  InAppWebViewController? webViewController,
}) => platform.getCookie(
  url: url,
  name: name,
  iosBelow11WebViewController: iosBelow11WebViewController?.platform,
  webViewController: webViewController?.platform,
);

getCookie method

Implementation

CookieManager class