CookieManager class
Class that implements a singleton object (shared instance) which manages the cookies used by WebView instances.
Constructors
- CookieManager()
- Class that implements a singleton object (shared instance) which manages the cookies used by WebView instances.
- 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 setterinherited
- 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 setterinherited
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
namefor the givenurl,domainandpath. -
deleteCookies(
{required WebUri url, String path = "/", String? domain, InAppWebViewController? iosBelow11WebViewController, InAppWebViewController? webViewController}) → Future< bool> -
Removes all cookies for the given
url,domainandpath. -
flush(
) → Future< void> - Ensures all cookies currently accessible through the getCookie API are written to persistent storage. This call will block the caller until it is done and may perform I/O.
-
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
namefor the givenurl. -
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 samehost,pathandnamewill 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.
-
isClassSupported(
{TargetPlatform? platform}) → bool -
Check if the current class is supported by the defaultTargetPlatform or a specific
platform. -
isMethodSupported(
PlatformCookieManagerMethod method, {TargetPlatform? platform}) → bool -
Check if the given
methodis supported by the defaultTargetPlatform or a specificplatform. -
isPropertySupported(
PlatformCookieManagerCreationParamsProperty property, {TargetPlatform? platform}) → bool -
Check if the given
propertyis supported by the defaultTargetPlatform or a specificplatform.