setCookie method

Future<bool> setCookie({

required WebUri url,
required String name,
required String value,
String path = "/",
String? domain,
int? expiresDate,
int? maxAge,
bool? isSecure,
bool? isHttpOnly,
HTTPCookieSameSitePolicy? sameSite,
@Deprecated("Use webViewController instead") InAppWebViewController? iosBelow11WebViewController,
InAppWebViewController? webViewController,

})

Sets a cookie for the given url. Any existing cookie with the same host, path and name will be replaced with the new cookie. The cookie being set will be ignored if it is expired.

The default value of path is "/".

The return value indicates whether the cookie was set successfully.

Officially Supported Platforms/Implementations:

Android WebView (Official API - CookieManager.setCookie)
iOS WKWebView (Official API - WKHTTPCookieStore.setCookie):
- On iOS below 11.0, the webViewController could be used if you need to set a session-only cookie using JavaScript (so isHttpOnly cannot be set, see: https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies#restrict_access_to_cookies) on the current URL of the WebView managed by that controller. JavaScript must be enabled in order to work. If webViewController is null or JavaScript is disabled for it, it will try to use a PlatformHeadlessInAppWebView to set the cookie (session-only cookie won't work! In that case, you should set also expiresDate or maxAge). In this case, this method will return always true.
macOS WKWebView (Official API - WKHTTPCookieStore.setCookie):
- On macOS below 10.13, the webViewController could be used if you need to set a session-only cookie using JavaScript (so isHttpOnly cannot be set, see: https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies#restrict_access_to_cookies) on the current URL of the WebView managed by that controller. JavaScript must be enabled in order to work. If webViewController is null or JavaScript is disabled for it, it will try to use a PlatformHeadlessInAppWebView to set the cookie (session-only cookie won't work! In that case, you should set also expiresDate or maxAge). In this case, this method will return always true.
Web <iframe> but requires same origin:
- The webViewController could be used if you need to set a session-only cookie using JavaScript (so isHttpOnly cannot be set, see: https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies#restrict_access_to_cookies) on the current URL of the WebView managed by that controller. JavaScript must be enabled in order to work. If webViewController is null or JavaScript is disabled for it, it will try to use a PlatformHeadlessInAppWebView to set the cookie (session-only cookie won't work! In that case, you should set also expiresDate or maxAge). In this case, this method will return always true.
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_add_cookie)

Parameters - Officially Supported Platforms/Implementations:

url: all platforms
name: all platforms
value: all platforms
path: all platforms
domain: all platforms
expiresDate: all platforms
maxAge: all platforms
isSecure: all platforms
isHttpOnly: all platforms
sameSite: 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<bool> setCookie({
  required WebUri url,
  required String name,
  required String value,
  String path = "/",
  String? domain,
  int? expiresDate,
  int? maxAge,
  bool? isSecure,
  bool? isHttpOnly,
  HTTPCookieSameSitePolicy? sameSite,
  @Deprecated("Use webViewController instead")
  InAppWebViewController? iosBelow11WebViewController,
  InAppWebViewController? webViewController,
}) => platform.setCookie(
  url: url,
  name: name,
  value: value,
  path: path,
  domain: domain,
  expiresDate: expiresDate,
  maxAge: maxAge,
  isSecure: isSecure,
  isHttpOnly: isHttpOnly,
  sameSite: sameSite,
  iosBelow11WebViewController: iosBelow11WebViewController?.platform,
  webViewController: webViewController?.platform,
);

setCookie method

Implementation

CookieManager class