| blob | e30cabdccad38e10a1c7f2ec4d0abc18a13f36dc |
1 {
2 "compatible": [],
3 "domains" : [{
4 "domain": "Inspector",
5 "hidden": true,
6 "types": [],
7 "commands": [
8 ],
9 "events": [
10 {
11 "name": "frontendReused"
12 },
13 {
14 "name": "bringToFront"
15 },
16 {
17 "name": "disconnectFromBackend"
18 },
19 {
20 "name": "reset"
21 },
22 {
23 "name": "showPanel",
24 "parameters": [
25 { "name": "panel", "type": "string" }
26 ]
27 },
28 {
29 "name": "startUserInitiatedDebugging"
30 },
31 {
32 "name": "evaluateForTestInFrontend",
33 "parameters": [
34 { "name": "testCallId", "type": "integer" },
35 { "name": "script", "type": "string" }
36 ]
37 },
38 {
39 "name": "inspect",
40 "parameters": [
41 { "name": "object", "$ref": "Runtime.RemoteObject" },
42 { "name": "hints", "type": "object" }
43 ]
44 },
45 {
46 "name": "didCreateWorker",
47 "parameters": [
48 { "name": "id", "type": "integer" },
49 { "name": "url", "type": "string" },
50 { "name": "isShared", "type": "boolean" }
51 ]
52 },
53 {
54 "name": "didDestroyWorker",
55 "parameters": [
56 { "name": "id", "type": "integer" }
57 ]
58 }
59 ]
60 },
61 {
62 "domain": "Page",
63 "description": "Actions and events related to the inspected page belong to the page domain.",
64 "types": [
65 {
66 "id": "ResourceType",
67 "type": "string",
68 "enum": ["Document", "Stylesheet", "Image", "Font", "Script", "XHR", "WebSocket", "Other"],
69 "description": "Resource type as it was perceived by the rendering engine."
70 },
71 {
72 "id": "Frame",
73 "type": "object",
74 "description": "Information about the Frame on the page.",
75 "properties": [
76 { "name": "id", "type": "string", "description": "Frame unique identifier." },
77 { "name": "parentId", "type": "string", "optional": true, "description": "Parent frame identifier." },
78 { "name": "loaderId", "$ref": "Network.LoaderId", "description": "Identifier of the loader associated with this frame." },
79 { "name": "name", "type": "string", "optional": true, "description": "Frame's name as specified in the tag." },
80 { "name": "url", "type": "string", "description": "Frame document's URL." },
81 { "name": "mimeType", "type": "string", "description": "Frame document's mimeType as determined by the browser." }
82 ],
83 "hidden": true
84 },
85 {
86 "id": "FrameResourceTree",
87 "type": "object",
88 "description": "Information about the Frame hierarchy along with their cached resources.",
89 "properties": [
90 { "name": "frame", "$ref": "Frame", "description": "Frame information for this tree item." },
91 { "name": "childFrames", "type": "array", "optional": true, "items": { "$ref": "FrameResourceTree" }, "description": "Child frames." },
92 { "name": "resources", "type": "array",
93 "items": {
94 "type": "object",
95 "properties": [
96 { "name": "url", "type": "string", "description": "Resource URL." },
97 { "name": "type", "$ref": "ResourceType", "description": "Type of this resource." },
98 { "name": "mimeType", "type": "string", "description": "Resource mimeType as determined by the browser." }
99 ]
100 },
101 "description": "Information about frame resources."
102 }
103 ],
104 "hidden": true
105 },
106 {
107 "id": "SearchResult",
108 "type": "object",
109 "description": "Search result for resource.",
110 "properties": [
111 { "name": "url", "type": "string", "description": "Resource URL." },
112 { "name": "frameId", "type": "string", "description": "Resource frame id." },
113 { "name": "matchesCount", "type": "number", "description": "Number of matches in the resource content." }
114 ],
115 "hidden": true
116 }
117 ],
118 "commands": [
119 {
120 "name": "enable",
121 "description": "Enables page domain notifications."
122 },
123 {
124 "name": "disable",
125 "description": "Disables page domain notifications."
126 },
127 {
128 "name": "addScriptToEvaluateOnLoad",
129 "parameters": [
130 { "name": "scriptSource", "type": "string" }
131 ],
132 "hidden": true
133 },
134 {
135 "name": "removeAllScriptsToEvaluateOnLoad",
136 "hidden": true
137 },
138 {
139 "name": "reload",
140 "parameters": [
141 { "name": "ignoreCache", "type": "boolean", "optional": true, "description": "If true, browser cache is ignored (as if the user pressed Shift+refresh)." }
142 ],
143 "description": "Reloads given page optionally ignoring the cache."
144 },
145 {
146 "name": "open",
147 "parameters": [
148 { "name": "url", "type": "string", "description": "URL to open." },
149 { "name": "newWindow", "optional": true, "type": "boolean", "description": "If true, opens given URL in a new window or tab." }
150 ],
151 "description": "Opens given URL either in the inspected page or in a new tab / window.",
152 "hidden": true
153 },
154 {
155 "name": "getCookies",
156 "returns": [
157 { "name": "cookies", "type": "array", "items": { "$ref": "Cookie"}, "description": "Array of cookie objects." },
158 { "name": "cookiesString", "type": "string", "description": "document.cookie string representation of the cookies." }
159 ],
160 "description": "Returns all browser cookies. Depending on the backend support, will either return detailed cookie information in the <code>cookie</code> field or string cookie representation using <code>cookieString</code>.",
161 "hidden": true
162 },
163 {
164 "name": "deleteCookie",
165 "parameters": [
166 { "name": "cookieName", "type": "string", "description": "Name of the cookie to remove." },
167 { "name": "domain", "type": "string", "description": "Domain of the cookie to remove." }
168 ],
169 "description": "Deletes browser cookie with given name for the given domain.",
170 "hidden": true
171 },
172 {
173 "name": "getResourceTree",
174 "description": "Returns present frame / resource tree structure.",
175 "returns": [
176 { "name": "frameTree", "$ref": "FrameResourceTree", "description": "Present frame / resource tree structure." }
177 ],
178 "hidden": true
179 },
180 {
181 "name": "getResourceContent",
182 "description": "Returns content of the given resource.",
183 "parameters": [
184 { "name": "frameId", "type": "string", "description": "Frame id to get resource for." },
185 { "name": "url", "type": "string", "description": "URL of the resource to get content for." }
186 ],
187 "returns": [
188 { "name": "content", "type": "string", "description": "Resource content." },
189 { "name": "base64Encoded", "type": "boolean", "description": "True, if content was served as base64." }
190 ],
191 "hidden": true
192 },
193 {
194 "name": "searchInResources",
195 "description": "Searches for given string in frame / resource tree structure.",
196 "parameters": [
197 { "name": "text", "type": "string", "description": "String to search for." },
198 { "name": "caseSensitive", "type": "boolean", "optional": true, "description": "If true, search is case sensitive." },
199 { "name": "isRegex", "type": "boolean", "optional": true, "description": "If true, treats string parameter as regex." }
200 ],
201 "returns": [
202 { "name": "result", "type": "array", "items": { "$ref": "SearchResult" }, "description": "List of search results." }
203 ],
204 "hidden": true
205 }
206 ],
207 "events": [
208 {
209 "name": "domContentEventFired",
210 "parameters": [
211 { "name": "timestamp", "type": "number" }
212 ]
213 },
214 {
215 "name": "loadEventFired",
216 "parameters": [
217 { "name": "timestamp", "type": "number" }
218 ]
219 },
220 {
221 "name": "frameNavigated",
222 "description": "Fired once navigation of the frame has completed. Frame is now associated with the new loader.",
223 "parameters": [
224 { "name": "frame", "$ref": "Frame", "description": "Frame object." },
225 { "name": "loaderId", "$ref": "Network.LoaderId", "description": "Loader identifier." }
226 ],
227 "hidden": true
228 },
229 {
230 "name": "frameDetached",
231 "description": "Fired when frame has been detached from its parent.",
232 "parameters": [
233 { "name": "frameId", "type": "string", "description": "Id of the frame that has been detached." }
234 ],
235 "hidden": true
236 }
237 ]
238 },
239 {
240 "domain": "Runtime",
241 "description": "Runtime domain exposes JavaScript runtime by means of remote evaluation and mirror objects. Evaluation results are returned as mirror object that expose object type, string representation and unique identifier that can be used for further object reference. Original objects are maintained in memory unless they are either explicitly released or are released along with the other objects in their object group.",
242 "types": [
243 {
244 "id": "RemoteObjectId",
245 "type": "string",
246 "description": "Unique object identifier."
247 },
248 {
249 "id": "RemoteObject",
250 "type": "object",
251 "description": "Mirror object referencing original JavaScript object.",
252 "properties": [
253 { "name": "type", "type": "string", "enum": ["object", "function", "undefined", "string", "number", "boolean"], "description": "Object type." },
254 { "name": "subtype", "type": "string", "optional": true, "enum": ["array", "null", "node", "regexp", "date"], "description": "Object subtype hint. Specified for <code>object</code> type values only." },
255 { "name": "className", "type": "string", "optional": true, "description": "Object class (constructor) name. Specified for <code>object</code> type values only." },
256 { "name": "value", "type": "any", "optional": true, "description": "Remote object value (in case of primitive values or JSON values if it was requested)." },
257 { "name": "description", "type": "string", "optional": true, "description": "String representation of the object." },
258 { "name": "objectId", "$ref": "RemoteObjectId", "optional": true, "description": "Unique object identifier (for non-primitive values)." }
259 ]
260 },
261 {
262 "id": "PropertyDescriptor",
263 "type": "object",
264 "description": "Object property descriptor.",
265 "properties": [
266 { "name": "name", "type": "string", "description": "Property name." },
267 { "name": "value", "$ref": "RemoteObject", "optional": true, "description": "The value associated with the property." },
268 { "name": "writable", "type": "boolean", "optional": true, "description": "True if the value associated with the property may be changed (data descriptors only)." },
269 { "name": "get", "$ref": "RemoteObject", "optional": true, "description": "A function which serves as a getter for the property, or <code>undefined</code> if there is no getter (accessor descriptors only)." },
270 { "name": "set", "$ref": "RemoteObject", "optional": true, "description": "A function which serves as a setter for the property, or <code>undefined</code> if there is no setter (accessor descriptors only)." },
271 { "name": "configurable", "type": "boolean", "description": "True if the type of this property descriptor may be changed and if the property may be deleted from the corresponding object." },
272 { "name": "enumerable", "type": "boolean", "description": "True if this property shows up during enumeration of the properties on the corresponding object." },
273 { "name": "wasThrown", "type": "boolean", "optional": true, "description": "True if the result was thrown during the evaluation." }
274 ]
275 },
276 {
277 "id": "CallArgument",
278 "type": "object",
279 "description": "Represents function call argument. Either remote object id <code>objectId</code> or primitive <code>value</code> or neither of (for undefined) them should be specified.",
280 "properties": [
281 { "name": "value", "type": "any", "optional": true, "description": "Primitive value." },
282 { "name": "objectId", "$ref": "RemoteObjectId", "optional": true, "description": "Remote object handle." }
283 ]
284 }
285 ],
286 "commands": [
287 {
288 "name": "evaluate",
289 "parameters": [
290 { "name": "expression", "type": "string", "description": "Expression to evaluate." },
291 { "name": "objectGroup", "type": "string", "optional": true, "description": "Symbolic group name that can be used to release multiple objects." },
292 { "name": "includeCommandLineAPI", "type": "boolean", "optional": true, "description": "Determines whether Command Line API should be available during the evaluation.", "hidden": true },
293 { "name": "doNotPauseOnExceptions", "type": "boolean", "optional": true, "description": "Specifies whether evaluation should stop on exceptions. Overrides setPauseOnException state.", "hidden": true },
294 { "name": "frameId", "type": "string", "optional": true, "description": "Specifies in which frame to perform evaluation.", "hidden": true },
295 { "name": "returnByValue", "type": "boolean", "optional": true, "description": "Whether the result is expected to be a JSON object that should be sent by value." }
296 ],
297 "returns": [
298 { "name": "result", "$ref": "RemoteObject", "description": "Evaluation result." },
299 { "name": "wasThrown", "type": "boolean", "optional": true, "description": "True if the result was thrown during the evaluation." }
300 ],
301 "description": "Evaluates expression on global object."
302 },
303 {
304 "name": "callFunctionOn",
305 "parameters": [
306 { "name": "objectId", "$ref": "RemoteObjectId", "description": "Identifier of the object to call function on." },
307 { "name": "functionDeclaration", "type": "string", "description": "Declaration of the function to call." },
308 { "name": "arguments", "type": "array", "items": { "$ref": "CallArgument", "description": "Call argument." }, "optional": true, "description": "Call arguments. All call arguments must belong to the same JavaScript world as the target object." },
309 { "name": "returnByValue", "type": "boolean", "optional": true, "description": "Whether the result is expected to be a JSON object which should be sent by value." }
310 ],
311 "returns": [
312 { "name": "result", "$ref": "RemoteObject", "description": "Call result." },
313 { "name": "wasThrown", "type": "boolean", "optional": true, "description": "True if the result was thrown during the evaluation." }
314 ],
315 "description": "Calls function with given declaration on the given object. Object group of the result is inherited from the target object."
316 },
317 {
318 "name": "getProperties",
319 "parameters": [
320 { "name": "objectId", "$ref": "RemoteObjectId", "description": "Identifier of the object to return properties for." },
321 { "name": "ownProperties", "optional": true, "type": "boolean", "description": "If true, returns properties belonging only to the element itself, not to its prototype chain." }
322 ],
323 "returns": [
324 { "name": "result", "type": "array", "items": { "$ref": "PropertyDescriptor"}, "description": "Object properties." }
325 ],
326 "description": "Returns properties of a given object. Object group of the result is inherited from the target object."
327 },
328 {
329 "name": "releaseObject",
330 "parameters": [
331 { "name": "objectId", "$ref": "RemoteObjectId", "description": "Identifier of the object to release." }
332 ],
333 "description": "Releases remote object with given id."
334 },
335 {
336 "name": "releaseObjectGroup",
337 "parameters": [
338 { "name": "objectGroup", "type": "string", "description": "Symbolic object group name." }
339 ],
340 "description": "Releases all remote objects that belong to a given group."
341 }
342 ]
343 },
344 {
345 "domain": "Console",
346 "description": "Console domain defines methods and events for interaction with the JavaScript console. Console collects messages created by means of the <a href='http://getfirebug.com/wiki/index.php/Console_API'>JavaScript Console API</a>. One needs to enable this domain using <code>enable</code> command in order to start receiving the console messages. Browser collects messages issued while console domain is not enabled as well and reports them using <code>messageAdded</code> notification upon enabling.",
347 "types": [
348 {
349 "id": "ConsoleMessage",
350 "type": "object",
351 "description": "Console message.",
352 "properties": [
353 { "name": "source", "type": "string", "enum": ["html", "wml", "xml", "javascript", "network", "console-api", "other"], "description": "Message source." },
354 { "name": "level", "type": "string", "enum": ["tip", "log", "warning", "error", "debug"], "description": "Message severity." },
355 { "name": "text", "type": "string", "description": "Message text." },
356 { "name": "type", "type": "string", "optional": true, "enum": ["log", "dir", "dirxml", "trace", "startGroup", "startGroupCollapsed", "endGroup", "assert"], "description": "Console message type." },
357 { "name": "url", "type": "string", "optional": true, "description": "URL of the message origin." },
358 { "name": "line", "type": "integer", "optional": true, "description": "Line number in the resource that generated this message." },
359 { "name": "repeatCount", "type": "integer", "optional": true, "description": "Repeat count for repeated messages." },
360 { "name": "networkRequestId", "$ref": "Network.RequestId", "optional": true, "description": "Identifier of the network request associated with this message." },
361 { "name": "parameters", "type": "array", "items": { "$ref": "Runtime.RemoteObject" }, "optional": true, "description": "Message parameters in case of the formatted message." },
362 { "name": "stackTrace", "$ref": "StackTrace", "optional": true, "description": "JavaScript stack trace for assertions and error messages." }
363 ]
364 },
365 {
366 "id": "CallFrame",
367 "type": "object",
368 "description": "Stack entry for console errors and assertions.",
369 "properties": [
370 { "name": "functionName", "type": "string", "description": "JavaScript function name." },
371 { "name": "url", "type": "string", "description": "JavaScript script name or url." },
372 { "name": "lineNumber", "type": "integer", "description": "JavaScript script line number." },
373 { "name": "columnNumber", "type": "integer", "description": "JavaScript script column number." }
374 ]
375 },
376 {
377 "id": "StackTrace",
378 "type": "array",
379 "items": { "$ref": "CallFrame" },
380 "description": "Call frames for assertions or error messages."
381 }
382 ],
383 "commands": [
384 {
385 "name": "enable",
386 "returns": [
387 { "name": "expiredMessagesCount", "type": "integer", "optional": true, "description": "Number of messages dropped due to message threashold overflow." }
388 ],
389 "description": "Enables console domain, sends the messages collected so far to the client by means of the <code>messageAdded</code> notification."
390 },
391 {
392 "name": "disable",
393 "description": "Disables console domain, prevents further console messages from being reported to the client."
394 },
395 {
396 "name": "clearMessages",
397 "description": "Clears console messages collected in the browser."
398 },
399 {
400 "name": "setMonitoringXHREnabled",
401 "parameters": [
402 { "name": "enabled", "type": "boolean", "description": "Monitoring enabled state." }
403 ],
404 "description": "Toggles monitoring of XMLHttpRequest. If <code>true</code>, console will receive messages upon each XHR issued.",
405 "hidden": true
406 },
407 {
408 "name": "addInspectedNode",
409 "parameters": [
410 { "name": "nodeId", "$ref": "DOM.NodeId", "description": "DOM node id to be accessible by means of $x command line API." }
411 ],
412 "description": "Enables console to refer to the node with given id via $x (see Command Line API for more details $x functions).",
413 "hidden": true
414 }
415 ],
416 "events": [
417 {
418 "name": "messageAdded",
419 "parameters": [
420 { "name": "message", "$ref": "ConsoleMessage", "description": "Console message that has been added." }
421 ],
422 "description": "Issued when new console message is added."
423 },
424 {
425 "name": "messageRepeatCountUpdated",
426 "parameters": [
427 { "name": "count", "type": "integer", "description": "New repeat count value." }
428 ],
429 "description": "Issued when subsequent message(s) are equal to the previous one(s)."
430 },
431 {
432 "name": "messagesCleared",
433 "description": "Issued when console is cleared. This happens either upon <code>clearMessages</code> command or after page navigation."
434 }
435 ]
436 },
437 {
438 "domain": "Network",
439 "description": "Network domain allows tracking network activities of the page. It exposes information about http, file, data and other requests and responses, their headers, bodies, timing, etc.",
440 "types": [
441 {
442 "id": "LoaderId",
443 "type": "string",
444 "description": "Unique loader identifier."
445 },
446 {
447 "id": "RequestId",
448 "type": "string",
449 "description": "Unique request identifier."
450 },
451 {
452 "id": "Timestamp",
453 "type": "number",
454 "description": "Number of seconds since epoch."
455 },
456 {
457 "id": "Headers",
458 "type": "object",
459 "description": "Request / response headers as keys / values of JSON object."
460 },
461 {
462 "id": "ResourceTiming",
463 "type": "object",
464 "description": "Timing information for the request.",
465 "properties": [
466 { "name": "requestTime", "type": "number", "description": "Timing's requestTime is a baseline in seconds, while the other numbers are ticks in milliseconds relatively to this requestTime." },
467 { "name": "proxyStart", "type": "number", "description": "Started resolving proxy." },
468 { "name": "proxyEnd", "type": "number", "description": "Finished resolving proxy." },
469 { "name": "dnsStart", "type": "number", "description": "Started DNS address resolve." },
470 { "name": "dnsEnd", "type": "number", "description": "Finished DNS address resolve." },
471 { "name": "connectStart", "type": "number", "description": "Started connecting to the remote host." },
472 { "name": "connectEnd", "type": "number", "description": "Connected to the remote host." },
473 { "name": "sslStart", "type": "number", "description": "Started SSL handshake." },
474 { "name": "sslEnd", "type": "number", "description": "Finished SSL handshake." },
475 { "name": "sendStart", "type": "number", "description": "Started sending request." },
476 { "name": "sendEnd", "type": "number", "description": "Finished sending request." },
477 { "name": "receiveHeadersEnd", "type": "number", "description": "Finished receiving response headers." }
478 ]
479 },
480 {
481 "id": "Request",
482 "type": "object",
483 "description": "HTTP request data.",
484 "properties": [
485 { "name": "url", "type": "string", "description": "Request URL." },
486 { "name": "method", "type": "string", "description": "HTTP request method." },
487 { "name": "headers", "$ref": "Headers", "description": "HTTP request headers." },
488 { "name": "postData", "type": "string", "optional": true, "description": "HTTP POST request data." }
489 ]
490 },
491 {
492 "id": "Response",
493 "type": "object",
494 "description": "HTTP response data.",
495 "properties": [
496 { "name": "url", "type": "string", "description": "Response URL." },
497 { "name": "status", "type": "number", "description": "HTTP response status code." },
498 { "name": "statusText", "type": "string", "description": "HTTP response status text." },
499 { "name": "headers", "$ref": "Headers", "description": "HTTP response headers." },
500 { "name": "headersText", "type": "string", "optional": true, "description": "HTTP response headers text." },
501 { "name": "mimeType", "type": "string", "description": "Resource mimeType as determined by the browser." },
502 { "name": "requestHeaders", "$ref": "Headers", "optional": true, "description": "Refined HTTP request headers that were actually transmitted over the network." },
503 { "name": "requestHeadersText", "type": "string", "optional": true, "description": "HTTP request headers text." },
504 { "name": "connectionReused", "type": "boolean", "description": "Specifies whether physical connection was actually reused for this request." },
505 { "name": "connectionId", "type": "number", "description": "Physical connection id that was actually used for this request." },
506 { "name": "fromDiskCache", "type": "boolean", "optional": true, "description": "Specifies that the request was served from the disk cache." },
507 { "name": "timing", "$ref": "ResourceTiming", "optional": true, "description": "Timing information for the given request." }
508 ]
509 },
510 {
511 "id": "CachedResource",
512 "type": "object",
513 "description": "Information about the cached resource.",
514 "properties": [
515 { "name": "url", "type": "string", "description": "Resource URL." },
516 { "name": "type", "$ref": "Page.ResourceType", "description": "Type of this resource." },
517 { "name": "response", "$ref": "Response", "optional": true, "description": "Cached response data." },
518 { "name": "bodySize", "type": "number", "description": "Cached response body size." }
519 ]
520 },
521 {
522 "id": "Initiator",
523 "type": "object",
524 "description": "Information about the request initiator.",
525 "properties": [
526 { "name": "type", "type": "string", "enum": ["parser", "script", "other"], "description": "Type of this initiator." },
527 { "name": "stackTrace", "$ref": "Console.StackTrace", "optional": true, "description": "Initiator JavaScript stack trace, set for Script only." },
528 { "name": "url", "type": "string", "optional": true, "description": "Initiator URL, set for Parser type only." },
529 { "name": "lineNumber", "type": "number", "optional": true, "description": "Initiator line number, set for Parser type only." }
530 ]
531 }
532 ],
533 "commands": [
534 {
535 "name": "enable",
536 "description": "Enables network tracking, network events will now be delivered to the client."
537 },
538 {
539 "name": "disable",
540 "description": "Disables network tracking, prevents network events from being sent to the client."
541 },
542 {
543 "name": "setUserAgentOverride",
544 "description": "Allows overriding user agent with the given string.",
545 "parameters": [
546 { "name": "userAgent", "type": "string", "description": "User agent to use." }
547 ]
548 },
549 {
550 "name": "setExtraHTTPHeaders",
551 "description": "Specifies whether to always send extra HTTP headers with the requests from this page.",
552 "parameters": [
553 { "name": "headers", "$ref": "Headers", "description": "Map with extra HTTP headers." }
554 ]
555 },
556 {
557 "name": "getResponseBody",
558 "description": "Returns content served for the given request.",
559 "parameters": [
560 { "name": "requestId", "$ref": "RequestId", "description": "Identifier of the network request to get content for." }
561 ],
562 "returns": [
563 { "name": "body", "type": "string", "description": "Response body." },
564 { "name": "base64Encoded", "type": "boolean", "description": "True, if content was sent as base64." }
565 ]
566 },
567 {
568 "name": "clearBrowserCache",
569 "description": "Clears browser cache."
570 },
571 {
572 "name": "clearBrowserCookies",
573 "description": "Clears browser cookies."
574 },
575 {
576 "name": "setCacheDisabled",
577 "parameters": [
578 { "name": "cacheDisabled", "type": "boolean", "description": "Cache disabled state." }
579 ],
580 "description": "Toggles ignoring cache for each request. If <code>true</code>, cache will not be used."
581 }
582 ],
583 "events": [
584 {
585 "name": "requestWillBeSent",
586 "description": "Fired when page is about to send HTTP request.",
587 "parameters": [
588 { "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
589 { "name": "frameId", "type": "string", "description": "Frame identifier.", "hidden": true },
590 { "name": "loaderId", "$ref": "LoaderId", "description": "Loader identifier." },
591 { "name": "documentURL", "type": "string", "description": "URL of the document this request is loaded for." },
592 { "name": "request", "$ref": "Request", "description": "Request data." },
593 { "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
594 { "name": "initiator", "$ref": "Initiator", "description": "Request initiator." },
595 { "name": "stackTrace", "$ref": "Console.StackTrace", "optional": true, "description": "JavaScript stack trace upon issuing this request." },
596 { "name": "redirectResponse", "optional": true, "$ref": "Response", "description": "Redirect response data." }
597 ]
598 },
599 {
600 "name": "requestServedFromCache",
601 "description": "Fired if request ended up loading from cache.",
602 "parameters": [
603 { "name": "requestId", "$ref": "RequestId", "description": "Request identifier." }
604 ]
605 },
606 {
607 "name": "responseReceived",
608 "description": "Fired when HTTP response is available.",
609 "parameters": [
610 { "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
611 { "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
612 { "name": "type", "$ref": "Page.ResourceType", "description": "Resource type." },
613 { "name": "response", "$ref": "Response", "description": "Response data." }
614 ]
615 },
616 {
617 "name": "dataReceived",
618 "description": "Fired when data chunk was received over the network.",
619 "parameters": [
620 { "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
621 { "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
622 { "name": "dataLength", "type": "integer", "description": "Data chunk length." },
623 { "name": "encodedDataLength", "type": "integer", "description": "Actual bytes received (might be less than dataLength for compressed encodings)." }
624 ]
625 },
626 {
627 "name": "loadingFinished",
628 "description": "Fired when HTTP request has finished loading.",
629 "parameters": [
630 { "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
631 { "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." }
632 ]
633 },
634 {
635 "name": "loadingFailed",
636 "description": "Fired when HTTP request has failed to load.",
637 "parameters": [
638 { "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
639 { "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
640 { "name": "errorText", "type": "string", "description": "User friendly error message." },
641 { "name": "canceled", "type": "boolean", "optional": true, "description": "True if loading was canceled." }
642 ]
643 },
644 {
645 "name": "requestServedFromMemoryCache",
646 "description": "Fired when HTTP request has been served from memory cache.",
647 "parameters": [
648 { "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
649 { "name": "frameId", "type": "string", "description": "Frame identifier.", "hidden": true },
650 { "name": "loaderId", "$ref": "LoaderId", "description": "Loader identifier." },
651 { "name": "documentURL", "type": "string", "description": "URL of the document this request is loaded for." },
652 { "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
653 { "name": "initiator", "$ref": "Initiator", "description": "Request initiator." },
654 { "name": "resource", "$ref": "CachedResource", "description": "Cached resource data." }
655 ]
656 },
657 {
658 "name": "webSocketWillSendHandshakeRequest",
659 "description": "Fired when WebSocket is about to initiate handshake.",
660 "parameters": [
661 { "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
662 { "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
663 { "name": "request", "type": "object", "description": "WebSocket request data." }
664 ],
665 "hidden": true
666 },
667 {
668 "name": "webSocketHandshakeResponseReceived",
669 "description": "Fired when WebSocket handshake response becomes available.",
670 "parameters": [
671 { "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
672 { "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
673 { "name": "response", "type": "object", "description": "WebSocket response data." }
674 ],
675 "hidden": true
676 },
677 {
678 "name": "webSocketCreated",
679 "description": "Fired upon WebSocket creation.",
680 "parameters": [
681 { "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
682 { "name": "url", "type": "string", "description": "WebSocket request URL." }
683 ],
684 "hidden": true
685 },
686 {
687 "name": "webSocketClosed",
688 "description": "Fired when WebSocket is closed.",
689 "parameters": [
690 { "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
691 { "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." }
692 ],
693 "hidden": true
694 }
695 ]
696 },
697 {
698 "domain": "Database",
699 "hidden": true,
700 "types": [
701 {
702 "id": "Database",
703 "type": "object",
704 "description": "Database object."
705 },
706 {
707 "id": "Error",
708 "type": "object",
709 "description": "Database error."
710 }
711 ],
712 "commands": [
713 {
714 "name": "enable",
715 "description": "Enables database tracking, database events will now be delivered to the client."
716 },
717 {
718 "name": "disable",
719 "description": "Disables database tracking, prevents database events from being sent to the client."
720 },
721 {
722 "name": "getDatabaseTableNames",
723 "parameters": [
724 { "name": "databaseId", "type": "integer" }
725 ],
726 "returns": [
727 { "name": "tableNames", "type": "array", "items": { "type": "string" } }
728 ]
729 },
730 {
731 "name": "executeSQL",
732 "parameters": [
733 { "name": "databaseId", "type": "integer" },
734 { "name": "query", "type": "string" }
735 ],
736 "returns": [
737 { "name": "success", "type": "boolean" },
738 { "name": "transactionId", "type": "integer" }
739 ]
740 }
741 ],
742 "events": [
743 {
744 "name": "addDatabase",
745 "parameters": [
746 { "name": "database", "$ref": "Database" }
747 ]
748 },
749 {
750 "name": "sqlTransactionSucceeded",
751 "parameters": [
752 { "name": "transactionId", "type": "integer" },
753 { "name": "columnNames", "type": "array", "items": { "type": "string" } },
754 { "name": "values", "type": "array", "items": { "type": "string or number" }}
755 ]
756 },
757 {
758 "name": "sqlTransactionFailed",
759 "parameters": [
760 { "name": "transactionId", "type": "integer" },
761 { "name": "sqlError", "$ref": "Error" }
762 ]
763 }
764 ]
765 },
766 {
767 "domain": "DOMStorage",
768 "hidden": true,
769 "types": [],
770 "commands": [
771 {
772 "name": "enable",
773 "description": "Enables storage tracking, storage events will now be delivered to the client."
774 },
775 {
776 "name": "disable",
777 "description": "Disables storage tracking, prevents storage events from being sent to the client."
778 },
779 {
780 "name": "getDOMStorageEntries",
781 "parameters": [
782 { "name": "storageId", "type": "integer" }
783 ],
784 "returns": [
785 { "name": "entries", "type": "array", "items": { "$ref": "DOMStorageEntry"} }
786 ]
787 },
788 {
789 "name": "setDOMStorageItem",
790 "parameters": [
791 { "name": "storageId", "type": "integer" },
792 { "name": "key", "type": "string" },
793 { "name": "value", "type": "string" }
794 ],
795 "returns": [
796 { "name": "success", "type": "boolean" }
797 ]
798 },
799 {
800 "name": "removeDOMStorageItem",
801 "parameters": [
802 { "name": "storageId", "type": "integer" },
803 { "name": "key", "type": "string" }
804 ],
805 "returns": [
806 { "name": "success", "type": "boolean" }
807 ]
808 }
809 ],
810 "events": [
811 {
812 "name": "addDOMStorage",
813 "parameters": [
814 { "name": "storage", "type": "object" }
815 ]
816 },
817 {
818 "name": "updateDOMStorage",
819 "parameters": [
820 { "name": "storageId", "type": "integer" }
821 ]
822 }
823 ]
824 },
825 {
826 "domain": "ApplicationCache",
827 "hidden": true,
828 "types": [
829 {
830 "id": "AppCache",
831 "type": "object",
832 "description": "AppCache."
833 }
834 ],
835 "commands": [
836 {
837 "name": "getApplicationCaches",
838 "returns": [
839 { "name": "applicationCaches", "$ref": "AppCache" }
840 ]
841 }
842 ],
843 "events": [
844 {
845 "name": "updateApplicationCacheStatus",
846 "parameters": [
847 { "name": "status", "type": "integer" }
848 ]
849 },
850 {
851 "name": "updateNetworkState",
852 "parameters": [
853 { "name": "isNowOnline", "type": "boolean" }
854 ]
855 }
856 ]
857 },
858 {
859 "domain": "DOM",
860 "description": "This domain exposes DOM read/write operations. Each DOM Node is represented with its mirror object that has an <code>id</code>. This <code>id</code> can be used to get additional information on the Node, resolve it into the JavaScript object wrapper, etc. It is important that client receives DOM events only for the nodes that are known to the client. Backend keeps track of the nodes that were sent to the client and never sends the same node twice. It is client's responsibility to collect information about the nodes that were sent to the client.<p>Note that <code>iframe</code> owner elements will return corresponding document elements as their child nodes.</p>",
861 "types": [
862 {
863 "id": "NodeId",
864 "type": "integer",
865 "description": "Unique DOM node identifier."
866 },
867 {
868 "id": "Node",
869 "type": "object",
870 "properties": [
871 { "name": "nodeId", "$ref": "NodeId", "description": "Node identifier that is passed into the rest of the DOM messages as the <code>nodeId</code>. Backend will only push node with given <code>id</code> once. It is aware of all requested nodes and will only fire DOM events for nodes known to the client." },
872 { "name": "nodeType", "type": "integer", "description": "<code>Node</code>'s nodeType." },
873 { "name": "nodeName", "type": "string", "description": "<code>Node</code>'s nodeName." },
874 { "name": "localName", "type": "string", "description": "<code>Node</code>'s localName." },
875 { "name": "nodeValue", "type": "string", "description": "<code>Node</code>'s nodeValue." },
876 { "name": "childNodeCount", "type": "integer", "optional": true, "description": "Child count for <code>Container</code> nodes." },
877 { "name": "children", "type": "array", "optional": true, "items": { "$ref": "Node" }, "description": "Child nodes of this node when requested with children." },
878 { "name": "attributes", "type": "array", "optional": true, "items": { "type": "string" }, "description": "Attributes of the <code>Element</code> node in the form of flat array <code>[name1, value1, name2, value2]</code>." },
879 { "name": "documentURL", "type": "string", "optional": true, "description": "Document URL that <code>Document</code> or <code>FrameOwner</code> node points to." },
880 { "name": "publicId", "type": "string", "optional": true, "description": "<code>DocumentType</code>'s publicId." },
881 { "name": "systemId", "type": "string", "optional": true, "description": "<code>DocumentType</code>'s systemId." },
882 { "name": "internalSubset", "type": "string", "optional": true, "description": "<code>DocumentType</code>'s internalSubset." },
883 { "name": "name", "type": "string", "optional": true, "description": "<code>Attr</code>'s name." },
884 { "name": "value", "type": "string", "optional": true, "description": "<code>Attr</code>'s value." }
885 ],
886 "description": "DOM interaction is implemented in terms of mirror objects that represent the actual DOM nodes. DOMNode is a base node mirror type."
887 },
888 {
889 "id": "EventListener",
890 "type": "object",
891 "hidden": true,
892 "properties": [
893 { "name": "type", "type": "string", "description": "<code>EventListener</code>'s type." },
894 { "name": "useCapture", "type": "boolean", "description": "<code>EventListener</code>'s useCapture." },
895 { "name": "isAttribute", "type": "boolean", "description": "<code>EventListener</code>'s isAttribute." },
896 { "name": "nodeId", "$ref": "NodeId", "description": "Target <code>DOMNode</code> id." },
897 { "name": "handlerBody", "type": "string", "description": "Event handler function body." },
898 { "name": "location", "$ref": "Debugger.Location", "optional": true, "description": "Handler code location." }
899 ],
900 "description": "DOM interaction is implemented in terms of mirror objects that represent the actual DOM nodes. DOMNode is a base node mirror type."
901 },
902 {
903 "id": "RGBA",
904 "type": "object",
905 "properties": [
906 { "name": "r", "type": "integer", "description": "The red component, in the [0-255] range." },
907 { "name": "g", "type": "integer", "description": "The green component, in the [0-255] range." },
908 { "name": "b", "type": "integer", "description": "The blue component, in the [0-255] range." },
909 { "name": "a", "type": "number", "optional": true, "description": "The alpha component, in the [0-1] range (default: 1)." }
910 ],
911 "description": "A structure holding an RGBA color."
912 },
913 {
914 "id": "HighlightConfig",
915 "type": "object",
916 "properties": [
917 { "name": "showInfo", "type": "boolean", "optional": true, "description": "Whether the node info tooltip should be shown (default: false)." },
918 { "name": "contentColor", "$ref": "RGBA", "optional": true, "description": "The content box highlight fill color (default: transparent)." },
919 { "name": "paddingColor", "$ref": "RGBA", "optional": true, "description": "The padding highlight fill color (default: transparent)." },
920 { "name": "borderColor", "$ref": "RGBA", "optional": true, "description": "The border highlight fill color (default: transparent)." },
921 { "name": "marginColor", "$ref": "RGBA", "optional": true, "description": "The margin highlight fill color (default: transparent)." }
922 ],
923 "description": "Configuration data for the highlighting of page elements."
924 }
925 ],
926 "commands": [
927 {
928 "name": "getDocument",
929 "returns": [
930 { "name": "root", "$ref": "Node", "description": "Resulting node." }
931 ],
932 "description": "Returns the root DOM node to the caller."
933 },
934 {
935 "name": "requestChildNodes",
936 "parameters": [
937 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to get children for." }
938 ],
939 "description": "Requests that children of the node with given id are returned to the caller in form of <code>setChildNodes</code> events."
940 },
941 {
942 "name": "querySelector",
943 "parameters": [
944 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to query upon." },
945 { "name": "selector", "type": "string", "description": "Selector string." }
946 ],
947 "returns": [
948 { "name": "nodeId", "$ref": "NodeId", "description": "Query selector result." }
949 ],
950 "description": "Executes <code>querySelector</code> on a given node."
951 },
952 {
953 "name": "querySelectorAll",
954 "parameters": [
955 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to query upon." },
956 { "name": "selector", "type": "string", "description": "Selector string." }
957 ],
958 "returns": [
959 { "name": "nodeIds", "type": "array", "items": { "$ref": "NodeId" }, "description": "Query selector result." }
960 ],
961 "description": "Executes <code>querySelectorAll</code> on a given node."
962 },
963 {
964 "name": "setNodeName",
965 "parameters": [
966 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to set name for." },
967 { "name": "name", "type": "string", "description": "New node's name." }
968 ],
969 "returns": [
970 { "name": "nodeId", "$ref": "NodeId", "description": "New node's id." }
971 ],
972 "description": "Sets node name for a node with given id."
973 },
974 {
975 "name": "setNodeValue",
976 "parameters": [
977 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to set value for." },
978 { "name": "value", "type": "string", "description": "New node's value." }
979 ],
980 "description": "Sets node value for a node with given id."
981 },
982 {
983 "name": "removeNode",
984 "parameters": [
985 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to remove." }
986 ],
987 "description": "Removes node with given id."
988 },
989 {
990 "name": "setAttributeValue",
991 "parameters": [
992 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the element to set attribute for." },
993 { "name": "name", "type": "string", "description": "Attribute name." },
994 { "name": "value", "type": "string", "description": "Attribute value." }
995 ],
996 "description": "Sets attribute for an element with given id."
997 },
998 {
999 "name": "setAttributesAsText",
1000 "parameters": [
1001 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the element to set attributes for." },
1002 { "name": "text", "type": "string", "description": "Text with a number of attributes. Will parse this text using HTML parser." },
1003 { "name": "name", "type": "string", "optional": true, "description": "Attribute name to replace with new attributes derived from text in case text parsed successfully." }
1004 ],
1005 "description": "Sets attributes on element with given id. This method is useful when user edits some existing attribute value and types in several attribute name/value pairs."
1006 },
1007 {
1008 "name": "removeAttribute",
1009 "parameters": [
1010 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the element to remove attribute from." },
1011 { "name": "name", "type": "string", "description": "Name of the attribute to remove." }
1012 ],
1013 "description": "Removes attribute with given name from an element with given id."
1014 },
1015 {
1016 "name": "getEventListenersForNode",
1017 "parameters": [
1018 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to get listeners for." }
1019 ],
1020 "returns": [
1021 { "name": "listeners", "type": "array", "items": { "$ref": "EventListener"}, "description": "Array of relevant listeners." }
1022 ],
1023 "description": "Returns event listeners relevant to the node.",
1024 "hidden": true
1025 },
1026 {
1027 "name": "copyNode",
1028 "parameters": [
1029 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to copy." }
1030 ],
1031 "description": "Copies node's HTML markup into the clipboard.",
1032 "hidden": true
1033 },
1034 {
1035 "name": "getOuterHTML",
1036 "parameters": [
1037 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to get markup for." }
1038 ],
1039 "returns": [
1040 { "name": "outerHTML", "type": "string", "description": "Outer HTML markup." }
1041 ],
1042 "description": "Returns node's HTML markup."
1043 },
1044 {
1045 "name": "setOuterHTML",
1046 "parameters": [
1047 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to set markup for." },
1048 { "name": "outerHTML", "type": "string", "description": "Outer HTML markup to set." }
1049 ],
1050 "description": "Sets node HTML markup, returns new node id."
1051 },
1052 {
1053 "name": "performSearch",
1054 "parameters": [
1055 { "name": "query", "type": "string", "description": "Plain text or query selector or XPath search query." },
1056 { "name": "runSynchronously", "type": "boolean", "optional": true, "description": "When set to true, performing search synchronously (can block user interaction)." }
1057 ],
1058 "description": "Starts asynchronous search for a given string in the DOM tree. Use <code>cancelSearch</code> to stop given asynchronous search task.",
1059 "hidden": true
1060 },
1061 {
1062 "name": "cancelSearch",
1063 "description": "Cancels asynchronous search started with <code>performSearch</code>.",
1064 "hidden": true
1065 },
1066 {
1067 "name": "requestNode",
1068 "parameters": [
1069 { "name": "objectId", "$ref": "Runtime.RemoteObjectId", "description": "JavaScript object id to convert into node." }
1070 ],
1071 "returns": [
1072 { "name": "nodeId", "$ref": "NodeId", "description": "Node id for given object." }
1073 ],
1074 "description": "Requests that the node is sent to the caller given the JavaScript node object reference. All nodes that form the path from the node to the root are also sent to the client as a series of <code>setChildNodes</code> notifications."
1075 },
1076 {
1077 "name": "setInspectModeEnabled",
1078 "hidden": true,
1079 "parameters": [
1080 { "name": "enabled", "type": "boolean", "description": "True to enable inspection mode, false to disable it." },
1081 { "name": "highlightConfig", "$ref": "HighlightConfig", "optional": true, "description": "A descriptor for the highlight appearance of hovered-over nodes. May be omitted if <code>enabled == false</code>." }
1082 ],
1083 "description": "Enters the 'inspect' mode. In this mode, elements that user is hovering over are highlighted. Backend then generates 'inspect' command upon element selection."
1084 },
1085 {
1086 "name": "highlightRect",
1087 "parameters": [
1088 { "name": "x", "type": "integer", "description": "X coordinate" },
1089 { "name": "y", "type": "integer", "description": "Y coordinate" },
1090 { "name": "width", "type": "integer", "description": "Rectangle width" },
1091 { "name": "height", "type": "integer", "description": "Rectangle height" },
1092 { "name": "color", "$ref": "RGBA", "optional": true, "description": "The highlight fill color (default: transparent)." },
1093 { "name": "outlineColor", "$ref": "RGBA", "optional": true, "description": "The highlight outline color (default: transparent)." }
1094 ],
1095 "description": "Highlights given rectangle. Coordinates are absolute with respect to the main frame viewport."
1096 },
1097 {
1098 "name": "highlightNode",
1099 "parameters": [
1100 { "name": "nodeId", "$ref": "NodeId", "description": "Identifier of the node to highlight." },
1101 { "name": "highlightConfig", "$ref": "HighlightConfig", "description": "A descriptor for the highlight appearance." }
1102 ],
1103 "description": "Highlights DOM node with given id."
1104 },
1105 {
1106 "name": "hideHighlight",
1107 "description": "Hides DOM node highlight."
1108 },
1109 {
1110 "name": "highlightFrame",
1111 "parameters": [
1112 { "name": "frameId", "type": "string", "description": "Identifier of the frame to highlight." },
1113 { "name": "contentColor", "$ref": "RGBA", "optional": true, "description": "The content box highlight fill color (default: transparent)." },
1114 { "name": "contentOutlineColor", "$ref": "RGBA", "optional": true, "description": "The content box highlight outline color (default: transparent)." }
1115 ],
1116 "description": "Highlights owner element of the frame with given id.",
1117 "hidden": true
1118 },
1119 {
1120 "name": "pushNodeByPathToFrontend",
1121 "parameters": [
1122 { "name": "path", "type": "string", "description": "Path to node in the proprietary format." }
1123 ],
1124 "returns": [
1125 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node for given path." }
1126 ],
1127 "description": "Requests that the node is sent to the caller given its path. // FIXME, use XPath",
1128 "hidden": true
1129 },
1130 {
1131 "name": "resolveNode",
1132 "parameters": [
1133 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to resolve." },
1134 { "name": "objectGroup", "type": "string", "optional": true, "description": "Symbolic group name that can be used to release multiple objects." }
1135 ],
1136 "returns": [
1137 { "name": "object", "$ref": "Runtime.RemoteObject", "description": "JavaScript object wrapper for given node." }
1138 ],
1139 "description": "Resolves JavaScript node object for given node id."
1140 },
1141 {
1142 "name": "getAttributes",
1143 "parameters": [
1144 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to retrieve attibutes for." }
1145 ],
1146 "returns": [
1147 { "name": "attributes", "type": "array", "items": { "type": "string" }, "description": "An interleaved array of node attribute names and values." }
1148 ],
1149 "description": "Returns attributes for the specified node."
1150 },
1151 {
1152 "name": "moveTo",
1153 "parameters": [
1154 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to drop." },
1155 { "name": "targetNodeId", "$ref": "NodeId", "description": "Id of the element to drop into." },
1156 { "name": "insertBeforeNodeId", "$ref": "NodeId", "optional": true, "description": "Drop node before given one." }
1157 ],
1158 "returns": [
1159 { "name": "nodeId", "$ref": "NodeId", "description": "New id of the moved node." }
1160 ],
1161 "description": "Moves node into the new container, places it before the given anchor."
1162 }
1163 ],
1164 "events": [
1165 {
1166 "name": "documentUpdated",
1167 "description": "Fired when <code>Document</code> has been totally updated. Node ids are no longer valid."
1168 },
1169 {
1170 "name": "setChildNodes",
1171 "parameters": [
1172 { "name": "parentId", "$ref": "NodeId", "description": "Parent node id to populate with children." },
1173 { "name": "nodes", "type": "array", "items": { "$ref": "Node"}, "description": "Child nodes array." }
1174 ],
1175 "description": "Fired when backend wants to provide client with the missing DOM structure. This happens upon most of the calls requesting node ids."
1176 },
1177 {
1178 "name": "attributeModified",
1179 "parameters": [
1180 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node that has changed." },
1181 { "name": "name", "type": "string", "description": "Attribute name." },
1182 { "name": "value", "type": "string", "description": "Attribute value." }
1183 ],
1184 "description": "Fired when <code>Element</code>'s attribute is modified."
1185 },
1186 {
1187 "name": "attributeRemoved",
1188 "parameters": [
1189 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node that has changed." },
1190 { "name": "name", "type": "string", "description": "Local attribute name." }
1191 ],
1192 "description": "Fired when <code>Element</code>'s attribute is removed."
1193 },
1194 {
1195 "name": "inlineStyleInvalidated",
1196 "parameters": [
1197 { "name": "nodeIds", "type": "array", "items": { "$ref": "NodeId" }, "description": "Ids of the nodes for which the inline styles have been invalidated." }
1198 ],
1199 "description": "Fired when <code>Element</code>'s inline style is modified via a CSS property modification.",
1200 "hidden": true
1201 },
1202 {
1203 "name": "characterDataModified",
1204 "parameters": [
1205 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node that has changed." },
1206 { "name": "characterData", "type": "string", "description": "New text value." }
1207 ],
1208 "description": "Mirrors <code>DOMCharacterDataModified</code> event."
1209 },
1210 {
1211 "name": "childNodeCountUpdated",
1212 "parameters": [
1213 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node that has changed." },
1214 { "name": "childNodeCount", "type": "integer", "description": "New node count." }
1215 ],
1216 "description": "Fired when <code>Container</code>'s child node count has changed."
1217 },
1218 {
1219 "name": "childNodeInserted",
1220 "parameters": [
1221 { "name": "parentNodeId", "$ref": "NodeId", "description": "Id of the node that has changed." },
1222 { "name": "previousNodeId", "$ref": "NodeId", "description": "If of the previous siblint." },
1223 { "name": "node", "$ref": "Node", "description": "Inserted node data." }
1224 ],
1225 "description": "Mirrors <code>DOMNodeInserted</code> event."
1226 },
1227 {
1228 "name": "childNodeRemoved",
1229 "parameters": [
1230 { "name": "parentNodeId", "$ref": "NodeId", "description": "Parent id." },
1231 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node that has been removed." }
1232 ],
1233 "description": "Mirrors <code>DOMNodeRemoved</code> event."
1234 },
1235 {
1236 "name": "searchResults",
1237 "parameters": [
1238 { "name": "nodeIds", "type": "array", "items": { "$ref": "NodeId" }, "description": "Ids of the search result nodes." }
1239 ],
1240 "description": "Pushes search results initiated using <code>performSearch</code> to the client.",
1241 "hidden": true
1242 }
1243 ]
1244 },
1245 {
1246 "domain": "CSS",
1247 "hidden": true,
1248 "description": "This domain exposes CSS read/write operations. All CSS objects, like stylesheets, rules, and styles, have an associated <code>id</code> used in subsequent operations on the related object. Each object type has a specific <code>id</code> structure, and those are not interchangeable between objects of different kinds. CSS objects can be loaded using the <code>get*ForNode()</code> calls (which accept a DOM node id). Alternatively, a client can discover all the existing stylesheets with the <code>getAllStyleSheets()</code> method and subsequently load the required stylesheet contents using the <code>getStyleSheet[Text]()</code> methods.",
1249 "types": [
1250 {
1251 "id": "CSSStyleId",
1252 "type": "object",
1253 "properties": [
1254 { "name": "styleSheetId", "type": "string", "description": "Enclosing stylesheet identifier." },
1255 { "name": "ordinal", "type": "integer", "description": "The style ordinal within the stylesheet." }
1256 ],
1257 "description": "This object identifies a CSS style in a unique way."
1258 },
1259 {
1260 "id": "CSSRuleId",
1261 "type": "object",
1262 "properties": [
1263 { "name": "styleSheetId", "type": "string", "description": "Enclosing stylesheet identifier." },
1264 { "name": "ordinal", "type": "integer", "description": "The rule ordinal within the stylesheet." }
1265 ],
1266 "description": "This object identifies a CSS rule in a unique way."
1267 },
1268 {
1269 "id": "CSSNodeStyles",
1270 "type": "object",
1271 "properties": [
1272 { "name": "inlineStyle", "$ref": "CSSStyle", "optional": true, "description": "The node's inline style, if any." },
1273 { "name": "computedStyle", "$ref": "CSSComputedStyle", "description": "The node's computed style." },
1274 { "name": "matchedCSSRules", "type": "array", "items": { "$ref": "CSSRule" }, "description": "CSS rules matching this node, from all applicable stylesheets." },
1275 { "name": "styleAttributes", "type": "array", "items": { "$ref": "CSSStyleAttribute" }, "description": "Entries for style-related element attributes (e.g. width=20)."},
1276 { "name": "pseudoElements", "type": "array", "items": { "$ref": "PseudoIdRules" }, "description": "Pseudo style rules for this node." },
1277 { "name": "inherited", "type": "array", "items": { "$ref": "InheritedStyleEntry" }, "description": "A chain of inherited styles (from the immediate node parent up to the DOM tree root)." }
1278 ],
1279 "description": "A holder for all CSS styles applicable to a particular DOM node."
1280 },
1281 {
1282 "id": "PseudoIdRules",
1283 "type": "object",
1284 "properties": [
1285 { "name": "pseudoId", "type": "integer", "description": "Pseudo style identifier (see <code>enum PseudoId</code> in <code>ComputedStyleConstants.h</code>)."},
1286 { "name": "rules", "type": "array", "items": { "$ref": "CSSRule" }, "description": "CSS rules applicable to the pseudo style."}
1287 ],
1288 "description": "CSS rule collection for a single pseudo style."
1289 },
1290 {
1291 "id": "InheritedStyleEntry",
1292 "type": "object",
1293 "properties": [
1294 { "name": "inlineStyle", "$ref": "CSSStyle", "optional": true, "description": "The ancestor node's inline style, if any, in the style inheritance chain." },
1295 { "name": "matchedCSSRules", "type": "array", "items": { "$ref": "CSSRule" }, "description": "CSS rules matching the ancestor node in the style inheritance chain." }
1296 ],
1297 "description": "CSS rule collection for a single pseudo style."
1298 },
1299 {
1300 "id": "CSSStyleAttribute",
1301 "type": "object",
1302 "properties": [
1303 { "name": "name", "type": "string", "description": "DOM attribute name (e.g. \"width\")."},
1304 { "name": "style", "$ref": "CSSStyle", "description": "CSS style generated by the respective DOM attribute."}
1305 ],
1306 "description": "CSS style information for a DOM style attribute."
1307 },
1308 {
1309 "id": "CSSStyleSheetHeader",
1310 "type": "object",
1311 "properties": [
1312 { "name": "styleSheetId", "type": "string", "description": "The stylesheet identifier."},
1313 { "name": "sourceURL", "type": "string", "description": "Stylesheet resource URL."},
1314 { "name": "title", "type": "string", "description": "Stylesheet title."},
1315 { "name": "disabled", "type": "boolean", "description": "Denotes whether the stylesheet is disabled."}
1316 ],
1317 "description": "CSS stylesheet metainformation."
1318 },
1319 {
1320 "id": "CSSStyleSheetBody",
1321 "type": "object",
1322 "properties": [
1323 { "name": "styleSheetId", "type": "string", "description": "The stylesheet identifier."},
1324 { "name": "rules", "type": "array", "items": { "$ref": "CSSRule" }, "description": "Stylesheet resource URL."},
1325 { "name": "text", "type": "string", "optional": true, "description": "Stylesheet resource contents (if available)."}
1326 ],
1327 "description": "CSS stylesheet contents."
1328 },
1329 {
1330 "id": "CSSRule",
1331 "type": "object",
1332 "properties": [
1333 { "name": "ruleId", "$ref": "CSSRuleId", "description": "The CSS rule identifier."},
1334 { "name": "selectorText", "type": "string", "description": "Rule selector."},
1335 { "name": "sourceURL", "type": "string", "optional": true, "description": "Parent stylesheet resource URL (for regular rules)."},
1336 { "name": "sourceLine", "type": "integer", "description": "Line ordinal of the rule selector start character in the resource."},
1337 { "name": "origin", "type": "string", "enum": ["user", "user-agent", "inspector", ""], "description": "The parent stylesheet type: \"user\" for user stylesheets, \"user-agent\" for user-agent stylesheets, \"inspector\" for stylesheets created by the inspector (i.e. those holding new rules created with <code>addRule()</code>), \"\" for regular stylesheets."},
1338 { "name": "style", "$ref": "CSSStyle", "description": "Associated style declaration." },
1339 { "name": "selectorRange", "$ref": "SourceRange", "optional": true, "description": "The rule selector range in the underlying resource (if available)." }
1340 ],
1341 "description": "CSS rule representation."
1342 },
1343 {
1344 "id": "SourceRange",
1345 "type": "object",
1346 "properties": [
1347 { "name": "start", "type": "integer", "description": "Start of range (inclusive)."},
1348 { "name": "end", "type": "integer", "description": "End of range (exclusive)."}
1349 ],
1350 "description": "Text range within a resource."
1351 },
1352 {
1353 "id": "ShorthandEntry",
1354 "type": "object"
1355 },
1356 {
1357 "id": "CSSComputedStyle",
1358 "type": "object"
1359 },
1360 {
1361 "id": "CSSStyle",
1362 "type": "object",
1363 "properties": [
1364 { "name": "styleId", "$ref": "CSSStyleId", "description": "The CSS style identifier."},
1365 { "name": "cssProperties", "type": "array", "items": { "$ref": "CSSProperty" }, "description": "CSS properties in the style."},
1366 { "name": "shorthandEntries", "type": "array", "items": { "$ref": "ShorthandEntry" }, "description": "Computed values for all shorthands found in the style." },
1367 { "name": "cssText", "type": "string", "optional": true, "description": "Style declaration text (if available)."},
1368 { "name": "range", "$ref": "SourceRange", "optional": true, "description": "Style declaration range in the enclosing stylesheet (if available)." },
1369 { "name": "width", "type": "integer", "description": "The effective \"width\" property value from this style." },
1370 { "name": "height", "type": "integer", "description": "The effective \"height\" property value from this style." }
1371 ],
1372 "description": "CSS style representation."
1373 },
1374 {
1375 "id": "CSSProperty",
1376 "type": "object",
1377 "properties": [
1378 { "name": "name", "type": "string", "description": "The property name." },
1379 { "name": "value", "type": "string", "description": "The property value." },
1380 { "name": "priority", "type": "string", "optional": true, "description": "The property priority (implies \"\" if absent)." },
1381 { "name": "implicit", "type": "boolean", "optional": true, "description": "Whether the property is implicit (implies <code>false</code> if absent)." },
1382 { "name": "parsedOk", "type": "boolean", "optional": true, "description": "Whether the property is understood by the browser (implies <code>true</code> if absent)." },
1383 { "name": "status", "type": "string", "enum": ["active", "inactive", "disabled", "style"], "optional": true, "description": "The property status: \"active\" (implied if absent) if the property is effective in the style, \"inactive\" if the property is overridden by a same-named property in this style later on, \"disabled\" if the property is disabled by the user, \"style\" if the property is reported by the browser rather than by the CSS source parser." },
1384 { "name": "shorthandName", "type": "string", "description": "The related shorthand property name (absent if this property is not a longhand)." },
1385 { "name": "range", "$ref": "SourceRange", "optional": true, "description": "The entire property range in the enclosing style declaration (if available)." }
1386 ],
1387 "description": "CSS style effective visual dimensions and source offsets."
1388 }
1389 ],
1390 "commands": [
1391 {
1392 "name": "getStylesForNode",
1393 "parameters": [
1394 { "name": "nodeId", "$ref": "DOM.NodeId" },
1395 { "name": "forcedPseudoClasses", "type": "array", "items": { "type": "string", "enum": ["active", "focus", "hover", "visited"] }, "optional": true, "description": "Element pseudo classes to force when computing applicable style rules." }
1396 ],
1397 "returns": [
1398 { "name": "styles", "$ref": "CSSNodeStyles", "description": "All styles for the specified DOM node." }
1399 ],
1400 "description": "Returns all styles for a DOM node identified by <code>nodeId</code>."
1401 },
1402 {
1403 "name": "getComputedStyleForNode",
1404 "parameters": [
1405 { "name": "nodeId", "$ref": "DOM.NodeId" }
1406 ],
1407 "returns": [
1408 { "name": "style", "$ref": "CSSStyle", "description": "Computed style for the specified DOM node." }
1409 ],
1410 "description": "Returns the computed style for a DOM node identified by <code>nodeId</code>."
1411 },
1412 {
1413 "name": "getInlineStyleForNode",
1414 "parameters": [
1415 { "name": "nodeId", "$ref": "DOM.NodeId" }
1416 ],
1417 "returns": [
1418 { "name": "style", "$ref": "CSSStyle", "description": "Inline style for the specified DOM node." }
1419 ],
1420 "description": "Returns the inline style (if present) for a DOM node identified by <code>nodeId</code>."
1421 },
1422 {
1423 "name": "getAllStyleSheets",
1424 "returns": [
1425 { "name": "headers", "type": "array", "items": { "$ref": "CSSStyleSheetHeader" }, "description": "Descriptor entries for all available stylesheets." }
1426 ],
1427 "description": "Returns metainfo entries for all known stylesheets."
1428 },
1429 {
1430 "name": "getStyleSheet",
1431 "parameters": [
1432 { "name": "styleSheetId", "type": "string" }
1433 ],
1434 "returns": [
1435 { "name": "styleSheet", "$ref": "CSSStyleSheetBody", "description": "Stylesheet contents for the specified <code>styleSheetId</code>." }
1436 ],
1437 "description": "Returns stylesheet data for the specified <code>styleSheetId</code>."
1438 },
1439 {
1440 "name": "getStyleSheetText",
1441 "parameters": [
1442 { "name": "styleSheetId", "type": "string" }
1443 ],
1444 "returns": [
1445 { "name": "text", "type": "string", "description": "The stylesheet text." }
1446 ],
1447 "description": "Returns the current textual content and the URL for a stylesheet."
1448 },
1449 {
1450 "name": "setStyleSheetText",
1451 "parameters": [
1452 { "name": "styleSheetId", "type": "string" },
1453 { "name": "text", "type": "string" }
1454 ],
1455 "description": "Sets the new stylesheet text, thereby invalidating all existing <code>CSSStyleId</code>'s and <code>CSSRuleId</code>'s contained by this stylesheet."
1456 },
1457 {
1458 "name": "setPropertyText",
1459 "parameters": [
1460 { "name": "styleId", "$ref": "CSSStyleId" },
1461 { "name": "propertyIndex", "type": "integer" },
1462 { "name": "text", "type": "string" },
1463 { "name": "overwrite", "type": "boolean" }
1464 ],
1465 "returns": [
1466 { "name": "style", "$ref": "CSSStyle", "description": "The resulting style after the property text modification." }
1467 ],
1468 "description": "Sets the new <code>text</code> for a property in the respective style, at offset <code>propertyIndex</code>. If <code>overwrite</code> is <code>true</code>, a property at the given offset is overwritten, otherwise inserted. <code>text</code> entirely replaces the property <code>name: value</code>."
1469 },
1470 {
1471 "name": "toggleProperty",
1472 "parameters": [
1473 { "name": "styleId", "$ref": "CSSStyleId" },
1474 { "name": "propertyIndex", "type": "integer" },
1475 { "name": "disable", "type": "boolean" }
1476 ],
1477 "returns": [
1478 { "name": "style", "$ref": "CSSStyle", "description": "The resulting style after the property toggling." }
1479 ],
1480 "description": "Toggles the property in the respective style, at offset <code>propertyIndex</code>. The <code>disable</code> parameter denotes whether the property should be disabled (i.e. removed from the style declaration). If <code>disable == false</code>, the property gets put back into its original place in the style declaration."
1481 },
1482 {
1483 "name": "setRuleSelector",
1484 "parameters": [
1485 { "name": "ruleId", "$ref": "CSSRuleId" },
1486 { "name": "selector", "type": "string" }
1487 ],
1488 "returns": [
1489 { "name": "rule", "$ref": "CSSRule", "description": "The resulting rule after the selector modification." }
1490 ],
1491 "description": "Modifies the rule selector."
1492 },
1493 {
1494 "name": "addRule",
1495 "parameters": [
1496 { "name": "contextNodeId", "$ref": "DOM.NodeId" },
1497 { "name": "selector", "type": "string" }
1498 ],
1499 "returns": [
1500 { "name": "rule", "$ref": "CSSRule", "description": "The newly created rule." }
1501 ],
1502 "description": "Creates a new empty rule with the given <code>selector</code> in a special \"inspector\" stylesheet in the owner document of the context node."
1503 },
1504 {
1505 "name": "getSupportedCSSProperties",
1506 "returns": [
1507 { "name": "cssProperties", "type": "array", "items": { "type": "string" }, "description": "Supported property names." }
1508 ],
1509 "description": "Returns all supported CSS property names."
1510 }
1511 ]
1512 },
1513 {
1514 "domain": "Timeline",
1515 "description": "Timeline provides its clients with instrumentation records that are generated during the page runtime. Timeline instrumentation can be started and stopped using corresponding commands. While timeline is started, it is generating timeline event records.",
1516 "types": [
1517 {
1518 "id": "TimelineEvent",
1519 "type": "object",
1520 "properties": [
1521 { "name": "type", "type": "string", "description": "Event type." },
1522 { "name": "data", "type": "object", "description": "Event data." },
1523 { "name": "children", "type": "array", "optional": true, "items": { "$ref": "TimelineEvent" }, "description": "Nested records." }
1524 ],
1525 "description": "Timeline record contains information about the recorded activity."
1526 }
1527 ],
1528 "commands": [
1529 {
1530 "name": "start",
1531 "parameters": [
1532 { "name": "maxCallStackDepth", "optional": true, "type": "integer", "description": "Samples JavaScript stack traces up to <code>maxCallStackDepth</code>, defaults to 5." }
1533 ],
1534 "description": "Starts capturing instrumentation events."
1535 },
1536 {
1537 "name": "stop",
1538 "description": "Stops capturing instrumentation events."
1539 }
1540 ],
1541 "events": [
1542 {
1543 "name": "started",
1544 "description": "Fired when timeline has been started.",
1545 "hidden": true
1546 },
1547 {
1548 "name": "stopped",
1549 "description": "Fired when timeline has been stopped.",
1550 "hidden": true
1551 },
1552 {
1553 "name": "eventRecorded",
1554 "parameters": [
1555 { "name": "record", "$ref": "TimelineEvent", "description": "Timeline event record data." }
1556 ],
1557 "description": "Fired for every instrumentation event while timeline is started."
1558 }
1559 ]
1560 },
1561 {
1562 "domain": "Debugger",
1563 "description": "Debugger domain exposes JavaScript debugging capabilities. It allows setting and removing breakpoints, stepping through execution, exploring stack traces, etc.",
1564 "types": [
1565 {
1566 "id": "BreakpointId",
1567 "type": "string",
1568 "description": "Breakpoint identifier."
1569 },
1570 {
1571 "id": "ScriptId",
1572 "type": "string",
1573 "description": "Unique script identifier."
1574 },
1575 {
1576 "id": "CallFrameId",
1577 "type": "string",
1578 "description": "Call frame identifier."
1579 },
1580 {
1581 "id": "Location",
1582 "type": "object",
1583 "properties": [
1584 { "name": "scriptId", "$ref": "ScriptId", "description": "Script identifier as reported in the <code>Debugger.scriptParsed</code>." },
1585 { "name": "lineNumber", "type": "integer", "description": "Line number in the script." },
1586 { "name": "columnNumber", "type": "integer", "optional": true, "description": "Column number in the script." }
1587 ],
1588 "description": "Location in the source code."
1589 },
1590 {
1591 "id": "CallFrame",
1592 "type": "object",
1593 "properties": [
1594 { "name": "callFrameId", "$ref": "CallFrameId", "description": "Call frame identifier. This identifier is only valid while the virtual machine is paused." },
1595 { "name": "functionName", "type": "string", "description": "Name of the JavaScript function called on this call frame." },
1596 { "name": "location", "$ref": "Location", "description": "Location in the source code." },
1597 { "name": "scopeChain", "type": "array", "items": { "$ref": "Scope" }, "description": "Scope chain for this call frame." },
1598 { "name": "this", "$ref": "Runtime.RemoteObject", "description": "<code>this</code> object for this call frame." }
1599 ],
1600 "description": "JavaScript call frame. Array of call frames form the call stack."
1601 },
1602 {
1603 "id": "Scope",
1604 "type": "object",
1605 "properties": [
1606 { "name": "type", "type": "string", "enum": ["global", "local", "with", "closure", "catch"], "description": "Scope type." },
1607 { "name": "object", "$ref": "Runtime.RemoteObject", "description": "Object representing the scope. For <code>global</code> and <code>with</code> scopes it represents the actual object; for the rest of the scopes, it is artificial transient object enumerating scope variables as its properties." }
1608 ],
1609 "description": "Scope description."
1610 }
1611 ],
1612 "commands": [
1613 {
1614 "name": "enable",
1615 "description": "Enables debugger for given page."
1616 },
1617 {
1618 "name": "disable",
1619 "description": "Disables debugger for given page."
1620 },
1621 {
1622 "name": "setBreakpointsActive",
1623 "parameters": [
1624 { "name": "active", "type": "boolean", "description": "New value for breakpoints active state." }
1625 ],
1626 "description": "Activates / deactivates all breakpoints on the page."
1627 },
1628 {
1629 "name": "setBreakpointByUrl",
1630 "parameters": [
1631 { "name": "lineNumber", "type": "integer", "description": "Line number to set breakpoint at." },
1632 { "name": "url", "type": "string", "optional": true, "description": "URL of the resources to set breakpoint on." },
1633 { "name": "urlRegex", "type": "string", "optional": true, "description": "Regex pattern for the URLs of the resources to set breakpoints on. Either <code>url</code> or <code>urlRegex</code> must be specified." },
1634 { "name": "columnNumber", "type": "integer", "optional": true, "description": "Offset in the line to set breakpoint at." },
1635 { "name": "condition", "type": "string", "optional": true, "description": "Expression to use as a breakpoint condition. When specified, debugger will only stop on the breakpoint if this expression evaluates to true." }
1636 ],
1637 "returns": [
1638 { "name": "breakpointId", "$ref": "BreakpointId", "description": "Id of the created breakpoint for further reference." },
1639 { "name": "locations", "optional": true, "type": "array", "items": { "$ref": "Location"}, "description": "List of the locations this breakpoint resolved into upon addition." }
1640 ],
1641 "description": "Sets JavaScript breakpoint at given location specified either by URL or URL regex. Once this command is issued, all existing parsed scripts will have breakpoints resolved and returned in <code>locations</code> property. Further matching script parsing will result in subsequent <code>breakpointResolved</code> events issued. This logical breakpoint will survive page reloads."
1642 },
1643 {
1644 "name": "setBreakpoint",
1645 "parameters": [
1646 { "name": "location", "$ref": "Location", "description": "Location to set breakpoint in." },
1647 { "name": "condition", "type": "string", "optional": true, "description": "Expression to use as a breakpoint condition. When specified, debugger will only stop on the breakpoint if this expression evaluates to true." }
1648 ],
1649 "returns": [
1650 { "name": "breakpointId", "$ref": "BreakpointId", "description": "Id of the created breakpoint for further reference." },
1651 { "name": "actualLocation", "$ref": "Location", "description": "Location this breakpoint resolved into." }
1652 ],
1653 "description": "Sets JavaScript breakpoint at a given location."
1654 },
1655 {
1656 "name": "removeBreakpoint",
1657 "parameters": [
1658 { "name": "breakpointId", "$ref": "BreakpointId" }
1659 ],
1660 "description": "Removes JavaScript breakpoint."
1661 },
1662 {
1663 "name": "continueToLocation",
1664 "parameters": [
1665 { "name": "location", "$ref": "Location", "description": "Location to continue to." }
1666 ],
1667 "description": "Continues execution until specific location is reached."
1668 },
1669 {
1670 "name": "stepOver",
1671 "description": "Steps over the statement."
1672 },
1673 {
1674 "name": "stepInto",
1675 "description": "Steps into the function call."
1676 },
1677 {
1678 "name": "stepOut",
1679 "description": "Steps out of the function call."
1680 },
1681 {
1682 "name": "pause",
1683 "description": "Stops on the next JavaScript statement."
1684 },
1685 {
1686 "name": "resume",
1687 "description": "Resumes JavaScript execution."
1688 },
1689 {
1690 "name": "setScriptSource",
1691 "parameters": [
1692 { "name": "scriptId", "$ref": "ScriptId", "description": "Id of the script to edit." },
1693 { "name": "scriptSource", "type": "string", "description": "New content of the script." },
1694 { "name": "preview", "type": "boolean", "optional": true, "description": " If true the change will not actually be applied. Preview mode may be used to get result description without actually modifying the code.", "hidden": true }
1695 ],
1696 "returns": [
1697 { "name": "callFrames", "type": "array", "optional": true, "items": { "$ref": "CallFrame"}, "description": "New stack trace in case editing has happened while VM was stopped." },
1698 { "name": "result", "type": "object", "optional": true, "description": "VM-specific description of the changes applied.", "hidden": true }
1699 ],
1700 "description": "Edits JavaScript source live."
1701 },
1702 {
1703 "name": "getScriptSource",
1704 "parameters": [
1705 { "name": "scriptId", "$ref": "ScriptId", "description": "Id of the script to get source for." }
1706 ],
1707 "returns": [
1708 { "name": "scriptSource", "type": "string", "description": "Script source." }
1709 ],
1710 "description": "Returns source for the script with given id."
1711 },
1712 {
1713 "name": "setPauseOnExceptions",
1714 "parameters": [
1715 { "name": "state", "type": "string", "enum": ["none", "uncaught", "all"], "description": "Pause on exceptions mode." }
1716 ],
1717 "description": "Defines pause on exceptions state. Can be set to stop on all exceptions, uncaught exceptions or no exceptions. Initial pause on exceptions state is <code>none</code>."
1718 },
1719 {
1720 "name": "evaluateOnCallFrame",
1721 "parameters": [
1722 { "name": "callFrameId", "$ref": "CallFrameId", "description": "Call frame identifier to evaluate on." },
1723 { "name": "expression", "type": "string", "description": "Expression to evaluate." },
1724 { "name": "objectGroup", "type": "string", "optional": true, "description": "String object group name to put result into (allows rapid releasing resulting object handles using <code>releaseObjectGroup</code>)." },
1725 { "name": "includeCommandLineAPI", "type": "boolean", "optional": true, "description": "Specifies whether command line API should be available to the evaluated expression, defaults to false.", "hidden": true },
1726 { "name": "returnByValue", "type": "boolean", "optional": true, "description": "Whether the result is expected to be a JSON object that should be sent by value." }
1727 ],
1728 "returns": [
1729 { "name": "result", "$ref": "Runtime.RemoteObject", "description": "Object wrapper for the evaluation result." },
1730 { "name": "wasThrown", "type": "boolean", "optional": true, "description": "True if the result was thrown during the evaluation." }
1731 ],
1732 "description": "Evaluates expression on a given call frame."
1733 }
1734 ],
1735 "events": [
1736 {
1737 "name": "debuggerWasEnabled",
1738 "description": "Fired when debugger gets enabled (deprecated).",
1739 "hidden": true
1740 },
1741 {
1742 "name": "debuggerWasDisabled",
1743 "description": "Fired when debugger gets disabled (deprecated).",
1744 "hidden": true
1745 },
1746 {
1747 "name": "scriptParsed",
1748 "parameters": [
1749 { "name": "scriptId", "$ref": "ScriptId", "description": "Identifier of the script parsed." },
1750 { "name": "url", "type": "string", "description": "URL or name of the script parsed (if any)." },
1751 { "name": "startLine", "type": "integer", "description": "Line offset of the script within the resource with given URL (for script tags)." },
1752 { "name": "startColumn", "type": "integer", "description": "Column offset of the script within the resource with given URL." },
1753 { "name": "endLine", "type": "integer", "description": "Last line of the script." },
1754 { "name": "endColumn", "type": "integer", "description": "Length of the last line of the script." },
1755 { "name": "isContentScript", "type": "boolean", "optional": true, "description": "Determines whether this script is a user extension script." }
1756 ],
1757 "description": "Fired when virtual machine parses script. This event is also fired for all known and uncollected scripts upon enabling debugger."
1758 },
1759 {
1760 "name": "scriptFailedToParse",
1761 "parameters": [
1762 { "name": "url", "type": "string", "description": "URL of the script that failed to parse." },
1763 { "name": "scriptSource", "type": "string", "description": "Source text of the script that failed to parse." },
1764 { "name": "startLine", "type": "integer", "description": "Line offset of the script within the resource." },
1765 { "name": "errorLine", "type": "integer", "description": "Line with error." },
1766 { "name": "errorMessage", "type": "string", "description": "Parse error message." }
1767 ],
1768 "description": "Fired when virtual machine fails to parse the script."
1769 },
1770 {
1771 "name": "breakpointResolved",
1772 "parameters": [
1773 { "name": "breakpointId", "$ref": "BreakpointId", "description": "Breakpoint unique identifier." },
1774 { "name": "location", "$ref": "Location", "description": "Actual breakpoint location." }
1775 ],
1776 "description": "Fired when breakpoint is resolved to an actual script and location."
1777 },
1778 {
1779 "name": "paused",
1780 "parameters": [
1781 { "name": "callFrames", "type": "array", "items": { "$ref": "CallFrame" }, "description": "Call stack the virtual machine stopped on." },
1782 { "name": "reason", "type": "string", "enum": [ "XHR", "DOM", "EventListener", "exception", "other" ], "description": "Pause reason." },
1783 { "name": "data", "type": "object", "optional": true, "description": "Object containing break-specific auxiliary properties." }
1784 ],
1785 "description": "Fired when the virtual machine stopped on breakpoint or exception or any other stop criteria."
1786 },
1787 {
1788 "name": "resumed",
1789 "description": "Fired when the virtual machine resumed execution."
1790 }
1791 ]
1792 },
1793 {
1794 "domain": "DOMDebugger",
1795 "description": "DOM debugging allows setting breakpoints on particular DOM operations and events. JavaScript execution will stop on these operations as if there was a regular breakpoint set.",
1796 "types": [
1797 {
1798 "id": "DOMBreakpointType",
1799 "type": "string",
1800 "enum": ["subtree-modified", "attribute-modified", "node-removed"],
1801 "description": "DOM breakpoint type."
1802 }
1803 ],
1804 "commands": [
1805 {
1806 "name": "setDOMBreakpoint",
1807 "parameters": [
1808 { "name": "nodeId", "$ref": "DOM.NodeId", "description": "Identifier of the node to set breakpoint on." },
1809 { "name": "type", "$ref": "DOMBreakpointType", "description": "Type of the operation to stop upon." }
1810 ],
1811 "description": "Sets breakpoint on particular operation with DOM."
1812 },
1813 {
1814 "name": "removeDOMBreakpoint",
1815 "parameters": [
1816 { "name": "nodeId", "$ref": "DOM.NodeId", "description": "Identifier of the node to remove breakpoint from." },
1817 { "name": "type", "$ref": "DOMBreakpointType", "description": "Type of the breakpoint to remove." }
1818 ],
1819 "description": "Removes DOM breakpoint that was set using <code>setDOMBreakpoint</code>."
1820 },
1821 {
1822 "name": "setEventListenerBreakpoint",
1823 "parameters": [
1824 { "name": "eventName", "type": "string", "description": "Event name to stop on (any DOM event will do)." }
1825 ],
1826 "description": "Sets breakpoint on particular DOM event."
1827 },
1828 {
1829 "name": "removeEventListenerBreakpoint",
1830 "parameters": [
1831 { "name": "eventName", "type": "string", "description": "Event name." }
1832 ],
1833 "description": "Removes breakpoint on particular DOM event."
1834 },
1835 {
1836 "name": "setXHRBreakpoint",
1837 "parameters": [
1838 { "name": "url", "type": "string", "description": "Resource URL substring. All XHRs having this substring in the URL will get stopped upon." }
1839 ],
1840 "description": "Sets breakpoint on XMLHttpRequest."
1841 },
1842 {
1843 "name": "removeXHRBreakpoint",
1844 "parameters": [
1845 { "name": "url", "type": "string", "description": "Resource URL substring." }
1846 ],
1847 "description": "Removes breakpoint from XMLHttpRequest."
1848 }
1849 ]
1850 },
1851 {
1852 "domain": "Profiler",
1853 "hidden": true,
1854 "types": [
1855 {
1856 "id": "Profile",
1857 "type": "object",
1858 "description": "Profile."
1859 },
1860 {
1861 "id": "ProfileHeader",
1862 "type": "object",
1863 "description": "Profile header."
1864 }
1865 ],
1866 "commands": [
1867 {
1868 "name": "enable"
1869 },
1870 {
1871 "name": "disable"
1872 },
1873 {
1874 "name": "isEnabled",
1875 "returns": [
1876 { "name": "state", "type": "boolean" }
1877 ]
1878 },
1879 {
1880 "name": "start"
1881 },
1882 {
1883 "name": "stop"
1884 },
1885 {
1886 "name": "getProfileHeaders",
1887 "returns": [
1888 { "name": "headers", "type": "array", "items": { "$ref": "ProfileHeader"} }
1889 ]
1890 },
1891 {
1892 "name": "getProfile",
1893 "parameters": [
1894 { "name": "type", "type": "string" },
1895 { "name": "uid", "type": "integer" }
1896 ],
1897 "returns": [
1898 { "name": "profile", "$ref": "Profile" }
1899 ]
1900 },
1901 {
1902 "name": "removeProfile",
1903 "parameters": [
1904 { "name": "type", "type": "string" },
1905 { "name": "uid", "type": "integer" }
1906 ]
1907 },
1908 {
1909 "name": "clearProfiles"
1910 },
1911 {
1912 "name": "takeHeapSnapshot"
1913 },
1914 {
1915 "name": "collectGarbage"
1916 }
1917 ],
1918 "events": [
1919 {
1920 "name": "profilerWasEnabled"
1921 },
1922 {
1923 "name": "profilerWasDisabled"
1924 },
1925 {
1926 "name": "addProfileHeader",
1927 "parameters": [
1928 { "name": "header", "$ref": "ProfileHeader" }
1929 ]
1930 },
1931 {
1932 "name": "addHeapSnapshotChunk",
1933 "parameters": [
1934 { "name": "uid", "type": "integer" },
1935 { "name": "chunk", "type": "string" }
1936 ]
1937 },
1938 {
1939 "name": "finishHeapSnapshot",
1940 "parameters": [
1941 { "name": "uid", "type": "integer" }
1942 ]
1943 },
1944 {
1945 "name": "setRecordingProfile",
1946 "parameters": [
1947 { "name": "isProfiling", "type": "boolean" }
1948 ]
1949 },
1950 {
1951 "name": "resetProfiles"
1952 },
1953 {
1954 "name": "reportHeapSnapshotProgress",
1955 "parameters": [
1956 { "name": "done", "type": "integer" },
1957 { "name": "total", "type": "integer" }
1958 ]
1959 }
1960 ]
1961 },
1962 {
1963 "domain": "Worker",
1964 "hidden": true,
1965 "types": [],
1966 "commands": [
1967 {
1968 "name": "setWorkerInspectionEnabled",
1969 "parameters": [
1970 { "name": "value", "type": "boolean" }
1971 ]
1972 },
1973 {
1974 "name": "sendMessageToWorker",
1975 "parameters": [
1976 { "name": "workerId", "type": "integer" },
1977 { "name": "message", "type": "object" }
1978 ]
1979 },
1980 {
1981 "name": "connectToWorker",
1982 "parameters": [
1983 { "name": "workerId", "type": "integer" }
1984 ]
1985 },
1986 {
1987 "name": "disconnectFromWorker",
1988 "parameters": [
1989 { "name": "workerId", "type": "integer" }
1990 ]
1991 },
1992 {
1993 "name": "setAutoconnectToWorkers",
1994 "parameters": [
1995 { "name": "value", "type": "boolean" }
1996 ]
1997 }
1999 ],
2000 "events": [
2001 {
2002 "name": "workerCreated",
2003 "parameters": [
2004 { "name": "workerId", "type": "integer" },
2005 { "name": "url", "type": "string" },
2006 { "name": "inspectorConnected", "type": "boolean" }
2007 ]
2008 },
2009 {
2010 "name": "workerTerminated",
2011 "parameters": [
2012 { "name": "workerId", "type": "integer" }
2013 ]
2014 },
2015 {
2016 "name": "dispatchMessageFromWorker",
2017 "parameters": [
2018 { "name": "workerId", "type": "integer" },
2019 { "name": "message", "type": "object" }
2020 ]
2021 }
2022 ]
2023 }]
2024 }