Click or drag to resize

ICookieManager Interface

Version 67.0.0
Used for managing cookies. The methods may be called on any thread unless otherwise indicated.

Namespace:  CefSharp
Assembly:  CefSharp (in CefSharp.dll) Version: 67.0.0.0 (67.0.0.0)
Syntax
public interface ICookieManager : IDisposable

The ICookieManager type exposes the following members.

Properties
  NameDescription
Public propertyIsDisposed
Returns true if disposed
Top
Methods
  NameDescription
Public methodDeleteCookies
Deletes all cookies that matches all the provided parameters. If both url and name are empty, all cookies will be deleted. Cookies can alternately be deleted using the Visit*Cookies() methods. This method will be executed on the CEF IO thread in an async fashion, to be notified upon completion implement IDeleteCookiesCallback and pass in as callback
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable.)
Public methodFlushStore
Flush the backing store (if any) to disk This method will be executed on the CEF IO thread in an async fashion, to be notified upon completion implement ICompletionCallback and pass in as callback
Public methodSetCookie
Sets a cookie given a valid URL and explicit user-provided cookie attributes. This function expects each attribute to be well-formed. It will check for disallowed characters (e.g. the ';' character is disallowed within the cookie value attribute) and will return false without setting the cookie if such characters are found. This method will be executed on the CEF IO thread in an async fashion, to be notified upon completion implement ISetCookieCallback and pass in as callback
Public methodSetStoragePath
Sets the directory path that will be used for storing cookie data. If path is empty data will be stored in memory only. Otherwise, data will be stored at the specified path. To persist session cookies (cookies without an expiry date or validity interval) set persistSessionCookies to true. Session cookies are generally intended to be transient and most Web browsers do not persist them.
Public methodSetSupportedSchemes
Set the schemes supported by this manager. By default only "http" and "https" schemes are supported. Must be called before any cookies are accessed.
Public methodVisitAllCookies
Visits all cookies using the provided Cookie Visitor. The returned cookies are sorted by longest path, then by earliest creation date.
Public methodVisitUrlCookies
Visits a subset of the cookies. The results are filtered by the given url scheme, host, domain and path. If includeHttpOnly is true, HTTP-only cookies will also be included in the results. The returned cookies are sorted by longest path, then by earliest creation date.
Top
Extension Methods
  NameDescription
Public Extension MethodDeleteCookiesAsync
Deletes all cookies that matches all the provided parameters asynchronously. If both url and name are empty, all cookies will be deleted.
(Defined by AsyncExtensions.)
Public Extension MethodFlushStoreAsync
Flush the backing store (if any) to disk.
(Defined by AsyncExtensions.)
Public Extension MethodSetCookieAsync
Sets a cookie given a valid URL and explicit user-provided cookie attributes. This function expects each attribute to be well-formed. It will check for disallowed characters (e.g. the ';' character is disallowed within the cookie value attribute) and will return false without setting
(Defined by AsyncExtensions.)
Public Extension MethodVisitAllCookiesAsync
Visits all cookies. The returned cookies are sorted by longest path, then by earliest creation date.
(Defined by AsyncExtensions.)
Public Extension MethodVisitUrlCookiesAsync
Visits a subset of the cookies. The results are filtered by the given url scheme, host, domain and path. If includeHttpOnly is true, HTTP-only cookies will also be included in the results. The returned cookies are sorted by longest path, then by earliest creation date.
(Defined by AsyncExtensions.)
Top
See Also