Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(542)

Side by Side Diff: third_party/WebKit/Source/devtools/protocol.json

Issue 2035653005: DevTools: split protocol.json into files per domain. (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master
Patch Set: Created 4 years, 6 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
OLDNEW
(Empty)
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 "handlers": ["browser"]
12 },
13 {
14 "name": "disable",
15 "description": "Disables inspector domain notifications.",
16 "handlers": ["browser"]
17 }
18 ],
19 "events": [
20 {
21 "name": "detached",
22 "description": "Fired when remote debugging connection is about to be terminated. Contains detach reason.",
23 "parameters": [
24 { "name": "reason", "type": "string", "description": "The re ason why connection has been terminated." }
25 ],
26 "handlers": ["browser"]
27 },
28 {
29 "name": "targetCrashed",
30 "description": "Fired when debugging target has crashed",
31 "handlers": ["browser"]
32 }
33 ]
34 },
35 {
36 "domain": "Memory",
37 "hidden": true,
38 "types": [
39 {
40 "id": "PressureLevel",
41 "type": "string",
42 "enum": ["moderate", "critical"],
43 "description": "Memory pressure level."
44 }
45 ],
46 "commands": [
47 {
48 "name": "getDOMCounters",
49 "returns": [
50 { "name": "documents", "type": "integer" },
51 { "name": "nodes", "type": "integer" },
52 { "name": "jsEventListeners", "type": "integer" }
53 ]
54 },
55 {
56 "name": "setPressureNotificationsSuppressed",
57 "description": "Enable/disable suppressing memory pressure notif ications in all processes.",
58 "parameters": [
59 { "name": "suppressed", "type": "boolean", "description": "I f true, memory pressure notifications will be suppressed."}
60 ],
61 "handlers": ["browser"]
62 },
63 {
64 "name": "simulatePressureNotification",
65 "description": "Simulate a memory pressure notification in all p rocesses.",
66 "parameters": [
67 { "name": "level", "$ref": "PressureLevel", "description": " Memory pressure level of the notification." }
68 ],
69 "handlers": ["browser"]
70 }
71 ]
72 },
73 {
74 "domain": "Page",
75 "description": "Actions and events related to the inspected page belong to the page domain.",
76 "dependencies": ["Debugger", "DOM"],
77 "types": [
78 {
79 "id": "ResourceType",
80 "type": "string",
81 "enum": ["Document", "Stylesheet", "Image", "Media", "Font", "Sc ript", "TextTrack", "XHR", "Fetch", "EventSource", "WebSocket", "Manifest", "Oth er"],
82 "description": "Resource type as it was perceived by the renderi ng engine."
83 },
84 {
85 "id": "FrameId",
86 "type": "string",
87 "description": "Unique frame identifier."
88 },
89 {
90 "id": "Frame",
91 "type": "object",
92 "description": "Information about the Frame on the page.",
93 "properties": [
94 { "name": "id", "type": "string", "description": "Frame uniq ue identifier." },
95 { "name": "parentId", "type": "string", "optional": true, "d escription": "Parent frame identifier." },
96 { "name": "loaderId", "$ref": "Network.LoaderId", "descripti on": "Identifier of the loader associated with this frame." },
97 { "name": "name", "type": "string", "optional": true, "descr iption": "Frame's name as specified in the tag." },
98 { "name": "url", "type": "string", "description": "Frame doc ument's URL." },
99 { "name": "securityOrigin", "type": "string", "description": "Frame document's security origin." },
100 { "name": "mimeType", "type": "string", "description": "Fram e document's mimeType as determined by the browser." }
101 ]
102 },
103 {
104 "id": "FrameResource",
105 "type": "object",
106 "description": "Information about the Resource on the page.",
107 "properties": [
108 { "name": "url", "type": "string", "description": "Resource URL." },
109 { "name": "type", "$ref": "ResourceType", "description": "Ty pe of this resource." },
110 { "name": "mimeType", "type": "string", "description": "Reso urce mimeType as determined by the browser." },
111 { "name": "failed", "type": "boolean", "optional": true, "de scription": "True if the resource failed to load." },
112 { "name": "canceled", "type": "boolean", "optional": true, " description": "True if the resource was canceled during loading." }
113 ],
114 "hidden": true
115 },
116 {
117 "id": "FrameResourceTree",
118 "type": "object",
119 "description": "Information about the Frame hierarchy along with their cached resources.",
120 "properties": [
121 { "name": "frame", "$ref": "Frame", "description": "Frame in formation for this tree item." },
122 { "name": "childFrames", "type": "array", "optional": true, "items": { "$ref": "FrameResourceTree" }, "description": "Child frames." },
123 { "name": "resources", "type": "array", "items": { "$ref": " FrameResource" }, "description": "Information about frame resources." }
124 ],
125 "hidden": true
126 },
127 {
128 "id": "ScriptIdentifier",
129 "type": "string",
130 "description": "Unique script identifier.",
131 "hidden": true
132 },
133 {
134 "id": "NavigationEntry",
135 "type": "object",
136 "description": "Navigation history entry.",
137 "properties": [
138 { "name": "id", "type": "integer", "description": "Unique id o f the navigation history entry." },
139 { "name": "url", "type": "string", "description": "URL of the navigation history entry." },
140 { "name": "title", "type": "string", "description": "Title of the navigation history entry." }
141 ],
142 "hidden": true
143 },
144 {
145 "id": "ScreencastFrameMetadata",
146 "type": "object",
147 "description": "Screencast frame metadata.",
148 "properties": [
149 { "name": "offsetTop", "type": "number", "hidden": true, "de scription": "Top offset in DIP." },
150 { "name": "pageScaleFactor", "type": "number", "hidden": tru e, "description": "Page scale factor." },
151 { "name": "deviceWidth", "type": "number", "hidden": true, " description": "Device screen width in DIP." },
152 { "name": "deviceHeight", "type": "number", "hidden": true, "description": "Device screen height in DIP." },
153 { "name": "scrollOffsetX", "type": "number", "hidden": true, "description": "Position of horizontal scroll in CSS pixels." },
154 { "name": "scrollOffsetY", "type": "number", "hidden": true, "description": "Position of vertical scroll in CSS pixels." },
155 { "name": "timestamp", "type": "number", "optional": true, " hidden": true, "description": "Frame swap timestamp." }
156 ],
157 "hidden": true
158 },
159 {
160 "id": "DialogType",
161 "description": "Javascript dialog type.",
162 "type": "string",
163 "enum": ["alert", "confirm", "prompt", "beforeunload"],
164 "hidden": true
165 },
166 {
167 "id": "AppManifestError",
168 "description": "Error while paring app manifest.",
169 "type": "object",
170 "properties": [
171 { "name": "message", "type": "string", "description": "Error m essage." },
172 { "name": "critical", "type": "integer", "description": "If cr iticial, this is a non-recoverable parse error." },
173 { "name": "line", "type": "integer", "description": "Error lin e." },
174 { "name": "column", "type": "integer", "description": "Error c olumn." }
175 ],
176 "hidden": true
177 }
178 ],
179 "commands": [
180 {
181 "name": "enable",
182 "description": "Enables page domain notifications.",
183 "handlers": ["browser", "renderer"]
184 },
185 {
186 "name": "disable",
187 "description": "Disables page domain notifications.",
188 "handlers": ["browser", "renderer"]
189 },
190 {
191 "name": "addScriptToEvaluateOnLoad",
192 "parameters": [
193 { "name": "scriptSource", "type": "string" }
194 ],
195 "returns": [
196 { "name": "identifier", "$ref": "ScriptIdentifier", "descrip tion": "Identifier of the added script." }
197 ],
198 "hidden": true
199 },
200 {
201 "name": "removeScriptToEvaluateOnLoad",
202 "parameters": [
203 { "name": "identifier", "$ref": "ScriptIdentifier" }
204 ],
205 "hidden": true
206 },
207 {
208 "name": "setAutoAttachToCreatedPages",
209 "parameters": [
210 { "name": "autoAttach", "type": "boolean", "description": "I f true, browser will open a new inspector window for every page created from thi s one." }
211 ],
212 "description": "Controls whether browser will open a new inspect or window for connected pages.",
213 "hidden": true
214 },
215 {
216 "name": "reload",
217 "parameters": [
218 { "name": "ignoreCache", "type": "boolean", "optional": true , "description": "If true, browser cache is ignored (as if the user pressed Shif t+refresh)." },
219 { "name": "scriptToEvaluateOnLoad", "type": "string", "optio nal": true, "description": "If set, the script will be injected into all frames of the inspected page after reload." }
220 ],
221 "description": "Reloads given page optionally ignoring the cache .",
222 "handlers": ["browser", "renderer"]
223 },
224 {
225 "name": "navigate",
226 "parameters": [
227 { "name": "url", "type": "string", "description": "URL to na vigate the page to." }
228 ],
229 "returns": [
230 { "name": "frameId", "$ref": "FrameId", "hidden": true, "des cription": "Frame id that will be navigated." }
231 ],
232 "description": "Navigates current page to the given URL.",
233 "handlers": ["browser", "renderer"]
234 },
235 {
236 "name": "getNavigationHistory",
237 "returns": [
238 { "name": "currentIndex", "type": "integer", "description": "Ind ex of the current navigation history entry." },
239 { "name": "entries", "type": "array", "items": { "$ref": "Naviga tionEntry" }, "description": "Array of navigation history entries." }
240 ],
241 "description": "Returns navigation history for the current page.",
242 "hidden": true,
243 "handlers": ["browser"]
244 },
245 {
246 "name": "navigateToHistoryEntry",
247 "parameters": [
248 { "name": "entryId", "type": "integer", "description": "Unique id of the entry to navigate to." }
249 ],
250 "description": "Navigates current page to the given history entry. ",
251 "hidden": true,
252 "handlers": ["browser"]
253 },
254 {
255 "name": "getCookies",
256 "returns": [
257 { "name": "cookies", "type": "array", "items": { "$ref": "Ne twork.Cookie" }, "description": "Array of cookie objects." }
258 ],
259 "description": "Returns all browser cookies. Depending on the ba ckend support, will return detailed cookie information in the <code>cookies</cod e> field.",
260 "handlers": ["browser"],
261 "async": true,
262 "hidden": true,
263 "redirect": "Network"
264 },
265 {
266 "name": "deleteCookie",
267 "parameters": [
268 { "name": "cookieName", "type": "string", "description": "Na me of the cookie to remove." },
269 { "name": "url", "type": "string", "description": "URL to ma tch cooke domain and path." }
270 ],
271 "description": "Deletes browser cookie with given name, domain a nd path.",
272 "handlers": ["browser"],
273 "async": true,
274 "hidden": true,
275 "redirect": "Network"
276 },
277 {
278 "name": "getResourceTree",
279 "description": "Returns present frame / resource tree structure. ",
280 "returns": [
281 { "name": "frameTree", "$ref": "FrameResourceTree", "descrip tion": "Present frame / resource tree structure." }
282 ],
283 "hidden": true
284 },
285 {
286 "name": "getResourceContent",
287 "async": true,
288 "description": "Returns content of the given resource.",
289 "parameters": [
290 { "name": "frameId", "$ref": "FrameId", "description": "Fram e id to get resource for." },
291 { "name": "url", "type": "string", "description": "URL of th e resource to get content for." }
292 ],
293 "returns": [
294 { "name": "content", "type": "string", "description": "Resou rce content." },
295 { "name": "base64Encoded", "type": "boolean", "description": "True, if content was served as base64." }
296 ],
297 "hidden": true
298 },
299 {
300 "name": "searchInResource",
301 "async": true,
302 "description": "Searches for given string in resource content.",
303 "parameters": [
304 { "name": "frameId", "$ref": "FrameId", "description": "Fram e id for resource to search in." },
305 { "name": "url", "type": "string", "description": "URL of th e resource to search in." },
306 { "name": "query", "type": "string", "description": "String to search for." },
307 { "name": "caseSensitive", "type": "boolean", "optional": tr ue, "description": "If true, search is case sensitive." },
308 { "name": "isRegex", "type": "boolean", "optional": true, "d escription": "If true, treats string parameter as regex." }
309 ],
310 "returns": [
311 { "name": "result", "type": "array", "items": { "$ref": "Deb ugger.SearchMatch" }, "description": "List of search matches." }
312 ],
313 "hidden": true
314 },
315 {
316 "name": "setDocumentContent",
317 "description": "Sets given markup as the document's HTML.",
318 "parameters": [
319 { "name": "frameId", "$ref": "FrameId", "description": "Fram e id to set HTML for." },
320 { "name": "html", "type": "string", "description": "HTML con tent to set." }
321 ],
322 "hidden": true
323 },
324 {
325 "name": "setDeviceMetricsOverride",
326 "description": "Overrides the values of device screen dimensions (window.screen.width, window.screen.height, window.innerWidth, window.innerHeig ht, and \"device-width\"/\"device-height\"-related CSS media query results).",
327 "parameters": [
328 { "name": "width", "type": "integer", "description": "Overri ding width value in pixels (minimum 0, maximum 10000000). 0 disables the overrid e." },
329 { "name": "height", "type": "integer", "description": "Overr iding height value in pixels (minimum 0, maximum 10000000). 0 disables the overr ide." },
330 { "name": "deviceScaleFactor", "type": "number", "descriptio n": "Overriding device scale factor value. 0 disables the override." },
331 { "name": "mobile", "type": "boolean", "description": "Wheth er to emulate mobile device. This includes viewport meta tag, overlay scrollbars , text autosizing and more." },
332 { "name": "fitWindow", "type": "boolean", "description": "Wh ether a view that exceeds the available browser window area should be scaled dow n to fit." },
333 { "name": "scale", "type": "number", "optional": true, "desc ription": "Scale to apply to resulting view image. Ignored in |fitWindow| mode." },
334 { "name": "offsetX", "type": "number", "optional": true, "de scription": "X offset to shift resulting view image by. Ignored in |fitWindow| m ode." },
335 { "name": "offsetY", "type": "number", "optional": true, "de scription": "Y offset to shift resulting view image by. Ignored in |fitWindow| m ode." },
336 { "name": "screenWidth", "type": "integer", "optional": true , "description": "Overriding screen width value in pixels (minimum 0, maximum 10 000000). Only used for |mobile==true|." },
337 { "name": "screenHeight", "type": "integer", "optional": tru e, "description": "Overriding screen height value in pixels (minimum 0, maximum 10000000). Only used for |mobile==true|." },
338 { "name": "positionX", "type": "integer", "optional": true, "description": "Overriding view X position on screen in pixels (minimum 0, maxim um 10000000). Only used for |mobile==true|." },
339 { "name": "positionY", "type": "integer", "optional": true, "description": "Overriding view Y position on screen in pixels (minimum 0, maxim um 10000000). Only used for |mobile==true|." },
340 { "name": "screenOrientation", "$ref": "Emulation.ScreenOrie ntation", "optional": true, "description": "Screen orientation override." }
341 ],
342 "handlers": ["browser"],
343 "redirect": "Emulation",
344 "hidden": true
345 },
346 {
347 "name": "clearDeviceMetricsOverride",
348 "description": "Clears the overriden device metrics.",
349 "handlers": ["browser"],
350 "redirect": "Emulation",
351 "hidden": true
352 },
353 {
354 "name": "setGeolocationOverride",
355 "description": "Overrides the Geolocation Position or Error. Omi tting any of the parameters emulates position unavailable.",
356 "parameters": [
357 { "name": "latitude", "type": "number", "optional": true, "d escription": "Mock latitude"},
358 { "name": "longitude", "type": "number", "optional": true, " description": "Mock longitude"},
359 { "name": "accuracy", "type": "number", "optional": true, "d escription": "Mock accuracy"}
360 ],
361 "redirect": "Emulation",
362 "handlers": ["browser"]
363 },
364 {
365 "name": "clearGeolocationOverride",
366 "description": "Clears the overriden Geolocation Position and Er ror.",
367 "redirect": "Emulation",
368 "handlers": ["browser"]
369 },
370 {
371 "name": "setDeviceOrientationOverride",
372 "description": "Overrides the Device Orientation.",
373 "parameters": [
374 { "name": "alpha", "type": "number", "description": "Mock al pha"},
375 { "name": "beta", "type": "number", "description": "Mock bet a"},
376 { "name": "gamma", "type": "number", "description": "Mock ga mma"}
377 ],
378 "redirect": "DeviceOrientation",
379 "hidden": true
380 },
381 {
382 "name": "clearDeviceOrientationOverride",
383 "description": "Clears the overridden Device Orientation.",
384 "redirect": "DeviceOrientation",
385 "hidden": true
386 },
387 {
388 "name": "setTouchEmulationEnabled",
389 "parameters": [
390 { "name": "enabled", "type": "boolean", "description": "Whet her the touch event emulation should be enabled." },
391 { "name": "configuration", "type": "string", "enum": ["mobil e", "desktop"], "optional": true, "description": "Touch/gesture events configura tion. Default: current platform." }
392 ],
393 "description": "Toggles mouse event-based touch event emulation. ",
394 "hidden": true,
395 "redirect": "Emulation",
396 "handlers": ["browser", "renderer"]
397 },
398 {
399 "name": "captureScreenshot",
400 "async": true,
401 "description": "Capture page screenshot.",
402 "returns": [
403 { "name": "data", "type": "string", "description": "Base64-e ncoded image data (PNG)." }
404 ],
405 "hidden": true,
406 "handlers": ["browser"]
407 },
408 {
409 "name": "startScreencast",
410 "description": "Starts sending each frame using the <code>screen castFrame</code> event.",
411 "parameters": [
412 { "name": "format", "type": "string", "optional": true, "enu m": ["jpeg", "png"], "description": "Image compression format." },
413 { "name": "quality", "type": "integer", "optional": true, "d escription": "Compression quality from range [0..100]." },
414 { "name": "maxWidth", "type": "integer", "optional": true, " description": "Maximum screenshot width." },
415 { "name": "maxHeight", "type": "integer", "optional": true, "description": "Maximum screenshot height." },
416 { "name": "everyNthFrame", "type": "integer", "optional": tr ue, "description": "Send every n-th frame." }
417 ],
418 "hidden": true,
419 "handlers": ["browser", "renderer"]
420 },
421 {
422 "name": "stopScreencast",
423 "description": "Stops sending each frame in the <code>screencast Frame</code>.",
424 "hidden": true,
425 "handlers": ["browser", "renderer"]
426 },
427 {
428 "name": "screencastFrameAck",
429 "description": "Acknowledges that a screencast frame has been re ceived by the frontend.",
430 "parameters": [
431 { "name": "sessionId", "type": "integer", "description": "Fr ame number." }
432 ],
433 "hidden": true,
434 "handlers": ["browser"]
435 },
436 {
437 "name": "handleJavaScriptDialog",
438 "description": "Accepts or dismisses a JavaScript initiated dial og (alert, confirm, prompt, or onbeforeunload).",
439 "parameters": [
440 { "name": "accept", "type": "boolean", "description": "Wheth er to accept or dismiss the dialog." },
441 { "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." }
442 ],
443 "hidden": true,
444 "handlers": ["browser"]
445 },
446 {
447 "name": "setColorPickerEnabled",
448 "parameters": [
449 { "name": "enabled", "type": "boolean", "description": "Show s / hides color picker" }
450 ],
451 "description": "Shows / hides color picker",
452 "hidden": true,
453 "handlers": ["browser"]
454 },
455 {
456 "name": "setOverlayMessage",
457 "parameters": [
458 { "name": "message", "type": "string", "optional": true, "de scription": "Overlay message to display when paused in debugger." }
459 ],
460 "hidden": true,
461 "description": "Sets overlay message."
462 },
463 {
464 "name": "getAppManifest",
465 "hidden": true,
466 "returns": [
467 { "name": "url", "type": "string", "description": "Manifest location." },
468 { "name": "errors", "type": "array", "items": { "$ref": "App ManifestError" } },
469 { "name": "data", "type": "string", "optional": true, "descr iption": "Manifest content." }
470 ],
471 "handlers": ["none"]
472 },
473 {
474 "name": "requestAppBanner",
475 "hidden": true,
476 "handlers": ["browser"]
477 },
478 {
479 "name": "setBlockedEventsWarningThreshold",
480 "hidden": true,
481 "parameters": [
482 { "name": "threshold", "type": "number", "description": "If set to a positive number, specifies threshold in seconds for input event latency that will cause a console warning about blocked event to be issued. If zero or less, the warning is disabled." }
483 ]
484 }
485 ],
486 "events": [
487 {
488 "name": "domContentEventFired",
489 "parameters": [
490 { "name": "timestamp", "type": "number" }
491 ]
492 },
493 {
494 "name": "loadEventFired",
495 "parameters": [
496 { "name": "timestamp", "type": "number" }
497 ]
498 },
499 {
500 "name": "frameAttached",
501 "description": "Fired when frame has been attached to its parent .",
502 "parameters": [
503 { "name": "frameId", "$ref": "FrameId", "description": "Id o f the frame that has been attached." },
504 { "name": "parentFrameId", "$ref": "FrameId", "description": "Parent frame identifier." }
505 ]
506 },
507 {
508 "name": "frameNavigated",
509 "description": "Fired once navigation of the frame has completed . Frame is now associated with the new loader.",
510 "parameters": [
511 { "name": "frame", "$ref": "Frame", "description": "Frame ob ject." }
512 ]
513 },
514 {
515 "name": "frameDetached",
516 "description": "Fired when frame has been detached from its pare nt.",
517 "parameters": [
518 { "name": "frameId", "$ref": "FrameId", "description": "Id o f the frame that has been detached." }
519 ]
520 },
521 {
522 "name": "frameStartedLoading",
523 "description": "Fired when frame has started loading.",
524 "parameters": [
525 { "name": "frameId", "$ref": "FrameId", "description": "Id o f the frame that has started loading." }
526 ],
527 "hidden": true
528 },
529 {
530 "name": "frameStoppedLoading",
531 "description": "Fired when frame has stopped loading.",
532 "parameters": [
533 { "name": "frameId", "$ref": "FrameId", "description": "Id o f the frame that has stopped loading." }
534 ],
535 "hidden": true
536 },
537 {
538 "name": "frameScheduledNavigation",
539 "description": "Fired when frame schedules a potential navigatio n.",
540 "parameters": [
541 { "name": "frameId", "$ref": "FrameId", "description": "Id o f the frame that has scheduled a navigation." },
542 { "name": "delay", "type": "number", "description": "Delay ( in seconds) until the navigation is scheduled to begin. The navigation is not gu aranteed to start." }
543 ],
544 "hidden": true
545 },
546 {
547 "name": "frameClearedScheduledNavigation",
548 "description": "Fired when frame no longer has a scheduled navig ation.",
549 "parameters": [
550 { "name": "frameId", "$ref": "FrameId", "description": "Id o f the frame that has cleared its scheduled navigation." }
551 ],
552 "hidden": true
553 },
554 {
555 "name": "frameResized",
556 "hidden": true
557 },
558 {
559 "name": "javascriptDialogOpening",
560 "description": "Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) is about to open.",
561 "parameters": [
562 { "name": "message", "type": "string", "description": "Messa ge that will be displayed by the dialog." },
563 { "name": "type", "$ref": "DialogType", "description": "Dial og type." }
564 ],
565 "hidden": true
566 },
567 {
568 "name": "javascriptDialogClosed",
569 "description": "Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) has been closed.",
570 "parameters": [
571 { "name": "result", "type": "boolean", "description": "Wheth er dialog was confirmed." }
572 ],
573 "hidden": true
574 },
575 {
576 "name": "screencastFrame",
577 "description": "Compressed image data requested by the <code>sta rtScreencast</code>.",
578 "parameters": [
579 { "name": "data", "type": "string", "description": "Base64-e ncoded compressed image." },
580 { "name": "metadata", "$ref": "ScreencastFrameMetadata", "de scription": "Screencast frame metadata."},
581 { "name": "sessionId", "type": "integer", "description": "Fr ame number."}
582 ],
583 "hidden": true,
584 "handlers": ["browser"]
585 },
586 {
587 "name": "screencastVisibilityChanged",
588 "description": "Fired when the page with currently enabled scree ncast was shown or hidden </code>.",
589 "parameters": [
590 { "name": "visible", "type": "boolean", "description": "True if the page is visible." }
591 ],
592 "hidden": true,
593 "handlers": ["browser"]
594 },
595 {
596 "name": "colorPicked",
597 "description": "Fired when a color has been picked.",
598 "parameters": [
599 { "name": "color", "$ref": "DOM.RGBA", "description": "RGBA of the picked color." }
600 ],
601 "hidden": true,
602 "handlers": ["browser"]
603 },
604 {
605 "name": "interstitialShown",
606 "description": "Fired when interstitial page was shown",
607 "hidden": true,
608 "handlers": ["browser"]
609 },
610 {
611 "name": "interstitialHidden",
612 "description": "Fired when interstitial page was hidden",
613 "hidden": true,
614 "handlers": ["browser"]
615 }
616 ]
617 },
618 {
619 "domain": "Rendering",
620 "description": "This domain allows to control rendering of the page.",
621 "hidden": true,
622 "commands": [
623 {
624 "name": "setShowPaintRects",
625 "description": "Requests that backend shows paint rectangles",
626 "parameters": [
627 { "name": "result", "type": "boolean", "description": "True for showing paint rectangles" }
628 ]
629 },
630 {
631 "name": "setShowDebugBorders",
632 "description": "Requests that backend shows debug borders on lay ers",
633 "parameters": [
634 { "name": "show", "type": "boolean", "description": "True fo r showing debug borders" }
635 ]
636 },
637 {
638 "name": "setShowFPSCounter",
639 "description": "Requests that backend shows the FPS counter",
640 "parameters": [
641 { "name": "show", "type": "boolean", "description": "True fo r showing the FPS counter" }
642 ]
643 },
644 {
645 "name": "setShowScrollBottleneckRects",
646 "description": "Requests that backend shows scroll bottleneck re cts",
647 "parameters": [
648 { "name": "show", "type": "boolean", "description": "True fo r showing scroll bottleneck rects" }
649 ]
650 },
651 {
652 "name": "setShowViewportSizeOnResize",
653 "description": "Paints viewport size upon main frame resize.",
654 "parameters": [
655 { "name": "show", "type": "boolean", "description": "Whether to paint size or not." }
656 ]
657 }
658 ]
659 },
660 {
661 "domain": "Emulation",
662 "description": "This domain emulates different environments for the page .",
663 "hidden": true,
664 "types": [
665 {
666 "id": "ScreenOrientation",
667 "type": "object",
668 "description": "Screen orientation.",
669 "properties": [
670 { "name": "type", "type": "string", "enum": ["portraitPrima ry", "portraitSecondary", "landscapePrimary", "landscapeSecondary"], "descriptio n": "Orientation type." },
671 { "name": "angle", "type": "integer", "description": "Orien tation angle." }
672 ]
673 }
674 ],
675 "commands": [
676 {
677 "name": "setDeviceMetricsOverride",
678 "description": "Overrides the values of device screen dimensions (window.screen.width, window.screen.height, window.innerWidth, window.innerHeig ht, and \"device-width\"/\"device-height\"-related CSS media query results).",
679 "parameters": [
680 { "name": "width", "type": "integer", "description": "Overri ding width value in pixels (minimum 0, maximum 10000000). 0 disables the overrid e." },
681 { "name": "height", "type": "integer", "description": "Overr iding height value in pixels (minimum 0, maximum 10000000). 0 disables the overr ide." },
682 { "name": "deviceScaleFactor", "type": "number", "descriptio n": "Overriding device scale factor value. 0 disables the override." },
683 { "name": "mobile", "type": "boolean", "description": "Wheth er to emulate mobile device. This includes viewport meta tag, overlay scrollbars , text autosizing and more." },
684 { "name": "fitWindow", "type": "boolean", "description": "Wh ether a view that exceeds the available browser window area should be scaled dow n to fit." },
685 { "name": "scale", "type": "number", "optional": true, "desc ription": "Scale to apply to resulting view image. Ignored in |fitWindow| mode." },
686 { "name": "offsetX", "type": "number", "optional": true, "de scription": "X offset to shift resulting view image by. Ignored in |fitWindow| m ode." },
687 { "name": "offsetY", "type": "number", "optional": true, "de scription": "Y offset to shift resulting view image by. Ignored in |fitWindow| m ode." },
688 { "name": "screenWidth", "type": "integer", "optional": true , "description": "Overriding screen width value in pixels (minimum 0, maximum 10 000000). Only used for |mobile==true|." },
689 { "name": "screenHeight", "type": "integer", "optional": tru e, "description": "Overriding screen height value in pixels (minimum 0, maximum 10000000). Only used for |mobile==true|." },
690 { "name": "positionX", "type": "integer", "optional": true, "description": "Overriding view X position on screen in pixels (minimum 0, maxim um 10000000). Only used for |mobile==true|." },
691 { "name": "positionY", "type": "integer", "optional": true, "description": "Overriding view Y position on screen in pixels (minimum 0, maxim um 10000000). Only used for |mobile==true|." },
692 { "name": "screenOrientation", "$ref": "ScreenOrientation", "optional": true, "description": "Screen orientation override." }
693 ],
694 "handlers": ["browser"]
695 },
696 {
697 "name": "clearDeviceMetricsOverride",
698 "description": "Clears the overriden device metrics.",
699 "handlers": ["browser"]
700 },
701 {
702 "name": "resetPageScaleFactor",
703 "description": "Requests that page scale factor is reset to init ial values."
704 },
705 {
706 "name": "setPageScaleFactor",
707 "description": "Sets a specified page scale factor.",
708 "parameters": [
709 { "name": "pageScaleFactor", "type": "number", "description" : "Page scale factor." }
710 ]
711 },
712 {
713 "name": "setScriptExecutionDisabled",
714 "description": "Switches script execution in the page.",
715 "parameters": [
716 { "name": "value", "type": "boolean", "description": "Whethe r script execution should be disabled in the page." }
717 ]
718 },
719 {
720 "name": "setGeolocationOverride",
721 "description": "Overrides the Geolocation Position or Error. Omi tting any of the parameters emulates position unavailable.",
722 "parameters": [
723 { "name": "latitude", "type": "number", "optional": true, "d escription": "Mock latitude"},
724 { "name": "longitude", "type": "number", "optional": true, " description": "Mock longitude"},
725 { "name": "accuracy", "type": "number", "optional": true, "d escription": "Mock accuracy"}
726 ],
727 "handlers": ["browser"]
728 },
729 {
730 "name": "clearGeolocationOverride",
731 "description": "Clears the overriden Geolocation Position and Er ror.",
732 "handlers": ["browser"]
733 },
734 {
735 "name": "setTouchEmulationEnabled",
736 "parameters": [
737 { "name": "enabled", "type": "boolean", "description": "Whet her the touch event emulation should be enabled." },
738 { "name": "configuration", "type": "string", "enum": ["mobil e", "desktop"], "optional": true, "description": "Touch/gesture events configura tion. Default: current platform." }
739 ],
740 "description": "Toggles mouse event-based touch event emulation. ",
741 "handlers": ["browser", "renderer"]
742 },
743 {
744 "name": "setEmulatedMedia",
745 "parameters": [
746 { "name": "media", "type": "string", "description": "Media t ype to emulate. Empty string disables the override." }
747 ],
748 "description": "Emulates the given media for CSS media queries."
749 },
750 {
751 "name": "setCPUThrottlingRate",
752 "parameters": [
753 { "name": "rate", "type": "number", "description": "Throttli ng rate as a slowdown factor (1 is no throttle, 2 is 2x slowdown, etc)." }
754 ],
755 "description": "Enables CPU throttling to emulate slow CPUs."
756 },
757 {
758 "name": "canEmulate",
759 "description": "Tells whether emulation is supported.",
760 "returns": [
761 { "name": "result", "type": "boolean", "description": "True if emulation is supported." }
762 ],
763 "handlers": ["browser"]
764 }
765 ]
766 },
767 {
768 "domain": "Runtime",
769 "description": "Runtime domain exposes JavaScript runtime by means of re mote evaluation and mirror objects. Evaluation results are returned as mirror ob ject that expose object type, string representation and unique identifier that c an be used for further object reference. Original objects are maintained in memo ry unless they are either explicitly released or are released along with the oth er objects in their object group.",
770 "types": [
771 {
772 "id": "ScriptId",
773 "type": "string",
774 "description": "Unique script identifier."
775 },
776 {
777 "id": "RemoteObjectId",
778 "type": "string",
779 "description": "Unique object identifier."
780 },
781 {
782 "id": "RemoteObject",
783 "type": "object",
784 "description": "Mirror object referencing original JavaScript ob ject.",
785 "properties": [
786 { "name": "type", "type": "string", "enum": ["object", "func tion", "undefined", "string", "number", "boolean", "symbol"], "description": "Ob ject type." },
787 { "name": "subtype", "type": "string", "optional": true, "en um": ["array", "null", "node", "regexp", "date", "map", "set", "iterator", "gene rator", "error"], "description": "Object subtype hint. Specified for <code>objec t</code> type values only." },
788 { "name": "className", "type": "string", "optional": true, " description": "Object class (constructor) name. Specified for <code>object</code > type values only." },
789 { "name": "value", "type": "any", "optional": true, "descrip tion": "Remote object value in case of primitive values or JSON values (if it wa s requested), or description string if the value can not be JSON-stringified (li ke NaN, Infinity, -Infinity, -0)." },
790 { "name": "description", "type": "string", "optional": true, "description": "String representation of the object." },
791 { "name": "objectId", "$ref": "RemoteObjectId", "optional": true, "description": "Unique object identifier (for non-primitive values)." },
792 { "name": "preview", "$ref": "ObjectPreview", "optional": tr ue, "description": "Preview containing abbreviated property values. Specified fo r <code>object</code> type values only.", "hidden": true },
793 { "name": "customPreview", "$ref": "CustomPreview", "optiona l": true, "hidden": true}
794 ]
795 },
796 {
797 "id": "CustomPreview",
798 "type": "object",
799 "hidden": true,
800 "properties": [
801 { "name": "header", "type": "string"},
802 { "name": "hasBody", "type": "boolean"},
803 { "name": "formatterObjectId", "$ref": "RemoteObjectId"},
804 { "name": "bindRemoteObjectFunctionId", "$ref": "RemoteObjec tId" },
805 { "name": "configObjectId", "$ref": "RemoteObjectId", "optio nal": true }
806 ]
807 },
808 {
809 "id": "ObjectPreview",
810 "type": "object",
811 "hidden": true,
812 "description": "Object containing abbreviated remote object valu e.",
813 "properties": [
814 { "name": "type", "type": "string", "enum": ["object", "func tion", "undefined", "string", "number", "boolean", "symbol"], "description": "Ob ject type." },
815 { "name": "subtype", "type": "string", "optional": true, "en um": ["array", "null", "node", "regexp", "date", "map", "set", "iterator", "gene rator", "error"], "description": "Object subtype hint. Specified for <code>objec t</code> type values only." },
816 { "name": "description", "type": "string", "optional": true, "description": "String representation of the object." },
817 { "name": "overflow", "type": "boolean", "description": "Tru e iff some of the properties or entries of the original object did not fit." },
818 { "name": "properties", "type": "array", "items": { "$ref": "PropertyPreview" }, "description": "List of the properties." },
819 { "name": "entries", "type": "array", "items": { "$ref": "En tryPreview" }, "optional": true, "description": "List of the entries. Specified for <code>map</code> and <code>set</code> subtype values only." }
820 ]
821 },
822 {
823 "id": "PropertyPreview",
824 "type": "object",
825 "hidden": true,
826 "properties": [
827 { "name": "name", "type": "string", "description": "Property name." },
828 { "name": "type", "type": "string", "enum": ["object", "func tion", "undefined", "string", "number", "boolean", "symbol", "accessor"], "descr iption": "Object type. Accessor means that the property itself is an accessor pr operty." },
829 { "name": "value", "type": "string", "optional": true, "desc ription": "User-friendly property value string." },
830 { "name": "valuePreview", "$ref": "ObjectPreview", "optional ": true, "description": "Nested value preview." },
831 { "name": "subtype", "type": "string", "optional": true, "en um": ["array", "null", "node", "regexp", "date", "map", "set", "iterator", "gene rator", "error"], "description": "Object subtype hint. Specified for <code>objec t</code> type values only." }
832 ]
833 },
834 {
835 "id": "EntryPreview",
836 "type": "object",
837 "hidden": true,
838 "properties": [
839 { "name": "key", "$ref": "ObjectPreview", "optional": true, "description": "Preview of the key. Specified for map-like collection entries." },
840 { "name": "value", "$ref": "ObjectPreview", "description": " Preview of the value." }
841 ]
842 },
843 {
844 "id": "PropertyDescriptor",
845 "type": "object",
846 "description": "Object property descriptor.",
847 "properties": [
848 { "name": "name", "type": "string", "description": "Property name or symbol description." },
849 { "name": "value", "$ref": "RemoteObject", "optional": true, "description": "The value associated with the property." },
850 { "name": "writable", "type": "boolean", "optional": true, " description": "True if the value associated with the property may be changed (da ta descriptors only)." },
851 { "name": "get", "$ref": "RemoteObject", "optional": true, " description": "A function which serves as a getter for the property, or <code>un defined</code> if there is no getter (accessor descriptors only)." },
852 { "name": "set", "$ref": "RemoteObject", "optional": true, " description": "A function which serves as a setter for the property, or <code>un defined</code> if there is no setter (accessor descriptors only)." },
853 { "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." },
854 { "name": "enumerable", "type": "boolean", "description": "T rue if this property shows up during enumeration of the properties on the corres ponding object." },
855 { "name": "wasThrown", "type": "boolean", "optional": true, "description": "True if the result was thrown during the evaluation." },
856 { "name": "isOwn", "optional": true, "type": "boolean", "des cription": "True if the property is owned for the object.", "hidden": true },
857 { "name": "symbol", "$ref": "RemoteObject", "optional": true , "description": "Property symbol object, if the property is of the <code>symbol </code> type.", "hidden": true }
858 ]
859 },
860 {
861 "id": "InternalPropertyDescriptor",
862 "type": "object",
863 "description": "Object internal property descriptor. This proper ty isn't normally visible in JavaScript code.",
864 "properties": [
865 { "name": "name", "type": "string", "description": "Conventi onal property name." },
866 { "name": "value", "$ref": "RemoteObject", "optional": true, "description": "The value associated with the property." }
867 ],
868 "hidden": true
869 },
870 {
871 "id": "CallArgument",
872 "type": "object",
873 "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.",
874 "properties": [
875 { "name": "value", "type": "any", "optional": true, "descrip tion": "Primitive value, or description string if the value can not be JSON-stri ngified (like NaN, Infinity, -Infinity, -0)." },
876 { "name": "objectId", "$ref": "RemoteObjectId", "optional": true, "description": "Remote object handle." },
877 { "name": "type", "optional": true, "hidden": true, "type": "string", "enum": ["object", "function", "undefined", "string", "number", "boole an", "symbol"], "description": "Object type." }
878 ]
879 },
880 {
881 "id": "ExecutionContextId",
882 "type": "integer",
883 "description": "Id of an execution context."
884 },
885 {
886 "id": "ExecutionContextDescription",
887 "type": "object",
888 "description": "Description of an isolated world.",
889 "properties": [
890 { "name": "id", "$ref": "ExecutionContextId", "description": "Unique id of the execution context. It can be used to specify in which executi on context script evaluation should be performed." },
891 { "name": "isDefault", "type": "boolean", "description": "Wh ether context is the default page context (as opposite to e.g. context of conten t script).", "hidden": true },
892 { "name": "origin", "type": "string", "description": "Execut ion context origin.", "hidden": true},
893 { "name": "name", "type": "string", "description": "Human re adable name describing given context.", "hidden": true},
894 { "name": "frameId", "type": "string", "description": "Id of the owning frame. May be an empty string if the context is not associated with a frame." }
895 ]
896 },
897 {
898 "id": "ExceptionDetails",
899 "type": "object",
900 "description": "Detailed information on exception (or error) tha t was thrown during script compilation or execution.",
901 "properties": [
902 { "name": "text", "type": "string", "description": "Exceptio n text." },
903 { "name": "url", "type": "string", "optional": true, "descri ption": "URL of the message origin." },
904 { "name": "scriptId", "type": "string", "optional": true, "d escription": "Script ID of the message origin." },
905 { "name": "line", "type": "integer", "optional": true, "desc ription": "Line number in the resource that generated this message." },
906 { "name": "column", "type": "integer", "optional": true, "de scription": "Column number in the resource that generated this message." },
907 { "name": "stack", "$ref": "StackTrace", "optional": true, " description": "JavaScript stack trace for assertions and error messages." }
908 ]
909 },
910 {
911 "id": "CallFrame",
912 "type": "object",
913 "description": "Stack entry for runtime errors and assertions.",
914 "properties": [
915 { "name": "functionName", "type": "string", "description": " JavaScript function name." },
916 { "name": "scriptId", "$ref": "ScriptId", "description": "Ja vaScript script id." },
917 { "name": "url", "type": "string", "description": "JavaScrip t script name or url." },
918 { "name": "lineNumber", "type": "integer", "description": "J avaScript script line number." },
919 { "name": "columnNumber", "type": "integer", "description": "JavaScript script column number." }
920 ]
921 },
922 {
923 "id": "StackTrace",
924 "type": "object",
925 "description": "Call frames for assertions or error messages.",
926 "properties": [
927 { "name": "description", "type": "string", "optional": true, "description": "String label of this stack trace. For async traces this may be a name of the function that initiated the async call." },
928 { "name": "callFrames", "type": "array", "items": { "$ref": "CallFrame" }, "description": "JavaScript function name." },
929 { "name": "parent", "$ref": "StackTrace", "optional": true, "hidden": true, "hidden": true, "description": "Asynchronous JavaScript stack tr ace that preceded this stack, if available." }
930 ]
931 }
932 ],
933 "commands": [
934 {
935 "name": "evaluate",
936 "parameters": [
937 { "name": "expression", "type": "string", "description": "Ex pression to evaluate." },
938 { "name": "objectGroup", "type": "string", "optional": true, "description": "Symbolic group name that can be used to release multiple object s." },
939 { "name": "includeCommandLineAPI", "type": "boolean", "optio nal": true, "description": "Determines whether Command Line API should be availa ble during the evaluation.", "hidden": true },
940 { "name": "doNotPauseOnExceptionsAndMuteConsole", "type": "b oolean", "optional": true, "description": "Specifies whether evaluation should s top on exceptions and mute console. Overrides setPauseOnException state.", "hidd en": true },
941 { "name": "contextId", "$ref": "ExecutionContextId", "option al": true, "description": "Specifies in which isolated context to perform evalua tion. 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 eva luation will be performed in the context of the inspected page." },
942 { "name": "returnByValue", "type": "boolean", "optional": tr ue, "description": "Whether the result is expected to be a JSON object that shou ld be sent by value." },
943 { "name": "generatePreview", "type": "boolean", "optional": true, "hidden": true, "description": "Whether preview should be generated for th e result." },
944 { "name": "userGesture", "type": "boolean", "optional": true , "hidden": true, "description": "Whether execution should be treated as initiat ed by user in the UI." }
945 ],
946 "returns": [
947 { "name": "result", "$ref": "RemoteObject", "description": " Evaluation result." },
948 { "name": "wasThrown", "type": "boolean", "optional": true, "description": "True if the result was thrown during the evaluation." },
949 { "name": "exceptionDetails", "$ref": "ExceptionDetails", "o ptional": true, "hidden": true, "description": "Exception details."}
950 ],
951 "description": "Evaluates expression on global object."
952 },
953 {
954 "name": "callFunctionOn",
955 "parameters": [
956 { "name": "objectId", "$ref": "RemoteObjectId", "description ": "Identifier of the object to call function on." },
957 { "name": "functionDeclaration", "type": "string", "descript ion": "Declaration of the function to call." },
958 { "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." },
959 { "name": "doNotPauseOnExceptionsAndMuteConsole", "type": "b oolean", "optional": true, "description": "Specifies whether function call shoul d stop on exceptions and mute console. Overrides setPauseOnException state.", "h idden": true },
960 { "name": "returnByValue", "type": "boolean", "optional": tr ue, "description": "Whether the result is expected to be a JSON object which sho uld be sent by value." },
961 { "name": "generatePreview", "type": "boolean", "optional": true, "hidden": true, "description": "Whether preview should be generated for th e result." },
962 { "name": "userGesture", "type": "boolean", "optional": true , "hidden": true, "description": "Whether execution should be treated as initiat ed by user in the UI." }
963 ],
964 "returns": [
965 { "name": "result", "$ref": "RemoteObject", "description": " Call result." },
966 { "name": "wasThrown", "type": "boolean", "optional": true, "description": "True if the result was thrown during the evaluation." }
967 ],
968 "description": "Calls function with given declaration on the giv en object. Object group of the result is inherited from the target object."
969 },
970 {
971 "name": "getProperties",
972 "parameters": [
973 { "name": "objectId", "$ref": "RemoteObjectId", "description ": "Identifier of the object to return properties for." },
974 { "name": "ownProperties", "optional": true, "type": "boolea n", "description": "If true, returns properties belonging only to the element it self, not to its prototype chain." },
975 { "name": "accessorPropertiesOnly", "optional": true, "type" : "boolean", "description": "If true, returns accessor properties (with getter/s etter) only; internal properties are not returned either.", "hidden": true },
976 { "name": "generatePreview", "type": "boolean", "optional": true, "hidden": true, "description": "Whether preview should be generated for th e results." }
977 ],
978 "returns": [
979 { "name": "result", "type": "array", "items": { "$ref": "Pro pertyDescriptor" }, "description": "Object properties." },
980 { "name": "internalProperties", "optional": true, "type": "a rray", "items": { "$ref": "InternalPropertyDescriptor" }, "description": "Intern al object properties (only of the element itself).", "hidden": true },
981 { "name": "exceptionDetails", "$ref": "ExceptionDetails", "o ptional": true, "hidden": true, "description": "Exception details."}
982 ],
983 "description": "Returns properties of a given object. Object gro up of the result is inherited from the target object."
984 },
985 {
986 "name": "releaseObject",
987 "parameters": [
988 { "name": "objectId", "$ref": "RemoteObjectId", "description ": "Identifier of the object to release." }
989 ],
990 "description": "Releases remote object with given id."
991 },
992 {
993 "name": "releaseObjectGroup",
994 "parameters": [
995 { "name": "objectGroup", "type": "string", "description": "S ymbolic object group name." }
996 ],
997 "description": "Releases all remote objects that belong to a giv en group."
998 },
999 {
1000 "name": "run",
1001 "hidden": true,
1002 "description": "Tells inspected instance(worker or page) that it can run in case it was started paused."
1003 },
1004 {
1005 "name": "enable",
1006 "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. "
1007 },
1008 {
1009 "name": "disable",
1010 "hidden": true,
1011 "description": "Disables reporting of execution contexts creatio n."
1012 },
1013 {
1014 "name": "setCustomObjectFormatterEnabled",
1015 "parameters": [
1016 {
1017 "name": "enabled",
1018 "type": "boolean"
1019 }
1020 ],
1021 "hidden": true
1022 },
1023 {
1024 "name": "compileScript",
1025 "hidden": true,
1026 "parameters": [
1027 { "name": "expression", "type": "string", "description": "Ex pression to compile." },
1028 { "name": "sourceURL", "type": "string", "description": "Sou rce url to be set for the script." },
1029 { "name": "persistScript", "type": "boolean", "description": "Specifies whether the compiled script should be persisted." },
1030 { "name": "executionContextId", "$ref": "ExecutionContextId" , "description": "Specifies in which isolated context to perform script run. Eac h content script lives in an isolated context and this parameter is used to spec ify one of those contexts." }
1031 ],
1032 "returns": [
1033 { "name": "scriptId", "$ref": "ScriptId", "optional": true, "description": "Id of the script." },
1034 { "name": "exceptionDetails", "$ref": "ExceptionDetails", "o ptional": true, "description": "Exception details."}
1035 ],
1036 "description": "Compiles expression."
1037 },
1038 {
1039 "name": "runScript",
1040 "hidden": true,
1041 "parameters": [
1042 { "name": "scriptId", "$ref": "ScriptId", "description": "Id of the script to run." },
1043 { "name": "executionContextId", "$ref": "ExecutionContextId" , "description": "Specifies in which isolated context to perform script run. Eac h content script lives in an isolated context and this parameter is used to spec ify one of those contexts." },
1044 { "name": "objectGroup", "type": "string", "optional": true, "description": "Symbolic group name that can be used to release multiple object s." },
1045 { "name": "doNotPauseOnExceptionsAndMuteConsole", "type": "b oolean", "optional": true, "description": "Specifies whether script run should s top on exceptions and mute console. Overrides setPauseOnException state." },
1046 { "name": "includeCommandLineAPI", "type": "boolean", "optio nal": true, "description": "Determines whether Command Line API should be availa ble during the evaluation." }
1047 ],
1048 "returns": [
1049 { "name": "result", "$ref": "RemoteObject", "description": " Run result." },
1050 { "name": "exceptionDetails", "$ref": "ExceptionDetails", "o ptional": true, "description": "Exception details."}
1051 ],
1052 "description": "Runs script with given id in a given context."
1053 }
1054 ],
1055 "events": [
1056 {
1057 "name": "executionContextCreated",
1058 "parameters": [
1059 { "name": "context", "$ref": "ExecutionContextDescription", "description": "A newly created execution contex." }
1060 ],
1061 "description": "Issued when new execution context is created."
1062 },
1063 {
1064 "name": "executionContextDestroyed",
1065 "parameters": [
1066 { "name": "executionContextId", "$ref": "ExecutionContextId" , "description": "Id of the destroyed context" }
1067 ],
1068 "description": "Issued when execution context is destroyed."
1069 },
1070 {
1071 "name": "executionContextsCleared",
1072 "description": "Issued when all executionContexts were cleared i n browser"
1073 },
1074 {
1075 "name": "inspectRequested",
1076 "parameters": [
1077 { "name": "object", "$ref": "RemoteObject" },
1078 { "name": "hints", "type": "object" }
1079 ],
1080 "hidden": true
1081 }
1082 ]
1083 },
1084 {
1085 "domain": "Console",
1086 "description": "Console domain defines methods and events for interactio n with the JavaScript console. Console collects messages created by means of the <a href='http://getfirebug.com/wiki/index.php/Console_API'>JavaScript Console A PI</a>. One needs to enable this domain using <code>enable</code> command in ord er to start receiving the console messages. Browser collects messages issued whi le console domain is not enabled as well and reports them using <code>messageAdd ed</code> notification upon enabling.",
1087 "dependencies": ["Runtime"],
1088 "types": [
1089 {
1090 "id": "Timestamp",
1091 "type": "number",
1092 "description": "Number of seconds since epoch.",
1093 "hidden": true
1094 },
1095 {
1096 "id": "ConsoleMessage",
1097 "type": "object",
1098 "description": "Console message.",
1099 "properties": [
1100 { "name": "source", "type": "string", "enum": ["xml", "javas cript", "network", "console-api", "storage", "appcache", "rendering", "security" , "other", "deprecation"], "description": "Message source." },
1101 { "name": "level", "type": "string", "enum": ["log", "warnin g", "error", "debug", "info", "revokedError"], "description": "Message severity. " },
1102 { "name": "text", "type": "string", "description": "Message text." },
1103 { "name": "type", "type": "string", "optional": true, "enum" : ["log", "dir", "dirxml", "table", "trace", "clear", "startGroup", "startGroupC ollapsed", "endGroup", "assert", "profile", "profileEnd"], "description": "Conso le message type." },
1104 { "name": "scriptId", "type": "string", "optional": true, "d escription": "Script ID of the message origin." },
1105 { "name": "url", "type": "string", "optional": true, "descri ption": "URL of the message origin." },
1106 { "name": "line", "type": "integer", "optional": true, "desc ription": "Line number in the resource that generated this message." },
1107 { "name": "column", "type": "integer", "optional": true, "de scription": "Column number in the resource that generated this message." },
1108 { "name": "repeatCount", "type": "integer", "optional": true , "description": "Repeat count for repeated messages." },
1109 { "name": "parameters", "type": "array", "items": { "$ref": "Runtime.RemoteObject" }, "optional": true, "description": "Message parameters i n case of the formatted message." },
1110 { "name": "stack", "$ref": "Runtime.StackTrace", "optional": true, "description": "JavaScript stack trace for assertions and error messages. " },
1111 { "name": "networkRequestId", "$ref": "Network.RequestId", " optional": true, "description": "Identifier of the network request associated wi th this message." },
1112 { "name": "timestamp", "$ref": "Timestamp", "description": " Timestamp, when this message was fired.", "hidden": true },
1113 { "name": "executionContextId", "$ref": "Runtime.ExecutionCo ntextId", "optional": true, "description": "Identifier of the context where this message was created", "hidden": true },
1114 { "name": "messageId", "type": "integer", "hidden": true, "o ptional": true, "description": "Message id." },
1115 { "name": "relatedMessageId", "type": "integer", "hidden": t rue, "optional": true, "description": "Related message id." }
1116 ]
1117 }
1118 ],
1119 "commands": [
1120 {
1121 "name": "enable",
1122 "description": "Enables console domain, sends the messages colle cted so far to the client by means of the <code>messageAdded</code> notification ."
1123 },
1124 {
1125 "name": "disable",
1126 "description": "Disables console domain, prevents further consol e messages from being reported to the client."
1127 },
1128 {
1129 "name": "clearMessages",
1130 "description": "Clears console messages collected in the browser ."
1131 }
1132 ],
1133 "events": [
1134 {
1135 "name": "messageAdded",
1136 "parameters": [
1137 { "name": "message", "$ref": "ConsoleMessage", "description" : "Console message that has been added." }
1138 ],
1139 "description": "Issued when new console message is added."
1140 },
1141 {
1142 "name": "messageRepeatCountUpdated",
1143 "parameters": [
1144 { "name": "count", "type": "integer", "description": "New re peat count value." },
1145 { "name": "timestamp", "$ref": "Timestamp", "description": " Timestamp of most recent message in batch.", "hidden": true }
1146 ],
1147 "description": "Is not issued. Will be gone in the future versio ns of the protocol.",
1148 "deprecated": true
1149 },
1150 {
1151 "name": "messagesCleared",
1152 "description": "Issued when console is cleared. This happens eit her upon <code>clearMessages</code> command or after page navigation."
1153 }
1154 ]
1155 },
1156 {
1157 "domain": "Security",
1158 "description": "Security",
1159 "hidden": true,
1160 "types": [
1161 {
1162 "id": "CertificateId",
1163 "type": "integer",
1164 "description": "An internal certificate ID value."
1165 },
1166 {
1167 "id": "SecurityState",
1168 "type": "string",
1169 "enum": ["unknown", "neutral", "insecure", "warning", "secure", "info"],
1170 "description": "The security level of a page or resource."
1171 },
1172 {
1173 "id": "SecurityStateExplanation",
1174 "type": "object",
1175 "properties": [
1176 { "name": "securityState", "$ref": "SecurityState", "descrip tion": "Security state representing the severity of the factor being explained." },
1177 { "name": "summary", "type": "string", "description": "Short phrase describing the type of factor." },
1178 { "name": "description", "type": "string", "description": "F ull text explanation of the factor." },
1179 { "name": "certificateId", "$ref": "CertificateId", "optiona l": true, "description": "Associated certificate id." }
1180 ],
1181 "description": "An explanation of an factor contributing to the security state."
1182 },
1183 {
1184 "id": "MixedContentStatus",
1185 "type": "object",
1186 "properties": [
1187 { "name": "ranInsecureContent", "type": "boolean", "descript ion": "True if the page ran insecure content such as scripts." },
1188 { "name": "displayedInsecureContent", "type": "boolean", "de scription": "True if the page displayed insecure content such as images." },
1189 { "name": "ranInsecureContentStyle", "$ref": "SecurityState" , "description": "Security state representing a page that ran insecure content." },
1190 { "name": "displayedInsecureContentStyle", "$ref": "Security State", "description": "Security state representing a page that displayed insecu re content." }
1191 ],
1192 "description": "Information about mixed content on the page."
1193 }
1194 ],
1195 "commands": [
1196 {
1197 "name": "enable",
1198 "description": "Enables tracking security state changes.",
1199 "handlers": ["browser"]
1200 },
1201 {
1202 "name": "disable",
1203 "description": "Disables tracking security state changes.",
1204 "handlers": ["browser"]
1205 }
1206 ],
1207 "events": [
1208 {
1209 "name": "securityStateChanged",
1210 "description": "The security state of the page changed.",
1211 "parameters": [
1212 { "name": "securityState", "$ref": "SecurityState", "descrip tion": "Security state." },
1213 { "name": "explanations", "type": "array", "items": { "$ref" : "SecurityStateExplanation" }, "description": "List of explanations for the sec urity state. If the overall security state is `insecure` or `warning`, at least one corresponding explanation should be included.", "optional": true },
1214 { "name": "mixedContentStatus", "$ref": "MixedContentStatus" , "description": "Information about mixed content on the page.", "optional": tru e },
1215 { "name": "schemeIsCryptographic", "type": "boolean", "descr iption": "True if the page was loaded over cryptographic transport such as HTTPS .", "optional": true }
1216 ],
1217 "handlers": ["browser"]
1218 }
1219 ]
1220 },
1221 {
1222 "domain": "Network",
1223 "description": "Network domain allows tracking network activities of the page. It exposes information about http, file, data and other requests and resp onses, their headers, bodies, timing, etc.",
1224 "dependencies": ["Runtime", "Security"],
1225 "types": [
1226 {
1227 "id": "LoaderId",
1228 "type": "string",
1229 "description": "Unique loader identifier."
1230 },
1231 {
1232 "id": "RequestId",
1233 "type": "string",
1234 "description": "Unique request identifier."
1235 },
1236 {
1237 "id": "Timestamp",
1238 "type": "number",
1239 "description": "Number of seconds since epoch."
1240 },
1241 {
1242 "id": "Headers",
1243 "type": "object",
1244 "description": "Request / response headers as keys / values of J SON object."
1245 },
1246 {
1247 "id": "ResourceTiming",
1248 "type": "object",
1249 "description": "Timing information for the request.",
1250 "properties": [
1251 { "name": "requestTime", "type": "number", "description": "T iming's requestTime is a baseline in seconds, while the other numbers are ticks in milliseconds relatively to this requestTime." },
1252 { "name": "proxyStart", "type": "number", "description": "St arted resolving proxy." },
1253 { "name": "proxyEnd", "type": "number", "description": "Fini shed resolving proxy." },
1254 { "name": "dnsStart", "type": "number", "description": "Star ted DNS address resolve." },
1255 { "name": "dnsEnd", "type": "number", "description": "Finish ed DNS address resolve." },
1256 { "name": "connectStart", "type": "number", "description": " Started connecting to the remote host." },
1257 { "name": "connectEnd", "type": "number", "description": "Co nnected to the remote host." },
1258 { "name": "sslStart", "type": "number", "description": "Star ted SSL handshake." },
1259 { "name": "sslEnd", "type": "number", "description": "Finish ed SSL handshake." },
1260 { "name": "workerStart", "type": "number", "description": "S tarted running ServiceWorker.", "hidden": true },
1261 { "name": "workerReady", "type": "number", "description": "F inished Starting ServiceWorker.", "hidden": true },
1262 { "name": "sendStart", "type": "number", "description": "Sta rted sending request." },
1263 { "name": "sendEnd", "type": "number", "description": "Finis hed sending request." },
1264 { "name": "pushStart", "type": "number", "description": "Tim e the server started pushing request.", "hidden": true },
1265 { "name": "pushEnd", "type": "number", "description": "Time the server finished pushing request.", "hidden": true },
1266 { "name": "receiveHeadersEnd", "type": "number", "descriptio n": "Finished receiving response headers." }
1267 ]
1268 },
1269 {
1270 "id": "ResourcePriority",
1271 "type": "string",
1272 "enum": ["VeryLow", "Low", "Medium", "High", "VeryHigh"],
1273 "description": "Loading priority of a resource request."
1274 },
1275 {
1276 "id": "Request",
1277 "type": "object",
1278 "description": "HTTP request data.",
1279 "properties": [
1280 { "name": "url", "type": "string", "description": "Request U RL." },
1281 { "name": "method", "type": "string", "description": "HTTP r equest method." },
1282 { "name": "headers", "$ref": "Headers", "description": "HTTP request headers." },
1283 { "name": "postData", "type": "string", "optional": true, "d escription": "HTTP POST request data." },
1284 { "name": "mixedContentType", "optional": true, "type": "str ing", "enum": ["blockable", "optionally-blockable", "none"], "description": "The mixed content status of the request, as defined in http://www.w3.org/TR/mixed-c ontent/" },
1285 { "name": "initialPriority", "$ref": "ResourcePriority", "de scription": "Priority of the resource request at the time request is sent."}
1286 ]
1287 },
1288 {
1289 "id": "CertificateSubject",
1290 "type": "object",
1291 "description": "Subject of a certificate.",
1292 "properties": [
1293 { "name": "name", "type": "string", "description": "Certific ate subject name." },
1294 { "name": "sanDnsNames", "type": "array", "items": { "type": "string" }, "description": "Subject Alternative Name (SAN) DNS names." },
1295 { "name": "sanIpAddresses", "type": "array", "items": { "typ e": "string" }, "description": "Subject Alternative Name (SAN) IP addresses." }
1296 ]
1297 },
1298 {
1299 "id": "CertificateDetails",
1300 "type": "object",
1301 "description": "Details about a request's certificate.",
1302 "properties": [
1303 { "name": "subject", "$ref": "CertificateSubject", "descript ion": "Certificate subject." },
1304 { "name": "issuer", "type": "string", "description": "Name o f the issuing CA." },
1305 { "name": "validFrom", "$ref": "Timestamp", "description": " Certificate valid from date." },
1306 { "name": "validTo", "$ref": "Timestamp", "description": "Ce rtificate valid to (expiration) date" }
1307 ]
1308 },
1309 {
1310 "id": "CertificateValidationDetails",
1311 "type": "object",
1312 "description": "Details about the validation status of a request 's certificate.",
1313 "properties": [
1314 { "name": "numUnknownScts", "type": "integer", "description" : "The number of SCTs from unknown logs." },
1315 { "name": "numInvalidScts", "type": "integer", "description" : "The number of invalid SCTs." },
1316 { "name": "numValidScts", "type": "integer", "description": "The number of valid SCTs." }
1317 ]
1318 },
1319 {
1320 "id": "SecurityDetails",
1321 "type": "object",
1322 "description": "Security details about a request.",
1323 "properties": [
1324 { "name": "protocol", "type": "string", "description": "Prot ocol name (e.g. \"TLS 1.2\" or \"QUIC\")." },
1325 { "name": "keyExchange", "type": "string", "description": "K ey Exchange used by the connection." },
1326 { "name": "cipher", "type": "string", "description": "Cipher name." },
1327 { "name": "mac", "type": "string", "optional": true, "descri ption": "TLS MAC. Note that AEAD ciphers do not have separate MACs." },
1328 { "name": "certificateId", "$ref": "Security.CertificateId", "description": "Certificate ID value." },
1329 { "name": "certificateValidationDetails", "$ref": "Certifica teValidationDetails", "optional": true, "description": "Validation details for t he request's certficate." }
1330 ]
1331 },
1332 {
1333 "id": "BlockedReason",
1334 "type": "string",
1335 "description": "The reason why request was blocked.",
1336 "enum": ["csp", "mixed-content", "origin", "inspector", "other"] ,
1337 "hidden": true
1338 },
1339 {
1340 "id": "Response",
1341 "type": "object",
1342 "description": "HTTP response data.",
1343 "properties": [
1344 { "name": "url", "type": "string", "description": "Response URL. This URL can be different from CachedResource.url in case of redirect." },
1345 { "name": "status", "type": "number", "description": "HTTP r esponse status code." },
1346 { "name": "statusText", "type": "string", "description": "HT TP response status text." },
1347 { "name": "headers", "$ref": "Headers", "description": "HTTP response headers." },
1348 { "name": "headersText", "type": "string", "optional": true, "description": "HTTP response headers text." },
1349 { "name": "mimeType", "type": "string", "description": "Reso urce mimeType as determined by the browser." },
1350 { "name": "requestHeaders", "$ref": "Headers", "optional": t rue, "description": "Refined HTTP request headers that were actually transmitted over the network." },
1351 { "name": "requestHeadersText", "type": "string", "optional" : true, "description": "HTTP request headers text." },
1352 { "name": "connectionReused", "type": "boolean", "descriptio n": "Specifies whether physical connection was actually reused for this request. " },
1353 { "name": "connectionId", "type": "number", "description": " Physical connection id that was actually used for this request." },
1354 { "name": "remoteIPAddress", "type": "string", "optional": t rue, "hidden": true, "description": "Remote IP address." },
1355 { "name": "remotePort", "type": "integer", "optional": true, "hidden": true, "description": "Remote port."},
1356 { "name": "fromDiskCache", "type": "boolean", "optional": tr ue, "description": "Specifies that the request was served from the disk cache." },
1357 { "name": "fromServiceWorker", "type": "boolean", "optional" : true, "description": "Specifies that the request was served from the ServiceWo rker." },
1358 { "name": "encodedDataLength", "type": "number", "optional": false, "description": "Total number of bytes received for this request so far." },
1359 { "name": "timing", "$ref": "ResourceTiming", "optional": tr ue, "description": "Timing information for the given request." },
1360 { "name": "protocol", "type": "string", "optional": true, "d escription": "Protocol used to fetch this request." },
1361 { "name": "securityState", "$ref": "Security.SecurityState", "description": "Security state of the request resource." },
1362 { "name": "securityDetails", "$ref": "SecurityDetails", "opt ional": true, "description": "Security details for the request." }
1363 ]
1364 },
1365 {
1366 "id": "WebSocketRequest",
1367 "type": "object",
1368 "description": "WebSocket request data.",
1369 "hidden": true,
1370 "properties": [
1371 { "name": "headers", "$ref": "Headers", "description": "HTTP request headers." }
1372 ]
1373 },
1374 {
1375 "id": "WebSocketResponse",
1376 "type": "object",
1377 "description": "WebSocket response data.",
1378 "hidden": true,
1379 "properties": [
1380 { "name": "status", "type": "number", "description": "HTTP r esponse status code." },
1381 { "name": "statusText", "type": "string", "description": "HT TP response status text." },
1382 { "name": "headers", "$ref": "Headers", "description": "HTTP response headers." },
1383 { "name": "headersText", "type": "string", "optional": true, "description": "HTTP response headers text." },
1384 { "name": "requestHeaders", "$ref": "Headers", "optional": t rue, "description": "HTTP request headers." },
1385 { "name": "requestHeadersText", "type": "string", "optional" : true, "description": "HTTP request headers text." }
1386 ]
1387 },
1388 {
1389 "id": "WebSocketFrame",
1390 "type": "object",
1391 "description": "WebSocket frame data.",
1392 "hidden": true,
1393 "properties": [
1394 { "name": "opcode", "type": "number", "description": "WebSoc ket frame opcode." },
1395 { "name": "mask", "type": "boolean", "description": "WebSock e frame mask." },
1396 { "name": "payloadData", "type": "string", "description": "W ebSocke frame payload data." }
1397 ]
1398 },
1399 {
1400 "id": "CachedResource",
1401 "type": "object",
1402 "description": "Information about the cached resource.",
1403 "properties": [
1404 { "name": "url", "type": "string", "description": "Resource URL. This is the url of the original network request." },
1405 { "name": "type", "$ref": "Page.ResourceType", "description" : "Type of this resource." },
1406 { "name": "response", "$ref": "Response", "optional": true, "description": "Cached response data." },
1407 { "name": "bodySize", "type": "number", "description": "Cach ed response body size." }
1408 ]
1409 },
1410 {
1411 "id": "Initiator",
1412 "type": "object",
1413 "description": "Information about the request initiator.",
1414 "properties": [
1415 { "name": "type", "type": "string", "enum": ["parser", "scri pt", "other"], "description": "Type of this initiator." },
1416 { "name": "stack", "$ref": "Runtime.StackTrace", "optional": true, "description": "Initiator JavaScript stack trace, set for Script only." } ,
1417 { "name": "url", "type": "string", "optional": true, "descri ption": "Initiator URL, set for Parser type only." },
1418 { "name": "lineNumber", "type": "number", "optional": true, "description": "Initiator line number, set for Parser type only." }
1419 ]
1420 },
1421 {
1422 "id": "Cookie",
1423 "type": "object",
1424 "description": "Cookie object",
1425 "properties": [
1426 { "name": "name", "type": "string", "description": "Cookie n ame." },
1427 { "name": "value", "type": "string", "description": "Cookie value." },
1428 { "name": "domain", "type": "string", "description": "Cookie domain." },
1429 { "name": "path", "type": "string", "description": "Cookie p ath." },
1430 { "name": "expires", "type": "number", "description": "Cooki e expires." },
1431 { "name": "size", "type": "integer", "description": "Cookie size." },
1432 { "name": "httpOnly", "type": "boolean", "description": "Tru e if cookie is http-only." },
1433 { "name": "secure", "type": "boolean", "description": "True if cookie is secure." },
1434 { "name": "session", "type": "boolean", "description": "True in case of session cookie." },
1435 { "name": "sameSite", "type": "string", "optional": true, "e num": ["Strict", "Lax"], "description": "Represents the cookies' 'SameSite' stat us: https://tools.ietf.org/html/draft-west-first-party-cookies" }
1436 ],
1437 "hidden": true
1438 }
1439 ],
1440 "commands": [
1441 {
1442 "name": "enable",
1443 "description": "Enables network tracking, network events will no w be delivered to the client.",
1444 "parameters": [
1445 { "name": "maxTotalBufferSize", "type": "integer", "optional ": true, "hidden": true, "description": "Buffer size in bytes to use when preser ving network payloads (XHRs, etc)." },
1446 { "name": "maxResourceBufferSize", "type": "integer", "optio nal": true, "hidden": true, "description": "Per-resource buffer size in bytes to use when preserving network payloads (XHRs, etc)." }
1447 ]
1448 },
1449 {
1450 "name": "disable",
1451 "description": "Disables network tracking, prevents network even ts from being sent to the client."
1452 },
1453 {
1454 "name": "setUserAgentOverride",
1455 "description": "Allows overriding user agent with the given stri ng.",
1456 "parameters": [
1457 { "name": "userAgent", "type": "string", "description": "Use r agent to use." }
1458 ]
1459 },
1460 {
1461 "name": "setExtraHTTPHeaders",
1462 "description": "Specifies whether to always send extra HTTP head ers with the requests from this page.",
1463 "parameters": [
1464 { "name": "headers", "$ref": "Headers", "description": "Map with extra HTTP headers." }
1465 ]
1466 },
1467 {
1468 "name": "getResponseBody",
1469 "async": true,
1470 "description": "Returns content served for the given request.",
1471 "parameters": [
1472 { "name": "requestId", "$ref": "RequestId", "description": " Identifier of the network request to get content for." }
1473 ],
1474 "returns": [
1475 { "name": "body", "type": "string", "description": "Response body." },
1476 { "name": "base64Encoded", "type": "boolean", "description": "True, if content was sent as base64." }
1477 ]
1478 },
1479 {
1480 "name": "addBlockedURL",
1481 "description": "Blocks specific URL from loading.",
1482 "parameters": [
1483 { "name": "url", "type": "string", "description": "URL to bl ock." }
1484 ],
1485 "hidden": true
1486 },
1487 {
1488 "name": "removeBlockedURL",
1489 "description": "Cancels blocking of a specific URL from loading. ",
1490 "parameters": [
1491 { "name": "url", "type": "string", "description": "URL to st op blocking." }
1492 ],
1493 "hidden": true
1494 },
1495 {
1496 "name": "replayXHR",
1497 "description": "This method sends a new XMLHttpRequest which is identical to the original one. The following parameters should be identical: met hod, url, async, request body, extra headers, withCredentials attribute, user, p assword.",
1498 "parameters": [
1499 { "name": "requestId", "$ref": "RequestId", "description": " Identifier of XHR to replay." }
1500 ],
1501 "hidden": true
1502 },
1503 {
1504 "name": "setMonitoringXHREnabled",
1505 "parameters": [
1506 { "name": "enabled", "type": "boolean", "description": "Moni toring enabled state." }
1507 ],
1508 "description": "Toggles monitoring of XMLHttpRequest. If <code>t rue</code>, console will receive messages upon each XHR issued.",
1509 "hidden": true
1510 },
1511 {
1512 "name": "canClearBrowserCache",
1513 "description": "Tells whether clearing browser cache is supporte d.",
1514 "returns": [
1515 { "name": "result", "type": "boolean", "description": "True if browser cache can be cleared." }
1516 ]
1517 },
1518 {
1519 "name": "clearBrowserCache",
1520 "description": "Clears browser cache.",
1521 "handlers": ["browser"]
1522 },
1523 {
1524 "name": "canClearBrowserCookies",
1525 "description": "Tells whether clearing browser cookies is suppor ted.",
1526 "returns": [
1527 { "name": "result", "type": "boolean", "description": "True if browser cookies can be cleared." }
1528 ]
1529 },
1530 {
1531 "name": "clearBrowserCookies",
1532 "description": "Clears browser cookies.",
1533 "handlers": ["browser"]
1534 },
1535 {
1536 "name": "getCookies",
1537 "returns": [
1538 { "name": "cookies", "type": "array", "items": { "$ref": "Co okie" }, "description": "Array of cookie objects." }
1539 ],
1540 "description": "Returns all browser cookies. Depending on the ba ckend support, will return detailed cookie information in the <code>cookies</cod e> field.",
1541 "handlers": ["browser"],
1542 "async": true,
1543 "hidden": true
1544 },
1545 {
1546 "name": "deleteCookie",
1547 "parameters": [
1548 { "name": "cookieName", "type": "string", "description": "Na me of the cookie to remove." },
1549 { "name": "url", "type": "string", "description": "URL to ma tch cooke domain and path." }
1550 ],
1551 "description": "Deletes browser cookie with given name, domain a nd path.",
1552 "handlers": ["browser"],
1553 "async": true,
1554 "hidden": true
1555 },
1556 {
1557 "name": "canEmulateNetworkConditions",
1558 "description": "Tells whether emulation of network conditions is supported.",
1559 "returns": [
1560 { "name": "result", "type": "boolean", "description": "True if emulation of network conditions is supported." }
1561 ],
1562 "hidden": true,
1563 "handlers": ["browser"]
1564 },
1565 {
1566 "name": "emulateNetworkConditions",
1567 "description": "Activates emulation of network conditions.",
1568 "parameters": [
1569 { "name": "offline", "type": "boolean", "description": "True to emulate internet disconnection." },
1570 { "name": "latency", "type": "number", "description": "Addit ional latency (ms)." },
1571 { "name": "downloadThroughput", "type": "number", "descripti on": "Maximal aggregated download throughput." },
1572 { "name": "uploadThroughput", "type": "number", "description ": "Maximal aggregated upload throughput." }
1573 ],
1574 "hidden": true,
1575 "handlers": ["browser"]
1576 },
1577 {
1578 "name": "setCacheDisabled",
1579 "parameters": [
1580 { "name": "cacheDisabled", "type": "boolean", "description": "Cache disabled state." }
1581 ],
1582 "description": "Toggles ignoring cache for each request. If <cod e>true</code>, cache will not be used."
1583 },
1584 {
1585 "name": "setBypassServiceWorker",
1586 "parameters": [
1587 { "name": "bypass", "type": "boolean", "description": "Bypas s service worker and load from network." }
1588 ],
1589 "hidden": true,
1590 "description": "Toggles ignoring of service worker for each requ est."
1591 },
1592 {
1593 "name": "setDataSizeLimitsForTest",
1594 "parameters": [
1595 { "name": "maxTotalSize", "type": "integer", "description": "Maximum total buffer size." },
1596 { "name": "maxResourceSize", "type": "integer", "description ": "Maximum per-resource size." }
1597 ],
1598 "description": "For testing.",
1599 "hidden": true
1600 },
1601 {
1602 "name": "getCertificateDetails",
1603 "description": "Returns details for the given certificate.",
1604 "parameters": [
1605 { "name": "certificateId", "$ref": "Security.CertificateId", "description": "ID of the certificate to get details for." }
1606 ],
1607 "returns": [
1608 { "name": "result", "$ref": "CertificateDetails", "descripti on": "Certificate details." }
1609 ],
1610 "handlers": ["browser"]
1611 },
1612 {
1613 "name": "showCertificateViewer",
1614 "description": "Displays native dialog with the certificate deta ils.",
1615 "parameters": [
1616 { "name": "certificateId", "$ref": "Security.CertificateId", "description": "Certificate id." }
1617 ],
1618 "handlers": ["browser"]
1619 }
1620 ],
1621 "events": [
1622 {
1623 "name": "resourceChangedPriority",
1624 "description": "Fired when resource loading priority is changed" ,
1625 "parameters": [
1626 { "name": "requestId", "$ref": "RequestId", "description": " Request identifier." },
1627 { "name": "newPriority", "$ref": "ResourcePriority", "descri ption": "New priority" },
1628 { "name": "timestamp", "$ref": "Timestamp", "description": " Timestamp." }
1629 ],
1630 "hidden": true
1631 },
1632 {
1633 "name": "requestWillBeSent",
1634 "description": "Fired when page is about to send HTTP request.",
1635 "parameters": [
1636 { "name": "requestId", "$ref": "RequestId", "description": " Request identifier." },
1637 { "name": "frameId", "$ref": "Page.FrameId", "description": "Frame identifier.", "hidden": true },
1638 { "name": "loaderId", "$ref": "LoaderId", "description": "Lo ader identifier." },
1639 { "name": "documentURL", "type": "string", "description": "U RL of the document this request is loaded for." },
1640 { "name": "request", "$ref": "Request", "description": "Requ est data." },
1641 { "name": "timestamp", "$ref": "Timestamp", "description": " Timestamp." },
1642 { "name": "wallTime", "$ref": "Timestamp", "hidden": true, " description": "UTC Timestamp." },
1643 { "name": "initiator", "$ref": "Initiator", "description": " Request initiator." },
1644 { "name": "redirectResponse", "optional": true, "$ref": "Res ponse", "description": "Redirect response data." },
1645 { "name": "type", "$ref": "Page.ResourceType", "optional": t rue, "hidden": true, "description": "Type of this resource." }
1646 ]
1647 },
1648 {
1649 "name": "requestServedFromCache",
1650 "description": "Fired if request ended up loading from cache.",
1651 "parameters": [
1652 { "name": "requestId", "$ref": "RequestId", "description": " Request identifier." }
1653 ]
1654 },
1655 {
1656 "name": "responseReceived",
1657 "description": "Fired when HTTP response is available.",
1658 "parameters": [
1659 { "name": "requestId", "$ref": "RequestId", "description": " Request identifier." },
1660 { "name": "frameId", "$ref": "Page.FrameId", "description": "Frame identifier.", "hidden": true },
1661 { "name": "loaderId", "$ref": "LoaderId", "description": "Lo ader identifier." },
1662 { "name": "timestamp", "$ref": "Timestamp", "description": " Timestamp." },
1663 { "name": "type", "$ref": "Page.ResourceType", "description" : "Resource type." },
1664 { "name": "response", "$ref": "Response", "description": "Re sponse data." }
1665 ]
1666 },
1667 {
1668 "name": "dataReceived",
1669 "description": "Fired when data chunk was received over the netw ork.",
1670 "parameters": [
1671 { "name": "requestId", "$ref": "RequestId", "description": " Request identifier." },
1672 { "name": "timestamp", "$ref": "Timestamp", "description": " Timestamp." },
1673 { "name": "dataLength", "type": "integer", "description": "D ata chunk length." },
1674 { "name": "encodedDataLength", "type": "integer", "descripti on": "Actual bytes received (might be less than dataLength for compressed encodi ngs)." }
1675 ]
1676 },
1677 {
1678 "name": "loadingFinished",
1679 "description": "Fired when HTTP request has finished loading.",
1680 "parameters": [
1681 { "name": "requestId", "$ref": "RequestId", "description": " Request identifier." },
1682 { "name": "timestamp", "$ref": "Timestamp", "description": " Timestamp." },
1683 { "name": "encodedDataLength", "type": "number", "descriptio n": "Total number of bytes received for this request." }
1684 ]
1685 },
1686 {
1687 "name": "loadingFailed",
1688 "description": "Fired when HTTP request has failed to load.",
1689 "parameters": [
1690 { "name": "requestId", "$ref": "RequestId", "description": " Request identifier." },
1691 { "name": "timestamp", "$ref": "Timestamp", "description": " Timestamp." },
1692 { "name": "type", "$ref": "Page.ResourceType", "description" : "Resource type." },
1693 { "name": "errorText", "type": "string", "description": "Use r friendly error message." },
1694 { "name": "canceled", "type": "boolean", "optional": true, " description": "True if loading was canceled." },
1695 { "name": "blockedReason", "$ref": "BlockedReason", "optiona l": true, "description": "The reason why loading was blocked, if any.", "hidden" : true }
1696 ]
1697 },
1698 {
1699 "name": "webSocketWillSendHandshakeRequest",
1700 "description": "Fired when WebSocket is about to initiate handsh ake.",
1701 "parameters": [
1702 { "name": "requestId", "$ref": "RequestId", "description": " Request identifier." },
1703 { "name": "timestamp", "$ref": "Timestamp", "description": " Timestamp." },
1704 { "name": "wallTime", "$ref": "Timestamp", "hidden": true, " description": "UTC Timestamp." },
1705 { "name": "request", "$ref": "WebSocketRequest", "descriptio n": "WebSocket request data." }
1706 ],
1707 "hidden": true
1708 },
1709 {
1710 "name": "webSocketHandshakeResponseReceived",
1711 "description": "Fired when WebSocket handshake response becomes available.",
1712 "parameters": [
1713 { "name": "requestId", "$ref": "RequestId", "description": " Request identifier." },
1714 { "name": "timestamp", "$ref": "Timestamp", "description": " Timestamp." },
1715 { "name": "response", "$ref": "WebSocketResponse", "descript ion": "WebSocket response data." }
1716 ],
1717 "hidden": true
1718 },
1719 {
1720 "name": "webSocketCreated",
1721 "description": "Fired upon WebSocket creation.",
1722 "parameters": [
1723 { "name": "requestId", "$ref": "RequestId", "description": " Request identifier." },
1724 { "name": "url", "type": "string", "description": "WebSocket request URL." }
1725 ],
1726 "hidden": true
1727 },
1728 {
1729 "name": "webSocketClosed",
1730 "description": "Fired when WebSocket is closed.",
1731 "parameters": [
1732 { "name": "requestId", "$ref": "RequestId", "description": " Request identifier." },
1733 { "name": "timestamp", "$ref": "Timestamp", "description": " Timestamp." }
1734 ],
1735 "hidden": true
1736 },
1737 {
1738 "name": "webSocketFrameReceived",
1739 "description": "Fired when WebSocket frame is received.",
1740 "parameters": [
1741 { "name": "requestId", "$ref": "RequestId", "description": " Request identifier." },
1742 { "name": "timestamp", "$ref": "Timestamp", "description": " Timestamp." },
1743 { "name": "response", "$ref": "WebSocketFrame", "description ": "WebSocket response data." }
1744 ],
1745 "hidden": true
1746 },
1747 {
1748 "name": "webSocketFrameError",
1749 "description": "Fired when WebSocket frame error occurs.",
1750 "parameters": [
1751 { "name": "requestId", "$ref": "RequestId", "description": " Request identifier." },
1752 { "name": "timestamp", "$ref": "Timestamp", "description": " Timestamp." },
1753 { "name": "errorMessage", "type": "string", "description": " WebSocket frame error message." }
1754 ],
1755 "hidden": true
1756 },
1757 {
1758 "name": "webSocketFrameSent",
1759 "description": "Fired when WebSocket frame is sent.",
1760 "parameters": [
1761 { "name": "requestId", "$ref": "RequestId", "description": " Request identifier." },
1762 { "name": "timestamp", "$ref": "Timestamp", "description": " Timestamp." },
1763 { "name": "response", "$ref": "WebSocketFrame", "description ": "WebSocket response data." }
1764 ],
1765 "hidden": true
1766 },
1767 {
1768 "name": "eventSourceMessageReceived",
1769 "description": "Fired when EventSource message is received.",
1770 "parameters": [
1771 { "name": "requestId", "$ref": "RequestId", "description": " Request identifier." },
1772 { "name": "timestamp", "$ref": "Timestamp", "description": " Timestamp." },
1773 { "name": "eventName", "type": "string", "description": "Mes sage type." },
1774 { "name": "eventId", "type": "string", "description": "Messa ge identifier." },
1775 { "name": "data", "type": "string", "description": "Message content." }
1776 ],
1777 "hidden": true
1778 }
1779 ]
1780 },
1781 {
1782 "domain": "Database",
1783 "hidden": true,
1784 "types": [
1785 {
1786 "id": "DatabaseId",
1787 "type": "string",
1788 "description": "Unique identifier of Database object.",
1789 "hidden": true
1790 },
1791 {
1792 "id": "Database",
1793 "type": "object",
1794 "description": "Database object.",
1795 "hidden": true,
1796 "properties": [
1797 { "name": "id", "$ref": "DatabaseId", "description": "Databa se ID." },
1798 { "name": "domain", "type": "string", "description": "Databa se domain." },
1799 { "name": "name", "type": "string", "description": "Database name." },
1800 { "name": "version", "type": "string", "description": "Datab ase version." }
1801 ]
1802 },
1803 {
1804 "id": "Error",
1805 "type": "object",
1806 "description": "Database error.",
1807 "properties": [
1808 { "name": "message", "type": "string", "description": "Error message." },
1809 { "name": "code", "type": "integer", "description": "Error c ode." }
1810 ]
1811 }
1812 ],
1813 "commands": [
1814 {
1815 "name": "enable",
1816 "description": "Enables database tracking, database events will now be delivered to the client."
1817 },
1818 {
1819 "name": "disable",
1820 "description": "Disables database tracking, prevents database ev ents from being sent to the client."
1821 },
1822 {
1823 "name": "getDatabaseTableNames",
1824 "parameters": [
1825 { "name": "databaseId", "$ref": "DatabaseId" }
1826 ],
1827 "returns": [
1828 { "name": "tableNames", "type": "array", "items": { "type": "string" } }
1829 ]
1830 },
1831 {
1832 "name": "executeSQL",
1833 "async": true,
1834 "parameters": [
1835 { "name": "databaseId", "$ref": "DatabaseId" },
1836 { "name": "query", "type": "string" }
1837 ],
1838 "returns": [
1839 { "name": "columnNames", "type": "array", "optional": true, "items": { "type": "string" } },
1840 { "name": "values", "type": "array", "optional": true, "item s": { "type": "any" }},
1841 { "name": "sqlError", "$ref": "Error", "optional": true }
1842 ]
1843 }
1844 ],
1845 "events": [
1846 {
1847 "name": "addDatabase",
1848 "parameters": [
1849 { "name": "database", "$ref": "Database" }
1850 ]
1851 }
1852 ]
1853 },
1854 {
1855 "domain": "IndexedDB",
1856 "hidden": true,
1857 "types": [
1858 {
1859 "id": "DatabaseWithObjectStores",
1860 "type": "object",
1861 "description": "Database with an array of object stores.",
1862 "properties": [
1863 { "name": "name", "type": "string", "description": "Database name." },
1864 { "name": "version", "type": "integer", "description": "Data base version." },
1865 { "name": "objectStores", "type": "array", "items": { "$ref" : "ObjectStore" }, "description": "Object stores in this database." }
1866 ]
1867 },
1868 {
1869 "id": "ObjectStore",
1870 "type": "object",
1871 "description": "Object store.",
1872 "properties": [
1873 { "name": "name", "type": "string", "description": "Object s tore name." },
1874 { "name": "keyPath", "$ref": "KeyPath", "description": "Obje ct store key path." },
1875 { "name": "autoIncrement", "type": "boolean", "description": "If true, object store has auto increment flag set." },
1876 { "name": "indexes", "type": "array", "items": { "$ref": "Ob jectStoreIndex" }, "description": "Indexes in this object store." }
1877 ]
1878 },
1879 {
1880 "id": "ObjectStoreIndex",
1881 "type": "object",
1882 "description": "Object store index.",
1883 "properties": [
1884 { "name": "name", "type": "string", "description": "Index na me." },
1885 { "name": "keyPath", "$ref": "KeyPath", "description": "Inde x key path." },
1886 { "name": "unique", "type": "boolean", "description": "If tr ue, index is unique." },
1887 { "name": "multiEntry", "type": "boolean", "description": "I f true, index allows multiple entries for a key." }
1888 ]
1889 },
1890 {
1891 "id": "Key",
1892 "type": "object",
1893 "description": "Key.",
1894 "properties": [
1895 { "name": "type", "type": "string", "enum": ["number", "stri ng", "date", "array"], "description": "Key type." },
1896 { "name": "number", "type": "number", "optional": true, "des cription": "Number value." },
1897 { "name": "string", "type": "string", "optional": true, "des cription": "String value." },
1898 { "name": "date", "type": "number", "optional": true, "descr iption": "Date value." },
1899 { "name": "array", "type": "array", "optional": true, "items ": { "$ref": "Key" }, "description": "Array value." }
1900 ]
1901 },
1902 {
1903 "id": "KeyRange",
1904 "type": "object",
1905 "description": "Key range.",
1906 "properties": [
1907 { "name": "lower", "$ref": "Key", "optional": true, "descrip tion": "Lower bound." },
1908 { "name": "upper", "$ref": "Key", "optional": true, "descrip tion": "Upper bound." },
1909 { "name": "lowerOpen", "type": "boolean", "description": "If true lower bound is open." },
1910 { "name": "upperOpen", "type": "boolean", "description": "If true upper bound is open." }
1911 ]
1912 },
1913 {
1914 "id": "DataEntry",
1915 "type": "object",
1916 "description": "Data entry.",
1917 "properties": [
1918 { "name": "key", "type": "string", "description": "JSON-stri ngified key object." },
1919 { "name": "primaryKey", "type": "string", "description": "JS ON-stringified primary key object." },
1920 { "name": "value", "type": "string", "description": "JSON-st ringified value object." }
1921 ]
1922 },
1923 {
1924 "id": "KeyPath",
1925 "type": "object",
1926 "description": "Key path.",
1927 "properties": [
1928 { "name": "type", "type": "string", "enum": ["null", "string ", "array"], "description": "Key path type." },
1929 { "name": "string", "type": "string", "optional": true, "des cription": "String value." },
1930 { "name": "array", "type": "array", "optional": true, "items ": { "type": "string" }, "description": "Array value." }
1931 ]
1932 }
1933 ],
1934 "commands": [
1935 {
1936 "name": "enable",
1937 "description": "Enables events from backend."
1938 },
1939 {
1940 "name": "disable",
1941 "description": "Disables events from backend."
1942 },
1943 {
1944 "name": "requestDatabaseNames",
1945 "async": true,
1946 "parameters": [
1947 { "name": "securityOrigin", "type": "string", "description": "Security origin." }
1948 ],
1949 "returns": [
1950 { "name": "databaseNames", "type": "array", "items": { "type ": "string" }, "description": "Database names for origin." }
1951 ],
1952 "description": "Requests database names for given security origi n."
1953 },
1954 {
1955 "name": "requestDatabase",
1956 "async": true,
1957 "parameters": [
1958 { "name": "securityOrigin", "type": "string", "description": "Security origin." },
1959 { "name": "databaseName", "type": "string", "description": " Database name." }
1960 ],
1961 "returns": [
1962 { "name": "databaseWithObjectStores", "$ref": "DatabaseWithO bjectStores", "description": "Database with an array of object stores." }
1963 ],
1964 "description": "Requests database with given name in given frame ."
1965 },
1966 {
1967 "name": "requestData",
1968 "async": true,
1969 "parameters": [
1970 { "name": "securityOrigin", "type": "string", "description": "Security origin." },
1971 { "name": "databaseName", "type": "string", "description": " Database name." },
1972 { "name": "objectStoreName", "type": "string", "description" : "Object store name." },
1973 { "name": "indexName", "type": "string", "description": "Ind ex name, empty string for object store data requests." },
1974 { "name": "skipCount", "type": "integer", "description": "Nu mber of records to skip." },
1975 { "name": "pageSize", "type": "integer", "description": "Num ber of records to fetch." },
1976 { "name": "keyRange", "$ref": "KeyRange", "optional": true, "description": "Key range." }
1977 ],
1978 "returns": [
1979 { "name": "objectStoreDataEntries", "type": "array", "items" : { "$ref": "DataEntry" }, "description": "Array of object store data entries." },
1980 { "name": "hasMore", "type": "boolean", "description": "If t rue, there are more entries to fetch in the given range." }
1981 ],
1982 "description": "Requests data from object store or index."
1983 },
1984 {
1985 "name": "clearObjectStore",
1986 "async": true,
1987 "parameters": [
1988 { "name": "securityOrigin", "type": "string", "description": "Security origin." },
1989 { "name": "databaseName", "type": "string", "description": " Database name." },
1990 { "name": "objectStoreName", "type": "string", "description" : "Object store name." }
1991 ],
1992 "returns": [
1993 ],
1994 "description": "Clears all entries from an object store."
1995 }
1996 ]
1997 },
1998 {
1999 "domain": "CacheStorage",
2000 "hidden": true,
2001 "types": [
2002 {
2003 "id": "CacheId",
2004 "type": "string",
2005 "description": "Unique identifier of the Cache object."
2006 },
2007 {
2008 "id": "DataEntry",
2009 "type": "object",
2010 "description": "Data entry.",
2011 "properties": [
2012 { "name": "request", "type": "string", "description": "Reque st url spec." },
2013 { "name": "response", "type": "string", "description": "Resp onse stataus text." }
2014 ]
2015 },
2016 {
2017 "id": "Cache",
2018 "type": "object",
2019 "description": "Cache identifier.",
2020 "properties": [
2021 { "name": "cacheId", "$ref": "CacheId", "description": "An o paque unique id of the cache." },
2022 { "name": "securityOrigin", "type": "string", "description": "Security origin of the cache." },
2023 { "name": "cacheName", "type": "string", "description": "The name of the cache." }
2024 ]
2025 }
2026 ],
2027 "commands": [
2028 {
2029 "name": "requestCacheNames",
2030 "async": true,
2031 "parameters": [
2032 { "name": "securityOrigin", "type": "string", "description": "Security origin." }
2033 ],
2034 "returns": [
2035 { "name": "caches", "type": "array", "items": { "$ref": "Cac he" }, "description": "Caches for the security origin." }
2036 ],
2037 "description": "Requests cache names."
2038 },
2039 {
2040 "name": "requestEntries",
2041 "async": true,
2042 "parameters": [
2043 { "name": "cacheId", "$ref": "CacheId", "description": "ID o f cache to get entries from." },
2044 { "name": "skipCount", "type": "integer", "description": "Nu mber of records to skip." },
2045 { "name": "pageSize", "type": "integer", "description": "Num ber of records to fetch." }
2046 ],
2047 "returns": [
2048 { "name": "cacheDataEntries", "type": "array", "items": { "$ ref": "DataEntry" }, "description": "Array of object store data entries." },
2049 { "name": "hasMore", "type": "boolean", "description": "If t rue, there are more entries to fetch in the given range." }
2050 ],
2051 "description": "Requests data from cache."
2052 },
2053 {
2054 "name": "deleteCache",
2055 "async": true,
2056 "parameters": [
2057 { "name": "cacheId", "$ref": "CacheId", "description": "Id o f cache for deletion." }
2058 ],
2059 "description": "Deletes a cache."
2060 },
2061 {
2062 "name": "deleteEntry",
2063 "async": true,
2064 "parameters": [
2065 { "name": "cacheId", "$ref": "CacheId", "description": "Id o f cache where the entry will be deleted." },
2066 { "name": "request", "type": "string", "description": "URL s pec of the request." }
2067 ],
2068 "description": "Deletes a cache entry."
2069 }
2070 ]
2071 },
2072 {
2073 "domain": "DOMStorage",
2074 "hidden": true,
2075 "description": "Query and modify DOM storage.",
2076 "types": [
2077 {
2078 "id": "StorageId",
2079 "type": "object",
2080 "description": "DOM Storage identifier.",
2081 "hidden": true,
2082 "properties": [
2083 { "name": "securityOrigin", "type": "string", "description": "Security origin for the storage." },
2084 { "name": "isLocalStorage", "type": "boolean", "description" : "Whether the storage is local storage (not session storage)." }
2085 ]
2086 },
2087 {
2088 "id": "Item",
2089 "type": "array",
2090 "description": "DOM Storage item.",
2091 "hidden": true,
2092 "items": { "type": "string" }
2093 }
2094 ],
2095 "commands": [
2096 {
2097 "name": "enable",
2098 "description": "Enables storage tracking, storage events will no w be delivered to the client."
2099 },
2100 {
2101 "name": "disable",
2102 "description": "Disables storage tracking, prevents storage even ts from being sent to the client."
2103 },
2104 {
2105 "name": "getDOMStorageItems",
2106 "parameters": [
2107 { "name": "storageId", "$ref": "StorageId" }
2108 ],
2109 "returns": [
2110 { "name": "entries", "type": "array", "items": { "$ref": "It em" } }
2111 ]
2112 },
2113 {
2114 "name": "setDOMStorageItem",
2115 "parameters": [
2116 { "name": "storageId", "$ref": "StorageId" },
2117 { "name": "key", "type": "string" },
2118 { "name": "value", "type": "string" }
2119 ]
2120 },
2121 {
2122 "name": "removeDOMStorageItem",
2123 "parameters": [
2124 { "name": "storageId", "$ref": "StorageId" },
2125 { "name": "key", "type": "string" }
2126 ]
2127 }
2128 ],
2129 "events": [
2130 {
2131 "name": "domStorageItemsCleared",
2132 "parameters": [
2133 { "name": "storageId", "$ref": "StorageId" }
2134 ]
2135 },
2136 {
2137 "name": "domStorageItemRemoved",
2138 "parameters": [
2139 { "name": "storageId", "$ref": "StorageId" },
2140 { "name": "key", "type": "string" }
2141 ]
2142 },
2143 {
2144 "name": "domStorageItemAdded",
2145 "parameters": [
2146 { "name": "storageId", "$ref": "StorageId" },
2147 { "name": "key", "type": "string" },
2148 { "name": "newValue", "type": "string" }
2149 ]
2150 },
2151 {
2152 "name": "domStorageItemUpdated",
2153 "parameters": [
2154 { "name": "storageId", "$ref": "StorageId" },
2155 { "name": "key", "type": "string" },
2156 { "name": "oldValue", "type": "string" },
2157 { "name": "newValue", "type": "string" }
2158 ]
2159 }
2160 ]
2161 },
2162 {
2163 "domain": "ApplicationCache",
2164 "hidden": true,
2165 "types": [
2166 {
2167 "id": "ApplicationCacheResource",
2168 "type": "object",
2169 "description": "Detailed application cache resource information. ",
2170 "properties": [
2171 { "name": "url", "type": "string", "description": "Resource url." },
2172 { "name": "size", "type": "integer", "description": "Resourc e size." },
2173 { "name": "type", "type": "string", "description": "Resource type." }
2174 ]
2175 },
2176 {
2177 "id": "ApplicationCache",
2178 "type": "object",
2179 "description": "Detailed application cache information.",
2180 "properties": [
2181 { "name": "manifestURL", "type": "string", "description": "M anifest URL." },
2182 { "name": "size", "type": "number", "description": "Applicat ion cache size." },
2183 { "name": "creationTime", "type": "number", "description": " Application cache creation time." },
2184 { "name": "updateTime", "type": "number", "description": "Ap plication cache update time." },
2185 { "name": "resources", "type": "array", "items": { "$ref": " ApplicationCacheResource" }, "description": "Application cache resources." }
2186 ]
2187 },
2188 {
2189 "id": "FrameWithManifest",
2190 "type": "object",
2191 "description": "Frame identifier - manifest URL pair.",
2192 "properties": [
2193 { "name": "frameId", "$ref": "Page.FrameId", "description": "Frame identifier." },
2194 { "name": "manifestURL", "type": "string", "description": "M anifest URL." },
2195 { "name": "status", "type": "integer", "description": "Appli cation cache status." }
2196 ]
2197 }
2198 ],
2199 "commands": [
2200 {
2201 "name": "getFramesWithManifests",
2202 "returns": [
2203 { "name": "frameIds", "type": "array", "items": { "$ref": "F rameWithManifest" }, "description": "Array of frame identifiers with manifest ur ls for each frame containing a document associated with some application cache." }
2204 ],
2205 "description": "Returns array of frame identifiers with manifest urls for each frame containing a document associated with some application cach e."
2206 },
2207 {
2208 "name": "enable",
2209 "description": "Enables application cache domain notifications."
2210 },
2211 {
2212 "name": "getManifestForFrame",
2213 "parameters": [
2214 { "name": "frameId", "$ref": "Page.FrameId", "description": "Identifier of the frame containing document whose manifest is retrieved." }
2215 ],
2216 "returns": [
2217 { "name": "manifestURL", "type": "string", "description": "M anifest URL for document in the given frame." }
2218 ],
2219 "description": "Returns manifest URL for document in the given f rame."
2220 },
2221 {
2222 "name": "getApplicationCacheForFrame",
2223 "parameters": [
2224 { "name": "frameId", "$ref": "Page.FrameId", "description": "Identifier of the frame containing document whose application cache is retrieve d." }
2225 ],
2226 "returns": [
2227 { "name": "applicationCache", "$ref": "ApplicationCache", "d escription": "Relevant application cache data for the document in given frame." }
2228 ],
2229 "description": "Returns relevant application cache data for the document in given frame."
2230 }
2231 ],
2232 "events": [
2233 {
2234 "name": "applicationCacheStatusUpdated",
2235 "parameters": [
2236 { "name": "frameId", "$ref": "Page.FrameId", "description": "Identifier of the frame containing document whose application cache updated sta tus." },
2237 { "name": "manifestURL", "type": "string", "description": "M anifest URL." },
2238 { "name": "status", "type": "integer", "description": "Updat ed application cache status." }
2239 ]
2240 },
2241 {
2242 "name": "networkStateUpdated",
2243 "parameters": [
2244 { "name": "isNowOnline", "type": "boolean" }
2245 ]
2246 }
2247 ]
2248 },
2249 {
2250 "domain": "DOM",
2251 "description": "This domain exposes DOM read/write operations. Each DOM Node is represented with its mirror object that has an <code>id</code>. This <co de>id</code> can be used to get additional information on the Node, resolve it i nto 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 i s 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 corres ponding document elements as their child nodes.</p>",
2252 "dependencies": ["Runtime"],
2253 "types": [
2254 {
2255 "id": "NodeId",
2256 "type": "integer",
2257 "description": "Unique DOM node identifier."
2258 },
2259 {
2260 "id": "BackendNodeId",
2261 "type": "integer",
2262 "description": "Unique DOM node identifier used to reference a n ode that may not have been pushed to the front-end.",
2263 "hidden": true
2264 },
2265 {
2266 "id": "BackendNode",
2267 "type": "object",
2268 "properties": [
2269 { "name": "nodeType", "type": "integer", "description": "<co de>Node</code>'s nodeType." },
2270 { "name": "nodeName", "type": "string", "description": "<cod e>Node</code>'s nodeName." },
2271 { "name": "backendNodeId", "$ref": "BackendNodeId" }
2272 ],
2273 "hidden": true,
2274 "description": "Backend node with a friendly name."
2275 },
2276 {
2277 "id": "PseudoType",
2278 "type": "string",
2279 "enum": [
2280 "first-line",
2281 "first-letter",
2282 "before",
2283 "after",
2284 "backdrop",
2285 "selection",
2286 "first-line-inherited",
2287 "scrollbar",
2288 "scrollbar-thumb",
2289 "scrollbar-button",
2290 "scrollbar-track",
2291 "scrollbar-track-piece",
2292 "scrollbar-corner",
2293 "resizer",
2294 "input-list-button"
2295 ],
2296 "description": "Pseudo element type."
2297 },
2298 {
2299 "id": "ShadowRootType",
2300 "type": "string",
2301 "enum": ["user-agent", "open", "closed"],
2302 "description": "Shadow root type."
2303 },
2304 {
2305 "id": "Node",
2306 "type": "object",
2307 "properties": [
2308 { "name": "nodeId", "$ref": "NodeId", "description": "Node i dentifier 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 clie nt." },
2309 { "name": "nodeType", "type": "integer", "description": "<co de>Node</code>'s nodeType." },
2310 { "name": "nodeName", "type": "string", "description": "<cod e>Node</code>'s nodeName." },
2311 { "name": "localName", "type": "string", "description": "<co de>Node</code>'s localName." },
2312 { "name": "nodeValue", "type": "string", "description": "<co de>Node</code>'s nodeValue." },
2313 { "name": "childNodeCount", "type": "integer", "optional": t rue, "description": "Child count for <code>Container</code> nodes." },
2314 { "name": "children", "type": "array", "optional": true, "it ems": { "$ref": "Node" }, "description": "Child nodes of this node when requeste d with children." },
2315 { "name": "attributes", "type": "array", "optional": true, " items": { "type": "string" }, "description": "Attributes of the <code>Element</c ode> node in the form of flat array <code>[name1, value1, name2, value2]</code>. " },
2316 { "name": "documentURL", "type": "string", "optional": true, "description": "Document URL that <code>Document</code> or <code>FrameOwner</co de> node points to." },
2317 { "name": "baseURL", "type": "string", "optional": true, "de scription": "Base URL that <code>Document</code> or <code>FrameOwner</code> node uses for URL completion.", "hidden": true },
2318 { "name": "publicId", "type": "string", "optional": true, "d escription": "<code>DocumentType</code>'s publicId." },
2319 { "name": "systemId", "type": "string", "optional": true, "d escription": "<code>DocumentType</code>'s systemId." },
2320 { "name": "internalSubset", "type": "string", "optional": tr ue, "description": "<code>DocumentType</code>'s internalSubset." },
2321 { "name": "xmlVersion", "type": "string", "optional": true, "description": "<code>Document</code>'s XML version in case of XML documents." } ,
2322 { "name": "name", "type": "string", "optional": true, "descr iption": "<code>Attr</code>'s name." },
2323 { "name": "value", "type": "string", "optional": true, "desc ription": "<code>Attr</code>'s value." },
2324 { "name": "pseudoType", "$ref": "PseudoType", "optional": tr ue, "description": "Pseudo element type for this node." },
2325 { "name": "shadowRootType", "$ref": "ShadowRootType", "optio nal": true, "description": "Shadow root type." },
2326 { "name": "frameId", "$ref": "Page.FrameId", "optional": tru e, "description": "Frame ID for frame owner elements.", "hidden": true },
2327 { "name": "contentDocument", "$ref": "Node", "optional": tru e, "description": "Content document for frame owner elements." },
2328 { "name": "shadowRoots", "type": "array", "optional": true, "items": { "$ref": "Node" }, "description": "Shadow root list for given element host.", "hidden": true },
2329 { "name": "templateContent", "$ref": "Node", "optional": tru e, "description": "Content document fragment for template elements.", "hidden": true },
2330 { "name": "pseudoElements", "type": "array", "items": { "$re f": "Node" }, "optional": true, "description": "Pseudo elements associated with this node.", "hidden": true },
2331 { "name": "importedDocument", "$ref": "Node", "optional": tr ue, "description": "Import document for the HTMLImport links." },
2332 { "name": "distributedNodes", "type": "array", "items": { "$ ref": "BackendNode" }, "optional": true, "description": "Distributed nodes for g iven insertion point.", "hidden": true }
2333 ],
2334 "description": "DOM interaction is implemented in terms of mirro r objects that represent the actual DOM nodes. DOMNode is a base node mirror typ e."
2335 },
2336 {
2337 "id": "RGBA",
2338 "type": "object",
2339 "properties": [
2340 { "name": "r", "type": "integer", "description": "The red co mponent, in the [0-255] range." },
2341 { "name": "g", "type": "integer", "description": "The green component, in the [0-255] range." },
2342 { "name": "b", "type": "integer", "description": "The blue c omponent, in the [0-255] range." },
2343 { "name": "a", "type": "number", "optional": true, "descript ion": "The alpha component, in the [0-1] range (default: 1)." }
2344 ],
2345 "description": "A structure holding an RGBA color."
2346 },
2347 {
2348 "id": "Quad",
2349 "type": "array",
2350 "items": { "type": "number" },
2351 "minItems": 8,
2352 "maxItems": 8,
2353 "description": "An array of quad vertices, x immediately followe d by y for each point, points clock-wise.",
2354 "hidden": true
2355 },
2356 {
2357 "id": "BoxModel",
2358 "type": "object",
2359 "hidden": true,
2360 "properties": [
2361 { "name": "content", "$ref": "Quad", "description": "Content box" },
2362 { "name": "padding", "$ref": "Quad", "description": "Padding box" },
2363 { "name": "border", "$ref": "Quad", "description": "Border b ox" },
2364 { "name": "margin", "$ref": "Quad", "description": "Margin b ox" },
2365 { "name": "width", "type": "integer", "description": "Node w idth" },
2366 { "name": "height", "type": "integer", "description": "Node height" },
2367 { "name": "shapeOutside", "$ref": "ShapeOutsideInfo", "optio nal": true, "description": "Shape outside coordinates" }
2368 ],
2369 "description": "Box model."
2370 },
2371 {
2372 "id": "ShapeOutsideInfo",
2373 "type": "object",
2374 "hidden": true,
2375 "properties": [
2376 { "name": "bounds", "$ref": "Quad", "description": "Shape bo unds" },
2377 { "name": "shape", "type": "array", "items": { "type": "any" }, "description": "Shape coordinate details" },
2378 { "name": "marginShape", "type": "array", "items": { "type": "any"}, "description": "Margin shape bounds" }
2379 ],
2380 "description": "CSS Shape Outside details."
2381 },
2382 {
2383 "id": "Rect",
2384 "type": "object",
2385 "hidden": true,
2386 "properties": [
2387 { "name": "x", "type": "number", "description": "X coordinat e" },
2388 { "name": "y", "type": "number", "description": "Y coordinat e" },
2389 { "name": "width", "type": "number", "description": "Rectang le width" },
2390 { "name": "height", "type": "number", "description": "Rectan gle height" }
2391 ],
2392 "description": "Rectangle."
2393 },
2394 {
2395 "id": "HighlightConfig",
2396 "type": "object",
2397 "properties": [
2398 { "name": "showInfo", "type": "boolean", "optional": true, " description": "Whether the node info tooltip should be shown (default: false)." },
2399 { "name": "showRulers", "type": "boolean", "optional": true, "description": "Whether the rulers should be shown (default: false)." },
2400 { "name": "showExtensionLines", "type": "boolean", "optional ": true, "description": "Whether the extension lines from node to the rulers sho uld be shown (default: false)." },
2401 { "name": "displayAsMaterial", "type": "boolean", "optional" : true, "hidden": true},
2402 { "name": "contentColor", "$ref": "RGBA", "optional": true, "description": "The content box highlight fill color (default: transparent)." },
2403 { "name": "paddingColor", "$ref": "RGBA", "optional": true, "description": "The padding highlight fill color (default: transparent)." },
2404 { "name": "borderColor", "$ref": "RGBA", "optional": true, " description": "The border highlight fill color (default: transparent)." },
2405 { "name": "marginColor", "$ref": "RGBA", "optional": true, " description": "The margin highlight fill color (default: transparent)." },
2406 { "name": "eventTargetColor", "$ref": "RGBA", "optional": tr ue, "hidden": true, "description": "The event target element highlight fill colo r (default: transparent)." },
2407 { "name": "shapeColor", "$ref": "RGBA", "optional": true, "h idden": true, "description": "The shape outside fill color (default: transparent )." },
2408 { "name": "shapeMarginColor", "$ref": "RGBA", "optional": tr ue, "hidden": true, "description": "The shape margin fill color (default: transp arent)." },
2409 { "name": "selectorList", "type": "string", "optional": true , "description": "Selectors to highlight relevant nodes."}
2410 ],
2411 "description": "Configuration data for the highlighting of page elements."
2412 },
2413 {
2414 "id": "InspectMode",
2415 "type": "string",
2416 "hidden": true,
2417 "enum": [
2418 "searchForNode",
2419 "searchForUAShadowDOM",
2420 "showLayoutEditor",
2421 "none"
2422 ]
2423 }
2424 ],
2425 "commands": [
2426 {
2427 "name": "enable",
2428 "description": "Enables DOM agent for the given page."
2429 },
2430 {
2431 "name": "disable",
2432 "description": "Disables DOM agent for the given page."
2433 },
2434 {
2435 "name": "getDocument",
2436 "returns": [
2437 { "name": "root", "$ref": "Node", "description": "Resulting node." }
2438 ],
2439 "description": "Returns the root DOM node to the caller."
2440 },
2441 {
2442 "name": "requestChildNodes",
2443 "parameters": [
2444 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to get children for." },
2445 { "name": "depth", "type": "integer", "optional": true, "des cription": "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 }
2446 ],
2447 "description": "Requests that children of the node with given id are returned to the caller in form of <code>setChildNodes</code> events where n ot only immediate children are retrieved, but all children down to the specified depth."
2448 },
2449 {
2450 "name": "querySelector",
2451 "parameters": [
2452 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to query upon." },
2453 { "name": "selector", "type": "string", "description": "Sele ctor string." }
2454 ],
2455 "returns": [
2456 { "name": "nodeId", "$ref": "NodeId", "description": "Query selector result." }
2457 ],
2458 "description": "Executes <code>querySelector</code> on a given n ode."
2459 },
2460 {
2461 "name": "querySelectorAll",
2462 "parameters": [
2463 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to query upon." },
2464 { "name": "selector", "type": "string", "description": "Sele ctor string." }
2465 ],
2466 "returns": [
2467 { "name": "nodeIds", "type": "array", "items": { "$ref": "No deId" }, "description": "Query selector result." }
2468 ],
2469 "description": "Executes <code>querySelectorAll</code> on a give n node."
2470 },
2471 {
2472 "name": "setNodeName",
2473 "parameters": [
2474 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to set name for." },
2475 { "name": "name", "type": "string", "description": "New node 's name." }
2476 ],
2477 "returns": [
2478 { "name": "nodeId", "$ref": "NodeId", "description": "New no de's id." }
2479 ],
2480 "description": "Sets node name for a node with given id."
2481 },
2482 {
2483 "name": "setNodeValue",
2484 "parameters": [
2485 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to set value for." },
2486 { "name": "value", "type": "string", "description": "New nod e's value." }
2487 ],
2488 "description": "Sets node value for a node with given id."
2489 },
2490 {
2491 "name": "removeNode",
2492 "parameters": [
2493 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to remove." }
2494 ],
2495 "description": "Removes node with given id."
2496 },
2497 {
2498 "name": "setAttributeValue",
2499 "parameters": [
2500 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the element to set attribute for." },
2501 { "name": "name", "type": "string", "description": "Attribut e name." },
2502 { "name": "value", "type": "string", "description": "Attribu te value." }
2503 ],
2504 "description": "Sets attribute for an element with given id."
2505 },
2506 {
2507 "name": "setAttributesAsText",
2508 "parameters": [
2509 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the element to set attributes for." },
2510 { "name": "text", "type": "string", "description": "Text wit h a number of attributes. Will parse this text using HTML parser." },
2511 { "name": "name", "type": "string", "optional": true, "descr iption": "Attribute name to replace with new attributes derived from text in cas e text parsed successfully." }
2512 ],
2513 "description": "Sets attributes on element with given id. This m ethod is useful when user edits some existing attribute value and types in sever al attribute name/value pairs."
2514 },
2515 {
2516 "name": "removeAttribute",
2517 "parameters": [
2518 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the element to remove attribute from." },
2519 { "name": "name", "type": "string", "description": "Name of the attribute to remove." }
2520 ],
2521 "description": "Removes attribute with given name from an elemen t with given id."
2522 },
2523 {
2524 "name": "getOuterHTML",
2525 "parameters": [
2526 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to get markup for." }
2527 ],
2528 "returns": [
2529 { "name": "outerHTML", "type": "string", "description": "Out er HTML markup." }
2530 ],
2531 "description": "Returns node's HTML markup."
2532 },
2533 {
2534 "name": "setOuterHTML",
2535 "parameters": [
2536 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to set markup for." },
2537 { "name": "outerHTML", "type": "string", "description": "Out er HTML markup to set." }
2538 ],
2539 "description": "Sets node HTML markup, returns new node id."
2540 },
2541 {
2542 "name": "performSearch",
2543 "parameters": [
2544 { "name": "query", "type": "string", "description": "Plain t ext or query selector or XPath search query." },
2545 { "name": "includeUserAgentShadowDOM", "type": "boolean", "o ptional": true, "description": "True to search in user agent shadow DOM.", "hidd en": true }
2546 ],
2547 "returns": [
2548 { "name": "searchId", "type": "string", "description": "Uniq ue search session identifier." },
2549 { "name": "resultCount", "type": "integer", "description": " Number of search results." }
2550 ],
2551 "description": "Searches for a given string in the DOM tree. Use <code>getSearchResults</code> to access search results or <code>cancelSearch</c ode> to end this search session.",
2552 "hidden": true
2553 },
2554 {
2555 "name": "getSearchResults",
2556 "parameters": [
2557 { "name": "searchId", "type": "string", "description": "Uniq ue search session identifier." },
2558 { "name": "fromIndex", "type": "integer", "description": "St art index of the search result to be returned." },
2559 { "name": "toIndex", "type": "integer", "description": "End index of the search result to be returned." }
2560 ],
2561 "returns": [
2562 { "name": "nodeIds", "type": "array", "items": { "$ref": "No deId" }, "description": "Ids of the search result nodes." }
2563 ],
2564 "description": "Returns search results from given <code>fromInde x</code> to given <code>toIndex</code> from the sarch with the given identifier. ",
2565 "hidden": true
2566 },
2567 {
2568 "name": "discardSearchResults",
2569 "parameters": [
2570 { "name": "searchId", "type": "string", "description": "Uniq ue search session identifier." }
2571 ],
2572 "description": "Discards search results from the session with th e given id. <code>getSearchResults</code> should no longer be called for that se arch.",
2573 "hidden": true
2574 },
2575 {
2576 "name": "requestNode",
2577 "parameters": [
2578 { "name": "objectId", "$ref": "Runtime.RemoteObjectId", "des cription": "JavaScript object id to convert into node." }
2579 ],
2580 "returns": [
2581 { "name": "nodeId", "$ref": "NodeId", "description": "Node i d for given object." }
2582 ],
2583 "description": "Requests that the node is sent to the caller giv en the JavaScript node object reference. All nodes that form the path from the n ode to the root are also sent to the client as a series of <code>setChildNodes</ code> notifications."
2584 },
2585 {
2586 "name": "setInspectMode",
2587 "hidden": true,
2588 "parameters": [
2589 { "name": "mode", "$ref": "InspectMode", "description": "Set an inspection mode." },
2590 { "name": "highlightConfig", "$ref": "HighlightConfig", "opt ional": true, "description": "A descriptor for the highlight appearance of hover ed-over nodes. May be omitted if <code>enabled == false</code>." }
2591 ],
2592 "description": "Enters the 'inspect' mode. In this mode, element s that user is hovering over are highlighted. Backend then generates 'inspectNod eRequested' event upon element selection."
2593 },
2594 {
2595 "name": "highlightRect",
2596 "parameters": [
2597 { "name": "x", "type": "integer", "description": "X coordina te" },
2598 { "name": "y", "type": "integer", "description": "Y coordina te" },
2599 { "name": "width", "type": "integer", "description": "Rectan gle width" },
2600 { "name": "height", "type": "integer", "description": "Recta ngle height" },
2601 { "name": "color", "$ref": "RGBA", "optional": true, "descri ption": "The highlight fill color (default: transparent)." },
2602 { "name": "outlineColor", "$ref": "RGBA", "optional": true, "description": "The highlight outline color (default: transparent)." }
2603 ],
2604 "description": "Highlights given rectangle. Coordinates are abso lute with respect to the main frame viewport."
2605 },
2606 {
2607 "name": "highlightQuad",
2608 "parameters": [
2609 { "name": "quad", "$ref": "Quad", "description": "Quad to hi ghlight" },
2610 { "name": "color", "$ref": "RGBA", "optional": true, "descri ption": "The highlight fill color (default: transparent)." },
2611 { "name": "outlineColor", "$ref": "RGBA", "optional": true, "description": "The highlight outline color (default: transparent)." }
2612 ],
2613 "description": "Highlights given quad. Coordinates are absolute with respect to the main frame viewport.",
2614 "hidden": true
2615 },
2616 {
2617 "name": "highlightNode",
2618 "parameters": [
2619 { "name": "highlightConfig", "$ref": "HighlightConfig", "de scription": "A descriptor for the highlight appearance." },
2620 { "name": "nodeId", "$ref": "NodeId", "optional": true, "des cription": "Identifier of the node to highlight." },
2621 { "name": "backendNodeId", "$ref": "BackendNodeId", "optiona l": true, "description": "Identifier of the backend node to highlight." },
2622 { "name": "objectId", "$ref": "Runtime.RemoteObjectId", "opt ional": true, "description": "JavaScript object id of the node to be highlighted .", "hidden": true }
2623 ],
2624 "description": "Highlights DOM node with given id or with the gi ven JavaScript object wrapper. Either nodeId or objectId must be specified."
2625 },
2626 {
2627 "name": "hideHighlight",
2628 "description": "Hides DOM node highlight."
2629 },
2630 {
2631 "name": "highlightFrame",
2632 "parameters": [
2633 { "name": "frameId", "$ref": "Page.FrameId", "description": "Identifier of the frame to highlight." },
2634 { "name": "contentColor", "$ref": "RGBA", "optional": true, "description": "The content box highlight fill color (default: transparent)." },
2635 { "name": "contentOutlineColor", "$ref": "RGBA", "optional": true, "description": "The content box highlight outline color (default: transpa rent)." }
2636 ],
2637 "description": "Highlights owner element of the frame with given id.",
2638 "hidden": true
2639 },
2640 {
2641 "name": "pushNodeByPathToFrontend",
2642 "parameters": [
2643 { "name": "path", "type": "string", "description": "Path to node in the proprietary format." }
2644 ],
2645 "returns": [
2646 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node for given path." }
2647 ],
2648 "description": "Requests that the node is sent to the caller giv en its path. // FIXME, use XPath",
2649 "hidden": true
2650 },
2651 {
2652 "name": "pushNodesByBackendIdsToFrontend",
2653 "parameters": [
2654 { "name": "backendNodeIds", "type": "array", "items": {"$ref ": "BackendNodeId"}, "description": "The array of backend node ids." }
2655 ],
2656 "returns": [
2657 { "name": "nodeIds", "type": "array", "items": {"$ref": "Nod eId"}, "description": "The array of ids of pushed nodes that correspond to the b ackend ids specified in backendNodeIds." }
2658 ],
2659 "description": "Requests that a batch of nodes is sent to the ca ller given their backend node ids.",
2660 "hidden": true
2661 },
2662 {
2663 "name": "setInspectedNode",
2664 "parameters": [
2665 { "name": "nodeId", "$ref": "NodeId", "description": "DOM no de id to be accessible by means of $x command line API." }
2666 ],
2667 "description": "Enables console to refer to the node with given id via $x (see Command Line API for more details $x functions).",
2668 "hidden": true
2669 },
2670 {
2671 "name": "resolveNode",
2672 "parameters": [
2673 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to resolve." },
2674 { "name": "objectGroup", "type": "string", "optional": true, "description": "Symbolic group name that can be used to release multiple object s." }
2675 ],
2676 "returns": [
2677 { "name": "object", "$ref": "Runtime.RemoteObject", "descrip tion": "JavaScript object wrapper for given node." }
2678 ],
2679 "description": "Resolves JavaScript node object for given node i d."
2680 },
2681 {
2682 "name": "getAttributes",
2683 "parameters": [
2684 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to retrieve attibutes for." }
2685 ],
2686 "returns": [
2687 { "name": "attributes", "type": "array", "items": { "type": "string" }, "description": "An interleaved array of node attribute names and val ues." }
2688 ],
2689 "description": "Returns attributes for the specified node."
2690 },
2691 {
2692 "name": "copyTo",
2693 "parameters": [
2694 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to copy." },
2695 { "name": "targetNodeId", "$ref": "NodeId", "description": " Id of the element to drop the copy into." },
2696 { "name": "insertBeforeNodeId", "$ref": "NodeId", "optional" : true, "description": "Drop the copy before this node (if absent, the copy beco mes the last child of <code>targetNodeId</code>)." }
2697 ],
2698 "returns": [
2699 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node clone." }
2700 ],
2701 "description": "Creates a deep copy of the specified node and pl aces it into the target container before the given anchor.",
2702 "hidden": true
2703 },
2704 {
2705 "name": "moveTo",
2706 "parameters": [
2707 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to move." },
2708 { "name": "targetNodeId", "$ref": "NodeId", "description": " Id of the element to drop the moved node into." },
2709 { "name": "insertBeforeNodeId", "$ref": "NodeId", "optional" : true, "description": "Drop node before this one (if absent, the moved node bec omes the last child of <code>targetNodeId</code>)." }
2710 ],
2711 "returns": [
2712 { "name": "nodeId", "$ref": "NodeId", "description": "New id of the moved node." }
2713 ],
2714 "description": "Moves node into the new container, places it bef ore the given anchor."
2715 },
2716 {
2717 "name": "undo",
2718 "description": "Undoes the last performed action.",
2719 "hidden": true
2720 },
2721 {
2722 "name": "redo",
2723 "description": "Re-does the last undone action.",
2724 "hidden": true
2725 },
2726 {
2727 "name": "markUndoableState",
2728 "description": "Marks last undoable state.",
2729 "hidden": true
2730 },
2731 {
2732 "name": "focus",
2733 "parameters": [
2734 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to focus." }
2735 ],
2736 "description": "Focuses the given element.",
2737 "hidden": true
2738 },
2739 {
2740 "name": "setFileInputFiles",
2741 "parameters": [
2742 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the file input node to set files for." },
2743 { "name": "files", "type": "array", "items": { "type": "stri ng" }, "description": "Array of file paths to set." }
2744 ],
2745 "description": "Sets files for the given file input element.",
2746 "hidden": true,
2747 "handlers": ["browser", "renderer"]
2748 },
2749 {
2750 "name": "getBoxModel",
2751 "parameters": [
2752 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to get box model for." }
2753 ],
2754 "returns": [
2755 { "name": "model", "$ref": "BoxModel", "description": "Box m odel for the node." }
2756 ],
2757 "description": "Returns boxes for the currently selected nodes." ,
2758 "hidden": true
2759 },
2760 {
2761 "name": "getNodeForLocation",
2762 "parameters": [
2763 { "name": "x", "type": "integer", "description": "X coordina te." },
2764 { "name": "y", "type": "integer", "description": "Y coordina te." }
2765 ],
2766 "returns": [
2767 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node at given coordinates." }
2768 ],
2769 "description": "Returns node id at given location.",
2770 "hidden": true
2771 },
2772 {
2773 "name": "getRelayoutBoundary",
2774 "parameters": [
2775 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node." }
2776 ],
2777 "returns": [
2778 { "name": "nodeId", "$ref": "NodeId", "description": "Relayo ut boundary node id for the given node." }
2779 ],
2780 "description": "Returns the id of the nearest ancestor that is a relayout boundary.",
2781 "hidden": true
2782 },
2783 {
2784 "name": "getHighlightObjectForTest",
2785 "parameters": [
2786 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to get highlight object for." }
2787 ],
2788 "returns": [
2789 { "name": "highlight", "type": "object", "description": "Hig hlight data for the node." }
2790 ],
2791 "description": "For testing.",
2792 "hidden": true
2793 }
2794 ],
2795 "events": [
2796 {
2797 "name": "documentUpdated",
2798 "description": "Fired when <code>Document</code> has been totall y updated. Node ids are no longer valid."
2799 },
2800 {
2801 "name": "inspectNodeRequested",
2802 "parameters": [
2803 { "name": "backendNodeId", "$ref": "BackendNodeId", "descrip tion": "Id of the node to inspect." }
2804 ],
2805 "description": "Fired when the node should be inspected. This ha ppens after call to <code>setInspectMode</code>.",
2806 "hidden" : true
2807 },
2808 {
2809 "name": "setChildNodes",
2810 "parameters": [
2811 { "name": "parentId", "$ref": "NodeId", "description": "Pare nt node id to populate with children." },
2812 { "name": "nodes", "type": "array", "items": { "$ref": "Node " }, "description": "Child nodes array." }
2813 ],
2814 "description": "Fired when backend wants to provide client with the missing DOM structure. This happens upon most of the calls requesting node i ds."
2815 },
2816 {
2817 "name": "attributeModified",
2818 "parameters": [
2819 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node that has changed." },
2820 { "name": "name", "type": "string", "description": "Attribut e name." },
2821 { "name": "value", "type": "string", "description": "Attribu te value." }
2822 ],
2823 "description": "Fired when <code>Element</code>'s attribute is m odified."
2824 },
2825 {
2826 "name": "attributeRemoved",
2827 "parameters": [
2828 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node that has changed." },
2829 { "name": "name", "type": "string", "description": "A ttribu te name." }
2830 ],
2831 "description": "Fired when <code>Element</code>'s attribute is r emoved."
2832 },
2833 {
2834 "name": "inlineStyleInvalidated",
2835 "parameters": [
2836 { "name": "nodeIds", "type": "array", "items": { "$ref": "No deId" }, "description": "Ids of the nodes for which the inline styles have been invalidated." }
2837 ],
2838 "description": "Fired when <code>Element</code>'s inline style i s modified via a CSS property modification.",
2839 "hidden": true
2840 },
2841 {
2842 "name": "characterDataModified",
2843 "parameters": [
2844 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node that has changed." },
2845 { "name": "characterData", "type": "string", "description": "New text value." }
2846 ],
2847 "description": "Mirrors <code>DOMCharacterDataModified</code> ev ent."
2848 },
2849 {
2850 "name": "childNodeCountUpdated",
2851 "parameters": [
2852 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node that has changed." },
2853 { "name": "childNodeCount", "type": "integer", "description" : "New node count." }
2854 ],
2855 "description": "Fired when <code>Container</code>'s child node c ount has changed."
2856 },
2857 {
2858 "name": "childNodeInserted",
2859 "parameters": [
2860 { "name": "parentNodeId", "$ref": "NodeId", "description": " Id of the node that has changed." },
2861 { "name": "previousNodeId", "$ref": "NodeId", "description": "If of the previous siblint." },
2862 { "name": "node", "$ref": "Node", "description": "Inserted n ode data." }
2863 ],
2864 "description": "Mirrors <code>DOMNodeInserted</code> event."
2865 },
2866 {
2867 "name": "childNodeRemoved",
2868 "parameters": [
2869 { "name": "parentNodeId", "$ref": "NodeId", "description": " Parent id." },
2870 { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node that has been removed." }
2871 ],
2872 "description": "Mirrors <code>DOMNodeRemoved</code> event."
2873 },
2874 {
2875 "name": "shadowRootPushed",
2876 "parameters": [
2877 { "name": "hostId", "$ref": "NodeId", "description": "Host e lement id." },
2878 { "name": "root", "$ref": "Node", "description": "Shadow roo t." }
2879 ],
2880 "description": "Called when shadow root is pushed into the eleme nt.",
2881 "hidden": true
2882 },
2883 {
2884 "name": "shadowRootPopped",
2885 "parameters": [
2886 { "name": "hostId", "$ref": "NodeId", "description": "Host e lement id." },
2887 { "name": "rootId", "$ref": "NodeId", "description": "Shadow root id." }
2888 ],
2889 "description": "Called when shadow root is popped from the eleme nt.",
2890 "hidden": true
2891 },
2892 {
2893 "name": "pseudoElementAdded",
2894 "parameters": [
2895 { "name": "parentId", "$ref": "NodeId", "description": "Pseu do element's parent element id." },
2896 { "name": "pseudoElement", "$ref": "Node", "description": "T he added pseudo element." }
2897 ],
2898 "description": "Called when a pseudo element is added to an elem ent.",
2899 "hidden": true
2900 },
2901 {
2902 "name": "pseudoElementRemoved",
2903 "parameters": [
2904 { "name": "parentId", "$ref": "NodeId", "description": "Pseu do element's parent element id." },
2905 { "name": "pseudoElementId", "$ref": "NodeId", "description" : "The removed pseudo element id." }
2906 ],
2907 "description": "Called when a pseudo element is removed from an element.",
2908 "hidden": true
2909 },
2910 {
2911 "name": "distributedNodesUpdated",
2912 "parameters": [
2913 { "name": "insertionPointId", "$ref": "NodeId", "description ": "Insertion point where distrubuted nodes were updated." },
2914 { "name": "distributedNodes", "type": "array", "items": { "$ ref": "BackendNode" }, "description": "Distributed nodes for given insertion poi nt." }
2915 ],
2916 "description": "Called when distrubution is changed.",
2917 "hidden": true
2918 },
2919 {
2920 "name": "nodeHighlightRequested",
2921 "parameters": [
2922 {"name": "nodeId", "$ref": "NodeId"}
2923 ],
2924 "hidden": true
2925 }
2926 ]
2927 },
2928 {
2929 "domain": "CSS",
2930 "hidden": true,
2931 "description": "This domain exposes CSS read/write operations. All CSS o bjects (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 o f the <code>styleSheetAdded</code>/<code>styleSheetRemoved</code> events) and su bsequently load the required stylesheet contents using the <code>getStyleSheet[T ext]()</code> methods.",
2932 "dependencies": ["DOM"],
2933 "types": [
2934 {
2935 "id": "StyleSheetId",
2936 "type": "string"
2937 },
2938 {
2939 "id": "StyleSheetOrigin",
2940 "type": "string",
2941 "enum": ["injected", "user-agent", "inspector", "regular"],
2942 "description": "Stylesheet type: \"injected\" for stylesheets in jected via extension, \"user-agent\" for user-agent stylesheets, \"inspector\" f or stylesheets created by the inspector (i.e. those holding the \"via inspector\ " rules), \"regular\" for regular stylesheets."
2943 },
2944 {
2945 "id": "PseudoElementMatches",
2946 "type": "object",
2947 "properties": [
2948 { "name": "pseudoType", "$ref": "DOM.PseudoType", "descripti on": "Pseudo element type."},
2949 { "name": "matches", "type": "array", "items": { "$ref": "Ru leMatch" }, "description": "Matches of CSS rules applicable to the pseudo style. "}
2950 ],
2951 "description": "CSS rule collection for a single pseudo style."
2952 },
2953 {
2954 "id": "InheritedStyleEntry",
2955 "type": "object",
2956 "properties": [
2957 { "name": "inlineStyle", "$ref": "CSSStyle", "optional": tru e, "description": "The ancestor node's inline style, if any, in the style inheri tance chain." },
2958 { "name": "matchedCSSRules", "type": "array", "items": { "$r ef": "RuleMatch" }, "description": "Matches of CSS rules matching the ancestor n ode in the style inheritance chain." }
2959 ],
2960 "description": "Inherited CSS rule collection from ancestor node ."
2961 },
2962 {
2963 "id": "RuleMatch",
2964 "type": "object",
2965 "properties": [
2966 { "name": "rule", "$ref": "CSSRule", "description": "CSS rul e in the match." },
2967 { "name": "matchingSelectors", "type": "array", "items": { " type": "integer" }, "description": "Matching selector indices in the rule's sele ctorList selectors (0-based)." }
2968 ],
2969 "description": "Match data for a CSS rule."
2970 },
2971 {
2972 "id": "Value",
2973 "type": "object",
2974 "properties": [
2975 { "name": "text", "type": "string", "description": "Value te xt." },
2976 { "name": "range", "$ref": "SourceRange", "optional": true, "description": "Value range in the underlying resource (if available)." }
2977 ],
2978 "description": "Data for a simple selector (these are delimited by commas in a selector list)."
2979 },
2980 {
2981 "id": "SelectorList",
2982 "type": "object",
2983 "properties": [
2984 { "name": "selectors", "type": "array", "items": { "$ref": " Value" }, "description": "Selectors in the list." },
2985 { "name": "text", "type": "string", "description": "Rule sel ector text." }
2986 ],
2987 "description": "Selector list data."
2988 },
2989 {
2990 "id": "CSSStyleSheetHeader",
2991 "type": "object",
2992 "properties": [
2993 { "name": "styleSheetId", "$ref": "StyleSheetId", "descripti on": "The stylesheet identifier."},
2994 { "name": "frameId", "$ref": "Page.FrameId", "description": "Owner frame identifier."},
2995 { "name": "sourceURL", "type": "string", "description": "Sty lesheet resource URL."},
2996 { "name": "sourceMapURL", "type": "string", "optional": true , "description": "URL of source map associated with the stylesheet (if any)." },
2997 { "name": "origin", "$ref": "StyleSheetOrigin", "description ": "Stylesheet origin."},
2998 { "name": "title", "type": "string", "description": "Stylesh eet title."},
2999 { "name": "ownerNode", "$ref": "DOM.BackendNodeId", "optiona l": true, "description": "The backend id for the owner node of the stylesheet." },
3000 { "name": "disabled", "type": "boolean", "description": "Den otes whether the stylesheet is disabled."},
3001 { "name": "hasSourceURL", "type": "boolean", "optional": tru e, "description": "Whether the sourceURL field value comes from the sourceURL co mment." },
3002 { "name": "isInline", "type": "boolean", "description": "Whe ther this stylesheet is created for STYLE tag by parser. This flag is not set fo r document.written STYLE tags." },
3003 { "name": "startLine", "type": "number", "description": "Lin e offset of the stylesheet within the resource (zero based)." },
3004 { "name": "startColumn", "type": "number", "description": "C olumn offset of the stylesheet within the resource (zero based)." }
3005 ],
3006 "description": "CSS stylesheet metainformation."
3007 },
3008 {
3009 "id": "CSSRule",
3010 "type": "object",
3011 "properties": [
3012 { "name": "styleSheetId", "$ref": "StyleSheetId", "optional" : true, "description": "The css style sheet identifier (absent for user agent st ylesheet and user-specified stylesheet rules) this rule came from." },
3013 { "name": "selectorList", "$ref": "SelectorList", "descripti on": "Rule selector data." },
3014 { "name": "origin", "$ref": "StyleSheetOrigin", "description ": "Parent stylesheet's origin."},
3015 { "name": "style", "$ref": "CSSStyle", "description": "Assoc iated style declaration." },
3016 { "name": "media", "type": "array", "items": { "$ref": "CSSM edia" }, "optional": true, "description": "Media list array (for rules involving media queries). The array enumerates media queries starting with the innermost one, going outwards." }
3017 ],
3018 "description": "CSS rule representation."
3019 },
3020 {
3021 "id": "SourceRange",
3022 "type": "object",
3023 "properties": [
3024 { "name": "startLine", "type": "integer", "description": "St art line of range." },
3025 { "name": "startColumn", "type": "integer", "description": " Start column of range (inclusive)." },
3026 { "name": "endLine", "type": "integer", "description": "End line of range" },
3027 { "name": "endColumn", "type": "integer", "description": "En d column of range (exclusive)." }
3028 ],
3029 "description": "Text range within a resource. All numbers are ze ro-based."
3030 },
3031 {
3032 "id": "ShorthandEntry",
3033 "type": "object",
3034 "properties": [
3035 { "name": "name", "type": "string", "description": "Shorthan d name." },
3036 { "name": "value", "type": "string", "description": "Shortha nd value." },
3037 { "name": "important", "type": "boolean", "optional": true, "description": "Whether the property has \"!important\" annotation (implies <cod e>false</code> if absent)." }
3038 ]
3039 },
3040 {
3041 "id": "CSSComputedStyleProperty",
3042 "type": "object",
3043 "properties": [
3044 { "name": "name", "type": "string", "description": "Computed style property name." },
3045 { "name": "value", "type": "string", "description": "Compute d style property value." }
3046 ]
3047 },
3048 {
3049 "id": "CSSStyle",
3050 "type": "object",
3051 "properties": [
3052 { "name": "styleSheetId", "$ref": "StyleSheetId", "optional" : true, "description": "The css style sheet identifier (absent for user agent st ylesheet and user-specified stylesheet rules) this rule came from." },
3053 { "name": "cssProperties", "type": "array", "items": { "$ref ": "CSSProperty" }, "description": "CSS properties in the style." },
3054 { "name": "shorthandEntries", "type": "array", "items": { "$ ref": "ShorthandEntry" }, "description": "Computed values for all shorthands fou nd in the style." },
3055 { "name": "cssText", "type": "string", "optional": true, "de scription": "Style declaration text (if available)." },
3056 { "name": "range", "$ref": "SourceRange", "optional": true, "description": "Style declaration range in the enclosing stylesheet (if availabl e)." }
3057 ],
3058 "description": "CSS style representation."
3059 },
3060 {
3061 "id": "CSSProperty",
3062 "type": "object",
3063 "properties": [
3064 { "name": "name", "type": "string", "description": "The prop erty name." },
3065 { "name": "value", "type": "string", "description": "The pro perty value." },
3066 { "name": "important", "type": "boolean", "optional": true, "description": "Whether the property has \"!important\" annotation (implies <cod e>false</code> if absent)." },
3067 { "name": "implicit", "type": "boolean", "optional": true, " description": "Whether the property is implicit (implies <code>false</code> if a bsent)." },
3068 { "name": "text", "type": "string", "optional": true, "descr iption": "The full property text as specified in the style." },
3069 { "name": "parsedOk", "type": "boolean", "optional": true, " description": "Whether the property is understood by the browser (implies <code> true</code> if absent)." },
3070 { "name": "disabled", "type": "boolean", "optional": true, " description": "Whether the property is disabled by the user (present for source- based properties only)." },
3071 { "name": "range", "$ref": "SourceRange", "optional": true, "description": "The entire property range in the enclosing style declaration (if available)." }
3072 ],
3073 "description": "CSS property declaration data."
3074 },
3075 {
3076 "id": "CSSMedia",
3077 "type": "object",
3078 "properties": [
3079 { "name": "text", "type": "string", "description": "Media qu ery text." },
3080 { "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\" attrib ute in an inline stylesheet's STYLE tag." },
3081 { "name": "sourceURL", "type": "string", "optional": true, " description": "URL of the document containing the media query description." },
3082 { "name": "range", "$ref": "SourceRange", "optional": true, "description": "The associated rule (@media or @import) header range in the encl osing stylesheet (if available)." },
3083 { "name": "styleSheetId", "$ref": "StyleSheetId", "optional" : true, "description": "Identifier of the stylesheet containing this object (if exists)." },
3084 { "name": "mediaList", "type": "array", "items": { "$ref": " MediaQuery" }, "optional": true, "hidden": true, "description": "Array of media queries." }
3085 ],
3086 "description": "CSS media rule descriptor."
3087 },
3088 {
3089 "id": "MediaQuery",
3090 "type": "object",
3091 "properties": [
3092 { "name": "expressions", "type": "array", "items": { "$ref": "MediaQueryExpression" }, "description": "Array of media query expressions." },
3093 { "name": "active", "type": "boolean", "description": "Wheth er the media query condition is satisfied." }
3094 ],
3095 "description": "Media query descriptor.",
3096 "hidden": true
3097 },
3098 {
3099 "id": "MediaQueryExpression",
3100 "type": "object",
3101 "properties": [
3102 { "name": "value", "type": "number", "description": "Media q uery expression value."},
3103 { "name": "unit", "type": "string", "description": "Media qu ery expression units."},
3104 { "name": "feature", "type": "string", "description": "Media query expression feature."},
3105 { "name": "valueRange", "$ref": "SourceRange", "optional": t rue, "description": "The associated range of the value text in the enclosing sty lesheet (if available)." },
3106 { "name": "computedLength", "type": "number", "optional": tr ue, "description": "Computed length of media query expression (if applicable)."}
3107 ],
3108 "description": "Media query expression descriptor.",
3109 "hidden": true
3110 },
3111 {
3112 "id": "PlatformFontUsage",
3113 "type": "object",
3114 "properties": [
3115 { "name": "familyName", "type": "string", "description": "Fo nt's family name reported by platform."},
3116 { "name": "isCustomFont", "type": "boolean", "description": "Indicates if the font was downloaded or resolved locally."},
3117 { "name": "glyphCount", "type": "number", "description": "Am ount of glyphs that were rendered with this font."}
3118 ],
3119 "description": "Information about amount of glyphs that were ren dered with given font.",
3120 "hidden": true
3121 },
3122 {
3123 "id": "CSSKeyframesRule",
3124 "type": "object",
3125 "properties": [
3126 { "name": "animationName", "$ref": "Value", "description": " Animation name." },
3127 { "name": "keyframes", "type": "array", "items": { "$ref": " CSSKeyframeRule" }, "description": "List of keyframes." }
3128 ],
3129 "description": "CSS keyframes rule representation."
3130 },
3131 {
3132 "id": "CSSKeyframeRule",
3133 "type": "object",
3134 "properties": [
3135 { "name": "styleSheetId", "$ref": "StyleSheetId", "optional" : true, "description": "The css style sheet identifier (absent for user agent st ylesheet and user-specified stylesheet rules) this rule came from." },
3136 { "name": "origin", "$ref": "StyleSheetOrigin", "description ": "Parent stylesheet's origin."},
3137 { "name": "keyText", "$ref": "Value", "description": "Associ ated key text." },
3138 { "name": "style", "$ref": "CSSStyle", "description": "Assoc iated style declaration." }
3139 ],
3140 "description": "CSS keyframe rule representation."
3141 },
3142 {
3143 "id": "StyleDeclarationEdit",
3144 "type": "object",
3145 "properties": [
3146 { "name": "styleSheetId", "$ref": "StyleSheetId", "descripti on": "The css style sheet identifier." },
3147 { "name": "range", "$ref": "SourceRange", "description": "Th e range of the style text in the enclosing stylesheet." },
3148 { "name": "text", "type": "string", "description": "New styl e text."}
3149 ],
3150 "description": "A descriptor of operation to mutate style declar ation text."
3151 }
3152 ],
3153 "commands": [
3154 {
3155 "name": "enable",
3156 "async": true,
3157 "description": "Enables the CSS agent for the given page. Client s should not assume that the CSS agent has been enabled until the result of this command is received."
3158 },
3159 {
3160 "name": "disable",
3161 "description": "Disables the CSS agent for the given page."
3162 },
3163 {
3164 "name": "getMatchedStylesForNode",
3165 "parameters": [
3166 { "name": "nodeId", "$ref": "DOM.NodeId" }
3167 ],
3168 "returns": [
3169 { "name": "inlineStyle", "$ref": "CSSStyle", "optional": tru e, "description": "Inline style for the specified DOM node." },
3170 { "name": "attributesStyle", "$ref": "CSSStyle", "optional": true, "description": "Attribute-defined element style (e.g. resulting from \"wi dth=20 height=100%\")."},
3171 { "name": "matchedCSSRules", "type": "array", "items": { "$r ef": "RuleMatch" }, "optional": true, "description": "CSS rules matching this no de, from all applicable stylesheets." },
3172 { "name": "pseudoElements", "type": "array", "items": { "$re f": "PseudoElementMatches" }, "optional": true, "description": "Pseudo style mat ches for this node." },
3173 { "name": "inherited", "type": "array", "items": { "$ref": " InheritedStyleEntry" }, "optional": true, "description": "A chain of inherited s tyles (from the immediate node parent up to the DOM tree root)." },
3174 { "name": "cssKeyframesRules", "type": "array", "items": { " $ref": "CSSKeyframesRule" }, "optional": true, "description": "A list of CSS key framed animations matching this node." }
3175 ],
3176 "description": "Returns requested styles for a DOM node identifi ed by <code>nodeId</code>."
3177 },
3178 {
3179 "name": "getInlineStylesForNode",
3180 "parameters": [
3181 { "name": "nodeId", "$ref": "DOM.NodeId" }
3182 ],
3183 "returns": [
3184 { "name": "inlineStyle", "$ref": "CSSStyle", "optional": tru e, "description": "Inline style for the specified DOM node." },
3185 { "name": "attributesStyle", "$ref": "CSSStyle", "optional": true, "description": "Attribute-defined element style (e.g. resulting from \"wi dth=20 height=100%\")."}
3186 ],
3187 "description": "Returns the styles defined inline (explicitly in the \"style\" attribute and implicitly, using DOM attributes) for a DOM node id entified by <code>nodeId</code>."
3188 },
3189 {
3190 "name": "getComputedStyleForNode",
3191 "parameters": [
3192 { "name": "nodeId", "$ref": "DOM.NodeId" }
3193 ],
3194 "returns": [
3195 { "name": "computedStyle", "type": "array", "items": { "$ref ": "CSSComputedStyleProperty" }, "description": "Computed style for the specifie d DOM node." }
3196 ],
3197 "description": "Returns the computed style for a DOM node identi fied by <code>nodeId</code>."
3198 },
3199 {
3200 "name": "getPlatformFontsForNode",
3201 "parameters": [
3202 { "name": "nodeId", "$ref": "DOM.NodeId" }
3203 ],
3204 "returns": [
3205 { "name": "fonts", "type": "array", "items": { "$ref": "Plat formFontUsage" }, "description": "Usage statistics for every employed platform f ont." }
3206 ],
3207 "description": "Requests information about platform fonts which we used to render child TextNodes in the given node.",
3208 "hidden": true
3209 },
3210 {
3211 "name": "getStyleSheetText",
3212 "parameters": [
3213 { "name": "styleSheetId", "$ref": "StyleSheetId" }
3214 ],
3215 "returns": [
3216 { "name": "text", "type": "string", "description": "The styl esheet text." }
3217 ],
3218 "description": "Returns the current textual content and the URL for a stylesheet."
3219 },
3220 {
3221 "name": "setStyleSheetText",
3222 "parameters": [
3223 { "name": "styleSheetId", "$ref": "StyleSheetId" },
3224 { "name": "text", "type": "string" }
3225 ],
3226 "returns": [
3227 { "name": "sourceMapURL", "type": "string", "optional": true , "description": "URL of source map associated with script (if any)." }
3228 ],
3229 "description": "Sets the new stylesheet text."
3230 },
3231 {
3232 "name": "setRuleSelector",
3233 "parameters": [
3234 { "name": "styleSheetId", "$ref": "StyleSheetId" },
3235 { "name": "range", "$ref": "SourceRange" },
3236 { "name": "selector", "type": "string" }
3237 ],
3238 "returns": [
3239 { "name": "selectorList", "$ref": "SelectorList", "descripti on": "The resulting selector list after modification." }
3240 ],
3241 "description": "Modifies the rule selector."
3242 },
3243 {
3244 "name": "setKeyframeKey",
3245 "parameters": [
3246 { "name": "styleSheetId", "$ref": "StyleSheetId" },
3247 { "name": "range", "$ref": "SourceRange" },
3248 { "name": "keyText", "type": "string" }
3249 ],
3250 "returns": [
3251 { "name": "keyText", "$ref": "Value", "description": "The re sulting key text after modification." }
3252 ],
3253 "description": "Modifies the keyframe rule key text."
3254 },
3255 {
3256 "name": "setStyleTexts",
3257 "parameters": [
3258 { "name": "edits", "type": "array", "items": { "$ref": "Styl eDeclarationEdit" }}
3259 ],
3260 "returns": [
3261 { "name": "styles", "type": "array", "items": { "$ref": "CSS Style" }, "description": "The resulting styles after modification." }
3262 ],
3263 "description": "Applies specified style edits one after another in the given order."
3264 },
3265 {
3266 "name": "setMediaText",
3267 "parameters": [
3268 { "name": "styleSheetId", "$ref": "StyleSheetId" },
3269 { "name": "range", "$ref": "SourceRange" },
3270 { "name": "text", "type": "string" }
3271 ],
3272 "returns": [
3273 { "name": "media", "$ref": "CSSMedia", "description": "The r esulting CSS media rule after modification." }
3274 ],
3275 "description": "Modifies the rule selector."
3276 },
3277 {
3278 "name": "createStyleSheet",
3279 "parameters": [
3280 { "name": "frameId", "$ref": "Page.FrameId", "description": "Identifier of the frame where \"via-inspector\" stylesheet should be created."}
3281 ],
3282 "returns": [
3283 { "name": "styleSheetId", "$ref": "StyleSheetId", "descripti on": "Identifier of the created \"via-inspector\" stylesheet." }
3284 ],
3285 "description": "Creates a new special \"via-inspector\" styleshe et in the frame with given <code>frameId</code>."
3286 },
3287 {
3288 "name": "addRule",
3289 "parameters": [
3290 { "name": "styleSheetId", "$ref": "StyleSheetId", "descripti on": "The css style sheet identifier where a new rule should be inserted." },
3291 { "name": "ruleText", "type": "string", "description": "The text of a new rule." },
3292 { "name": "location", "$ref": "SourceRange", "description": "Text position of a new rule in the target style sheet." }
3293 ],
3294 "returns": [
3295 { "name": "rule", "$ref": "CSSRule", "description": "The new ly created rule." }
3296 ],
3297 "description": "Inserts a new rule with the given <code>ruleText </code> in a stylesheet with given <code>styleSheetId</code>, at the position sp ecified by <code>location</code>."
3298 },
3299 {
3300 "name": "forcePseudoState",
3301 "parameters": [
3302 { "name": "nodeId", "$ref": "DOM.NodeId", "description": "Th e element id for which to force the pseudo state." },
3303 { "name": "forcedPseudoClasses", "type": "array", "items": { "type": "string", "enum": ["active", "focus", "hover", "visited"] }, "descripti on": "Element pseudo classes to force when computing the element's style." }
3304 ],
3305 "description": "Ensures that the given node will have specified pseudo-classes whenever its style is computed by the browser."
3306 },
3307 {
3308 "name": "getMediaQueries",
3309 "returns": [
3310 { "name": "medias", "type": "array", "items": { "$ref": "CSS Media" } }
3311 ],
3312 "description": "Returns all media queries parsed by the renderin g engine.",
3313 "hidden": true
3314 },
3315 {
3316 "name": "setEffectivePropertyValueForNode",
3317 "parameters": [
3318 { "name": "nodeId", "$ref": "DOM.NodeId", "description": "Th e element id for which to set property." },
3319 { "name": "propertyName", "type": "string"},
3320 { "name": "value", "type": "string"}
3321 ],
3322 "description": "Find a rule with the given active property for t he given node and set the new value for this property",
3323 "hidden": true
3324 },
3325 {
3326 "name": "getBackgroundColors",
3327 "parameters": [
3328 { "name": "nodeId", "$ref": "DOM.NodeId", "description": "Id of the node to get background colors for." }
3329 ],
3330 "returns": [
3331 { "name": "backgroundColors", "type": "array", "items": { "t ype": "string" }, "description": "The range of background colors behind this ele ment, if it contains any visible text. If no visible text is present, this will be undefined. In the case of a flat background color, this will consist of simpl y that color. In the case of a gradient, this will consist of each of the color stops. For anything more complicated, this will be an empty array. Images will b e ignored (as if the image had failed to load).", "optional": true }
3332 ],
3333 "hidden": true
3334 }
3335 ],
3336 "events": [
3337 {
3338 "name": "mediaQueryResultChanged",
3339 "description": "Fires whenever a MediaQuery result changes (for example, after a browser window has been resized.) The current implementation co nsiders only viewport-dependent media features."
3340 },
3341 {
3342 "name": "styleSheetChanged",
3343 "parameters": [
3344 { "name": "styleSheetId", "$ref": "StyleSheetId" }
3345 ],
3346 "description": "Fired whenever a stylesheet is changed as a resu lt of the client operation."
3347 },
3348 {
3349 "name": "styleSheetAdded",
3350 "parameters": [
3351 { "name": "header", "$ref": "CSSStyleSheetHeader", "descript ion": "Added stylesheet metainfo." }
3352 ],
3353 "description": "Fired whenever an active document stylesheet is added."
3354 },
3355 {
3356 "name": "styleSheetRemoved",
3357 "parameters": [
3358 { "name": "styleSheetId", "$ref": "StyleSheetId", "descripti on": "Identifier of the removed stylesheet." }
3359 ],
3360 "description": "Fired whenever an active document stylesheet is removed."
3361 },
3362 {
3363 "name": "layoutEditorChange",
3364 "parameters": [
3365 { "name": "styleSheetId", "$ref": "StyleSheetId", "descripti on": "Identifier of the stylesheet where the modification occurred." },
3366 { "name": "changeRange", "$ref": "SourceRange", "description ": "Range where the modification occurred." }
3367 ]
3368 }
3369 ]
3370 },
3371 {
3372 "domain": "IO",
3373 "description": "Input/Output operations for streams produced by DevTools .",
3374 "hidden": true,
3375 "types": [
3376 {
3377 "id": "StreamHandle",
3378 "type": "string"
3379 }
3380 ],
3381 "commands": [
3382 {
3383 "name": "read",
3384 "description": "Read a chunk of the stream",
3385 "async": true,
3386 "parameters": [
3387 { "name": "handle", "$ref": "StreamHandle", "description": " Handle of the stream to read." },
3388 { "name": "offset", "type": "integer", "optional": true, "de scription": "Seek to the specified offset before reading (if not specificed, pro ceed with offset following the last read)." },
3389 { "name": "size", "type": "integer", "optional": true, "des cription": "Maximum number of bytes to read (left upon the agent discretion if n ot specified)." }
3390 ],
3391 "returns": [
3392 { "name": "data", "type": "string", "description": "Data tha t were read." },
3393 { "name": "eof", "type": "boolean", "description": "Set if t he end-of-file condition occured while reading." }
3394 ],
3395 "handlers": ["browser"]
3396 },
3397 {
3398 "name": "close",
3399 "description": "Close the stream, discard any temporary backing storage.",
3400 "parameters": [
3401 { "name": "handle", "$ref": "StreamHandle", "description": " Handle of the stream to close." }
3402 ],
3403 "handlers": ["browser"]
3404 }
3405 ]
3406 },
3407 {
3408 "domain": "Debugger",
3409 "description": "Debugger domain exposes JavaScript debugging capabilitie s. It allows setting and removing breakpoints, stepping through execution, explo ring stack traces, etc.",
3410 "dependencies": ["Runtime"],
3411 "types": [
3412 {
3413 "id": "BreakpointId",
3414 "type": "string",
3415 "description": "Breakpoint identifier."
3416 },
3417 {
3418 "id": "CallFrameId",
3419 "type": "string",
3420 "description": "Call frame identifier."
3421 },
3422 {
3423 "id": "Location",
3424 "type": "object",
3425 "properties": [
3426 { "name": "scriptId", "$ref": "Runtime.ScriptId", "descripti on": "Script identifier as reported in the <code>Debugger.scriptParsed</code>." },
3427 { "name": "lineNumber", "type": "integer", "description": "L ine number in the script (0-based)." },
3428 { "name": "columnNumber", "type": "integer", "optional": tru e, "description": "Column number in the script (0-based)." }
3429 ],
3430 "description": "Location in the source code."
3431 },
3432 {
3433 "id": "ScriptPosition",
3434 "hidden": true,
3435 "type": "object",
3436 "properties": [
3437 { "name": "line", "type": "integer" },
3438 { "name": "column", "type": "integer" }
3439 ],
3440 "description": "Location in the source code."
3441 },
3442 {
3443 "id": "FunctionDetails",
3444 "hidden": true,
3445 "type": "object",
3446 "properties": [
3447 { "name": "location", "$ref": "Location", "optional": true, "description": "Location of the function, none for native functions." },
3448 { "name": "functionName", "type": "string", "description": " Name of the function." },
3449 { "name": "isGenerator", "type": "boolean", "description": " Whether this is a generator function." },
3450 { "name": "scopeChain", "type": "array", "optional": true, " items": { "$ref": "Scope" }, "description": "Scope chain for this closure." }
3451 ],
3452 "description": "Information about the function."
3453 },
3454 {
3455 "id": "GeneratorObjectDetails",
3456 "hidden": true,
3457 "type": "object",
3458 "properties": [
3459 { "name": "function", "$ref": "Runtime.RemoteObject", "descr iption": "Generator function." },
3460 { "name": "functionName", "type": "string", "description": " Name of the generator function." },
3461 { "name": "status", "type": "string", "enum": ["running", "s uspended", "closed"], "description": "Current generator object status." },
3462 { "name": "location", "$ref": "Location", "optional": true, "description": "If suspended, location where generator function was suspended (e .g. location of the last 'yield'). Otherwise, location of the generator function ." }
3463 ],
3464 "description": "Information about the generator object."
3465 },
3466 {
3467 "id": "CollectionEntry",
3468 "hidden": true,
3469 "type": "object",
3470 "properties": [
3471 { "name": "key", "$ref": "Runtime.RemoteObject", "optional": true, "description": "Entry key of a map-like collection, otherwise not provide d." },
3472 { "name": "value", "$ref": "Runtime.RemoteObject", "descript ion": "Entry value." }
3473 ],
3474 "description": "Collection entry."
3475 },
3476 {
3477 "id": "CallFrame",
3478 "type": "object",
3479 "properties": [
3480 { "name": "callFrameId", "$ref": "CallFrameId", "description ": "Call frame identifier. This identifier is only valid while the virtual machi ne is paused." },
3481 { "name": "functionName", "type": "string", "description": " Name of the JavaScript function called on this call frame." },
3482 { "name": "functionLocation", "$ref": "Location", "optional" : true, "hidden": true, "description": "Location in the source code." },
3483 { "name": "location", "$ref": "Location", "description": "Lo cation in the source code." },
3484 { "name": "scopeChain", "type": "array", "items": { "$ref": "Scope" }, "description": "Scope chain for this call frame." },
3485 { "name": "this", "$ref": "Runtime.RemoteObject", "descripti on": "<code>this</code> object for this call frame." },
3486 { "name": "returnValue", "$ref": "Runtime.RemoteObject", "op tional": true, "hidden": true, "description": "The value being returned, if the function is at return point." }
3487 ],
3488 "description": "JavaScript call frame. Array of call frames form the call stack."
3489 },
3490 {
3491 "id": "Scope",
3492 "type": "object",
3493 "properties": [
3494 { "name": "type", "type": "string", "enum": ["global", "loca l", "with", "closure", "catch", "block", "script"], "description": "Scope type." },
3495 { "name": "object", "$ref": "Runtime.RemoteObject", "descrip tion": "Object representing the scope. For <code>global</code> and <code>with</c ode> scopes it represents the actual object; for the rest of the scopes, it is a rtificial transient object enumerating scope variables as its properties." },
3496 { "name": "name", "type": "string", "optional": true, "hidde n": true },
3497 { "name": "startLocation", "$ref": "Location", "optional": t rue, "hidden": true, "description": "Location in the source code where scope sta rts" },
3498 { "name": "endLocation", "$ref": "Location", "optional": tru e, "hidden": true, "description": "Location in the source code where scope ends" }
3499 ],
3500 "description": "Scope description."
3501 },
3502 {
3503 "id": "SetScriptSourceError",
3504 "type": "object",
3505 "properties": [
3506 { "name": "message", "type": "string", "description": "Compi ler error message" },
3507 { "name": "lineNumber", "type": "integer", "description": "C ompile error line number (1-based)" },
3508 { "name": "columnNumber", "type": "integer", "description": "Compile error column number (1-based)" }
3509 ],
3510 "description": "Error data for setScriptSource command. Contains uncompilable script source error.",
3511 "hidden": true
3512 },
3513 {
3514 "id": "SearchMatch",
3515 "type": "object",
3516 "description": "Search match for resource.",
3517 "properties": [
3518 { "name": "lineNumber", "type": "number", "description": "Li ne number in resource content." },
3519 { "name": "lineContent", "type": "string", "description": "L ine with match content." }
3520 ],
3521 "hidden": true
3522 }
3523 ],
3524 "commands": [
3525 {
3526 "name": "enable",
3527 "description": "Enables debugger for the given page. Clients sho uld not assume that the debugging has been enabled until the result for this com mand is received."
3528 },
3529 {
3530 "name": "disable",
3531 "description": "Disables debugger for given page."
3532 },
3533 {
3534 "name": "setBreakpointsActive",
3535 "parameters": [
3536 { "name": "active", "type": "boolean", "description": "New v alue for breakpoints active state." }
3537 ],
3538 "description": "Activates / deactivates all breakpoints on the p age."
3539 },
3540 {
3541 "name": "setSkipAllPauses",
3542 "hidden": true,
3543 "parameters": [
3544 { "name": "skipped", "type": "boolean", "description": "New value for skip pauses state." }
3545 ],
3546 "description": "Makes page not interrupt on any pauses (breakpoi nt, exception, dom exception etc)."
3547 },
3548 {
3549 "name": "setBreakpointByUrl",
3550 "parameters": [
3551 { "name": "lineNumber", "type": "integer", "description": "L ine number to set breakpoint at." },
3552 { "name": "url", "type": "string", "optional": true, "descri ption": "URL of the resources to set breakpoint on." },
3553 { "name": "urlRegex", "type": "string", "optional": true, "d escription": "Regex pattern for the URLs of the resources to set breakpoints on. Either <code>url</code> or <code>urlRegex</code> must be specified." },
3554 { "name": "columnNumber", "type": "integer", "optional": tru e, "description": "Offset in the line to set breakpoint at." },
3555 { "name": "condition", "type": "string", "optional": true, " description": "Expression to use as a breakpoint condition. When specified, debu gger will only stop on the breakpoint if this expression evaluates to true." }
3556 ],
3557 "returns": [
3558 { "name": "breakpointId", "$ref": "BreakpointId", "descripti on": "Id of the created breakpoint for further reference." },
3559 { "name": "locations", "type": "array", "items": { "$ref": " Location" }, "description": "List of the locations this breakpoint resolved into upon addition." }
3560 ],
3561 "description": "Sets JavaScript breakpoint at given location spe cified either by URL or URL regex. Once this command is issued, all existing par sed scripts will have breakpoints resolved and returned in <code>locations</code > property. Further matching script parsing will result in subsequent <code>brea kpointResolved</code> events issued. This logical breakpoint will survive page r eloads."
3562 },
3563 {
3564 "name": "setBreakpoint",
3565 "parameters": [
3566 { "name": "location", "$ref": "Location", "description": "Lo cation to set breakpoint in." },
3567 { "name": "condition", "type": "string", "optional": true, " description": "Expression to use as a breakpoint condition. When specified, debu gger will only stop on the breakpoint if this expression evaluates to true." }
3568 ],
3569 "returns": [
3570 { "name": "breakpointId", "$ref": "BreakpointId", "descripti on": "Id of the created breakpoint for further reference." },
3571 { "name": "actualLocation", "$ref": "Location", "description ": "Location this breakpoint resolved into." }
3572 ],
3573 "description": "Sets JavaScript breakpoint at a given location."
3574 },
3575 {
3576 "name": "removeBreakpoint",
3577 "parameters": [
3578 { "name": "breakpointId", "$ref": "BreakpointId" }
3579 ],
3580 "description": "Removes JavaScript breakpoint."
3581 },
3582 {
3583 "name": "continueToLocation",
3584 "parameters": [
3585 { "name": "location", "$ref": "Location", "description": "Lo cation to continue to." },
3586 { "name": "interstatementLocation", "type": "boolean", "opti onal": true, "hidden": true, "description": "Allows breakpoints at the intemedia te positions inside statements." }
3587 ],
3588 "description": "Continues execution until specific location is r eached."
3589 },
3590 {
3591 "name": "stepOver",
3592 "description": "Steps over the statement."
3593 },
3594 {
3595 "name": "stepInto",
3596 "description": "Steps into the function call."
3597 },
3598 {
3599 "name": "stepOut",
3600 "description": "Steps out of the function call."
3601 },
3602 {
3603 "name": "pause",
3604 "description": "Stops on the next JavaScript statement."
3605 },
3606 {
3607 "name": "resume",
3608 "description": "Resumes JavaScript execution."
3609 },
3610 {
3611 "name": "searchInContent",
3612 "parameters": [
3613 { "name": "scriptId", "$ref": "Runtime.ScriptId", "descripti on": "Id of the script to search in." },
3614 { "name": "query", "type": "string", "description": "String to search for." },
3615 { "name": "caseSensitive", "type": "boolean", "optional": tr ue, "description": "If true, search is case sensitive." },
3616 { "name": "isRegex", "type": "boolean", "optional": true, "d escription": "If true, treats string parameter as regex." }
3617 ],
3618 "returns": [
3619 { "name": "result", "type": "array", "items": { "$ref": "Sea rchMatch" }, "description": "List of search matches." }
3620 ],
3621 "description": "Searches for given string in script content."
3622 },
3623 {
3624 "name": "canSetScriptSource",
3625 "returns": [
3626 { "name": "result", "type": "boolean", "description": "True if <code>setScriptSource</code> is supported." }
3627 ],
3628 "description": "Always returns true."
3629 },
3630 {
3631 "name": "setScriptSource",
3632 "parameters": [
3633 { "name": "scriptId", "$ref": "Runtime.ScriptId", "descripti on": "Id of the script to edit." },
3634 { "name": "scriptSource", "type": "string", "description": " New content of the script." },
3635 { "name": "preview", "type": "boolean", "optional": true, "d escription": " If true the change will not actually be applied. Preview mode may be used to get result description without actually modifying the code.", "hidde n": true }
3636 ],
3637 "returns": [
3638 { "name": "callFrames", "type": "array", "optional": true, " items": { "$ref": "CallFrame" }, "description": "New stack trace in case editing has happened while VM was stopped." },
3639 { "name": "stackChanged", "type": "boolean", "optional": tru e, "description": "Whether current call stack was modified after applying the c hanges.", "hidden": true },
3640 { "name": "asyncStackTrace", "$ref": "Runtime.StackTrace", " optional": true, "description": "Async stack trace, if any.", "hidden": true },
3641 { "name": "compileError", "optional": true, "$ref": "SetScri ptSourceError", "description": "Error data if any." }
3642 ],
3643 "description": "Edits JavaScript source live."
3644 },
3645 {
3646 "name": "restartFrame",
3647 "parameters": [
3648 { "name": "callFrameId", "$ref": "CallFrameId", "description ": "Call frame identifier to evaluate on." }
3649 ],
3650 "returns": [
3651 { "name": "callFrames", "type": "array", "items": { "$ref": "CallFrame" }, "description": "New stack trace." },
3652 { "name": "asyncStackTrace", "$ref": "Runtime.StackTrace", " optional": true, "description": "Async stack trace, if any." }
3653 ],
3654 "hidden": true,
3655 "description": "Restarts particular call frame from the beginnin g."
3656 },
3657 {
3658 "name": "getScriptSource",
3659 "parameters": [
3660 { "name": "scriptId", "$ref": "Runtime.ScriptId", "descripti on": "Id of the script to get source for." }
3661 ],
3662 "returns": [
3663 { "name": "scriptSource", "type": "string", "description": " Script source." }
3664 ],
3665 "description": "Returns source for the script with given id."
3666 },
3667 {
3668 "name": "getFunctionDetails",
3669 "hidden": true,
3670 "parameters": [
3671 { "name": "functionId", "$ref": "Runtime.RemoteObjectId", "d escription": "Id of the function to get details for." }
3672 ],
3673 "returns": [
3674 { "name": "details", "$ref": "FunctionDetails", "description ": "Information about the function." }
3675 ],
3676 "description": "Returns detailed information on given function."
3677 },
3678 {
3679 "name": "getGeneratorObjectDetails",
3680 "hidden": true,
3681 "parameters": [
3682 { "name": "objectId", "$ref": "Runtime.RemoteObjectId", "des cription": "Id of the generator object to get details for." }
3683 ],
3684 "returns": [
3685 { "name": "details", "$ref": "GeneratorObjectDetails", "desc ription": "Information about the generator object." }
3686 ],
3687 "description": "Returns detailed information on given generator object."
3688 },
3689 {
3690 "name": "getCollectionEntries",
3691 "hidden": true,
3692 "parameters": [
3693 { "name": "objectId", "$ref": "Runtime.RemoteObjectId", "des cription": "Id of the collection to get entries for." }
3694 ],
3695 "returns": [
3696 { "name": "entries", "type": "array", "items": { "$ref": "Co llectionEntry" }, "description": "Array of collection entries." }
3697 ],
3698 "description": "Returns entries of given collection."
3699 },
3700 {
3701 "name": "setPauseOnExceptions",
3702 "parameters": [
3703 { "name": "state", "type": "string", "enum": ["none", "uncau ght", "all"], "description": "Pause on exceptions mode." }
3704 ],
3705 "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>."
3706 },
3707 {
3708 "name": "evaluateOnCallFrame",
3709 "parameters": [
3710 { "name": "callFrameId", "$ref": "CallFrameId", "description ": "Call frame identifier to evaluate on." },
3711 { "name": "expression", "type": "string", "description": "Ex pression to evaluate." },
3712 { "name": "objectGroup", "type": "string", "optional": true, "description": "String object group name to put result into (allows rapid relea sing resulting object handles using <code>releaseObjectGroup</code>)." },
3713 { "name": "includeCommandLineAPI", "type": "boolean", "optio nal": true, "description": "Specifies whether command line API should be availab le to the evaluated expression, defaults to false.", "hidden": true },
3714 { "name": "doNotPauseOnExceptionsAndMuteConsole", "type": "b oolean", "optional": true, "description": "Specifies whether evaluation should s top on exceptions and mute console. Overrides setPauseOnException state.", "hidd en": true },
3715 { "name": "returnByValue", "type": "boolean", "optional": tr ue, "description": "Whether the result is expected to be a JSON object that shou ld be sent by value." },
3716 { "name": "generatePreview", "type": "boolean", "optional": true, "hidden": true, "description": "Whether preview should be generated for th e result." }
3717 ],
3718 "returns": [
3719 { "name": "result", "$ref": "Runtime.RemoteObject", "descrip tion": "Object wrapper for the evaluation result." },
3720 { "name": "wasThrown", "type": "boolean", "optional": true, "description": "True if the result was thrown during the evaluation." },
3721 { "name": "exceptionDetails", "$ref": "Runtime.ExceptionDeta ils", "optional": true, "hidden": true, "description": "Exception details."}
3722 ],
3723 "description": "Evaluates expression on a given call frame."
3724 },
3725 {
3726 "name": "setVariableValue",
3727 "parameters": [
3728 { "name": "scopeNumber", "type": "integer", "description": " 0-based number of scope as was listed in scope chain. Only 'local', 'closure' an d 'catch' scope types are allowed. Other scopes could be manipulated manually." },
3729 { "name": "variableName", "type": "string", "description": " Variable name." },
3730 { "name": "newValue", "$ref": "Runtime.CallArgument", "descr iption": "New variable value." },
3731 { "name": "callFrameId", "$ref": "CallFrameId", "description ": "Id of callframe that holds variable." }
3732 ],
3733 "hidden": true,
3734 "description": "Changes value of variable in a callframe. Object -based scopes are not supported and must be mutated manually."
3735 },
3736 {
3737 "name": "getBacktrace",
3738 "returns": [
3739 { "name": "callFrames", "type": "array", "items": { "$ref": "CallFrame" }, "description": "Call stack the virtual machine stopped on." },
3740 { "name": "asyncStackTrace", "$ref": "Runtime.StackTrace", " optional": true, "description": "Async stack trace, if any." }
3741 ],
3742 "hidden": true,
3743 "description": "Returns call stack including variables changed s ince VM was paused. VM must be paused."
3744 },
3745 {
3746 "name": "setAsyncCallStackDepth",
3747 "parameters": [
3748 { "name": "maxDepth", "type": "integer", "description": "Max imum depth of async call stacks. Setting to <code>0</code> will effectively disa ble collecting async call stacks (default)." }
3749 ],
3750 "hidden": true,
3751 "description": "Enables or disables async call stacks tracking."
3752 },
3753 {
3754 "name": "setBlackboxPatterns",
3755 "parameters": [
3756 { "name": "patterns", "type": "array", "items": { "type": "s tring" }, "description": "Array of regexps that will be used to check script url for blackbox state." }
3757 ],
3758 "hidden": true,
3759 "description": "Replace previous blackbox patterns with passed o nes. Forces backend to skip stepping/pausing in scripts with url matching one of the patterns. VM will try to leave blackboxed script by performing 'step in' se veral times, finally resorting to 'step out' if unsuccessful."
3760 },
3761 {
3762 "name": "setBlackboxedRanges",
3763 "parameters": [
3764 { "name": "scriptId", "$ref": "Runtime.ScriptId", "descripti on": "Id of the script." },
3765 { "name": "positions", "type": "array", "items": { "$ref": " ScriptPosition" } }
3766 ],
3767 "hidden": true,
3768 "description": "Makes backend skip steps in the script in blackb oxed ranges. VM will try leave blacklisted scripts by performing 'step in' sever al times, finally resorting to 'step out' if unsuccessful. Positions array conta ins positions where blackbox state is changed. First interval isn't blackboxed. Array should be sorted."
3769 }
3770 ],
3771 "events": [
3772 {
3773 "name": "scriptParsed",
3774 "parameters": [
3775 { "name": "scriptId", "$ref": "Runtime.ScriptId", "descripti on": "Identifier of the script parsed." },
3776 { "name": "url", "type": "string", "description": "URL or na me of the script parsed (if any)." },
3777 { "name": "startLine", "type": "integer", "description": "Li ne offset of the script within the resource with given URL (for script tags)." } ,
3778 { "name": "startColumn", "type": "integer", "description": " Column offset of the script within the resource with given URL." },
3779 { "name": "endLine", "type": "integer", "description": "Last line of the script." },
3780 { "name": "endColumn", "type": "integer", "description": "Le ngth of the last line of the script." },
3781 { "name": "executionContextId", "$ref": "Runtime.ExecutionCo ntextId", "description": "Specifies script creation context.", "hidden": true },
3782 { "name": "hash", "type": "string", "hidden": true, "descrip tion": "Content hash of the script."},
3783 { "name": "isContentScript", "type": "boolean", "optional": true, "description": "Determines whether this script is a user extension script. " },
3784 { "name": "isInternalScript", "type": "boolean", "optional": true, "description": "Determines whether this script is an internal script.", " hidden": true },
3785 { "name": "isLiveEdit", "type": "boolean", "optional": true, "description": "True, if this script is generated as a result of the live edit operation.", "hidden": true },
3786 { "name": "sourceMapURL", "type": "string", "optional": true , "description": "URL of source map associated with script (if any)." },
3787 { "name": "hasSourceURL", "type": "boolean", "optional": tru e, "description": "True, if this script has sourceURL.", "hidden": true },
3788 { "name": "deprecatedCommentWasUsed", "type": "boolean", "op tional": true, "hidden": true, "description": "True, if '//@ sourceURL' or '//@ sourceMappingURL' was used."}
3789 ],
3790 "description": "Fired when virtual machine parses script. This e vent is also fired for all known and uncollected scripts upon enabling debugger. "
3791 },
3792 {
3793 "name": "scriptFailedToParse",
3794 "parameters": [
3795 { "name": "scriptId", "$ref": "Runtime.ScriptId", "descripti on": "Identifier of the script parsed." },
3796 { "name": "url", "type": "string", "description": "URL or na me of the script parsed (if any)." },
3797 { "name": "startLine", "type": "integer", "description": "Li ne offset of the script within the resource with given URL (for script tags)." } ,
3798 { "name": "startColumn", "type": "integer", "description": " Column offset of the script within the resource with given URL." },
3799 { "name": "endLine", "type": "integer", "description": "Last line of the script." },
3800 { "name": "endColumn", "type": "integer", "description": "Le ngth of the last line of the script." },
3801 { "name": "executionContextId", "$ref": "Runtime.ExecutionCo ntextId", "description": "Specifies script creation context.", "hidden": true },
3802 { "name": "hash", "type": "string", "hidden": true, "descrip tion": "Content hash of the script."},
3803 { "name": "isContentScript", "type": "boolean", "optional": true, "description": "Determines whether this script is a user extension script. " },
3804 { "name": "isInternalScript", "type": "boolean", "optional": true, "description": "Determines whether this script is an internal script.", " hidden": true },
3805 { "name": "sourceMapURL", "type": "string", "optional": true , "description": "URL of source map associated with script (if any)." },
3806 { "name": "hasSourceURL", "type": "boolean", "optional": tru e, "description": "True, if this script has sourceURL.", "hidden": true },
3807 { "name": "deprecatedCommentWasUsed", "type": "boolean", "op tional": true, "hidden": true, "description": "True, if '//@ sourceURL' or '//@ sourceMappingURL' was used."}
3808 ],
3809 "description": "Fired when virtual machine fails to parse the sc ript."
3810 },
3811 {
3812 "name": "breakpointResolved",
3813 "parameters": [
3814 { "name": "breakpointId", "$ref": "BreakpointId", "descripti on": "Breakpoint unique identifier." },
3815 { "name": "location", "$ref": "Location", "description": "Ac tual breakpoint location." }
3816 ],
3817 "description": "Fired when breakpoint is resolved to an actual s cript and location."
3818 },
3819 {
3820 "name": "paused",
3821 "parameters": [
3822 { "name": "callFrames", "type": "array", "items": { "$ref": "CallFrame" }, "description": "Call stack the virtual machine stopped on." },
3823 { "name": "reason", "type": "string", "enum": [ "XHR", "DOM" , "EventListener", "exception", "assert", "CSPViolation", "debugCommand", "promi seRejection", "other" ], "description": "Pause reason." },
3824 { "name": "data", "type": "object", "optional": true, "descr iption": "Object containing break-specific auxiliary properties." },
3825 { "name": "hitBreakpoints", "type": "array", "optional": tru e, "items": { "type": "string" }, "description": "Hit breakpoints IDs", "hidden" : true },
3826 { "name": "asyncStackTrace", "$ref": "Runtime.StackTrace", " optional": true, "description": "Async stack trace, if any.", "hidden": true }
3827 ],
3828 "description": "Fired when the virtual machine stopped on breakp oint or exception or any other stop criteria."
3829 },
3830 {
3831 "name": "resumed",
3832 "description": "Fired when the virtual machine resumed execution ."
3833 }
3834 ]
3835 },
3836 {
3837 "domain": "DOMDebugger",
3838 "description": "DOM debugging allows setting breakpoints on particular D OM operations and events. JavaScript execution will stop on these operations as if there was a regular breakpoint set.",
3839 "dependencies": ["DOM", "Debugger"],
3840 "types": [
3841 {
3842 "id": "DOMBreakpointType",
3843 "type": "string",
3844 "enum": ["subtree-modified", "attribute-modified", "node-removed "],
3845 "description": "DOM breakpoint type."
3846 },
3847 {
3848 "id": "EventListener",
3849 "type": "object",
3850 "description": "Object event listener.",
3851 "properties": [
3852 { "name": "type", "type": "string", "description": "<code>Ev entListener</code>'s type." },
3853 { "name": "useCapture", "type": "boolean", "description": "< code>EventListener</code>'s useCapture." },
3854 { "name": "passive", "type": "boolean", "description": "<cod e>EventListener</code>'s passive flag." },
3855 { "name": "location", "$ref": "Debugger.Location", "descript ion": "Handler code location." },
3856 { "name": "handler", "$ref": "Runtime.RemoteObject", "option al": true, "description": "Event handler function value." },
3857 { "name": "originalHandler", "$ref": "Runtime.RemoteObject", "optional": true, "description": "Event original handler function value." },
3858 { "name": "removeFunction", "$ref": "Runtime.RemoteObject", "optional": true, "description": "Event listener remove function." }
3859 ],
3860 "hidden": true
3861 }
3862 ],
3863 "commands": [
3864 {
3865 "name": "setDOMBreakpoint",
3866 "parameters": [
3867 { "name": "nodeId", "$ref": "DOM.NodeId", "description": "Id entifier of the node to set breakpoint on." },
3868 { "name": "type", "$ref": "DOMBreakpointType", "description" : "Type of the operation to stop upon." }
3869 ],
3870 "description": "Sets breakpoint on particular operation with DOM ."
3871 },
3872 {
3873 "name": "removeDOMBreakpoint",
3874 "parameters": [
3875 { "name": "nodeId", "$ref": "DOM.NodeId", "description": "Id entifier of the node to remove breakpoint from." },
3876 { "name": "type", "$ref": "DOMBreakpointType", "description" : "Type of the breakpoint to remove." }
3877 ],
3878 "description": "Removes DOM breakpoint that was set using <code> setDOMBreakpoint</code>."
3879 },
3880 {
3881 "name": "setEventListenerBreakpoint",
3882 "parameters": [
3883 { "name": "eventName", "type": "string", "description": "DOM Event name to stop on (any DOM event will do)." },
3884 { "name": "targetName", "type": "string", "optional": true, "description": "EventTarget interface name to stop on. If equal to <code>\"*\"</ code> or not provided, will stop on any EventTarget.", "hidden": true }
3885 ],
3886 "description": "Sets breakpoint on particular DOM event."
3887 },
3888 {
3889 "name": "removeEventListenerBreakpoint",
3890 "parameters": [
3891 { "name": "eventName", "type": "string", "description": "Eve nt name." },
3892 { "name": "targetName", "type": "string", "optional": true, "description": "EventTarget interface name.", "hidden": true }
3893 ],
3894 "description": "Removes breakpoint on particular DOM event."
3895 },
3896 {
3897 "name": "setInstrumentationBreakpoint",
3898 "parameters": [
3899 { "name": "eventName", "type": "string", "description": "Ins trumentation name to stop on." }
3900 ],
3901 "description": "Sets breakpoint on particular native event.",
3902 "hidden": true
3903 },
3904 {
3905 "name": "removeInstrumentationBreakpoint",
3906 "parameters": [
3907 { "name": "eventName", "type": "string", "description": "Ins trumentation name to stop on." }
3908 ],
3909 "description": "Removes breakpoint on particular native event.",
3910 "hidden": true
3911 },
3912 {
3913 "name": "setXHRBreakpoint",
3914 "parameters": [
3915 { "name": "url", "type": "string", "description": "Resource URL substring. All XHRs having this substring in the URL will get stopped upon." }
3916 ],
3917 "description": "Sets breakpoint on XMLHttpRequest."
3918 },
3919 {
3920 "name": "removeXHRBreakpoint",
3921 "parameters": [
3922 { "name": "url", "type": "string", "description": "Resource URL substring." }
3923 ],
3924 "description": "Removes breakpoint from XMLHttpRequest."
3925 },
3926 {
3927 "name": "getEventListeners",
3928 "hidden": true,
3929 "parameters": [
3930 { "name": "objectId", "$ref": "Runtime.RemoteObjectId", "des cription": "Identifier of the object to return listeners for." }
3931 ],
3932 "returns": [
3933 { "name": "listeners", "type": "array", "items": { "$ref": " EventListener" }, "description": "Array of relevant listeners." }
3934 ],
3935 "description": "Returns event listeners of the given object."
3936 }
3937 ]
3938 },
3939 {
3940 "domain": "Profiler",
3941 "dependencies": ["Runtime", "Debugger"],
3942 "hidden": true,
3943 "types": [
3944 {
3945 "id": "CPUProfileNode",
3946 "type": "object",
3947 "description": "CPU Profile node. Holds callsite information, ex ecution statistics and child nodes.",
3948 "properties": [
3949 { "name": "functionName", "type": "string", "description": " Function name." },
3950 { "name": "scriptId", "$ref": "Runtime.ScriptId", "descripti on": "Script identifier." },
3951 { "name": "url", "type": "string", "description": "URL." },
3952 { "name": "lineNumber", "type": "integer", "description": "1 -based line number of the function start position." },
3953 { "name": "columnNumber", "type": "integer", "description": "1-based column number of the function start position." },
3954 { "name": "hitCount", "type": "integer", "description": "Num ber of samples where this node was on top of the call stack." },
3955 { "name": "callUID", "type": "number", "description": "Call UID." },
3956 { "name": "children", "type": "array", "items": { "$ref": "C PUProfileNode" }, "description": "Child nodes." },
3957 { "name": "deoptReason", "type": "string", "description": "T he reason of being not optimized. The function may be deoptimized or marked as d on't optimize."},
3958 { "name": "id", "type": "integer", "description": "Unique id of the node." },
3959 { "name": "positionTicks", "type": "array", "items": { "$ref ": "PositionTickInfo" }, "description": "An array of source position ticks." }
3960 ]
3961 },
3962 {
3963 "id": "CPUProfile",
3964 "type": "object",
3965 "description": "Profile.",
3966 "properties": [
3967 { "name": "head", "$ref": "CPUProfileNode" },
3968 { "name": "startTime", "type": "number", "description": "Pro filing start time in seconds." },
3969 { "name": "endTime", "type": "number", "description": "Profi ling end time in seconds." },
3970 { "name": "samples", "optional": true, "type": "array", "ite ms": { "type": "integer" }, "description": "Ids of samples top nodes." },
3971 { "name": "timestamps", "optional": true, "type": "array", " items": { "type": "number" }, "description": "Timestamps of the samples in micro seconds." }
3972 ]
3973 },
3974 {
3975 "id": "PositionTickInfo",
3976 "type": "object",
3977 "description": "Specifies a number of samples attributed to a ce rtain source position.",
3978 "properties": [
3979 { "name": "line", "type": "integer", "description": "Source line number (1-based)." },
3980 { "name": "ticks", "type": "integer", "description": "Number of samples attributed to the source line." }
3981 ]
3982 }
3983 ],
3984 "commands": [
3985 {
3986 "name": "enable"
3987 },
3988 {
3989 "name": "disable"
3990 },
3991 {
3992 "name": "setSamplingInterval",
3993 "parameters": [
3994 { "name": "interval", "type": "integer", "description": "New sampling interval in microseconds." }
3995 ],
3996 "description": "Changes CPU profiler sampling interval. Must be called before CPU profiles recording started."
3997 },
3998 {
3999 "name": "start"
4000 },
4001 {
4002 "name": "stop",
4003 "returns": [
4004 { "name": "profile", "$ref": "CPUProfile", "description": "R ecorded profile." }
4005 ]
4006 }
4007 ],
4008 "events": [
4009 {
4010 "name": "consoleProfileStarted",
4011 "parameters": [
4012 { "name": "id", "type": "string" },
4013 { "name": "location", "$ref": "Debugger.Location", "descript ion": "Location of console.profile()." },
4014 { "name": "title", "type": "string", "optional": true, "desc ription": "Profile title passed as argument to console.profile()." }
4015
4016 ],
4017 "description": "Sent when new profile recodring is started using console.profile() call."
4018 },
4019 {
4020 "name": "consoleProfileFinished",
4021 "parameters": [
4022 { "name": "id", "type": "string" },
4023 { "name": "location", "$ref": "Debugger.Location", "descript ion": "Location of console.profileEnd()." },
4024 { "name": "profile", "$ref": "CPUProfile" },
4025 { "name": "title", "type": "string", "optional": true, "desc ription": "Profile title passed as argunet to console.profile()." }
4026 ]
4027 }
4028 ]
4029 },
4030 {
4031 "domain": "HeapProfiler",
4032 "dependencies": ["Runtime"],
4033 "hidden": true,
4034 "types": [
4035 {
4036 "id": "HeapSnapshotObjectId",
4037 "type": "string",
4038 "description": "Heap snapshot object id."
4039 },
4040 {
4041 "id": "SamplingHeapProfileNode",
4042 "type": "object",
4043 "description": "Sampling Heap Profile node. Holds callsite infor mation, allocation statistics and child nodes.",
4044 "properties": [
4045 { "name": "functionName", "type": "string", "description": " Function name." },
4046 { "name": "scriptId", "$ref": "Runtime.ScriptId", "descripti on": "Script identifier." },
4047 { "name": "url", "type": "string", "description": "URL." },
4048 { "name": "lineNumber", "type": "integer", "description": "1 -based line number of the function start position." },
4049 { "name": "columnNumber", "type": "integer", "description": "1-based column number of the function start position." },
4050 { "name": "selfSize", "type": "number", "description": "Allo cations size in bytes for the node excluding children." },
4051 { "name": "children", "type": "array", "items": { "$ref": "S amplingHeapProfileNode" }, "description": "Child nodes." }
4052 ]
4053 },
4054 {
4055 "id": "SamplingHeapProfile",
4056 "type": "object",
4057 "description": "Profile.",
4058 "properties": [
4059 { "name": "head", "$ref": "SamplingHeapProfileNode" }
4060 ]
4061 }
4062 ],
4063 "commands": [
4064 {
4065 "name": "enable"
4066 },
4067 {
4068 "name": "disable"
4069 },
4070 {
4071 "name": "startTrackingHeapObjects",
4072 "parameters": [
4073 { "name": "trackAllocations", "type": "boolean", "optional": true }
4074 ]
4075 },
4076 {
4077 "name": "stopTrackingHeapObjects",
4078 "parameters": [
4079 { "name": "reportProgress", "type": "boolean", "optional": t rue, "description": "If true 'reportHeapSnapshotProgress' events will be generat ed while snapshot is being taken when the tracking is stopped." }
4080 ]
4081
4082 },
4083 {
4084 "name": "takeHeapSnapshot",
4085 "parameters": [
4086 { "name": "reportProgress", "type": "boolean", "optional": t rue, "description": "If true 'reportHeapSnapshotProgress' events will be generat ed while snapshot is being taken." }
4087 ]
4088 },
4089 {
4090 "name": "collectGarbage"
4091 },
4092 {
4093 "name": "getObjectByHeapObjectId",
4094 "parameters": [
4095 { "name": "objectId", "$ref": "HeapSnapshotObjectId" },
4096 { "name": "objectGroup", "type": "string", "optional": true, "description": "Symbolic group name that can be used to release multiple object s." }
4097 ],
4098 "returns": [
4099 { "name": "result", "$ref": "Runtime.RemoteObject", "descrip tion": "Evaluation result." }
4100 ]
4101 },
4102 {
4103 "name": "addInspectedHeapObject",
4104 "parameters": [
4105 { "name": "heapObjectId", "$ref": "HeapSnapshotObjectId", "d escription": "Heap snapshot object id to be accessible by means of $x command li ne API." }
4106 ],
4107 "description": "Enables console to refer to the node with given id via $x (see Command Line API for more details $x functions)."
4108 },
4109 {
4110 "name": "getHeapObjectId",
4111 "parameters": [
4112 { "name": "objectId", "$ref": "Runtime.RemoteObjectId", "des cription": "Identifier of the object to get heap object id for." }
4113 ],
4114 "returns": [
4115 { "name": "heapSnapshotObjectId", "$ref": "HeapSnapshotObjec tId", "description": "Id of the heap snapshot object corresponding to the passed remote object id." }
4116 ]
4117 },
4118 {
4119 "name": "startSampling",
4120 "parameters": [
4121 { "name": "samplingInterval", "type": "number", "optional": true, "description": "Average sample interval in bytes. Poisson distribution is used for the intervals. The default value is 32768 bytes." }
4122 ]
4123 },
4124 {
4125 "name": "stopSampling",
4126 "returns": [
4127 { "name": "profile", "$ref": "SamplingHeapProfile", "descrip tion": "Recorded sampling heap profile." }
4128 ]
4129 }
4130 ],
4131 "events": [
4132 {
4133 "name": "addHeapSnapshotChunk",
4134 "parameters": [
4135 { "name": "chunk", "type": "string" }
4136 ]
4137 },
4138 {
4139 "name": "resetProfiles"
4140 },
4141 {
4142 "name": "reportHeapSnapshotProgress",
4143 "parameters": [
4144 { "name": "done", "type": "integer" },
4145 { "name": "total", "type": "integer" },
4146 { "name": "finished", "type": "boolean", "optional": true }
4147 ]
4148 },
4149 {
4150 "name": "lastSeenObjectId",
4151 "description": "If heap objects tracking has been started then b ackend 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 hea pStatsUpdate events will be sent before a new lastSeenObjectId event.",
4152 "parameters": [
4153 { "name": "lastSeenObjectId", "type": "integer" },
4154 { "name": "timestamp", "type": "number" }
4155 ]
4156 },
4157 {
4158 "name": "heapStatsUpdate",
4159 "description": "If heap objects tracking has been started then b ackend may send update for one or more fragments",
4160 "parameters": [
4161 { "name": "statsUpdate", "type": "array", "items": { "type": "integer" }, "description": "An array of triplets. Each triplet describes a fra gment. The first integer is the fragment index, the second integer is a total co unt of objects for the fragment, the third integer is a total size of the object s for the fragment."}
4162 ]
4163 }
4164 ]
4165 },
4166 {
4167 "domain": "Worker",
4168 "hidden": true,
4169 "types": [],
4170 "commands": [
4171 {
4172 "name": "enable"
4173 },
4174 {
4175 "name": "disable"
4176 },
4177 {
4178 "name": "sendMessageToWorker",
4179 "parameters": [
4180 { "name": "workerId", "type": "string" },
4181 { "name": "message", "type": "string" }
4182 ]
4183 },
4184 {
4185 "name": "setWaitForDebuggerOnStart",
4186 "parameters": [
4187 { "name": "value", "type": "boolean" }
4188 ]
4189 }
4190 ],
4191 "events": [
4192 {
4193 "name": "workerCreated",
4194 "parameters": [
4195 { "name": "workerId", "type": "string" },
4196 { "name": "url", "type": "string" },
4197 { "name": "waitingForDebugger", "type": "boolean" }
4198 ]
4199 },
4200 {
4201 "name": "workerTerminated",
4202 "parameters": [
4203 { "name": "workerId", "type": "string" }
4204 ]
4205 },
4206 {
4207 "name": "dispatchMessageFromWorker",
4208 "parameters": [
4209 { "name": "workerId", "type": "string" },
4210 { "name": "message", "type": "string" }
4211 ]
4212 }
4213 ]
4214 },
4215 {
4216 "domain": "ServiceWorker",
4217 "hidden": true,
4218 "types": [
4219 {
4220 "id": "ServiceWorkerRegistration",
4221 "type": "object",
4222 "description": "ServiceWorker registration.",
4223 "properties": [
4224 { "name": "registrationId", "type": "string" },
4225 { "name": "scopeURL", "type": "string" },
4226 { "name": "isDeleted", "type": "boolean" }
4227 ]
4228 },
4229 {
4230 "id": "ServiceWorkerVersionRunningStatus",
4231 "type": "string",
4232 "enum": ["stopped", "starting", "running", "stopping"]
4233 },
4234 {
4235 "id": "ServiceWorkerVersionStatus",
4236 "type": "string",
4237 "enum": ["new", "installing", "installed", "activating", "activa ted", "redundant"]
4238 },
4239 {
4240 "id": "TargetID",
4241 "type": "string"
4242 },
4243 {
4244 "id": "ServiceWorkerVersion",
4245 "type": "object",
4246 "description": "ServiceWorker version.",
4247 "properties": [
4248 { "name": "versionId", "type": "string" },
4249 { "name": "registrationId", "type": "string" },
4250 { "name": "scriptURL", "type": "string" },
4251 { "name": "runningStatus", "$ref": "ServiceWorkerVersionRunn ingStatus" },
4252 { "name": "status", "$ref": "ServiceWorkerVersionStatus" },
4253 { "name": "scriptLastModified", "type": "number", "optional" : true, "description": "The Last-Modified header value of the main script." },
4254 { "name": "scriptResponseTime", "type": "number", "optional" : true, "description": "The time at which the response headers of the main scrip t were received from the server. For cached script it is the last time the cach e entry was validated." },
4255 { "name": "controlledClients", "type": "array", "optional": true, "items": { "$ref": "TargetID" } }
4256 ]
4257 },
4258 {
4259 "id": "ServiceWorkerErrorMessage",
4260 "type": "object",
4261 "description": "ServiceWorker error message.",
4262 "properties": [
4263 { "name": "errorMessage", "type": "string" },
4264 { "name": "registrationId", "type": "string" },
4265 { "name": "versionId", "type": "string" },
4266 { "name": "sourceURL", "type": "string" },
4267 { "name": "lineNumber", "type": "integer" },
4268 { "name": "columnNumber", "type": "integer" }
4269 ]
4270 },
4271 {
4272 "id": "TargetInfo",
4273 "type": "object",
4274 "properties": [
4275 { "name": "id", "$ref": "TargetID" },
4276 { "name": "type", "type": "string" },
4277 { "name": "title", "type": "string" },
4278 { "name": "url", "type": "string" }
4279 ]
4280 }
4281 ],
4282 "commands": [
4283 {
4284 "name": "enable",
4285 "handlers": ["browser"]
4286 },
4287 {
4288 "name": "disable",
4289 "handlers": ["browser"]
4290 },
4291 {
4292 "name": "sendMessage",
4293 "parameters": [
4294 { "name": "workerId", "type": "string" },
4295 { "name": "message", "type": "string" }
4296 ],
4297 "handlers": ["browser"]
4298 },
4299 {
4300 "name": "stop",
4301 "parameters": [
4302 { "name": "workerId", "type": "string" }
4303 ],
4304 "handlers": ["browser"]
4305 },
4306 {
4307 "name": "unregister",
4308 "parameters": [
4309 { "name": "scopeURL", "type": "string" }
4310 ],
4311 "handlers": ["browser"]
4312 },
4313 {
4314 "name": "updateRegistration",
4315 "parameters": [
4316 { "name": "scopeURL", "type": "string" }
4317 ],
4318 "handlers": ["browser"]
4319 },
4320 {
4321 "name": "startWorker",
4322 "parameters": [
4323 { "name": "scopeURL", "type": "string" }
4324 ],
4325 "handlers": ["browser"]
4326 },
4327 {
4328 "name": "skipWaiting",
4329 "parameters": [
4330 { "name": "scopeURL", "type": "string" }
4331 ],
4332 "handlers": ["browser"]
4333 },
4334 {
4335 "name": "stopWorker",
4336 "parameters": [
4337 { "name": "versionId", "type": "string" }
4338 ],
4339 "handlers": ["browser"]
4340 },
4341 {
4342 "name": "inspectWorker",
4343 "parameters": [
4344 { "name": "versionId", "type": "string" }
4345 ],
4346 "handlers": ["browser"]
4347 },
4348 {
4349 "name": "setForceUpdateOnPageLoad",
4350 "parameters": [
4351 { "name": "forceUpdateOnPageLoad", "type": "boolean" }
4352 ],
4353 "handlers": ["browser"]
4354 },
4355 {
4356 "name": "deliverPushMessage",
4357 "parameters": [
4358 { "name": "origin", "type": "string" },
4359 { "name": "registrationId", "type": "string" },
4360 { "name": "data", "type": "string" }
4361 ],
4362 "handlers": ["browser"]
4363 },
4364 {
4365 "name": "dispatchSyncEvent",
4366 "parameters": [
4367 { "name": "origin", "type": "string" },
4368 { "name": "registrationId", "type": "string" },
4369 { "name": "tag", "type": "string" },
4370 { "name": "lastChance", "type": "boolean" }
4371 ],
4372 "handlers": ["browser"]
4373 },
4374 {
4375 "name": "getTargetInfo",
4376 "parameters": [
4377 { "name": "targetId", "$ref": "TargetID" }
4378 ],
4379 "returns": [
4380 { "name": "targetInfo","$ref": "TargetInfo" }
4381 ],
4382 "handlers": ["browser"]
4383 },
4384 {
4385 "name": "activateTarget",
4386 "parameters": [
4387 { "name": "targetId", "$ref": "TargetID" }
4388 ],
4389 "handlers": ["browser"]
4390 }
4391 ],
4392 "events": [
4393 {
4394 "name": "workerCreated",
4395 "parameters": [
4396 { "name": "workerId", "type": "string" },
4397 { "name": "url", "type": "string" },
4398 { "name": "versionId", "type": "string" }
4399 ],
4400 "handlers": ["browser"]
4401 },
4402 {
4403 "name": "workerTerminated",
4404 "parameters": [
4405 { "name": "workerId", "type": "string" }
4406 ],
4407 "handlers": ["browser"]
4408 },
4409 {
4410 "name": "dispatchMessage",
4411 "parameters": [
4412 { "name": "workerId", "type": "string" },
4413 { "name": "message", "type": "string" }
4414 ],
4415 "handlers": ["browser"]
4416 },
4417 {
4418 "name": "workerRegistrationUpdated",
4419 "parameters": [
4420 { "name": "registrations", "type": "array", "items": { "$ref ": "ServiceWorkerRegistration" } }
4421 ],
4422 "handlers": ["browser"]
4423 },
4424 {
4425 "name": "workerVersionUpdated",
4426 "parameters": [
4427 { "name": "versions", "type": "array", "items": { "$ref": "S erviceWorkerVersion" } }
4428 ],
4429 "handlers": ["browser"]
4430 },
4431 {
4432 "name": "workerErrorReported",
4433 "parameters": [
4434 { "name": "errorMessage", "$ref": "ServiceWorkerErrorMessage " }
4435 ],
4436 "handlers": ["browser"]
4437 }
4438 ]
4439 },
4440 {
4441 "domain": "Input",
4442 "types": [
4443 {
4444 "id": "TouchPoint",
4445 "type": "object",
4446 "hidden": true,
4447 "properties": [
4448 { "name": "state", "type": "string", "enum": ["touchPressed" , "touchReleased", "touchMoved", "touchStationary", "touchCancelled"], "descript ion": "State of the touch point." },
4449 { "name": "x", "type": "integer", "description": "X coordina te of the event relative to the main frame's viewport."},
4450 { "name": "y", "type": "integer", "description": "Y coordina te of the event relative to the main frame's viewport. 0 refers to the top of th e viewport and Y increases as it proceeds towards the bottom of the viewport."},
4451 { "name": "radiusX", "type": "integer", "optional": true, "d escription": "X radius of the touch area (default: 1)."},
4452 { "name": "radiusY", "type": "integer", "optional": true, "d escription": "Y radius of the touch area (default: 1)."},
4453 { "name": "rotationAngle", "type": "number", "optional": tru e, "description": "Rotation angle (default: 0.0)."},
4454 { "name": "force", "type": "number", "optional": true, "desc ription": "Force (default: 1.0)."},
4455 { "name": "id", "type": "number", "optional": true, "descrip tion": "Identifier used to track touch sources between events, must be unique wi thin an event."}
4456 ]
4457 },
4458 {
4459 "id": "GestureSourceType",
4460 "type": "string",
4461 "hidden": true,
4462 "enum": ["default", "touch", "mouse"]
4463 }
4464 ],
4465 "commands": [
4466 {
4467 "name": "dispatchKeyEvent",
4468 "parameters": [
4469 { "name": "type", "type": "string", "enum": ["keyDown", "key Up", "rawKeyDown", "char"], "description": "Type of the key event." },
4470 { "name": "modifiers", "type": "integer", "optional": true, "description": "Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Met a/Command=4, Shift=8 (default: 0)." },
4471 { "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)." },
4472 { "name": "text", "type": "string", "optional": true, "descr iption": "Text as generated by processing a virtual key code with a keyboard lay out. Not needed for for <code>keyUp</code> and <code>rawKeyDown</code> events (d efault: \"\")" },
4473 { "name": "unmodifiedText", "type": "string", "optional": tr ue, "description": "Text that would have been generated by the keyboard if no mo difiers were pressed (except for shift). Useful for shortcut (accelerator) key h andling (default: \"\")." },
4474 { "name": "keyIdentifier", "type": "string", "optional": tru e, "description": "Unique key identifier (e.g., 'U+0041') (default: \"\")." },
4475 { "name": "code", "type": "string", "optional": true, "descr iption": "Unique DOM defined string value for each physical key (e.g., 'KeyA') ( default: \"\")." },
4476 { "name": "key", "type": "string", "optional": true, "descri ption": "Unique DOM defined string value describing the meaning of the key in th e context of active modifiers, keyboard layout, etc (e.g., 'AltGr') (default: \" \")." },
4477 { "name": "windowsVirtualKeyCode", "type": "integer", "optio nal": true, "description": "Windows virtual key code (default: 0)." },
4478 { "name": "nativeVirtualKeyCode", "type": "integer", "option al": true, "description": "Native virtual key code (default: 0)." },
4479 { "name": "autoRepeat", "type": "boolean", "optional": true, "description": "Whether the event was generated from auto repeat (default: fals e)." },
4480 { "name": "isKeypad", "type": "boolean", "optional": true, " description": "Whether the event was generated from the keypad (default: false). " },
4481 { "name": "isSystemKey", "type": "boolean", "optional": true , "description": "Whether the event was a system key event (default: false)." }
4482 ],
4483 "description": "Dispatches a key event to the page.",
4484 "handlers": ["browser"]
4485 },
4486 {
4487 "name": "dispatchMouseEvent",
4488 "parameters": [
4489 { "name": "type", "type": "string", "enum": ["mousePressed", "mouseReleased", "mouseMoved"], "description": "Type of the mouse event." },
4490 { "name": "x", "type": "integer", "description": "X coordina te of the event relative to the main frame's viewport."},
4491 { "name": "y", "type": "integer", "description": "Y coordina te of the event relative to the main frame's viewport. 0 refers to the top of th e viewport and Y increases as it proceeds towards the bottom of the viewport."},
4492 { "name": "modifiers", "type": "integer", "optional": true, "description": "Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Met a/Command=4, Shift=8 (default: 0)." },
4493 { "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)." },
4494 { "name": "button", "type": "string", "enum": ["none", "left ", "middle", "right"], "optional": true, "description": "Mouse button (default: \"none\")." },
4495 { "name": "clickCount", "type": "integer", "optional": true, "description": "Number of times the mouse button was clicked (default: 0)." }
4496 ],
4497 "description": "Dispatches a mouse event to the page.",
4498 "handlers": ["browser"]
4499 },
4500 {
4501 "name": "dispatchTouchEvent",
4502 "hidden": true,
4503 "parameters": [
4504 { "name": "type", "type": "string", "enum": ["touchStart", " touchEnd", "touchMove"], "description": "Type of the touch event." },
4505 { "name": "touchPoints", "type": "array", "items": { "$ref": "TouchPoint" }, "description": "Touch points." },
4506 { "name": "modifiers", "type": "integer", "optional": true, "description": "Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Met a/Command=4, Shift=8 (default: 0)." },
4507 { "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)." }
4508 ],
4509 "description": "Dispatches a touch event to the page."
4510 },
4511 {
4512 "name": "emulateTouchFromMouseEvent",
4513 "hidden": true,
4514 "parameters": [
4515 { "name": "type", "type": "string", "enum": ["mousePressed", "mouseReleased", "mouseMoved", "mouseWheel"], "description": "Type of the mouse event." },
4516 { "name": "x", "type": "integer", "description": "X coordina te of the mouse pointer in DIP."},
4517 { "name": "y", "type": "integer", "description": "Y coordina te of the mouse pointer in DIP."},
4518 { "name": "timestamp", "type": "number", "description": "Tim e at which the event occurred. Measured in UTC time in seconds since January 1, 1970." },
4519 { "name": "button", "type": "string", "enum": ["none", "left ", "middle", "right"], "description": "Mouse button." },
4520 { "name": "deltaX", "type": "number", "optional": true, "des cription": "X delta in DIP for mouse wheel event (default: 0)."},
4521 { "name": "deltaY", "type": "number", "optional": true, "des cription": "Y delta in DIP for mouse wheel event (default: 0)."},
4522 { "name": "modifiers", "type": "integer", "optional": true, "description": "Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Met a/Command=4, Shift=8 (default: 0)." },
4523 { "name": "clickCount", "type": "integer", "optional": true, "description": "Number of times the mouse button was clicked (default: 0)." }
4524 ],
4525 "description": "Emulates touch event from the mouse event parame ters.",
4526 "handlers": ["browser"]
4527 },
4528 {
4529 "name": "synthesizePinchGesture",
4530 "async": true,
4531 "parameters": [
4532 { "name": "x", "type": "integer", "description": "X coordina te of the start of the gesture in CSS pixels." },
4533 { "name": "y", "type": "integer", "description": "Y coordina te of the start of the gesture in CSS pixels." },
4534 { "name": "scaleFactor", "type": "number", "description": "R elative scale factor after zooming (>1.0 zooms in, <1.0 zooms out)." },
4535 { "name": "relativeSpeed", "type": "integer", "optional": tr ue, "description": "Relative pointer speed in pixels per second (default: 800)." },
4536 { "name": "gestureSourceType", "$ref": "GestureSourceType", "optional": true, "description": "Which type of input events to be generated (de fault: 'default', which queries the platform for the preferred input type)." }
4537 ],
4538 "description": "Synthesizes a pinch gesture over a time period b y issuing appropriate touch events.",
4539 "hidden": true,
4540 "handlers": ["browser"]
4541 },
4542 {
4543 "name": "synthesizeScrollGesture",
4544 "async": true,
4545 "parameters": [
4546 { "name": "x", "type": "integer", "description": "X coordina te of the start of the gesture in CSS pixels." },
4547 { "name": "y", "type": "integer", "description": "Y coordina te of the start of the gesture in CSS pixels." },
4548 { "name": "xDistance", "type": "integer", "optional": true, "description": "The distance to scroll along the X axis (positive to scroll left )." },
4549 { "name": "yDistance", "type": "integer", "optional": true, "description": "The distance to scroll along the Y axis (positive to scroll up). " },
4550 { "name": "xOverscroll", "type": "integer", "optional": true , "description": "The number of additional pixels to scroll back along the X axi s, in addition to the given distance." },
4551 { "name": "yOverscroll", "type": "integer", "optional": true , "description": "The number of additional pixels to scroll back along the Y axi s, in addition to the given distance." },
4552 { "name": "preventFling", "type": "boolean", "optional": tru e, "description": "Prevent fling (default: true)." },
4553 { "name": "speed", "type": "integer", "optional": true, "des cription": "Swipe speed in pixels per second (default: 800)." },
4554 { "name": "gestureSourceType", "$ref": "GestureSourceType", "optional": true, "description": "Which type of input events to be generated (de fault: 'default', which queries the platform for the preferred input type)." },
4555 { "name": "repeatCount", "type": "integer", "optional": true , "description": "The number of times to repeat the gesture (default: 0)." },
4556 { "name": "repeatDelayMs", "type": "integer", "optional": tr ue, "description": "The number of milliseconds delay between each repeat. (defau lt: 250)." },
4557 { "name": "interactionMarkerName", "type": "string", "option al": true, "description": "The name of the interaction markers to generate, if n ot empty (default: \"\")." }
4558 ],
4559 "description": "Synthesizes a scroll gesture over a time period by issuing appropriate touch events.",
4560 "hidden": true,
4561 "handlers": ["browser"]
4562 },
4563 {
4564 "name": "synthesizeTapGesture",
4565 "async": true,
4566 "parameters": [
4567 { "name": "x", "type": "integer", "description": "X coordina te of the start of the gesture in CSS pixels." },
4568 { "name": "y", "type": "integer", "description": "Y coordina te of the start of the gesture in CSS pixels." },
4569 { "name": "duration", "type": "integer", "optional": true, " description": "Duration between touchdown and touchup events in ms (default: 50) ." },
4570 { "name": "tapCount", "type": "integer", "optional": true, " description": "Number of times to perform the tap (e.g. 2 for double tap, defaul t: 1)." },
4571 { "name": "gestureSourceType", "$ref": "GestureSourceType", "optional": true, "description": "Which type of input events to be generated (de fault: 'default', which queries the platform for the preferred input type)." }
4572 ],
4573 "description": "Synthesizes a tap gesture over a time period by issuing appropriate touch events.",
4574 "hidden": true,
4575 "handlers": ["browser"]
4576 }
4577 ],
4578 "events": []
4579 },
4580 {
4581 "domain": "LayerTree",
4582 "hidden": true,
4583 "dependencies": ["DOM"],
4584 "types": [
4585 {
4586 "id": "LayerId",
4587 "type": "string",
4588 "description": "Unique Layer identifier."
4589 },
4590 {
4591 "id": "SnapshotId",
4592 "type": "string",
4593 "description": "Unique snapshot identifier."
4594 },
4595 {
4596 "id": "ScrollRect",
4597 "type": "object",
4598 "description": "Rectangle where scrolling happens on the main th read.",
4599 "properties": [
4600 { "name": "rect", "$ref": "DOM.Rect", "description": "Rectan gle itself." },
4601 { "name": "type", "type": "string", "enum": ["RepaintsOnScro ll", "TouchEventHandler", "WheelEventHandler"], "description": "Reason for recta ngle to force scrolling on the main thread" }
4602 ]
4603 },
4604 {
4605 "id": "PictureTile",
4606 "type": "object",
4607 "description": "Serialized fragment of layer picture along with its offset within the layer.",
4608 "properties": [
4609 { "name": "x", "type": "number", "description": "Offset from owning layer left boundary" },
4610 { "name": "y", "type": "number", "description": "Offset from owning layer top boundary" },
4611 { "name": "picture", "type": "string", "description": "Base6 4-encoded snapshot data." }
4612 ]
4613 },
4614 {
4615 "id": "Layer",
4616 "type": "object",
4617 "description": "Information about a compositing layer.",
4618 "properties": [
4619 { "name": "layerId", "$ref": "LayerId", "description": "The unique id for this layer." },
4620 { "name": "parentLayerId", "$ref": "LayerId", "optional": tr ue, "description": "The id of parent (not present for root)." },
4621 { "name": "backendNodeId", "$ref": "DOM.BackendNodeId", "opt ional": true, "description": "The backend id for the node associated with this l ayer." },
4622 { "name": "offsetX", "type": "number", "description": "Offse t from parent layer, X coordinate." },
4623 { "name": "offsetY", "type": "number", "description": "Offse t from parent layer, Y coordinate." },
4624 { "name": "width", "type": "number", "description": "Layer w idth." },
4625 { "name": "height", "type": "number", "description": "Layer height." },
4626 { "name": "transform", "type": "array", "items": { "type": " number" }, "minItems": 16, "maxItems": 16, "optional": true, "description": "Tra nsformation matrix for layer, default is identity matrix" },
4627 { "name": "anchorX", "type": "number", "optional": true, "de scription": "Transform anchor point X, absent if no transform specified" },
4628 { "name": "anchorY", "type": "number", "optional": true, "de scription": "Transform anchor point Y, absent if no transform specified" },
4629 { "name": "anchorZ", "type": "number", "optional": true, "de scription": "Transform anchor point Z, absent if no transform specified" },
4630 { "name": "paintCount", "type": "integer", "description": "I ndicates how many time this layer has painted." },
4631 { "name": "drawsContent", "type": "boolean", "description": "Indicates whether this layer hosts any content, rather than being used for tran sform/scrolling purposes only." },
4632 { "name": "invisible", "type": "boolean", "optional": true, "description": "Set if layer is not visible." },
4633 { "name": "scrollRects", "type": "array", "items": { "$ref": "ScrollRect"}, "optional": true, "description": "Rectangles scrolling on main t hread only."}
4634 ]
4635 },
4636 {
4637 "id": "PaintProfile",
4638 "type": "array",
4639 "description": "Array of timings, one per paint step.",
4640 "items": {
4641 "type": "number",
4642 "description": "A time in seconds since the end of previous step (for the first step, time since painting started)"
4643 }
4644 }
4645 ],
4646 "commands": [
4647 {
4648 "name": "enable",
4649 "description": "Enables compositing tree inspection."
4650 },
4651 {
4652 "name": "disable",
4653 "description": "Disables compositing tree inspection."
4654 },
4655 {
4656 "name": "compositingReasons",
4657 "parameters": [
4658 { "name": "layerId", "$ref": "LayerId", "description": "The id of the layer for which we want to get the reasons it was composited." }
4659 ],
4660 "description": "Provides the reasons why the given layer was com posited.",
4661 "returns": [
4662 { "name": "compositingReasons", "type": "array", "items": { "type": "string" }, "description": "A list of strings specifying reasons for the given layer to become composited." }
4663 ]
4664 },
4665 {
4666 "name": "makeSnapshot",
4667 "parameters": [
4668 { "name": "layerId", "$ref": "LayerId", "description": "The id of the layer." }
4669 ],
4670 "description": "Returns the layer snapshot identifier.",
4671 "returns": [
4672 { "name": "snapshotId", "$ref": "SnapshotId", "description": "The id of the layer snapshot." }
4673 ]
4674 },
4675 {
4676 "name": "loadSnapshot",
4677 "parameters": [
4678 { "name": "tiles", "type": "array", "items": { "$ref": "Pict ureTile" }, "minItems": 1, "description": "An array of tiles composing the snaps hot." }
4679 ],
4680 "description": "Returns the snapshot identifier.",
4681 "returns": [
4682 { "name": "snapshotId", "$ref": "SnapshotId", "description": "The id of the snapshot." }
4683 ]
4684 },
4685 {
4686 "name": "releaseSnapshot",
4687 "parameters": [
4688 { "name": "snapshotId", "$ref": "SnapshotId", "description": "The id of the layer snapshot." }
4689 ],
4690 "description": "Releases layer snapshot captured by the back-end ."
4691 },
4692 {
4693 "name": "profileSnapshot",
4694 "parameters": [
4695 { "name": "snapshotId", "$ref": "SnapshotId", "description": "The id of the layer snapshot." },
4696 { "name": "minRepeatCount", "type": "integer", "optional": t rue, "description": "The maximum number of times to replay the snapshot (1, if n ot specified)." },
4697 { "name": "minDuration", "type": "number", "optional": true, "description": "The minimum duration (in seconds) to replay the snapshot." },
4698 { "name": "clipRect", "$ref": "DOM.Rect", "optional": true, "description": "The clip rectangle to apply when replaying the snapshot." }
4699 ],
4700 "returns": [
4701 { "name": "timings", "type": "array", "items": { "$ref": "Pa intProfile" }, "description": "The array of paint profiles, one per run." }
4702 ]
4703 },
4704 {
4705 "name": "replaySnapshot",
4706 "parameters": [
4707 { "name": "snapshotId", "$ref": "SnapshotId", "description": "The id of the layer snapshot." },
4708 { "name": "fromStep", "type": "integer", "optional": true, " description": "The first step to replay from (replay from the very start if not specified)." },
4709 { "name": "toStep", "type": "integer", "optional": true, "de scription": "The last step to replay to (replay till the end if not specified)." },
4710 { "name": "scale", "type": "number", "optional": true, "desc ription": "The scale to apply while replaying (defaults to 1)." }
4711 ],
4712 "description": "Replays the layer snapshot and returns the resul ting bitmap.",
4713 "returns": [
4714 { "name": "dataURL", "type": "string", "description": "A dat a: URL for resulting image." }
4715 ]
4716 },
4717 {
4718 "name": "snapshotCommandLog",
4719 "parameters": [
4720 { "name": "snapshotId", "$ref": "SnapshotId", "description": "The id of the layer snapshot." }
4721 ],
4722 "description": "Replays the layer snapshot and returns canvas lo g.",
4723 "returns": [
4724 { "name": "commandLog", "type": "array", "items": { "type": "object" }, "description": "The array of canvas function calls." }
4725 ]
4726 }
4727 ],
4728 "events": [
4729 {
4730 "name": "layerTreeDidChange",
4731 "parameters": [
4732 { "name": "layers", "type": "array", "items": { "$ref": "Lay er" }, "optional": true, "description": "Layer tree, absent if not in the comspo siting mode." }
4733 ]
4734 },
4735 {
4736 "name": "layerPainted",
4737 "parameters": [
4738 { "name": "layerId", "$ref": "LayerId", "description": "The id of the painted layer." },
4739 { "name": "clip", "$ref": "DOM.Rect", "description": "Clip r ectangle." }
4740 ]
4741 }
4742 ]
4743 },
4744 {
4745 "domain": "DeviceOrientation",
4746 "hidden": true,
4747 "commands": [
4748 {
4749 "name": "setDeviceOrientationOverride",
4750 "description": "Overrides the Device Orientation.",
4751 "parameters": [
4752 { "name": "alpha", "type": "number", "description": "Mock al pha"},
4753 { "name": "beta", "type": "number", "description": "Mock bet a"},
4754 { "name": "gamma", "type": "number", "description": "Mock ga mma"}
4755 ]
4756 },
4757 {
4758 "name": "clearDeviceOrientationOverride",
4759 "description": "Clears the overridden Device Orientation."
4760 }
4761 ]
4762 },
4763 {
4764 "domain": "Tracing",
4765 "types": [
4766 {
4767 "id": "MemoryDumpConfig",
4768 "type": "object",
4769 "description": "Configuration for memory dump. Used only when \" memory-infra\" category is enabled."
4770 },
4771 {
4772 "id": "TraceConfig",
4773 "type": "object",
4774 "properties": [
4775 { "name": "recordMode", "type": "string", "optional": true, "enum": ["recordUntilFull", "recordContinuously", "recordAsMuchAsPossible", "ech oToConsole"], "description": "Controls how the trace buffer stores data." },
4776 { "name": "enableSampling", "type": "boolean", "optional": t rue, "description": "Turns on JavaScript stack sampling." },
4777 { "name": "enableSystrace", "type": "boolean", "optional": t rue, "description": "Turns on system tracing." },
4778 { "name": "enableArgumentFilter", "type": "boolean", "option al": true, "description": "Turns on argument filter." },
4779 { "name": "includedCategories", "type": "array", "items": { "type": "string" }, "optional": true, "description": "Included category filters. " },
4780 { "name": "excludedCategories", "type": "array", "items": { "type": "string" }, "optional": true, "description": "Excluded category filters. " },
4781 { "name": "syntheticDelays", "type": "array", "items": { "ty pe": "string" }, "optional": true, "description": "Configuration to synthesize t he delays in tracing." },
4782 { "name": "memoryDumpConfig", "$ref": "MemoryDumpConfig", "o ptional": true, "description": "Configuration for memory dump triggers. Used onl y when \"memory-infra\" category is enabled." }
4783 ]
4784 }
4785 ],
4786 "commands": [
4787 {
4788 "name": "start",
4789 "async": true,
4790 "description": "Start trace events collection.",
4791 "parameters": [
4792 { "name": "categories", "type": "string", "optional": true, "deprecated": true, "description": "Category/tag filter" },
4793 { "name": "options", "type": "string", "optional": true, "de precated": true, "description": "Tracing options" },
4794 { "name": "bufferUsageReportingInterval", "type": "number", "optional": true, "description": "If set, the agent will issue bufferUsage event s at this interval, specified in milliseconds" },
4795 { "name": "transferMode", "type": "string", "enum": ["Report Events", "ReturnAsStream"], "optional": true, "description": "Whether to report trace events as series of dataCollected events or to save trace to a stream (def aults to <code>ReportEvents</code>)." },
4796 { "name": "traceConfig", "$ref": "TraceConfig", "optional": true, "description": "" }
4797 ],
4798 "handlers": ["browser", "renderer"]
4799 },
4800 {
4801 "name": "end",
4802 "async": true,
4803 "description": "Stop trace events collection.",
4804 "handlers": ["browser", "renderer"]
4805 },
4806 {
4807 "name": "getCategories",
4808 "async": true,
4809 "description": "Gets supported tracing categories.",
4810 "returns": [
4811 { "name": "categories", "type": "array", "items": { "type": "string" }, "description": "A list of supported tracing categories." }
4812 ],
4813 "handlers": ["browser"]
4814 },
4815 {
4816 "name": "requestMemoryDump",
4817 "async": true,
4818 "description": "Request a global memory dump.",
4819 "returns": [
4820 { "name": "dumpGuid", "type": "string", "description": "GUID of the resulting global memory dump." },
4821 { "name": "success", "type": "boolean", "description": "True iff the global memory dump succeeded." }
4822 ],
4823 "handlers": ["browser"]
4824 },
4825 {
4826 "name": "recordClockSyncMarker",
4827 "description": "Record a clock sync marker in the trace.",
4828 "parameters": [
4829 { "name": "syncId", "type": "string", "description": "The ID of this clock sync marker" }
4830 ],
4831 "handlers": ["browser"]
4832 }
4833 ],
4834 "events": [
4835 {
4836 "name": "dataCollected",
4837 "parameters": [
4838 { "name": "value", "type": "array", "items": { "type": "obje ct" } }
4839 ],
4840 "description": "Contains an bucket of collected trace events. Wh en tracing is stopped collected events will be send as a sequence of dataCollect ed events followed by tracingComplete event.",
4841 "handlers": ["browser"]
4842 },
4843 {
4844 "name": "tracingComplete",
4845 "description": "Signals that tracing is stopped and there is no trace buffers pending flush, all data were delivered via dataCollected events.",
4846 "parameters": [
4847 { "name": "stream", "$ref": "IO.StreamHandle", "optional": t rue, "description": "A handle of the stream that holds resulting trace data." }
4848 ],
4849 "handlers": ["browser"]
4850 },
4851 {
4852 "name": "bufferUsage",
4853 "parameters": [
4854 { "name": "percentFull", "type": "number", "optional": true, "description": "A number in range [0..1] that indicates the used size of event buffer as a fraction of its total size." },
4855 { "name": "eventCount", "type": "number", "optional": true, "description": "An approximate number of events in the trace log." },
4856 { "name": "value", "type": "number", "optional": true, "desc ription": "A number in range [0..1] that indicates the used size of event buffer as a fraction of its total size." }
4857 ],
4858 "handlers": ["browser"]
4859 }
4860 ]
4861 },
4862 {
4863 "domain": "Animation",
4864 "hidden": true,
4865 "dependencies": ["Runtime", "DOM"],
4866 "types": [
4867 {
4868 "id": "Animation",
4869 "type": "object",
4870 "hidden": true,
4871 "properties": [
4872 { "name": "id", "type": "string", "description": "<code>Anim ation</code>'s id." },
4873 { "name": "name", "type": "string", "description": "<code>An imation</code>'s name." },
4874 { "name": "pausedState", "type": "boolean", "hidden": "true" , "description": "<code>Animation</code>'s internal paused state." },
4875 { "name": "playState", "type": "string", "description": "<co de>Animation</code>'s play state." },
4876 { "name": "playbackRate", "type": "number", "description": " <code>Animation</code>'s playback rate." },
4877 { "name": "startTime", "type": "number", "description": "<co de>Animation</code>'s start time." },
4878 { "name": "currentTime", "type": "number", "description": "< code>Animation</code>'s current time." },
4879 { "name": "source", "$ref": "AnimationEffect", "description" : "<code>Animation</code>'s source animation node." },
4880 { "name": "type", "type": "string", "enum": ["CSSTransition" , "CSSAnimation", "WebAnimation"], "description": "Animation type of <code>Anima tion</code>." },
4881 { "name": "cssId", "type": "string", "optional": true, "desc ription": "A unique ID for <code>Animation</code> representing the sources that triggered this CSS animation/transition."}
4882 ],
4883 "description": "Animation instance."
4884 },
4885 {
4886 "id": "AnimationEffect",
4887 "type": "object",
4888 "hidden": true,
4889 "properties": [
4890 { "name": "delay", "type": "number", "description": "<code>A nimationEffect</code>'s delay." },
4891 { "name": "endDelay", "type": "number", "description": "<cod e>AnimationEffect</code>'s end delay." },
4892 { "name": "playbackRate", "type": "number", "description": " <code>AnimationEffect</code>'s playbackRate." },
4893 { "name": "iterationStart", "type": "number", "description": "<code>AnimationEffect</code>'s iteration start." },
4894 { "name": "iterations", "type": "number", "description": "<c ode>AnimationEffect</code>'s iterations." },
4895 { "name": "duration", "type": "number", "description": "<cod e>AnimationEffect</code>'s iteration duration." },
4896 { "name": "direction", "type": "string", "description": "<co de>AnimationEffect</code>'s playback direction." },
4897 { "name": "fill", "type": "string", "description": "<code>An imationEffect</code>'s fill mode." },
4898 { "name": "backendNodeId", "$ref": "DOM.BackendNodeId", "des cription": "<code>AnimationEffect</code>'s target node." },
4899 { "name": "keyframesRule", "$ref": "KeyframesRule", "optiona l": true, "description": "<code>AnimationEffect</code>'s keyframes." },
4900 { "name": "easing", "type": "string", "description": "<code> AnimationEffect</code>'s timing function." }
4901 ],
4902 "description": "AnimationEffect instance"
4903 },
4904 {
4905 "id": "KeyframesRule",
4906 "type": "object",
4907 "properties": [
4908 { "name": "name", "type": "string", "optional": true, "descr iption": "CSS keyframed animation's name." },
4909 { "name": "keyframes", "type": "array", "items": { "$ref": " KeyframeStyle" }, "description": "List of animation keyframes." }
4910 ],
4911 "description": "Keyframes Rule"
4912 },
4913 {
4914 "id": "KeyframeStyle",
4915 "type": "object",
4916 "properties": [
4917 { "name": "offset", "type": "string", "description": "Keyfra me's time offset." },
4918 { "name": "easing", "type": "string", "description": "<code> AnimationEffect</code>'s timing function." }
4919 ],
4920 "description": "Keyframe Style"
4921 }
4922 ],
4923 "commands": [
4924 {
4925 "name": "enable",
4926 "description": "Enables animation domain notifications."
4927 },
4928 {
4929 "name": "disable",
4930 "description": "Disables animation domain notifications."
4931 },
4932 {
4933 "name": "getPlaybackRate",
4934 "returns": [
4935 { "name": "playbackRate", "type": "number", "description": " Playback rate for animations on page."}
4936 ],
4937 "description": "Gets the playback rate of the document timeline. "
4938 },
4939 {
4940 "name": "setPlaybackRate",
4941 "parameters": [
4942 { "name": "playbackRate", "type": "number", "description": " Playback rate for animations on page" }
4943 ],
4944 "description": "Sets the playback rate of the document timeline. "
4945 },
4946 {
4947 "name": "getCurrentTime",
4948 "parameters": [
4949 { "name": "id", "type": "string", "description": "Id of anim ation." }
4950 ],
4951 "returns": [
4952 { "name": "currentTime", "type": "number", "description": "C urrent time of the page." }
4953 ],
4954 "description": "Returns the current time of the an animation."
4955 },
4956 {
4957 "name": "setPaused",
4958 "parameters": [
4959 { "name": "animations", "type": "array", "items": { "type": "string" }, "description": "Animations to set the pause state of." },
4960 { "name": "paused", "type": "boolean", "description": "Pause d state to set to." }
4961 ],
4962 "description": "Sets the paused state of a set of animations."
4963 },
4964 {
4965 "name": "setTiming",
4966 "parameters": [
4967 { "name": "animationId", "type": "string", "description": "A nimation id." },
4968 { "name": "duration", "type": "number", "description": "Dura tion of the animation." },
4969 { "name": "delay", "type": "number", "description": "Delay o f the animation." }
4970 ],
4971 "description": "Sets the timing of an animation node."
4972 },
4973 {
4974 "name": "seekAnimations",
4975 "parameters": [
4976 { "name": "animations", "type": "array", "items": { "type": "string" }, "description": "List of animation ids to seek." },
4977 { "name": "currentTime", "type": "number", "description": "S et the current time of each animation." }
4978 ],
4979 "description": "Seek a set of animations to a particular time wi thin each animation."
4980 },
4981 {
4982 "name": "releaseAnimations",
4983 "parameters": [
4984 { "name": "animations", "type": "array", "items": { "type": "string" }, "description": "List of animation ids to seek." }
4985 ],
4986 "description": "Releases a set of animations to no longer be man ipulated."
4987 },
4988 {
4989 "name": "resolveAnimation",
4990 "parameters": [
4991 { "name": "animationId", "type": "string", "description": "A nimation id." }
4992 ],
4993 "returns": [
4994 { "name": "remoteObject", "$ref": "Runtime.RemoteObject", "d escription": "Corresponding remote object." }
4995 ],
4996 "description": "Gets the remote object of the Animation."
4997 }
4998 ],
4999 "events": [
5000 {
5001 "name": "animationCreated",
5002 "parameters": [
5003 { "name": "id", "type": "string", "description": "Id of the animation that was created." }
5004 ],
5005 "description": "Event for each animation that has been created."
5006 },
5007 {
5008 "name": "animationStarted",
5009 "parameters": [
5010 { "name": "animation", "$ref": "Animation", "description": " Animation that was started." }
5011 ],
5012 "description": "Event for animation that has been started."
5013 },
5014 {
5015 "name": "animationCanceled",
5016 "parameters": [
5017 { "name": "id", "type": "string", "description": "Id of the animation that was cancelled."}
5018 ],
5019 "description": "Event for when an animation has been cancelled."
5020 }
5021 ]
5022 },
5023 {
5024 "domain": "Accessibility",
5025 "hidden": true,
5026 "dependencies": ["DOM"],
5027 "types": [
5028 {
5029 "id": "AXNodeId",
5030 "type": "string",
5031 "description": "Unique accessibility node identifier."
5032 },
5033 {
5034 "id": "AXValueType",
5035 "type": "string",
5036 "enum": [ "boolean", "tristate", "booleanOrUndefined", "idref", "idrefList", "integer", "node", "nodeList", "number", "string", "computedString" , "token", "tokenList", "domRelation", "role", "internalRole", "valueUndefined" ],
5037 "description": "Enum of possible property types."
5038 },
5039 {
5040 "id": "AXValueSourceType",
5041 "type": "string",
5042 "enum": [ "attribute", "implicit", "style", "contents", "placeho lder", "relatedElement" ],
5043 "description": "Enum of possible property sources."
5044 },
5045 { "id": "AXValueNativeSourceType",
5046 "type": "string",
5047 "enum": [ "figcaption", "label", "labelfor", "labelwrapped", "lege nd", "tablecaption", "title", "other" ],
5048 "description": "Enum of possible native property sources (as a sub type of a particular AXValueSourceType)."
5049 },
5050 {
5051 "id": "AXValueSource",
5052 "type": "object",
5053 "properties": [
5054 { "name": "type", "$ref": "AXValueSourceType", "description" : "What type of source this is." },
5055 { "name": "value", "$ref": "AXValue", "description": "The va lue of this property source.", "optional": true },
5056 { "name": "attribute", "type": "string", "description": "The name of the relevant attribute, if any.", "optional": true },
5057 { "name": "attributeValue", "$ref": "AXValue", "description" : "The value of the relevant attribute, if any.", "optional": true },
5058 { "name": "superseded", "type": "boolean", "description": "W hether this source is superseded by a higher priority source.", "optional": true },
5059 { "name": "nativeSource", "$ref": "AXValueNativeSourceType", "description": "The native markup source for this value, e.g. a <label> element .", "optional": true },
5060 { "name": "nativeSourceValue", "$ref": "AXValue", "descripti on": "The value, such as a node or node list, of the native source.", "optional" : true },
5061 { "name": "invalid", "type": "boolean", "description": "Whet her the value for this property is invalid.", "optional": true },
5062 { "name": "invalidReason", "type": "string", "description": "Reason for the value being invalid, if it is.", "optional": true }
5063 ],
5064 "description": "A single source for a computed AX property."
5065 },
5066 {
5067 "id": "AXRelatedNode",
5068 "type": "object",
5069 "properties": [
5070 { "name": "backendNodeId", "$ref": "DOM.BackendNodeId", "des cription": "The BackendNodeId of the related node." },
5071 { "name": "idref", "type": "string", "description": "The IDR ef value provided, if any.", "optional": true },
5072 { "name": "text", "type": "string", "description": "The text alternative of this node in the current context.", "optional": true }
5073 ]
5074 },
5075 {
5076 "id": "AXProperty",
5077 "type": "object",
5078 "properties": [
5079 { "name": "name", "type": "string", "description": "The name of this property." },
5080 { "name": "value", "$ref": "AXValue", "description": "The va lue of this property." }
5081 ]
5082 },
5083 {
5084 "id": "AXValue",
5085 "type": "object",
5086 "properties": [
5087 { "name": "type", "$ref": "AXValueType", "description": "The type of this value." },
5088
5089 { "name": "value", "type": "any", "description": "The comput ed value of this property.", "optional": true },
5090 { "name": "relatedNodes", "type": "array", "items": { "$ref" : "AXRelatedNode" }, "description": "One or more related nodes, if applicable.", "optional": true },
5091 { "name": "sources", "type": "array", "items": { "$ref": "AX ValueSource" }, "description": "The sources which contributed to the computation of this property.", "optional": true }
5092 ],
5093 "description": "A single computed AX property."
5094 },
5095 {
5096 "id": "AXGlobalStates",
5097 "type": "string",
5098 "enum": [ "disabled", "hidden", "hiddenRoot", "invalid" ],
5099 "description": "States which apply to every AX node."
5100 },
5101 {
5102 "id": "AXLiveRegionAttributes",
5103 "type": "string",
5104 "enum": [ "live", "atomic", "relevant", "busy", "root" ],
5105 "description": "Attributes which apply to nodes in live regions. "
5106 },
5107 {
5108 "id": "AXWidgetAttributes",
5109 "type": "string",
5110 "enum": [ "autocomplete", "haspopup", "level", "multiselectable" , "orientation", "multiline", "readonly", "required", "valuemin", "valuemax", "v aluetext" ],
5111 "Description": "Attributes which apply to widgets."
5112 },
5113 {
5114 "id": "AXWidgetStates",
5115 "type": "string",
5116 "enum": [ "checked", "expanded", "pressed", "selected" ],
5117 "description": "States which apply to widgets."
5118 },
5119 {
5120 "id": "AXRelationshipAttributes",
5121 "type": "string",
5122 "enum": [ "activedescendant", "flowto", "controls", "describedby ", "labelledby", "owns" ],
5123 "description": "Relationships between elements other than parent /child/sibling."
5124 },
5125 {
5126 "id": "AXNode",
5127 "type": "object",
5128 "properties": [
5129 { "name": "nodeId", "$ref": "AXNodeId", "description": "Uniq ue identifier for this node." },
5130 { "name": "ignored", "type": "boolean", "description": "Whet her this node is ignored for accessibility" },
5131 { "name": "ignoredReasons", "type": "array", "items": { "$re f": "AXProperty" }, "description": "Collection of reasons why this node is hidde n.", "optional": true },
5132 { "name": "role", "$ref": "AXValue", "description": "This <c ode>Node</code>'s role, whether explicit or implicit.", "optional": true},
5133 { "name": "name", "$ref": "AXValue", "description": "The acc essible name for this <code>Node</code>.", "optional": true },
5134 { "name": "description", "$ref": "AXValue", "description": " The accessible description for this <code>Node</code>.", "optional": true },
5135 { "name": "value", "$ref": "AXValue", "description": "The va lue for this <code>Node</code>.", "optional": true },
5136 { "name": "properties", "type": "array", "items": { "$ref": "AXProperty" }, "description": "All other properties", "optional": true }
5137 ],
5138 "description": "A node in the accessibility tree."
5139 }
5140 ],
5141 "commands": [
5142 {
5143 "name": "getAXNode",
5144 "parameters": [
5145 { "name": "nodeId", "$ref": "DOM.NodeId", "description": "ID of node to get accessibility node for." }
5146 ],
5147 "returns": [
5148 { "name": "accessibilityNode", "$ref": "AXNode", "descriptio n": "The <code>Accessibility.AXNode</code> for this DOM node, if it exists.", "o ptional": true }
5149 ],
5150 "description": "Fetches the accessibility node for this DOM node , if it exists.",
5151 "hidden": true
5152 }
5153 ]
5154 },
5155 {
5156 "domain": "Storage",
5157 "hidden": true,
5158 "types": [
5159 {
5160 "id": "StorageType",
5161 "type": "string",
5162 "enum": [
5163 "appcache",
5164 "cookies",
5165 "file_systems",
5166 "indexeddb",
5167 "local_storage",
5168 "shader_cache",
5169 "websql",
5170 "webrtc_indetity",
5171 "service_workers",
5172 "cache_storage",
5173 "all"
5174 ],
5175 "description": "Enum of possible storage types."
5176 }
5177 ],
5178 "commands": [
5179 {
5180 "name": "clearDataForOrigin",
5181 "parameters": [
5182 { "name": "origin", "type": "string", "description": "Securi ty origin." },
5183 { "name": "storageTypes", "type": "string", "description": " Comma separated origin names." }
5184 ],
5185 "description": "Clears storage for origin.",
5186 "handlers": ["browser"]
5187 }
5188 ]
5189 }]
5190 }
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698