summaryrefslogtreecommitdiffstats
path: root/toolkit/components/extensions/schemas/contextual_identities.json
blob: 315270ef20bfbe280391c2e6ace76cb81ce61acd (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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
[
  {
    "namespace": "manifest",
    "types": [
      {
        "$extend": "PermissionNoPrompt",
        "choices": [
          {
            "type": "string",
            "enum": ["contextualIdentities"]
          }
        ]
      }
    ]
  },
  {
    "namespace": "contextualIdentities",
    "description": "Use the <code>browser.contextualIdentities</code> API to query and modify contextual identity, also called as containers.",
    "permissions": ["contextualIdentities"],
    "types": [
      {
        "id": "ContextualIdentity",
        "type": "object",
        "description": "Represents information about a contextual identity.",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the contextual identity."
          },
          "icon": {
            "type": "string",
            "description": "The icon name of the contextual identity."
          },
          "iconUrl": {
            "type": "string",
            "description": "The icon url of the contextual identity."
          },
          "color": {
            "type": "string",
            "description": "The color name of the contextual identity."
          },
          "colorCode": {
            "type": "string",
            "description": "The color hash of the contextual identity."
          },
          "cookieStoreId": {
            "type": "string",
            "description": "The cookie store ID of the contextual identity."
          }
        }
      }
    ],
    "functions": [
      {
        "name": "get",
        "type": "function",
        "description": "Retrieves information about a single contextual identity.",
        "async": true,
        "parameters": [
          {
            "type": "string",
            "name": "cookieStoreId",
            "description": "The ID of the contextual identity cookie store. "
          }
        ]
      },
      {
        "name": "query",
        "type": "function",
        "description": "Retrieves all contextual identities",
        "async": true,
        "parameters": [
          {
            "type": "object",
            "name": "details",
            "description": "Information to filter the contextual identities being retrieved.",
            "properties": {
              "name": {
                "type": "string",
                "optional": true,
                "description": "Filters the contextual identity by name."
              }
            }
          }
        ]
      },
      {
        "name": "create",
        "type": "function",
        "description": "Creates a contextual identity with the given data.",
        "async": true,
        "parameters": [
          {
            "type": "object",
            "name": "details",
            "description": "Details about the contextual identity being created.",
            "properties": {
              "name": {
                "type": "string",
                "optional": false,
                "description": "The name of the contextual identity."
              },
              "color": {
                "type": "string",
                "optional": false,
                "description": "The color of the contextual identity."
              },
              "icon": {
                "type": "string",
                "optional": false,
                "description": "The icon of the contextual identity."
              }
            }
          }
        ]
      },
      {
        "name": "update",
        "type": "function",
        "description": "Updates a contextual identity with the given data.",
        "async": true,
        "parameters": [
          {
            "type": "string",
            "name": "cookieStoreId",
            "description": "The ID of the contextual identity cookie store. "
          },
          {
            "type": "object",
            "name": "details",
            "description": "Details about the contextual identity being created.",
            "properties": {
              "name": {
                "type": "string",
                "optional": true,
                "description": "The name of the contextual identity."
              },
              "color": {
                "type": "string",
                "optional": true,
                "description": "The color of the contextual identity."
              },
              "icon": {
                "type": "string",
                "optional": true,
                "description": "The icon of the contextual identity."
              }
            }
          }
        ]
      },
      {
        "name": "move",
        "type": "function",
        "description": "Reorder one or more contextual identities by their cookieStoreIDs to a given position.",
        "async": true,
        "parameters": [
          {
            "name": "cookieStoreIds",
            "description": "The ID or list of IDs of the contextual identity cookie stores. ",
            "choices": [
              { "type": "string" },
              { "type": "array", "items": { "type": "string" } }
            ]
          },
          {
            "type": "integer",
            "name": "position",
            "description": "The position the contextual identity should move to."
          }
        ]
      },
      {
        "name": "remove",
        "type": "function",
        "description": "Deletes a contextual identity by its cookie Store ID.",
        "async": true,
        "parameters": [
          {
            "type": "string",
            "name": "cookieStoreId",
            "description": "The ID of the contextual identity cookie store. "
          }
        ]
      }
    ],
    "events": [
      {
        "name": "onUpdated",
        "type": "function",
        "description": "Fired when a container is updated.",
        "parameters": [
          {
            "type": "object",
            "name": "changeInfo",
            "properties": {
              "contextualIdentity": {
                "$ref": "ContextualIdentity",
                "description": "Contextual identity that has been updated"
              }
            }
          }
        ]
      },
      {
        "name": "onCreated",
        "type": "function",
        "description": "Fired when a new container is created.",
        "parameters": [
          {
            "type": "object",
            "name": "changeInfo",
            "properties": {
              "contextualIdentity": {
                "$ref": "ContextualIdentity",
                "description": "Contextual identity that has been created"
              }
            }
          }
        ]
      },
      {
        "name": "onRemoved",
        "type": "function",
        "description": "Fired when a container is removed.",
        "parameters": [
          {
            "type": "object",
            "name": "changeInfo",
            "properties": {
              "contextualIdentity": {
                "$ref": "ContextualIdentity",
                "description": "Contextual identity that has been removed"
              }
            }
          }
        ]
      }
    ]
  }
]