Skip to content

Commit 351cae3

Browse files
committedAug 13, 2019
ICookieManager - Update xml doc
Updated to reflect upstream changes see https://magpcss.org/ceforum/apidocs3/projects/(default)/CefCookieManager.html Resolves cefsharp#2855
1 parent c640d6b commit 351cae3

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed
 

‎CefSharp/ICookieManager.cs

+16-16
Original file line numberDiff line numberDiff line change
@@ -12,32 +12,32 @@ namespace CefSharp
1212
public interface ICookieManager : IDisposable
1313
{
1414
/// <summary>
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-
/// Cookies can alternately be deleted using the Visit*Cookies() methods.
17-
/// This method will be executed on the CEF UI thread in an async fashion, to be notified upon completion implement <see cref="IDeleteCookiesCallback"/>
18-
/// and pass in as <paramref name="callback"/>
15+
/// Delete all cookies that match the specified parameters.
16+
/// If both <paramref name="url"/> and <paramref name="name"/> values are specified all host and domain cookies matching both will be deleted.
17+
/// If only <paramref name="url"/> is specified all host cookies (but not domain cookies) irrespective of path will be deleted.
18+
/// If <paramref name="url"/> is empty all cookies for all hosts and domains will be deleted.
19+
/// Cookies can alternately be deleted using the Visit*Cookies() methods.
1920
/// </summary>
20-
/// <param name="url">The cookie URL. If an empty string is provided, any URL will be matched.</param>
21-
/// <param name="name">The name of the cookie. If an empty string is provided, any URL will be matched.</param>
21+
/// <param name="url">The cookie URL.</param>
22+
/// <param name="name">The name of the cookie.</param>
2223
/// <param name="callback">If non-NULL it will be executed asnychronously on the CEF UI thread after the cookies have been deleted.</param>
23-
/// <returns>Returns false if a non-empty invalid URL is specified, or if cookies cannot be accessed; otherwise, true.</returns>
24+
/// <returns>Returns false if a non-empty invalid URL is specified or if cookies cannot be accessed; otherwise, true.</returns>
2425
bool DeleteCookies(string url = null, string name = null, IDeleteCookiesCallback callback = null);
2526

2627
/// <summary>
2728
/// 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
28-
/// characters (e.g. the ';' character is disallowed within the cookie value attribute) and will return false without setting
29-
/// the cookie if such characters are found.
29+
/// characters (e.g. the ';' character is disallowed within the cookie value attribute) and fail without setting the cookie if such characters are found.
3030
/// This method will be executed on the CEF UI thread in an async fashion, to be notified upon completion implement <see cref="ISetCookieCallback"/>
3131
/// and pass in as <paramref name="callback"/>
3232
/// </summary>
3333
/// <param name="url">The cookie URL</param>
3434
/// <param name="cookie">The cookie</param>
3535
/// <param name="callback">If non-NULL it will be executed asnychronously on the CEF UI thread after the cookie has been set.</param>
36-
/// <returns>returns false if the cookie cannot be set (e.g. if illegal charecters such as ';' are used); otherwise true.</returns>
36+
/// <returns>Returns false if an invalid URL is specified or if cookies cannot be accessed.</returns>
3737
bool SetCookie(string url, Cookie cookie, ISetCookieCallback callback = null);
3838

3939
/// <summary>
40-
/// Set the schemes supported by this manager. Calling this method with an empty <paramref name="schemes"/> value and <paramref name="includeDefaults"/>
40+
/// Set the schemes supported by this manager. Calling this method with an empty <paramref name="schemes"/> value and <paramref name="includeDefaults"/>
4141
/// set to false will disable all loading and saving of cookies for this manager. Must be called before any cookies are accessed.
4242
/// </summary>
4343
/// <param name="schemes">The list of supported schemes.</param>
@@ -47,19 +47,19 @@ public interface ICookieManager : IDisposable
4747
void SetSupportedSchemes(string[] schemes, bool includeDefaults, ICompletionCallback callback = null);
4848

4949
/// <summary>
50-
/// Visits all cookies using the provided Cookie Visitor. The returned cookies are sorted by longest path, then by earliest creation date.
50+
/// Visit all cookies on the UI thread. The returned cookies are ordered by longest path, then by earliest creation date.
5151
/// </summary>
5252
/// <param name="visitor">A user-provided Cookie Visitor implementation.</param>
5353
/// <returns>Returns false if cookies cannot be accessed; otherwise, true.</returns>
5454
bool VisitAllCookies(ICookieVisitor visitor);
5555

5656
/// <summary>
57-
/// Visits a subset of the cookies. The results are filtered by the given url scheme, host, domain and path.
58-
/// If <paramref name="includeHttpOnly"/> is true, HTTP-only cookies will also be included in the results. The returned cookies
59-
/// are sorted by longest path, then by earliest creation date.
57+
/// Visit a subset of cookies on the CEF UI thread.
58+
/// The results are filtered by the given url scheme, host, domain and path.
59+
/// The returned cookies are ordered by longest path, then by earliest creation date.
6060
/// </summary>
6161
/// <param name="url">The URL to use for filtering a subset of the cookies available.</param>
62-
/// <param name="includeHttpOnly">A flag that determines whether HTTP-only cookies will be shown in results.</param>
62+
/// <param name="includeHttpOnly">If true HTTP-only cookies will also be included in the results.</param>
6363
/// <param name="visitor">A user-provided Cookie Visitor implementation.</param>
6464
/// <returns>Returns false if cookies cannot be accessed; otherwise, true.</returns>
6565
bool VisitUrlCookies(string url, bool includeHttpOnly, ICookieVisitor visitor);

0 commit comments

Comments
 (0)