incorporate API review changes

Maura Winstanley · Maura Winstanley · commit 54862852b392 · 2021-10-29T10:45:55.000-07:00
diff --git a/specs/ClearBrowsingData.md b/specs/ClearBrowsingData.md
@@ -20,9 +20,9 @@ HRESULT ClearBrowsingDataInTimeRange(
       [in] double endTime, 
       [in] ICoreWebView2ClearBrowsingDataCompletedHandler* handler);
 ```
-The first method takes `COREWEBVIEW2_BROWSING_DATA_KINDS` which corresponds to the data type(s) to clear as well as a handler which will indicate if the proper data has been cleared successfully. This method clears the data for all time. 
+The first method takes `COREWEBVIEW2_BROWSING_DATA_KINDS` which corresponds to the data type(s) to clear as well as a handler which will indicate if the proper data has been cleared successfully. This method clears the data regardless of timestamp. 
 
-The second method takes the same parameters for the dataKinds and handler, as well as a start and end time in which the API should clear the corresponding data between. The time parameters correspond to how many seconds have passed since the UNIX epoch. 
+The second method takes the same parameters for the dataKinds and handler, as well as a start and end time in which the API should clear the corresponding data between. The time parameters correspond to how many seconds have passed since the UNIX epoch. Passing in a value of zero or less than zero (up to negative infinity) will clear the corresponding data for any time before X time. Passing in a value of the current time or greater (up to positive infinity) will clear the corresponding data for any time after X time. For example passing in negative infinity and positive infinity as the time parameters will clear the entirety of the corresponding data. The timestamp represents the time at which the data was created. 
 
 Both methods clear the data for the associated profile in which the method is called on.
 
@@ -49,16 +49,12 @@ void ClearAutofillData()
         /// This will clear the data for the last hour.
         COREWEBVIEW2_BROWSING_DATA_KINDS dataKinds = (COREWEBVIEW2_BROWSING_DATA_KINDS)
             (COREWEBVIEW2_BROWSING_DATA_KINDS_GENERAL_AUTOFILL |
-            COREWEBVIEW2_BROWSING_DATA_KINDS_PASSWORD_AUTOSAVE));
+            COREWEBVIEW2_BROWSING_DATA_KINDS_PASSWORD_AUTOSAVE);
         CHECK_FAILURE(profile->ClearBrowsingDataInTimeRange(
             dataKinds, startTime, endTime,
             Callback<ICoreWebView2StagingClearBrowsingDataCompletedHandler>(
                 [this](HRESULT error)
                     -> HRESULT {
-                    LPCWSTR result = error == S_OK ? L"Succeeded" : L"Failed";
-                    RunAsync([this, result]() {
-                        MessageBox(nullptr, result, L"Clear Browsing Data", MB_OK);
-                    });
                     return S_OK;
                 })
                 .Get()));
@@ -75,10 +71,10 @@ private void ClearAutofillData()
     if (webView.CoreWebView2 != null) 
     {
         profile = webView.CoreWebView2.Profile;
-        double endTime = DateTimeOffset.Now.ToUnixTimeSeconds();
-        // Get the current time which is the time in which the browsing data will be cleared until.
-        double startTime = endTime - 3600;
-        // Offset the current time by 3600 seconds to clear the browsing data from the last hour.
+        // Get the current time, the time in which the browsing data will be cleared until.
+        System.DateTime endTime = DateTime.Now;
+        System.DateTime startTime = DateTime.Now.AddHours(-1);   
+        // Offset the current time by one hour to clear the browsing data from the last hour.
         CoreWebView2BrowsingDataKinds dataKinds = (CoreWebView2BrowsingDataKinds)(CoreWebView2BrowsingDataKinds.GeneralAutofill | CoreWebView2BrowsingDataKinds.PasswordAutosave);
         await profile.ClearBrowsingDataAsync(dataKinds, startTime, endTime);
     }
@@ -99,7 +95,7 @@ interface ICoreWebView2ClearBrowsingDataCompletedHandler;
 
 /// Specifies the datatype for the
 /// `ICoreWebView2Profile::ClearBrowsingData` method.
-[v1_enum]
+[v1_enum] 
 typedef enum COREWEBVIEW2_BROWSING_DATA_KINDS {
   /// Specifies data stored by the AppCache DOM feature.
   COREWEBVIEW2_BROWSING_DATA_KINDS_APP_CACHE = 1 << 0,
@@ -116,71 +112,62 @@ typedef enum COREWEBVIEW2_BROWSING_DATA_KINDS {
   /// Specifies data stored by the Web SQL database DOM API.
   COREWEBVIEW2_BROWSING_DATA_KINDS_WEB_SQL = 1 << 4,
 
-  /// Specifies cache storage which stores the network requests
-  /// and responses. 
+  /// Specifies data stored by the CacheStorge DOM API.
   COREWEBVIEW2_BROWSING_DATA_KINDS_CACHE_STORAGE = 1 << 5,
 
-  /// Specifies DOM storage data. This browsing data kind is inclusive 
-  /// of COREWEBVIEW2_BROWSING_DATA_KINDS_APP_CACHE, 
+  /// Specifies DOM storage data, now and future. This browsing data kind is 
+  /// inclusive of COREWEBVIEW2_BROWSING_DATA_KINDS_APP_CACHE, 
   /// COREWEBVIEW2_BROWSING_DATA_KINDS_FILE_SYSTEMS,
   /// COREWEBVIEW2_BROWSING_DATA_KINDS_INDEXED_DB, 
   /// COREWEBVIEW2_BROWSING_DATA_KINDS_LOCAL_STORAGE,
   /// COREWEBVIEW2_BROWSING_DATA_KINDS_WEB_SQL, 
   /// COREWEBVIEW2_BROWSING_DATA_KINDS_CACHE_STORAGE.
-  COREWEBVIEW2_BROWSING_DATA_KINDS_DOM_STORAGE = 
-      COREWEBVIEW2_BROWSING_DATA_KINDS_APP_CACHE|
-      COREWEBVIEW2_BROWSING_DATA_KINDS_FILE_SYSTEMS | 
-      COREWEBVIEW2_BROWSING_DATA_KINDS_INDEXED_DB |
-      COREWEBVIEW2_BROWSING_DATA_KINDS_LOCAL_STORAGE | 
-      COREWEBVIEW2_BROWSING_DATA_KINDS_WEB_SQL |
-      COREWEBVIEW2_BROWSING_DATA_KINDS_CACHE_STORAGE,
+  /// New DOM storage data types may be added to this data kind in the future. 
+  COREWEBVIEW2_BROWSING_DATA_KINDS_ALL_DOM_STORAGE = 1 << 6,
 
   /// Specifies HTTP cookies data.
-  COREWEBVIEW2_BROWSING_DATA_KINDS_COOKIES = 1 << 6,
+  COREWEBVIEW2_BROWSING_DATA_KINDS_COOKIES = 1 << 7,
 
-  /// Specifies site data. This browsing data kind
-  /// is inclusive of COREWEBVIEW2_BROWSING_DATA_KINDS_DOM_STORAGE and
-  /// COREWEBVIEW2_BROWSING_DATA_KINDS_COOKIES. 
-  COREWEBVIEW2_BROWSING_DATA_KINDS_SITE = COREWEBVIEW2_BROWSING_DATA_KINDS_DOM_STORAGE | 
-      COREWEBVIEW2_BROWSING_DATA_KINDS_COOKIES, 
+  /// Specifies all site data, now and future. This browsing data kind
+  /// is inclusive of COREWEBVIEW2_BROWSING_DATA_KINDS_ALL_DOM_STORAGE and
+  /// COREWEBVIEW2_BROWSING_DATA_KINDS_COOKIES. New site data types
+  /// may be added to this data kind in the future. 
+  COREWEBVIEW2_BROWSING_DATA_KINDS_ALL_SITE = 1 << 8,
 
-  /// Specifies content in the HTTP cache including images and other files. 
-  COREWEBVIEW2_BROWSING_DATA_KINDS_HTTP_CACHE = 1 << 7,
+  /// Specifies disk cache. 
+  COREWEBVIEW2_BROWSING_DATA_KINDS_DISK_CACHE = 1 << 9,
 
   /// Specifies download history data. 
-  COREWEBVIEW2_BROWSING_DATA_KINDS_DOWNLOAD_HISTORY = 1 << 8, 
+  COREWEBVIEW2_BROWSING_DATA_KINDS_DOWNLOAD_HISTORY = 1 << 10, 
 
   /// Specifies general autofill form data. 
   /// This excludes password information and includes information like: 
   /// names, street and email addresses, phone numbers, and arbitrary input. 
   /// This also includes payment data. 
-  COREWEBVIEW2_BROWSING_DATA_KINDS_GENERAL_AUTOFILL = 1 << 9, 
+  COREWEBVIEW2_BROWSING_DATA_KINDS_GENERAL_AUTOFILL = 1 << 11, 
 
   /// Specifies password autosave data. 
-  COREWEBVIEW2_BROWSING_DATA_KINDS_PASSWORD_AUTOSAVE = 1 << 10,
+  COREWEBVIEW2_BROWSING_DATA_KINDS_PASSWORD_AUTOSAVE = 1 << 12,
 
   /// Specifies browsing history data. 
-  COREWEBVIEW2_BROWSING_DATA_KINDS_BROWSING_HISTORY = 1 << 11,
+  COREWEBVIEW2_BROWSING_DATA_KINDS_BROWSING_HISTORY = 1 << 13,
 
   /// Specifies settings data.
-  COREWEBVIEW2_BROWSING_DATA_KINDS_SETTINGS = 1 << 12,
+  COREWEBVIEW2_BROWSING_DATA_KINDS_SETTINGS = 1 << 14,
 
   /// Specifies profile data that should be wiped to make it look like a new profile.
-  /// This browsing data kind is inclusive of COREWEBVIEW2_BROWSING_DATA_KINDS_SITE,
-  /// COREWEBVIEW2_BROWSING_DATA_KINDS_HTTP_CACHE, 
+  /// This does not delete account-scoped data like passwords but will remove access
+  /// to account-scoped data by signing the user out.
+  /// Specifies all profile data, now and future. New profile data types may be added
+  /// to this data kind in the future. 
+  /// This browsing data kind is inclusive of COREWEBVIEW2_BROWSING_DATA_KINDS_ALL_SITE,
+  /// COREWEBVIEW2_BROWSING_DATA_KINDS_DISK_CACHE, 
   /// COREWEBVIEW2_BROWSING_DATA_KINDS_DOWNLOAD_HISTORY,
   /// COREWEBVIEW2_BROWSING_DATA_KINDS_GENERAL_AUTOFILL, 
   /// COREWEBVIEW2_BROWSING_DATA_KINDS_PASSWORD_AUTOSAVE,
   /// COREWEBVIEW2_BROWSING_DATA_KINDS_BROWSING_HISTORY, and 
   /// COREWEBVIEW2_BROWSING_DATA_KINDS_SETTINGS.
-  COREWEBVIEW2_BROWSING_DATA_KINDS_PROFILE =  
-    COREWEBVIEW2_BROWSING_DATA_KINDS_SITE |
-    COREWEBVIEW2_BROWSING_DATA_KINDS_HTTP_CACHE | 
-    COREWEBVIEW2_BROWSING_DATA_KINDS_DOWNLOAD_HISTORY |
-    COREWEBVIEW2_BROWSING_DATA_KINDS_GENERAL_AUTOFILL | 
-    COREWEBVIEW2_BROWSING_DATA_KINDS_PASSWORD_AUTOSAVE |
-    COREWEBVIEW2_BROWSING_DATA_KINDS_BROWSING_HISTORY | 
-    COREWEBVIEW2_BROWSING_DATA_KINDS_SETTINGS,
+  COREWEBVIEW2_BROWSING_DATA_KINDS_ALL_PROFILE =  1 << 15,
 } COREWEBVIEW2_BROWSING_DATA_KINDS;
 
 [uuid(DAF8B1F9-276D-410C-B481-58CBADF85C9C), object, pointer_default(unique)]
@@ -193,23 +180,26 @@ interface ICoreWebView2Profile : IUnknown {
   /// are listed below. These data kinds follow a hierarchical structure in which 
   /// nested bullet points are included in their parent bullet point's data kind.
   /// Ex: DOM storage is encompassed in site data which is encompassed in the profile data. 
-  /// * Profile
-  ///   * Site Data
-  ///     * DOM Storage: App Cache, File Systems, Indexed DB, Local Storage, Web SQL, Cache 
+  /// * All Profile
+  ///   * All Site Data
+  ///     * All DOM Storage: App Cache, File Systems, Indexed DB, Local Storage, Web SQL, Cache 
   ///         Storage
   ///     * Cookies 
-  ///   * HTTP Cache 
+  ///   * Disk Cache 
   ///   * Download History
   ///   * General Autofill 
   ///   * Password Autosave
   ///   * Browsing History
   ///   * Settings  
-  /// The completed handler will be invoked when the browsing data has been cleared and will 
-  /// indicate if the specified data was properly cleared.
-  /// If the WebView object is closed before the clear browsing data operation 
-  /// has completed, the handler will be released, but not invoked. In this case 
-  /// the clear browsing data operation may or may not be completed. 
-  /// ClearBrowsingData clears the `dataKinds` for all time. 
+  /// The completed handler will be invoked when the browsing data has been cleared and
+  /// will indicate if the specified data was properly cleared.
+  /// Because this is an asynchronous operation, code that is dependent on the cleared 
+  /// data must be placed in the callback of this operation.
+  /// If the WebView object is closed before the clear browsing data operation
+  /// has completed, the handler will be released, but not invoked. In this case
+  /// the clear browsing data operation may or may not be completed.
+  /// ClearBrowsingData clears the `dataKinds` regardless of timestamp. 
+
   HRESULT ClearBrowsingData(
       [in] COREWEBVIEW2_BROWSING_DATA_KINDS dataKinds,
       [in] ICoreWebView2ClearBrowsingDataCompletedHandler* handler);
@@ -218,19 +208,30 @@ interface ICoreWebView2Profile : IUnknown {
   /// takes in two additional parameters for the start and end time for which it 
   /// should clear the data between.  The `startTime` and `endTime` 
   /// parameters correspond to the number of seconds since the UNIX epoch. 
-  ///
-  /// \snippet AppWindow.cpp ClearBrowsingData
+  /// The `startTime` will be offset by -1.0 and the `endTime will be offset by +1.0
+  /// to ensure the last fractional second is cleared on each respective end.
+  /// `startTime` is inclusive while `endTime` is exclusive, therefore the data will 
+  /// clear [startTime, endTime).
+ 
   HRESULT ClearBrowsingDataInTimeRange(
       [in] COREWEBVIEW2_BROWSING_DATA_KINDS dataKinds, 
       [in] double startTime,
       [in] double endTime, 
       [in] ICoreWebView2ClearBrowsingDataCompletedHandler* handler);
