deleteCookies method

Future<bool> deleteCookies({

required WebUri url,
String path = "/",
String? domain,
@Deprecated("Use webViewController instead") InAppWebViewController? iosBelow11WebViewController,
InAppWebViewController? webViewController,

})

Removes all cookies for the given url, domain and path.

The default value of path is "/".

The return value indicates whether cookies were deleted successfully.

Officially Supported Platforms/Implementations:

Android WebView (Official API - CookieManager.getCookie)
iOS WKWebView (Official API - WKHTTPCookieStore.delete):
- On iOS below 11.0, the webViewController is used for deleting the cookies (also session-only cookies) using JavaScript (cookies with isHttpOnly enabled cannot be deleted, 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 delete the cookies (session-only cookies and cookies with isHttpOnly enabled won't be deleted!). In this case, this method will return always true.
macOS WKWebView (Official API - WKHTTPCookieStore.delete):
- On macOS below 10.13, the webViewController is used for deleting the cookies (also session-only cookies) using JavaScript (cookies with isHttpOnly enabled cannot be deleted, 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 delete the cookies (session-only cookies and cookies with isHttpOnly enabled won't be deleted!). In this case, this method will return always true.
Web <iframe> but requires same origin:
- The webViewController is used for deleting the cookies (also session-only cookies) using JavaScript (cookies with isHttpOnly enabled cannot be deleted, 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 delete the cookies (session-only cookies and cookies with isHttpOnly enabled won't be deleted!). 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_delete_cookie)

Parameters - Officially Supported Platforms/Implementations:

url: all platforms
path: all platforms
domain: 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> deleteCookies({
  required WebUri url,
  String path = "/",
  String? domain,
  @Deprecated("Use webViewController instead")
  InAppWebViewController? iosBelow11WebViewController,
  InAppWebViewController? webViewController,
}) => platform.deleteCookies(
  url: url,
  path: path,
  domain: domain,
  iosBelow11WebViewController: iosBelow11WebViewController?.platform,
  webViewController: webViewController?.platform,
);

deleteCookies method

Implementation

CookieManager class