You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
ICookieManager - Improve xmldoc wording around how methods are executed.
Most methods are executed in an async fashion with a callback that notifies of completion.
Set ICookieManager.DeleteCookies params to null by default (they're optional)
Copy file name to clipboardExpand all lines: CefSharp/ICookieManager.cs
+7-1Lines changed: 7 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -14,17 +14,21 @@ public interface ICookieManager : IDisposable
14
14
/// <summary>
15
15
/// Deletes all cookies that matches all the provided parameters. If both <paramref name="url"/> and <paramref name="name"/> are empty, all cookies will be deleted.
16
16
/// Cookies can alternately be deleted using the Visit*Cookies() methods.
17
+
/// This method will be executed on the CEF IO thread in an async fashion, to be notified upon completion implement <see cref="IDeleteCookiesCallback"/>
18
+
/// and pass in as <paramref name="callback"/>
17
19
/// </summary>
18
20
/// <param name="url">The cookie URL. If an empty string is provided, any URL will be matched.</param>
19
21
/// <param name="name">The name of the cookie. If an empty string is provided, any URL will be matched.</param>
20
22
/// <param name="callback">If non-NULL it will be executed asnychronously on the CEF IO thread after the cookies have been deleted.</param>
21
23
/// <return>Returns false if a non-empty invalid URL is specified, or if cookies cannot be accessed; otherwise, true.</return>
/// 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
26
28
/// characters (e.g. the ';' character is disallowed within the cookie value attribute) and will return false without setting
27
29
/// the cookie if such characters are found.
30
+
/// This method will be executed on the CEF IO thread in an async fashion, to be notified upon completion implement <see cref="ISetCookieCallback"/>
31
+
/// and pass in as <paramref name="callback"/>
28
32
/// </summary>
29
33
/// <param name="url">The cookie URL</param>
30
34
/// <param name="cookie">The cookie</param>
@@ -72,6 +76,8 @@ public interface ICookieManager : IDisposable
72
76
73
77
/// <summary>
74
78
/// Flush the backing store (if any) to disk
79
+
/// This method will be executed on the CEF IO thread in an async fashion, to be notified upon completion implement <see cref="ICompletionCallback"/>
80
+
/// and pass in as <paramref name="callback"/>
75
81
/// </summary>
76
82
/// <param name="callback">If non-NULL it will be executed asnychronously on the CEF IO thread after the flush is complete.</param>
77
83
/// <return>Returns false if cookies cannot be accessed.</return>
0 commit comments