ZotShelf_plugin/schema.json at main · oyvindbso/ZotShelf_plugin · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
{
    "types": {
      "Item": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "title": {
            "type": "string"
          },
          "contentType": {
            "type": "string"
          }
        }
      }
    },
    "functions": {
      "getEpubItems": {
        "description": "Get EPUB items from Zotero",
        "async": true,
        "parameters": [
          {
            "name": "collectionID",
            "type": "string",
            "optional": true
          }
        ],
        "returns": {
          "type": "array",
          "items": {
            "$ref": "Item"
          }
        }
      },
      "openEpubItem": {
        "description": "Open an EPUB in Zotero reader",
        "async": true,
        "parameters": [
          {
            "name": "itemID",
            "type": "number"
          }
        ],
        "returns": {
          "type": "boolean"
        }
      },
      "getCachedCover": {
        "description": "Get cached cover for an item",
        "async": false,
        "parameters": [
          {
            "name": "itemID",
            "type": "number"
          }
        ],
        "returns": {
          "type": "string"
        }
      },
      "cacheCover": {
        "description": "Cache a cover for an item",
        "async": false,
        "parameters": [
          {
            "name": "itemID",
            "type": "number"
          },
          {
            "name": "coverData",
            "type": "string"
          }
        ],
        "returns": {
          "type": "boolean"
        }
      },
      "setCollection": {
        "description": "Set the current collection filter",
        "async": false,
        "parameters": [
          {
            "name": "collectionID",
            "type": "string"
          }
        ],
        "returns": {
          "type": "boolean"
        }
      }
    }
  }