CookieManager class

Class that implements a singleton object (shared instance) which manages the cookies used by WebView instances. On Android, it is implemented using CookieManager. On iOS, it is implemented using WKHTTPCookieStore.

NOTE for iOS below 11.0 and Web platform (LIMITED SUPPORT!): in this case, almost all of the methods (PlatformCookieManager.deleteAllCookies and PlatformCookieManager.getAllCookies are not supported!) has been implemented using JavaScript because there is no other way to work with them on iOS below 11.0. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies#restrict_access_to_cookies for JavaScript restrictions.

Officially Supported Platforms/Implementations:

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

Constructors

CookieManager()

Class that implements a singleton object (shared instance) which manages the cookies used by WebView instances. On Android, it is implemented using CookieManager. On iOS, it is implemented using WKHTTPCookieStore.

CookieManager.fromPlatform(PlatformCookieManager platform)

Constructs a CookieManager from a specific platform implementation.

CookieManager.fromPlatformCreationParams(PlatformCookieManagerCreationParams params)

Constructs a CookieManager from creation params for a specific platform.

Properties

hashCode → int

The hash code for this object.

no setter, inherited

ios ↔ IOSCookieManager

Use CookieManager instead.

getter/setter pair

platform → PlatformCookieManager

Implementation of PlatformCookieManager for the current platform.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

deleteAllCookies() → Future<bool>

Removes all cookies.

deleteCookie({required WebUri url, required String name, String path = "/", String? domain, InAppWebViewController? iosBelow11WebViewController, InAppWebViewController? webViewController}) → Future<bool>

Removes a cookie by its name for the given url, domain and path.

deleteCookies({required WebUri url, String path = "/", String? domain, InAppWebViewController? iosBelow11WebViewController, InAppWebViewController? webViewController}) → Future<bool>

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

getAllCookies() → Future<List<Cookie>>

Fetches all stored cookies.

getCookie({required WebUri url, required String name, InAppWebViewController? iosBelow11WebViewController, InAppWebViewController? webViewController}) → Future<Cookie?>

Gets a cookie by its name for the given url.

getCookies({required WebUri url, InAppWebViewController? iosBelow11WebViewController, InAppWebViewController? webViewController}) → Future<List<Cookie>>

Gets all the cookies for the given url.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

removeSessionCookies() → Future<bool>

Removes all session cookies, which are cookies without an expiration date.

setCookie({required WebUri url, required String name, required String value, String path = "/", String? domain, int? expiresDate, int? maxAge, bool? isSecure, bool? isHttpOnly, HTTPCookieSameSitePolicy? sameSite, InAppWebViewController? iosBelow11WebViewController, InAppWebViewController? webViewController}) → Future<bool>

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.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

instance({WebViewEnvironment? webViewEnvironment}) → CookieManager

Gets the CookieManager shared instance.