Added option to bookmarkManagerPrivate.getMetaInfo() to get meta info from all bookmarks in a one f…

chrome/common/extensions/api/bookmark_manager_private.json

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 [
   {
     "namespace": "bookmarkManagerPrivate",
     "description": "none",
     "types": [
       {
@@ skipping 31 matching lines @@
             "type": "array",
             "items": {"$ref": "BookmarkNodeDataElement"}
           }
         }
       },
       {
         "id": "MetaInfoFields",
         "type": "object",
         "description": "Collection of meta info fields.",
         "additionalProperties": {"type": "string"}
+      },
+      {
+        "id": "MapMetaInfoFields",
+        "type": "object",
+        "description": "Map Id to MetaInfoFields.",
+        "additionalProperties": {"type": "any"}
       }
     ],
     "functions": [
       {
         "name": "copy",
         "type": "function",
         "description": "Copies the given bookmarks into the clipboard",
         "parameters": [
           {
             "name": "idList",
@@ skipping 200 matching lines @@
                 "$ref": "bookmarks.BookmarkTreeNode"
               }
             ]
           }
         ]
       },
       {
         "name": "getMetaInfo",
         "type": "function",
         "description": "Gets meta info from a bookmark node",
+        "allowAmbiguousOptionalArguments": true,
         "parameters": [
           {
             "name": "id",
-            "description": "The id of the bookmark to retrieve meta info from",
+            "description": "The id of the bookmark to retrieve meta info from. If omitted meta info for all nodes is returned.",
+            "optional": true,
             "type": "string"
           },
           {
             "name": "key",
             "description": "The key for the meta info to retrieve. If omitted, all fields are returned",
             "optional": true,
             "type": "string"
           },
           {
             "type": "function",
             "name": "callback",
             "parameters": [
               {
                 "name": "value",
-                "description": "If a key was given, the value of the specified field, if present. Otherwise an object containing all meta info fields for the node.",
+                "description": "If a key was given, the value of the specified field, if present. Otherwise an object containing all meta info fields for the node. If id is not given then meta info for all nodes as an object with node id to meta info.",

[not at google - send to devlin, 2014/06/16 21:49:27]

Ah, yeah, this is a pretty confusing API no matter how you phrase it... 1 type,
2 types, no types... 2 methods would have been better I think.

e.g. what happens if you specify a key value, but no ID? like

chrome.bookmarkManagerPrivate.getMetaInfo(null, 'foo', function(whatIsThis) {});

[yefimt, 2014/06/16 21:56:20]

Originally it was ignoring second parameter if first one is null. After talking
to Mike and extension dev changed it to return "undefined" in callback. That is
consistent with behavior when key is not found.

On 2014/06/16 21:49:27, kalman wrote:

[not at google - send to devlin, 2014/06/16 21:59:47]

undefined... and set error? sounds like it should be an error in that case.

[yefimt, 2014/06/16 22:32:12]

extension developers don't want error as they don't get callback in this case.

On 2014/06/16 21:59:47, kalman wrote:

[not at google - send to devlin, 2014/06/16 22:33:54]

they don't get a callback..? then where does the undefined go? I'm confusd.

                 "optional": true,
                 // TODO(rfevang): Convert this to always return MetaInfoFields
                 // if the API is made public.
                 "choices": [
                   {"type": "string"},
-                  {"$ref": "MetaInfoFields"}
+                  {"$ref": "MapMetaInfoFields"}

[not at google - send to devlin, 2014/06/16 21:49:27]

if you're going to do this, might as well inline the definition of
MapMetaInfoFields

[yefimt, 2014/06/16 21:56:20]

Do you mean remove "choices", yes it is possible
On 2014/06/16 21:49:27, kalman wrote:

[not at google - send to devlin, 2014/06/16 21:59:47]

No I mean make this

"choices": [
  {"type": "string"},
  {"type": "object", "additionalPropreties": "any"}
]

[yefimt, 2014/06/16 22:00:42]

I think it will be too confusing. Combining MetaInfoFields and MapMetaInfoFileds
was semi OK because they both "additionalProperties", adding "string" there
sounds too much:)

On 2014/06/16 21:56:20, yefimt wrote:

[not at google - send to devlin, 2014/06/16 22:02:01]

I don't understand. this is exactly what you already have, except instead of
{"$ref": "MapMetaInfoFields"} it's {"type": "object", ...}

[yefimt, 2014/06/16 22:32:12]

Done.

                 ]
               }
             ]
           }
         ]
       },
       {
         "name": "setMetaInfo",
         "type": "function",
         "description": "Sets a meta info value for a bookmark node",
@@ skipping 129 matching lines @@
         "type": "function",
         "description": "Fired when the meta info of a node changes.",
         "parameters": [
           {"name": "id", "type": "string"},
           {"name": "metaInfoChanges", "$ref": "MetaInfoFields"}
         ]
       }
     ]
   }
 ]