+
+  /// ClearBrowsingDataAll behaves like ClearBrowsingData except that it 
+  /// clears the entirety of the data associated with the profile it is called on.
+  /// It clears the data regardless of timestamp.
+
+  HRESULT ClearBrowsingDataAll(
+    [in] ICoreWebView2ClearBrowsingDataCompletedHandler* handler);
 }
 
 /// The caller implements this interface to receive the `ClearBrowsingData` result.
 [uuid(27676699-FE17-4E2B-8C1B-267395A04ED5), object, pointer_default(unique)]
 interface ICoreWebView2ClearBrowsingDataCompletedHandler : IUnknown {
   /// Provide the completion status of the corresponding asynchronous method. 
+
   HRESULT Invoke([in] HRESULT errorCode);
 }
 
@@ -247,22 +248,24 @@ namespace Microsoft.Web.WebView2.Core
         LocalStorage = 8,
         WebSql = 16,
         CacheStorage = 32,
-        DomStorage = 63,
-        Cookies = 64,
-        Site = 127,
-        HttpCache = 128,
-        DownloadHistory = 256,
-        GeneralAutofill = 512,
-        PasswordAutosave = 1024,
-        BrowsingHistory = 2048,
-        Settings = 4096,
-        Profile = 8191,
+        AllDomStorage = 64,
+        Cookies = 128,
+        AllSite = 256,
+        DiskCache = 512,
+        DownloadHistory = 1024,
+        GeneralAutofill = 2048,
+        PasswordAutosave = 4096,
+        BrowsingHistory = 8192,
+        Settings = 16384,
+        AllProfile = 32768,
     };
 
     public partial class CoreWebView2Profile
     {
-        public async Task<bool> ClearBrowsingDataAsync(CoreWebView2BrowsingDataKinds dataKinds);
-        public async Task<bool> ClearBrowsingDataAsync(CoreWebView2BrowsingDataKinds dataKinds, double startTime, double endTime);
+        public async Task ClearBrowsingDataAsync(CoreWebView2BrowsingDataKinds dataKinds);
+        /// .NET and WinRT will take the official DateTime object for start and end time parameters.
+        public async Task ClearBrowsingDataAsync(CoreWebView2BrowsingDataKinds dataKinds, DateTime startTime, DateTime endTime);
+        public async Task ClearBrowsingDataAsync();
     }
 }
 ```
