diff options
Diffstat (limited to 'chromium/chrome/common/extensions/api/reading_list_private.json')
-rw-r--r-- | chromium/chrome/common/extensions/api/reading_list_private.json | 96 |
1 files changed, 96 insertions, 0 deletions
diff --git a/chromium/chrome/common/extensions/api/reading_list_private.json b/chromium/chrome/common/extensions/api/reading_list_private.json new file mode 100644 index 00000000000..7e1979d0981 --- /dev/null +++ b/chromium/chrome/common/extensions/api/reading_list_private.json @@ -0,0 +1,96 @@ +// Copyright 2014 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": "readingListPrivate", + "description": "none", + "types": [ + { + "id": "Entry", + "type": "object", + "description": "An article entry from the reading list. May contain one or more pages.", + "properties": { + "id": { + "description": "A unique id for referring to the entry.", + "type": "string" + } + } + } + ], + "functions": [ + { + "name": "addEntry", + "type": "function", + "description": "Adds an entry to the reading list. The callback is invoked only once article distillation is complete.", + "parameters": [ + { + "type": "object", + "name": "entry", + "properties": { + "url": { + "description": "The url of the entry.", + "type": "string" + } + } + }, + { + "type": "function", + "name": "callback", + "optional": true, + "parameters": [ + { + "name": "result", + "$ref": "Entry", + "description": "The entry that was added." + } + ] + } + ] + }, + { + "name": "removeEntry", + "type": "function", + "description": "Removes an entry with the given entry id.", + "parameters": [ + { + "name": "id", + "type": "string", + "description": "A string containing an entry id." + }, + { + "type": "function", + "name": "callback", + "parameters": [ + { + "name": "result", + "$ref": "Entry", + "optional": true, + "description": "The entry that was removed or null if removal failed." + } + ] + } + ] + }, + { + "name": "getEntries", + "type": "function", + "description": "Gets all the entries currently stored in the reading list.", + "parameters": [ + { + "type": "function", + "name": "callback", + "parameters": [ + { + "name": "result", + "type": "array", + "items": {"$ref": "Entry"} + } + ] + } + ] + } + ] + } +] |