PlatformCookieManagerMethod enum

Can be used to check if the PlatformCookieManager.deleteAllCookies method is supported at runtime.

Officially Supported Platforms/Implementations:

• Android WebView (Official API - CookieManager.removeAllCookies)
• iOS WKWebView 11.0+ (Official API - WKWebsiteDataStore.removeData):
  • It will return always true.
• macOS WKWebView 10.13+ (Official API - WKWebsiteDataStore.removeData):
  • It will return always true.
• Windows WebView2
• Linux WPE WebKit (Official API - webkit_website_data_manager_clear):
  • Uses WebsiteDataManager to clear all cookie data.

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

Can be used to check if the PlatformCookieManager.deleteCookie method is supported at runtime.

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 cookie (also session-only cookie) using JavaScript (cookie 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 cookie (session-only cookie and cookie 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 cookie (also session-only cookie) using JavaScript (cookie 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 cookie (session-only cookie and cookie 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 cookie (also session-only cookie) using JavaScript (cookie 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 cookie (session-only cookie and cookie 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
• name: 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.

Can be used to check if the PlatformCookieManager.deleteCookies method is supported at runtime.

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.

Can be used to check if the PlatformCookieManager.flush method is supported at runtime.

Officially Supported Platforms/Implementations:

• Android WebView (Official API - CookieManager.flush)

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

Can be used to check if the PlatformCookieManager.getAllCookies method is supported at runtime.

Officially Supported Platforms/Implementations:

• iOS WKWebView 11.0+ (Official API - WKHTTPCookieStore.getAllCookies)
• macOS WKWebView 10.13+ (Official API - WKHTTPCookieStore.getAllCookies)
• Linux WPE WebKit (Official API - webkit_cookie_manager_get_all_cookies)

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

Can be used to check if the PlatformCookieManager.getCookie method is supported at runtime.

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.

Can be used to check if the PlatformCookieManager.getCookies method is supported at runtime.

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 cookies (also session-only cookies) using JavaScript (cookies 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 cookies (session-only cookies and cookies 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 cookies (also session-only cookies) using JavaScript (cookies 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 cookies (session-only cookies and cookies with isHttpOnly enabled won't be found!).
• Web <iframe> but requires same origin:
  • The webViewController is used for getting the cookies (also session-only cookies) using JavaScript (cookies 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 cookies (session-only cookies and cookies 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
• 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.

Can be used to check if the PlatformCookieManager.removeSessionCookies method is supported at runtime.

Officially Supported Platforms/Implementations:

• Android WebView (Official API - CookieManager.removeSessionCookies)

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

Can be used to check if the PlatformCookieManager.setCookie method is supported at runtime.

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.