Skip to content

Commit 3806d5f

Browse files
committed
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)
1 parent 6ba6b7a commit 3806d5f

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

CefSharp/ICookieManager.cs

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,21 @@ public interface ICookieManager : IDisposable
1414
/// <summary>
1515
/// 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.
1616
/// 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"/>
1719
/// </summary>
1820
/// <param name="url">The cookie URL. If an empty string is provided, any URL will be matched.</param>
1921
/// <param name="name">The name of the cookie. If an empty string is provided, any URL will be matched.</param>
2022
/// <param name="callback">If non-NULL it will be executed asnychronously on the CEF IO thread after the cookies have been deleted.</param>
2123
/// <return>Returns false if a non-empty invalid URL is specified, or if cookies cannot be accessed; otherwise, true.</return>
22-
bool DeleteCookies(string url, string name, IDeleteCookiesCallback callback = null);
24+
bool DeleteCookies(string url = null, string name = null, IDeleteCookiesCallback callback = null);
2325

2426
/// <summary>
2527
/// 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
2628
/// characters (e.g. the ';' character is disallowed within the cookie value attribute) and will return false without setting
2729
/// 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"/>
2832
/// </summary>
2933
/// <param name="url">The cookie URL</param>
3034
/// <param name="cookie">The cookie</param>
@@ -72,6 +76,8 @@ public interface ICookieManager : IDisposable
7276

7377
/// <summary>
7478
/// 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"/>
7581
/// </summary>
7682
/// <param name="callback">If non-NULL it will be executed asnychronously on the CEF IO thread after the flush is complete.</param>
7783
/// <return>Returns false if cookies cannot be accessed.</return>

0 commit comments

Comments
 (0)