Click or drag to resize

ICookieManager Interface

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

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

The ICookieManager type exposes the following members.

Properties
  NameDescription
Public propertyIsDisposed
Returns true if disposed
Top
Methods
  NameDescription
Public methodDeleteCookies
Delete all cookies that match the specified parameters. If both url and name values are specified all host and domain cookies matching both will be deleted. If only url is specified all host cookies (but not domain cookies) irrespective of path will be deleted. If url is empty all cookies for all hosts and domains will be deleted. Cookies can alternately be deleted using the Visit*Cookies() methods.
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 UI 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 fail without setting the cookie if such characters are found. This method will be executed on the CEF UI thread in an async fashion, to be notified upon completion implement ISetCookieCallback and pass in as callback
Public methodVisitAllCookies
Visit all cookies on the UI thread. The returned cookies are ordered by longest path, then by earliest creation date.
Public methodVisitUrlCookies
Visit a subset of cookies on the CEF UI thread. The results are filtered by the given url scheme, host, domain and path. The returned cookies are ordered 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