summaryrefslogtreecommitdiffstats
path: root/browser/components/extensions/schemas/commands.json
blob: 19e8e122f97f4764368513ee8310ddb5af506af8 (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
[
  {
    "namespace": "manifest",
    "types": [
      {
        "id": "KeyName",
        "type": "string",
        "format": "manifestShortcutKey"
      },
      {
        "$extend": "WebExtensionManifest",
        "properties": {
          "commands": {
            "type": "object",
            "optional": true,
            "additionalProperties": {
              "type": "object",
              "additionalProperties": { "$ref": "UnrecognizedProperty" },
              "properties": {
                "suggested_key": {
                  "type": "object",
                  "optional": true,
                  "properties": {
                    "default": {
                      "$ref": "KeyName",
                      "optional": true
                    },
                    "mac": {
                      "$ref": "KeyName",
                      "optional": true
                    },
                    "linux": {
                      "$ref": "KeyName",
                      "optional": true
                    },
                    "windows": {
                      "$ref": "KeyName",
                      "optional": true
                    },
                    "chromeos": {
                      "type": "string",
                      "optional": true
                    },
                    "android": {
                      "type": "string",
                      "optional": true
                    },
                    "ios": {
                      "type": "string",
                      "optional": true
                    },
                    "additionalProperties": {
                      "type": "string",
                      "deprecated": "Unknown platform name",
                      "optional": true
                    }
                  }
                },
                "description": {
                  "type": "string",
                  "preprocess": "localize",
                  "optional": true
                }
              }
            }
          }
        }
      }
    ]
  },
  {
    "namespace": "commands",
    "description": "Use the commands API to add keyboard shortcuts that trigger actions in your extension, for example, an action to open the browser action or send a command to the xtension.",
    "permissions": ["manifest:commands"],
    "types": [
      {
        "id": "Command",
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "optional": true,
            "description": "The name of the Extension Command"
          },
          "description": {
            "type": "string",
            "optional": true,
            "description": "The Extension Command description"
          },
          "shortcut": {
            "type": "string",
            "optional": true,
            "description": "The shortcut active for this command, or blank if not active."
          }
        }
      }
    ],
    "events": [
      {
        "name": "onCommand",
        "description": "Fired when a registered command is activated using a keyboard shortcut.",
        "type": "function",
        "parameters": [
          {
            "name": "command",
            "type": "string"
          }
        ]
      },
      {
        "name": "onChanged",
        "description": "Fired when a registered command's shortcut is changed.",
        "type": "function",
        "parameters": [
          {
            "type": "object",
            "name": "changeInfo",
            "properties": {
              "name": {
                "type": "string",
                "description": "The name of the shortcut."
              },
              "newShortcut": {
                "type": "string",
                "description": "The new shortcut active for this command, or blank if not active."
              },
              "oldShortcut": {
                "type": "string",
                "description": "The old shortcut which is no longer active for this command, or blank if the shortcut was previously inactive."
              }
            }
          }
        ]
      }
    ],
    "functions": [
      {
        "name": "update",
        "type": "function",
        "async": true,
        "description": "Update the details of an already defined command.",
        "parameters": [
          {
            "type": "object",
            "name": "detail",
            "description": "The new description for the command.",
            "properties": {
              "name": {
                "type": "string",
                "description": "The name of the command."
              },
              "description": {
                "type": "string",
                "optional": true,
                "description": "The new description for the command."
              },
              "shortcut": {
                "type": "string",
                "format": "manifestShortcutKeyOrEmpty",
                "optional": true
              }
            }
          }
        ]
      },
      {
        "name": "reset",
        "type": "function",
        "async": true,
        "description": "Reset a command's details to what is specified in the manifest.",
        "parameters": [
          {
            "type": "string",
            "name": "name",
            "description": "The name of the command."
          }
        ]
      },
      {
        "name": "getAll",
        "type": "function",
        "async": "callback",
        "description": "Returns all the registered extension commands for this extension and their shortcut (if active).",
        "parameters": [
          {
            "type": "function",
            "name": "callback",
            "optional": true,
            "parameters": [
              {
                "name": "commands",
                "type": "array",
                "items": {
                  "$ref": "Command"
                }
              }
            ],
            "description": "Called to return the registered commands."
          }
        ]
      }
    ]
  }
]