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
|
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
[
{
"namespace": "extension",
"allowedContexts": ["content", "devtools"],
"description": "The <code>browser.extension</code> API has utilities that can be used by any extension page. It includes support for exchanging messages between an extension and its content scripts or between extensions, as described in detail in $(topic:messaging)[Message Passing].",
"properties": {
"lastError": {
"type": "object",
"optional": true,
"max_manifest_version": 2,
"deprecated": "Please use $(ref:runtime.lastError).",
"allowedContexts": ["content", "devtools"],
"description": "Set for the lifetime of a callback if an ansychronous extension api has resulted in an error. If no error has occured lastError will be <var>undefined</var>.",
"properties": {
"message": {
"type": "string",
"description": "Description of the error that has taken place."
}
},
"additionalProperties": {
"type": "any"
}
},
"inIncognitoContext": {
"type": "boolean",
"optional": true,
"allowedContexts": ["content", "devtools"],
"description": "True for content scripts running inside incognito tabs, and for extension pages running inside an incognito process. The latter only applies to extensions with 'split' incognito_behavior."
}
},
"types": [
{
"id": "ViewType",
"type": "string",
"enum": ["tab", "popup", "sidebar"],
"description": "The type of extension view."
}
],
"functions": [
{
"name": "getURL",
"type": "function",
"deprecated": "Please use $(ref:runtime.getURL).",
"max_manifest_version": 2,
"allowedContexts": ["content", "devtools"],
"description": "Converts a relative path within an extension install directory to a fully-qualified URL.",
"parameters": [
{
"type": "string",
"name": "path",
"description": "A path to a resource within an extension expressed relative to its install directory."
}
],
"returns": {
"type": "string",
"description": "The fully-qualified URL to the resource."
}
},
{
"name": "getViews",
"type": "function",
"description": "Returns an array of the JavaScript 'window' objects for each of the pages running inside the current extension.",
"parameters": [
{
"type": "object",
"name": "fetchProperties",
"optional": true,
"properties": {
"type": {
"$ref": "ViewType",
"optional": true,
"description": "The type of view to get. If omitted, returns all views (including background pages and tabs). Valid values: 'tab', 'popup', 'sidebar'."
},
"windowId": {
"type": "integer",
"optional": true,
"description": "The window to restrict the search to. If omitted, returns all views."
},
"tabId": {
"type": "integer",
"optional": true,
"description": "Find a view according to a tab id. If this field is omitted, returns all views."
}
}
}
],
"returns": {
"type": "array",
"description": "Array of global objects",
"items": {
"type": "object",
"isInstanceOf": "Window",
"additionalProperties": { "type": "any" }
}
}
},
{
"name": "getBackgroundPage",
"type": "function",
"description": "Returns the JavaScript 'window' object for the background page running inside the current extension. Returns null if the extension has no background page.",
"parameters": [],
"returns": {
"type": "object",
"optional": true,
"isInstanceOf": "Window",
"additionalProperties": { "type": "any" }
}
},
{
"name": "isAllowedIncognitoAccess",
"type": "function",
"description": "Retrieves the state of the extension's access to Incognito-mode (as determined by the user-controlled 'Allowed in Incognito' checkbox.",
"async": "callback",
"parameters": [
{
"type": "function",
"name": "callback",
"parameters": [
{
"name": "isAllowedAccess",
"type": "boolean",
"description": "True if the extension has access to Incognito mode, false otherwise."
}
]
}
]
},
{
"name": "isAllowedFileSchemeAccess",
"type": "function",
"description": "Retrieves the state of the extension's access to the 'file://' scheme (as determined by the user-controlled 'Allow access to File URLs' checkbox.",
"async": "callback",
"parameters": [
{
"type": "function",
"name": "callback",
"parameters": [
{
"name": "isAllowedAccess",
"type": "boolean",
"description": "True if the extension can access the 'file://' scheme, false otherwise."
}
]
}
]
},
{
"name": "setUpdateUrlData",
"unsupported": true,
"type": "function",
"description": "Sets the value of the ap CGI parameter used in the extension's update URL. This value is ignored for extensions that are hosted in the browser vendor's store.",
"parameters": [{ "type": "string", "name": "data", "maxLength": 1024 }]
}
],
"events": [
{
"name": "onRequest",
"unsupported": true,
"deprecated": "Please use $(ref:runtime.onMessage).",
"type": "function",
"description": "Fired when a request is sent from either an extension process or a content script.",
"parameters": [
{
"name": "request",
"type": "any",
"optional": true,
"description": "The request sent by the calling script."
},
{ "name": "sender", "$ref": "runtime.MessageSender" },
{
"name": "sendResponse",
"type": "function",
"description": "Function to call (at most once) when you have a response. The argument should be any JSON-ifiable object, or undefined if there is no response. If you have more than one <code>onRequest</code> listener in the same document, then only one may send a response."
}
]
},
{
"name": "onRequestExternal",
"unsupported": true,
"deprecated": "Please use $(ref:runtime.onMessageExternal).",
"type": "function",
"description": "Fired when a request is sent from another extension.",
"parameters": [
{
"name": "request",
"type": "any",
"optional": true,
"description": "The request sent by the calling script."
},
{ "name": "sender", "$ref": "runtime.MessageSender" },
{
"name": "sendResponse",
"type": "function",
"description": "Function to call when you have a response. The argument should be any JSON-ifiable object, or undefined if there is no response."
}
]
}
]
}
]
|
