chrome/common/extensions/api/reading_list_private.json

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 [
   6   {
   7     "namespace": "readingListPrivate",
   8     "description": "none",
   9     "types": [
  10       {
  11         "id": "Entry",
  12         "type": "object",
  13         "description": "An article entry from the reading list. May contain one or more pages.",
  14         "properties": {
  15           "id": {
  16             "description": "A unique id for referring to the entry.",
  17             "type": "string"
  18           }
  19         }
  20       }
  21     ],
  22     "functions": [
  23       {
  24         "name": "addEntry",
  25         "type": "function",
  26         "description": "Adds an entry to the reading list. The callback is invoked only once article distillation is complete.",
  27         "parameters": [
  28           {
  29             "type": "object",
  30             "name": "entry",
  31             "properties": {
  32               "url": {
  33                 "description": "The url of the entry.",
  34                 "type": "string"
  35               }
  36             }
  37           },
  38           {
  39             "type": "function",
  40             "name": "callback",
  41             "optional": true,
  42             "parameters": [
  43               {
  44                 "name": "result",
  45                 "$ref": "Entry",
  46                 "description": "The entry that was added."
  47               }
  48             ]
  49           }
  50         ]
  51       },
  52       {
  53         "name": "removeEntry",
  54         "type": "function",
  55         "description": "Removes an entry with the given entry id.",
  56         "parameters": [
  57           {
  58             "name": "id",
  59             "type": "string",
  60             "description": "A string containing an entry id."
  61           },
  62           {
  63             "type": "function",
  64             "name": "callback",
  65             "parameters": [
  66              {
  67                "name": "result",
  68                "$ref": "Entry",
  69                "optional": true,
  70                "description": "The entry that was removed or null if removal failed."
  71              }
  72             ]
  73           }
  74         ]
  75       },
  76       {
  77         "name": "getEntries",
  78         "type": "function",
  79         "description": "Gets all the entries currently stored in the reading list.",
  80         "parameters": [
  81           {
  82             "type": "function",
  83             "name": "callback",
  84             "parameters": [
  85              {
  86                "name": "result",
  87                "type": "array",
  88                "items": {"$ref": "Entry"}
  89              }
  90             ]
  91           }
  92         ]
  93       }
  94     ]
  95   }
  96 ]