summaryrefslogtreecommitdiffstats
path: root/toolkit/components/extensions/schemas/user_scripts_content.json
blob: 252336c4231bde6d08dbdbe7846978c6b7072185 (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
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

[
  {
    "namespace": "userScripts",
    "max_manifest_version": 2,
    "permissions": ["manifest:user_scripts"],
    "allowedContexts": ["content"],
    "events": [
      {
        "name": "onBeforeScript",
        "permissions": ["manifest:user_scripts.api_script"],
        "allowedContexts": ["content", "content_only"],
        "type": "function",
        "description": "Event called when a new userScript global has been created",
        "parameters": [
          {
            "type": "object",
            "name": "userScript",
            "properties": {
              "metadata": {
                "type": "any",
                "description": "The userScript metadata (as set in userScripts.register)"
              },
              "global": {
                "type": "any",
                "description": "The userScript global"
              },
              "defineGlobals": {
                "type": "function",
                "description": "Exports all the properties of a given plain object as userScript globals",
                "parameters": [
                  {
                    "type": "object",
                    "name": "sourceObject",
                    "description": "A plain object whose properties are exported as userScript globals"
                  }
                ]
              },
              "export": {
                "type": "function",
                "description": "Convert a given value to make it accessible to the userScript code",
                "parameters": [
                  {
                    "type": "any",
                    "name": "value",
                    "description": "A value to convert into an object accessible to the userScript"
                  }
                ],
                "returns": {
                  "type": "any"
                }
              }
            }
          }
        ]
      }
    ]
  }
]