Added COM IDL

Author: peiche-ms

specs/CookieManagement.md

@@ -53,6 +53,147 @@ See [API Details](#api-details) section below for API reference.
 
 # API Details
 
+## Win32 C++
+
+```IDL
+interface ICoreWebView2;
+interface ICoreWebView2Cookie;
+interface ICoreWebView2CookieList;
+interface ICoreWebView2CookieManager;
+interface ICoreWebView2GetCookiesCompletedHandler;
+
+/// Kind of cookie SameSite status used in the ICoreWebView2Cookie interface.
+/// These fields match those as specified in https://developer.mozilla.org/docs/Web/HTTP/Cookies#.
+/// Learn more about SameSite cookies here: https://tools.ietf.org/html/draft-west-first-party-cookies-07
+[v1_enum]
+typedef enum COREWEBVIEW2_COOKIE_SAME_SITE_KIND {
+  /// None SameSite type. No restrictions on cross-site requests.
+  COREWEBVIEW2_COOKIE_SAME_SITE_KIND_NONE,
+  /// Lax SameSite type. The cookie will be sent with "same-site" requests, and with "cross-site" top level navigation.
+  COREWEBVIEW2_COOKIE_SAME_SITE_KIND_LAX,
+  /// Strict SameSite type. The cookie will only be sent along with "same-site" requests.
+  COREWEBVIEW2_COOKIE_SAME_SITE_KIND_STRICT,
+} COREWEBVIEW2_COOKIE_SAME_SITE_KIND;
+
+[uuid(20113081-93BD-4F2A-86B9-ADF92DEAAF10), object, pointer_default(unique)]
+interface ICoreWebView2 : IUnknown {
+  /// Create a new cookie manager object. See ICoreWebView2CookieManager.
+  HRESULT CreateCookieManager([out, retval] ICoreWebView2CookieManager** cookieManager);
+}
+
+/// Provides a set of properties that are used to manage an
+/// ICoreWebView2Cookie.
+[uuid(0AD66B3B-316F-4F54-8472-F5FF54360A60), object, pointer_default(unique)]
+interface ICoreWebView2Cookie : IUnknown {
+  /// Cookie name.
+  [propget] HRESULT Name([out, retval] LPWSTR* name);
+
+  /// Cookie value.
+  [propget] HRESULT Value([out, retval] LPWSTR* value);
+  /// Set the cookie value property.
+  [propput] HRESULT Value([in] LPCWSTR value);
+
+  /// The domain for which the cookie is valid.
+  /// The default is the host that this cookie has been received from.
+  [propget] HRESULT Domain([out, retval] LPWSTR* domain);
+
+  /// The path for which the cookie is valid. If not specified, this cookie
+  /// will be sent to all pages on the Domain.
+  [propget] HRESULT Path([out, retval] LPWSTR* path);
+
+  /// The expiration date and time for the cookie as the number of seconds since the UNIX epoch.
+  /// The default is -1.0, which means cookies are session cookies by default.
+  [propget] HRESULT Expires([out, retval] double* expires);
+  /// Set the Expires property. Cookies are session cookies
+  /// and will not be persistent if Expires is negative.
+  [propput] HRESULT Expires([in] double expires);
+
+  /// Whether this cookie is http-only.
+  /// True if a page script or other active content cannot access this
+  /// cookie. The default is false.
+  [propget] HRESULT HttpOnly([out, retval] BOOL* httpOnly);
+  /// Set the HttpOnly property.
+  [propput] HRESULT HttpOnly([in] BOOL httpOnly);
+
+  /// SameSite status of the cookie which represents the enforcement mode of the cookie.
+  /// The default is COREWEBVIEW2_COOKIE_SAME_SITE_KIND_LAX.
+  [propget] HRESULT SameSite([out, retval] COREWEBVIEW2_COOKIE_SAME_SITE_KIND* sameSite);
+  /// Set the SameSite property.
+  [propput] HRESULT SameSite([in] COREWEBVIEW2_COOKIE_SAME_SITE_KIND sameSite);
+
+  /// The security level of this cookie. True if the client is only to return
+  /// the cookie in subsequent requests if those requests use HTTPS.
+  /// The default is false.
+  /// Note that cookie that requests COREWEBVIEW2_COOKIE_SAME_SITE_KIND_NONE but
+  /// is not marked Secure will be rejected.
+  [propget] HRESULT Secure([out, retval] BOOL* secure);
+  /// Set the Secure property.
+  [propput] HRESULT Secure([in] BOOL secure);
+}
+
+/// Add or delete an ICoreWebView2Cookie or ICoreWebView2Cookies,
+/// or view the cookies. The changes would apply to the context of the user profile.
+/// That is, other WebViews under the same user profile could be affected.
+[uuid(588C8A15-A28A-4FFD-926B-5E6EE7449E7C), object, pointer_default(unique)]
+interface ICoreWebView2CookieManager : IUnknown {
+  /// Create a cookie object with a specified name, value, domain, and path.
+  /// One can set other optional properties after cookie creation.
+  /// See ICoreWebView2Cookie for more details.
+  HRESULT CreateCookie(
+    [in] LPCWSTR name,
+    [in] LPCWSTR value,
+    [in] LPCWSTR domain,
+    [in] LPCWSTR path,
+    [out, retval] ICoreWebView2Cookie** cookie);
+
+  /// Gets a list of cookies matching the specific URI.
+  /// You can modify the cookie objects, call
+  /// ICoreWebView2CookieManager::SetCookie, and the changes
+  /// will be applied to the webview.
+  HRESULT GetCookies(
+    [in] LPCWSTR uri,
+    [in] ICoreWebView2GetCookiesCompletedHandler* handler);
+
+  /// Sets a cookie with the given cookie data; may overwrite equivalent cookies
+  /// if they exist.
+  HRESULT SetCookie([in] ICoreWebView2Cookie* cookie);
+
+  /// Deletes browser cookies with matching name and uri or domain/path pair.
+  /// Cookie name is required.
+  /// If uri is specified, deletes all cookies with the given name where domain
+  /// and path match provided URI.
+  /// If domain is specified, deletes only cookies with the exact domain.
+  /// If path is specified, deletes only cookies with the exact path.
+  HRESULT DeleteCookies([in] LPCWSTR name, [in] LPCWSTR uri, [in] LPCWSTR domain, [in] LPCWSTR path);
+
+  /// Clears all cookies under the same profile.
+  /// This could affect other WebViews under the same user profile.
+  HRESULT ClearAllCookies();
+}
+
+/// A list of cookie objects. See ICoreWebView2Cookie.
+[uuid(02F758AF-2F1C-4263-A5F8-37CA875B40D1), object, pointer_default(unique)]
+interface ICoreWebView2CookieList : IUnknown {
+  /// The number of cookies contained in the ICoreWebView2CookieList.
+  [propget] HRESULT Size([out, retval] UINT* size);
+
+  /// Get the cookie object at the given index.
+  HRESULT GetValueAtIndex([in] UINT index, [out, retval] ICoreWebView2Cookie** cookie);
+}
+
+/// The caller implements this method to receive the result of the
+/// GetCookies method. The result is written to the cookie list provided in
+/// the GetCookies method call.
+[uuid(0AD3D432-69E9-4223-9CC4-460C20BDCEF5), object, pointer_default(unique)]
+interface ICoreWebView2GetCookiesCompletedHandler : IUnknown {
+  /// Called to provide the implementer with the completion status
+  /// of the corresponding asynchronous method call.
+  HRESULT Invoke(HRESULT result, ICoreWebView2CookieList* cookieList);
+}
+```
+
+## .NET and WinRT
+
 ```c#
 namespace Microsoft.Web.WebView2.Core
 {