| blob | 73782c59b662caeacff941af0fd21fedfa78a66f |
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 [
6 {
7 "namespace": "devtools.inspectedWindow",
8 "description": "Use the <code>chrome.devtools.inspectedWindow</code> API to interact with the inspected window: obtain the tab ID for the inspected page, evaluate the code in the context of the inspected window, reload the page, or obtain the list of resources within the page.",
9 "nocompile": true,
10 "types": [
11 {
12 "id": "Resource",
13 "type": "object",
14 "description": "A resource within the inspected page, such as a document, a script, or an image.",
15 "properties": {
16 "url": {
17 "type": "string",
18 "description": "The URL of the resource."
19 }
20 },
21 "functions": [
22 {
23 "name": "getContent",
24 "type": "function",
25 "description": "Gets the content of the resource.",
26 "parameters": [
27 {
28 "name": "callback",
29 "type": "function",
30 "description": "A function that receives resource content when the request completes.",
31 "parameters": [
32 {
33 "name": "content",
34 "type": "string",
35 "description": "Content of the resource (potentially encoded)."
36 },
37 {
38 "name": "encoding",
39 "type": "string",
40 "description": "Empty if content is not encoded, encoding name otherwise. Currently, only base64 is supported."
41 }
42 ]
43 }
44 ]
45 },
46 {
47 "name": "setContent",
48 "type": "function",
49 "description": "Sets the content of the resource.",
50 "parameters": [
51 {
52 "name": "content",
53 "type": "string",
54 "description": "New content of the resource. Only resources with the text type are currently supported."
55 },
56 {
57 "name": "commit",
58 "type": "boolean",
59 "description": "True if the user has finished editing the resource, and the new content of the resource should be persisted; false if this is a minor change sent in progress of the user editing the resource."
60 },
61 {
62 "name": "callback",
63 "type": "function",
64 "description": "A function called upon request completion.",
65 "optional": true,
66 "parameters": [
67 {
68 "name": "error",
69 "type": "object",
70 "additionalProperties": {"type": "any"},
71 "optional": true,
72 "description": "Set to undefined if the resource content was set successfully; describes error otherwise."
73 }
74 ]
75 }
76 ]
77 }
78 ]
79 }
80 ],
81 "properties": {
82 "tabId": {
83 "description": "The ID of the tab being inspected. This ID may be used with chrome.tabs.* API.",
84 "type": "integer"
85 }
86 },
87 "functions": [
88 {
89 "name": "eval",
90 "type": "function",
91 "description": "Evaluates a JavaScript expression in the context of the main frame of the inspected page. The expression must evaluate to a JSON-compliant object, otherwise an exception is thrown. The eval function can report either a DevTools-side error or a JavaScript exception that occurs during evaluation. In either case, the <code>result</code> parameter of the callback is <code>undefined</code>. In the case of a DevTools-side error, the <code>isException</code> parameter is non-null and has <code>isError</code> set to true and <code>code</code> set to an error code. In the case of a JavaScript error, <code>isException</code> is set to true and <code>value</code> is set to the string value of thrown object.",
92 "parameters": [
93 {
94 "name": "expression",
95 "type": "string",
96 "description": "An expression to evaluate."
97 },
98 {
99 "name": "options",
100 "type": "object",
101 "optional": true,
102 "description": "The options parameter can contain one or more options.",
103 "properties": {
104 "frameURL": {
105 "type": "string",
106 "optional": true,
107 "description": "If specified, the expression is evaluated on the iframe whose URL matches the one specified. By default, the expression is evaluated in the top frame of the inspected page."
108 },
109 "useContentScriptContext": {
110 "type": "boolean",
111 "optional": true,
112 "description": "Evaluate the expression in the context of the content script of the calling extension, provided that the content script is already injected into the inspected page. If not, the expression is not evaluated and the callback is invoked with the exception parameter set to an object that has the <code>isError</code> field set to true and the <code>code</code> field set to <code>E_NOTFOUND</code>."
113 },
114 "contextSecurityOrigin": {
115 "type": "string",
116 "optional": true,
117 "description": "Evaluate the expression in the context of a content script of an extension that matches the specified origin. If given, contextSecurityOrigin overrides the 'true' setting on userContentScriptContext."
118 }
119 }
120 },
121 {
122 "name": "callback",
123 "type": "function",
124 "description": "A function called when evaluation completes.",
125 "optional": true,
126 "parameters": [
127 {
128 "name": "result",
129 "type": "object",
130 "additionalProperties": {"type": "any"},
131 "description": "The result of evaluation."
132 },
133 {
134 "name": "exceptionInfo",
135 "type": "object",
136 "description": "An object providing details if an exception occurred while evaluating the expression.",
137 "properties": {
138 "isError": {
139 "type": "boolean",
140 "description": "Set if the error occurred on the DevTools side before the expression is evaluated."
141 },
142 "code": {
143 "type": "string",
144 "description": "Set if the error occurred on the DevTools side before the expression is evaluated."
145 },
146 "description": {
147 "type": "string",
148 "description": "Set if the error occurred on the DevTools side before the expression is evaluated."
149 },
150 "details": {
151 "type": "array",
152 "items": { "type": "any" },
153 "description": "Set if the error occurred on the DevTools side before the expression is evaluated, contains the array of the values that may be substituted into the description string to provide more information about the cause of the error."
154 },
155 "isException": {
156 "type": "boolean",
157 "description": "Set if the evaluated code produces an unhandled exception."
158 },
159 "value": {
160 "type": "string",
161 "description": "Set if the evaluated code produces an unhandled exception."
162 }
163 }
164 }
165 ]
166 }
167 ]
168 },
169 {
170 "name": "reload",
171 "type": "function",
172 "description": "Reloads the inspected page.",
173 "parameters": [
174 {
175 "type": "object",
176 "name": "reloadOptions",
177 "optional": true,
178 "properties": {
179 "ignoreCache": {
180 "type": "boolean",
181 "optional": true,
182 "description": "When true, the loader will ignore the cache for all inspected page resources loaded before the <code>load</code> event is fired. The effect is similar to pressing Ctrl+Shift+R in the inspected window or within the Developer Tools window."
183 },
184 "userAgent": {
185 "type": "string",
186 "optional": true,
187 "description": "If specified, the string will override the value of the <code>User-Agent</code> HTTP header that's sent while loading the resources of the inspected page. The string will also override the value of the <code>navigator.userAgent</code> property that's returned to any scripts that are running within the inspected page."
188 },
189 "injectedScript": {
190 "type": "string",
191 "optional": true,
192 "description": "If specified, the script will be injected into every frame of the inspected page immediately upon load, before any of the frame's scripts. The script will not be injected after subsequent reloads—for example, if the user presses Ctrl+R."
193 },
194 "preprocessorScript": {
195 "type": "string",
196 "deprecated": "Please avoid using this parameter, it will be removed soon.",
197 "optional": true,
198 "description": "If specified, this script evaluates into a function that accepts three string arguments: the source to preprocess, the URL of the source, and a function name if the source is an DOM event handler. The preprocessorerScript function should return a string to be compiled by Chrome in place of the input source. In the case that the source is a DOM event handler, the returned source must compile to a single JS function."
199 }
200 }
201 }
202 ]
203 },
204 {
205 "name": "getResources",
206 "type": "function",
207 "description": "Retrieves the list of resources from the inspected page.",
208 "parameters": [
209 {
210 "name": "callback",
211 "type": "function",
212 "description": "A function that receives the list of resources when the request completes.",
213 "parameters": [
214 {
215 "name": "resources",
216 "type": "array",
217 "items": { "$ref": "Resource" },
218 "description": "The resources within the page."
219 }
220 ]
221 }
222 ]
223 }
224 ],
225 "events": [
226 {
227 "name": "onResourceAdded",
228 "description": "Fired when a new resource is added to the inspected page.",
229 "parameters": [
230 {
231 "name": "resource",
232 "$ref": "Resource"
233 }
234 ]
235 },
236 {
237 "name": "onResourceContentCommitted",
238 "description": "Fired when a new revision of the resource is committed (e.g. user saves an edited version of the resource in the Developer Tools).",
239 "parameters": [
240 {
241 "name": "resource",
242 "$ref": "Resource"
243 },
244 {
245 "name": "content",
246 "type": "string",
247 "description": "New content of the resource."
248 }
249 ]
250 }
251 ]
252 }
253 ]