Change the first parameter of savePage.saveAsMHTML to be a dictionary.

This CL makes the first parameter of the experimental savePage.saveAsMHTML API
a dictionary, so the API can easily be extended in the future.

BUG=None
TEST=browser_tests should pass.


Review URL: http://codereview.chromium.org/8631017

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@111249 0039d316-1c4b-4281-b951-d872f2087c98

3 files changed, 82 insertions, 10 deletions

diff --git a/chrome/common/extensions/api/extension_api.json b/chrome/common/extensions/api/extension_api.json
index 1fb9a7d..4ded7d2 100644
--- a/chrome/common/extensions/api/extension_api.json
+++ b/chrome/common/extensions/api/extension_api.json
@@ -9062,13 +9062,18 @@
       {
         "name": "saveAsMHTML",
         "type": "function",
-        "description": "Saves the content of the tab with given id to MHTML.",
+        "description": "Saves the content of the tab with given id as MHTML.",
         "parameters": [
           {
-            "name": "tabId",
-            "type": "integer",
-            "minimum": 0,
-            "description": "The id of the tab to save."
+            "name": "details",
+            "type": "object",
+            "properties": {
+              "tabId": {
+                "type": "integer",
+                "minimum": 0,
+                "description": "The id of the tab to save as MHTML."
+              }
+            }
           },
           {
             "name": "callback",
diff --git a/chrome/common/extensions/docs/experimental.savePage.html b/chrome/common/extensions/docs/experimental.savePage.html
index c2de7a7..5ace1e4 100644
--- a/chrome/common/extensions/docs/experimental.savePage.html
+++ b/chrome/common/extensions/docs/experimental.savePage.html
@@ -378,7 +378,7 @@ system and that it can only be loaded in the main frame.
 <h2 id="manifest">Manifest</h2>
 
 <p>
-The infobars API is currently
+The savePage API is currently
 experimental, so you must declare the "experimental"
 permission to use it.
 
@@ -420,8 +420,8 @@ permission to use it.
 
               <div class="summary"><span style="display: none; ">void</span>
                   <!-- Note: intentionally longer 80 columns -->
-                  <span>chrome.experimental.savePage.saveAsMHTML</span>(<span class="null"><span style="display: none; ">, </span><span>integer</span>
-                      <var><span>tabId</span></var></span><span class="null"><span>, </span><span>function</span>
+                  <span>chrome.experimental.savePage.saveAsMHTML</span>(<span class="null"><span style="display: none; ">, </span><span>object</span>
+                      <var><span>details</span></var></span><span class="null"><span>, </span><span>function</span>
                       <var><span>callback</span></var></span>)</div>
 
               <div class="description">
@@ -434,6 +434,53 @@ permission to use it.
                   <div>
                     <div>
           <dt>
+            <var>details</var>
+              <em>
+
+                <!-- TYPE -->
+                <div style="display:inline">
+                  (
+                    <span class="optional" style="display: none; ">optional</span>
+                    <span class="enum" style="display: none; ">enumerated</span>
+                    <span id="typeTemplate">
+                      <span style="display: none; ">
+                        <a> Type</a>
+                      </span>
+                      <span>
+                        <span style="display: none; ">
+                          array of <span><span></span></span>
+                        </span>
+                        <span>object</span>
+                        <span style="display: none; "></span>
+                      </span>
+                    </span>
+                  )
+                </div>
+
+              </em>
+          </dt>
+          <dd class="todo">
+            Undocumented.
+          </dd>
+          <dd style="display: none; ">
+            Description of this parameter from the json schema.
+          </dd>
+          <dd style="display: none; ">
+            This parameter was added in version
+            <b><span></span></b>.
+            You must omit this parameter in earlier versions,
+            and you may omit it in any version.  If you require this
+            parameter, the manifest key
+            <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>
+            can ensure that your extension won't be run in an earlier browser version.
+          </dd>
+
+          <!-- OBJECT PROPERTIES -->
+          <dd>
+            <dl>
+              <div>
+                <div>
+          <dt>
             <var>tabId</var>
               <em>
 
@@ -462,7 +509,7 @@ permission to use it.
           <dd class="todo" style="display: none; ">
             Undocumented.
           </dd>
-          <dd>The id of the tab to save.</dd>
+          <dd>The id of the tab to save to MHTML.</dd>
           <dd style="display: none; ">
             This parameter was added in version
             <b><span></span></b>.
@@ -499,6 +546,26 @@ permission to use it.
           </dd>
 
         </div>
+              </div>
+            </dl>
+          </dd>
+
+          <!-- OBJECT METHODS -->
+          <dd style="display: none; ">
+            <div></div>
+          </dd>
+
+          <!-- OBJECT EVENT FIELDS -->
+          <dd style="display: none; ">
+            <div></div>
+          </dd>
+
+          <!-- FUNCTION PARAMETERS -->
+          <dd style="display: none; ">
+            <div></div>
+          </dd>
+
+        </div>
                   </div><div>
                     <div>
           <dt>
diff --git a/chrome/common/extensions/docs/static/experimental.savePage.html b/chrome/common/extensions/docs/static/experimental.savePage.html
index 06910d4..1db3947 100644
--- a/chrome/common/extensions/docs/static/experimental.savePage.html
+++ b/chrome/common/extensions/docs/static/experimental.savePage.html
@@ -17,7 +17,7 @@ system and that it can only be loaded in the main frame.
 <h2 id="manifest">Manifest</h2>
 
 <p>
-The infobars API is currently
+The savePage API is currently
 experimental, so you must declare the "experimental"
 permission to use it.