summaryrefslogtreecommitdiffstats
path: root/comm/mail/components/extensions/schemas/sessions.json
blob: 3c2fdff16576c6a1b2c6648c2ba118f82c4c1dc5 (plain)
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
[
  {
    "namespace": "sessions",
    "functions": [
      {
        "name": "setTabValue",
        "type": "function",
        "description": "Store a key/value pair associated with a given tab.",
        "async": true,
        "parameters": [
          {
            "name": "tabId",
            "type": "integer",
            "description": "ID of the tab with which you want to associate the data. Error is thrown if ID is invalid."
          },
          {
            "name": "key",
            "type": "string",
            "description": "Key that you can later use to retrieve this particular data value."
          },
          {
            "name": "value",
            "type": "string"
          }
        ]
      },
      {
        "name": "getTabValue",
        "type": "function",
        "description": "Retrieve a previously stored value for a given tab, given its key.",
        "async": "callback",
        "parameters": [
          {
            "name": "tabId",
            "type": "integer",
            "description": "ID of the tab whose data you are trying to retrieve. Error is thrown if ID is invalid."
          },
          {
            "name": "key",
            "type": "string",
            "description": "Key identifying the particular value to retrieve."
          },
          {
            "type": "function",
            "name": "callback",
            "optional": true,
            "parameters": [
              {
                "type": "string",
                "optional": true
              }
            ]
          }
        ]
      },
      {
        "name": "removeTabValue",
        "type": "function",
        "description": "Remove a key/value pair from a given tab.",
        "async": true,
        "parameters": [
          {
            "name": "tabId",
            "type": "integer",
            "description": "ID of the tab whose data you are trying to remove. Error is thrown if ID is invalid."
          },
          {
            "name": "key",
            "type": "string",
            "description": "Key identifying the particular value to remove."
          }
        ]
      }
    ]
  }
]