| blob | 42541d4f5ea0b0e1bfe1c3a7babf5e0a9a578d55 |
1 {
2 "version": { "major": "1", "minor": "1" },
3 "domains": [{
4 "domain": "Inspector",
5 "hidden": true,
6 "types": [],
7 "commands": [
8 {
9 "name": "enable",
10 "description": "Enables inspector domain notifications."
11 },
12 {
13 "name": "disable",
14 "description": "Disables inspector domain notifications."
15 },
16 {
17 "name": "reset",
18 "description": "Resets all domains."
19 }
20 ],
21 "events": [
22 {
23 "name": "evaluateForTestInFrontend",
24 "parameters": [
25 { "name": "testCallId", "type": "integer" },
26 { "name": "script", "type": "string" }
27 ]
28 },
29 {
30 "name": "inspect",
31 "parameters": [
32 { "name": "object", "$ref": "Runtime.RemoteObject" },
33 { "name": "hints", "type": "object" }
34 ]
35 },
36 {
37 "name": "detached",
38 "description": "Fired when remote debugging connection is about to be terminated. Contains detach reason.",
39 "parameters": [
40 { "name": "reason", "type": "string", "description": "The reason why connection has been terminated." }
41 ]
42 },
43 {
44 "name": "targetCrashed",
45 "description": "Fired when debugging target has crashed"
46 }
47 ]
48 },
49 {
50 "domain": "Memory",
51 "hidden": true,
52 "types": [
53 {
54 "id": "MemoryBlock",
55 "type": "object",
56 "properties": [
57 { "name": "size", "type": "number", "optional": true, "description": "Size of the block in bytes if available" },
58 { "name": "name", "type": "string", "description": "Unique name used to identify the component that allocated this block" },
59 { "name": "children", "type": "array", "optional": true, "items": { "$ref": "MemoryBlock" }}
60 ]
61 },
62 {
63 "id": "HeapSnapshotChunk",
64 "type": "object",
65 "properties": [
66 { "name": "strings", "type": "array", "items": { "type": "string" }, "description": "An array of strings that were found since last update." },
67 { "name": "nodes", "type": "array", "items": { "type": "integer" }, "description": "An array of nodes that were found since last update." },
68 { "name": "edges", "type": "array", "items": { "type": "integer" }, "description": "An array of edges that were found since last update." },
69 { "name": "baseToRealNodeId", "type": "array", "items": { "type": "integer" }, "description": "An array of integers for nodeId remapping. Even nodeId has to be mapped to the following odd nodeId." }
70 ]
71 }
72 ],
73 "commands": [
74 {
75 "name": "getDOMCounters",
76 "returns": [
77 { "name": "documents", "type": "integer" },
78 { "name": "nodes", "type": "integer" },
79 { "name": "jsEventListeners", "type": "integer" }
80 ]
81 }
82 ],
83 "events": [
84 {
85 "name": "addNativeSnapshotChunk",
86 "parameters": [
87 { "name": "chunk", "$ref": "HeapSnapshotChunk", "description": "A chunk of the serialized the snapshot." }
88 ]
89 }
90 ]
91 },
92 {
93 "domain": "Page",
94 "description": "Actions and events related to the inspected page belong to the page domain.",
95 "types": [
96 {
97 "id": "ResourceType",
98 "type": "string",
99 "enum": ["Document", "Stylesheet", "Image", "Font", "Script", "XHR", "WebSocket", "Other"],
100 "description": "Resource type as it was perceived by the rendering engine."
101 },
102 {
103 "id": "FrameId",
104 "type": "string",
105 "description": "Unique frame identifier."
106 },
107 {
108 "id": "Frame",
109 "type": "object",
110 "description": "Information about the Frame on the page.",
111 "properties": [
112 { "name": "id", "type": "string", "description": "Frame unique identifier." },
113 { "name": "parentId", "type": "string", "optional": true, "description": "Parent frame identifier." },
114 { "name": "loaderId", "$ref": "Network.LoaderId", "description": "Identifier of the loader associated with this frame." },
115 { "name": "name", "type": "string", "optional": true, "description": "Frame's name as specified in the tag." },
116 { "name": "url", "type": "string", "description": "Frame document's URL." },
117 { "name": "securityOrigin", "type": "string", "description": "Frame document's security origin." },
118 { "name": "mimeType", "type": "string", "description": "Frame document's mimeType as determined by the browser." }
119 ]
120 },
121 {
122 "id": "FrameResourceTree",
123 "type": "object",
124 "description": "Information about the Frame hierarchy along with their cached resources.",
125 "properties": [
126 { "name": "frame", "$ref": "Frame", "description": "Frame information for this tree item." },
127 { "name": "childFrames", "type": "array", "optional": true, "items": { "$ref": "FrameResourceTree" }, "description": "Child frames." },
128 { "name": "resources", "type": "array",
129 "items": {
130 "type": "object",
131 "properties": [
132 { "name": "url", "type": "string", "description": "Resource URL." },
133 { "name": "type", "$ref": "ResourceType", "description": "Type of this resource." },
134 { "name": "mimeType", "type": "string", "description": "Resource mimeType as determined by the browser." },
135 { "name": "failed", "type": "boolean", "optional": true, "description": "True if the resource failed to load." },
136 { "name": "canceled", "type": "boolean", "optional": true, "description": "True if the resource was canceled during loading." }
137 ]
138 },
139 "description": "Information about frame resources."
140 }
141 ],
142 "hidden": true
143 },
144 {
145 "id": "SearchMatch",
146 "type": "object",
147 "description": "Search match for resource.",
148 "properties": [
149 { "name": "lineNumber", "type": "number", "description": "Line number in resource content." },
150 { "name": "lineContent", "type": "string", "description": "Line with match content." }
151 ],
152 "hidden": true
153 },
154 {
155 "id": "SearchResult",
156 "type": "object",
157 "description": "Search result for resource.",
158 "properties": [
159 { "name": "url", "type": "string", "description": "Resource URL." },
160 { "name": "frameId", "$ref": "FrameId", "description": "Resource frame id." },
161 { "name": "matchesCount", "type": "number", "description": "Number of matches in the resource content." }
162 ],
163 "hidden": true
164 },
165 {
166 "id": "Cookie",
167 "type": "object",
168 "description": "Cookie object",
169 "properties": [
170 { "name": "name", "type": "string", "description": "Cookie name." },
171 { "name": "value", "type": "string", "description": "Cookie value." },
172 { "name": "domain", "type": "string", "description": "Cookie domain." },
173 { "name": "path", "type": "string", "description": "Cookie path." },
174 { "name": "expires", "type": "number", "description": "Cookie expires." },
175 { "name": "size", "type": "integer", "description": "Cookie size." },
176 { "name": "httpOnly", "type": "boolean", "description": "True if cookie is http-only." },
177 { "name": "secure", "type": "boolean", "description": "True if cookie is secure." },
178 { "name": "session", "type": "boolean", "description": "True in case of session cookie." }
179 ],
180 "hidden": true
181 },
182 {
183 "id": "ScriptIdentifier",
184 "type": "string",
185 "description": "Unique script identifier.",
186 "hidden": true
187 },
188 {
189 "id": "NavigationEntry",
190 "type": "object",
191 "description": "Navigation history entry.",
192 "properties": [
193 { "name": "id", "type": "integer", "description": "Unique id of the navigation history entry." },
194 { "name": "url", "type": "string", "description": "URL of the navigation history entry." },
195 { "name": "title", "type": "string", "description": "Title of the navigation history entry." }
196 ],
197 "hidden": true
198 }
199 ],
200 "commands": [
201 {
202 "name": "enable",
203 "description": "Enables page domain notifications."
204 },
205 {
206 "name": "disable",
207 "description": "Disables page domain notifications."
208 },
209 {
210 "name": "addScriptToEvaluateOnLoad",
211 "parameters": [
212 { "name": "scriptSource", "type": "string" }
213 ],
214 "returns": [
215 { "name": "identifier", "$ref": "ScriptIdentifier", "description": "Identifier of the added script." }
216 ],
217 "hidden": true
218 },
219 {
220 "name": "removeScriptToEvaluateOnLoad",
221 "parameters": [
222 { "name": "identifier", "$ref": "ScriptIdentifier" }
223 ],
224 "hidden": true
225 },
226 {
227 "name": "reload",
228 "parameters": [
229 { "name": "ignoreCache", "type": "boolean", "optional": true, "description": "If true, browser cache is ignored (as if the user pressed Shift+refresh)." },
230 { "name": "scriptToEvaluateOnLoad", "type": "string", "optional": true, "description": "If set, the script will be injected into all frames of the inspected page after reload." },
231 { "name": "scriptPreprocessor", "type": "string", "optional": true, "description": "Script body that should evaluate to function that will preprocess all the scripts before their compilation.", "hidden": true }
232 ],
233 "description": "Reloads given page optionally ignoring the cache."
234 },
235 {
236 "name": "navigate",
237 "parameters": [
238 { "name": "url", "type": "string", "description": "URL to navigate the page to." }
239 ],
240 "description": "Navigates current page to the given URL."
241 },
242 {
243 "name": "getNavigationHistory",
244 "parameters": [],
245 "returns": [
246 { "name": "currentIndex", "type": "integer", "description": "Index of the current navigation history entry." },
247 { "name": "entries", "type": "array", "items": { "$ref": "NavigationEntry"}, "description": "Array of navigation history entries." }
248 ],
249 "description": "Returns navigation history for the current page.",
250 "hidden": true
251 },
252 {
253 "name": "navigateToHistoryEntry",
254 "parameters": [
255 { "name": "entryId", "type": "integer", "description": "Unique id of the entry to navigate to." }
256 ],
257 "description": "Navigates current page to the given history entry.",
258 "hidden": true
259 },
260 {
261 "name": "getCookies",
262 "returns": [
263 { "name": "cookies", "type": "array", "items": { "$ref": "Cookie"}, "description": "Array of cookie objects." },
264 { "name": "cookiesString", "type": "string", "description": "document.cookie string representation of the cookies." }
265 ],
266 "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>.",
267 "hidden": true
268 },
269 {
270 "name": "deleteCookie",
271 "parameters": [
272 { "name": "cookieName", "type": "string", "description": "Name of the cookie to remove." },
273 { "name": "url", "type": "string", "description": "URL to match cooke domain and path." }
274 ],
275 "description": "Deletes browser cookie with given name, domain and path.",
276 "hidden": true
277 },
278 {
279 "name": "getResourceTree",
280 "description": "Returns present frame / resource tree structure.",
281 "returns": [
282 { "name": "frameTree", "$ref": "FrameResourceTree", "description": "Present frame / resource tree structure." }
283 ],
284 "hidden": true
285 },
286 {
287 "name": "getResourceContent",
288 "description": "Returns content of the given resource.",
289 "parameters": [
290 { "name": "frameId", "$ref": "FrameId", "description": "Frame id to get resource for." },
291 { "name": "url", "type": "string", "description": "URL of the resource to get content for." }
292 ],
293 "returns": [
294 { "name": "content", "type": "string", "description": "Resource content." },
295 { "name": "base64Encoded", "type": "boolean", "description": "True, if content was served as base64." }
296 ],
297 "hidden": true
298 },
299 {
300 "name": "searchInResource",
301 "description": "Searches for given string in resource content.",
302 "parameters": [
303 { "name": "frameId", "$ref": "FrameId", "description": "Frame id for resource to search in." },
304 { "name": "url", "type": "string", "description": "URL of the resource to search in." },
305 { "name": "query", "type": "string", "description": "String to search for." },
306 { "name": "caseSensitive", "type": "boolean", "optional": true, "description": "If true, search is case sensitive." },
307 { "name": "isRegex", "type": "boolean", "optional": true, "description": "If true, treats string parameter as regex." }
308 ],
309 "returns": [
310 { "name": "result", "type": "array", "items": { "$ref": "SearchMatch" }, "description": "List of search matches." }
311 ],
312 "hidden": true
313 },
314 {
315 "name": "searchInResources",
316 "description": "Searches for given string in frame / resource tree structure.",
317 "parameters": [
318 { "name": "text", "type": "string", "description": "String to search for." },
319 { "name": "caseSensitive", "type": "boolean", "optional": true, "description": "If true, search is case sensitive." },
320 { "name": "isRegex", "type": "boolean", "optional": true, "description": "If true, treats string parameter as regex." }
321 ],
322 "returns": [
323 { "name": "result", "type": "array", "items": { "$ref": "SearchResult" }, "description": "List of search results." }
324 ],
325 "hidden": true
326 },
327 {
328 "name": "setDocumentContent",
329 "description": "Sets given markup as the document's HTML.",
330 "parameters": [
331 { "name": "frameId", "$ref": "FrameId", "description": "Frame id to set HTML for." },
332 { "name": "html", "type": "string", "description": "HTML content to set." }
333 ],
334 "hidden": true
335 },
336 {
337 "name": "setDeviceMetricsOverride",
338 "description": "Overrides the values of device screen dimensions (window.screen.width, window.screen.height, window.innerWidth, window.innerHeight, and \"device-width\"/\"device-height\"-related CSS media query results) and the font scale factor.",
339 "parameters": [
340 { "name": "width", "type": "integer", "description": "Overriding width value in pixels (minimum 0, maximum 10000000). 0 disables the override." },
341 { "name": "height", "type": "integer", "description": "Overriding height value in pixels (minimum 0, maximum 10000000). 0 disables the override." },
342 { "name": "fontScaleFactor", "type": "number", "description": "Overriding font scale factor value (must be positive). 1 disables the override." },
343 { "name": "fitWindow", "type": "boolean", "description": "Whether a view that exceeds the available browser window area should be scaled down to fit." }
344 ],
345 "hidden": true
346 },
347 {
348 "name": "setShowPaintRects",
349 "description": "Requests that backend shows paint rectangles",
350 "parameters": [
351 { "name": "result", "type": "boolean", "description": "True for showing paint rectangles" }
352 ],
353 "hidden": true
354 },
355 {
356 "name": "setShowDebugBorders",
357 "description": "Requests that backend shows debug borders on layers",
358 "parameters": [
359 { "name": "show", "type": "boolean", "description": "True for showing debug borders" }
360 ],
361 "hidden": true
362 },
363 {
364 "name": "setShowFPSCounter",
365 "description": "Requests that backend shows the FPS counter",
366 "parameters": [
367 { "name": "show", "type": "boolean", "description": "True for showing the FPS counter" }
368 ],
369 "hidden": true
370 },
371 {
372 "name": "setContinuousPaintingEnabled",
373 "description": "Requests that backend enables continuous painting",
374 "parameters": [
375 { "name": "enabled", "type": "boolean", "description": "True for enabling cointinuous painting" }
376 ],
377 "hidden": true
378 },
379 {
380 "name": "setShowScrollBottleneckRects",
381 "description": "Requests that backend shows scroll bottleneck rects",
382 "parameters": [
383 { "name": "show", "type": "boolean", "description": "True for showing scroll bottleneck rects" }
384 ],
385 "hidden": true
386 },
387 {
388 "name": "getScriptExecutionStatus",
389 "description": "Determines if scripts can be executed in the page.",
390 "returns": [
391 { "name": "result", "type": "string", "enum": ["allowed", "disabled", "forbidden"], "description": "Script execution status: \"allowed\" if scripts can be executed, \"disabled\" if script execution has been disabled through page settings, \"forbidden\" if script execution for the given page is not possible for other reasons." }
392 ],
393 "hidden": true
394 },
395 {
396 "name": "setScriptExecutionDisabled",
397 "description": "Switches script execution in the page.",
398 "parameters": [
399 { "name": "value", "type": "boolean", "description": "Whether script execution should be disabled in the page." }
400 ],
401 "hidden": true
402 },
403 {
404 "name": "setGeolocationOverride",
405 "description": "Overrides the Geolocation Position or Error.",
406 "parameters": [
407 { "name": "latitude", "type": "number", "optional": true, "description": "Mock longitude"},
408 { "name": "longitude", "type": "number", "optional": true, "description": "Mock latitude"},
409 { "name": "accuracy", "type": "number", "optional": true, "description": "Mock accuracy"}
410 ]
411 },
412 {
413 "name": "clearGeolocationOverride",
414 "description": "Clears the overriden Geolocation Position and Error."
415 },
416 {
417 "name": "setDeviceOrientationOverride",
418 "description": "Overrides the Device Orientation.",
419 "parameters": [
420 { "name": "alpha", "type": "number", "description": "Mock alpha"},
421 { "name": "beta", "type": "number", "description": "Mock beta"},
422 { "name": "gamma", "type": "number", "description": "Mock gamma"}
423 ],
424 "hidden": true
425 },
426 {
427 "name": "clearDeviceOrientationOverride",
428 "description": "Clears the overridden Device Orientation.",
429 "hidden": true
430 },
431 {
432 "name": "setTouchEmulationEnabled",
433 "parameters": [
434 { "name": "enabled", "type": "boolean", "description": "Whether the touch event emulation should be enabled." }
435 ],
436 "description": "Toggles mouse event-based touch event emulation.",
437 "hidden": true
438 },
439 {
440 "name": "setEmulatedMedia",
441 "parameters": [
442 { "name": "media", "type": "string", "description": "Media type to emulate. Empty string disables the override." }
443 ],
444 "description": "Emulates the given media for CSS media queries.",
445 "hidden": true
446 },
447 {
448 "name": "captureScreenshot",
449 "description": "Capture page screenshot.",
450 "parameters": [
451 { "name": "format", "type": "string", "optional": true, "enum": ["jpeg", "png"], "description": "Image compression format." },
452 { "name": "quality", "type": "integer", "hidden": true, "optional": true, "description": "Compression quality from range [0..100]." },
453 { "name": "maxWidth", "type": "integer", "hidden": true, "optional": true, "description": "Maximum screenshot width." },
454 { "name": "maxHeight", "type": "integer", "hidden": true, "optional": true, "description": "Maximum screenshot height." }
455 ],
456 "returns": [
457 { "name": "data", "type": "string", "description": "Base64-encoded image data (PNG)." },
458 { "name": "deviceScaleFactor", "type": "number", "hidden": true, "description": "Device scale factor." },
459 { "name": "pageScaleFactor", "type": "number", "hidden": true, "description": "Page scale factor." },
460 { "name": "viewport", "$ref": "DOM.Rect", "hidden": true, "description": "Viewport in CSS pixels." }
461 ],
462 "hidden": true
463 },
464 {
465 "name": "startScreencast",
466 "description": "Starts sending each frame using the <code>screencastFrame</code> event.",
467 "parameters": [
468 { "name": "format", "type": "string", "optional": true, "enum": ["jpeg", "png"], "description": "Image compression format." },
469 { "name": "quality", "type": "integer", "optional": true, "description": "Compression quality from range [0..100]." },
470 { "name": "maxWidth", "type": "integer", "optional": true, "description": "Maximum screenshot width." },
471 { "name": "maxHeight", "type": "integer", "optional": true, "description": "Maximum screenshot height." }
472 ],
473 "hidden": true
474 },
475 {
476 "name": "stopScreencast",
477 "description": "Stops sending each frame in the <code>screencastFrame</code>.",
478 "hidden": true
479 },
480 {
481 "name": "handleJavaScriptDialog",
482 "description": "Accepts or dismisses a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload).",
483 "parameters": [
484 { "name": "accept", "type": "boolean", "description": "Whether to accept or dismiss the dialog." },
485 { "name": "promptText", "type": "string", "optional": true, "description": "The text to enter into the dialog prompt before accepting. Used only if this is a prompt dialog." }
486 ],
487 "hidden": true
488 },
489 {
490 "name": "setShowViewportSizeOnResize",
491 "description": "Paints viewport size upon main frame resize.",
492 "parameters": [
493 { "name": "show", "type": "boolean", "description": "Whether to paint size or not." },
494 { "name": "showGrid", "type": "boolean", "optional": true, "description": "Whether to paint grid as well." }
495 ],
496 "hidden": true
497 },
498 {
499 "name": "setForceCompositingMode",
500 "description": "Force accelerated compositing mode for inspected page.",
501 "parameters": [
502 { "name": "force", "type": "boolean", "description": "Whether to force accelerated compositing or not." }
503 ],
504 "hidden": true
505 }
506 ],
507 "events": [
508 {
509 "name": "domContentEventFired",
510 "parameters": [
511 { "name": "timestamp", "type": "number" }
512 ]
513 },
514 {
515 "name": "loadEventFired",
516 "parameters": [
517 { "name": "timestamp", "type": "number" }
518 ]
519 },
520 {
521 "name": "frameAttached",
522 "description": "Fired when frame has been attached to its parent.",
523 "parameters": [
524 { "name": "frameId", "$ref": "FrameId", "description": "Id of the frame that has been attached." }
525 ]
526 },
527 {
528 "name": "frameNavigated",
529 "description": "Fired once navigation of the frame has completed. Frame is now associated with the new loader.",
530 "parameters": [
531 { "name": "frame", "$ref": "Frame", "description": "Frame object." }
532 ]
533 },
534 {
535 "name": "frameDetached",
536 "description": "Fired when frame has been detached from its parent.",
537 "parameters": [
538 { "name": "frameId", "$ref": "FrameId", "description": "Id of the frame that has been detached." }
539 ]
540 },
541 {
542 "name": "frameStartedLoading",
543 "description": "Fired when frame has started loading.",
544 "parameters": [
545 { "name": "frameId", "$ref": "FrameId", "description": "Id of the frame that has started loading." }
546 ],
547 "hidden": true
548 },
549 {
550 "name": "frameStoppedLoading",
551 "description": "Fired when frame has stopped loading.",
552 "parameters": [
553 { "name": "frameId", "$ref": "FrameId", "description": "Id of the frame that has stopped loading." }
554 ],
555 "hidden": true
556 },
557 {
558 "name": "frameScheduledNavigation",
559 "description": "Fired when frame schedules a potential navigation.",
560 "parameters": [
561 { "name": "frameId", "$ref": "FrameId", "description": "Id of the frame that has scheduled a navigation." },
562 { "name": "delay", "type": "number", "description": "Delay (in seconds) until the navigation is scheduled to begin. The navigation is not guaranteed to start." }
563 ],
564 "hidden": true
565 },
566 {
567 "name": "frameClearedScheduledNavigation",
568 "description": "Fired when frame no longer has a scheduled navigation.",
569 "parameters": [
570 { "name": "frameId", "$ref": "FrameId", "description": "Id of the frame that has cleared its scheduled navigation." }
571 ],
572 "hidden": true
573 },
574 {
575 "name": "javascriptDialogOpening",
576 "description": "Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) is about to open.",
577 "parameters": [
578 { "name": "message", "type": "string", "description": "Message that will be displayed by the dialog." }
579 ],
580 "hidden": true
581 },
582 {
583 "name": "javascriptDialogClosed",
584 "description": "Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) has been closed.",
585 "hidden": true
586 },
587 {
588 "name": "scriptsEnabled",
589 "description": "Fired when the JavaScript is enabled/disabled on the page",
590 "parameters": [
591 { "name": "isEnabled", "type": "boolean", "description": "Whether script execution is enabled or disabled on the page." }
592 ],
593 "hidden": true
594 },
595 {
596 "name": "screencastFrame",
597 "description": "Compressed image data requested by the <code>startScreencast</code>.",
598 "parameters": [
599 { "name": "data", "type": "string", "description": "Base64-encoded compressed image." },
600 { "name": "deviceScaleFactor", "type": "number", "hidden": true, "optional": true, "description": "Device scale factor." },
601 { "name": "pageScaleFactor", "type": "number", "hidden": true, "optional": true, "description": "Page scale factor." },
602 { "name": "viewport", "$ref": "DOM.Rect", "hidden": true, "optional": true, "description": "Viewport in CSS pixels." },
603 { "name": "offsetTop", "type": "number", "hidden": true, "optional": true, "description": "Top offset in DIP." },
604 { "name": "offsetBottom", "type": "number", "hidden": true, "optional": true, "description": "Bottom offset in DIP." }
605 ],
606 "hidden": true
607 }
608 ]
609 },
610 {
611 "domain": "Runtime",
612 "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.",
613 "types": [
614 {
615 "id": "RemoteObjectId",
616 "type": "string",
617 "description": "Unique object identifier."
618 },
619 {
620 "id": "RemoteObject",
621 "type": "object",
622 "description": "Mirror object referencing original JavaScript object.",
623 "properties": [
624 { "name": "type", "type": "string", "enum": ["object", "function", "undefined", "string", "number", "boolean"], "description": "Object type." },
625 { "name": "subtype", "type": "string", "optional": true, "enum": ["array", "null", "node", "regexp", "date"], "description": "Object subtype hint. Specified for <code>object</code> type values only." },
626 { "name": "className", "type": "string", "optional": true, "description": "Object class (constructor) name. Specified for <code>object</code> type values only." },
627 { "name": "value", "type": "any", "optional": true, "description": "Remote object value (in case of primitive values or JSON values if it was requested)." },
628 { "name": "description", "type": "string", "optional": true, "description": "String representation of the object." },
629 { "name": "objectId", "$ref": "RemoteObjectId", "optional": true, "description": "Unique object identifier (for non-primitive values)." },
630 { "name": "preview", "$ref": "ObjectPreview", "optional": true, "description": "Preview containing abbreviated property values.", "hidden": true }
631 ]
632 },
633 {
634 "id": "ObjectPreview",
635 "type": "object",
636 "hidden": true,
637 "description": "Object containing abbreviated remote object value.",
638 "properties": [
639 { "name": "lossless", "type": "boolean", "description": "Determines whether preview is lossless (contains all information of the original object)." },
640 { "name": "overflow", "type": "boolean", "description": "True iff some of the properties of the original did not fit." },
641 { "name": "properties", "type": "array", "items": { "$ref": "PropertyPreview" }, "description": "List of the properties." }
642 ]
643 },
644 {
645 "id": "PropertyPreview",
646 "type": "object",
647 "hidden": true,
648 "properties": [
649 { "name": "name", "type": "string", "description": "Property name." },
650 { "name": "type", "type": "string", "enum": ["object", "function", "undefined", "string", "number", "boolean"], "description": "Object type." },
651 { "name": "value", "type": "string", "optional": true, "description": "User-friendly property value string." },
652 { "name": "valuePreview", "$ref": "ObjectPreview", "optional": true, "description": "Nested value preview." },
653 { "name": "subtype", "type": "string", "optional": true, "enum": ["array", "null", "node", "regexp", "date"], "description": "Object subtype hint. Specified for <code>object</code> type values only." }
654 ]
655 },
656 {
657 "id": "PropertyDescriptor",
658 "type": "object",
659 "description": "Object property descriptor.",
660 "properties": [
661 { "name": "name", "type": "string", "description": "Property name." },
662 { "name": "value", "$ref": "RemoteObject", "optional": true, "description": "The value associated with the property." },
663 { "name": "writable", "type": "boolean", "optional": true, "description": "True if the value associated with the property may be changed (data descriptors only)." },
664 { "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)." },
665 { "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)." },
666 { "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." },
667 { "name": "enumerable", "type": "boolean", "description": "True if this property shows up during enumeration of the properties on the corresponding object." },
668 { "name": "wasThrown", "type": "boolean", "optional": true, "description": "True if the result was thrown during the evaluation." },
669 { "name": "isOwn", "optional": true, "type": "boolean", "description": "True if the property is owned for the object.", "hidden": true }
671 ]
672 },
673 {
674 "id": "InternalPropertyDescriptor",
675 "type": "object",
676 "description": "Object internal property descriptor. This property isn't normally visible in JavaScript code.",
677 "properties": [
678 { "name": "name", "type": "string", "description": "Conventional property name." },
679 { "name": "value", "$ref": "RemoteObject", "optional": true, "description": "The value associated with the property." }
680 ],
681 "hidden": true
682 },
683 {
684 "id": "CallArgument",
685 "type": "object",
686 "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.",
687 "properties": [
688 { "name": "value", "type": "any", "optional": true, "description": "Primitive value." },
689 { "name": "objectId", "$ref": "RemoteObjectId", "optional": true, "description": "Remote object handle." }
690 ]
691 },
692 {
693 "id": "ExecutionContextId",
694 "type": "integer",
695 "description": "Id of an execution context."
696 },
697 {
698 "id": "ExecutionContextDescription",
699 "type": "object",
700 "description": "Description of an isolated world.",
701 "properties": [
702 { "name": "id", "$ref": "ExecutionContextId", "description": "Unique id of the execution context. It can be used to specify in which execution context script evaluation should be performed." },
703 { "name": "isPageContext", "type": "boolean", "description": "True if this is a context where inpspected web page scripts run. False if it is a content script isolated context.", "hidden": true },
704 { "name": "name", "type": "string", "description": "Human readable name describing given context.", "hidden": true},
705 { "name": "frameId", "$ref": "Page.FrameId", "description": "Id of the owning frame." }
706 ]
707 }
709 ],
710 "commands": [
711 {
712 "name": "evaluate",
713 "parameters": [
714 { "name": "expression", "type": "string", "description": "Expression to evaluate." },
715 { "name": "objectGroup", "type": "string", "optional": true, "description": "Symbolic group name that can be used to release multiple objects." },
716 { "name": "includeCommandLineAPI", "type": "boolean", "optional": true, "description": "Determines whether Command Line API should be available during the evaluation.", "hidden": true },
717 { "name": "doNotPauseOnExceptionsAndMuteConsole", "type": "boolean", "optional": true, "description": "Specifies whether evaluation should stop on exceptions and mute console. Overrides setPauseOnException state.", "hidden": true },
718 { "name": "contextId", "$ref": "Runtime.ExecutionContextId", "optional": true, "description": "Specifies in which isolated context to perform evaluation. Each content script lives in an isolated context and this parameter may be used to specify one of those contexts. If the parameter is omitted or 0 the evaluation will be performed in the context of the inspected page." },
719 { "name": "returnByValue", "type": "boolean", "optional": true, "description": "Whether the result is expected to be a JSON object that should be sent by value." },
720 { "name": "generatePreview", "type": "boolean", "optional": true, "hidden": true, "description": "Whether preview should be generated for the result." }
721 ],
722 "returns": [
723 { "name": "result", "$ref": "RemoteObject", "description": "Evaluation result." },
724 { "name": "wasThrown", "type": "boolean", "optional": true, "description": "True if the result was thrown during the evaluation." }
725 ],
726 "description": "Evaluates expression on global object."
727 },
728 {
729 "name": "callFunctionOn",
730 "parameters": [
731 { "name": "objectId", "$ref": "RemoteObjectId", "description": "Identifier of the object to call function on." },
732 { "name": "functionDeclaration", "type": "string", "description": "Declaration of the function to call." },
733 { "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." },
734 { "name": "doNotPauseOnExceptionsAndMuteConsole", "type": "boolean", "optional": true, "description": "Specifies whether function call should stop on exceptions and mute console. Overrides setPauseOnException state.", "hidden": true },
735 { "name": "returnByValue", "type": "boolean", "optional": true, "description": "Whether the result is expected to be a JSON object which should be sent by value." },
736 { "name": "generatePreview", "type": "boolean", "optional": true, "hidden": true, "description": "Whether preview should be generated for the result." }
737 ],
738 "returns": [
739 { "name": "result", "$ref": "RemoteObject", "description": "Call result." },
740 { "name": "wasThrown", "type": "boolean", "optional": true, "description": "True if the result was thrown during the evaluation." }
741 ],
742 "description": "Calls function with given declaration on the given object. Object group of the result is inherited from the target object."
743 },
744 {
745 "name": "getProperties",
746 "parameters": [
747 { "name": "objectId", "$ref": "RemoteObjectId", "description": "Identifier of the object to return properties for." },
748 { "name": "ownProperties", "optional": true, "type": "boolean", "description": "If true, returns properties belonging only to the element itself, not to its prototype chain." },
749 { "name": "accessorPropertiesOnly", "optional": true, "type": "boolean", "description": "If true, returns accessor properties (with getter/setter) only; internal properties are not returned either.", "hidden": true }
750 ],
751 "returns": [
752 { "name": "result", "type": "array", "items": { "$ref": "PropertyDescriptor"}, "description": "Object properties." },
753 { "name": "internalProperties", "optional": true, "type": "array", "items": { "$ref": "InternalPropertyDescriptor"}, "description": "Internal object properties (only of the element itself).", "hidden": true }
754 ],
755 "description": "Returns properties of a given object. Object group of the result is inherited from the target object."
756 },
757 {
758 "name": "releaseObject",
759 "parameters": [
760 { "name": "objectId", "$ref": "RemoteObjectId", "description": "Identifier of the object to release." }
761 ],
762 "description": "Releases remote object with given id."
763 },
764 {
765 "name": "releaseObjectGroup",
766 "parameters": [
767 { "name": "objectGroup", "type": "string", "description": "Symbolic object group name." }
768 ],
769 "description": "Releases all remote objects that belong to a given group."
770 },
771 {
772 "name": "run",
773 "hidden": true,
774 "description": "Tells inspected instance(worker or page) that it can run in case it was started paused."
775 },
776 {
777 "name": "enable",
778 "description": "Enables reporting of execution contexts creation by means of <code>executionContextCreated</code> event. When the reporting gets enabled the event will be sent immediately for each existing execution context."
779 },
780 {
781 "name": "disable",
782 "hidden": true,
783 "description": "Disables reporting of execution contexts creation."
784 }
785 ],
786 "events": [
787 {
788 "name": "executionContextCreated",
789 "parameters": [
790 { "name": "context", "$ref": "ExecutionContextDescription", "description": "A newly created execution contex." }
791 ],
792 "description": "Issued when new execution context is created."
793 }
794 ]
795 },
796 {
797 "domain": "Console",
798 "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.",
799 "types": [
800 {
801 "id": "Timestamp",
802 "type": "number",
803 "description": "Number of seconds since epoch.",
804 "hidden": true
805 },
806 {
807 "id": "ConsoleMessage",
808 "type": "object",
809 "description": "Console message.",
810 "properties": [
811 { "name": "source", "type": "string", "enum": ["xml", "javascript", "network", "console-api", "storage", "appcache", "rendering", "css", "security", "other", "deprecation"], "description": "Message source." },
812 { "name": "level", "type": "string", "enum": ["log", "warning", "error", "debug"], "description": "Message severity." },
813 { "name": "text", "type": "string", "description": "Message text." },
814 { "name": "type", "type": "string", "optional": true, "enum": ["log", "dir", "dirxml", "table", "trace", "clear", "startGroup", "startGroupCollapsed", "endGroup", "assert", "timing", "profile", "profileEnd"], "description": "Console message type." },
815 { "name": "url", "type": "string", "optional": true, "description": "URL of the message origin." },
816 { "name": "line", "type": "integer", "optional": true, "description": "Line number in the resource that generated this message." },
817 { "name": "column", "type": "integer", "optional": true, "description": "Column number in the resource that generated this message." },
818 { "name": "repeatCount", "type": "integer", "optional": true, "description": "Repeat count for repeated messages." },
819 { "name": "parameters", "type": "array", "items": { "$ref": "Runtime.RemoteObject" }, "optional": true, "description": "Message parameters in case of the formatted message." },
820 { "name": "stackTrace", "$ref": "StackTrace", "optional": true, "description": "JavaScript stack trace for assertions and error messages." },
821 { "name": "networkRequestId", "$ref": "Network.RequestId", "optional": true, "description": "Identifier of the network request associated with this message." },
822 { "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp, when this message was fired.", "hidden": true }
823 ]
824 },
825 {
826 "id": "CallFrame",
827 "type": "object",
828 "description": "Stack entry for console errors and assertions.",
829 "properties": [
830 { "name": "functionName", "type": "string", "description": "JavaScript function name." },
831 { "name": "scriptId", "type": "string", "description": "JavaScript script id." },
832 { "name": "url", "type": "string", "description": "JavaScript script name or url." },
833 { "name": "lineNumber", "type": "integer", "description": "JavaScript script line number." },
834 { "name": "columnNumber", "type": "integer", "description": "JavaScript script column number." }
835 ]
836 },
837 {
838 "id": "StackTrace",
839 "type": "array",
840 "items": { "$ref": "CallFrame" },
841 "description": "Call frames for assertions or error messages."
842 }
843 ],
844 "commands": [
845 {
846 "name": "enable",
847 "description": "Enables console domain, sends the messages collected so far to the client by means of the <code>messageAdded</code> notification."
848 },
849 {
850 "name": "disable",
851 "description": "Disables console domain, prevents further console messages from being reported to the client."
852 },
853 {
854 "name": "clearMessages",
855 "description": "Clears console messages collected in the browser."
856 },
857 {
858 "name": "setMonitoringXHREnabled",
859 "parameters": [
860 { "name": "enabled", "type": "boolean", "description": "Monitoring enabled state." }
861 ],
862 "description": "Toggles monitoring of XMLHttpRequest. If <code>true</code>, console will receive messages upon each XHR issued.",
863 "hidden": true
864 },
865 {
866 "name": "addInspectedNode",
867 "parameters": [
868 { "name": "nodeId", "$ref": "DOM.NodeId", "description": "DOM node id to be accessible by means of $x command line API." }
869 ],
870 "description": "Enables console to refer to the node with given id via $x (see Command Line API for more details $x functions).",
871 "hidden": true
872 },
873 {
874 "name": "addInspectedHeapObject",
875 "parameters": [
876 { "name": "heapObjectId", "type": "integer" }
877 ],
878 "hidden": true
879 }
880 ],
881 "events": [
882 {
883 "name": "messageAdded",
884 "parameters": [
885 { "name": "message", "$ref": "ConsoleMessage", "description": "Console message that has been added." }
886 ],
887 "description": "Issued when new console message is added."
888 },
889 {
890 "name": "messageRepeatCountUpdated",
891 "parameters": [
892 { "name": "count", "type": "integer", "description": "New repeat count value." },
893 { "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp of most recent message in batch.", "hidden": true }
894 ],
895 "description": "Issued when subsequent message(s) are equal to the previous one(s)."
896 },
897 {
898 "name": "messagesCleared",
899 "description": "Issued when console is cleared. This happens either upon <code>clearMessages</code> command or after page navigation."
900 }
901 ]
902 },
903 {
904 "domain": "Network",
905 "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.",
906 "types": [
907 {
908 "id": "LoaderId",
909 "type": "string",
910 "description": "Unique loader identifier."
911 },
912 {
913 "id": "RequestId",
914 "type": "string",
915 "description": "Unique request identifier."
916 },
917 {
918 "id": "Timestamp",
919 "type": "number",
920 "description": "Number of seconds since epoch."
921 },
922 {
923 "id": "Headers",
924 "type": "object",
925 "description": "Request / response headers as keys / values of JSON object."
926 },
927 {
928 "id": "ResourceTiming",
929 "type": "object",
930 "description": "Timing information for the request.",
931 "properties": [
932 { "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." },
933 { "name": "proxyStart", "type": "number", "description": "Started resolving proxy." },
934 { "name": "proxyEnd", "type": "number", "description": "Finished resolving proxy." },
935 { "name": "dnsStart", "type": "number", "description": "Started DNS address resolve." },
936 { "name": "dnsEnd", "type": "number", "description": "Finished DNS address resolve." },
937 { "name": "connectStart", "type": "number", "description": "Started connecting to the remote host." },
938 { "name": "connectEnd", "type": "number", "description": "Connected to the remote host." },
939 { "name": "sslStart", "type": "number", "description": "Started SSL handshake." },
940 { "name": "sslEnd", "type": "number", "description": "Finished SSL handshake." },
941 { "name": "sendStart", "type": "number", "description": "Started sending request." },
942 { "name": "sendEnd", "type": "number", "description": "Finished sending request." },
943 { "name": "receiveHeadersEnd", "type": "number", "description": "Finished receiving response headers." }
944 ]
945 },
946 {
947 "id": "Request",
948 "type": "object",
949 "description": "HTTP request data.",
950 "properties": [
951 { "name": "url", "type": "string", "description": "Request URL." },
952 { "name": "method", "type": "string", "description": "HTTP request method." },
953 { "name": "headers", "$ref": "Headers", "description": "HTTP request headers." },
954 { "name": "postData", "type": "string", "optional": true, "description": "HTTP POST request data." }
955 ]
956 },
957 {
958 "id": "Response",
959 "type": "object",
960 "description": "HTTP response data.",
961 "properties": [
962 { "name": "url", "type": "string", "description": "Response URL. This URL can be different from CachedResource.url in case of redirect." },
963 { "name": "status", "type": "number", "description": "HTTP response status code." },
964 { "name": "statusText", "type": "string", "description": "HTTP response status text." },
965 { "name": "headers", "$ref": "Headers", "description": "HTTP response headers." },
966 { "name": "headersText", "type": "string", "optional": true, "description": "HTTP response headers text." },
967 { "name": "mimeType", "type": "string", "description": "Resource mimeType as determined by the browser." },
968 { "name": "requestHeaders", "$ref": "Headers", "optional": true, "description": "Refined HTTP request headers that were actually transmitted over the network." },
969 { "name": "requestHeadersText", "type": "string", "optional": true, "description": "HTTP request headers text." },
970 { "name": "connectionReused", "type": "boolean", "description": "Specifies whether physical connection was actually reused for this request." },
971 { "name": "connectionId", "type": "number", "description": "Physical connection id that was actually used for this request." },
972 { "name": "fromDiskCache", "type": "boolean", "optional": true, "description": "Specifies that the request was served from the disk cache." },
973 { "name": "timing", "$ref": "ResourceTiming", "optional": true, "description": "Timing information for the given request." }
974 ]
975 },
976 {
977 "id": "WebSocketRequest",
978 "type": "object",
979 "description": "WebSocket request data.",
980 "hidden": true,
981 "properties": [
982 { "name": "headers", "$ref": "Headers", "description": "HTTP response headers." }
983 ]
984 },
985 {
986 "id": "WebSocketResponse",
987 "type": "object",
988 "description": "WebSocket response data.",
989 "hidden": true,
990 "properties": [
991 { "name": "status", "type": "number", "description": "HTTP response status code." },
992 { "name": "statusText", "type": "string", "description": "HTTP response status text." },
993 { "name": "headers", "$ref": "Headers", "description": "HTTP response headers." }
994 ]
995 },
996 {
997 "id": "WebSocketFrame",
998 "type": "object",
999 "description": "WebSocket frame data.",
1000 "hidden": true,
1001 "properties": [
1002 { "name": "opcode", "type": "number", "description": "WebSocket frame opcode." },
1003 { "name": "mask", "type": "boolean", "description": "WebSocke frame mask." },
1004 { "name": "payloadData", "type": "string", "description": "WebSocke frame payload data." }
1005 ]
1006 },
1007 {
1008 "id": "CachedResource",
1009 "type": "object",
1010 "description": "Information about the cached resource.",
1011 "properties": [
1012 { "name": "url", "type": "string", "description": "Resource URL. This is the url of the original network request." },
1013 { "name": "type", "$ref": "Page.ResourceType", "description": "Type of this resource." },
1014 { "name": "response", "$ref": "Response", "optional": true, "description": "Cached response data." },
1015 { "name": "bodySize", "type": "number", "description": "Cached response body size." }
1016 ]
1017 },
1018 {
1019 "id": "Initiator",
1020 "type": "object",
1021 "description": "Information about the request initiator.",
1022 "properties": [
1023 { "name": "type", "type": "string", "enum": ["parser", "script", "other"], "description": "Type of this initiator." },
1024 { "name": "stackTrace", "$ref": "Console.StackTrace", "optional": true, "description": "Initiator JavaScript stack trace, set for Script only." },
1025 { "name": "url", "type": "string", "optional": true, "description": "Initiator URL, set for Parser type only." },
1026 { "name": "lineNumber", "type": "number", "optional": true, "description": "Initiator line number, set for Parser type only." }
1027 ]
1028 }
1029 ],
1030 "commands": [
1031 {
1032 "name": "enable",
1033 "description": "Enables network tracking, network events will now be delivered to the client."
1034 },
1035 {
1036 "name": "disable",
1037 "description": "Disables network tracking, prevents network events from being sent to the client."
1038 },
1039 {
1040 "name": "setUserAgentOverride",
1041 "description": "Allows overriding user agent with the given string.",
1042 "parameters": [
1043 { "name": "userAgent", "type": "string", "description": "User agent to use." }
1044 ]
1045 },
1046 {
1047 "name": "setExtraHTTPHeaders",
1048 "description": "Specifies whether to always send extra HTTP headers with the requests from this page.",
1049 "parameters": [
1050 { "name": "headers", "$ref": "Headers", "description": "Map with extra HTTP headers." }
1051 ]
1052 },
1053 {
1054 "name": "getResponseBody",
1055 "description": "Returns content served for the given request.",
1056 "parameters": [
1057 { "name": "requestId", "$ref": "RequestId", "description": "Identifier of the network request to get content for." }
1058 ],
1059 "returns": [
1060 { "name": "body", "type": "string", "description": "Response body." },
1061 { "name": "base64Encoded", "type": "boolean", "description": "True, if content was sent as base64." }
1062 ]
1063 },
1064 {
1065 "name": "replayXHR",
1066 "description": "This method sends a new XMLHttpRequest which is identical to the original one. The following parameters should be identical: method, url, async, request body, extra headers, withCredentials attribute, user, password.",
1067 "parameters": [
1068 { "name": "requestId", "$ref": "RequestId", "description": "Identifier of XHR to replay." }
1069 ],
1070 "hidden": true
1071 },
1072 {
1073 "name": "canClearBrowserCache",
1074 "description": "Tells whether clearing browser cache is supported.",
1075 "returns": [
1076 { "name": "result", "type": "boolean", "description": "True if browser cache can be cleared." }
1077 ]
1078 },
1079 {
1080 "name": "clearBrowserCache",
1081 "description": "Clears browser cache."
1082 },
1083 {
1084 "name": "canClearBrowserCookies",
1085 "description": "Tells whether clearing browser cookies is supported.",
1086 "returns": [
1087 { "name": "result", "type": "boolean", "description": "True if browser cookies can be cleared." }
1088 ]
1089 },
1090 {
1091 "name": "clearBrowserCookies",
1092 "description": "Clears browser cookies."
1093 },
1094 {
1095 "name": "setCacheDisabled",
1096 "parameters": [
1097 { "name": "cacheDisabled", "type": "boolean", "description": "Cache disabled state." }
1098 ],
1099 "description": "Toggles ignoring cache for each request. If <code>true</code>, cache will not be used."
1100 },
1101 {
1102 "name": "loadResourceForFrontend",
1103 "async": true,
1104 "parameters": [
1105 { "name": "frameId", "$ref": "Page.FrameId", "description": "Frame to load the resource from." },
1106 { "name": "url", "type": "string", "description": "URL of the resource to load." },
1107 { "name": "requestHeaders", "$ref": "Network.Headers", "optional": true, "description": "Request headers." }
1108 ],
1109 "returns": [
1110 { "name": "statusCode", "type": "number", "description": "HTTP status code." },
1111 { "name": "responseHeaders", "$ref": "Network.Headers", "description": "Response headers." },
1112 { "name": "content", "type": "string", "description": "Resource content." }
1113 ],
1114 "description": "Loads a resource in the context of a frame on the inspected page without cross origin checks.",
1115 "hidden": true
1116 }
1117 ],
1118 "events": [
1119 {
1120 "name": "requestWillBeSent",
1121 "description": "Fired when page is about to send HTTP request.",
1122 "parameters": [
1123 { "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
1124 { "name": "frameId", "$ref": "Page.FrameId", "description": "Frame identifier.", "hidden": true },
1125 { "name": "loaderId", "$ref": "LoaderId", "description": "Loader identifier." },
1126 { "name": "documentURL", "type": "string", "description": "URL of the document this request is loaded for." },
1127 { "name": "request", "$ref": "Request", "description": "Request data." },
1128 { "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
1129 { "name": "initiator", "$ref": "Initiator", "description": "Request initiator." },
1130 { "name": "redirectResponse", "optional": true, "$ref": "Response", "description": "Redirect response data." }
1131 ]
1132 },
1133 {
1134 "name": "requestServedFromCache",
1135 "description": "Fired if request ended up loading from cache.",
1136 "parameters": [
1137 { "name": "requestId", "$ref": "RequestId", "description": "Request identifier." }
1138 ]
1139 },
1140 {
1141 "name": "responseReceived",
1142 "description": "Fired when HTTP response is available.",
1143 "parameters": [
1144 { "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
1145 { "name": "frameId", "$ref": "Page.FrameId", "description": "Frame identifier.", "hidden": true },
1146 { "name": "loaderId", "$ref": "LoaderId", "description": "Loader identifier." },
1147 { "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
1148 { "name": "type", "$ref": "Page.ResourceType", "description": "Resource type." },
1149 { "name": "response", "$ref": "Response", "description": "Response data." }
1150 ]
1151 },
1152 {
1153 "name": "dataReceived",
1154 "description": "Fired when data chunk was received over the network.",
1155 "parameters": [
1156 { "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
1157 { "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
1158 { "name": "dataLength", "type": "integer", "description": "Data chunk length." },
1159 { "name": "encodedDataLength", "type": "integer", "description": "Actual bytes received (might be less than dataLength for compressed encodings)." }
1160 ]
1161 },
1162 {
1163 "name": "loadingFinished",
1164 "description": "Fired when HTTP request has finished loading.",
1165 "parameters": [
1166 { "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
1167 { "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." }
1168 ]
1169 },
1170 {
1171 "name": "loadingFailed",
1172 "description": "Fired when HTTP request has failed to load.",
1173 "parameters": [
1174 { "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
1175 { "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
1176 { "name": "errorText", "type": "string", "description": "User friendly error message." },
1177 { "name": "canceled", "type": "boolean", "optional": true, "description": "True if loading was canceled." }
1178 ]
1179 },
1180 {
1181 "name": "webSocketWillSendHandshakeRequest",
1182 "description": "Fired when WebSocket is about to initiate handshake.",
1183 "parameters": [
1184 { "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
1185 { "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
1186 { "name": "request", "$ref": "WebSocketRequest", "description": "WebSocket request data." }
1187 ],
1188 "hidden": true
1189 },
1190 {
1191 "name": "webSocketHandshakeResponseReceived",
1192 "description": "Fired when WebSocket handshake response becomes available.",
1193 "parameters": [
1194 { "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
1195 { "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
1196 { "name": "response", "$ref": "WebSocketResponse", "description": "WebSocket response data." }
1197 ],
1198 "hidden": true
1199 },
1200 {
1201 "name": "webSocketCreated",
1202 "description": "Fired upon WebSocket creation.",
1203 "parameters": [
1204 { "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
1205 { "name": "url", "type": "string", "description": "WebSocket request URL." }
1206 ],
1207 "hidden": true
1208 },
1209 {
1210 "name": "webSocketClosed",
1211 "description": "Fired when WebSocket is closed.",
1212 "parameters": [
1213 { "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
1214 { "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." }
1215 ],
1216 "hidden": true
1217 },
1218 {
1219 "name": "webSocketFrameReceived",
1220 "description": "Fired when WebSocket frame is received.",
1221 "parameters": [
1222 { "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
1223 { "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
1224 { "name": "response", "$ref": "WebSocketFrame", "description": "WebSocket response data." }
1225 ],
1226 "hidden": true
1227 },
1228 {
1229 "name": "webSocketFrameError",
1230 "description": "Fired when WebSocket frame error occurs.",
1231 "parameters": [
1232 { "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
1233 { "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
1234 { "name": "errorMessage", "type": "string", "description": "WebSocket frame error message." }
1235 ],
1236 "hidden": true
1237 },
1238 {
1239 "name": "webSocketFrameSent",
1240 "description": "Fired when WebSocket frame is sent.",
1241 "parameters": [
1242 { "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
1243 { "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
1244 { "name": "response", "$ref": "WebSocketFrame", "description": "WebSocket response data." }
1245 ],
1246 "hidden": true
1247 }
1248 ]
1249 },
1250 {
1251 "domain": "Database",
1252 "hidden": true,
1253 "types": [
1254 {
1255 "id": "DatabaseId",
1256 "type": "string",
1257 "description": "Unique identifier of Database object.",
1258 "hidden": true
1259 },
1260 {
1261 "id": "Database",
1262 "type": "object",
1263 "description": "Database object.",
1264 "hidden": true,
1265 "properties": [
1266 { "name": "id", "$ref": "DatabaseId", "description": "Database ID." },
1267 { "name": "domain", "type": "string", "description": "Database domain." },
1268 { "name": "name", "type": "string", "description": "Database name." },
1269 { "name": "version", "type": "string", "description": "Database version." }
1270 ]
1271 },
1272 {
1273 "id": "Error",
1274 "type": "object",
1275 "description": "Database error.",
1276 "properties": [
1277 { "name": "message", "type": "string", "description": "Error message." },
1278 { "name": "code", "type": "integer", "description": "Error code." }
1279 ]
1280 }
1281 ],
1282 "commands": [
1283 {
1284 "name": "enable",
1285 "description": "Enables database tracking, database events will now be delivered to the client."
1286 },
1287 {
1288 "name": "disable",
1289 "description": "Disables database tracking, prevents database events from being sent to the client."
1290 },
1291 {
1292 "name": "getDatabaseTableNames",
1293 "parameters": [
1294 { "name": "databaseId", "$ref": "DatabaseId" }
1295 ],
1296 "returns": [
1297 { "name": "tableNames", "type": "array", "items": { "type": "string" } }
1298 ]
1299 },
1300 {
1301 "name": "executeSQL",
1302 "async": true,
1303 "parameters": [
1304 { "name": "databaseId", "$ref": "DatabaseId" },
1305 { "name": "query", "type": "string" }
1306 ],
1307 "returns": [
1308 { "name": "columnNames", "type": "array", "optional": true, "items": { "type": "string" } },
1309 { "name": "values", "type": "array", "optional": true, "items": { "type": "any" }},
1310 { "name": "sqlError", "$ref": "Error", "optional": true }
1311 ]
1312 }
1313 ],
1314 "events": [
1315 {
1316 "name": "addDatabase",
1317 "parameters": [
1318 { "name": "database", "$ref": "Database" }
1319 ]
1320 }
1321 ]
1322 },
1323 {
1324 "domain": "IndexedDB",
1325 "hidden": true,
1326 "types": [
1327 {
1328 "id": "DatabaseWithObjectStores",
1329 "type": "object",
1330 "description": "Database with an array of object stores.",
1331 "properties": [
1332 { "name": "name", "type": "string", "description": "Database name." },
1333 { "name": "version", "type": "string", "description": "Deprecated string database version." },
1334 { "name": "intVersion", "type": "integer", "description": "Integer database version." },
1335 { "name": "objectStores", "type": "array", "items": { "$ref": "ObjectStore" }, "description": "Object stores in this database." }
1336 ]
1337 },
1338 {
1339 "id": "ObjectStore",
1340 "type": "object",
1341 "description": "Object store.",
1342 "properties": [
1343 { "name": "name", "type": "string", "description": "Object store name." },
1344 { "name": "keyPath", "$ref": "KeyPath", "description": "Object store key path." },
1345 { "name": "autoIncrement", "type": "boolean", "description": "If true, object store has auto increment flag set." },
1346 { "name": "indexes", "type": "array", "items": { "$ref": "ObjectStoreIndex" }, "description": "Indexes in this object store." }
1347 ]
1348 },
1349 {
1350 "id": "ObjectStoreIndex",
1351 "type": "object",
1352 "description": "Object store index.",
1353 "properties": [
1354 { "name": "name", "type": "string", "description": "Index name." },
1355 { "name": "keyPath", "$ref": "KeyPath", "description": "Index key path." },
1356 { "name": "unique", "type": "boolean", "description": "If true, index is unique." },
1357 { "name": "multiEntry", "type": "boolean", "description": "If true, index allows multiple entries for a key." }
1358 ]
1359 },
1360 {
1361 "id": "Key",
1362 "type": "object",
1363 "description": "Key.",
1364 "properties": [
1365 { "name": "type", "type": "string", "enum": ["number", "string", "date", "array"], "description": "Key type." },
1366 { "name": "number", "type": "number", "optional": true, "description": "Number value." },
1367 { "name": "string", "type": "string", "optional": true, "description": "String value." },
1368 { "name": "date", "type": "number", "optional": true, "description": "Date value." },
1369 { "name": "array", "type": "array", "optional": true, "items": { "$ref": "Key" }, "description": "Array value." }
1370 ]
1371 },
1372 {
1373 "id": "KeyRange",
1374 "type": "object",
1375 "description": "Key range.",
1376 "properties": [
1377 { "name": "lower", "$ref": "Key", "optional": true, "description": "Lower bound." },
1378 { "name": "upper", "$ref": "Key", "optional": true, "description": "Upper bound." },
1379 { "name": "lowerOpen", "type": "boolean", "description": "If true lower bound is open." },
1380 { "name": "upperOpen", "type": "boolean", "description": "If true upper bound is open." }
1381 ]
1382 },
1383 {
1384 "id": "DataEntry",
1385 "type": "object",
1386 "description": "Data entry.",
1387 "properties": [
1388 { "name": "key", "$ref": "Runtime.RemoteObject", "description": "Key." },
1389 { "name": "primaryKey", "$ref": "Runtime.RemoteObject", "description": "Primary key." },
1390 { "name": "value", "$ref": "Runtime.RemoteObject", "description": "Value." }
1391 ]
1392 },
1393 {
1394 "id": "KeyPath",
1395 "type": "object",
1396 "description": "Key path.",
1397 "properties": [
1398 { "name": "type", "type": "string", "enum": ["null", "string", "array"], "description": "Key path type." },
1399 { "name": "string", "type": "string", "optional": true, "description": "String value." },
1400 { "name": "array", "type": "array", "optional": true, "items": { "type": "string" }, "description": "Array value." }
1401 ]
1402 }
1403 ],
1404 "commands": [
1405 {
1406 "name": "enable",
1407 "description": "Enables events from backend."
1408 },
1409 {
1410 "name": "disable",
1411 "description": "Disables events from backend."
1412 },
1413 {
1414 "name": "requestDatabaseNames",
1415 "async": true,
1416 "parameters": [
1417 { "name": "securityOrigin", "type": "string", "description": "Security origin." }
1418 ],
1419 "returns": [
1420 { "name": "databaseNames", "type": "array", "items": { "type": "string" }, "description": "Database names for origin." }
1421 ],
1422 "description": "Requests database names for given security origin."
1423 },
1424 {
1425 "name": "requestDatabase",
1426 "async": true,
1427 "parameters": [
1428 { "name": "securityOrigin", "type": "string", "description": "Security origin." },
1429 { "name": "databaseName", "type": "string", "description": "Database name." }
1430 ],
1431 "returns": [
1432 { "name": "databaseWithObjectStores", "$ref": "DatabaseWithObjectStores", "description": "Database with an array of object stores." }
1433 ],
1434 "description": "Requests database with given name in given frame."
1435 },
1436 {
1437 "name": "requestData",
1438 "async": true,
1439 "parameters": [
1440 { "name": "securityOrigin", "type": "string", "description": "Security origin." },
1441 { "name": "databaseName", "type": "string", "description": "Database name." },
1442 { "name": "objectStoreName", "type": "string", "description": "Object store name." },
1443 { "name": "indexName", "type": "string", "description": "Index name, empty string for object store data requests." },
1444 { "name": "skipCount", "type": "integer", "description": "Number of records to skip." },
1445 { "name": "pageSize", "type": "integer", "description": "Number of records to fetch." },
1446 { "name": "keyRange", "$ref": "KeyRange", "optional": true, "description": "Key range." }
1447 ],
1448 "returns": [
1449 { "name": "objectStoreDataEntries", "type": "array", "items": { "$ref": "DataEntry" }, "description": "Array of object store data entries." },
1450 { "name": "hasMore", "type": "boolean", "description": "If true, there are more entries to fetch in the given range." }
1451 ],
1452 "description": "Requests data from object store or index."
1453 },
1454 {
1455 "name": "clearObjectStore",
1456 "async": true,
1457 "parameters": [
1458 { "name": "securityOrigin", "type": "string", "description": "Security origin." },
1459 { "name": "databaseName", "type": "string", "description": "Database name." },
1460 { "name": "objectStoreName", "type": "string", "description": "Object store name." }
1461 ],
1462 "returns": [
1463 ],
1464 "description": "Clears all entries from an object store."
1465 }
1466 ]
1467 },
1468 {
1469 "domain": "DOMStorage",
1470 "hidden": true,
1471 "description": "Query and modify DOM storage.",
1472 "types": [
1473 {
1474 "id": "StorageId",
1475 "type": "object",
1476 "description": "DOM Storage identifier.",
1477 "hidden": true,
1478 "properties": [
1479 { "name": "securityOrigin", "type": "string", "description": "Security origin for the storage." },
1480 { "name": "isLocalStorage", "type": "boolean", "description": "Whether the storage is local storage (not session storage)." }
1481 ]
1482 },
1483 {
1484 "id": "Item",
1485 "type": "array",
1486 "description": "DOM Storage item.",
1487 "hidden": true,
1488 "items": { "type": "string" }
1489 }
1490 ],
1491 "commands": [
1492 {
1493 "name": "enable",
1494 "description": "Enables storage tracking, storage events will now be delivered to the client."
1495 },
1496 {
1497 "name": "disable",
1498 "description": "Disables storage tracking, prevents storage events from being sent to the client."
1499 },
1500 {
1501 "name": "getDOMStorageItems",
1502 "parameters": [
1503 { "name": "storageId", "$ref": "StorageId" }
1504 ],
1505 "returns": [
1506 { "name": "entries", "type": "array", "items": { "$ref": "Item" } }
1507 ]
1508 },
1509 {
1510 "name": "setDOMStorageItem",
1511 "parameters": [
1512 { "name": "storageId", "$ref": "StorageId" },
1513 { "name": "key", "type": "string" },
1514 { "name": "value", "type": "string" }
1515 ]
1516 },
1517 {
1518 "name": "removeDOMStorageItem",
1519 "parameters": [
1520 { "name": "storageId", "$ref": "StorageId" },
1521 { "name": "key", "type": "string" }
1522 ]
1523 }
1524 ],
1525 "events": [
1526 {
1527 "name": "domStorageItemsCleared",
1528 "parameters": [
1529 { "name": "storageId", "$ref": "StorageId" }
1530 ]
1531 },
1532 {
1533 "name": "domStorageItemRemoved",
1534 "parameters": [
1535 { "name": "storageId", "$ref": "StorageId" },
1536 { "name": "key", "type": "string" }
1537 ]
1538 },
1539 {
1540 "name": "domStorageItemAdded",
1541 "parameters": [
1542 { "name": "storageId", "$ref": "StorageId" },
1543 { "name": "key", "type": "string" },
1544 { "name": "newValue", "type": "string" }
1545 ]
1546 },
1547 {
1548 "name": "domStorageItemUpdated",
1549 "parameters": [
1550 { "name": "storageId", "$ref": "StorageId" },
1551 { "name": "key", "type": "string" },
1552 { "name": "oldValue", "type": "string" },
1553 { "name": "newValue", "type": "string" }
1554 ]
1555 }
1556 ]
1557 },
1558 {
1559 "domain": "ApplicationCache",
1560 "hidden": true,
1561 "types": [
1562 {
1563 "id": "ApplicationCacheResource",
1564 "type": "object",
1565 "description": "Detailed application cache resource information.",
1566 "properties": [
1567 { "name": "url", "type": "string", "description": "Resource url." },
1568 { "name": "size", "type": "integer", "description": "Resource size." },
1569 { "name": "type", "type": "string", "description": "Resource type." }
1570 ]
1571 },
1572 {
1573 "id": "ApplicationCache",
1574 "type": "object",
1575 "description": "Detailed application cache information.",
1576 "properties": [
1577 { "name": "manifestURL", "type": "string", "description": "Manifest URL." },
1578 { "name": "size", "type": "number", "description": "Application cache size." },
1579 { "name": "creationTime", "type": "number", "description": "Application cache creation time." },
1580 { "name": "updateTime", "type": "number", "description": "Application cache update time." },
1581 { "name": "resources", "type": "array", "items": { "$ref": "ApplicationCacheResource" }, "description": "Application cache resources." }
1582 ]
1583 },
1584 {
1585 "id": "FrameWithManifest",
1586 "type": "object",
1587 "description": "Frame identifier - manifest URL pair.",
1588 "properties": [
1589 { "name": "frameId", "$ref": "Page.FrameId", "description": "Frame identifier." },
1590 { "name": "manifestURL", "type": "string", "description": "Manifest URL." },
1591 { "name": "status", "type": "integer", "description": "Application cache status." }
1592 ]
1593 }
1594 ],
1595 "commands": [
1596 {
1597 "name": "getFramesWithManifests",
1598 "returns": [
1599 { "name": "frameIds", "type": "array", "items": { "$ref": "FrameWithManifest" }, "description": "Array of frame identifiers with manifest urls for each frame containing a document associated with some application cache." }
1600 ],
1601 "description": "Returns array of frame identifiers with manifest urls for each frame containing a document associated with some application cache."
1602 },
1603 {
1604 "name": "enable",
1605 "description": "Enables application cache domain notifications."
1606 },
1607 {
1608 "name": "getManifestForFrame",
1609 "parameters": [
1610 { "name": "frameId", "$ref": "Page.FrameId", "description": "Identifier of the frame containing document whose manifest is retrieved." }
1611 ],
1612 "returns": [
1613 { "name": "manifestURL", "type": "string", "description": "Manifest URL for document in the given frame." }
1614 ],
1615 "description": "Returns manifest URL for document in the given frame."
1616 },
1617 {
1618 "name": "getApplicationCacheForFrame",
1619 "parameters": [
1620 { "name": "frameId", "$ref": "Page.FrameId", "description": "Identifier of the frame containing document whose application cache is retrieved." }
1621 ],
1622 "returns": [
1623 { "name": "applicationCache", "$ref": "ApplicationCache", "description": "Relevant application cache data for the document in given frame." }
1624 ],
1625 "description": "Returns relevant application cache data for the document in given frame."
1626 }
1627 ],
1628 "events": [
1629 {
1630 "name": "applicationCacheStatusUpdated",
1631 "parameters": [
1632 { "name": "frameId", "$ref": "Page.FrameId", "description": "Identifier of the frame containing document whose application cache updated status." },
1633 { "name": "manifestURL", "type": "string", "description": "Manifest URL." },
1634 { "name": "status", "type": "integer", "description": "Updated application cache status." }
1635 ]
1636 },
1637 {
1638 "name": "networkStateUpdated",
1639 "parameters": [
1640 { "name": "isNowOnline", "type": "boolean" }
1641 ]
1642 }
1643 ]
1644 },
1645 {
1646 "domain": "FileSystem",
1647 "hidden": true,
1648 "types": [
1649 {
1650 "id": "Entry",
1651 "type": "object",
1652 "properties": [
1653 { "name": "url", "type": "string", "description": "filesystem: URL for the entry." },
1654 { "name": "name", "type": "string", "description": "The name of the file or directory." },
1655 { "name": "isDirectory", "type": "boolean", "description": "True if the entry is a directory." },
1656 { "name": "mimeType", "type": "string", "optional": true, "description": "MIME type of the entry, available for a file only." },
1657 { "name": "resourceType", "$ref": "Page.ResourceType", "optional": true, "description": "ResourceType of the entry, available for a file only." },
1658 { "name": "isTextFile", "type": "boolean", "optional": true, "description": "True if the entry is a text file." }
1659 ],
1660 "description": "Represents a browser side file or directory."
1661 },
1662 {
1663 "id": "Metadata",
1664 "type": "object",
1665 "properties": [
1666 { "name": "modificationTime", "type": "number", "description": "Modification time." },
1667 { "name": "size", "type": "number", "description": "File size. This field is always zero for directories." }
1668 ],
1669 "description": "Represents metadata of a file or entry."
1670 }
1671 ],
1672 "commands": [
1673 {
1674 "name": "enable",
1675 "description": "Enables events from backend."
1676 },
1677 {
1678 "name": "disable",
1679 "description": "Disables events from backend."
1680 },
1681 {
1682 "name": "requestFileSystemRoot",
1683 "async": true,
1684 "parameters": [
1685 { "name": "origin", "type": "string", "description": "Security origin of requesting FileSystem. One of frames in current page needs to have this security origin." },
1686 { "name": "type", "type": "string", "enum": ["temporary", "persistent"], "description": "FileSystem type of requesting FileSystem." }
1687 ],
1688 "returns": [
1689 { "name": "errorCode", "type": "integer", "description": "0, if no error. Otherwise, errorCode is set to FileError::ErrorCode value." },
1690 { "name": "root", "$ref": "Entry", "optional": true, "description": "Contains root of the requested FileSystem if the command completed successfully." }
1691 ],
1692 "description": "Returns root directory of the FileSystem, if exists."
1693 },
1694 {
1695 "name": "requestDirectoryContent",
1696 "async": true,
1697 "parameters": [
1698 { "name": "url", "type": "string", "description": "URL of the directory that the frontend is requesting to read from." }
1699 ],
1700 "returns": [
1701 { "name": "errorCode", "type": "integer", "description": "0, if no error. Otherwise, errorCode is set to FileError::ErrorCode value." },
1702 { "name": "entries", "type": "array", "items": { "$ref": "Entry" }, "optional": true, "description": "Contains all entries on directory if the command completed successfully." }
1703 ],
1704 "description": "Returns content of the directory."
1705 },
1706 {
1707 "name": "requestMetadata",
1708 "async": true,
1709 "parameters": [
1710 { "name": "url", "type": "string", "description": "URL of the entry that the frontend is requesting to get metadata from." }
1711 ],
1712 "returns": [
1713 { "name": "errorCode", "type": "integer", "description": "0, if no error. Otherwise, errorCode is set to FileError::ErrorCode value." },
1714 { "name": "metadata", "$ref": "Metadata", "optional": true, "description": "Contains metadata of the entry if the command completed successfully." }
1715 ],
1716 "description": "Returns metadata of the entry."
1717 },
1718 {
1719 "name": "requestFileContent",
1720 "async": true,
1721 "parameters": [
1722 { "name": "url", "type": "string", "description": "URL of the file that the frontend is requesting to read from." },
1723 { "name": "readAsText", "type": "boolean", "description": "True if the content should be read as text, otherwise the result will be returned as base64 encoded text." },
1724 { "name": "start", "type": "integer", "optional": true, "description": "Specifies the start of range to read." },
1725 { "name": "end", "type": "integer", "optional": true, "description": "Specifies the end of range to read exclusively." },
1726 { "name": "charset", "type": "string", "optional": true, "description": "Overrides charset of the content when content is served as text." }
1727 ],
1728 "returns": [
1729 { "name": "errorCode", "type": "integer", "description": "0, if no error. Otherwise, errorCode is set to FileError::ErrorCode value." },
1730 { "name": "content", "type": "string", "optional": true, "description": "Content of the file." },
1731 { "name": "charset", "type": "string", "optional": true, "description": "Charset of the content if it is served as text." }
1732 ],
1733 "description": "Returns content of the file. Result should be sliced into [start, end)."
1734 },
1735 {
1736 "name": "deleteEntry",
1737 "async": true,
1738 "parameters": [
1739 { "name": "url", "type": "string", "description": "URL of the entry to delete." }
1740 ],
1741 "returns": [
1742 { "name": "errorCode", "type": "integer", "description": "0, if no error. Otherwise errorCode is set to FileError::ErrorCode value." }
1743 ],
1744 "description": "Deletes specified entry. If the entry is a directory, the agent deletes children recursively."
1745 }
1746 ]
1747 },
1748 {
1749 "domain": "DOM",
1750 "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>",
1751 "types": [
1752 {
1753 "id": "NodeId",
1754 "type": "integer",
1755 "description": "Unique DOM node identifier."
1756 },
1757 {
1758 "id": "BackendNodeId",
1759 "type": "integer",
1760 "description": "Unique DOM node identifier used to reference a node that may not have been pushed to the front-end.",
1761 "hidden": true
1762 },
1763 {
1764 "id": "Node",
1765 "type": "object",
1766 "properties": [
1767 { "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." },
1768 { "name": "nodeType", "type": "integer", "description": "<code>Node</code>'s nodeType." },
1769 { "name": "nodeName", "type": "string", "description": "<code>Node</code>'s nodeName." },
1770 { "name": "localName", "type": "string", "description": "<code>Node</code>'s localName." },
1771 { "name": "nodeValue", "type": "string", "description": "<code>Node</code>'s nodeValue." },
1772 { "name": "childNodeCount", "type": "integer", "optional": true, "description": "Child count for <code>Container</code> nodes." },
1773 { "name": "children", "type": "array", "optional": true, "items": { "$ref": "Node" }, "description": "Child nodes of this node when requested with children." },
1774 { "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>." },
1775 { "name": "documentURL", "type": "string", "optional": true, "description": "Document URL that <code>Document</code> or <code>FrameOwner</code> node points to." },
1776 { "name": "baseURL", "type": "string", "optional": true, "description": "Base URL that <code>Document</code> or <code>FrameOwner</code> node uses for URL completion.", "hidden": true },
1777 { "name": "publicId", "type": "string", "optional": true, "description": "<code>DocumentType</code>'s publicId." },
1778 { "name": "systemId", "type": "string", "optional": true, "description": "<code>DocumentType</code>'s systemId." },
1779 { "name": "internalSubset", "type": "string", "optional": true, "description": "<code>DocumentType</code>'s internalSubset." },
1780 { "name": "xmlVersion", "type": "string", "optional": true, "description": "<code>Document</code>'s XML version in case of XML documents." },
1781 { "name": "name", "type": "string", "optional": true, "description": "<code>Attr</code>'s name." },
1782 { "name": "value", "type": "string", "optional": true, "description": "<code>Attr</code>'s value." },
1783 { "name": "frameId", "$ref": "Page.FrameId", "optional": true, "description": "Frame ID for frame owner elements.", "hidden": true },
1784 { "name": "contentDocument", "$ref": "Node", "optional": true, "description": "Content document for frame owner elements." },
1785 { "name": "shadowRoots", "type": "array", "optional": true, "items": { "$ref": "Node" }, "description": "Shadow root list for given element host.", "hidden": true },
1786 { "name": "templateContent", "$ref": "Node", "optional": true, "description": "Content document fragment for template elements", "hidden": true }
1787 ],
1788 "description": "DOM interaction is implemented in terms of mirror objects that represent the actual DOM nodes. DOMNode is a base node mirror type."
1789 },
1790 {
1791 "id": "EventListener",
1792 "type": "object",
1793 "hidden": true,
1794 "properties": [
1795 { "name": "type", "type": "string", "description": "<code>EventListener</code>'s type." },
1796 { "name": "useCapture", "type": "boolean", "description": "<code>EventListener</code>'s useCapture." },
1797 { "name": "isAttribute", "type": "boolean", "description": "<code>EventListener</code>'s isAttribute." },
1798 { "name": "nodeId", "$ref": "NodeId", "description": "Target <code>DOMNode</code> id." },
1799 { "name": "handlerBody", "type": "string", "description": "Event handler function body." },
1800 { "name": "location", "$ref": "Debugger.Location", "optional": true, "description": "Handler code location." },
1801 { "name": "sourceName", "type": "string", "optional": true, "description": "Source script URL." },
1802 { "name": "handler", "$ref": "Runtime.RemoteObject", "optional": true, "description": "Event handler function value." }
1803 ],
1804 "description": "DOM interaction is implemented in terms of mirror objects that represent the actual DOM nodes. DOMNode is a base node mirror type."
1805 },
1806 {
1807 "id": "RGBA",
1808 "type": "object",
1809 "properties": [
1810 { "name": "r", "type": "integer", "description": "The red component, in the [0-255] range." },
1811 { "name": "g", "type": "integer", "description": "The green component, in the [0-255] range." },
1812 { "name": "b", "type": "integer", "description": "The blue component, in the [0-255] range." },
1813 { "name": "a", "type": "number", "optional": true, "description": "The alpha component, in the [0-1] range (default: 1)." }
1814 ],
1815 "description": "A structure holding an RGBA color."
1816 },
1817 {
1818 "id": "Quad",
1819 "type": "array",
1820 "items": { "type": "number" },
1821 "minItems": 8,
1822 "maxItems": 8,
1823 "description": "An array of quad vertices, x immediately followed by y for each point, points clock-wise.",
1824 "hidden": true
1825 },
1826 {
1827 "id": "BoxModel",
1828 "type": "object",
1829 "hidden": true,
1830 "properties": [
1831 { "name": "content", "$ref": "Quad", "description": "Content box" },
1832 { "name": "padding", "$ref": "Quad", "description": "Padding box" },
1833 { "name": "border", "$ref": "Quad", "description": "Border box" },
1834 { "name": "margin", "$ref": "Quad", "description": "Margin box" },
1835 { "name": "width", "type": "integer", "description": "Node width" },
1836 { "name": "height", "type": "integer", "description": "Node height" },
1837 { "name": "shapeOutside", "type": "string", "description": "CSS Shape Outside" }
1838 ],
1839 "description": "Box model."
1840 },
1841 {
1842 "id": "Rect",
1843 "type": "object",
1844 "hidden": true,
1845 "properties": [
1846 { "name": "x", "type": "number", "description": "X coordinate" },
1847 { "name": "y", "type": "number", "description": "Y coordinate" },
1848 { "name": "width", "type": "number", "description": "Rectangle width" },
1849 { "name": "height", "type": "number", "description": "Rectangle height" }
1850 ],
1851 "description": "Rectangle."
1852 },
1853 {
1854 "id": "HighlightConfig",
1855 "type": "object",
1856 "properties": [
1857 { "name": "showInfo", "type": "boolean", "optional": true, "description": "Whether the node info tooltip should be shown (default: false)." },
1858 { "name": "contentColor", "$ref": "RGBA", "optional": true, "description": "The content box highlight fill color (default: transparent)." },
1859 { "name": "paddingColor", "$ref": "RGBA", "optional": true, "description": "The padding highlight fill color (default: transparent)." },
1860 { "name": "borderColor", "$ref": "RGBA", "optional": true, "description": "The border highlight fill color (default: transparent)." },
1861 { "name": "marginColor", "$ref": "RGBA", "optional": true, "description": "The margin highlight fill color (default: transparent)." },
1862 { "name": "eventTargetColor", "$ref": "RGBA", "optional": true, "hidden": true, "description": "The event target element highlight fill color (default: transparent)." }
1863 ],
1864 "description": "Configuration data for the highlighting of page elements."
1865 }
1866 ],
1867 "commands": [
1868 {
1869 "name": "getDocument",
1870 "returns": [
1871 { "name": "root", "$ref": "Node", "description": "Resulting node." }
1872 ],
1873 "description": "Returns the root DOM node to the caller."
1874 },
1875 {
1876 "name": "requestChildNodes",
1877 "parameters": [
1878 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to get children for." },
1879 { "name": "depth", "type": "integer", "optional": true, "description": "The maximum depth at which children should be retrieved, defaults to 1. Use -1 for the entire subtree or provide an integer larger than 0.", "hidden": true }
1880 ],
1881 "description": "Requests that children of the node with given id are returned to the caller in form of <code>setChildNodes</code> events where not only immediate children are retrieved, but all children down to the specified depth."
1882 },
1883 {
1884 "name": "querySelector",
1885 "parameters": [
1886 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to query upon." },
1887 { "name": "selector", "type": "string", "description": "Selector string." }
1888 ],
1889 "returns": [
1890 { "name": "nodeId", "$ref": "NodeId", "description": "Query selector result." }
1891 ],
1892 "description": "Executes <code>querySelector</code> on a given node."
1893 },
1894 {
1895 "name": "querySelectorAll",
1896 "parameters": [
1897 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to query upon." },
1898 { "name": "selector", "type": "string", "description": "Selector string." }
1899 ],
1900 "returns": [
1901 { "name": "nodeIds", "type": "array", "items": { "$ref": "NodeId" }, "description": "Query selector result." }
1902 ],
1903 "description": "Executes <code>querySelectorAll</code> on a given node."
1904 },
1905 {
1906 "name": "setNodeName",
1907 "parameters": [
1908 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to set name for." },
1909 { "name": "name", "type": "string", "description": "New node's name." }
1910 ],
1911 "returns": [
1912 { "name": "nodeId", "$ref": "NodeId", "description": "New node's id." }
1913 ],
1914 "description": "Sets node name for a node with given id."
1915 },
1916 {
1917 "name": "setNodeValue",
1918 "parameters": [
1919 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to set value for." },
1920 { "name": "value", "type": "string", "description": "New node's value." }
1921 ],
1922 "description": "Sets node value for a node with given id."
1923 },
1924 {
1925 "name": "removeNode",
1926 "parameters": [
1927 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to remove." }
1928 ],
1929 "description": "Removes node with given id."
1930 },
1931 {
1932 "name": "setAttributeValue",
1933 "parameters": [
1934 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the element to set attribute for." },
1935 { "name": "name", "type": "string", "description": "Attribute name." },
1936 { "name": "value", "type": "string", "description": "Attribute value." }
1937 ],
1938 "description": "Sets attribute for an element with given id."
1939 },
1940 {
1941 "name": "setAttributesAsText",
1942 "parameters": [
1943 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the element to set attributes for." },
1944 { "name": "text", "type": "string", "description": "Text with a number of attributes. Will parse this text using HTML parser." },
1945 { "name": "name", "type": "string", "optional": true, "description": "Attribute name to replace with new attributes derived from text in case text parsed successfully." }
1946 ],
1947 "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."
1948 },
1949 {
1950 "name": "removeAttribute",
1951 "parameters": [
1952 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the element to remove attribute from." },
1953 { "name": "name", "type": "string", "description": "Name of the attribute to remove." }
1954 ],
1955 "description": "Removes attribute with given name from an element with given id."
1956 },
1957 {
1958 "name": "getEventListenersForNode",
1959 "parameters": [
1960 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to get listeners for." },
1961 { "name": "objectGroup", "type": "string", "optional": true, "description": "Symbolic group name for handler value. Handler value is not returned without this parameter specified." }
1962 ],
1963 "returns": [
1964 { "name": "listeners", "type": "array", "items": { "$ref": "EventListener"}, "description": "Array of relevant listeners." }
1965 ],
1966 "description": "Returns event listeners relevant to the node.",
1967 "hidden": true
1968 },
1969 {
1970 "name": "getOuterHTML",
1971 "parameters": [
1972 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to get markup for." }
1973 ],
1974 "returns": [
1975 { "name": "outerHTML", "type": "string", "description": "Outer HTML markup." }
1976 ],
1977 "description": "Returns node's HTML markup."
1978 },
1979 {
1980 "name": "setOuterHTML",
1981 "parameters": [
1982 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to set markup for." },
1983 { "name": "outerHTML", "type": "string", "description": "Outer HTML markup to set." }
1984 ],
1985 "description": "Sets node HTML markup, returns new node id."
1986 },
1987 {
1988 "name": "performSearch",
1989 "parameters": [
1990 { "name": "query", "type": "string", "description": "Plain text or query selector or XPath search query." }
1991 ],
1992 "returns": [
1993 { "name": "searchId", "type": "string", "description": "Unique search session identifier." },
1994 { "name": "resultCount", "type": "integer", "description": "Number of search results." }
1995 ],
1996 "description": "Searches for a given string in the DOM tree. Use <code>getSearchResults</code> to access search results or <code>cancelSearch</code> to end this search session.",
1997 "hidden": true
1998 },
1999 {
2000 "name": "getSearchResults",
2001 "parameters": [
2002 { "name": "searchId", "type": "string", "description": "Unique search session identifier." },
2003 { "name": "fromIndex", "type": "integer", "description": "Start index of the search result to be returned." },
2004 { "name": "toIndex", "type": "integer", "description": "End index of the search result to be returned." }
2005 ],
2006 "returns": [
2007 { "name": "nodeIds", "type": "array", "items": { "$ref": "NodeId" }, "description": "Ids of the search result nodes." }
2008 ],
2009 "description": "Returns search results from given <code>fromIndex</code> to given <code>toIndex</code> from the sarch with the given identifier.",
2010 "hidden": true
2011 },
2012 {
2013 "name": "discardSearchResults",
2014 "parameters": [
2015 { "name": "searchId", "type": "string", "description": "Unique search session identifier." }
2016 ],
2017 "description": "Discards search results from the session with the given id. <code>getSearchResults</code> should no longer be called for that search.",
2018 "hidden": true
2019 },
2020 {
2021 "name": "requestNode",
2022 "parameters": [
2023 { "name": "objectId", "$ref": "Runtime.RemoteObjectId", "description": "JavaScript object id to convert into node." }
2024 ],
2025 "returns": [
2026 { "name": "nodeId", "$ref": "NodeId", "description": "Node id for given object." }
2027 ],
2028 "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."
2029 },
2030 {
2031 "name": "setInspectModeEnabled",
2032 "hidden": true,
2033 "parameters": [
2034 { "name": "enabled", "type": "boolean", "description": "True to enable inspection mode, false to disable it." },
2035 { "name": "inspectShadowDOM", "type": "boolean", "optional": true, "description": "True to enable inspection mode for shadow DOM." },
2036 { "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>." }
2037 ],
2038 "description": "Enters the 'inspect' mode. In this mode, elements that user is hovering over are highlighted. Backend then generates 'inspectNodeRequested' event upon element selection."
2039 },
2040 {
2041 "name": "highlightRect",
2042 "parameters": [
2043 { "name": "x", "type": "integer", "description": "X coordinate" },
2044 { "name": "y", "type": "integer", "description": "Y coordinate" },
2045 { "name": "width", "type": "integer", "description": "Rectangle width" },
2046 { "name": "height", "type": "integer", "description": "Rectangle height" },
2047 { "name": "color", "$ref": "RGBA", "optional": true, "description": "The highlight fill color (default: transparent)." },
2048 { "name": "outlineColor", "$ref": "RGBA", "optional": true, "description": "The highlight outline color (default: transparent)." }
2049 ],
2050 "description": "Highlights given rectangle. Coordinates are absolute with respect to the main frame viewport."
2051 },
2052 {
2053 "name": "highlightQuad",
2054 "parameters": [
2055 { "name": "quad", "$ref": "Quad", "description": "Quad to highlight" },
2056 { "name": "color", "$ref": "RGBA", "optional": true, "description": "The highlight fill color (default: transparent)." },
2057 { "name": "outlineColor", "$ref": "RGBA", "optional": true, "description": "The highlight outline color (default: transparent)." }
2058 ],
2059 "description": "Highlights given quad. Coordinates are absolute with respect to the main frame viewport.",
2060 "hidden": true
2061 },
2062 {
2063 "name": "highlightNode",
2064 "parameters": [
2065 { "name": "highlightConfig", "$ref": "HighlightConfig", "description": "A descriptor for the highlight appearance." },
2066 { "name": "nodeId", "$ref": "NodeId", "optional": true, "description": "Identifier of the node to highlight." },
2067 { "name": "objectId", "$ref": "Runtime.RemoteObjectId", "optional": true, "description": "JavaScript object id of the node to be highlighted.", "hidden": true }
2068 ],
2069 "description": "Highlights DOM node with given id or with the given JavaScript object wrapper. Either nodeId or objectId must be specified."
2070 },
2071 {
2072 "name": "hideHighlight",
2073 "description": "Hides DOM node highlight."
2074 },
2075 {
2076 "name": "highlightFrame",
2077 "parameters": [
2078 { "name": "frameId", "$ref": "Page.FrameId", "description": "Identifier of the frame to highlight." },
2079 { "name": "contentColor", "$ref": "RGBA", "optional": true, "description": "The content box highlight fill color (default: transparent)." },
2080 { "name": "contentOutlineColor", "$ref": "RGBA", "optional": true, "description": "The content box highlight outline color (default: transparent)." }
2081 ],
2082 "description": "Highlights owner element of the frame with given id.",
2083 "hidden": true
2084 },
2085 {
2086 "name": "pushNodeByPathToFrontend",
2087 "parameters": [
2088 { "name": "path", "type": "string", "description": "Path to node in the proprietary format." }
2089 ],
2090 "returns": [
2091 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node for given path." }
2092 ],
2093 "description": "Requests that the node is sent to the caller given its path. // FIXME, use XPath",
2094 "hidden": true
2095 },
2096 {
2097 "name": "pushNodeByBackendIdToFrontend",
2098 "parameters": [
2099 { "name": "backendNodeId", "$ref": "BackendNodeId", "description": "The backend node id of the node." }
2100 ],
2101 "returns": [
2102 { "name": "nodeId", "$ref": "NodeId", "description": "The pushed node's id." }
2103 ],
2104 "description": "Requests that the node is sent to the caller given its backend node id.",
2105 "hidden": true
2106 },
2107 {
2108 "name": "releaseBackendNodeIds",
2109 "parameters": [
2110 { "name": "nodeGroup", "type": "string", "description": "The backend node ids group name." }
2111 ],
2112 "description": "Requests that group of <code>BackendNodeIds</code> is released.",
2113 "hidden": true
2114 },
2115 {
2116 "name": "resolveNode",
2117 "parameters": [
2118 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to resolve." },
2119 { "name": "objectGroup", "type": "string", "optional": true, "description": "Symbolic group name that can be used to release multiple objects." }
2120 ],
2121 "returns": [
2122 { "name": "object", "$ref": "Runtime.RemoteObject", "description": "JavaScript object wrapper for given node." }
2123 ],
2124 "description": "Resolves JavaScript node object for given node id."
2125 },
2126 {
2127 "name": "getAttributes",
2128 "parameters": [
2129 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to retrieve attibutes for." }
2130 ],
2131 "returns": [
2132 { "name": "attributes", "type": "array", "items": { "type": "string" }, "description": "An interleaved array of node attribute names and values." }
2133 ],
2134 "description": "Returns attributes for the specified node."
2135 },
2136 {
2137 "name": "moveTo",
2138 "parameters": [
2139 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to drop." },
2140 { "name": "targetNodeId", "$ref": "NodeId", "description": "Id of the element to drop into." },
2141 { "name": "insertBeforeNodeId", "$ref": "NodeId", "optional": true, "description": "Drop node before given one." }
2142 ],
2143 "returns": [
2144 { "name": "nodeId", "$ref": "NodeId", "description": "New id of the moved node." }
2145 ],
2146 "description": "Moves node into the new container, places it before the given anchor."
2147 },
2148 {
2149 "name": "undo",
2150 "description": "Undoes the last performed action.",
2151 "hidden": true
2152 },
2153 {
2154 "name": "redo",
2155 "description": "Re-does the last undone action.",
2156 "hidden": true
2157 },
2158 {
2159 "name": "markUndoableState",
2160 "description": "Marks last undoable state.",
2161 "hidden": true
2162 },
2163 {
2164 "name": "focus",
2165 "parameters": [
2166 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to focus." }
2167 ],
2168 "description": "Focuses the given element.",
2169 "hidden": true
2170 },
2171 {
2172 "name": "setFileInputFiles",
2173 "parameters": [
2174 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the file input node to set files for." },
2175 { "name": "files", "type": "array", "items": { "type": "string" }, "description": "Array of file paths to set." }
2176 ],
2177 "description": "Sets files for the given file input element.",
2178 "hidden": true
2179 },
2180 {
2181 "name": "getBoxModel",
2182 "parameters": [
2183 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to get box model for." }
2184 ],
2185 "returns": [
2186 { "name": "model", "$ref": "BoxModel", "description": "Box model for the node." }
2187 ],
2188 "description": "Returns boxes for the currently selected nodes.",
2189 "hidden": true
2190 },
2191 {
2192 "name": "getNodeForLocation",
2193 "parameters": [
2194 { "name": "x", "type": "integer", "description": "X coordinate." },
2195 { "name": "y", "type": "integer", "description": "Y coordinate." }
2196 ],
2197 "returns": [
2198 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node at given coordinates." }
2199 ],
2200 "description": "Returns node id at given location.",
2201 "hidden": true
2202 }
2203 ],
2204 "events": [
2205 {
2206 "name": "documentUpdated",
2207 "description": "Fired when <code>Document</code> has been totally updated. Node ids are no longer valid."
2208 },
2209 {
2210 "name": "inspectNodeRequested",
2211 "parameters": [
2212 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to inspect." }
2213 ],
2214 "description": "Fired when the node should be inspected. This happens after call to <code>setInspectModeEnabled</code>.",
2215 "hidden" : true
2216 },
2217 {
2218 "name": "setChildNodes",
2219 "parameters": [
2220 { "name": "parentId", "$ref": "NodeId", "description": "Parent node id to populate with children." },
2221 { "name": "nodes", "type": "array", "items": { "$ref": "Node"}, "description": "Child nodes array." }
2222 ],
2223 "description": "Fired when backend wants to provide client with the missing DOM structure. This happens upon most of the calls requesting node ids."
2224 },
2225 {
2226 "name": "attributeModified",
2227 "parameters": [
2228 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node that has changed." },
2229 { "name": "name", "type": "string", "description": "Attribute name." },
2230 { "name": "value", "type": "string", "description": "Attribute value." }
2231 ],
2232 "description": "Fired when <code>Element</code>'s attribute is modified."
2233 },
2234 {
2235 "name": "attributeRemoved",
2236 "parameters": [
2237 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node that has changed." },
2238 { "name": "name", "type": "string", "description": "A ttribute name." }
2239 ],
2240 "description": "Fired when <code>Element</code>'s attribute is removed."
2241 },
2242 {
2243 "name": "inlineStyleInvalidated",
2244 "parameters": [
2245 { "name": "nodeIds", "type": "array", "items": { "$ref": "NodeId" }, "description": "Ids of the nodes for which the inline styles have been invalidated." }
2246 ],
2247 "description": "Fired when <code>Element</code>'s inline style is modified via a CSS property modification.",
2248 "hidden": true
2249 },
2250 {
2251 "name": "characterDataModified",
2252 "parameters": [
2253 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node that has changed." },
2254 { "name": "characterData", "type": "string", "description": "New text value." }
2255 ],
2256 "description": "Mirrors <code>DOMCharacterDataModified</code> event."
2257 },
2258 {
2259 "name": "childNodeCountUpdated",
2260 "parameters": [
2261 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node that has changed." },
2262 { "name": "childNodeCount", "type": "integer", "description": "New node count." }
2263 ],
2264 "description": "Fired when <code>Container</code>'s child node count has changed."
2265 },
2266 {
2267 "name": "childNodeInserted",
2268 "parameters": [
2269 { "name": "parentNodeId", "$ref": "NodeId", "description": "Id of the node that has changed." },
2270 { "name": "previousNodeId", "$ref": "NodeId", "description": "If of the previous siblint." },
2271 { "name": "node", "$ref": "Node", "description": "Inserted node data." }
2272 ],
2273 "description": "Mirrors <code>DOMNodeInserted</code> event."
2274 },
2275 {
2276 "name": "childNodeRemoved",
2277 "parameters": [
2278 { "name": "parentNodeId", "$ref": "NodeId", "description": "Parent id." },
2279 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node that has been removed." }
2280 ],
2281 "description": "Mirrors <code>DOMNodeRemoved</code> event."
2282 },
2283 {
2284 "name": "shadowRootPushed",
2285 "parameters": [
2286 { "name": "hostId", "$ref": "NodeId", "description": "Host element id." },
2287 { "name": "root", "$ref": "Node", "description": "Shadow root." }
2288 ],
2289 "description": "Called when shadow root is pushed into the element.",
2290 "hidden": true
2291 },
2292 {
2293 "name": "shadowRootPopped",
2294 "parameters": [
2295 { "name": "hostId", "$ref": "NodeId", "description": "Host element id." },
2296 { "name": "rootId", "$ref": "NodeId", "description": "Shadow root id." }
2297 ],
2298 "description": "Called when shadow root is popped from the element.",
2299 "hidden": true
2300 }
2301 ]
2302 },
2303 {
2304 "domain": "CSS",
2305 "hidden": true,
2306 "description": "This domain exposes CSS read/write operations. All CSS objects (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). A client can also discover all the existing stylesheets with the <code>getAllStyleSheets()</code> method (or keeping track of the <code>styleSheetAdded</code>/<code>styleSheetRemoved</code> events) and subsequently load the required stylesheet contents using the <code>getStyleSheet[Text]()</code> methods.",
2307 "types": [
2308 {
2309 "id": "StyleSheetId",
2310 "type": "string"
2311 },
2312 {
2313 "id": "CSSStyleId",
2314 "type": "object",
2315 "properties": [
2316 { "name": "styleSheetId", "$ref": "StyleSheetId", "description": "Enclosing stylesheet identifier." },
2317 { "name": "ordinal", "type": "integer", "description": "The style ordinal within the stylesheet." }
2318 ],
2319 "description": "This object identifies a CSS style in a unique way."
2320 },
2321 {
2322 "id": "StyleSheetOrigin",
2323 "type": "string",
2324 "enum": ["user", "user-agent", "inspector", "regular"],
2325 "description": "Stylesheet type: \"user\" for user stylesheets, \"user-agent\" for user-agent stylesheets, \"inspector\" for stylesheets created by the inspector (i.e. those holding the \"via inspector\" rules), \"regular\" for regular stylesheets."
2326 },
2327 {
2328 "id": "CSSRuleId",
2329 "type": "object",
2330 "properties": [
2331 { "name": "styleSheetId", "$ref": "StyleSheetId", "description": "Enclosing stylesheet identifier." },
2332 { "name": "ordinal", "type": "integer", "description": "The rule ordinal within the stylesheet." }
2333 ],
2334 "description": "This object identifies a CSS rule in a unique way."
2335 },
2336 {
2337 "id": "PseudoIdMatches",
2338 "type": "object",
2339 "properties": [
2340 { "name": "pseudoId", "type": "integer", "description": "Pseudo style identifier (see <code>enum PseudoId</code> in <code>ComputedStyleConstants.h</code>)."},
2341 { "name": "matches", "type": "array", "items": { "$ref": "RuleMatch" }, "description": "Matches of CSS rules applicable to the pseudo style."}
2342 ],
2343 "description": "CSS rule collection for a single pseudo style."
2344 },
2345 {
2346 "id": "InheritedStyleEntry",
2347 "type": "object",
2348 "properties": [
2349 { "name": "inlineStyle", "$ref": "CSSStyle", "optional": true, "description": "The ancestor node's inline style, if any, in the style inheritance chain." },
2350 { "name": "matchedCSSRules", "type": "array", "items": { "$ref": "RuleMatch" }, "description": "Matches of CSS rules matching the ancestor node in the style inheritance chain." }
2351 ],
2352 "description": "CSS rule collection for a single pseudo style."
2353 },
2354 {
2355 "id": "RuleMatch",
2356 "type": "object",
2357 "properties": [
2358 { "name": "rule", "$ref": "CSSRule", "description": "CSS rule in the match." },
2359 { "name": "matchingSelectors", "type": "array", "items": { "type": "integer" }, "description": "Matching selector indices in the rule's selectorList selectors (0-based)." }
2360 ],
2361 "description": "Match data for a CSS rule."
2362 },
2363 {
2364 "id": "SelectorList",
2365 "type": "object",
2366 "properties": [
2367 { "name": "selectors", "type": "array", "items": { "type": "string" }, "description": "Selectors in the list." },
2368 { "name": "text", "type": "string", "description": "Rule selector text." },
2369 { "name": "range", "$ref": "SourceRange", "optional": true, "description": "Rule selector range in the underlying resource (if available)." }
2370 ],
2371 "description": "Selector list data."
2372 },
2373 {
2374 "id": "CSSStyleAttribute",
2375 "type": "object",
2376 "properties": [
2377 { "name": "name", "type": "string", "description": "DOM attribute name (e.g. \"width\")."},
2378 { "name": "style", "$ref": "CSSStyle", "description": "CSS style generated by the respective DOM attribute."}
2379 ],
2380 "description": "CSS style information for a DOM style attribute."
2381 },
2382 {
2383 "id": "CSSStyleSheetHeader",
2384 "type": "object",
2385 "properties": [
2386 { "name": "styleSheetId", "$ref": "StyleSheetId", "description": "The stylesheet identifier."},
2387 { "name": "frameId", "$ref": "Page.FrameId", "description": "Owner frame identifier."},
2388 { "name": "sourceURL", "type": "string", "description": "Stylesheet resource URL."},
2389 { "name": "sourceMapURL", "type": "string", "optional": true, "description": "URL of source map associated with the stylesheet (if any)." },
2390 { "name": "origin", "$ref": "StyleSheetOrigin", "description": "Stylesheet origin."},
2391 { "name": "title", "type": "string", "description": "Stylesheet title."},
2392 { "name": "disabled", "type": "boolean", "description": "Denotes whether the stylesheet is disabled."},
2393 { "name": "hasSourceURL", "type": "boolean", "optional": true, "description": "Whether the sourceURL field value comes from the sourceURL comment." },
2394 { "name": "isInline", "type": "boolean", "description": "Whether this stylesheet is created for STYLE tag by parser. This flag is not set for document.written STYLE tags." },
2395 { "name": "startLine", "type": "number", "description": "Line offset of the stylesheet within the resource (zero based)." },
2396 { "name": "startColumn", "type": "number", "description": "Column offset of the stylesheet within the resource (zero based)." }
2397 ],
2398 "description": "CSS stylesheet metainformation."
2399 },
2400 {
2401 "id": "CSSStyleSheetBody",
2402 "type": "object",
2403 "properties": [
2404 { "name": "styleSheetId", "$ref": "StyleSheetId", "description": "The stylesheet identifier."},
2405 { "name": "rules", "type": "array", "items": { "$ref": "CSSRule" }, "description": "Stylesheet resource URL."},
2406 { "name": "text", "type": "string", "optional": true, "description": "Stylesheet resource contents (if available)."}
2407 ],
2408 "description": "CSS stylesheet contents."
2409 },
2410 {
2411 "id": "CSSRule",
2412 "type": "object",
2413 "properties": [
2414 { "name": "ruleId", "$ref": "CSSRuleId", "optional": true, "description": "The CSS rule identifier (absent for user agent stylesheet and user-specified stylesheet rules)."},
2415 { "name": "selectorList", "$ref": "SelectorList", "description": "Rule selector data." },
2416 { "name": "sourceURL", "type": "string", "optional": true, "description": "Parent stylesheet resource URL (for regular rules)."},
2417 { "name": "origin", "$ref": "StyleSheetOrigin", "description": "Parent stylesheet's origin."},
2418 { "name": "style", "$ref": "CSSStyle", "description": "Associated style declaration." },
2419 { "name": "media", "type": "array", "items": { "$ref": "CSSMedia" }, "optional": true, "description": "Media list array (for rules involving media queries). The array enumerates media queries starting with the innermost one, going outwards." }
2420 ],
2421 "description": "CSS rule representation."
2422 },
2423 {
2424 "id": "SourceRange",
2425 "type": "object",
2426 "properties": [
2427 { "name": "startLine", "type": "integer", "description": "Start line of range." },
2428 { "name": "startColumn", "type": "integer", "description": "Start column of range (inclusive)." },
2429 { "name": "endLine", "type": "integer", "description": "End line of range" },
2430 { "name": "endColumn", "type": "integer", "description": "End column of range (exclusive)." }
2431 ],
2432 "description": "Text range within a resource. All numbers are zero-based."
2433 },
2434 {
2435 "id": "ShorthandEntry",
2436 "type": "object",
2437 "properties": [
2438 { "name": "name", "type": "string", "description": "Shorthand name." },
2439 { "name": "value", "type": "string", "description": "Shorthand value." }
2440 ]
2441 },
2442 {
2443 "id": "CSSPropertyInfo",
2444 "type": "object",
2445 "properties": [
2446 { "name": "name", "type": "string", "description": "Property name." },
2447 { "name": "longhands", "type": "array", "optional": true, "items": { "type": "string" }, "description": "Longhand property names." }
2448 ]
2449 },
2450 {
2451 "id": "CSSComputedStyleProperty",
2452 "type": "object",
2453 "properties": [
2454 { "name": "name", "type": "string", "description": "Computed style property name." },
2455 { "name": "value", "type": "string", "description": "Computed style property value." }
2456 ]
2457 },
2458 {
2459 "id": "CSSStyle",
2460 "type": "object",
2461 "properties": [
2462 { "name": "styleId", "$ref": "CSSStyleId", "optional": true, "description": "The CSS style identifier (absent for attribute styles)." },
2463 { "name": "cssProperties", "type": "array", "items": { "$ref": "CSSProperty" }, "description": "CSS properties in the style." },
2464 { "name": "shorthandEntries", "type": "array", "items": { "$ref": "ShorthandEntry" }, "description": "Computed values for all shorthands found in the style." },
2465 { "name": "cssText", "type": "string", "optional": true, "description": "Style declaration text (if available)." },
2466 { "name": "range", "$ref": "SourceRange", "optional": true, "description": "Style declaration range in the enclosing stylesheet (if available)." },
2467 { "name": "width", "type": "string", "optional": true, "description": "The effective \"width\" property value from this style." },
2468 { "name": "height", "type": "string", "optional": true, "description": "The effective \"height\" property value from this style." }
2469 ],
2470 "description": "CSS style representation."
2471 },
2472 {
2473 "id": "CSSProperty",
2474 "type": "object",
2475 "properties": [
2476 { "name": "name", "type": "string", "description": "The property name." },
2477 { "name": "value", "type": "string", "description": "The property value." },
2478 { "name": "priority", "type": "string", "optional": true, "description": "The property priority (implies \"\" if absent)." },
2479 { "name": "implicit", "type": "boolean", "optional": true, "description": "Whether the property is implicit (implies <code>false</code> if absent)." },
2480 { "name": "text", "type": "string", "optional": true, "description": "The full property text as specified in the style." },
2481 { "name": "parsedOk", "type": "boolean", "optional": true, "description": "Whether the property is understood by the browser (implies <code>true</code> if absent)." },
2482 { "name": "status", "type": "string", "enum": ["active", "inactive", "disabled", "style"], "optional": true, "description": "The property status: \"active\" 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\" (implied if absent) if the property is reported by the browser rather than by the CSS source parser." },
2483 { "name": "range", "$ref": "SourceRange", "optional": true, "description": "The entire property range in the enclosing style declaration (if available)." }
2484 ],
2485 "description": "CSS property declaration data."
2486 },
2487 {
2488 "id": "CSSMedia",
2489 "type": "object",
2490 "properties": [
2491 { "name": "text", "type": "string", "description": "Media query text." },
2492 { "name": "source", "type": "string", "enum": ["mediaRule", "importRule", "linkedSheet", "inlineSheet"], "description": "Source of the media query: \"mediaRule\" if specified by a @media rule, \"importRule\" if specified by an @import rule, \"linkedSheet\" if specified by a \"media\" attribute in a linked stylesheet's LINK tag, \"inlineSheet\" if specified by a \"media\" attribute in an inline stylesheet's STYLE tag." },
2493 { "name": "sourceURL", "type": "string", "optional": true, "description": "URL of the document containing the media query description." },
2494 { "name": "range", "$ref": "SourceRange", "optional": true, "description": "The associated rule (@media or @import) header range in the enclosing stylesheet (if available)." },
2495 { "name": "parentStyleSheetId", "$ref": "StyleSheetId", "optional": true, "description": "Identifier of the stylesheet containing this object (if exists)." }
2496 ],
2497 "description": "CSS media query descriptor."
2498 },
2499 {
2500 "id": "SelectorProfileEntry",
2501 "type": "object",
2502 "properties": [
2503 { "name": "selector", "type": "string", "description": "CSS selector of the corresponding rule." },
2504 { "name": "url", "type": "string", "description": "URL of the resource containing the corresponding rule." },
2505 { "name": "lineNumber", "type": "integer", "description": "Selector line number in the resource for the corresponding rule." },
2506 { "name": "time", "type": "number", "description": "Total time this rule handling contributed to the browser running time during profiling (in milliseconds)." },
2507 { "name": "hitCount", "type": "integer", "description": "Number of times this rule was considered a candidate for matching against DOM elements." },
2508 { "name": "matchCount", "type": "integer", "description": "Number of times this rule actually matched a DOM element." }
2509 ],
2510 "description": "CSS selector profile entry."
2511 },
2512 {
2513 "id": "SelectorProfile",
2514 "type": "object",
2515 "properties": [
2516 { "name": "totalTime", "type": "number", "description": "Total processing time for all selectors in the profile (in milliseconds)." },
2517 { "name": "data", "type": "array", "items": { "$ref": "SelectorProfileEntry" }, "description": "CSS selector profile entries." }
2518 ]
2519 },
2520 {
2521 "id": "Region",
2522 "type": "object",
2523 "properties": [
2524 { "name": "regionOverset", "type": "string", "enum": ["overset", "fit", "empty"], "description": "The \"overset\" attribute of a Named Flow." },
2525 { "name": "nodeId", "$ref": "DOM.NodeId", "description": "The corresponding DOM node id." }
2526 ],
2527 "description": "This object represents a region that flows from a Named Flow.",
2528 "hidden": true
2529 },
2530 {
2531 "id": "NamedFlow",
2532 "type": "object",
2533 "properties": [
2534 { "name": "documentNodeId", "$ref": "DOM.NodeId", "description": "The document node id." },
2535 { "name": "name", "type": "string", "description": "Named Flow identifier." },
2536 { "name": "overset", "type": "boolean", "description": "The \"overset\" attribute of a Named Flow." },
2537 { "name": "content", "type": "array", "items": { "$ref": "DOM.NodeId" }, "description": "An array of nodes that flow into the Named Flow." },
2538 { "name": "regions", "type": "array", "items": { "$ref": "Region" }, "description": "An array of regions associated with the Named Flow." }
2539 ],
2540 "description": "This object represents a Named Flow.",
2541 "hidden": true
2542 },
2543 {
2544 "id": "PlatformFontUsage",
2545 "type": "object",
2546 "properties": [
2547 { "name": "familyName", "type": "string", "description": "Font's family name reported by platform."},
2548 { "name": "glyphCount", "type": "number", "description": "Amount of glyphs that were rendered with this font."}
2549 ],
2550 "description": "Information about amount of glyphs that were rendered with given font."
2551 }
2552 ],
2553 "commands": [
2554 {
2555 "name": "enable",
2556 "description": "Enables the CSS agent for the given page. Clients should not assume that the CSS agent has been enabled until the result of this command is received."
2557 },
2558 {
2559 "name": "disable",
2560 "description": "Disables the CSS agent for the given page."
2561 },
2562 {
2563 "name": "getMatchedStylesForNode",
2564 "parameters": [
2565 { "name": "nodeId", "$ref": "DOM.NodeId" },
2566 { "name": "includePseudo", "type": "boolean", "optional": true, "description": "Whether to include pseudo styles (default: true)." },
2567 { "name": "includeInherited", "type": "boolean", "optional": true, "description": "Whether to include inherited styles (default: true)." }
2568 ],
2569 "returns": [
2570 { "name": "matchedCSSRules", "type": "array", "items": { "$ref": "RuleMatch" }, "optional": true, "description": "CSS rules matching this node, from all applicable stylesheets." },
2571 { "name": "pseudoElements", "type": "array", "items": { "$ref": "PseudoIdMatches" }, "optional": true, "description": "Pseudo style matches for this node." },
2572 { "name": "inherited", "type": "array", "items": { "$ref": "InheritedStyleEntry" }, "optional": true, "description": "A chain of inherited styles (from the immediate node parent up to the DOM tree root)." }
2573 ],
2574 "description": "Returns requested styles for a DOM node identified by <code>nodeId</code>."
2575 },
2576 {
2577 "name": "getInlineStylesForNode",
2578 "parameters": [
2579 { "name": "nodeId", "$ref": "DOM.NodeId" }
2580 ],
2581 "returns": [
2582 { "name": "inlineStyle", "$ref": "CSSStyle", "optional": true, "description": "Inline style for the specified DOM node." },
2583 { "name": "attributesStyle", "$ref": "CSSStyle", "optional": true, "description": "Attribute-defined element style (e.g. resulting from \"width=20 height=100%\")."}
2584 ],
2585 "description": "Returns the styles defined inline (explicitly in the \"style\" attribute and implicitly, using DOM attributes) for a DOM node identified by <code>nodeId</code>."
2586 },
2587 {
2588 "name": "getComputedStyleForNode",
2589 "parameters": [
2590 { "name": "nodeId", "$ref": "DOM.NodeId" }
2591 ],
2592 "returns": [
2593 { "name": "computedStyle", "type": "array", "items": { "$ref": "CSSComputedStyleProperty" }, "description": "Computed style for the specified DOM node." }
2594 ],
2595 "description": "Returns the computed style for a DOM node identified by <code>nodeId</code>."
2596 },
2597 {
2598 "name": "getPlatformFontsForNode",
2599 "parameters": [
2600 { "name": "nodeId", "$ref": "DOM.NodeId" }
2601 ],
2602 "returns": [
2603 { "name": "cssFamilyName", "type": "string", "description": "Font family name which is determined by computed style." },
2604 { "name": "fonts", "type": "array", "items": { "$ref": "PlatformFontUsage"}, "description": "Usage statistics for every employed platform font." }
2605 ],
2606 "description": "Requests information about platform fonts which we used to render child TextNodes in the given node.",
2607 "hidden": true
2608 },
2609 {
2610 "name": "getAllStyleSheets",
2611 "returns": [
2612 { "name": "headers", "type": "array", "items": { "$ref": "CSSStyleSheetHeader" }, "description": "Descriptor entries for all available stylesheets." }
2613 ],
2614 "description": "Returns metainfo entries for all known stylesheets."
2615 },
2616 {
2617 "name": "getStyleSheet",
2618 "parameters": [
2619 { "name": "styleSheetId", "$ref": "StyleSheetId" }
2620 ],
2621 "returns": [
2622 { "name": "styleSheet", "$ref": "CSSStyleSheetBody", "description": "Stylesheet contents for the specified <code>styleSheetId</code>." }
2623 ],
2624 "description": "Returns stylesheet data for the specified <code>styleSheetId</code>."
2625 },
2626 {
2627 "name": "getStyleSheetText",
2628 "parameters": [
2629 { "name": "styleSheetId", "$ref": "StyleSheetId" }
2630 ],
2631 "returns": [
2632 { "name": "text", "type": "string", "description": "The stylesheet text." }
2633 ],
2634 "description": "Returns the current textual content and the URL for a stylesheet."
2635 },
2636 {
2637 "name": "setStyleSheetText",
2638 "parameters": [
2639 { "name": "styleSheetId", "$ref": "StyleSheetId" },
2640 { "name": "text", "type": "string" }
2641 ],
2642 "description": "Sets the new stylesheet text, thereby invalidating all existing <code>CSSStyleId</code>'s and <code>CSSRuleId</code>'s contained by this stylesheet."
2643 },
2644 {
2645 "name": "setStyleText",
2646 "parameters": [
2647 { "name": "styleId", "$ref": "CSSStyleId" },
2648 { "name": "text", "type": "string" }
2649 ],
2650 "returns": [
2651 { "name": "style", "$ref": "CSSStyle", "description": "The resulting style after the text modification." }
2652 ],
2653 "description": "Updates the CSSStyleDeclaration text."
2654 },
2655 {
2656 "name": "setPropertyText",
2657 "parameters": [
2658 { "name": "styleId", "$ref": "CSSStyleId" },
2659 { "name": "propertyIndex", "type": "integer" },
2660 { "name": "text", "type": "string" },
2661 { "name": "overwrite", "type": "boolean" }
2662 ],
2663 "returns": [
2664 { "name": "style", "$ref": "CSSStyle", "description": "The resulting style after the property text modification." }
2665 ],
2666 "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>."
2667 },
2668 {
2669 "name": "toggleProperty",
2670 "parameters": [
2671 { "name": "styleId", "$ref": "CSSStyleId" },
2672 { "name": "propertyIndex", "type": "integer" },
2673 { "name": "disable", "type": "boolean" }
2674 ],
2675 "returns": [
2676 { "name": "style", "$ref": "CSSStyle", "description": "The resulting style after the property toggling." }
2677 ],
2678 "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."
2679 },
2680 {
2681 "name": "setRuleSelector",
2682 "parameters": [
2683 { "name": "ruleId", "$ref": "CSSRuleId" },
2684 { "name": "selector", "type": "string" }
2685 ],
2686 "returns": [
2687 { "name": "rule", "$ref": "CSSRule", "description": "The resulting rule after the selector modification." }
2688 ],
2689 "description": "Modifies the rule selector."
2690 },
2691 {
2692 "name": "addRule",
2693 "parameters": [
2694 { "name": "contextNodeId", "$ref": "DOM.NodeId" },
2695 { "name": "selector", "type": "string" }
2696 ],
2697 "returns": [
2698 { "name": "rule", "$ref": "CSSRule", "description": "The newly created rule." }
2699 ],
2700 "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."
2701 },
2702 {
2703 "name": "getSupportedCSSProperties",
2704 "returns": [
2705 { "name": "cssProperties", "type": "array", "items": { "$ref": "CSSPropertyInfo" }, "description": "Supported property metainfo." }
2706 ],
2707 "description": "Returns all supported CSS property names."
2708 },
2709 {
2710 "name": "forcePseudoState",
2711 "parameters": [
2712 { "name": "nodeId", "$ref": "DOM.NodeId", "description": "The element id for which to force the pseudo state." },
2713 { "name": "forcedPseudoClasses", "type": "array", "items": { "type": "string", "enum": ["active", "focus", "hover", "visited"] }, "description": "Element pseudo classes to force when computing the element's style." }
2714 ],
2715 "description": "Ensures that the given node will have specified pseudo-classes whenever its style is computed by the browser."
2716 },
2717 {
2718 "name": "getNamedFlowCollection",
2719 "parameters": [
2720 { "name": "documentNodeId", "$ref": "DOM.NodeId", "description": "The document node id for which to get the Named Flow Collection." }
2721 ],
2722 "returns": [
2723 { "name": "namedFlows", "type": "array", "items": { "$ref": "NamedFlow" }, "description": "An array containing the Named Flows in the document." }
2724 ],
2725 "description": "Returns the Named Flows from the document.",
2726 "hidden": true
2727 }
2728 ],
2729 "events": [
2730 {
2731 "name": "mediaQueryResultChanged",
2732 "description": "Fires whenever a MediaQuery result changes (for example, after a browser window has been resized.) The current implementation considers only viewport-dependent media features."
2733 },
2734 {
2735 "name": "styleSheetChanged",
2736 "parameters": [
2737 { "name": "styleSheetId", "$ref": "StyleSheetId" }
2738 ],
2739 "description": "Fired whenever a stylesheet is changed as a result of the client operation."
2740 },
2741 {
2742 "name": "styleSheetAdded",
2743 "parameters": [
2744 { "name": "header", "$ref": "CSSStyleSheetHeader", "description": "Added stylesheet metainfo." }
2745 ],
2746 "description": "Fired whenever an active document stylesheet is added."
2747 },
2748 {
2749 "name": "styleSheetRemoved",
2750 "parameters": [
2751 { "name": "styleSheetId", "$ref": "StyleSheetId", "description": "Identifier of the removed stylesheet." }
2752 ],
2753 "description": "Fired whenever an active document stylesheet is removed."
2754 },
2755 {
2756 "name": "namedFlowCreated",
2757 "parameters": [
2758 { "name": "namedFlow", "$ref": "NamedFlow", "description": "The new Named Flow." }
2759 ],
2760 "description": "Fires when a Named Flow is created.",
2761 "hidden": true
2762 },
2763 {
2764 "name": "namedFlowRemoved",
2765 "parameters": [
2766 { "name": "documentNodeId", "$ref": "DOM.NodeId", "description": "The document node id." },
2767 { "name": "flowName", "type": "string", "description": "Identifier of the removed Named Flow." }
2768 ],
2769 "description": "Fires when a Named Flow is removed: has no associated content nodes and regions.",
2770 "hidden": true
2771 },
2772 {
2773 "name": "regionLayoutUpdated",
2774 "parameters": [
2775 { "name": "namedFlow", "$ref": "NamedFlow", "description": "The Named Flow whose layout may have changed." }
2776 ],
2777 "description": "Fires when a Named Flow's layout may have changed.",
2778 "hidden": true
2779 },
2780 {
2781 "name": "regionOversetChanged",
2782 "parameters": [
2783 { "name": "namedFlow", "$ref": "NamedFlow", "description": "The Named Flow containing the regions whose regionOverset values changed." }
2784 ],
2785 "description": "Fires if any of the regionOverset values changed in a Named Flow's region chain.",
2786 "hidden": true
2787 }
2788 ]
2789 },
2790 {
2791 "domain": "Timeline",
2792 "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.",
2793 "types": [
2794 {
2795 "id": "DOMCounters",
2796 "type": "object",
2797 "properties": [
2798 { "name": "documents", "type": "integer" },
2799 { "name": "nodes", "type": "integer" },
2800 { "name": "jsEventListeners", "type": "integer" }
2801 ],
2802 "description": "Current values of DOM counters.",
2803 "hidden": true
2804 },
2805 {
2806 "id": "TimelineEvent",
2807 "type": "object",
2808 "properties": [
2809 { "name": "type", "type": "string", "description": "Event type." },
2810 { "name": "thread", "type": "string", "optional": true, "description": "If present, identifies the thread that produced the event.", "hidden": true },
2811 { "name": "data", "type": "object", "description": "Event data." },
2812 { "name": "children", "type": "array", "optional": true, "items": { "$ref": "TimelineEvent" }, "description": "Nested records." },
2813 { "name": "counters", "$ref": "DOMCounters", "optional": true, "hidden": true, "description": "Current values of DOM counters." },
2814 { "name": "usedHeapSize", "type": "integer", "optional": true, "hidden": true, "description": "Current size of JS heap." },
2815 { "name": "nativeHeapStatistics", "type": "object", "optional": true, "hidden": true, "description": "Native heap statistics." }
2816 ],
2817 "description": "Timeline record contains information about the recorded activity."
2818 }
2819 ],
2820 "commands": [
2821 {
2822 "name": "start",
2823 "parameters": [
2824 { "name": "maxCallStackDepth", "optional": true, "type": "integer", "description": "Samples JavaScript stack traces up to <code>maxCallStackDepth</code>, defaults to 5." },
2825 { "name": "includeDomCounters", "optional": true, "type": "boolean", "hidden": true, "description": "Whether DOM counters data should be included into timeline events." },
2826 { "name": "includeNativeMemoryStatistics", "optional": true, "type": "boolean", "hidden": true, "description": "Whether native memory usage statistics should be reported as part of timeline events." }
2828 ],
2829 "description": "Starts capturing instrumentation events."
2830 },
2831 {
2832 "name": "stop",
2833 "description": "Stops capturing instrumentation events."
2834 }
2835 ],
2836 "events": [
2837 {
2838 "name": "eventRecorded",
2839 "parameters": [
2840 { "name": "record", "$ref": "TimelineEvent", "description": "Timeline event record data." }
2841 ],
2842 "description": "Fired for every instrumentation event while timeline is started."
2843 }
2844 ]
2845 },
2846 {
2847 "domain": "Debugger",
2848 "description": "Debugger domain exposes JavaScript debugging capabilities. It allows setting and removing breakpoints, stepping through execution, exploring stack traces, etc.",
2849 "types": [
2850 {
2851 "id": "BreakpointId",
2852 "type": "string",
2853 "description": "Breakpoint identifier."
2854 },
2855 {
2856 "id": "ScriptId",
2857 "type": "string",
2858 "description": "Unique script identifier."
2859 },
2860 {
2861 "id": "CallFrameId",
2862 "type": "string",
2863 "description": "Call frame identifier."
2864 },
2865 {
2866 "id": "Location",
2867 "type": "object",
2868 "properties": [
2869 { "name": "scriptId", "$ref": "ScriptId", "description": "Script identifier as reported in the <code>Debugger.scriptParsed</code>." },
2870 { "name": "lineNumber", "type": "integer", "description": "Line number in the script (0-based)." },
2871 { "name": "columnNumber", "type": "integer", "optional": true, "description": "Column number in the script (0-based)." }
2872 ],
2873 "description": "Location in the source code."
2874 },
2875 {
2876 "id": "FunctionDetails",
2877 "hidden": true,
2878 "type": "object",
2879 "properties": [
2880 { "name": "location", "$ref": "Location", "description": "Location of the function." },
2881 { "name": "name", "type": "string", "optional": true, "description": "Name of the function. Not present for anonymous functions." },
2882 { "name": "displayName", "type": "string", "optional": true, "description": "Display name of the function(specified in 'displayName' property on the function object)." },
2883 { "name": "inferredName", "type": "string", "optional": true, "description": "Name of the function inferred from its initial assignment." },
2884 { "name": "scopeChain", "type": "array", "optional": true, "items": { "$ref": "Scope" }, "description": "Scope chain for this closure." }
2885 ],
2886 "description": "Information about the function."
2887 },
2888 {
2889 "id": "CallFrame",
2890 "type": "object",
2891 "properties": [
2892 { "name": "callFrameId", "$ref": "CallFrameId", "description": "Call frame identifier. This identifier is only valid while the virtual machine is paused." },
2893 { "name": "functionName", "type": "string", "description": "Name of the JavaScript function called on this call frame." },
2894 { "name": "location", "$ref": "Location", "description": "Location in the source code." },
2895 { "name": "scopeChain", "type": "array", "items": { "$ref": "Scope" }, "description": "Scope chain for this call frame." },
2896 { "name": "this", "$ref": "Runtime.RemoteObject", "description": "<code>this</code> object for this call frame." }
2897 ],
2898 "description": "JavaScript call frame. Array of call frames form the call stack."
2899 },
2900 {
2901 "id": "Scope",
2902 "type": "object",
2903 "properties": [
2904 { "name": "type", "type": "string", "enum": ["global", "local", "with", "closure", "catch"], "description": "Scope type." },
2905 { "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." }
2906 ],
2907 "description": "Scope description."
2908 },
2909 {
2910 "id": "SetScriptSourceError",
2911 "type": "object",
2912 "properties": [
2913 { "name": "compileError", "optional": true, "type": "object", "properties":
2914 [
2915 { "name": "message", "type": "string", "description": "Compiler error message" },
2916 { "name": "lineNumber", "type": "integer", "description": "Compile error line number (1-based)" },
2917 { "name": "columnNumber", "type": "integer", "description": "Compile error column number (1-based)" }
2918 ]
2919 }
2920 ],
2921 "description": "Error data for setScriptSource command. compileError is a case type for uncompilable script source error.",
2922 "hidden": true
2923 }
2924 ],
2925 "commands": [
2926 {
2927 "name": "enable",
2928 "description": "Enables debugger for the given page. Clients should not assume that the debugging has been enabled until the result for this command is received."
2929 },
2930 {
2931 "name": "disable",
2932 "description": "Disables debugger for given page."
2933 },
2934 {
2935 "name": "setBreakpointsActive",
2936 "parameters": [
2937 { "name": "active", "type": "boolean", "description": "New value for breakpoints active state." }
2938 ],
2939 "description": "Activates / deactivates all breakpoints on the page."
2940 },
2941 {
2942 "name": "setSkipAllPauses",
2943 "hidden": true,
2944 "parameters": [
2945 { "name": "skipped", "type": "boolean", "description": "New value for skip pauses state." },
2946 { "name": "untilReload", "type": "boolean", "optional": true, "description": "Whether page reload should set skipped to false." }
2947 ],
2948 "description": "Makes page not interrupt on any pauses (breakpoint, exception, dom exception etc)."
2949 },
2950 {
2951 "name": "setBreakpointByUrl",
2952 "parameters": [
2953 { "name": "lineNumber", "type": "integer", "description": "Line number to set breakpoint at." },
2954 { "name": "url", "type": "string", "optional": true, "description": "URL of the resources to set breakpoint on." },
2955 { "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." },
2956 { "name": "columnNumber", "type": "integer", "optional": true, "description": "Offset in the line to set breakpoint at." },
2957 { "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." },
2958 { "name": "isAntibreakpoint", "type": "boolean", "optional": true, "hidden": true, "description": "Creates pseudo-breakpoint that prevents debugger from pausing on exception at this location." }
2959 ],
2960 "returns": [
2961 { "name": "breakpointId", "$ref": "BreakpointId", "description": "Id of the created breakpoint for further reference." },
2962 { "name": "locations", "type": "array", "items": { "$ref": "Location"}, "description": "List of the locations this breakpoint resolved into upon addition." }
2963 ],
2964 "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."
2965 },
2966 {
2967 "name": "setBreakpoint",
2968 "parameters": [
2969 { "name": "location", "$ref": "Location", "description": "Location to set breakpoint in." },
2970 { "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." }
2971 ],
2972 "returns": [
2973 { "name": "breakpointId", "$ref": "BreakpointId", "description": "Id of the created breakpoint for further reference." },
2974 { "name": "actualLocation", "$ref": "Location", "description": "Location this breakpoint resolved into." }
2975 ],
2976 "description": "Sets JavaScript breakpoint at a given location."
2977 },
2978 {
2979 "name": "removeBreakpoint",
2980 "parameters": [
2981 { "name": "breakpointId", "$ref": "BreakpointId" }
2982 ],
2983 "description": "Removes JavaScript breakpoint."
2984 },
2985 {
2986 "name": "continueToLocation",
2987 "parameters": [
2988 { "name": "location", "$ref": "Location", "description": "Location to continue to." },
2989 { "name": "interstatementLocation", "type": "boolean", "optional": true, "hidden": true, "description": "Allows breakpoints at the intemediate positions inside statements." }
2990 ],
2991 "description": "Continues execution until specific location is reached."
2992 },
2993 {
2994 "name": "stepOver",
2995 "description": "Steps over the statement."
2996 },
2997 {
2998 "name": "stepInto",
2999 "description": "Steps into the function call."
3000 },
3001 {
3002 "name": "stepOut",
3003 "description": "Steps out of the function call."
3004 },
3005 {
3006 "name": "pause",
3007 "description": "Stops on the next JavaScript statement."
3008 },
3009 {
3010 "name": "resume",
3011 "description": "Resumes JavaScript execution."
3012 },
3013 {
3014 "name": "searchInContent",
3015 "parameters": [
3016 { "name": "scriptId", "$ref": "ScriptId", "description": "Id of the script to search in." },
3017 { "name": "query", "type": "string", "description": "String to search for." },
3018 { "name": "caseSensitive", "type": "boolean", "optional": true, "description": "If true, search is case sensitive." },
3019 { "name": "isRegex", "type": "boolean", "optional": true, "description": "If true, treats string parameter as regex." }
3020 ],
3021 "returns": [
3022 { "name": "result", "type": "array", "items": { "$ref": "Page.SearchMatch" }, "description": "List of search matches." }
3023 ],
3024 "description": "Searches for given string in script content."
3025 },
3026 {
3027 "name": "canSetScriptSource",
3028 "returns": [
3029 { "name": "result", "type": "boolean", "description": "True if <code>setScriptSource</code> is supported." }
3030 ],
3031 "description": "Always returns true."
3032 },
3033 {
3034 "name": "setScriptSource",
3035 "parameters": [
3036 { "name": "scriptId", "$ref": "ScriptId", "description": "Id of the script to edit." },
3037 { "name": "scriptSource", "type": "string", "description": "New content of the script." },
3038 { "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 }
3039 ],
3040 "returns": [
3041 { "name": "callFrames", "type": "array", "optional": true, "items": { "$ref": "CallFrame"}, "description": "New stack trace in case editing has happened while VM was stopped." },
3042 { "name": "result", "type": "object", "optional": true, "description": "VM-specific description of the changes applied.", "hidden": true }
3043 ],
3044 "error": {
3045 "$ref": "SetScriptSourceError"
3046 },
3047 "description": "Edits JavaScript source live."
3048 },
3049 {
3050 "name": "restartFrame",
3051 "parameters": [
3052 { "name": "callFrameId", "$ref": "CallFrameId", "description": "Call frame identifier to evaluate on." }
3053 ],
3054 "returns": [
3055 { "name": "callFrames", "type": "array", "items": { "$ref": "CallFrame"}, "description": "New stack trace." },
3056 { "name": "result", "type": "object", "description": "VM-specific description.", "hidden": true }
3057 ],
3058 "hidden": true,
3059 "description": "Restarts particular call frame from the beginning."
3060 },
3061 {
3062 "name": "getScriptSource",
3063 "parameters": [
3064 { "name": "scriptId", "$ref": "ScriptId", "description": "Id of the script to get source for." }
3065 ],
3066 "returns": [
3067 { "name": "scriptSource", "type": "string", "description": "Script source." }
3068 ],
3069 "description": "Returns source for the script with given id."
3070 },
3071 {
3072 "name": "getFunctionDetails",
3073 "hidden": true,
3074 "parameters": [
3075 { "name": "functionId", "$ref": "Runtime.RemoteObjectId", "description": "Id of the function to get location for." }
3076 ],
3077 "returns": [
3078 { "name": "details", "$ref": "FunctionDetails", "description": "Information about the function." }
3079 ],
3080 "description": "Returns detailed informtation on given function."
3081 },
3082 {
3083 "name": "setPauseOnExceptions",
3084 "parameters": [
3085 { "name": "state", "type": "string", "enum": ["none", "uncaught", "all"], "description": "Pause on exceptions mode." }
3086 ],
3087 "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>."
3088 },
3089 {
3090 "name": "evaluateOnCallFrame",
3091 "parameters": [
3092 { "name": "callFrameId", "$ref": "CallFrameId", "description": "Call frame identifier to evaluate on." },
3093 { "name": "expression", "type": "string", "description": "Expression to evaluate." },
3094 { "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>)." },
3095 { "name": "includeCommandLineAPI", "type": "boolean", "optional": true, "description": "Specifies whether command line API should be available to the evaluated expression, defaults to false.", "hidden": true },
3096 { "name": "doNotPauseOnExceptionsAndMuteConsole", "type": "boolean", "optional": true, "description": "Specifies whether evaluation should stop on exceptions and mute console. Overrides setPauseOnException state.", "hidden": true },
3097 { "name": "returnByValue", "type": "boolean", "optional": true, "description": "Whether the result is expected to be a JSON object that should be sent by value." },
3098 { "name": "generatePreview", "type": "boolean", "optional": true, "hidden": true, "description": "Whether preview should be generated for the result." }
3099 ],
3100 "returns": [
3101 { "name": "result", "$ref": "Runtime.RemoteObject", "description": "Object wrapper for the evaluation result." },
3102 { "name": "wasThrown", "type": "boolean", "optional": true, "description": "True if the result was thrown during the evaluation." }
3103 ],
3104 "description": "Evaluates expression on a given call frame."
3105 },
3106 {
3107 "name": "compileScript",
3108 "hidden": true,
3109 "parameters": [
3110 { "name": "expression", "type": "string", "description": "Expression to compile." },
3111 { "name": "sourceURL", "type": "string", "description": "Source url to be set for the script." }
3112 ],
3113 "returns": [
3114 { "name": "scriptId", "$ref": "ScriptId", "optional": true, "description": "Id of the script." },
3115 { "name": "syntaxErrorMessage", "type": "string", "optional": true, "description": "Syntax error message if compilation failed." }
3116 ],
3117 "description": "Compiles expression."
3118 },
3119 {
3120 "name": "runScript",
3121 "hidden": true,
3122 "parameters": [
3123 { "name": "scriptId", "$ref": "ScriptId", "description": "Id of the script to run." },
3124 { "name": "contextId", "$ref": "Runtime.ExecutionContextId", "optional": true, "description": "Specifies in which isolated context to perform script run. Each content script lives in an isolated context and this parameter may be used to specify one of those contexts. If the parameter is omitted or 0 the evaluation will be performed in the context of the inspected page." },
3125 { "name": "objectGroup", "type": "string", "optional": true, "description": "Symbolic group name that can be used to release multiple objects." },
3126 { "name": "doNotPauseOnExceptionsAndMuteConsole", "type": "boolean", "optional": true, "description": "Specifies whether script run should stop on exceptions and mute console. Overrides setPauseOnException state." }
3127 ],
3128 "returns": [
3129 { "name": "result", "$ref": "Runtime.RemoteObject", "description": "Run result." },
3130 { "name": "wasThrown", "type": "boolean", "optional": true, "description": "True if the result was thrown during the script run." }
3131 ],
3132 "description": "Runs script with given id in a given context."
3133 },
3134 {
3135 "name": "setOverlayMessage",
3136 "parameters": [
3137 { "name": "message", "type": "string", "optional": true, "description": "Overlay message to display when paused in debugger." }
3138 ],
3139 "hidden": true,
3140 "description": "Sets overlay message."
3141 },
3142 {
3143 "name": "setVariableValue",
3144 "parameters": [
3145 { "name": "scopeNumber", "type": "integer", "description": "0-based number of scope as was listed in scope chain. Only 'local', 'closure' and 'catch' scope types are allowed. Other scopes could be manipulated manually." },
3146 { "name": "variableName", "type": "string", "description": "Variable name." },
3147 { "name": "newValue", "$ref": "Runtime.CallArgument", "description": "New variable value." },
3148 { "name": "callFrameId", "$ref": "CallFrameId", "optional": true, "description": "Id of callframe that holds variable." },
3149 { "name": "functionObjectId", "$ref": "Runtime.RemoteObjectId", "optional": true, "description": "Object id of closure (function) that holds variable." }
3150 ],
3151 "hidden": true,
3152 "description": "Changes value of variable in a callframe or a closure. Either callframe or function must be specified. Object-based scopes are not supported and must be mutated manually."
3153 },
3154 {
3155 "name": "getStepInPositions",
3156 "parameters": [
3157 { "name": "callFrameId", "$ref": "CallFrameId", "description": "Id of a call frame where the current statement should be analized" }
3158 ],
3159 "returns": [
3160 { "name": "stepInPositions", "type": "array", "items": { "$ref": "Location" }, "optional": true, "description": "experimental" }
3161 ],
3162 "hidden": true,
3163 "description": "Lists all positions where step-in is possible for a current statement in a specified call frame"
3164 },
3165 {
3166 "name": "getBacktrace",
3167 "returns": [
3168 { "name": "callFrames", "type": "array", "items": { "$ref": "CallFrame"}, "description": "Call stack the virtual machine stopped on." }
3169 ],
3170 "hidden": true,
3171 "description": "Returns call stack including variables changed since VM was paused. VM must be paused."
3172 },
3173 {
3174 "name": "skipStackFrames",
3175 "parameters": [
3176 { "name": "script", "optional": true, "type": "string", "description": "Regular expression defining the scripts to ignore while stepping." }
3177 ],
3178 "hidden": true,
3179 "description": "Makes backend skip steps in the sources with names matching given pattern. VM will try leave blacklisted scripts by performing 'step in' several times, finally resorting to 'step out' if unsuccessful."
3180 }
3181 ],
3182 "events": [
3183 {
3184 "name": "globalObjectCleared",
3185 "description": "Called when global has been cleared and debugger client should reset its state. Happens upon navigation or reload."
3186 },
3187 {
3188 "name": "scriptParsed",
3189 "parameters": [
3190 { "name": "scriptId", "$ref": "ScriptId", "description": "Identifier of the script parsed." },
3191 { "name": "url", "type": "string", "description": "URL or name of the script parsed (if any)." },
3192 { "name": "startLine", "type": "integer", "description": "Line offset of the script within the resource with given URL (for script tags)." },
3193 { "name": "startColumn", "type": "integer", "description": "Column offset of the script within the resource with given URL." },
3194 { "name": "endLine", "type": "integer", "description": "Last line of the script." },
3195 { "name": "endColumn", "type": "integer", "description": "Length of the last line of the script." },
3196 { "name": "isContentScript", "type": "boolean", "optional": true, "description": "Determines whether this script is a user extension script." },
3197 { "name": "sourceMapURL", "type": "string", "optional": true, "description": "URL of source map associated with script (if any)." },
3198 { "name": "hasSourceURL", "type": "boolean", "optional": true, "description": "True, if this script has sourceURL.", "hidden": true }
3199 ],
3200 "description": "Fired when virtual machine parses script. This event is also fired for all known and uncollected scripts upon enabling debugger."
3201 },
3202 {
3203 "name": "scriptFailedToParse",
3204 "parameters": [
3205 { "name": "scriptId", "$ref": "ScriptId", "description": "Identifier of the script parsed." },
3206 { "name": "url", "type": "string", "description": "URL or name of the script parsed (if any)." },
3207 { "name": "startLine", "type": "integer", "description": "Line offset of the script within the resource with given URL (for script tags)." },
3208 { "name": "startColumn", "type": "integer", "description": "Column offset of the script within the resource with given URL." },
3209 { "name": "endLine", "type": "integer", "description": "Last line of the script." },
3210 { "name": "endColumn", "type": "integer", "description": "Length of the last line of the script." },
3211 { "name": "isContentScript", "type": "boolean", "optional": true, "description": "Determines whether this script is a user extension script." },
3212 { "name": "sourceMapURL", "type": "string", "optional": true, "description": "URL of source map associated with script (if any)." },
3213 { "name": "hasSourceURL", "type": "boolean", "optional": true, "description": "True, if this script has sourceURL.", "hidden": true }
3214 ],
3215 "description": "Fired when virtual machine fails to parse the script."
3216 },
3217 {
3218 "name": "breakpointResolved",
3219 "parameters": [
3220 { "name": "breakpointId", "$ref": "BreakpointId", "description": "Breakpoint unique identifier." },
3221 { "name": "location", "$ref": "Location", "description": "Actual breakpoint location." }
3222 ],
3223 "description": "Fired when breakpoint is resolved to an actual script and location."
3224 },
3225 {
3226 "name": "paused",
3227 "parameters": [
3228 { "name": "callFrames", "type": "array", "items": { "$ref": "CallFrame" }, "description": "Call stack the virtual machine stopped on." },
3229 { "name": "reason", "type": "string", "enum": [ "XHR", "DOM", "EventListener", "exception", "assert", "CSPViolation", "debugCommand", "other" ], "description": "Pause reason." },
3230 { "name": "data", "type": "object", "optional": true, "description": "Object containing break-specific auxiliary properties." },
3231 { "name": "hitBreakpoints", "type": "array", "optional": true, "items": { "type": "string" }, "description": "Hit breakpoints IDs", "hidden": true }
3232 ],
3233 "description": "Fired when the virtual machine stopped on breakpoint or exception or any other stop criteria."
3234 },
3235 {
3236 "name": "resumed",
3237 "description": "Fired when the virtual machine resumed execution."
3238 }
3239 ]
3240 },
3241 {
3242 "domain": "DOMDebugger",
3243 "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.",
3244 "types": [
3245 {
3246 "id": "DOMBreakpointType",
3247 "type": "string",
3248 "enum": ["subtree-modified", "attribute-modified", "node-removed"],
3249 "description": "DOM breakpoint type."
3250 }
3251 ],
3252 "commands": [
3253 {
3254 "name": "setDOMBreakpoint",
3255 "parameters": [
3256 { "name": "nodeId", "$ref": "DOM.NodeId", "description": "Identifier of the node to set breakpoint on." },
3257 { "name": "type", "$ref": "DOMBreakpointType", "description": "Type of the operation to stop upon." }
3258 ],
3259 "description": "Sets breakpoint on particular operation with DOM."
3260 },
3261 {
3262 "name": "removeDOMBreakpoint",
3263 "parameters": [
3264 { "name": "nodeId", "$ref": "DOM.NodeId", "description": "Identifier of the node to remove breakpoint from." },
3265 { "name": "type", "$ref": "DOMBreakpointType", "description": "Type of the breakpoint to remove." }
3266 ],
3267 "description": "Removes DOM breakpoint that was set using <code>setDOMBreakpoint</code>."
3268 },
3269 {
3270 "name": "setEventListenerBreakpoint",
3271 "parameters": [
3272 { "name": "eventName", "type": "string", "description": "DOM Event name to stop on (any DOM event will do)." }
3273 ],
3274 "description": "Sets breakpoint on particular DOM event."
3275 },
3276 {
3277 "name": "removeEventListenerBreakpoint",
3278 "parameters": [
3279 { "name": "eventName", "type": "string", "description": "Event name." }
3280 ],
3281 "description": "Removes breakpoint on particular DOM event."
3282 },
3283 {
3284 "name": "setInstrumentationBreakpoint",
3285 "parameters": [
3286 { "name": "eventName", "type": "string", "description": "Instrumentation name to stop on." }
3287 ],
3288 "description": "Sets breakpoint on particular native event.",
3289 "hidden": true
3290 },
3291 {
3292 "name": "removeInstrumentationBreakpoint",
3293 "parameters": [
3294 { "name": "eventName", "type": "string", "description": "Instrumentation name to stop on." }
3295 ],
3296 "description": "Removes breakpoint on particular native event.",
3297 "hidden": true
3298 },
3299 {
3300 "name": "setXHRBreakpoint",
3301 "parameters": [
3302 { "name": "url", "type": "string", "description": "Resource URL substring. All XHRs having this substring in the URL will get stopped upon." }
3303 ],
3304 "description": "Sets breakpoint on XMLHttpRequest."
3305 },
3306 {
3307 "name": "removeXHRBreakpoint",
3308 "parameters": [
3309 { "name": "url", "type": "string", "description": "Resource URL substring." }
3310 ],
3311 "description": "Removes breakpoint from XMLHttpRequest."
3312 }
3313 ]
3314 },
3315 {
3316 "domain": "Profiler",
3317 "hidden": true,
3318 "types": [
3319 {
3320 "id": "ProfileHeader",
3321 "type": "object",
3322 "description": "Profile header.",
3323 "properties": [
3324 { "name": "title", "type": "string", "description": "Profile title." },
3325 { "name": "uid", "type": "integer", "description": "Unique identifier of the profile." }
3326 ]
3327 },
3328 {
3329 "id": "CPUProfileNode",
3330 "type": "object",
3331 "description": "CPU Profile node. Holds callsite information, execution statistics and child nodes.",
3332 "properties": [
3333 { "name": "functionName", "type": "string", "description": "Function name." },
3334 { "name": "scriptId", "$ref": "Debugger.ScriptId", "description": "Script identifier." },
3335 { "name": "url", "type": "string", "description": "URL." },
3336 { "name": "lineNumber", "type": "integer", "description": "Line number." },
3337 { "name": "hitCount", "type": "integer", "description": "Number of samples where this node was on top of the call stack." },
3338 { "name": "callUID", "type": "number", "description": "Call UID." },
3339 { "name": "children", "type": "array", "items": { "$ref": "CPUProfileNode" }, "description": "Child nodes." },
3340 { "name": "deoptReason", "type": "string", "description": "The reason of being not optimized. The function may be deoptimized or marked as don't optimize."},
3341 { "name": "id", "optional": true, "type": "integer", "description": "Unique id of the node." }
3342 ]
3343 },
3344 {
3345 "id": "CPUProfile",
3346 "type": "object",
3347 "description": "Profile.",
3348 "properties": [
3349 { "name": "head", "$ref": "CPUProfileNode" },
3350 { "name": "startTime", "type": "number", "description": "Profiling start time in seconds." },
3351 { "name": "endTime", "type": "number", "description": "Profiling end time in seconds." },
3352 { "name": "samples", "optional": true, "type": "array", "items": { "type": "integer" }, "description": "Ids of samples top nodes." }
3353 ]
3354 },
3355 {
3356 "id": "HeapSnapshotObjectId",
3357 "type": "string",
3358 "description": "Heap snashot object id."
3359 }
3360 ],
3361 "commands": [
3362 {
3363 "name": "enable"
3364 },
3365 {
3366 "name": "disable"
3367 },
3368 {
3369 "name": "start"
3370 },
3371 {
3372 "name": "stop",
3373 "returns": [
3374 { "name": "header", "$ref": "ProfileHeader", "description": "The header of the recorded profile."}
3375 ]
3376 },
3377 {
3378 "name": "getProfileHeaders",
3379 "returns": [
3380 { "name": "headers", "type": "array", "items": { "$ref": "ProfileHeader"} }
3381 ]
3382 },
3383 {
3384 "name": "getCPUProfile",
3385 "parameters": [
3386 { "name": "uid", "type": "integer" }
3387 ],
3388 "returns": [
3389 { "name": "profile", "$ref": "CPUProfile" }
3390 ]
3391 },
3392 {
3393 "name": "removeProfile",
3394 "parameters": [
3395 { "name": "type", "type": "string" },
3396 { "name": "uid", "type": "integer" }
3397 ]
3398 },
3399 {
3400 "name": "clearProfiles"
3401 }
3402 ],
3403 "events": [
3404 {
3405 "name": "addProfileHeader",
3406 "parameters": [
3407 { "name": "header", "$ref": "ProfileHeader" }
3408 ]
3409 },
3410 {
3411 "name": "setRecordingProfile",
3412 "parameters": [
3413 { "name": "isProfiling", "type": "boolean" }
3414 ]
3415 },
3416 {
3417 "name": "resetProfiles"
3418 }
3419 ]
3420 },
3421 {
3422 "domain": "HeapProfiler",
3423 "hidden": true,
3424 "types": [
3425 {
3426 "id": "ProfileHeader",
3427 "type": "object",
3428 "description": "Profile header.",
3429 "properties": [
3430 { "name": "title", "type": "string", "description": "Profile title." },
3431 { "name": "uid", "type": "integer", "description": "Unique identifier of the profile." },
3432 { "name": "maxJSObjectId", "type": "integer", "optional": true, "description": "Last seen JS object Id." }
3433 ]
3434 },
3435 {
3436 "id": "HeapSnapshotObjectId",
3437 "type": "string",
3438 "description": "Heap snashot object id."
3439 }
3440 ],
3441 "commands": [
3442 {
3443 "name": "getProfileHeaders",
3444 "returns": [
3445 { "name": "headers", "type": "array", "items": { "$ref": "ProfileHeader"} }
3446 ]
3447 },
3448 {
3449 "name": "startTrackingHeapObjects"
3450 },
3451 {
3452 "name": "stopTrackingHeapObjects"
3453 },
3454 {
3455 "name": "getHeapSnapshot",
3456 "parameters": [
3457 { "name": "uid", "type": "integer" }
3458 ]
3459 },
3460 {
3461 "name": "removeProfile",
3462 "parameters": [
3463 { "name": "uid", "type": "integer" }
3464 ]
3465 },
3466 {
3467 "name": "clearProfiles"
3468 },
3469 {
3470 "name": "takeHeapSnapshot",
3471 "parameters": [
3472 { "name": "reportProgress", "type": "boolean", "optional": true, "description": "If true 'reportHeapSnapshotProgress' events will be generated while snapshot is being taken." }
3473 ]
3474 },
3475 {
3476 "name": "collectGarbage"
3477 },
3478 {
3479 "name": "getObjectByHeapObjectId",
3480 "parameters": [
3481 { "name": "objectId", "$ref": "HeapSnapshotObjectId" },
3482 { "name": "objectGroup", "type": "string", "optional": true, "description": "Symbolic group name that can be used to release multiple objects." }
3483 ],
3484 "returns": [
3485 { "name": "result", "$ref": "Runtime.RemoteObject", "description": "Evaluation result." }
3486 ]
3487 },
3488 {
3489 "name": "getHeapObjectId",
3490 "parameters": [
3491 { "name": "objectId", "$ref": "Runtime.RemoteObjectId", "description": "Identifier of the object to get heap object id for." }
3492 ],
3493 "returns": [
3494 { "name": "heapSnapshotObjectId", "$ref": "HeapSnapshotObjectId", "description": "Id of the heap snapshot object corresponding to the passed remote object id." }
3495 ]
3496 }
3497 ],
3498 "events": [
3499 {
3500 "name": "addProfileHeader",
3501 "parameters": [
3502 { "name": "header", "$ref": "ProfileHeader" }
3503 ]
3504 },
3505 {
3506 "name": "addHeapSnapshotChunk",
3507 "parameters": [
3508 { "name": "uid", "type": "integer" },
3509 { "name": "chunk", "type": "string" }
3510 ]
3511 },
3512 {
3513 "name": "finishHeapSnapshot",
3514 "parameters": [
3515 { "name": "uid", "type": "integer" }
3516 ]
3517 },
3518 {
3519 "name": "resetProfiles"
3520 },
3521 {
3522 "name": "reportHeapSnapshotProgress",
3523 "parameters": [
3524 { "name": "done", "type": "integer" },
3525 { "name": "total", "type": "integer" }
3526 ]
3527 },
3528 {
3529 "name": "lastSeenObjectId",
3530 "description": "If heap objects tracking has been started then backend regulary sends a current value for last seen object id and corresponding timestamp. If the were changes in the heap since last event then one or more heapStatsUpdate events will be sent before a new lastSeenObjectId event.",
3531 "parameters": [
3532 { "name": "lastSeenObjectId", "type": "integer" },
3533 { "name": "timestamp", "type": "number" }
3534 ]
3535 },
3536 {
3537 "name": "heapStatsUpdate",
3538 "description": "If heap objects tracking has been started then backend may send update for one or more fragments",
3539 "parameters": [
3540 { "name": "statsUpdate", "type": "array", "items": { "type": "integer" }, "description": "An array of triplets. Each triplet describes a fragment. The first integer is the fragment index, the second integer is a total count of objects for the fragment, the third integer is a total size of the objects for the fragment."}
3541 ]
3542 }
3543 ]
3544 },
3545 {
3546 "domain": "Worker",
3547 "hidden": true,
3548 "types": [],
3549 "commands": [
3550 {
3551 "name": "enable"
3552 },
3553 {
3554 "name": "disable"
3555 },
3556 {
3557 "name": "sendMessageToWorker",
3558 "parameters": [
3559 { "name": "workerId", "type": "integer" },
3560 { "name": "message", "type": "object" }
3561 ]
3562 },
3563 {
3564 "name": "canInspectWorkers",
3565 "description": "Tells whether browser supports workers inspection.",
3566 "returns": [
3567 { "name": "result", "type": "boolean", "description": "True if browser has workers support." }
3568 ]
3569 },
3570 {
3571 "name": "connectToWorker",
3572 "parameters": [
3573 { "name": "workerId", "type": "integer" }
3574 ]
3575 },
3576 {
3577 "name": "disconnectFromWorker",
3578 "parameters": [
3579 { "name": "workerId", "type": "integer" }
3580 ]
3581 },
3582 {
3583 "name": "setAutoconnectToWorkers",
3584 "parameters": [
3585 { "name": "value", "type": "boolean" }
3586 ]
3587 }
3588 ],
3589 "events": [
3590 {
3591 "name": "workerCreated",
3592 "parameters": [
3593 { "name": "workerId", "type": "integer" },
3594 { "name": "url", "type": "string" },
3595 { "name": "inspectorConnected", "type": "boolean" }
3596 ]
3597 },
3598 {
3599 "name": "workerTerminated",
3600 "parameters": [
3601 { "name": "workerId", "type": "integer" }
3602 ]
3603 },
3604 {
3605 "name": "dispatchMessageFromWorker",
3606 "parameters": [
3607 { "name": "workerId", "type": "integer" },
3608 { "name": "message", "type": "object" }
3609 ]
3610 },
3611 {
3612 "name": "disconnectedFromWorker"
3613 }
3614 ]
3615 },
3616 {
3617 "domain": "Canvas",
3618 "hidden": true,
3619 "types": [
3620 {
3621 "id": "ResourceId",
3622 "type": "string",
3623 "description": "Unique resource identifier."
3624 },
3625 {
3626 "id": "ResourceStateDescriptor",
3627 "type": "object",
3628 "description": "Resource state descriptor.",
3629 "properties": [
3630 { "name": "name", "type": "string", "description": "State name." },
3631 { "name": "enumValueForName", "type": "string", "optional": true, "description": "String representation of the enum value, if <code>name</code> stands for an enum." },
3632 { "name": "value", "$ref": "CallArgument", "optional": true, "description": "The value associated with the particular state." },
3633 { "name": "values", "type": "array", "items": { "$ref": "ResourceStateDescriptor" }, "optional": true, "description": "Array of values associated with the particular state. Either <code>value</code> or <code>values</code> will be specified." },
3634 { "name": "isArray", "type": "boolean", "optional": true, "description": "True iff the given <code>values</code> items stand for an array rather than a list of grouped states." }
3635 ]
3636 },
3637 {
3638 "id": "ResourceState",
3639 "type": "object",
3640 "description": "Resource state.",
3641 "properties": [
3642 { "name": "id", "$ref": "ResourceId" },
3643 { "name": "traceLogId", "$ref": "TraceLogId" },
3644 { "name": "descriptors", "type": "array", "items": { "$ref": "ResourceStateDescriptor" }, "optional": true, "description": "Describes current <code>Resource</code> state." },
3645 { "name": "imageURL", "type": "string", "optional": true, "description": "Screenshot image data URL." }
3646 ]
3647 },
3648 {
3649 "id": "CallArgument",
3650 "type": "object",
3651 "properties": [
3652 { "name": "description", "type": "string", "description": "String representation of the object." },
3653 { "name": "enumName", "type": "string", "optional": true, "description": "Enum name, if any, that stands for the value (for example, a WebGL enum name)." },
3654 { "name": "resourceId", "$ref": "ResourceId", "optional": true, "description": "Resource identifier. Specified for <code>Resource</code> objects only." },
3655 { "name": "type", "type": "string", "optional": true, "enum": ["object", "function", "undefined", "string", "number", "boolean"], "description": "Object type. Specified for non <code>Resource</code> objects only." },
3656 { "name": "subtype", "type": "string", "optional": true, "enum": ["array", "null", "node", "regexp", "date"], "description": "Object subtype hint. Specified for <code>object</code> type values only." },
3657 { "name": "remoteObject", "$ref": "Runtime.RemoteObject", "optional": true, "description": "The <code>RemoteObject</code>, if requested." }
3658 ]
3659 },
3660 {
3661 "id": "Call",
3662 "type": "object",
3663 "properties": [
3664 { "name": "contextId", "$ref": "ResourceId" },
3665 { "name": "functionName", "type": "string", "optional": true },
3666 { "name": "arguments", "type": "array", "items": { "$ref": "CallArgument" }, "optional": true },
3667 { "name": "result", "$ref": "CallArgument", "optional": true },
3668 { "name": "isDrawingCall", "type": "boolean", "optional": true },
3669 { "name": "isFrameEndCall", "type": "boolean", "optional": true },
3670 { "name": "property", "type": "string", "optional": true },
3671 { "name": "value", "$ref": "CallArgument", "optional": true },
3672 { "name": "sourceURL", "type": "string", "optional": true },
3673 { "name": "lineNumber", "type": "integer", "optional": true },
3674 { "name": "columnNumber", "type": "integer", "optional": true }
3675 ]
3676 },
3677 {
3678 "id": "TraceLogId",
3679 "type": "string",
3680 "description": "Unique trace log identifier."
3681 },
3682 {
3683 "id": "TraceLog",
3684 "type": "object",
3685 "properties": [
3686 { "name": "id", "$ref": "TraceLogId" },
3687 { "name": "calls", "type": "array", "items": { "$ref": "Call" } },
3688 { "name": "contexts", "type": "array", "items": { "$ref": "CallArgument" } },
3689 { "name": "startOffset", "type": "integer" },
3690 { "name": "alive", "type": "boolean" },
3691 { "name": "totalAvailableCalls", "type": "number" }
3692 ]
3693 }
3694 ],
3695 "commands": [
3696 {
3697 "name": "enable",
3698 "description": "Enables Canvas inspection."
3699 },
3700 {
3701 "name": "disable",
3702 "description": "Disables Canvas inspection."
3703 },
3704 {
3705 "name": "dropTraceLog",
3706 "parameters": [
3707 { "name": "traceLogId", "$ref": "TraceLogId" }
3708 ]
3709 },
3710 {
3711 "name": "hasUninstrumentedCanvases",
3712 "returns": [
3713 { "name": "result", "type": "boolean" }
3714 ],
3715 "description": "Checks if there is any uninstrumented canvas in the inspected page."
3716 },
3717 {
3718 "name": "captureFrame",
3719 "parameters": [
3720 { "name": "frameId", "$ref": "Page.FrameId", "optional": true, "description": "Identifier of the frame containing document whose canvases are to be captured. If omitted, main frame is assumed." }
3721 ],
3722 "returns": [
3723 { "name": "traceLogId", "$ref": "TraceLogId", "description": "Identifier of the trace log containing captured canvas calls." }
3724 ],
3725 "description": "Starts (or continues) a canvas frame capturing which will be stopped automatically after the next frame is prepared."
3726 },
3727 {
3728 "name": "startCapturing",
3729 "parameters": [
3730 { "name": "frameId", "$ref": "Page.FrameId", "optional": true, "description": "Identifier of the frame containing document whose canvases are to be captured. If omitted, main frame is assumed." }
3731 ],
3732 "returns": [
3733 { "name": "traceLogId", "$ref": "TraceLogId", "description": "Identifier of the trace log containing captured canvas calls." }
3734 ],
3735 "description": "Starts (or continues) consecutive canvas frames capturing. The capturing is stopped by the corresponding stopCapturing command."
3736 },
3737 {
3738 "name": "stopCapturing",
3739 "parameters": [
3740 { "name": "traceLogId", "$ref": "TraceLogId" }
3741 ]
3742 },
3743 {
3744 "name": "getTraceLog",
3745 "parameters": [
3746 { "name": "traceLogId", "$ref": "TraceLogId" },
3747 { "name": "startOffset", "type": "integer", "optional": true },
3748 { "name": "maxLength", "type": "integer", "optional": true }
3749 ],
3750 "returns": [
3751 { "name": "traceLog", "$ref": "TraceLog" }
3752 ]
3753 },
3754 {
3755 "name": "replayTraceLog",
3756 "parameters": [
3757 { "name": "traceLogId", "$ref": "TraceLogId" },
3758 { "name": "stepNo", "type": "integer", "description": "Last call index in the trace log to replay (zero based)." }
3759 ],
3760 "returns": [
3761 { "name": "resourceState", "$ref": "ResourceState" },
3762 { "name": "replayTime", "type": "number", "description": "Replay time (in milliseconds)." }
3763 ]
3764 },
3765 {
3766 "name": "getResourceState",
3767 "parameters": [
3768 { "name": "traceLogId", "$ref": "TraceLogId" },
3769 { "name": "resourceId", "$ref": "ResourceId" }
3770 ],
3771 "returns": [
3772 { "name": "resourceState", "$ref": "ResourceState" }
3773 ]
3774 },
3775 {
3776 "name": "evaluateTraceLogCallArgument",
3777 "parameters": [
3778 { "name": "traceLogId", "$ref": "TraceLogId" },
3779 { "name": "callIndex", "type": "integer", "description": "Index of the call to evaluate on (zero based)." },
3780 { "name": "argumentIndex", "type": "integer", "description": "Index of the argument to evaluate (zero based). Provide <code>-1</code> to evaluate call result." },
3781 { "name": "objectGroup", "type": "string", "optional": true, "description": "String object group name to put result into (allows rapid releasing resulting object handles using <code>Runtime.releaseObjectGroup</code>)." }
3782 ],
3783 "returns": [
3784 { "name": "result", "$ref": "Runtime.RemoteObject", "optional": true, "description": "Object wrapper for the evaluation result." },
3785 { "name": "resourceState", "$ref": "ResourceState", "optional": true, "description": "State of the <code>Resource</code> object." }
3786 ],
3787 "description": "Evaluates a given trace call argument or its result."
3788 }
3789 ],
3790 "events": [
3791 {
3792 "name": "contextCreated",
3793 "parameters": [
3794 { "name": "frameId", "$ref": "Page.FrameId", "description": "Identifier of the frame containing a canvas with a context." }
3795 ],
3796 "description": "Fired when a canvas context has been created in the given frame. The context may not be instrumented (see hasUninstrumentedCanvases command)."
3797 },
3798 {
3799 "name": "traceLogsRemoved",
3800 "parameters": [
3801 { "name": "frameId", "$ref": "Page.FrameId", "optional": true, "description": "If given, trace logs from the given frame were removed." },
3802 { "name": "traceLogId", "$ref": "TraceLogId", "optional": true, "description": "If given, trace log with the given ID was removed." }
3803 ],
3804 "description": "Fired when a set of trace logs were removed from the backend. If no parameters are given, all trace logs were removed."
3805 }
3806 ]
3807 },
3808 {
3809 "domain": "Input",
3810 "types": [
3811 {
3812 "id": "TouchPoint",
3813 "type": "object",
3814 "hidden": true,
3815 "properties": [
3816 { "name": "state", "type": "string", "enum": ["touchPressed", "touchReleased", "touchMoved", "touchStationary", "touchCancelled"], "description": "State of the touch point." },
3817 { "name": "x", "type": "integer", "description": "X coordinate of the event relative to the main frame's viewport."},
3818 { "name": "y", "type": "integer", "description": "Y coordinate of the event relative to the main frame's viewport. 0 refers to the top of the viewport and Y increases as it proceeds towards the bottom of the viewport."},
3819 { "name": "radiusX", "type": "integer", "optional": true, "description": "X radius of the touch area (default: 1)."},
3820 { "name": "radiusY", "type": "integer", "optional": true, "description": "Y radius of the touch area (default: 1)."},
3821 { "name": "rotationAngle", "type": "number", "optional": true, "description": "Rotation angle (default: 0.0)."},
3822 { "name": "force", "type": "number", "optional": true, "description": "Force (default: 1.0)."},
3823 { "name": "id", "type": "number", "optional": true, "description": "Identifier used to track touch sources between events, must be unique within an event."}
3824 ]
3825 }
3826 ],
3827 "commands": [
3828 {
3829 "name": "dispatchKeyEvent",
3830 "parameters": [
3831 { "name": "type", "type": "string", "enum": ["keyDown", "keyUp", "rawKeyDown", "char"], "description": "Type of the key event." },
3832 { "name": "modifiers", "type": "integer", "optional": true, "description": "Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8 (default: 0)." },
3833 { "name": "timestamp", "type": "number", "optional": true, "description": "Time at which the event occurred. Measured in UTC time in seconds since January 1, 1970 (default: current time)." },
3834 { "name": "text", "type": "string", "optional": true, "description": "Text as generated by processing a virtual key code with a keyboard layout. Not needed for for <code>keyUp</code> and <code>rawKeyDown</code> events (default: \"\")" },
3835 { "name": "unmodifiedText", "type": "string", "optional": true, "description": "Text that would have been generated by the keyboard if no modifiers were pressed (except for shift). Useful for shortcut (accelerator) key handling (default: \"\")." },
3836 { "name": "keyIdentifier", "type": "string", "optional": true, "description": "Unique key identifier (e.g., 'U+0041') (default: \"\")." },
3837 { "name": "windowsVirtualKeyCode", "type": "integer", "optional": true, "description": "Windows virtual key code (default: 0)." },
3838 { "name": "nativeVirtualKeyCode", "type": "integer", "optional": true, "description": "Native virtual key code (default: 0)." },
3839 { "name": "autoRepeat", "type": "boolean", "optional": true, "description": "Whether the event was generated from auto repeat (default: false)." },
3840 { "name": "isKeypad", "type": "boolean", "optional": true, "description": "Whether the event was generated from the keypad (default: false)." },
3841 { "name": "isSystemKey", "type": "boolean", "optional": true, "description": "Whether the event was a system key event (default: false)." }
3842 ],
3843 "description": "Dispatches a key event to the page."
3844 },
3845 {
3846 "name": "dispatchMouseEvent",
3847 "parameters": [
3848 { "name": "type", "type": "string", "enum": ["mousePressed", "mouseReleased", "mouseMoved"], "description": "Type of the mouse event." },
3849 { "name": "x", "type": "integer", "description": "X coordinate of the event relative to the main frame's viewport."},
3850 { "name": "y", "type": "integer", "description": "Y coordinate of the event relative to the main frame's viewport. 0 refers to the top of the viewport and Y increases as it proceeds towards the bottom of the viewport."},
3851 { "name": "modifiers", "type": "integer", "optional": true, "description": "Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8 (default: 0)." },
3852 { "name": "timestamp", "type": "number", "optional": true, "description": "Time at which the event occurred. Measured in UTC time in seconds since January 1, 1970 (default: current time)." },
3853 { "name": "button", "type": "string", "enum": ["none", "left", "middle", "right"], "optional": true, "description": "Mouse button (default: \"none\")." },
3854 { "name": "clickCount", "type": "integer", "optional": true, "description": "Number of times the mouse button was clicked (default: 0)." },
3855 { "name": "deviceSpace", "type": "boolean", "optional": true, "hidden": true, "description": "If true, x and y are given in dip wrt current viewport." }
3856 ],
3857 "description": "Dispatches a mouse event to the page."
3858 },
3859 {
3860 "name": "dispatchTouchEvent",
3861 "hidden": true,
3862 "parameters": [
3863 { "name": "type", "type": "string", "enum": ["touchStart", "touchEnd", "touchMove"], "description": "Type of the touch event." },
3864 { "name": "touchPoints", "type": "array", "items": { "$ref": "TouchPoint" }, "description": "Touch points." },
3865 { "name": "modifiers", "type": "integer", "optional": true, "description": "Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8 (default: 0)." },
3866 { "name": "timestamp", "type": "number", "optional": true, "description": "Time at which the event occurred. Measured in UTC time in seconds since January 1, 1970 (default: current time)." }
3867 ],
3868 "description": "Dispatches a touch event to the page."
3869 },
3870 {
3871 "name": "dispatchGestureEvent",
3872 "hidden": true,
3873 "parameters": [
3874 { "name": "type", "type": "string", "enum": ["scrollBegin", "scrollEnd", "scrollUpdate", "tapDown", "tap", "pinchBegin", "pinchEnd", "pinchUpdate"], "description": "Type of the gesture event." },
3875 { "name": "x", "type": "integer", "description": "X coordinate relative to the screen's viewport."},
3876 { "name": "y", "type": "integer", "description": "Y coordinate relative to the screen's viewport."},
3877 { "name": "timestamp", "type": "number", "optional": true, "description": "Time at which the event occurred. Measured in UTC time in seconds since January 1, 1970 (default: current time)." },
3878 { "name": "deltaX", "type": "integer", "optional": true, "description": "Delta X where apllies."},
3879 { "name": "deltaY", "type": "integer", "optional": true, "description": "Delta Y where apllies."},
3880 { "name": "pinchScale", "type": "number", "optional": true, "description": "Pinch scale." }
3881 ],
3882 "description": "Dispatches a gesture event to the page."
3883 }
3884 ],
3885 "events": []
3886 },
3887 {
3888 "domain": "LayerTree",
3889 "hidden": true,
3890 "types": [
3891 {
3892 "id": "LayerId",
3893 "type": "string",
3894 "description": "Unique Layer identifier."
3895 },
3896 {
3897 "id": "Layer",
3898 "type": "object",
3899 "description": "Information about a compositing layer.",
3900 "properties": [
3901 { "name": "layerId", "$ref": "LayerId", "description": "The unique id for this layer." },
3902 { "name": "parentLayerId", "$ref": "LayerId", "optional": true, "description": "The id of parent (not present for root)." },
3903 { "name": "nodeId", "$ref": "DOM.NodeId", "optional": true, "description": "The id for the node associated with this layer." },
3904 { "name": "offsetX", "type": "number", "description": "Offset from parent layer, X coordinate." },
3905 { "name": "offsetY", "type": "number", "description": "Offset from parent layer, X coordinate." },
3906 { "name": "width", "type": "number", "description": "Layer width." },
3907 { "name": "height", "type": "number", "description": "Layer height." },
3908 { "name": "transform", "type": "array", "items": { "type": "number" }, "minItems": 16, "maxItems": 16, "optional": true, "description": "Transformation matrix for layer, default is identity matrix" },
3909 { "name": "anchorX", "type": "number", "optional": true, "description": "Transform anchor point X, absent if no transform specified" },
3910 { "name": "anchorY", "type": "number", "optional": true, "description": "Transform anchor point Y, absent if no transform specified" },
3911 { "name": "anchorZ", "type": "number", "optional": true, "description": "Transform anchor point Z, absent if no transform specified" },
3912 { "name": "paintCount", "type": "integer", "description": "Indicates how many time this layer has painted." },
3913 { "name": "invisible", "type": "boolean", "optional": true, "description": "Set if layer is not visible." }
3914 ]
3915 }
3916 ],
3917 "commands": [
3918 {
3919 "name": "enable",
3920 "description": "Enables compositing tree inspection."
3921 },
3922 {
3923 "name": "disable",
3924 "description": "Disables compositing tree inspection."
3925 },
3926 {
3927 "name": "getLayers",
3928 "parameters": [
3929 { "name": "nodeId", "optional": true, "$ref": "DOM.NodeId", "description": "Root of the subtree for which we want to gather layers (return entire tree if not specified)" }
3930 ],
3931 "description": "Returns the layer tree structure of the current page.",
3932 "returns": [
3933 { "name": "layers", "type": "array", "items": { "$ref": "Layer" }, "description": "Child layers." }
3934 ]
3935 },
3936 {
3937 "name": "compositingReasons",
3938 "parameters": [
3939 { "name": "layerId", "$ref": "LayerId", "description": "The id of the layer for which we want to get the reasons it was composited." }
3940 ],
3941 "description": "Provides the reasons why the given layer was composited.",
3942 "returns": [
3943 { "name": "compositingReasons", "type": "array", "items": { "type": "string" }, "description": "A list of strings specifying reasons for the given layer to become composited." }
3944 ]
3945 }
3946 ],
3947 "events": [
3948 {
3949 "name": "layerTreeDidChange"
3950 }
3951 ]
3952 },
3953 {
3954 "domain": "Tracing",
3955 "hidden": true,
3956 "commands": [
3957 {
3958 "name": "start",
3959 "description": "Strart trace events collection.",
3960 "parameters": [
3961 { "name": "categories", "type": "string", "description": "Category/tag filter" }
3962 ]
3963 },
3964 {
3965 "name": "end",
3966 "description": "Stop trace events collection."
3967 }
3968 ],
3969 "events": [
3970 {
3971 "name": "dataCollected",
3972 "parameters": [
3973 { "name": "value", "type": "array", "items": { "type": "object" } }
3974 ]
3975 },
3976 {
3977 "name": "tracingComplete"
3978 }
3979 ]
3980 }]
3981 }