From 0b33a4c6ddd818bb12b2d9feb692460d6ca63d95 Mon Sep 17 00:00:00 2001
From: Georgios Diamantopoulos <georgiosd@gmail.com>
Date: Wed, 15 Mar 2017 21:24:45 +0200
Subject: [PATCH] add recent protocols
---
...vs.ChromeDevTools.ProtocolGenerator.csproj | 9 +-
source/ProtocolGenerator/Program.cs | 3 +-
.../{protocol.json => browser_protocol.json} | 3748 +++++++----------
source/ProtocolGenerator/js_protocol.json | 1084 +++++
4 files changed, 2664 insertions(+), 2180 deletions(-)
rename source/ProtocolGenerator/{protocol.json => browser_protocol.json} (62%)
create mode 100644 source/ProtocolGenerator/js_protocol.json
diff --git a/source/ProtocolGenerator/MasterDevs.ChromeDevTools.ProtocolGenerator.csproj b/source/ProtocolGenerator/MasterDevs.ChromeDevTools.ProtocolGenerator.csproj
index cd0b46d..2f280b1 100644
--- a/source/ProtocolGenerator/MasterDevs.ChromeDevTools.ProtocolGenerator.csproj
+++ b/source/ProtocolGenerator/MasterDevs.ChromeDevTools.ProtocolGenerator.csproj
@@ -67,6 +67,9 @@
</ItemGroup>
<ItemGroup>
<None Include="App.config" />
+ <None Include="browser_protocol.json">
+ <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+ </None>
<None Include="Inspector-0.1.json">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
@@ -88,12 +91,12 @@
<None Include="Inspector-iOS-9.3.json">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
+ <None Include="js_protocol.json">
+ <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+ </None>
<None Include="packages.config">
<SubType>Designer</SubType>
</None>
- <None Include="protocol.json">
- <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
- </None>
</ItemGroup>
<Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
<Import Project="$(SolutionDir)\.nuget\NuGet.targets" Condition="Exists('$(SolutionDir)\.nuget\NuGet.targets')" />
diff --git a/source/ProtocolGenerator/Program.cs b/source/ProtocolGenerator/Program.cs
index dab543f..574676d 100644
--- a/source/ProtocolGenerator/Program.cs
+++ b/source/ProtocolGenerator/Program.cs
@@ -32,7 +32,8 @@ namespace MasterDevs.ChromeDevTools.ProtocolGenerator
//protocolFiles.Add("Chrome-0.1", "Inspector-0.1.json");
//protocolFiles.Add("Chrome-1.0", "Inspector-1.0.json");
//protocolFiles.Add("Chrome", "Inspector-1.1.json");
- protocolFiles.Add("Chrome", "protocol.json");
+ protocolFiles.Add("Chrome", "browser_protocol.json");
+ protocolFiles.Add("ChromeJS", "js_protocol.json");
//protocolFiles.Add("iOS-7.0", "Inspector-iOS-7.0.json");
//protocolFiles.Add("iOS-8.0", "Inspector-iOS-8.0.json");
//protocolFiles.Add("iOS-9.0", "Inspector-iOS-9.0.json");
diff --git a/source/ProtocolGenerator/protocol.json b/source/ProtocolGenerator/browser_protocol.json
similarity index 62%
rename from source/ProtocolGenerator/protocol.json
rename to source/ProtocolGenerator/browser_protocol.json
index ea0dc88..83974fd 100644
--- a/source/ProtocolGenerator/protocol.json
+++ b/source/ProtocolGenerator/browser_protocol.json
@@ -1,8 +1,8 @@
{
- "version": { "major": "1", "minor": "1" },
+ "version": { "major": "1", "minor": "2" },
"domains": [{
"domain": "Inspector",
- "hidden": true,
+ "experimental": true,
"types": [],
"commands": [
{
@@ -15,38 +15,30 @@
}
],
"events": [
- {
- "name": "evaluateForTestInFrontend",
- "parameters": [
- { "name": "testCallId", "type": "integer" },
- { "name": "script", "type": "string" }
- ]
- },
- {
- "name": "inspect",
- "parameters": [
- { "name": "object", "$ref": "Runtime.RemoteObject" },
- { "name": "hints", "type": "object" }
- ]
- },
{
"name": "detached",
"description": "Fired when remote debugging connection is about to be terminated. Contains detach reason.",
"parameters": [
{ "name": "reason", "type": "string", "description": "The reason why connection has been terminated." }
- ],
- "handlers": ["browser"]
+ ]
},
{
"name": "targetCrashed",
- "description": "Fired when debugging target has crashed",
- "handlers": ["browser"]
+ "description": "Fired when debugging target has crashed"
}
]
},
{
"domain": "Memory",
- "hidden": true,
+ "experimental": true,
+ "types": [
+ {
+ "id": "PressureLevel",
+ "type": "string",
+ "enum": ["moderate", "critical"],
+ "description": "Memory pressure level."
+ }
+ ],
"commands": [
{
"name": "getDOMCounters",
@@ -55,17 +47,32 @@
{ "name": "nodes", "type": "integer" },
{ "name": "jsEventListeners", "type": "integer" }
]
+ },
+ {
+ "name": "setPressureNotificationsSuppressed",
+ "description": "Enable/disable suppressing memory pressure notifications in all processes.",
+ "parameters": [
+ { "name": "suppressed", "type": "boolean", "description": "If true, memory pressure notifications will be suppressed."}
+ ]
+ },
+ {
+ "name": "simulatePressureNotification",
+ "description": "Simulate a memory pressure notification in all processes.",
+ "parameters": [
+ { "name": "level", "$ref": "PressureLevel", "description": "Memory pressure level of the notification." }
+ ]
}
]
},
{
"domain": "Page",
"description": "Actions and events related to the inspected page belong to the page domain.",
+ "dependencies": ["Debugger", "DOM"],
"types": [
{
"id": "ResourceType",
"type": "string",
- "enum": ["Document", "Stylesheet", "Image", "Media", "Font", "Script", "TextTrack", "XHR", "WebSocket", "Other"],
+ "enum": ["Document", "Stylesheet", "Image", "Media", "Font", "Script", "TextTrack", "XHR", "Fetch", "EventSource", "WebSocket", "Manifest", "Other"],
"description": "Resource type as it was perceived by the rendering engine."
},
{
@@ -87,6 +94,21 @@
{ "name": "mimeType", "type": "string", "description": "Frame document's mimeType as determined by the browser." }
]
},
+ {
+ "id": "FrameResource",
+ "type": "object",
+ "description": "Information about the Resource on the page.",
+ "properties": [
+ { "name": "url", "type": "string", "description": "Resource URL." },
+ { "name": "type", "$ref": "ResourceType", "description": "Type of this resource." },
+ { "name": "mimeType", "type": "string", "description": "Resource mimeType as determined by the browser." },
+ { "name": "lastModified", "$ref": "Network.Timestamp", "description": "last-modified timestamp as reported by server.", "optional": true },
+ { "name": "contentSize", "type": "number", "description": "Resource content size.", "optional": true },
+ { "name": "failed", "type": "boolean", "optional": true, "description": "True if the resource failed to load." },
+ { "name": "canceled", "type": "boolean", "optional": true, "description": "True if the resource was canceled during loading." }
+ ],
+ "experimental": true
+ },
{
"id": "FrameResourceTree",
"type": "object",
@@ -94,27 +116,15 @@
"properties": [
{ "name": "frame", "$ref": "Frame", "description": "Frame information for this tree item." },
{ "name": "childFrames", "type": "array", "optional": true, "items": { "$ref": "FrameResourceTree" }, "description": "Child frames." },
- { "name": "resources", "type": "array",
- "items": {
- "type": "object",
- "properties": [
- { "name": "url", "type": "string", "description": "Resource URL." },
- { "name": "type", "$ref": "ResourceType", "description": "Type of this resource." },
- { "name": "mimeType", "type": "string", "description": "Resource mimeType as determined by the browser." },
- { "name": "failed", "type": "boolean", "optional": true, "description": "True if the resource failed to load." },
- { "name": "canceled", "type": "boolean", "optional": true, "description": "True if the resource was canceled during loading." }
- ]
- },
- "description": "Information about frame resources."
- }
- ],
- "hidden": true
+ { "name": "resources", "type": "array", "items": { "$ref": "FrameResource" }, "description": "Information about frame resources." }
+ ],
+ "experimental": true
},
{
"id": "ScriptIdentifier",
"type": "string",
"description": "Unique script identifier.",
- "hidden": true
+ "experimental": true
},
{
"id": "NavigationEntry",
@@ -125,34 +135,85 @@
{ "name": "url", "type": "string", "description": "URL of the navigation history entry." },
{ "name": "title", "type": "string", "description": "Title of the navigation history entry." }
],
- "hidden": true
+ "experimental": true
},
{
"id": "ScreencastFrameMetadata",
"type": "object",
- "description": "Screencast frame metadata",
+ "description": "Screencast frame metadata.",
+ "properties": [
+ { "name": "offsetTop", "type": "number", "experimental": true, "description": "Top offset in DIP." },
+ { "name": "pageScaleFactor", "type": "number", "experimental": true, "description": "Page scale factor." },
+ { "name": "deviceWidth", "type": "number", "experimental": true, "description": "Device screen width in DIP." },
+ { "name": "deviceHeight", "type": "number", "experimental": true, "description": "Device screen height in DIP." },
+ { "name": "scrollOffsetX", "type": "number", "experimental": true, "description": "Position of horizontal scroll in CSS pixels." },
+ { "name": "scrollOffsetY", "type": "number", "experimental": true, "description": "Position of vertical scroll in CSS pixels." },
+ { "name": "timestamp", "type": "number", "optional": true, "experimental": true, "description": "Frame swap timestamp." }
+ ],
+ "experimental": true
+ },
+ {
+ "id": "DialogType",
+ "description": "Javascript dialog type.",
+ "type": "string",
+ "enum": ["alert", "confirm", "prompt", "beforeunload"],
+ "experimental": true
+ },
+ {
+ "id": "AppManifestError",
+ "description": "Error while paring app manifest.",
+ "type": "object",
+ "properties": [
+ { "name": "message", "type": "string", "description": "Error message." },
+ { "name": "critical", "type": "integer", "description": "If criticial, this is a non-recoverable parse error." },
+ { "name": "line", "type": "integer", "description": "Error line." },
+ { "name": "column", "type": "integer", "description": "Error column." }
+ ],
+ "experimental": true
+ },
+ {
+ "id": "NavigationResponse",
+ "description": "Proceed: allow the navigation; Cancel: cancel the navigation; CancelAndIgnore: cancels the navigation and makes the requester of the navigation acts like the request was never made.",
+ "type": "string",
+ "enum": ["Proceed", "Cancel", "CancelAndIgnore"],
+ "experimental": true
+ },
+ {
+ "id": "LayoutViewport",
+ "type": "object",
+ "description": "Layout viewport position and dimensions.",
+ "experimental": true,
+ "properties": [
+ { "name": "pageX", "type": "integer", "description": "Horizontal offset relative to the document (CSS pixels)." },
+ { "name": "pageY", "type": "integer", "description": "Vertical offset relative to the document (CSS pixels)." },
+ { "name": "clientWidth", "type": "integer", "description": "Width (CSS pixels), excludes scrollbar if present." },
+ { "name": "clientHeight", "type": "integer", "description": "Height (CSS pixels), excludes scrollbar if present." }
+ ]
+ },
+ {
+ "id": "VisualViewport",
+ "type": "object",
+ "description": "Visual viewport position, dimensions, and scale.",
+ "experimental": true,
"properties": [
- { "name": "offsetTop", "type": "number", "hidden": true, "description": "Top offset in DIP." },
- { "name": "pageScaleFactor", "type": "number", "hidden": true, "description": "Page scale factor." },
- { "name": "deviceWidth", "type": "number", "hidden": true, "description": "Device screen width in DIP." },
- { "name": "deviceHeight", "type": "number", "hidden": true, "description": "Device screen height in DIP." },
- { "name": "scrollOffsetX", "type": "number", "hidden": true, "description": "Position of horizontal scroll in CSS pixels." },
- { "name": "scrollOffsetY", "type": "number", "hidden": true, "description": "Position of vertical scroll in CSS pixels." },
- { "name": "timestamp", "type": "number", "optional": true, "hidden": true, "description": "Frame swap timestamp." }
- ],
- "hidden": true
+ { "name": "offsetX", "type": "number", "description": "Horizontal offset relative to the layout viewport (CSS pixels)." },
+ { "name": "offsetY", "type": "number", "description": "Vertical offset relative to the layout viewport (CSS pixels)." },
+ { "name": "pageX", "type": "number", "description": "Horizontal offset relative to the document (CSS pixels)." },
+ { "name": "pageY", "type": "number", "description": "Vertical offset relative to the document (CSS pixels)." },
+ { "name": "clientWidth", "type": "number", "description": "Width (CSS pixels), excludes scrollbar if present." },
+ { "name": "clientHeight", "type": "number", "description": "Height (CSS pixels), excludes scrollbar if present." },
+ { "name": "scale", "type": "number", "description": "Scale relative to the ideal viewport (size at width=device-width)." }
+ ]
}
],
"commands": [
{
"name": "enable",
- "description": "Enables page domain notifications.",
- "handlers": ["browser", "renderer"]
+ "description": "Enables page domain notifications."
},
{
"name": "disable",
- "description": "Disables page domain notifications.",
- "handlers": ["browser", "renderer"]
+ "description": "Disables page domain notifications."
},
{
"name": "addScriptToEvaluateOnLoad",
@@ -162,14 +223,22 @@
"returns": [
{ "name": "identifier", "$ref": "ScriptIdentifier", "description": "Identifier of the added script." }
],
- "hidden": true
+ "experimental": true
},
{
"name": "removeScriptToEvaluateOnLoad",
"parameters": [
{ "name": "identifier", "$ref": "ScriptIdentifier" }
],
- "hidden": true
+ "experimental": true
+ },
+ {
+ "name": "setAutoAttachToCreatedPages",
+ "parameters": [
+ { "name": "autoAttach", "type": "boolean", "description": "If true, browser will open a new inspector window for every page created from this one." }
+ ],
+ "description": "Controls whether browser will open a new inspector window for connected pages.",
+ "experimental": true
},
{
"name": "reload",
@@ -177,30 +246,32 @@
{ "name": "ignoreCache", "type": "boolean", "optional": true, "description": "If true, browser cache is ignored (as if the user pressed Shift+refresh)." },
{ "name": "scriptToEvaluateOnLoad", "type": "string", "optional": true, "description": "If set, the script will be injected into all frames of the inspected page after reload." }
],
- "description": "Reloads given page optionally ignoring the cache.",
- "handlers": ["browser", "renderer"]
+ "description": "Reloads given page optionally ignoring the cache."
},
{
"name": "navigate",
"parameters": [
- { "name": "url", "type": "string", "description": "URL to navigate the page to." }
+ { "name": "url", "type": "string", "description": "URL to navigate the page to." },
+ { "name": "referrer", "type": "string", "optional": true, "experimental": true, "description": "Referrer URL." }
],
"returns": [
- { "name": "frameId", "$ref": "FrameId", "hidden": true, "description": "Frame id that will be navigated." }
+ { "name": "frameId", "$ref": "FrameId", "experimental": true, "description": "Frame id that will be navigated." }
],
- "description": "Navigates current page to the given URL.",
- "handlers": ["browser", "renderer"]
+ "description": "Navigates current page to the given URL."
+ },
+ {
+ "name": "stopLoading",
+ "description": "Force the page stop all navigations and pending resource fetches.",
+ "experimental": true
},
{
"name": "getNavigationHistory",
- "parameters": [],
"returns": [
{ "name": "currentIndex", "type": "integer", "description": "Index of the current navigation history entry." },
{ "name": "entries", "type": "array", "items": { "$ref": "NavigationEntry" }, "description": "Array of navigation history entries." }
],
"description": "Returns navigation history for the current page.",
- "hidden": true,
- "handlers": ["browser"]
+ "experimental": true
},
{
"name": "navigateToHistoryEntry",
@@ -208,8 +279,7 @@
{ "name": "entryId", "type": "integer", "description": "Unique id of the entry to navigate to." }
],
"description": "Navigates current page to the given history entry.",
- "hidden": true,
- "handlers": ["browser"]
+ "experimental": true
},
{
"name": "getCookies",
@@ -217,9 +287,7 @@
{ "name": "cookies", "type": "array", "items": { "$ref": "Network.Cookie" }, "description": "Array of cookie objects." }
],
"description": "Returns all browser cookies. Depending on the backend support, will return detailed cookie information in the <code>cookies</code> field.",
- "handlers": ["browser"],
- "async": true,
- "hidden": true,
+ "experimental": true,
"redirect": "Network"
},
{
@@ -229,9 +297,7 @@
{ "name": "url", "type": "string", "description": "URL to match cooke domain and path." }
],
"description": "Deletes browser cookie with given name, domain and path.",
- "handlers": ["browser"],
- "async": true,
- "hidden": true,
+ "experimental": true,
"redirect": "Network"
},
{
@@ -240,11 +306,10 @@
"returns": [
{ "name": "frameTree", "$ref": "FrameResourceTree", "description": "Present frame / resource tree structure." }
],
- "hidden": true
+ "experimental": true
},
{
"name": "getResourceContent",
- "async": true,
"description": "Returns content of the given resource.",
"parameters": [
{ "name": "frameId", "$ref": "FrameId", "description": "Frame id to get resource for." },
@@ -254,7 +319,7 @@
{ "name": "content", "type": "string", "description": "Resource content." },
{ "name": "base64Encoded", "type": "boolean", "description": "True, if content was served as base64." }
],
- "hidden": true
+ "experimental": true
},
{
"name": "searchInResource",
@@ -269,7 +334,7 @@
"returns": [
{ "name": "result", "type": "array", "items": { "$ref": "Debugger.SearchMatch" }, "description": "List of search matches." }
],
- "hidden": true
+ "experimental": true
},
{
"name": "setDocumentContent",
@@ -278,7 +343,7 @@
{ "name": "frameId", "$ref": "FrameId", "description": "Frame id to set HTML for." },
{ "name": "html", "type": "string", "description": "HTML content to set." }
],
- "hidden": true
+ "experimental": true
},
{
"name": "setDeviceMetricsOverride",
@@ -291,18 +356,21 @@
{ "name": "fitWindow", "type": "boolean", "description": "Whether a view that exceeds the available browser window area should be scaled down to fit." },
{ "name": "scale", "type": "number", "optional": true, "description": "Scale to apply to resulting view image. Ignored in |fitWindow| mode." },
{ "name": "offsetX", "type": "number", "optional": true, "description": "X offset to shift resulting view image by. Ignored in |fitWindow| mode." },
- { "name": "offsetY", "type": "number", "optional": true, "description": "Y offset to shift resulting view image by. Ignored in |fitWindow| mode." }
+ { "name": "offsetY", "type": "number", "optional": true, "description": "Y offset to shift resulting view image by. Ignored in |fitWindow| mode." },
+ { "name": "screenWidth", "type": "integer", "optional": true, "description": "Overriding screen width value in pixels (minimum 0, maximum 10000000). Only used for |mobile==true|." },
+ { "name": "screenHeight", "type": "integer", "optional": true, "description": "Overriding screen height value in pixels (minimum 0, maximum 10000000). Only used for |mobile==true|." },
+ { "name": "positionX", "type": "integer", "optional": true, "description": "Overriding view X position on screen in pixels (minimum 0, maximum 10000000). Only used for |mobile==true|." },
+ { "name": "positionY", "type": "integer", "optional": true, "description": "Overriding view Y position on screen in pixels (minimum 0, maximum 10000000). Only used for |mobile==true|." },
+ { "name": "screenOrientation", "$ref": "Emulation.ScreenOrientation", "optional": true, "description": "Screen orientation override." }
],
- "handlers": ["browser"],
"redirect": "Emulation",
- "hidden": true
+ "experimental": true
},
{
"name": "clearDeviceMetricsOverride",
"description": "Clears the overriden device metrics.",
- "handlers": ["browser"],
"redirect": "Emulation",
- "hidden": true
+ "experimental": true
},
{
"name": "setGeolocationOverride",
@@ -312,14 +380,12 @@
{ "name": "longitude", "type": "number", "optional": true, "description": "Mock longitude"},
{ "name": "accuracy", "type": "number", "optional": true, "description": "Mock accuracy"}
],
- "redirect": "Emulation",
- "handlers": ["browser"]
+ "redirect": "Emulation"
},
{
"name": "clearGeolocationOverride",
"description": "Clears the overriden Geolocation Position and Error.",
- "redirect": "Emulation",
- "handlers": ["browser"]
+ "redirect": "Emulation"
},
{
"name": "setDeviceOrientationOverride",
@@ -330,13 +396,13 @@
{ "name": "gamma", "type": "number", "description": "Mock gamma"}
],
"redirect": "DeviceOrientation",
- "hidden": true
+ "experimental": true
},
{
"name": "clearDeviceOrientationOverride",
"description": "Clears the overridden Device Orientation.",
"redirect": "DeviceOrientation",
- "hidden": true
+ "experimental": true
},
{
"name": "setTouchEmulationEnabled",
@@ -345,29 +411,28 @@
{ "name": "configuration", "type": "string", "enum": ["mobile", "desktop"], "optional": true, "description": "Touch/gesture events configuration. Default: current platform." }
],
"description": "Toggles mouse event-based touch event emulation.",
- "hidden": true,
- "redirect": "Emulation",
- "handlers": ["browser", "renderer"]
+ "experimental": true,
+ "redirect": "Emulation"
},
{
"name": "captureScreenshot",
- "async": true,
"description": "Capture page screenshot.",
- "parameters": [],
+ "parameters": [
+ { "name": "format", "type": "string", "optional": true, "enum": ["jpeg", "png"], "description": "Image compression format (defaults to png)." },
+ { "name": "quality", "type": "integer", "optional": true, "description": "Compression quality from range [0..100] (jpeg only)." }
+ ],
"returns": [
- { "name": "data", "type": "string", "description": "Base64-encoded image data (PNG)." }
+ { "name": "data", "type": "string", "description": "Base64-encoded image data." }
],
- "hidden": true,
- "handlers": ["browser"]
+ "experimental": true
},
{
- "name": "canScreencast",
- "description": "Tells whether screencast is supported.",
+ "name": "printToPDF",
+ "description": "Print page as pdf.",
"returns": [
- { "name": "result", "type": "boolean", "description": "True if screencast is supported." }
+ { "name": "data", "type": "string", "description": "Base64-encoded pdf data." }
],
- "hidden": true,
- "handlers": ["browser"]
+ "experimental": true
},
{
"name": "startScreencast",
@@ -376,25 +441,23 @@
{ "name": "format", "type": "string", "optional": true, "enum": ["jpeg", "png"], "description": "Image compression format." },
{ "name": "quality", "type": "integer", "optional": true, "description": "Compression quality from range [0..100]." },
{ "name": "maxWidth", "type": "integer", "optional": true, "description": "Maximum screenshot width." },
- { "name": "maxHeight", "type": "integer", "optional": true, "description": "Maximum screenshot height." }
+ { "name": "maxHeight", "type": "integer", "optional": true, "description": "Maximum screenshot height." },
+ { "name": "everyNthFrame", "type": "integer", "optional": true, "description": "Send every n-th frame." }
],
- "hidden": true,
- "handlers": ["browser", "renderer"]
+ "experimental": true
},
{
"name": "stopScreencast",
"description": "Stops sending each frame in the <code>screencastFrame</code>.",
- "hidden": true,
- "handlers": ["browser", "renderer"]
+ "experimental": true
},
{
"name": "screencastFrameAck",
"description": "Acknowledges that a screencast frame has been received by the frontend.",
"parameters": [
- { "name": "frameNumber", "type": "integer", "description": "Frame number." }
+ { "name": "sessionId", "type": "integer", "description": "Frame number." }
],
- "hidden": true,
- "handlers": ["browser"]
+ "experimental": true
},
{
"name": "handleJavaScriptDialog",
@@ -402,35 +465,64 @@
"parameters": [
{ "name": "accept", "type": "boolean", "description": "Whether to accept or dismiss the dialog." },
{ "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." }
+ ]
+ },
+ {
+ "name": "setColorPickerEnabled",
+ "parameters": [
+ { "name": "enabled", "type": "boolean", "description": "Shows / hides color picker" }
],
- "hidden": true,
- "handlers": ["browser"]
+ "description": "Shows / hides color picker",
+ "experimental": true
},
{
- "name": "setShowViewportSizeOnResize",
- "description": "Paints viewport size upon main frame resize.",
+ "name": "configureOverlay",
"parameters": [
- { "name": "show", "type": "boolean", "description": "Whether to paint size or not." },
- { "name": "showGrid", "type": "boolean", "optional": true, "description": "Whether to paint grid as well." }
+ { "name": "suspended", "type": "boolean", "optional": true, "description": "Whether overlay should be suspended and not consume any resources." },
+ { "name": "message", "type": "string", "optional": true, "description": "Overlay message to display." }
],
- "hidden": true
+ "experimental": true,
+ "description": "Configures overlay."
},
{
- "name": "setColorPickerEnabled",
+ "name": "getAppManifest",
+ "experimental": true,
+ "returns": [
+ { "name": "url", "type": "string", "description": "Manifest location." },
+ { "name": "errors", "type": "array", "items": { "$ref": "AppManifestError" } },
+ { "name": "data", "type": "string", "optional": true, "description": "Manifest content." }
+ ]
+ },
+ {
+ "name": "requestAppBanner",
+ "experimental": true
+ },
+ {
+ "name": "setControlNavigations",
"parameters": [
- { "name": "enabled", "type": "boolean", "description": "Shows / hides color picker" }
+ { "name": "enabled", "type": "boolean" }
],
- "description": "Shows / hides color picker",
- "hidden": true,
- "handlers": ["browser"]
+ "description": "Toggles navigation throttling which allows programatic control over navigation and redirect response.",
+ "experimental": true
},
{
- "name": "setOverlayMessage",
+ "name": "processNavigation",
"parameters": [
- { "name": "message", "type": "string", "optional": true, "description": "Overlay message to display when paused in debugger." }
+ { "name": "response", "$ref": "NavigationResponse" },
+ { "name": "navigationId", "type": "integer" }
],
- "hidden": true,
- "description": "Sets overlay message."
+ "description": "Should be sent in response to a navigationRequested or a redirectRequested event, telling the browser how to handle the navigation.",
+ "experimental": true
+ },
+ {
+ "name": "getLayoutMetrics",
+ "description": "Returns metrics relating to the layouting of the page, such as viewport bounds/scale.",
+ "experimental": true,
+ "returns": [
+ { "name": "layoutViewport", "$ref": "LayoutViewport", "description": "Metrics relating to the layout viewport." },
+ { "name": "visualViewport", "$ref": "VisualViewport", "description": "Metrics relating to the visual viewport." },
+ { "name": "contentSize", "$ref": "DOM.Rect", "description": "Size of scrollable area."}
+ ]
}
],
"events": [
@@ -474,7 +566,7 @@
"parameters": [
{ "name": "frameId", "$ref": "FrameId", "description": "Id of the frame that has started loading." }
],
- "hidden": true
+ "experimental": true
},
{
"name": "frameStoppedLoading",
@@ -482,7 +574,7 @@
"parameters": [
{ "name": "frameId", "$ref": "FrameId", "description": "Id of the frame that has stopped loading." }
],
- "hidden": true
+ "experimental": true
},
{
"name": "frameScheduledNavigation",
@@ -491,7 +583,7 @@
{ "name": "frameId", "$ref": "FrameId", "description": "Id of the frame that has scheduled a navigation." },
{ "name": "delay", "type": "number", "description": "Delay (in seconds) until the navigation is scheduled to begin. The navigation is not guaranteed to start." }
],
- "hidden": true
+ "experimental": true
},
{
"name": "frameClearedScheduledNavigation",
@@ -499,24 +591,26 @@
"parameters": [
{ "name": "frameId", "$ref": "FrameId", "description": "Id of the frame that has cleared its scheduled navigation." }
],
- "hidden": true
+ "experimental": true
},
{
"name": "frameResized",
- "hidden": true
+ "experimental": true
},
{
"name": "javascriptDialogOpening",
"description": "Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) is about to open.",
"parameters": [
- { "name": "message", "type": "string", "description": "Message that will be displayed by the dialog." }
- ],
- "hidden": true
+ { "name": "message", "type": "string", "description": "Message that will be displayed by the dialog." },
+ { "name": "type", "$ref": "DialogType", "description": "Dialog type." }
+ ]
},
{
"name": "javascriptDialogClosed",
"description": "Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) has been closed.",
- "hidden": true
+ "parameters": [
+ { "name": "result", "type": "boolean", "description": "Whether dialog was confirmed." }
+ ]
},
{
"name": "screencastFrame",
@@ -524,10 +618,9 @@
"parameters": [
{ "name": "data", "type": "string", "description": "Base64-encoded compressed image." },
{ "name": "metadata", "$ref": "ScreencastFrameMetadata", "description": "Screencast frame metadata."},
- { "name": "frameNumber", "type": "integer", "optional": true, "description": "Frame number."}
+ { "name": "sessionId", "type": "integer", "description": "Frame number."}
],
- "hidden": true,
- "handlers": ["browser"]
+ "experimental": true
},
{
"name": "screencastVisibilityChanged",
@@ -535,8 +628,7 @@
"parameters": [
{ "name": "visible", "type": "boolean", "description": "True if the page is visible." }
],
- "hidden": true,
- "handlers": ["browser"]
+ "experimental": true
},
{
"name": "colorPicked",
@@ -544,27 +636,32 @@
"parameters": [
{ "name": "color", "$ref": "DOM.RGBA", "description": "RGBA of the picked color." }
],
- "hidden": true,
- "handlers": ["browser"]
+ "experimental": true
},
{
"name": "interstitialShown",
- "description": "Fired when interstitial page was shown",
- "hidden": true,
- "handlers": ["browser"]
+ "description": "Fired when interstitial page was shown"
},
{
"name": "interstitialHidden",
- "description": "Fired when interstitial page was hidden",
- "hidden": true,
- "handlers": ["browser"]
+ "description": "Fired when interstitial page was hidden"
+ },
+ {
+ "name": "navigationRequested",
+ "description": "Fired when a navigation is started if navigation throttles are enabled. The navigation will be deferred until processNavigation is called.",
+ "parameters": [
+ { "name": "isInMainFrame", "type": "boolean", "description": "Whether the navigation is taking place in the main frame or in a subframe." },
+ { "name": "isRedirect", "type": "boolean", "description": "Whether the navigation has encountered a server redirect or not." },
+ { "name": "navigationId", "type": "integer" },
+ { "name": "url", "type": "string", "description": "URL of requested navigation." }
+ ]
}
]
},
{
"domain": "Rendering",
"description": "This domain allows to control rendering of the page.",
- "hidden": true,
+ "experimental": true,
"commands": [
{
"name": "setShowPaintRects",
@@ -588,17 +685,17 @@
]
},
{
- "name": "setContinuousPaintingEnabled",
- "description": "Requests that backend enables continuous painting",
+ "name": "setShowScrollBottleneckRects",
+ "description": "Requests that backend shows scroll bottleneck rects",
"parameters": [
- { "name": "enabled", "type": "boolean", "description": "True for enabling cointinuous painting" }
+ { "name": "show", "type": "boolean", "description": "True for showing scroll bottleneck rects" }
]
},
{
- "name": "setShowScrollBottleneckRects",
- "description": "Requests that backend shows scroll bottleneck rects",
+ "name": "setShowViewportSizeOnResize",
+ "description": "Paints viewport size upon main frame resize.",
"parameters": [
- { "name": "show", "type": "boolean", "description": "True for showing scroll bottleneck rects" }
+ { "name": "show", "type": "boolean", "description": "Whether to paint size or not." }
]
}
]
@@ -606,21 +703,27 @@
{
"domain": "Emulation",
"description": "This domain emulates different environments for the page.",
- "hidden": true,
+ "dependencies": ["DOM"],
"types": [
{
- "id": "Viewport",
+ "id": "ScreenOrientation",
"type": "object",
- "description": "Visible page viewport",
+ "description": "Screen orientation.",
"properties": [
- { "name": "scrollX", "type": "number", "description": "X scroll offset in CSS pixels." },
- { "name": "scrollY", "type": "number", "description": "Y scroll offset in CSS pixels." },
- { "name": "contentsWidth", "type": "number", "description": "Contents width in CSS pixels." },
- { "name": "contentsHeight", "type": "number", "description": "Contents height in CSS pixels." },
- { "name": "pageScaleFactor", "type": "number", "description": "Page scale factor." },
- { "name": "minimumPageScaleFactor", "type": "number", "description": "Minimum page scale factor." },
- { "name": "maximumPageScaleFactor", "type": "number", "description": "Maximum page scale factor." }
+ { "name": "type", "type": "string", "enum": ["portraitPrimary", "portraitSecondary", "landscapePrimary", "landscapeSecondary"], "description": "Orientation type." },
+ { "name": "angle", "type": "integer", "description": "Orientation angle." }
]
+ },
+ {
+ "id": "VirtualTimePolicy",
+ "type": "string",
+ "enum": [
+ "advance",
+ "pause",
+ "pauseIfNetworkFetchesPending"
+ ],
+ "experimental": true,
+ "description": "advance: If the scheduler runs out of immediate work, the virtual time base may fast forward to allow the next delayed task (if any) to run; pause: The virtual time base may not advance; pauseIfNetworkFetchesPending: The virtual time base may not advance if there are any pending resource fetches."
}
],
"commands": [
@@ -633,31 +736,61 @@
{ "name": "deviceScaleFactor", "type": "number", "description": "Overriding device scale factor value. 0 disables the override." },
{ "name": "mobile", "type": "boolean", "description": "Whether to emulate mobile device. This includes viewport meta tag, overlay scrollbars, text autosizing and more." },
{ "name": "fitWindow", "type": "boolean", "description": "Whether a view that exceeds the available browser window area should be scaled down to fit." },
- { "name": "scale", "type": "number", "optional": true, "description": "Scale to apply to resulting view image. Ignored in |fitWindow| mode." },
- { "name": "offsetX", "type": "number", "optional": true, "description": "X offset to shift resulting view image by. Ignored in |fitWindow| mode." },
- { "name": "offsetY", "type": "number", "optional": true, "description": "Y offset to shift resulting view image by. Ignored in |fitWindow| mode." }
- ],
- "handlers": ["browser"]
+ { "name": "scale", "type": "number", "optional": true, "experimental": true, "description": "Scale to apply to resulting view image. Ignored in |fitWindow| mode." },
+ { "name": "offsetX", "type": "number", "optional": true, "deprecated": true, "experimental": true, "description": "Not used." },
+ { "name": "offsetY", "type": "number", "optional": true, "deprecated": true, "experimental": true, "description": "Not used." },
+ { "name": "screenWidth", "type": "integer", "optional": true, "experimental": true, "description": "Overriding screen width value in pixels (minimum 0, maximum 10000000). Only used for |mobile==true|." },
+ { "name": "screenHeight", "type": "integer", "optional": true, "experimental": true, "description": "Overriding screen height value in pixels (minimum 0, maximum 10000000). Only used for |mobile==true|." },
+ { "name": "positionX", "type": "integer", "optional": true, "experimental": true, "description": "Overriding view X position on screen in pixels (minimum 0, maximum 10000000). Only used for |mobile==true|." },
+ { "name": "positionY", "type": "integer", "optional": true, "experimental": true, "description": "Overriding view Y position on screen in pixels (minimum 0, maximum 10000000). Only used for |mobile==true|." },
+ { "name": "screenOrientation", "$ref": "ScreenOrientation", "optional": true, "description": "Screen orientation override." }
+ ]
},
{
"name": "clearDeviceMetricsOverride",
- "description": "Clears the overriden device metrics.",
- "handlers": ["browser"]
+ "description": "Clears the overriden device metrics."
+ },
+ {
+ "name": "forceViewport",
+ "description": "Overrides the visible area of the page. The change is hidden from the page, i.e. the observable scroll position and page scale does not change. In effect, the command moves the specified area of the page into the top-left corner of the frame.",
+ "experimental": true,
+ "parameters": [
+ { "name": "x", "type": "number", "description": "X coordinate of top-left corner of the area (CSS pixels)." },
+ { "name": "y", "type": "number", "description": "Y coordinate of top-left corner of the area (CSS pixels)." },
+ { "name": "scale", "type": "number", "description": "Scale to apply to the area (relative to a page scale of 1.0)." }
+ ]
+ },
+ {
+ "name": "resetViewport",
+ "description": "Resets the visible area of the page to the original viewport, undoing any effects of the <code>forceViewport</code> command.",
+ "experimental": true
},
{
- "name": "resetScrollAndPageScaleFactor",
- "description": "Requests that scroll offsets and page scale factor are reset to initial values."
+ "name": "resetPageScaleFactor",
+ "experimental": true,
+ "description": "Requests that page scale factor is reset to initial values."
},
{
"name": "setPageScaleFactor",
"description": "Sets a specified page scale factor.",
+ "experimental": true,
"parameters": [
{ "name": "pageScaleFactor", "type": "number", "description": "Page scale factor." }
]
},
+ {
+ "name": "setVisibleSize",
+ "description": "Resizes the frame/viewport of the page. Note that this does not affect the frame's container (e.g. browser window). Can be used to produce screenshots of the specified size. Not supported on Android.",
+ "experimental": true,
+ "parameters": [
+ { "name": "width", "type": "integer", "description": "Frame width (DIP)." },
+ { "name": "height", "type": "integer", "description": "Frame height (DIP)." }
+ ]
+ },
{
"name": "setScriptExecutionDisabled",
"description": "Switches script execution in the page.",
+ "experimental": true,
"parameters": [
{ "name": "value", "type": "boolean", "description": "Whether script execution should be disabled in the page." }
]
@@ -665,17 +798,17 @@
{
"name": "setGeolocationOverride",
"description": "Overrides the Geolocation Position or Error. Omitting any of the parameters emulates position unavailable.",
+ "experimental": true,
"parameters": [
{ "name": "latitude", "type": "number", "optional": true, "description": "Mock latitude"},
{ "name": "longitude", "type": "number", "optional": true, "description": "Mock longitude"},
{ "name": "accuracy", "type": "number", "optional": true, "description": "Mock accuracy"}
- ],
- "handlers": ["browser"]
+ ]
},
{
"name": "clearGeolocationOverride",
"description": "Clears the overriden Geolocation Position and Error.",
- "handlers": ["browser"]
+ "experimental": true
},
{
"name": "setTouchEmulationEnabled",
@@ -683,8 +816,7 @@
{ "name": "enabled", "type": "boolean", "description": "Whether the touch event emulation should be enabled." },
{ "name": "configuration", "type": "string", "enum": ["mobile", "desktop"], "optional": true, "description": "Touch/gesture events configuration. Default: current platform." }
],
- "description": "Toggles mouse event-based touch event emulation.",
- "handlers": ["browser", "renderer"]
+ "description": "Toggles mouse event-based touch event emulation."
},
{
"name": "setEmulatedMedia",
@@ -693,484 +825,278 @@
],
"description": "Emulates the given media for CSS media queries."
},
+ {
+ "name": "setCPUThrottlingRate",
+ "parameters": [
+ { "name": "rate", "type": "number", "description": "Throttling rate as a slowdown factor (1 is no throttle, 2 is 2x slowdown, etc)." }
+ ],
+ "experimental": true,
+ "description": "Enables CPU throttling to emulate slow CPUs."
+ },
{
"name": "canEmulate",
"description": "Tells whether emulation is supported.",
"returns": [
{ "name": "result", "type": "boolean", "description": "True if emulation is supported." }
],
- "handlers": ["browser"]
+ "experimental": true
+ },
+ {
+ "name": "setVirtualTimePolicy",
+ "description": "Turns on virtual time for all frames (replacing real-time with a synthetic time source) and sets the current virtual time policy. Note this supersedes any previous time budget.",
+ "parameters": [
+ { "name": "policy", "$ref": "VirtualTimePolicy" },
+ { "name": "budget", "type": "integer", "optional": true, "description": "If set, after this many virtual milliseconds have elapsed virtual time will be paused and a virtualTimeBudgetExpired event is sent." }
+ ],
+ "experimental": true
+ },
+ {
+ "name": "setDefaultBackgroundColorOverride",
+ "description": "Sets or clears an override of the default background color of the frame. This override is used if the content does not specify one.",
+ "parameters": [
+ { "name": "color", "$ref": "DOM.RGBA", "optional": true, "description": "RGBA of the default background color. If not specified, any existing override will be cleared." }
+ ],
+ "experimental": true
}
],
"events": [
{
- "name": "viewportChanged",
- "description": "Fired when a visible page viewport has changed. Only fired when device metrics are overridden.",
- "parameters": [
- { "name": "viewport", "$ref": "Viewport", "description": "Viewport description." }
- ]
+ "name": "virtualTimeBudgetExpired",
+ "experimental": true,
+ "description": "Notification sent after the virual time budget for the current VirtualTimePolicy has run out."
}
]
},
{
- "domain": "Runtime",
- "description": "Runtime domain exposes JavaScript runtime by means of remote evaluation and mirror objects. Evaluation results are returned as mirror object that expose object type, string representation and unique identifier that can be used for further object reference. Original objects are maintained in memory unless they are either explicitly released or are released along with the other objects in their object group.",
+ "domain": "Security",
+ "description": "Security",
+ "experimental": true,
"types": [
{
- "id": "RemoteObjectId",
+ "id": "CertificateId",
+ "type": "integer",
+ "description": "An internal certificate ID value."
+ },
+ {
+ "id": "SecurityState",
"type": "string",
- "description": "Unique object identifier."
+ "enum": ["unknown", "neutral", "insecure", "warning", "secure", "info"],
+ "description": "The security level of a page or resource."
},
{
- "id": "RemoteObject",
+ "id": "SecurityStateExplanation",
"type": "object",
- "description": "Mirror object referencing original JavaScript object.",
"properties": [
- { "name": "type", "type": "string", "enum": ["object", "function", "undefined", "string", "number", "boolean", "symbol"], "description": "Object type." },
- { "name": "subtype", "type": "string", "optional": true, "enum": ["array", "null", "node", "regexp", "date", "map", "set", "iterator", "generator", "error"], "description": "Object subtype hint. Specified for <code>object</code> type values only." },
- { "name": "className", "type": "string", "optional": true, "description": "Object class (constructor) name. Specified for <code>object</code> type values only." },
- { "name": "value", "type": "any", "optional": true, "description": "Remote object value in case of primitive values or JSON values (if it was requested), or description string if the value can not be JSON-stringified (like NaN, Infinity, -Infinity, -0)." },
- { "name": "description", "type": "string", "optional": true, "description": "String representation of the object." },
- { "name": "objectId", "$ref": "RemoteObjectId", "optional": true, "description": "Unique object identifier (for non-primitive values)." },
- { "name": "preview", "$ref": "ObjectPreview", "optional": true, "description": "Preview containing abbreviated property values. Specified for <code>object</code> type values only.", "hidden": true },
- { "name": "customPreview", "$ref": "CustomPreview", "optional": true, "hidden": true}
- ]
+ { "name": "securityState", "$ref": "SecurityState", "description": "Security state representing the severity of the factor being explained." },
+ { "name": "summary", "type": "string", "description": "Short phrase describing the type of factor." },
+ { "name": "description", "type": "string", "description": "Full text explanation of the factor." },
+ { "name": "hasCertificate", "type": "boolean", "description": "True if the page has a certificate." }
+ ],
+ "description": "An explanation of an factor contributing to the security state."
},
- { "id": "CustomPreview",
+ {
+ "id": "InsecureContentStatus",
"type": "object",
- "hidden": true,
"properties": [
- { "name": "header", "type": "string"},
- { "name": "hasBody", "type": "boolean"},
- {"name": "formatterObjectId", "$ref": "RemoteObjectId"},
- {"name": "configObjectId", "$ref": "RemoteObjectId", "optional": true}
+ { "name": "ranMixedContent", "type": "boolean", "description": "True if the page was loaded over HTTPS and ran mixed (HTTP) content such as scripts." },
+ { "name": "displayedMixedContent", "type": "boolean", "description": "True if the page was loaded over HTTPS and displayed mixed (HTTP) content such as images." },
+ { "name": "ranContentWithCertErrors", "type": "boolean", "description": "True if the page was loaded over HTTPS without certificate errors, and ran content such as scripts that were loaded with certificate errors." },
+ { "name": "displayedContentWithCertErrors", "type": "boolean", "description": "True if the page was loaded over HTTPS without certificate errors, and displayed content such as images that were loaded with certificate errors." },
+ { "name": "ranInsecureContentStyle", "$ref": "SecurityState", "description": "Security state representing a page that ran insecure content." },
+ { "name": "displayedInsecureContentStyle", "$ref": "SecurityState", "description": "Security state representing a page that displayed insecure content." }
+ ],
+ "description": "Information about insecure content on the page."
+ }
+ ],
+ "commands": [
+ {
+ "name": "enable",
+ "description": "Enables tracking security state changes."
+ },
+ {
+ "name": "disable",
+ "description": "Disables tracking security state changes."
+ },
+ {
+ "name": "showCertificateViewer",
+ "description": "Displays native dialog with the certificate details."
+ }
+ ],
+ "events": [
+ {
+ "name": "securityStateChanged",
+ "description": "The security state of the page changed.",
+ "parameters": [
+ { "name": "securityState", "$ref": "SecurityState", "description": "Security state." },
+ { "name": "schemeIsCryptographic", "type": "boolean", "description": "True if the page was loaded over cryptographic transport such as HTTPS." },
+ { "name": "explanations", "type": "array", "items": { "$ref": "SecurityStateExplanation" }, "description": "List of explanations for the security state. If the overall security state is `insecure` or `warning`, at least one corresponding explanation should be included." },
+ { "name": "insecureContentStatus", "$ref": "InsecureContentStatus", "description": "Information about insecure content on the page." },
+ { "name": "summary", "type": "string", "description": "Overrides user-visible description of the state.", "optional": true }
]
+ }
+ ]
+ },
+ {
+ "domain": "Network",
+ "description": "Network domain allows tracking network activities of the page. It exposes information about http, file, data and other requests and responses, their headers, bodies, timing, etc.",
+ "dependencies": ["Runtime", "Security"],
+ "types": [
+ {
+ "id": "LoaderId",
+ "type": "string",
+ "description": "Unique loader identifier."
+ },
+ {
+ "id": "RequestId",
+ "type": "string",
+ "description": "Unique request identifier."
+ },
+ {
+ "id": "Timestamp",
+ "type": "number",
+ "description": "Number of seconds since epoch."
},
{
- "id": "ObjectPreview",
+ "id": "Headers",
"type": "object",
- "hidden": true,
- "description": "Object containing abbreviated remote object value.",
- "properties": [
- { "name": "type", "type": "string", "enum": ["object", "function", "undefined", "string", "number", "boolean", "symbol"], "description": "Object type." },
- { "name": "subtype", "type": "string", "optional": true, "enum": ["array", "null", "node", "regexp", "date", "map", "set", "iterator", "generator", "error"], "description": "Object subtype hint. Specified for <code>object</code> type values only." },
- { "name": "description", "type": "string", "optional": true, "description": "String representation of the object." },
- { "name": "lossless", "type": "boolean", "description": "Determines whether preview is lossless (contains all information of the original object)." },
- { "name": "overflow", "type": "boolean", "description": "True iff some of the properties or entries of the original object did not fit." },
- { "name": "properties", "type": "array", "items": { "$ref": "PropertyPreview" }, "description": "List of the properties." },
- { "name": "entries", "type": "array", "items": { "$ref": "EntryPreview" }, "optional": true, "description": "List of the entries. Specified for <code>map</code> and <code>set</code> subtype values only." }
- ]
+ "description": "Request / response headers as keys / values of JSON object."
},
{
- "id": "PropertyPreview",
+ "id": "ConnectionType",
+ "type": "string",
+ "enum": ["none", "cellular2g", "cellular3g", "cellular4g", "bluetooth", "ethernet", "wifi", "wimax", "other"],
+ "description": "Loading priority of a resource request."
+ },
+ {
+ "id": "CookieSameSite",
+ "type": "string",
+ "enum": ["Strict", "Lax"],
+ "description": "Represents the cookie's 'SameSite' status: https://tools.ietf.org/html/draft-west-first-party-cookies"
+ },
+ {
+ "id": "ResourceTiming",
"type": "object",
- "hidden": true,
+ "description": "Timing information for the request.",
"properties": [
- { "name": "name", "type": "string", "description": "Property name." },
- { "name": "type", "type": "string", "enum": ["object", "function", "undefined", "string", "number", "boolean", "symbol", "accessor"], "description": "Object type. Accessor means that the property itself is an accessor property." },
- { "name": "value", "type": "string", "optional": true, "description": "User-friendly property value string." },
- { "name": "valuePreview", "$ref": "ObjectPreview", "optional": true, "description": "Nested value preview." },
- { "name": "subtype", "type": "string", "optional": true, "enum": ["array", "null", "node", "regexp", "date", "map", "set", "iterator", "generator", "error"], "description": "Object subtype hint. Specified for <code>object</code> type values only." }
+ { "name": "requestTime", "type": "number", "description": "Timing's requestTime is a baseline in seconds, while the other numbers are ticks in milliseconds relatively to this requestTime." },
+ { "name": "proxyStart", "type": "number", "description": "Started resolving proxy." },
+ { "name": "proxyEnd", "type": "number", "description": "Finished resolving proxy." },
+ { "name": "dnsStart", "type": "number", "description": "Started DNS address resolve." },
+ { "name": "dnsEnd", "type": "number", "description": "Finished DNS address resolve." },
+ { "name": "connectStart", "type": "number", "description": "Started connecting to the remote host." },
+ { "name": "connectEnd", "type": "number", "description": "Connected to the remote host." },
+ { "name": "sslStart", "type": "number", "description": "Started SSL handshake." },
+ { "name": "sslEnd", "type": "number", "description": "Finished SSL handshake." },
+ { "name": "workerStart", "type": "number", "description": "Started running ServiceWorker.", "experimental": true },
+ { "name": "workerReady", "type": "number", "description": "Finished Starting ServiceWorker.", "experimental": true },
+ { "name": "sendStart", "type": "number", "description": "Started sending request." },
+ { "name": "sendEnd", "type": "number", "description": "Finished sending request." },
+ { "name": "pushStart", "type": "number", "description": "Time the server started pushing request.", "experimental": true },
+ { "name": "pushEnd", "type": "number", "description": "Time the server finished pushing request.", "experimental": true },
+ { "name": "receiveHeadersEnd", "type": "number", "description": "Finished receiving response headers." }
]
},
{
- "id": "EntryPreview",
+ "id": "ResourcePriority",
+ "type": "string",
+ "enum": ["VeryLow", "Low", "Medium", "High", "VeryHigh"],
+ "description": "Loading priority of a resource request."
+ },
+ {
+ "id": "Request",
"type": "object",
- "hidden": true,
+ "description": "HTTP request data.",
"properties": [
- { "name": "key", "$ref": "ObjectPreview", "optional": true, "description": "Preview of the key. Specified for map-like collection entries." },
- { "name": "value", "$ref": "ObjectPreview", "description": "Preview of the value." }
+ { "name": "url", "type": "string", "description": "Request URL." },
+ { "name": "method", "type": "string", "description": "HTTP request method." },
+ { "name": "headers", "$ref": "Headers", "description": "HTTP request headers." },
+ { "name": "postData", "type": "string", "optional": true, "description": "HTTP POST request data." },
+ { "name": "mixedContentType", "optional": true, "type": "string", "enum": ["blockable", "optionally-blockable", "none"], "description": "The mixed content status of the request, as defined in http://www.w3.org/TR/mixed-content/" },
+ { "name": "initialPriority", "$ref": "ResourcePriority", "description": "Priority of the resource request at the time request is sent."},
+ { "name": "referrerPolicy", "type": "string", "enum": [ "unsafe-url", "no-referrer-when-downgrade", "no-referrer", "origin", "origin-when-cross-origin", "no-referrer-when-downgrade-origin-when-cross-origin" ], "description": "The referrer policy of the request, as defined in https://www.w3.org/TR/referrer-policy/" }
]
},
{
- "id": "PropertyDescriptor",
- "type": "object",
- "description": "Object property descriptor.",
+ "id": "SignedCertificateTimestamp",
+ "type" : "object",
+ "description": "Details of a signed certificate timestamp (SCT).",
"properties": [
- { "name": "name", "type": "string", "description": "Property name or symbol description." },
- { "name": "value", "$ref": "RemoteObject", "optional": true, "description": "The value associated with the property." },
- { "name": "writable", "type": "boolean", "optional": true, "description": "True if the value associated with the property may be changed (data descriptors only)." },
- { "name": "get", "$ref": "RemoteObject", "optional": true, "description": "A function which serves as a getter for the property, or <code>undefined</code> if there is no getter (accessor descriptors only)." },
- { "name": "set", "$ref": "RemoteObject", "optional": true, "description": "A function which serves as a setter for the property, or <code>undefined</code> if there is no setter (accessor descriptors only)." },
- { "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." },
- { "name": "enumerable", "type": "boolean", "description": "True if this property shows up during enumeration of the properties on the corresponding object." },
- { "name": "wasThrown", "type": "boolean", "optional": true, "description": "True if the result was thrown during the evaluation." },
- { "name": "isOwn", "optional": true, "type": "boolean", "description": "True if the property is owned for the object.", "hidden": true },
- { "name": "symbol", "$ref": "RemoteObject", "optional": true, "description": "Property symbol object, if the property is of the <code>symbol</code> type.", "hidden": true }
+ { "name": "status", "type": "string", "description": "Validation status." },
+ { "name": "origin", "type": "string", "description": "Origin." },
+ { "name": "logDescription", "type": "string", "description": "Log name / description." },
+ { "name": "logId", "type": "string", "description": "Log ID." },
+ { "name": "timestamp", "$ref": "Timestamp", "description": "Issuance date." },
+ { "name": "hashAlgorithm", "type": "string", "description": "Hash algorithm." },
+ { "name": "signatureAlgorithm", "type": "string", "description": "Signature algorithm." },
+ { "name": "signatureData", "type": "string", "description": "Signature data." }
]
},
{
- "id": "EventListener",
+ "id": "SecurityDetails",
"type": "object",
- "description": "Object event listener.",
+ "description": "Security details about a request.",
"properties": [
- { "name": "type", "type": "string", "description": "<code>EventListener</code>'s type." },
- { "name": "useCapture", "type": "boolean", "description": "<code>EventListener</code>'s useCapture." },
- { "name": "location", "$ref": "Debugger.Location", "description": "Handler code location." },
- { "name": "handler", "$ref": "Runtime.RemoteObject", "optional": true, "description": "Event handler function value." }
- ],
- "hidden": true
+ { "name": "protocol", "type": "string", "description": "Protocol name (e.g. \"TLS 1.2\" or \"QUIC\")." },
+ { "name": "keyExchange", "type": "string", "description": "Key Exchange used by the connection, or the empty string if not applicable." },
+ { "name": "keyExchangeGroup", "type": "string", "optional": true, "description": "(EC)DH group used by the connection, if applicable." },
+ { "name": "cipher", "type": "string", "description": "Cipher name." },
+ { "name": "mac", "type": "string", "optional": true, "description": "TLS MAC. Note that AEAD ciphers do not have separate MACs." },
+ { "name": "certificateId", "$ref": "Security.CertificateId", "description": "Certificate ID value." },
+ { "name": "subjectName", "type": "string", "description": "Certificate subject name." },
+ { "name": "sanList", "type": "array", "items": { "type": "string" }, "description": "Subject Alternative Name (SAN) DNS names and IP addresses." },
+ { "name": "issuer", "type": "string", "description": "Name of the issuing CA." },
+ { "name": "validFrom", "$ref": "Timestamp", "description": "Certificate valid from date." },
+ { "name": "validTo", "$ref": "Timestamp", "description": "Certificate valid to (expiration) date" },
+ { "name": "signedCertificateTimestampList", "type": "array", "items": { "$ref": "SignedCertificateTimestamp" }, "description": "List of signed certificate timestamps (SCTs)." }
+ ]
},
{
- "id": "InternalPropertyDescriptor",
- "type": "object",
- "description": "Object internal property descriptor. This property isn't normally visible in JavaScript code.",
- "properties": [
- { "name": "name", "type": "string", "description": "Conventional property name." },
- { "name": "value", "$ref": "RemoteObject", "optional": true, "description": "The value associated with the property." }
- ],
- "hidden": true
+ "id": "BlockedReason",
+ "type": "string",
+ "description": "The reason why request was blocked.",
+ "enum": ["csp", "mixed-content", "origin", "inspector", "subresource-filter", "other"],
+ "experimental": true
},
{
- "id": "CallArgument",
+ "id": "Response",
"type": "object",
- "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.",
+ "description": "HTTP response data.",
"properties": [
- { "name": "value", "type": "any", "optional": true, "description": "Primitive value, or description string if the value can not be JSON-stringified (like NaN, Infinity, -Infinity, -0)." },
- { "name": "objectId", "$ref": "RemoteObjectId", "optional": true, "description": "Remote object handle." },
- { "name": "type", "optional": true, "hidden": true, "type": "string", "enum": ["object", "function", "undefined", "string", "number", "boolean", "symbol"], "description": "Object type." }
+ { "name": "url", "type": "string", "description": "Response URL. This URL can be different from CachedResource.url in case of redirect." },
+ { "name": "status", "type": "number", "description": "HTTP response status code." },
+ { "name": "statusText", "type": "string", "description": "HTTP response status text." },
+ { "name": "headers", "$ref": "Headers", "description": "HTTP response headers." },
+ { "name": "headersText", "type": "string", "optional": true, "description": "HTTP response headers text." },
+ { "name": "mimeType", "type": "string", "description": "Resource mimeType as determined by the browser." },
+ { "name": "requestHeaders", "$ref": "Headers", "optional": true, "description": "Refined HTTP request headers that were actually transmitted over the network." },
+ { "name": "requestHeadersText", "type": "string", "optional": true, "description": "HTTP request headers text." },
+ { "name": "connectionReused", "type": "boolean", "description": "Specifies whether physical connection was actually reused for this request." },
+ { "name": "connectionId", "type": "number", "description": "Physical connection id that was actually used for this request." },
+ { "name": "remoteIPAddress", "type": "string", "optional": true, "experimental": true, "description": "Remote IP address." },
+ { "name": "remotePort", "type": "integer", "optional": true, "experimental": true, "description": "Remote port."},
+ { "name": "fromDiskCache", "type": "boolean", "optional": true, "description": "Specifies that the request was served from the disk cache." },
+ { "name": "fromServiceWorker", "type": "boolean", "optional": true, "description": "Specifies that the request was served from the ServiceWorker." },
+ { "name": "encodedDataLength", "type": "number", "optional": false, "description": "Total number of bytes received for this request so far." },
+ { "name": "timing", "$ref": "ResourceTiming", "optional": true, "description": "Timing information for the given request." },
+ { "name": "protocol", "type": "string", "optional": true, "description": "Protocol used to fetch this request." },
+ { "name": "securityState", "$ref": "Security.SecurityState", "description": "Security state of the request resource." },
+ { "name": "securityDetails", "$ref": "SecurityDetails", "optional": true, "description": "Security details for the request." }
]
},
{
- "id": "ExecutionContextId",
- "type": "integer",
- "description": "Id of an execution context."
- },
- {
- "id": "ExecutionContextDescription",
+ "id": "WebSocketRequest",
"type": "object",
- "description": "Description of an isolated world.",
+ "description": "WebSocket request data.",
+ "experimental": true,
"properties": [
- { "name": "id", "$ref": "ExecutionContextId", "description": "Unique id of the execution context. It can be used to specify in which execution context script evaluation should be performed." },
- { "name": "isPageContext", "type": "boolean", "optional": true, "description": "True if this is a context where inpspected web page scripts run. False if it is a content script isolated context.", "hidden": true },
- { "name": "origin", "type": "string", "description": "Execution context origin.", "hidden": true},
- { "name": "name", "type": "string", "description": "Human readable name describing given context.", "hidden": true},
- { "name": "frameId", "type": "string", "description": "Id of the owning frame. May be an empty string if the context is not associated with a frame." }
- ]
- }
- ],
- "commands": [
- {
- "name": "evaluate",
- "parameters": [
- { "name": "expression", "type": "string", "description": "Expression to evaluate." },
- { "name": "objectGroup", "type": "string", "optional": true, "description": "Symbolic group name that can be used to release multiple objects." },
- { "name": "includeCommandLineAPI", "type": "boolean", "optional": true, "description": "Determines whether Command Line API should be available during the evaluation.", "hidden": true },
- { "name": "doNotPauseOnExceptionsAndMuteConsole", "type": "boolean", "optional": true, "description": "Specifies whether evaluation should stop on exceptions and mute console. Overrides setPauseOnException state.", "hidden": true },
- { "name": "contextId", "$ref": "ExecutionContextId", "optional": true, "description": "Specifies in which isolated context to perform evaluation. Each content script lives in an isolated context and this parameter may be used to specify one of those contexts. If the parameter is omitted or 0 the evaluation will be performed in the context of the inspected page." },
- { "name": "returnByValue", "type": "boolean", "optional": true, "description": "Whether the result is expected to be a JSON object that should be sent by value." },
- { "name": "generatePreview", "type": "boolean", "optional": true, "hidden": true, "description": "Whether preview should be generated for the result." }
- ],
- "returns": [
- { "name": "result", "$ref": "RemoteObject", "description": "Evaluation result." },
- { "name": "wasThrown", "type": "boolean", "optional": true, "description": "True if the result was thrown during the evaluation." },
- { "name": "exceptionDetails", "$ref": "Debugger.ExceptionDetails", "optional": true, "hidden": true, "description": "Exception details."}
- ],
- "description": "Evaluates expression on global object."
- },
- {
- "name": "callFunctionOn",
- "parameters": [
- { "name": "objectId", "$ref": "RemoteObjectId", "description": "Identifier of the object to call function on." },
- { "name": "functionDeclaration", "type": "string", "description": "Declaration of the function to call." },
- { "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." },
- { "name": "doNotPauseOnExceptionsAndMuteConsole", "type": "boolean", "optional": true, "description": "Specifies whether function call should stop on exceptions and mute console. Overrides setPauseOnException state.", "hidden": true },
- { "name": "returnByValue", "type": "boolean", "optional": true, "description": "Whether the result is expected to be a JSON object which should be sent by value." },
- { "name": "generatePreview", "type": "boolean", "optional": true, "hidden": true, "description": "Whether preview should be generated for the result." }
- ],
- "returns": [
- { "name": "result", "$ref": "RemoteObject", "description": "Call result." },
- { "name": "wasThrown", "type": "boolean", "optional": true, "description": "True if the result was thrown during the evaluation." }
- ],
- "description": "Calls function with given declaration on the given object. Object group of the result is inherited from the target object."
- },
- {
- "name": "getProperties",
- "parameters": [
- { "name": "objectId", "$ref": "RemoteObjectId", "description": "Identifier of the object to return properties for." },
- { "name": "ownProperties", "optional": true, "type": "boolean", "description": "If true, returns properties belonging only to the element itself, not to its prototype chain." },
- { "name": "accessorPropertiesOnly", "optional": true, "type": "boolean", "description": "If true, returns accessor properties (with getter/setter) only; internal properties are not returned either.", "hidden": true },
- { "name": "generatePreview", "type": "boolean", "optional": true, "hidden": true, "description": "Whether preview should be generated for the results." }
- ],
- "returns": [
- { "name": "result", "type": "array", "items": { "$ref": "PropertyDescriptor" }, "description": "Object properties." },
- { "name": "internalProperties", "optional": true, "type": "array", "items": { "$ref": "InternalPropertyDescriptor" }, "description": "Internal object properties (only of the element itself).", "hidden": true }
- ],
- "description": "Returns properties of a given object. Object group of the result is inherited from the target object."
- },
- {
- "name": "getEventListeners",
- "hidden": true,
- "parameters": [
- { "name": "objectId", "$ref": "RemoteObjectId", "description": "Identifier of the object to return listeners for." },
- { "name": "objectGroup", "type": "string", "optional": true, "description": "Symbolic group name for handler value. Handler value is not returned without this parameter specified." }
- ],
- "returns": [
- { "name": "listeners", "type": "array", "items": { "$ref": "EventListener" }, "description": "Array of relevant listeners." }
- ],
- "description": "Returns event listeners of the given object."
- },
- {
- "name": "releaseObject",
- "parameters": [
- { "name": "objectId", "$ref": "RemoteObjectId", "description": "Identifier of the object to release." }
- ],
- "description": "Releases remote object with given id."
- },
- {
- "name": "releaseObjectGroup",
- "parameters": [
- { "name": "objectGroup", "type": "string", "description": "Symbolic object group name." }
- ],
- "description": "Releases all remote objects that belong to a given group."
- },
- {
- "name": "run",
- "hidden": true,
- "description": "Tells inspected instance(worker or page) that it can run in case it was started paused."
- },
- {
- "name": "enable",
- "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."
- },
- {
- "name": "disable",
- "hidden": true,
- "description": "Disables reporting of execution contexts creation."
- },
- {
- "name": "isRunRequired",
- "returns": [
- { "name": "result", "type": "boolean", "description": "True if the Runtime is in paused on start state." }
- ],
- "hidden": true
- },
- {
- "name": "setCustomObjectFormatterEnabled",
- "parameters": [
- {
- "name": "enabled",
- "type": "boolean"
- }
- ],
- "hidden": true
- }
- ],
- "events": [
- {
- "name": "executionContextCreated",
- "parameters": [
- { "name": "context", "$ref": "ExecutionContextDescription", "description": "A newly created execution contex." }
- ],
- "description": "Issued when new execution context is created."
- },
- {
- "name": "executionContextDestroyed",
- "parameters": [
- { "name": "executionContextId", "$ref": "ExecutionContextId", "description": "Id of the destroyed context" }
- ],
- "description": "Issued when execution context is destroyed."
- },
- {
- "name": "executionContextsCleared",
- "description": "Issued when all executionContexts were cleared in browser"
- }
- ]
- },
- {
- "domain": "Console",
- "description": "Console domain defines methods and events for interaction with the JavaScript console. Console collects messages created by means of the <a href='http://getfirebug.com/wiki/index.php/Console_API'>JavaScript Console API</a>. One needs to enable this domain using <code>enable</code> command in order to start receiving the console messages. Browser collects messages issued while console domain is not enabled as well and reports them using <code>messageAdded</code> notification upon enabling.",
- "types": [
- {
- "id": "Timestamp",
- "type": "number",
- "description": "Number of seconds since epoch.",
- "hidden": true
- },
- {
- "id": "ConsoleMessage",
- "type": "object",
- "description": "Console message.",
- "properties": [
- { "name": "source", "type": "string", "enum": ["xml", "javascript", "network", "console-api", "storage", "appcache", "rendering", "css", "security", "other", "deprecation"], "description": "Message source." },
- { "name": "level", "type": "string", "enum": ["log", "warning", "error", "debug", "info"], "description": "Message severity." },
- { "name": "text", "type": "string", "description": "Message text." },
- { "name": "type", "type": "string", "optional": true, "enum": ["log", "dir", "dirxml", "table", "trace", "clear", "startGroup", "startGroupCollapsed", "endGroup", "assert", "profile", "profileEnd"], "description": "Console message type." },
- { "name": "scriptId", "type": "string", "optional": true, "description": "Script ID of the message origin." },
- { "name": "url", "type": "string", "optional": true, "description": "URL of the message origin." },
- { "name": "line", "type": "integer", "optional": true, "description": "Line number in the resource that generated this message." },
- { "name": "column", "type": "integer", "optional": true, "description": "Column number in the resource that generated this message." },
- { "name": "repeatCount", "type": "integer", "optional": true, "description": "Repeat count for repeated messages." },
- { "name": "parameters", "type": "array", "items": { "$ref": "Runtime.RemoteObject" }, "optional": true, "description": "Message parameters in case of the formatted message." },
- { "name": "stackTrace", "$ref": "StackTrace", "optional": true, "description": "JavaScript stack trace for assertions and error messages." },
- { "name": "asyncStackTrace", "$ref": "AsyncStackTrace", "optional": true, "description": "Asynchronous JavaScript stack trace that preceded this message, if available.", "hidden": true },
- { "name": "networkRequestId", "$ref": "Network.RequestId", "optional": true, "description": "Identifier of the network request associated with this message." },
- { "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp, when this message was fired.", "hidden": true },
- { "name": "executionContextId", "$ref": "Runtime.ExecutionContextId", "optional": true, "description": "Identifier of the context where this message was created", "hidden": true }
- ]
- },
- {
- "id": "CallFrame",
- "type": "object",
- "description": "Stack entry for console errors and assertions.",
- "properties": [
- { "name": "functionName", "type": "string", "description": "JavaScript function name." },
- { "name": "scriptId", "type": "string", "description": "JavaScript script id." },
- { "name": "url", "type": "string", "description": "JavaScript script name or url." },
- { "name": "lineNumber", "type": "integer", "description": "JavaScript script line number." },
- { "name": "columnNumber", "type": "integer", "description": "JavaScript script column number." }
- ]
- },
- {
- "id": "StackTrace",
- "type": "array",
- "items": { "$ref": "CallFrame" },
- "description": "Call frames for assertions or error messages."
- },
- {
- "id": "AsyncStackTrace",
- "type": "object",
- "properties": [
- { "name": "callFrames", "type": "array", "items": { "$ref": "CallFrame" }, "description": "Call frames of the stack trace." },
- { "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." },
- { "name": "asyncStackTrace", "$ref": "AsyncStackTrace", "optional": true, "description": "Next asynchronous stack trace, if any." }
- ],
- "description": "Asynchronous JavaScript call stack.",
- "hidden": true
- }
- ],
- "commands": [
- {
- "name": "enable",
- "description": "Enables console domain, sends the messages collected so far to the client by means of the <code>messageAdded</code> notification."
- },
- {
- "name": "disable",
- "description": "Disables console domain, prevents further console messages from being reported to the client."
- },
- {
- "name": "clearMessages",
- "description": "Clears console messages collected in the browser."
- }
- ],
- "events": [
- {
- "name": "messageAdded",
- "parameters": [
- { "name": "message", "$ref": "ConsoleMessage", "description": "Console message that has been added." }
- ],
- "description": "Issued when new console message is added."
- },
- {
- "name": "messageRepeatCountUpdated",
- "parameters": [
- { "name": "count", "type": "integer", "description": "New repeat count value." },
- { "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp of most recent message in batch.", "hidden": true }
- ],
- "description": "Is not issued. Will be gone in the future versions of the protocol.",
- "deprecated": true
- },
- {
- "name": "messagesCleared",
- "description": "Issued when console is cleared. This happens either upon <code>clearMessages</code> command or after page navigation."
- }
- ]
- },
- {
- "domain": "Network",
- "description": "Network domain allows tracking network activities of the page. It exposes information about http, file, data and other requests and responses, their headers, bodies, timing, etc.",
- "types": [
- {
- "id": "LoaderId",
- "type": "string",
- "description": "Unique loader identifier."
- },
- {
- "id": "RequestId",
- "type": "string",
- "description": "Unique request identifier."
- },
- {
- "id": "Timestamp",
- "type": "number",
- "description": "Number of seconds since epoch."
- },
- {
- "id": "Headers",
- "type": "object",
- "description": "Request / response headers as keys / values of JSON object."
- },
- {
- "id": "ResourceTiming",
- "type": "object",
- "description": "Timing information for the request.",
- "properties": [
- { "name": "requestTime", "type": "number", "description": "Timing's requestTime is a baseline in seconds, while the other numbers are ticks in milliseconds relatively to this requestTime." },
- { "name": "proxyStart", "type": "number", "description": "Started resolving proxy." },
- { "name": "proxyEnd", "type": "number", "description": "Finished resolving proxy." },
- { "name": "dnsStart", "type": "number", "description": "Started DNS address resolve." },
- { "name": "dnsEnd", "type": "number", "description": "Finished DNS address resolve." },
- { "name": "connectStart", "type": "number", "description": "Started connecting to the remote host." },
- { "name": "connectEnd", "type": "number", "description": "Connected to the remote host." },
- { "name": "sslStart", "type": "number", "description": "Started SSL handshake." },
- { "name": "sslEnd", "type": "number", "description": "Finished SSL handshake." },
- { "name": "serviceWorkerFetchStart", "type": "number", "description": "Started fetching via ServiceWorker.", "hidden": true },
- { "name": "serviceWorkerFetchReady", "type": "number", "description": "Prepared a ServiceWorker.", "hidden": true },
- { "name": "serviceWorkerFetchEnd", "type": "number", "description": "Finished fetching via ServiceWorker.", "hidden": true },
- { "name": "sendStart", "type": "number", "description": "Started sending request." },
- { "name": "sendEnd", "type": "number", "description": "Finished sending request." },
- { "name": "receiveHeadersEnd", "type": "number", "description": "Finished receiving response headers." }
- ]
- },
- {
- "id": "Request",
- "type": "object",
- "description": "HTTP request data.",
- "properties": [
- { "name": "url", "type": "string", "description": "Request URL." },
- { "name": "method", "type": "string", "description": "HTTP request method." },
- { "name": "headers", "$ref": "Headers", "description": "HTTP request headers." },
- { "name": "postData", "type": "string", "optional": true, "description": "HTTP POST request data." }
- ]
- },
- {
- "id": "Response",
- "type": "object",
- "description": "HTTP response data.",
- "properties": [
- { "name": "url", "type": "string", "description": "Response URL. This URL can be different from CachedResource.url in case of redirect." },
- { "name": "status", "type": "number", "description": "HTTP response status code." },
- { "name": "statusText", "type": "string", "description": "HTTP response status text." },
- { "name": "headers", "$ref": "Headers", "description": "HTTP response headers." },
- { "name": "headersText", "type": "string", "optional": true, "description": "HTTP response headers text." },
- { "name": "mimeType", "type": "string", "description": "Resource mimeType as determined by the browser." },
- { "name": "requestHeaders", "$ref": "Headers", "optional": true, "description": "Refined HTTP request headers that were actually transmitted over the network." },
- { "name": "requestHeadersText", "type": "string", "optional": true, "description": "HTTP request headers text." },
- { "name": "connectionReused", "type": "boolean", "description": "Specifies whether physical connection was actually reused for this request." },
- { "name": "connectionId", "type": "number", "description": "Physical connection id that was actually used for this request." },
- { "name": "remoteIPAddress", "type": "string", "optional": true, "hidden": true, "description": "Remote IP address." },
- { "name": "remotePort", "type": "integer", "optional": true, "hidden": true, "description": "Remote port."},
- { "name": "fromDiskCache", "type": "boolean", "optional": true, "description": "Specifies that the request was served from the disk cache." },
- { "name": "fromServiceWorker", "type": "boolean", "optional": true, "description": "Specifies that the request was served from the ServiceWorker." },
- { "name": "encodedDataLength", "type": "number", "optional": false, "description": "Total number of bytes received for this request so far." },
- { "name": "timing", "$ref": "ResourceTiming", "optional": true, "description": "Timing information for the given request." },
- { "name": "protocol", "type": "string", "optional": true, "description": "Protocol used to fetch this resquest." }
- ]
- },
- {
- "id": "WebSocketRequest",
- "type": "object",
- "description": "WebSocket request data.",
- "hidden": true,
- "properties": [
- { "name": "headers", "$ref": "Headers", "description": "HTTP request headers." }
+ { "name": "headers", "$ref": "Headers", "description": "HTTP request headers." }
]
},
{
"id": "WebSocketResponse",
"type": "object",
"description": "WebSocket response data.",
- "hidden": true,
+ "experimental": true,
"properties": [
{ "name": "status", "type": "number", "description": "HTTP response status code." },
{ "name": "statusText", "type": "string", "description": "HTTP response status text." },
@@ -1184,7 +1110,7 @@
"id": "WebSocketFrame",
"type": "object",
"description": "WebSocket frame data.",
- "hidden": true,
+ "experimental": true,
"properties": [
{ "name": "opcode", "type": "number", "description": "WebSocket frame opcode." },
{ "name": "mask", "type": "boolean", "description": "WebSocke frame mask." },
@@ -1207,11 +1133,10 @@
"type": "object",
"description": "Information about the request initiator.",
"properties": [
- { "name": "type", "type": "string", "enum": ["parser", "script", "other"], "description": "Type of this initiator." },
- { "name": "stackTrace", "$ref": "Console.StackTrace", "optional": true, "description": "Initiator JavaScript stack trace, set for Script only." },
+ { "name": "type", "type": "string", "enum": ["parser", "script", "preload", "other"], "description": "Type of this initiator." },
+ { "name": "stack", "$ref": "Runtime.StackTrace", "optional": true, "description": "Initiator JavaScript stack trace, set for Script only." },
{ "name": "url", "type": "string", "optional": true, "description": "Initiator URL, set for Parser type only." },
- { "name": "lineNumber", "type": "number", "optional": true, "description": "Initiator line number, set for Parser type only." },
- { "name": "asyncStackTrace", "$ref": "Console.AsyncStackTrace", "optional": true, "description": "Initiator asynchronous JavaScript stack trace, if available.", "hidden": true }
+ { "name": "lineNumber", "type": "number", "optional": true, "description": "Initiator line number, set for Parser type only (0-based)." }
]
},
{
@@ -1223,19 +1148,24 @@
{ "name": "value", "type": "string", "description": "Cookie value." },
{ "name": "domain", "type": "string", "description": "Cookie domain." },
{ "name": "path", "type": "string", "description": "Cookie path." },
- { "name": "expires", "type": "number", "description": "Cookie expires." },
+ { "name": "expires", "type": "number", "description": "Cookie expiration date as the number of seconds since the UNIX epoch." },
{ "name": "size", "type": "integer", "description": "Cookie size." },
{ "name": "httpOnly", "type": "boolean", "description": "True if cookie is http-only." },
{ "name": "secure", "type": "boolean", "description": "True if cookie is secure." },
- { "name": "session", "type": "boolean", "description": "True in case of session cookie." }
+ { "name": "session", "type": "boolean", "description": "True in case of session cookie." },
+ { "name": "sameSite", "$ref": "CookieSameSite", "optional": true, "description": "Cookie SameSite type." }
],
- "hidden": true
+ "experimental": true
}
],
"commands": [
{
"name": "enable",
- "description": "Enables network tracking, network events will now be delivered to the client."
+ "description": "Enables network tracking, network events will now be delivered to the client.",
+ "parameters": [
+ { "name": "maxTotalBufferSize", "type": "integer", "optional": true, "experimental": true, "description": "Buffer size in bytes to use when preserving network payloads (XHRs, etc)." },
+ { "name": "maxResourceBufferSize", "type": "integer", "optional": true, "experimental": true, "description": "Per-resource buffer size in bytes to use when preserving network payloads (XHRs, etc)." }
+ ]
},
{
"name": "disable",
@@ -1257,7 +1187,6 @@
},
{
"name": "getResponseBody",
- "async": true,
"description": "Returns content served for the given request.",
"parameters": [
{ "name": "requestId", "$ref": "RequestId", "description": "Identifier of the network request to get content for." }
@@ -1267,13 +1196,29 @@
{ "name": "base64Encoded", "type": "boolean", "description": "True, if content was sent as base64." }
]
},
+ {
+ "name": "addBlockedURL",
+ "description": "Blocks specific URL from loading.",
+ "parameters": [
+ { "name": "url", "type": "string", "description": "URL to block." }
+ ],
+ "experimental": true
+ },
+ {
+ "name": "removeBlockedURL",
+ "description": "Cancels blocking of a specific URL from loading.",
+ "parameters": [
+ { "name": "url", "type": "string", "description": "URL to stop blocking." }
+ ],
+ "experimental": true
+ },
{
"name": "replayXHR",
"description": "This method sends a new XMLHttpRequest which is identical to the original one. The following parameters should be identical: method, url, async, request body, extra headers, withCredentials attribute, user, password.",
"parameters": [
{ "name": "requestId", "$ref": "RequestId", "description": "Identifier of XHR to replay." }
],
- "hidden": true
+ "experimental": true
},
{
"name": "setMonitoringXHREnabled",
@@ -1281,7 +1226,7 @@
{ "name": "enabled", "type": "boolean", "description": "Monitoring enabled state." }
],
"description": "Toggles monitoring of XMLHttpRequest. If <code>true</code>, console will receive messages upon each XHR issued.",
- "hidden": true
+ "experimental": true
},
{
"name": "canClearBrowserCache",
@@ -1292,8 +1237,7 @@
},
{
"name": "clearBrowserCache",
- "description": "Clears browser cache.",
- "handlers": ["browser"]
+ "description": "Clears browser cache."
},
{
"name": "canClearBrowserCookies",
@@ -1304,18 +1248,26 @@
},
{
"name": "clearBrowserCookies",
- "description": "Clears browser cookies.",
- "handlers": ["browser"]
+ "description": "Clears browser cookies."
},
{
"name": "getCookies",
+ "parameters": [
+ { "name": "urls", "type": "array", "items": { "type": "string" }, "optional": true, "description": "The list of URLs for which applicable cookies will be fetched" }
+ ],
+ "returns": [
+ { "name": "cookies", "type": "array", "items": { "$ref": "Cookie" }, "description": "Array of cookie objects." }
+ ],
+ "description": "Returns all browser cookies for the current URL. Depending on the backend support, will return detailed cookie information in the <code>cookies</code> field.",
+ "experimental": true
+ },
+ {
+ "name": "getAllCookies",
"returns": [
{ "name": "cookies", "type": "array", "items": { "$ref": "Cookie" }, "description": "Array of cookie objects." }
],
"description": "Returns all browser cookies. Depending on the backend support, will return detailed cookie information in the <code>cookies</code> field.",
- "handlers": ["browser"],
- "async": true,
- "hidden": true
+ "experimental": true
},
{
"name": "deleteCookie",
@@ -1324,9 +1276,26 @@
{ "name": "url", "type": "string", "description": "URL to match cooke domain and path." }
],
"description": "Deletes browser cookie with given name, domain and path.",
- "handlers": ["browser"],
- "async": true,
- "hidden": true
+ "experimental": true
+ },
+ {
+ "name": "setCookie",
+ "parameters": [
+ { "name": "url", "type": "string", "description": "The request-URI to associate with the setting of the cookie. This value can affect the default domain and path values of the created cookie." },
+ { "name": "name", "type": "string", "description": "The name of the cookie." },
+ { "name": "value", "type": "string", "description": "The value of the cookie." },
+ { "name": "domain", "type": "string", "optional": true, "description": "If omitted, the cookie becomes a host-only cookie." },
+ { "name": "path", "type": "string", "optional": true, "description": "Defaults to the path portion of the url parameter." },
+ { "name": "secure", "type": "boolean", "optional": true, "description": "Defaults ot false." },
+ { "name": "httpOnly", "type": "boolean", "optional": true, "description": "Defaults to false." },
+ { "name": "sameSite", "$ref": "CookieSameSite", "optional": true, "description": "Defaults to browser default behavior." },
+ { "name": "expirationDate", "$ref": "Timestamp", "optional": true, "description": "If omitted, the cookie becomes a session cookie." }
+ ],
+ "returns": [
+ { "name": "success", "type": "boolean", "description": "True if successfully set cookie." }
+ ],
+ "description": "Sets a cookie with the given cookie data; may overwrite equivalent cookies if they exist.",
+ "experimental": true
},
{
"name": "canEmulateNetworkConditions",
@@ -1334,8 +1303,7 @@
"returns": [
{ "name": "result", "type": "boolean", "description": "True if emulation of network conditions is supported." }
],
- "hidden": true,
- "handlers": ["browser"]
+ "experimental": true
},
{
"name": "emulateNetworkConditions",
@@ -1344,10 +1312,9 @@
{ "name": "offline", "type": "boolean", "description": "True to emulate internet disconnection." },
{ "name": "latency", "type": "number", "description": "Additional latency (ms)." },
{ "name": "downloadThroughput", "type": "number", "description": "Maximal aggregated download throughput." },
- { "name": "uploadThroughput", "type": "number", "description": "Maximal aggregated upload throughput." }
- ],
- "hidden": true,
- "handlers": ["browser", "renderer"]
+ { "name": "uploadThroughput", "type": "number", "description": "Maximal aggregated upload throughput." },
+ { "name": "connectionType", "$ref": "ConnectionType", "optional": true, "description": "Connection type if known."}
+ ]
},
{
"name": "setCacheDisabled",
@@ -1356,6 +1323,14 @@
],
"description": "Toggles ignoring cache for each request. If <code>true</code>, cache will not be used."
},
+ {
+ "name": "setBypassServiceWorker",
+ "parameters": [
+ { "name": "bypass", "type": "boolean", "description": "Bypass service worker and load from network." }
+ ],
+ "experimental": true,
+ "description": "Toggles ignoring of service worker for each request."
+ },
{
"name": "setDataSizeLimitsForTest",
"parameters": [
@@ -1363,24 +1338,45 @@
{ "name": "maxResourceSize", "type": "integer", "description": "Maximum per-resource size." }
],
"description": "For testing.",
- "hidden": true
+ "experimental": true
+ },
+ {
+ "name": "getCertificate",
+ "description": "Returns the DER-encoded certificate.",
+ "parameters": [
+ { "name": "origin", "type": "string", "description": "Origin to get certificate for." }
+ ],
+ "returns": [
+ { "name": "tableNames", "type": "array", "items": { "type": "string" } }
+ ],
+ "experimental": true
}
],
"events": [
+ {
+ "name": "resourceChangedPriority",
+ "description": "Fired when resource loading priority is changed",
+ "parameters": [
+ { "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
+ { "name": "newPriority", "$ref": "ResourcePriority", "description": "New priority" },
+ { "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." }
+ ],
+ "experimental": true
+ },
{
"name": "requestWillBeSent",
"description": "Fired when page is about to send HTTP request.",
"parameters": [
{ "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
- { "name": "frameId", "$ref": "Page.FrameId", "description": "Frame identifier.", "hidden": true },
+ { "name": "frameId", "$ref": "Page.FrameId", "description": "Frame identifier.", "experimental": true },
{ "name": "loaderId", "$ref": "LoaderId", "description": "Loader identifier." },
{ "name": "documentURL", "type": "string", "description": "URL of the document this request is loaded for." },
{ "name": "request", "$ref": "Request", "description": "Request data." },
{ "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
- { "name": "wallTime", "$ref": "Timestamp", "hidden": true, "description": "UTC Timestamp." },
+ { "name": "wallTime", "$ref": "Timestamp", "experimental": true, "description": "UTC Timestamp." },
{ "name": "initiator", "$ref": "Initiator", "description": "Request initiator." },
{ "name": "redirectResponse", "optional": true, "$ref": "Response", "description": "Redirect response data." },
- { "name": "type", "$ref": "Page.ResourceType", "optional": true, "hidden": true, "description": "Type of this resource." }
+ { "name": "type", "$ref": "Page.ResourceType", "optional": true, "experimental": true, "description": "Type of this resource." }
]
},
{
@@ -1395,7 +1391,7 @@
"description": "Fired when HTTP response is available.",
"parameters": [
{ "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
- { "name": "frameId", "$ref": "Page.FrameId", "description": "Frame identifier.", "hidden": true },
+ { "name": "frameId", "$ref": "Page.FrameId", "description": "Frame identifier.", "experimental": true },
{ "name": "loaderId", "$ref": "LoaderId", "description": "Loader identifier." },
{ "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
{ "name": "type", "$ref": "Page.ResourceType", "description": "Resource type." },
@@ -1429,7 +1425,8 @@
{ "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
{ "name": "type", "$ref": "Page.ResourceType", "description": "Resource type." },
{ "name": "errorText", "type": "string", "description": "User friendly error message." },
- { "name": "canceled", "type": "boolean", "optional": true, "description": "True if loading was canceled." }
+ { "name": "canceled", "type": "boolean", "optional": true, "description": "True if loading was canceled." },
+ { "name": "blockedReason", "$ref": "BlockedReason", "optional": true, "description": "The reason why loading was blocked, if any.", "experimental": true }
]
},
{
@@ -1438,10 +1435,10 @@
"parameters": [
{ "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
{ "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
- { "name": "wallTime", "$ref": "Timestamp", "hidden": true, "description": "UTC Timestamp." },
+ { "name": "wallTime", "$ref": "Timestamp", "experimental": true, "description": "UTC Timestamp." },
{ "name": "request", "$ref": "WebSocketRequest", "description": "WebSocket request data." }
],
- "hidden": true
+ "experimental": true
},
{
"name": "webSocketHandshakeResponseReceived",
@@ -1451,16 +1448,17 @@
{ "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
{ "name": "response", "$ref": "WebSocketResponse", "description": "WebSocket response data." }
],
- "hidden": true
+ "experimental": true
},
{
"name": "webSocketCreated",
"description": "Fired upon WebSocket creation.",
"parameters": [
{ "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
- { "name": "url", "type": "string", "description": "WebSocket request URL." }
+ { "name": "url", "type": "string", "description": "WebSocket request URL." },
+ { "name": "initiator", "$ref": "Initiator", "optional": true, "description": "Request initiator." }
],
- "hidden": true
+ "experimental": true
},
{
"name": "webSocketClosed",
@@ -1469,7 +1467,7 @@
{ "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
{ "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." }
],
- "hidden": true
+ "experimental": true
},
{
"name": "webSocketFrameReceived",
@@ -1479,7 +1477,7 @@
{ "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
{ "name": "response", "$ref": "WebSocketFrame", "description": "WebSocket response data." }
],
- "hidden": true
+ "experimental": true
},
{
"name": "webSocketFrameError",
@@ -1489,7 +1487,7 @@
{ "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
{ "name": "errorMessage", "type": "string", "description": "WebSocket frame error message." }
],
- "hidden": true
+ "experimental": true
},
{
"name": "webSocketFrameSent",
@@ -1499,7 +1497,7 @@
{ "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
{ "name": "response", "$ref": "WebSocketFrame", "description": "WebSocket response data." }
],
- "hidden": true
+ "experimental": true
},
{
"name": "eventSourceMessageReceived",
@@ -1511,25 +1509,25 @@
{ "name": "eventId", "type": "string", "description": "Message identifier." },
{ "name": "data", "type": "string", "description": "Message content." }
],
- "hidden": true
+ "experimental": true
}
]
},
{
"domain": "Database",
- "hidden": true,
+ "experimental": true,
"types": [
{
"id": "DatabaseId",
"type": "string",
"description": "Unique identifier of Database object.",
- "hidden": true
+ "experimental": true
},
{
"id": "Database",
"type": "object",
"description": "Database object.",
- "hidden": true,
+ "experimental": true,
"properties": [
{ "name": "id", "$ref": "DatabaseId", "description": "Database ID." },
{ "name": "domain", "type": "string", "description": "Database domain." },
@@ -1567,7 +1565,6 @@
},
{
"name": "executeSQL",
- "async": true,
"parameters": [
{ "name": "databaseId", "$ref": "DatabaseId" },
{ "name": "query", "type": "string" }
@@ -1590,7 +1587,8 @@
},
{
"domain": "IndexedDB",
- "hidden": true,
+ "dependencies": ["Runtime"],
+ "experimental": true,
"types": [
{
"id": "DatabaseWithObjectStores",
@@ -1598,8 +1596,7 @@
"description": "Database with an array of object stores.",
"properties": [
{ "name": "name", "type": "string", "description": "Database name." },
- { "name": "version", "type": "string", "description": "Deprecated string database version." },
- { "name": "intVersion", "type": "integer", "description": "Integer database version." },
+ { "name": "version", "type": "integer", "description": "Database version." },
{ "name": "objectStores", "type": "array", "items": { "$ref": "ObjectStore" }, "description": "Object stores in this database." }
]
},
@@ -1653,9 +1650,9 @@
"type": "object",
"description": "Data entry.",
"properties": [
- { "name": "key", "type": "string", "description": "JSON-stringified key object." },
- { "name": "primaryKey", "type": "string", "description": "JSON-stringified primary key object." },
- { "name": "value", "type": "string", "description": "JSON-stringified value object." }
+ { "name": "key", "$ref": "Runtime.RemoteObject", "description": "Key object." },
+ { "name": "primaryKey", "$ref": "Runtime.RemoteObject", "description": "Primary key object." },
+ { "name": "value", "$ref": "Runtime.RemoteObject", "description": "Value object." }
]
},
{
@@ -1680,7 +1677,6 @@
},
{
"name": "requestDatabaseNames",
- "async": true,
"parameters": [
{ "name": "securityOrigin", "type": "string", "description": "Security origin." }
],
@@ -1691,7 +1687,6 @@
},
{
"name": "requestDatabase",
- "async": true,
"parameters": [
{ "name": "securityOrigin", "type": "string", "description": "Security origin." },
{ "name": "databaseName", "type": "string", "description": "Database name." }
@@ -1703,7 +1698,6 @@
},
{
"name": "requestData",
- "async": true,
"parameters": [
{ "name": "securityOrigin", "type": "string", "description": "Security origin." },
{ "name": "databaseName", "type": "string", "description": "Database name." },
@@ -1721,7 +1715,6 @@
},
{
"name": "clearObjectStore",
- "async": true,
"parameters": [
{ "name": "securityOrigin", "type": "string", "description": "Security origin." },
{ "name": "databaseName", "type": "string", "description": "Database name." },
@@ -1730,12 +1723,22 @@
"returns": [
],
"description": "Clears all entries from an object store."
+ },
+ {
+ "name": "deleteDatabase",
+ "parameters": [
+ { "name": "securityOrigin", "type": "string", "description": "Security origin." },
+ { "name": "databaseName", "type": "string", "description": "Database name." }
+ ],
+ "returns": [
+ ],
+ "description": "Deletes a database."
}
]
},
{
"domain": "CacheStorage",
- "hidden": true,
+ "experimental": true,
"types": [
{
"id": "CacheId",
@@ -1747,8 +1750,8 @@
"type": "object",
"description": "Data entry.",
"properties": [
- { "name": "request", "type": "string", "description": "JSON-stringified request object." },
- { "name": "response", "type": "string", "description": "JSON-stringified response object." }
+ { "name": "request", "type": "string", "description": "Request url spec." },
+ { "name": "response", "type": "string", "description": "Response stataus text." }
]
},
{
@@ -1765,7 +1768,6 @@
"commands": [
{
"name": "requestCacheNames",
- "async": true,
"parameters": [
{ "name": "securityOrigin", "type": "string", "description": "Security origin." }
],
@@ -1776,7 +1778,6 @@
},
{
"name": "requestEntries",
- "async": true,
"parameters": [
{ "name": "cacheId", "$ref": "CacheId", "description": "ID of cache to get entries from." },
{ "name": "skipCount", "type": "integer", "description": "Number of records to skip." },
@@ -1790,24 +1791,31 @@
},
{
"name": "deleteCache",
- "async": true,
"parameters": [
{ "name": "cacheId", "$ref": "CacheId", "description": "Id of cache for deletion." }
],
"description": "Deletes a cache."
+ },
+ {
+ "name": "deleteEntry",
+ "parameters": [
+ { "name": "cacheId", "$ref": "CacheId", "description": "Id of cache where the entry will be deleted." },
+ { "name": "request", "type": "string", "description": "URL spec of the request." }
+ ],
+ "description": "Deletes a cache entry."
}
]
},
{
"domain": "DOMStorage",
- "hidden": true,
+ "experimental": true,
"description": "Query and modify DOM storage.",
"types": [
{
"id": "StorageId",
"type": "object",
"description": "DOM Storage identifier.",
- "hidden": true,
+ "experimental": true,
"properties": [
{ "name": "securityOrigin", "type": "string", "description": "Security origin for the storage." },
{ "name": "isLocalStorage", "type": "boolean", "description": "Whether the storage is local storage (not session storage)." }
@@ -1817,7 +1825,7 @@
"id": "Item",
"type": "array",
"description": "DOM Storage item.",
- "hidden": true,
+ "experimental": true,
"items": { "type": "string" }
}
],
@@ -1830,6 +1838,12 @@
"name": "disable",
"description": "Disables storage tracking, prevents storage events from being sent to the client."
},
+ {
+ "name": "clear",
+ "parameters": [
+ { "name": "storageId", "$ref": "StorageId" }
+ ]
+ },
{
"name": "getDOMStorageItems",
"parameters": [
@@ -1890,7 +1904,7 @@
},
{
"domain": "ApplicationCache",
- "hidden": true,
+ "experimental": true,
"types": [
{
"id": "ApplicationCacheResource",
@@ -1976,122 +1990,20 @@
]
},
{
- "domain": "FileSystem",
- "hidden": true,
+ "domain": "DOM",
+ "description": "This domain exposes DOM read/write operations. Each DOM Node is represented with its mirror object that has an <code>id</code>. This <code>id</code> can be used to get additional information on the Node, resolve it into the JavaScript object wrapper, etc. It is important that client receives DOM events only for the nodes that are known to the client. Backend keeps track of the nodes that were sent to the client and never sends the same node twice. It is client's responsibility to collect information about the nodes that were sent to the client.<p>Note that <code>iframe</code> owner elements will return corresponding document elements as their child nodes.</p>",
+ "dependencies": ["Runtime"],
"types": [
{
- "id": "Entry",
- "type": "object",
- "properties": [
- { "name": "url", "type": "string", "description": "filesystem: URL for the entry." },
- { "name": "name", "type": "string", "description": "The name of the file or directory." },
- { "name": "isDirectory", "type": "boolean", "description": "True if the entry is a directory." },
- { "name": "mimeType", "type": "string", "optional": true, "description": "MIME type of the entry, available for a file only." },
- { "name": "resourceType", "$ref": "Page.ResourceType", "optional": true, "description": "ResourceType of the entry, available for a file only." },
- { "name": "isTextFile", "type": "boolean", "optional": true, "description": "True if the entry is a text file." }
- ],
- "description": "Represents a browser side file or directory."
- },
- {
- "id": "Metadata",
- "type": "object",
- "properties": [
- { "name": "modificationTime", "type": "number", "description": "Modification time." },
- { "name": "size", "type": "number", "description": "File size. This field is always zero for directories." }
- ],
- "description": "Represents metadata of a file or entry."
- }
- ],
- "commands": [
- {
- "name": "enable",
- "description": "Enables events from backend."
- },
- {
- "name": "disable",
- "description": "Disables events from backend."
- },
- {
- "name": "requestFileSystemRoot",
- "async": true,
- "parameters": [
- { "name": "origin", "type": "string", "description": "Security origin of requesting FileSystem. One of frames in current page needs to have this security origin." },
- { "name": "type", "type": "string", "enum": ["temporary", "persistent"], "description": "FileSystem type of requesting FileSystem." }
- ],
- "returns": [
- { "name": "errorCode", "type": "integer", "description": "0, if no error. Otherwise, errorCode is set to FileError::ErrorCode value." },
- { "name": "root", "$ref": "Entry", "optional": true, "description": "Contains root of the requested FileSystem if the command completed successfully." }
- ],
- "description": "Returns root directory of the FileSystem, if exists."
- },
- {
- "name": "requestDirectoryContent",
- "async": true,
- "parameters": [
- { "name": "url", "type": "string", "description": "URL of the directory that the frontend is requesting to read from." }
- ],
- "returns": [
- { "name": "errorCode", "type": "integer", "description": "0, if no error. Otherwise, errorCode is set to FileError::ErrorCode value." },
- { "name": "entries", "type": "array", "items": { "$ref": "Entry" }, "optional": true, "description": "Contains all entries on directory if the command completed successfully." }
- ],
- "description": "Returns content of the directory."
- },
- {
- "name": "requestMetadata",
- "async": true,
- "parameters": [
- { "name": "url", "type": "string", "description": "URL of the entry that the frontend is requesting to get metadata from." }
- ],
- "returns": [
- { "name": "errorCode", "type": "integer", "description": "0, if no error. Otherwise, errorCode is set to FileError::ErrorCode value." },
- { "name": "metadata", "$ref": "Metadata", "optional": true, "description": "Contains metadata of the entry if the command completed successfully." }
- ],
- "description": "Returns metadata of the entry."
- },
- {
- "name": "requestFileContent",
- "async": true,
- "parameters": [
- { "name": "url", "type": "string", "description": "URL of the file that the frontend is requesting to read from." },
- { "name": "readAsText", "type": "boolean", "description": "True if the content should be read as text, otherwise the result will be returned as base64 encoded text." },
- { "name": "start", "type": "integer", "optional": true, "description": "Specifies the start of range to read." },
- { "name": "end", "type": "integer", "optional": true, "description": "Specifies the end of range to read exclusively." },
- { "name": "charset", "type": "string", "optional": true, "description": "Overrides charset of the content when content is served as text." }
- ],
- "returns": [
- { "name": "errorCode", "type": "integer", "description": "0, if no error. Otherwise, errorCode is set to FileError::ErrorCode value." },
- { "name": "content", "type": "string", "optional": true, "description": "Content of the file." },
- { "name": "charset", "type": "string", "optional": true, "description": "Charset of the content if it is served as text." }
- ],
- "description": "Returns content of the file. Result should be sliced into [start, end)."
- },
- {
- "name": "deleteEntry",
- "async": true,
- "parameters": [
- { "name": "url", "type": "string", "description": "URL of the entry to delete." }
- ],
- "returns": [
- { "name": "errorCode", "type": "integer", "description": "0, if no error. Otherwise errorCode is set to FileError::ErrorCode value." }
- ],
- "description": "Deletes specified entry. If the entry is a directory, the agent deletes children recursively."
- }
- ]
- },
- {
- "domain": "DOM",
- "description": "This domain exposes DOM read/write operations. Each DOM Node is represented with its mirror object that has an <code>id</code>. This <code>id</code> can be used to get additional information on the Node, resolve it into the JavaScript object wrapper, etc. It is important that client receives DOM events only for the nodes that are known to the client. Backend keeps track of the nodes that were sent to the client and never sends the same node twice. It is client's responsibility to collect information about the nodes that were sent to the client.<p>Note that <code>iframe</code> owner elements will return corresponding document elements as their child nodes.</p>",
- "types": [
- {
- "id": "NodeId",
- "type": "integer",
- "description": "Unique DOM node identifier."
+ "id": "NodeId",
+ "type": "integer",
+ "description": "Unique DOM node identifier."
},
{
"id": "BackendNodeId",
"type": "integer",
"description": "Unique DOM node identifier used to reference a node that may not have been pushed to the front-end.",
- "hidden": true
+ "experimental": true
},
{
"id": "BackendNode",
@@ -2101,7 +2013,7 @@
{ "name": "nodeName", "type": "string", "description": "<code>Node</code>'s nodeName." },
{ "name": "backendNodeId", "$ref": "BackendNodeId" }
],
- "hidden": true,
+ "experimental": true,
"description": "Backend node with a friendly name."
},
{
@@ -2129,7 +2041,7 @@
{
"id": "ShadowRootType",
"type": "string",
- "enum": ["user-agent", "author"],
+ "enum": ["user-agent", "open", "closed"],
"description": "Shadow root type."
},
{
@@ -2137,6 +2049,8 @@
"type": "object",
"properties": [
{ "name": "nodeId", "$ref": "NodeId", "description": "Node identifier that is passed into the rest of the DOM messages as the <code>nodeId</code>. Backend will only push node with given <code>id</code> once. It is aware of all requested nodes and will only fire DOM events for nodes known to the client." },
+ { "name": "parentId", "$ref": "NodeId", "optional": true, "description": "The id of the parent node if any.", "experimental": true },
+ { "name": "backendNodeId", "$ref": "BackendNodeId", "description": "The BackendNodeId for this node.", "experimental": true },
{ "name": "nodeType", "type": "integer", "description": "<code>Node</code>'s nodeType." },
{ "name": "nodeName", "type": "string", "description": "<code>Node</code>'s nodeName." },
{ "name": "localName", "type": "string", "description": "<code>Node</code>'s localName." },
@@ -2145,7 +2059,7 @@
{ "name": "children", "type": "array", "optional": true, "items": { "$ref": "Node" }, "description": "Child nodes of this node when requested with children." },
{ "name": "attributes", "type": "array", "optional": true, "items": { "type": "string" }, "description": "Attributes of the <code>Element</code> node in the form of flat array <code>[name1, value1, name2, value2]</code>." },
{ "name": "documentURL", "type": "string", "optional": true, "description": "Document URL that <code>Document</code> or <code>FrameOwner</code> node points to." },
- { "name": "baseURL", "type": "string", "optional": true, "description": "Base URL that <code>Document</code> or <code>FrameOwner</code> node uses for URL completion.", "hidden": true },
+ { "name": "baseURL", "type": "string", "optional": true, "description": "Base URL that <code>Document</code> or <code>FrameOwner</code> node uses for URL completion.", "experimental": true },
{ "name": "publicId", "type": "string", "optional": true, "description": "<code>DocumentType</code>'s publicId." },
{ "name": "systemId", "type": "string", "optional": true, "description": "<code>DocumentType</code>'s systemId." },
{ "name": "internalSubset", "type": "string", "optional": true, "description": "<code>DocumentType</code>'s internalSubset." },
@@ -2154,27 +2068,14 @@
{ "name": "value", "type": "string", "optional": true, "description": "<code>Attr</code>'s value." },
{ "name": "pseudoType", "$ref": "PseudoType", "optional": true, "description": "Pseudo element type for this node." },
{ "name": "shadowRootType", "$ref": "ShadowRootType", "optional": true, "description": "Shadow root type." },
- { "name": "frameId", "$ref": "Page.FrameId", "optional": true, "description": "Frame ID for frame owner elements.", "hidden": true },
+ { "name": "frameId", "$ref": "Page.FrameId", "optional": true, "description": "Frame ID for frame owner elements.", "experimental": true },
{ "name": "contentDocument", "$ref": "Node", "optional": true, "description": "Content document for frame owner elements." },
- { "name": "shadowRoots", "type": "array", "optional": true, "items": { "$ref": "Node" }, "description": "Shadow root list for given element host.", "hidden": true },
- { "name": "templateContent", "$ref": "Node", "optional": true, "description": "Content document fragment for template elements.", "hidden": true },
- { "name": "pseudoElements", "type": "array", "items": { "$ref": "Node" }, "optional": true, "description": "Pseudo elements associated with this node.", "hidden": true },
+ { "name": "shadowRoots", "type": "array", "optional": true, "items": { "$ref": "Node" }, "description": "Shadow root list for given element host.", "experimental": true },
+ { "name": "templateContent", "$ref": "Node", "optional": true, "description": "Content document fragment for template elements.", "experimental": true },
+ { "name": "pseudoElements", "type": "array", "items": { "$ref": "Node" }, "optional": true, "description": "Pseudo elements associated with this node.", "experimental": true },
{ "name": "importedDocument", "$ref": "Node", "optional": true, "description": "Import document for the HTMLImport links." },
- { "name": "distributedNodes", "type": "array", "items": { "$ref": "BackendNode" }, "optional": true, "description": "Distributed nodes for given insertion point.", "hidden": true }
- ],
- "description": "DOM interaction is implemented in terms of mirror objects that represent the actual DOM nodes. DOMNode is a base node mirror type."
- },
- {
- "id": "EventListener",
- "type": "object",
- "hidden": true,
- "properties": [
- { "name": "type", "type": "string", "description": "<code>EventListener</code>'s type." },
- { "name": "useCapture", "type": "boolean", "description": "<code>EventListener</code>'s useCapture." },
- { "name": "isAttribute", "type": "boolean", "description": "<code>EventListener</code>'s isAttribute." },
- { "name": "nodeId", "$ref": "NodeId", "description": "Target <code>DOMNode</code> id." },
- { "name": "location", "$ref": "Debugger.Location", "description": "Handler code location." },
- { "name": "handler", "$ref": "Runtime.RemoteObject", "optional": true, "description": "Event handler function value." }
+ { "name": "distributedNodes", "type": "array", "items": { "$ref": "BackendNode" }, "optional": true, "description": "Distributed nodes for given insertion point.", "experimental": true },
+ { "name": "isSVG", "type": "boolean", "optional": true, "description": "Whether the node is SVG.", "experimental": true }
],
"description": "DOM interaction is implemented in terms of mirror objects that represent the actual DOM nodes. DOMNode is a base node mirror type."
},
@@ -2196,12 +2097,12 @@
"minItems": 8,
"maxItems": 8,
"description": "An array of quad vertices, x immediately followed by y for each point, points clock-wise.",
- "hidden": true
+ "experimental": true
},
{
"id": "BoxModel",
"type": "object",
- "hidden": true,
+ "experimental": true,
"properties": [
{ "name": "content", "$ref": "Quad", "description": "Content box" },
{ "name": "padding", "$ref": "Quad", "description": "Padding box" },
@@ -2216,7 +2117,7 @@
{
"id": "ShapeOutsideInfo",
"type": "object",
- "hidden": true,
+ "experimental": true,
"properties": [
{ "name": "bounds", "$ref": "Quad", "description": "Shape bounds" },
{ "name": "shape", "type": "array", "items": { "type": "any"}, "description": "Shape coordinate details" },
@@ -2227,7 +2128,7 @@
{
"id": "Rect",
"type": "object",
- "hidden": true,
+ "experimental": true,
"properties": [
{ "name": "x", "type": "number", "description": "X coordinate" },
{ "name": "y", "type": "number", "description": "Y coordinate" },
@@ -2243,15 +2144,27 @@
{ "name": "showInfo", "type": "boolean", "optional": true, "description": "Whether the node info tooltip should be shown (default: false)." },
{ "name": "showRulers", "type": "boolean", "optional": true, "description": "Whether the rulers should be shown (default: false)." },
{ "name": "showExtensionLines", "type": "boolean", "optional": true, "description": "Whether the extension lines from node to the rulers should be shown (default: false)." },
+ { "name": "displayAsMaterial", "type": "boolean", "optional": true, "experimental": true},
{ "name": "contentColor", "$ref": "RGBA", "optional": true, "description": "The content box highlight fill color (default: transparent)." },
{ "name": "paddingColor", "$ref": "RGBA", "optional": true, "description": "The padding highlight fill color (default: transparent)." },
{ "name": "borderColor", "$ref": "RGBA", "optional": true, "description": "The border highlight fill color (default: transparent)." },
{ "name": "marginColor", "$ref": "RGBA", "optional": true, "description": "The margin highlight fill color (default: transparent)." },
- { "name": "eventTargetColor", "$ref": "RGBA", "optional": true, "hidden": true, "description": "The event target element highlight fill color (default: transparent)." },
- { "name": "shapeColor", "$ref": "RGBA", "optional": true, "hidden": true, "description": "The shape outside fill color (default: transparent)." },
- { "name": "shapeMarginColor", "$ref": "RGBA", "optional": true, "hidden": true, "description": "The shape margin fill color (default: transparent)." }
+ { "name": "eventTargetColor", "$ref": "RGBA", "optional": true, "experimental": true, "description": "The event target element highlight fill color (default: transparent)." },
+ { "name": "shapeColor", "$ref": "RGBA", "optional": true, "experimental": true, "description": "The shape outside fill color (default: transparent)." },
+ { "name": "shapeMarginColor", "$ref": "RGBA", "optional": true, "experimental": true, "description": "The shape margin fill color (default: transparent)." },
+ { "name": "selectorList", "type": "string", "optional": true, "description": "Selectors to highlight relevant nodes."}
],
"description": "Configuration data for the highlighting of page elements."
+ },
+ {
+ "id": "InspectMode",
+ "type": "string",
+ "experimental": true,
+ "enum": [
+ "searchForNode",
+ "searchForUAShadowDOM",
+ "none"
+ ]
}
],
"commands": [
@@ -2265,16 +2178,43 @@
},
{
"name": "getDocument",
+ "parameters": [
+ { "name": "depth", "type": "integer", "optional": true, "description": "The maximum depth at which children should be retrieved, defaults to 1. Use -1 for the entire subtree or provide an integer larger than 0.", "experimental": true },
+ { "name": "pierce", "type": "boolean", "optional": true, "description": "Whether or not iframes and shadow roots should be traversed when returning the subtree (default is false).", "experimental": true }
+ ],
"returns": [
{ "name": "root", "$ref": "Node", "description": "Resulting node." }
],
- "description": "Returns the root DOM node to the caller."
+ "description": "Returns the root DOM node (and optionally the subtree) to the caller."
+ },
+ {
+ "name": "getFlattenedDocument",
+ "parameters": [
+ { "name": "depth", "type": "integer", "optional": true, "description": "The maximum depth at which children should be retrieved, defaults to 1. Use -1 for the entire subtree or provide an integer larger than 0.", "experimental": true },
+ { "name": "pierce", "type": "boolean", "optional": true, "description": "Whether or not iframes and shadow roots should be traversed when returning the subtree (default is false).", "experimental": true }
+ ],
+ "returns": [
+ { "name": "nodes", "type": "array", "items": { "$ref": "Node" }, "description": "Resulting node." }
+ ],
+ "description": "Returns the root DOM node (and optionally the subtree) to the caller."
+ },
+ {
+ "name": "collectClassNamesFromSubtree",
+ "parameters": [
+ { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to collect class names." }
+ ],
+ "returns": [
+ {"name": "classNames", "type": "array", "items": { "type": "string" }, "description": "Class name list." }
+ ],
+ "description": "Collects class names for the node with given id and all of it's child nodes.",
+ "experimental": true
},
{
"name": "requestChildNodes",
"parameters": [
{ "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to get children for." },
- { "name": "depth", "type": "integer", "optional": true, "description": "The maximum depth at which children should be retrieved, defaults to 1. Use -1 for the entire subtree or provide an integer larger than 0.", "hidden": true }
+ { "name": "depth", "type": "integer", "optional": true, "description": "The maximum depth at which children should be retrieved, defaults to 1. Use -1 for the entire subtree or provide an integer larger than 0.", "experimental": true },
+ { "name": "pierce", "type": "boolean", "optional": true, "description": "Whether or not iframes and shadow roots should be traversed when returning the sub-tree (default is false).", "experimental": true }
],
"description": "Requests that children of the node with given id are returned to the caller in form of <code>setChildNodes</code> events where not only immediate children are retrieved, but all children down to the specified depth."
},
@@ -2352,18 +2292,6 @@
],
"description": "Removes attribute with given name from an element with given id."
},
- {
- "name": "getEventListenersForNode",
- "parameters": [
- { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to get listeners for." },
- { "name": "objectGroup", "type": "string", "optional": true, "description": "Symbolic group name for handler value. Handler value is not returned without this parameter specified." }
- ],
- "returns": [
- { "name": "listeners", "type": "array", "items": { "$ref": "EventListener" }, "description": "Array of relevant listeners." }
- ],
- "description": "Returns event listeners relevant to the node.",
- "hidden": true
- },
{
"name": "getOuterHTML",
"parameters": [
@@ -2386,14 +2314,14 @@
"name": "performSearch",
"parameters": [
{ "name": "query", "type": "string", "description": "Plain text or query selector or XPath search query." },
- { "name": "includeUserAgentShadowDOM", "type": "boolean", "optional": true, "description": "True to search in user agent shadow DOM.", "hidden": true }
+ { "name": "includeUserAgentShadowDOM", "type": "boolean", "optional": true, "description": "True to search in user agent shadow DOM.", "experimental": true }
],
"returns": [
{ "name": "searchId", "type": "string", "description": "Unique search session identifier." },
{ "name": "resultCount", "type": "integer", "description": "Number of search results." }
],
"description": "Searches for a given string in the DOM tree. Use <code>getSearchResults</code> to access search results or <code>cancelSearch</code> to end this search session.",
- "hidden": true
+ "experimental": true
},
{
"name": "getSearchResults",
@@ -2406,7 +2334,7 @@
{ "name": "nodeIds", "type": "array", "items": { "$ref": "NodeId" }, "description": "Ids of the search result nodes." }
],
"description": "Returns search results from given <code>fromIndex</code> to given <code>toIndex</code> from the sarch with the given identifier.",
- "hidden": true
+ "experimental": true
},
{
"name": "discardSearchResults",
@@ -2414,7 +2342,7 @@
{ "name": "searchId", "type": "string", "description": "Unique search session identifier." }
],
"description": "Discards search results from the session with the given id. <code>getSearchResults</code> should no longer be called for that search.",
- "hidden": true
+ "experimental": true
},
{
"name": "requestNode",
@@ -2427,11 +2355,10 @@
"description": "Requests that the node is sent to the caller given the JavaScript node object reference. All nodes that form the path from the node to the root are also sent to the client as a series of <code>setChildNodes</code> notifications."
},
{
- "name": "setInspectModeEnabled",
- "hidden": true,
+ "name": "setInspectMode",
+ "experimental": true,
"parameters": [
- { "name": "enabled", "type": "boolean", "description": "True to enable inspection mode, false to disable it." },
- { "name": "inspectUAShadowDOM", "type": "boolean", "optional": true, "description": "True to enable inspection mode for user agent shadow DOM." },
+ { "name": "mode", "$ref": "InspectMode", "description": "Set an inspection mode." },
{ "name": "highlightConfig", "$ref": "HighlightConfig", "optional": true, "description": "A descriptor for the highlight appearance of hovered-over nodes. May be omitted if <code>enabled == false</code>." }
],
"description": "Enters the 'inspect' mode. In this mode, elements that user is hovering over are highlighted. Backend then generates 'inspectNodeRequested' event upon element selection."
@@ -2456,7 +2383,7 @@
{ "name": "outlineColor", "$ref": "RGBA", "optional": true, "description": "The highlight outline color (default: transparent)." }
],
"description": "Highlights given quad. Coordinates are absolute with respect to the main frame viewport.",
- "hidden": true
+ "experimental": true
},
{
"name": "highlightNode",
@@ -2464,7 +2391,7 @@
{ "name": "highlightConfig", "$ref": "HighlightConfig", "description": "A descriptor for the highlight appearance." },
{ "name": "nodeId", "$ref": "NodeId", "optional": true, "description": "Identifier of the node to highlight." },
{ "name": "backendNodeId", "$ref": "BackendNodeId", "optional": true, "description": "Identifier of the backend node to highlight." },
- { "name": "objectId", "$ref": "Runtime.RemoteObjectId", "optional": true, "description": "JavaScript object id of the node to be highlighted.", "hidden": true }
+ { "name": "objectId", "$ref": "Runtime.RemoteObjectId", "optional": true, "description": "JavaScript object id of the node to be highlighted.", "experimental": true }
],
"description": "Highlights DOM node with given id or with the given JavaScript object wrapper. Either nodeId or objectId must be specified."
},
@@ -2480,7 +2407,7 @@
{ "name": "contentOutlineColor", "$ref": "RGBA", "optional": true, "description": "The content box highlight outline color (default: transparent)." }
],
"description": "Highlights owner element of the frame with given id.",
- "hidden": true
+ "experimental": true
},
{
"name": "pushNodeByPathToFrontend",
@@ -2491,7 +2418,7 @@
{ "name": "nodeId", "$ref": "NodeId", "description": "Id of the node for given path." }
],
"description": "Requests that the node is sent to the caller given its path. // FIXME, use XPath",
- "hidden": true
+ "experimental": true
},
{
"name": "pushNodesByBackendIdsToFrontend",
@@ -2502,7 +2429,7 @@
{ "name": "nodeIds", "type": "array", "items": {"$ref": "NodeId"}, "description": "The array of ids of pushed nodes that correspond to the backend ids specified in backendNodeIds." }
],
"description": "Requests that a batch of nodes is sent to the caller given their backend node ids.",
- "hidden": true
+ "experimental": true
},
{
"name": "setInspectedNode",
@@ -2510,7 +2437,7 @@
{ "name": "nodeId", "$ref": "NodeId", "description": "DOM node id to be accessible by means of $x command line API." }
],
"description": "Enables console to refer to the node with given id via $x (see Command Line API for more details $x functions).",
- "hidden": true
+ "experimental": true
},
{
"name": "resolveNode",
@@ -2544,7 +2471,7 @@
{ "name": "nodeId", "$ref": "NodeId", "description": "Id of the node clone." }
],
"description": "Creates a deep copy of the specified node and places it into the target container before the given anchor.",
- "hidden": true
+ "experimental": true
},
{
"name": "moveTo",
@@ -2561,17 +2488,17 @@
{
"name": "undo",
"description": "Undoes the last performed action.",
- "hidden": true
+ "experimental": true
},
{
"name": "redo",
"description": "Re-does the last undone action.",
- "hidden": true
+ "experimental": true
},
{
"name": "markUndoableState",
"description": "Marks last undoable state.",
- "hidden": true
+ "experimental": true
},
{
"name": "focus",
@@ -2579,7 +2506,7 @@
{ "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to focus." }
],
"description": "Focuses the given element.",
- "hidden": true
+ "experimental": true
},
{
"name": "setFileInputFiles",
@@ -2588,8 +2515,7 @@
{ "name": "files", "type": "array", "items": { "type": "string" }, "description": "Array of file paths to set." }
],
"description": "Sets files for the given file input element.",
- "hidden": true,
- "handlers": ["browser", "renderer"]
+ "experimental": true
},
{
"name": "getBoxModel",
@@ -2600,7 +2526,7 @@
{ "name": "model", "$ref": "BoxModel", "description": "Box model for the node." }
],
"description": "Returns boxes for the currently selected nodes.",
- "hidden": true
+ "experimental": true
},
{
"name": "getNodeForLocation",
@@ -2612,7 +2538,7 @@
{ "name": "nodeId", "$ref": "NodeId", "description": "Id of the node at given coordinates." }
],
"description": "Returns node id at given location.",
- "hidden": true
+ "experimental": true
},
{
"name": "getRelayoutBoundary",
@@ -2623,7 +2549,7 @@
{ "name": "nodeId", "$ref": "NodeId", "description": "Relayout boundary node id for the given node." }
],
"description": "Returns the id of the nearest ancestor that is a relayout boundary.",
- "hidden": true
+ "experimental": true
},
{
"name": "getHighlightObjectForTest",
@@ -2634,7 +2560,7 @@
{ "name": "highlight", "type": "object", "description": "Highlight data for the node." }
],
"description": "For testing.",
- "hidden": true
+ "experimental": true
}
],
"events": [
@@ -2647,8 +2573,8 @@
"parameters": [
{ "name": "backendNodeId", "$ref": "BackendNodeId", "description": "Id of the node to inspect." }
],
- "description": "Fired when the node should be inspected. This happens after call to <code>setInspectModeEnabled</code>.",
- "hidden" : true
+ "description": "Fired when the node should be inspected. This happens after call to <code>setInspectMode</code>.",
+ "experimental" : true
},
{
"name": "setChildNodes",
@@ -2681,7 +2607,7 @@
{ "name": "nodeIds", "type": "array", "items": { "$ref": "NodeId" }, "description": "Ids of the nodes for which the inline styles have been invalidated." }
],
"description": "Fired when <code>Element</code>'s inline style is modified via a CSS property modification.",
- "hidden": true
+ "experimental": true
},
{
"name": "characterDataModified",
@@ -2723,7 +2649,7 @@
{ "name": "root", "$ref": "Node", "description": "Shadow root." }
],
"description": "Called when shadow root is pushed into the element.",
- "hidden": true
+ "experimental": true
},
{
"name": "shadowRootPopped",
@@ -2732,7 +2658,7 @@
{ "name": "rootId", "$ref": "NodeId", "description": "Shadow root id." }
],
"description": "Called when shadow root is popped from the element.",
- "hidden": true
+ "experimental": true
},
{
"name": "pseudoElementAdded",
@@ -2741,7 +2667,7 @@
{ "name": "pseudoElement", "$ref": "Node", "description": "The added pseudo element." }
],
"description": "Called when a pseudo element is added to an element.",
- "hidden": true
+ "experimental": true
},
{
"name": "pseudoElementRemoved",
@@ -2750,7 +2676,7 @@
{ "name": "pseudoElementId", "$ref": "NodeId", "description": "The removed pseudo element id." }
],
"description": "Called when a pseudo element is removed from an element.",
- "hidden": true
+ "experimental": true
},
{
"name": "distributedNodesUpdated",
@@ -2759,14 +2685,22 @@
{ "name": "distributedNodes", "type": "array", "items": { "$ref": "BackendNode" }, "description": "Distributed nodes for given insertion point." }
],
"description": "Called when distrubution is changed.",
- "hidden": true
+ "experimental": true
+ },
+ {
+ "name": "nodeHighlightRequested",
+ "parameters": [
+ {"name": "nodeId", "$ref": "NodeId"}
+ ],
+ "experimental": true
}
]
},
{
"domain": "CSS",
- "hidden": true,
+ "experimental": true,
"description": "This domain exposes CSS read/write operations. All CSS objects (stylesheets, rules, and styles) have an associated <code>id</code> used in subsequent operations on the related object. Each object type has a specific <code>id</code> structure, and those are not interchangeable between objects of different kinds. CSS objects can be loaded using the <code>get*ForNode()</code> calls (which accept a DOM node id). A client can also discover all the existing stylesheets with the <code>getAllStyleSheets()</code> method (or keeping track of the <code>styleSheetAdded</code>/<code>styleSheetRemoved</code> events) and subsequently load the required stylesheet contents using the <code>getStyleSheet[Text]()</code> methods.",
+ "dependencies": ["DOM"],
"types": [
{
"id": "StyleSheetId",
@@ -2779,10 +2713,10 @@
"description": "Stylesheet type: \"injected\" for stylesheets injected via extension, \"user-agent\" for user-agent stylesheets, \"inspector\" for stylesheets created by the inspector (i.e. those holding the \"via inspector\" rules), \"regular\" for regular stylesheets."
},
{
- "id": "PseudoIdMatches",
+ "id": "PseudoElementMatches",
"type": "object",
"properties": [
- { "name": "pseudoId", "type": "integer", "description": "Pseudo style identifier (see <code>enum PseudoId</code> in <code>ComputedStyleConstants.h</code>)."},
+ { "name": "pseudoType", "$ref": "DOM.PseudoType", "description": "Pseudo element type."},
{ "name": "matches", "type": "array", "items": { "$ref": "RuleMatch" }, "description": "Matches of CSS rules applicable to the pseudo style."}
],
"description": "CSS rule collection for a single pseudo style."
@@ -2806,11 +2740,11 @@
"description": "Match data for a CSS rule."
},
{
- "id": "Selector",
+ "id": "Value",
"type": "object",
"properties": [
- { "name": "value", "type": "string", "description": "Selector text." },
- { "name": "range", "$ref": "SourceRange", "optional": true, "description": "Selector range in the underlying resource (if available)." }
+ { "name": "text", "type": "string", "description": "Value text." },
+ { "name": "range", "$ref": "SourceRange", "optional": true, "description": "Value range in the underlying resource (if available)." }
],
"description": "Data for a simple selector (these are delimited by commas in a selector list)."
},
@@ -2818,7 +2752,7 @@
"id": "SelectorList",
"type": "object",
"properties": [
- { "name": "selectors", "type": "array", "items": { "$ref": "Selector" }, "description": "Selectors in the list." },
+ { "name": "selectors", "type": "array", "items": { "$ref": "Value" }, "description": "Selectors in the list." },
{ "name": "text", "type": "string", "description": "Rule selector text." }
],
"description": "Selector list data."
@@ -2854,6 +2788,18 @@
],
"description": "CSS rule representation."
},
+ {
+ "id": "RuleUsage",
+ "type": "object",
+ "properties": [
+ { "name": "styleSheetId", "$ref": "StyleSheetId", "description": "The css style sheet identifier (absent for user agent stylesheet and user-specified stylesheet rules) this rule came from." },
+ { "name": "startOffset", "type": "number", "description": "Offset of the start of the rule (including selector) from the beginning of the stylesheet." },
+ { "name": "endOffset", "type": "number", "description": "Offset of the end of the rule body from the beginning of the stylesheet." },
+ { "name": "used", "type": "boolean", "description": "Indicates whether the rule was actually used by some element in the page." }
+ ],
+ "description": "CSS rule usage information.",
+ "experimental": true
+ },
{
"id": "SourceRange",
"type": "object",
@@ -2870,7 +2816,8 @@
"type": "object",
"properties": [
{ "name": "name", "type": "string", "description": "Shorthand name." },
- { "name": "value", "type": "string", "description": "Shorthand value." }
+ { "name": "value", "type": "string", "description": "Shorthand value." },
+ { "name": "important", "type": "boolean", "optional": true, "description": "Whether the property has \"!important\" annotation (implies <code>false</code> if absent)." }
]
},
{
@@ -2916,8 +2863,8 @@
{ "name": "source", "type": "string", "enum": ["mediaRule", "importRule", "linkedSheet", "inlineSheet"], "description": "Source of the media query: \"mediaRule\" if specified by a @media rule, \"importRule\" if specified by an @import rule, \"linkedSheet\" if specified by a \"media\" attribute in a linked stylesheet's LINK tag, \"inlineSheet\" if specified by a \"media\" attribute in an inline stylesheet's STYLE tag." },
{ "name": "sourceURL", "type": "string", "optional": true, "description": "URL of the document containing the media query description." },
{ "name": "range", "$ref": "SourceRange", "optional": true, "description": "The associated rule (@media or @import) header range in the enclosing stylesheet (if available)." },
- { "name": "parentStyleSheetId", "$ref": "StyleSheetId", "optional": true, "description": "Identifier of the stylesheet containing this object (if exists)." },
- { "name": "mediaList", "type": "array", "items": { "$ref": "MediaQuery" }, "optional": true, "hidden": true, "description": "Array of media queries." }
+ { "name": "styleSheetId", "$ref": "StyleSheetId", "optional": true, "description": "Identifier of the stylesheet containing this object (if exists)." },
+ { "name": "mediaList", "type": "array", "items": { "$ref": "MediaQuery" }, "optional": true, "experimental": true, "description": "Array of media queries." }
],
"description": "CSS media rule descriptor."
},
@@ -2929,7 +2876,7 @@
{ "name": "active", "type": "boolean", "description": "Whether the media query condition is satisfied." }
],
"description": "Media query descriptor.",
- "hidden": true
+ "experimental": true
},
{
"id": "MediaQueryExpression",
@@ -2942,23 +2889,86 @@
{ "name": "computedLength", "type": "number", "optional": true, "description": "Computed length of media query expression (if applicable)."}
],
"description": "Media query expression descriptor.",
- "hidden": true
+ "experimental": true
},
{
"id": "PlatformFontUsage",
"type": "object",
"properties": [
{ "name": "familyName", "type": "string", "description": "Font's family name reported by platform."},
+ { "name": "isCustomFont", "type": "boolean", "description": "Indicates if the font was downloaded or resolved locally."},
{ "name": "glyphCount", "type": "number", "description": "Amount of glyphs that were rendered with this font."}
],
"description": "Information about amount of glyphs that were rendered with given font.",
- "hidden": true
+ "experimental": true
+ },
+ {
+ "id": "CSSKeyframesRule",
+ "type": "object",
+ "properties": [
+ { "name": "animationName", "$ref": "Value", "description": "Animation name." },
+ { "name": "keyframes", "type": "array", "items": { "$ref": "CSSKeyframeRule" }, "description": "List of keyframes." }
+ ],
+ "description": "CSS keyframes rule representation."
+ },
+ {
+ "id": "CSSKeyframeRule",
+ "type": "object",
+ "properties": [
+ { "name": "styleSheetId", "$ref": "StyleSheetId", "optional": true, "description": "The css style sheet identifier (absent for user agent stylesheet and user-specified stylesheet rules) this rule came from." },
+ { "name": "origin", "$ref": "StyleSheetOrigin", "description": "Parent stylesheet's origin."},
+ { "name": "keyText", "$ref": "Value", "description": "Associated key text." },
+ { "name": "style", "$ref": "CSSStyle", "description": "Associated style declaration." }
+ ],
+ "description": "CSS keyframe rule representation."
+ },
+ {
+ "id": "StyleDeclarationEdit",
+ "type": "object",
+ "properties": [
+ { "name": "styleSheetId", "$ref": "StyleSheetId", "description": "The css style sheet identifier." },
+ { "name": "range", "$ref": "SourceRange", "description": "The range of the style text in the enclosing stylesheet." },
+ { "name": "text", "type": "string", "description": "New style text."}
+ ],
+ "description": "A descriptor of operation to mutate style declaration text."
+ },
+ {
+ "id": "InlineTextBox",
+ "type": "object",
+ "properties": [
+ { "name": "boundingBox", "$ref": "DOM.Rect", "description": "The absolute position bounding box." },
+ { "name": "startCharacterIndex", "type": "integer", "description": "The starting index in characters, for this post layout textbox substring." },
+ { "name": "numCharacters", "type": "integer", "description": "The number of characters in this post layout textbox substring." }
+ ],
+ "description": "Details of post layout rendered text positions. The exact layout should not be regarded as stable and may change between versions.",
+ "experimental": true
+ },
+ {
+ "id": "LayoutTreeNode",
+ "type": "object",
+ "properties": [
+ { "name": "nodeId", "$ref": "DOM.NodeId", "description": "The id of the related DOM node matching one from DOM.GetDocument." },
+ { "name": "boundingBox", "$ref": "DOM.Rect", "description": "The absolute position bounding box." },
+ { "name": "layoutText", "type": "string", "optional": true, "description": "Contents of the LayoutText if any" },
+ { "name": "inlineTextNodes", "type": "array", "optional": true, "items": { "$ref": "InlineTextBox" }, "description": "The post layout inline text nodes, if any." },
+ { "name": "styleIndex", "type": "integer", "optional": true, "description": "Index into the computedStyles array returned by getLayoutTreeAndStyles." }
+ ],
+ "description": "Details of an element in the DOM tree with a LayoutObject.",
+ "experimental": true
+ },
+ {
+ "id": "ComputedStyle",
+ "type": "object",
+ "properties": [
+ { "name": "properties", "type": "array", "items": { "$ref": "CSSComputedStyleProperty" } }
+ ],
+ "description": "A subset of the full ComputedStyle as defined by the request whitelist.",
+ "experimental": true
}
],
"commands": [
{
"name": "enable",
- "async": true,
"description": "Enables the CSS agent for the given page. Clients should not assume that the CSS agent has been enabled until the result of this command is received."
},
{
@@ -2968,14 +2978,15 @@
{
"name": "getMatchedStylesForNode",
"parameters": [
- { "name": "nodeId", "$ref": "DOM.NodeId" },
- { "name": "excludePseudo", "type": "boolean", "optional": true, "description": "Whether to exclude pseudo styles (default: false)." },
- { "name": "excludeInherited", "type": "boolean", "optional": true, "description": "Whether to exclude inherited styles (default: false)." }
+ { "name": "nodeId", "$ref": "DOM.NodeId" }
],
"returns": [
+ { "name": "inlineStyle", "$ref": "CSSStyle", "optional": true, "description": "Inline style for the specified DOM node." },
+ { "name": "attributesStyle", "$ref": "CSSStyle", "optional": true, "description": "Attribute-defined element style (e.g. resulting from \"width=20 height=100%\")."},
{ "name": "matchedCSSRules", "type": "array", "items": { "$ref": "RuleMatch" }, "optional": true, "description": "CSS rules matching this node, from all applicable stylesheets." },
- { "name": "pseudoElements", "type": "array", "items": { "$ref": "PseudoIdMatches" }, "optional": true, "description": "Pseudo style matches for this node." },
- { "name": "inherited", "type": "array", "items": { "$ref": "InheritedStyleEntry" }, "optional": true, "description": "A chain of inherited styles (from the immediate node parent up to the DOM tree root)." }
+ { "name": "pseudoElements", "type": "array", "items": { "$ref": "PseudoElementMatches" }, "optional": true, "description": "Pseudo style matches for this node." },
+ { "name": "inherited", "type": "array", "items": { "$ref": "InheritedStyleEntry" }, "optional": true, "description": "A chain of inherited styles (from the immediate node parent up to the DOM tree root)." },
+ { "name": "cssKeyframesRules", "type": "array", "items": { "$ref": "CSSKeyframesRule" }, "optional": true, "description": "A list of CSS keyframed animations matching this node." }
],
"description": "Returns requested styles for a DOM node identified by <code>nodeId</code>."
},
@@ -3006,11 +3017,10 @@
{ "name": "nodeId", "$ref": "DOM.NodeId" }
],
"returns": [
- { "name": "cssFamilyName", "type": "string", "description": "Font family name which is determined by computed style." },
{ "name": "fonts", "type": "array", "items": { "$ref": "PlatformFontUsage" }, "description": "Usage statistics for every employed platform font." }
],
"description": "Requests information about platform fonts which we used to render child TextNodes in the given node.",
- "hidden": true
+ "experimental": true
},
{
"name": "getStyleSheetText",
@@ -3023,24 +3033,26 @@
"description": "Returns the current textual content and the URL for a stylesheet."
},
{
- "name": "setStyleSheetText",
+ "name": "collectClassNames",
"parameters": [
- { "name": "styleSheetId", "$ref": "StyleSheetId" },
- { "name": "text", "type": "string" }
+ { "name": "styleSheetId", "$ref": "StyleSheetId" }
],
- "description": "Sets the new stylesheet text."
+ "returns": [
+ {"name": "classNames", "type": "array", "items": { "type": "string" }, "description": "Class name list." }
+ ],
+ "description": "Returns all class names from specified stylesheet.",
+ "experimental": true
},
{
- "name": "setPropertyText",
+ "name": "setStyleSheetText",
"parameters": [
{ "name": "styleSheetId", "$ref": "StyleSheetId" },
- { "name": "range", "$ref": "SourceRange", "description": "Either a source range of the property to be edited or an empty range representing a position for the property insertion." },
{ "name": "text", "type": "string" }
],
"returns": [
- { "name": "style", "$ref": "CSSStyle", "description": "The resulting style after the property text modification." }
+ { "name": "sourceMapURL", "type": "string", "optional": true, "description": "URL of source map associated with script (if any)." }
],
- "description": "Either replaces a property identified by <code>styleSheetId</code> and <code>range</code> with <code>text</code> or inserts a new property <code>text</code> at the position identified by an empty <code>range</code>."
+ "description": "Sets the new stylesheet text."
},
{
"name": "setRuleSelector",
@@ -3050,10 +3062,32 @@
{ "name": "selector", "type": "string" }
],
"returns": [
- { "name": "rule", "$ref": "CSSRule", "description": "The resulting rule after the selector modification." }
+ { "name": "selectorList", "$ref": "SelectorList", "description": "The resulting selector list after modification." }
],
"description": "Modifies the rule selector."
},
+ {
+ "name": "setKeyframeKey",
+ "parameters": [
+ { "name": "styleSheetId", "$ref": "StyleSheetId" },
+ { "name": "range", "$ref": "SourceRange" },
+ { "name": "keyText", "type": "string" }
+ ],
+ "returns": [
+ { "name": "keyText", "$ref": "Value", "description": "The resulting key text after modification." }
+ ],
+ "description": "Modifies the keyframe rule key text."
+ },
+ {
+ "name": "setStyleTexts",
+ "parameters": [
+ { "name": "edits", "type": "array", "items": { "$ref": "StyleDeclarationEdit" }}
+ ],
+ "returns": [
+ { "name": "styles", "type": "array", "items": { "$ref": "CSSStyle" }, "description": "The resulting styles after modification." }
+ ],
+ "description": "Applies specified style edits one after another in the given order."
+ },
{
"name": "setMediaText",
"parameters": [
@@ -3102,7 +3136,52 @@
{ "name": "medias", "type": "array", "items": { "$ref": "CSSMedia" } }
],
"description": "Returns all media queries parsed by the rendering engine.",
- "hidden": true
+ "experimental": true
+ },
+ {
+ "name": "setEffectivePropertyValueForNode",
+ "parameters": [
+ { "name": "nodeId", "$ref": "DOM.NodeId", "description": "The element id for which to set property." },
+ { "name": "propertyName", "type": "string"},
+ { "name": "value", "type": "string"}
+ ],
+ "description": "Find a rule with the given active property for the given node and set the new value for this property",
+ "experimental": true
+ },
+ {
+ "name": "getBackgroundColors",
+ "parameters": [
+ { "name": "nodeId", "$ref": "DOM.NodeId", "description": "Id of the node to get background colors for." }
+ ],
+ "returns": [
+ { "name": "backgroundColors", "type": "array", "items": { "type": "string" }, "description": "The range of background colors behind this element, 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 simply 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 be ignored (as if the image had failed to load).", "optional": true }
+ ],
+ "experimental": true
+ },
+ {
+ "name": "getLayoutTreeAndStyles",
+ "parameters": [
+ { "name": "computedStyleWhitelist", "type": "array", "items": { "type": "string" }, "description": "Whitelist of computed styles to return." }
+ ],
+ "returns": [
+ { "name": "layoutTreeNodes", "type": "array", "items": { "$ref": "LayoutTreeNode" } },
+ { "name": "computedStyles", "type": "array", "items": { "$ref": "ComputedStyle" } }
+ ],
+ "description": "For the main document and any content documents, return the LayoutTreeNodes and a whitelisted subset of the computed style. It only returns pushed nodes, on way to pull all nodes is to call DOM.getDocument with a depth of -1.",
+ "experimental": true
+ },
+ {
+ "name": "startRuleUsageTracking",
+ "description": "Enables the selector recording.",
+ "experimental": true
+ },
+ {
+ "name": "stopRuleUsageTracking",
+ "returns": [
+ { "name": "ruleUsage", "type": "array", "items": { "$ref": "RuleUsage" } }
+ ],
+ "description": "The list of rules with an indication of whether these were used",
+ "experimental": true
}
],
"events": [
@@ -3110,6 +3189,10 @@
"name": "mediaQueryResultChanged",
"description": "Fires whenever a MediaQuery result changes (for example, after a browser window has been resized.) The current implementation considers only viewport-dependent media features."
},
+ {
+ "name": "fontsUpdated",
+ "description": "Fires whenever a web font gets loaded."
+ },
{
"name": "styleSheetChanged",
"parameters": [
@@ -3134,979 +3217,332 @@
]
},
{
- "domain": "Timeline",
- "description": "Timeline domain is deprecated. Please use Tracing instead.",
+ "domain": "IO",
+ "description": "Input/Output operations for streams produced by DevTools.",
+ "experimental": true,
"types": [
{
- "id": "TimelineEvent",
- "type": "object",
- "properties": [
- { "name": "type", "type": "string", "description": "Event type." },
- { "name": "data", "type": "object", "description": "Event data." },
- { "name": "startTime", "type": "number", "description": "Start time." },
- { "name": "endTime", "type": "number", "optional": true, "description": "End time." },
- { "name": "children", "type": "array", "optional": true, "items": { "$ref": "TimelineEvent" }, "description": "Nested records." },
- { "name": "thread", "type": "string", "optional": true, "hidden": true, "description": "If present, identifies the thread that produced the event." },
- { "name": "stackTrace", "$ref": "Console.StackTrace", "optional": true, "hidden": true, "description": "Stack trace." },
- { "name": "frameId", "type": "string", "optional": true, "hidden": true, "description": "Unique identifier of the frame within the page that the event relates to." }
- ],
- "description": "Timeline record contains information about the recorded activity."
+ "id": "StreamHandle",
+ "type": "string"
}
],
"commands": [
{
- "name": "enable",
- "description": "Deprecated."
- },
- {
- "name": "disable",
- "description": "Deprecated."
- },
- {
- "name": "start",
+ "name": "read",
+ "description": "Read a chunk of the stream",
"parameters": [
- { "name": "maxCallStackDepth", "optional": true, "type": "integer", "description": "Samples JavaScript stack traces up to <code>maxCallStackDepth</code>, defaults to 5." },
- { "name": "bufferEvents", "optional": true, "type": "boolean", "hidden": true, "description": "Whether instrumentation events should be buffered and returned upon <code>stop</code> call." },
- { "name": "liveEvents", "optional": true, "type": "string", "hidden": true, "description": "Coma separated event types to issue although bufferEvents is set."},
- { "name": "includeCounters", "optional": true, "type": "boolean", "hidden": true, "description": "Whether counters data should be included into timeline events." },
- { "name": "includeGPUEvents", "optional": true, "type": "boolean", "hidden": true, "description": "Whether events from GPU process should be collected." }
+ { "name": "handle", "$ref": "StreamHandle", "description": "Handle of the stream to read." },
+ { "name": "offset", "type": "integer", "optional": true, "description": "Seek to the specified offset before reading (if not specificed, proceed with offset following the last read)." },
+ { "name": "size", "type": "integer", "optional": true, "description": "Maximum number of bytes to read (left upon the agent discretion if not specified)." }
],
- "description": "Deprecated."
+ "returns": [
+ { "name": "data", "type": "string", "description": "Data that were read." },
+ { "name": "eof", "type": "boolean", "description": "Set if the end-of-file condition occured while reading." }
+ ]
},
{
- "name": "stop",
- "description": "Deprecated."
- }
- ],
- "events": [
- {
- "name": "eventRecorded",
+ "name": "close",
+ "description": "Close the stream, discard any temporary backing storage.",
"parameters": [
- { "name": "record", "$ref": "TimelineEvent", "description": "Timeline event record data." }
- ],
- "description": "Deprecated."
+ { "name": "handle", "$ref": "StreamHandle", "description": "Handle of the stream to close." }
+ ]
}
]
},
{
- "domain": "Debugger",
- "description": "Debugger domain exposes JavaScript debugging capabilities. It allows setting and removing breakpoints, stepping through execution, exploring stack traces, etc.",
+ "domain": "DOMDebugger",
+ "description": "DOM debugging allows setting breakpoints on particular DOM operations and events. JavaScript execution will stop on these operations as if there was a regular breakpoint set.",
+ "dependencies": ["DOM", "Debugger"],
"types": [
{
- "id": "BreakpointId",
- "type": "string",
- "description": "Breakpoint identifier."
- },
- {
- "id": "ScriptId",
- "type": "string",
- "description": "Unique script identifier."
- },
- {
- "id": "CallFrameId",
+ "id": "DOMBreakpointType",
"type": "string",
- "description": "Call frame identifier."
+ "enum": ["subtree-modified", "attribute-modified", "node-removed"],
+ "description": "DOM breakpoint type."
},
{
- "id": "Location",
+ "id": "EventListener",
"type": "object",
+ "description": "Object event listener.",
"properties": [
- { "name": "scriptId", "$ref": "ScriptId", "description": "Script identifier as reported in the <code>Debugger.scriptParsed</code>." },
+ { "name": "type", "type": "string", "description": "<code>EventListener</code>'s type." },
+ { "name": "useCapture", "type": "boolean", "description": "<code>EventListener</code>'s useCapture." },
+ { "name": "passive", "type": "boolean", "description": "<code>EventListener</code>'s passive flag." },
+ { "name": "once", "type": "boolean", "description": "<code>EventListener</code>'s once flag." },
+ { "name": "scriptId", "$ref": "Runtime.ScriptId", "description": "Script id of the handler code." },
{ "name": "lineNumber", "type": "integer", "description": "Line number in the script (0-based)." },
- { "name": "columnNumber", "type": "integer", "optional": true, "description": "Column number in the script (0-based)." }
+ { "name": "columnNumber", "type": "integer", "description": "Column number in the script (0-based)." },
+ { "name": "handler", "$ref": "Runtime.RemoteObject", "optional": true, "description": "Event handler function value." },
+ { "name": "originalHandler", "$ref": "Runtime.RemoteObject", "optional": true, "description": "Event original handler function value." },
+ { "name": "backendNodeId", "$ref": "DOM.BackendNodeId", "optional": true, "description": "Node the listener is added to (if any)." }
+ ],
+ "experimental": true
+ }
+ ],
+ "commands": [
+ {
+ "name": "setDOMBreakpoint",
+ "parameters": [
+ { "name": "nodeId", "$ref": "DOM.NodeId", "description": "Identifier of the node to set breakpoint on." },
+ { "name": "type", "$ref": "DOMBreakpointType", "description": "Type of the operation to stop upon." }
],
- "description": "Location in the source code."
+ "description": "Sets breakpoint on particular operation with DOM."
},
{
- "id": "FunctionDetails",
- "hidden": true,
- "type": "object",
- "properties": [
- { "name": "location", "$ref": "Location", "optional": true, "description": "Location of the function, none for native functions." },
- { "name": "functionName", "type": "string", "description": "Name of the function." },
- { "name": "isGenerator", "type": "boolean", "description": "Whether this is a generator function." },
- { "name": "scopeChain", "type": "array", "optional": true, "items": { "$ref": "Scope" }, "description": "Scope chain for this closure." }
+ "name": "removeDOMBreakpoint",
+ "parameters": [
+ { "name": "nodeId", "$ref": "DOM.NodeId", "description": "Identifier of the node to remove breakpoint from." },
+ { "name": "type", "$ref": "DOMBreakpointType", "description": "Type of the breakpoint to remove." }
],
- "description": "Information about the function."
+ "description": "Removes DOM breakpoint that was set using <code>setDOMBreakpoint</code>."
},
{
- "id": "GeneratorObjectDetails",
- "hidden": true,
- "type": "object",
- "properties": [
- { "name": "function", "$ref": "Runtime.RemoteObject", "description": "Generator function." },
- { "name": "functionName", "type": "string", "description": "Name of the generator function." },
- { "name": "status", "type": "string", "enum": ["running", "suspended", "closed"], "description": "Current generator object status." },
- { "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." }
+ "name": "setEventListenerBreakpoint",
+ "parameters": [
+ { "name": "eventName", "type": "string", "description": "DOM Event name to stop on (any DOM event will do)." },
+ { "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.", "experimental": true }
],
- "description": "Information about the generator object."
+ "description": "Sets breakpoint on particular DOM event."
},
{
- "id": "CollectionEntry",
- "hidden": true,
- "type": "object",
- "properties": [
- { "name": "key", "$ref": "Runtime.RemoteObject", "optional": true, "description": "Entry key of a map-like collection, otherwise not provided." },
- { "name": "value", "$ref": "Runtime.RemoteObject", "description": "Entry value." }
+ "name": "removeEventListenerBreakpoint",
+ "parameters": [
+ { "name": "eventName", "type": "string", "description": "Event name." },
+ { "name": "targetName", "type": "string", "optional": true, "description": "EventTarget interface name.", "experimental": true }
],
- "description": "Collection entry."
+ "description": "Removes breakpoint on particular DOM event."
},
{
- "id": "CallFrame",
- "type": "object",
- "properties": [
- { "name": "callFrameId", "$ref": "CallFrameId", "description": "Call frame identifier. This identifier is only valid while the virtual machine is paused." },
- { "name": "functionName", "type": "string", "description": "Name of the JavaScript function called on this call frame." },
- { "name": "functionLocation", "$ref": "Location", "optional": true, "hidden": true, "description": "Location in the source code." },
- { "name": "location", "$ref": "Location", "description": "Location in the source code." },
- { "name": "scopeChain", "type": "array", "items": { "$ref": "Scope" }, "description": "Scope chain for this call frame." },
- { "name": "this", "$ref": "Runtime.RemoteObject", "description": "<code>this</code> object for this call frame." },
- { "name": "returnValue", "$ref": "Runtime.RemoteObject", "optional": true, "hidden": true, "description": "The value being returned, if the function is at return point." }
+ "name": "setInstrumentationBreakpoint",
+ "parameters": [
+ { "name": "eventName", "type": "string", "description": "Instrumentation name to stop on." }
],
- "description": "JavaScript call frame. Array of call frames form the call stack."
+ "description": "Sets breakpoint on particular native event.",
+ "experimental": true
},
{
- "id": "StackTrace",
- "type": "object",
- "properties": [
- { "name": "callFrames", "type": "array", "items": { "$ref": "CallFrame" }, "description": "Call frames of the stack trace." },
- { "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." },
- { "name": "asyncStackTrace", "$ref": "StackTrace", "optional": true, "description": "Async stack trace, if any." }
+ "name": "removeInstrumentationBreakpoint",
+ "parameters": [
+ { "name": "eventName", "type": "string", "description": "Instrumentation name to stop on." }
],
- "description": "JavaScript call stack, including async stack traces.",
- "hidden": true
+ "description": "Removes breakpoint on particular native event.",
+ "experimental": true
},
{
- "id": "Scope",
- "type": "object",
- "properties": [
- { "name": "type", "type": "string", "enum": ["global", "local", "with", "closure", "catch", "block", "script"], "description": "Scope type." },
- { "name": "object", "$ref": "Runtime.RemoteObject", "description": "Object representing the scope. For <code>global</code> and <code>with</code> scopes it represents the actual object; for the rest of the scopes, it is artificial transient object enumerating scope variables as its properties." }
+ "name": "setXHRBreakpoint",
+ "parameters": [
+ { "name": "url", "type": "string", "description": "Resource URL substring. All XHRs having this substring in the URL will get stopped upon." }
],
- "description": "Scope description."
+ "description": "Sets breakpoint on XMLHttpRequest."
},
{
- "id": "ExceptionDetails",
- "type": "object",
- "description": "Detailed information on exception (or error) that was thrown during script compilation or execution.",
- "properties": [
- { "name": "text", "type": "string", "description": "Exception text." },
- { "name": "url", "type": "string", "optional": true, "description": "URL of the message origin." },
- { "name": "scriptId", "type": "string", "optional": true, "description": "Script ID of the message origin." },
- { "name": "line", "type": "integer", "optional": true, "description": "Line number in the resource that generated this message." },
- { "name": "column", "type": "integer", "optional": true, "description": "Column number in the resource that generated this message." },
- { "name": "stackTrace", "$ref": "Console.StackTrace", "optional": true, "description": "JavaScript stack trace for assertions and error messages." }
- ]
- },
- {
- "id": "SetScriptSourceError",
- "type": "object",
- "properties": [
- { "name": "compileError", "optional": true, "type": "object", "properties":
- [
- { "name": "message", "type": "string", "description": "Compiler error message" },
- { "name": "lineNumber", "type": "integer", "description": "Compile error line number (1-based)" },
- { "name": "columnNumber", "type": "integer", "description": "Compile error column number (1-based)" }
- ]
- }
- ],
- "description": "Error data for setScriptSource command. compileError is a case type for uncompilable script source error.",
- "hidden": true
- },
- {
- "id": "PromiseDetails",
- "type": "object",
- "description": "Information about the promise.",
- "properties": [
- { "name": "id", "type": "integer", "description": "Unique id of the promise." },
- { "name": "status", "type": "string", "enum": ["pending", "resolved", "rejected"], "description": "Status of the promise." },
- { "name": "parentId", "type": "integer", "optional": true, "description": "Id of the parent promise." },
- { "name": "callFrame", "$ref": "Console.CallFrame", "optional": true, "description": "Top call frame on promise creation."},
- { "name": "creationTime", "type": "number", "optional": true, "description": "Creation time of the promise." },
- { "name": "settlementTime", "type": "number", "optional": true, "description": "Settlement time of the promise." },
- { "name": "creationStack", "$ref": "Console.StackTrace", "optional": true, "description": "JavaScript stack trace on promise creation." },
- { "name": "asyncCreationStack", "$ref": "Console.AsyncStackTrace", "optional": true, "description": "JavaScript asynchronous stack trace on promise creation, if available." },
- { "name": "settlementStack", "$ref": "Console.StackTrace", "optional": true, "description": "JavaScript stack trace on promise settlement." },
- { "name": "asyncSettlementStack", "$ref": "Console.AsyncStackTrace", "optional": true, "description": "JavaScript asynchronous stack trace on promise settlement, if available." }
- ],
- "hidden": true
- },
- {
- "id": "AsyncOperation",
- "type": "object",
- "description": "Information about the async operation.",
- "properties": [
- { "name": "id", "type": "integer", "description": "Unique id of the async operation." },
- { "name": "description", "type": "string", "description": "String description of the async operation." },
- { "name": "stackTrace", "$ref": "Console.StackTrace", "optional": true, "description": "Stack trace where async operation was scheduled." },
- { "name": "asyncStackTrace", "$ref": "Console.AsyncStackTrace", "optional": true, "description": "Asynchronous stack trace where async operation was scheduled, if available." }
- ],
- "hidden": true
- },
- {
- "id": "SearchMatch",
- "type": "object",
- "description": "Search match for resource.",
- "properties": [
- { "name": "lineNumber", "type": "number", "description": "Line number in resource content." },
- { "name": "lineContent", "type": "string", "description": "Line with match content." }
- ],
- "hidden": true
- }
- ],
- "commands": [
- {
- "name": "enable",
- "description": "Enables debugger for the given page. Clients should not assume that the debugging has been enabled until the result for this command is received."
- },
- {
- "name": "disable",
- "description": "Disables debugger for given page."
- },
- {
- "name": "setBreakpointsActive",
- "parameters": [
- { "name": "active", "type": "boolean", "description": "New value for breakpoints active state." }
- ],
- "description": "Activates / deactivates all breakpoints on the page."
- },
- {
- "name": "setSkipAllPauses",
- "hidden": true,
- "parameters": [
- { "name": "skipped", "type": "boolean", "description": "New value for skip pauses state." }
- ],
- "description": "Makes page not interrupt on any pauses (breakpoint, exception, dom exception etc)."
- },
- {
- "name": "setBreakpointByUrl",
- "parameters": [
- { "name": "lineNumber", "type": "integer", "description": "Line number to set breakpoint at." },
- { "name": "url", "type": "string", "optional": true, "description": "URL of the resources to set breakpoint on." },
- { "name": "urlRegex", "type": "string", "optional": true, "description": "Regex pattern for the URLs of the resources to set breakpoints on. Either <code>url</code> or <code>urlRegex</code> must be specified." },
- { "name": "columnNumber", "type": "integer", "optional": true, "description": "Offset in the line to set breakpoint at." },
- { "name": "condition", "type": "string", "optional": true, "description": "Expression to use as a breakpoint condition. When specified, debugger will only stop on the breakpoint if this expression evaluates to true." }
- ],
- "returns": [
- { "name": "breakpointId", "$ref": "BreakpointId", "description": "Id of the created breakpoint for further reference." },
- { "name": "locations", "type": "array", "items": { "$ref": "Location" }, "description": "List of the locations this breakpoint resolved into upon addition." }
- ],
- "description": "Sets JavaScript breakpoint at given location specified either by URL or URL regex. Once this command is issued, all existing parsed scripts will have breakpoints resolved and returned in <code>locations</code> property. Further matching script parsing will result in subsequent <code>breakpointResolved</code> events issued. This logical breakpoint will survive page reloads."
- },
- {
- "name": "setBreakpoint",
- "parameters": [
- { "name": "location", "$ref": "Location", "description": "Location to set breakpoint in." },
- { "name": "condition", "type": "string", "optional": true, "description": "Expression to use as a breakpoint condition. When specified, debugger will only stop on the breakpoint if this expression evaluates to true." }
- ],
- "returns": [
- { "name": "breakpointId", "$ref": "BreakpointId", "description": "Id of the created breakpoint for further reference." },
- { "name": "actualLocation", "$ref": "Location", "description": "Location this breakpoint resolved into." }
- ],
- "description": "Sets JavaScript breakpoint at a given location."
- },
- {
- "name": "removeBreakpoint",
- "parameters": [
- { "name": "breakpointId", "$ref": "BreakpointId" }
- ],
- "description": "Removes JavaScript breakpoint."
- },
- {
- "name": "continueToLocation",
- "parameters": [
- { "name": "location", "$ref": "Location", "description": "Location to continue to." },
- { "name": "interstatementLocation", "type": "boolean", "optional": true, "hidden": true, "description": "Allows breakpoints at the intemediate positions inside statements." }
- ],
- "description": "Continues execution until specific location is reached."
- },
- {
- "name": "stepOver",
- "description": "Steps over the statement."
- },
- {
- "name": "stepInto",
- "description": "Steps into the function call."
- },
- {
- "name": "stepOut",
- "description": "Steps out of the function call."
- },
- {
- "name": "pause",
- "description": "Stops on the next JavaScript statement."
- },
- {
- "name": "resume",
- "description": "Resumes JavaScript execution."
- },
- {
- "name": "stepIntoAsync",
- "description": "Steps into the first async operation handler that was scheduled by or after the current statement.",
- "hidden": true
- },
- {
- "name": "searchInContent",
- "parameters": [
- { "name": "scriptId", "$ref": "ScriptId", "description": "Id of the script to search in." },
- { "name": "query", "type": "string", "description": "String to search for." },
- { "name": "caseSensitive", "type": "boolean", "optional": true, "description": "If true, search is case sensitive." },
- { "name": "isRegex", "type": "boolean", "optional": true, "description": "If true, treats string parameter as regex." }
- ],
- "returns": [
- { "name": "result", "type": "array", "items": { "$ref": "SearchMatch" }, "description": "List of search matches." }
- ],
- "description": "Searches for given string in script content."
- },
- {
- "name": "canSetScriptSource",
- "returns": [
- { "name": "result", "type": "boolean", "description": "True if <code>setScriptSource</code> is supported." }
- ],
- "description": "Always returns true."
- },
- {
- "name": "setScriptSource",
- "parameters": [
- { "name": "scriptId", "$ref": "ScriptId", "description": "Id of the script to edit." },
- { "name": "scriptSource", "type": "string", "description": "New content of the script." },
- { "name": "preview", "type": "boolean", "optional": true, "description": " If true the change will not actually be applied. Preview mode may be used to get result description without actually modifying the code.", "hidden": true }
- ],
- "returns": [
- { "name": "callFrames", "type": "array", "optional": true, "items": { "$ref": "CallFrame" }, "description": "New stack trace in case editing has happened while VM was stopped." },
- { "name": "result", "type": "object", "optional": true, "description": "VM-specific description of the changes applied.", "hidden": true },
- { "name": "asyncStackTrace", "$ref": "StackTrace", "optional": true, "description": "Async stack trace, if any.", "hidden": true }
- ],
- "error": {
- "$ref": "SetScriptSourceError"
- },
- "description": "Edits JavaScript source live."
- },
- {
- "name": "restartFrame",
- "parameters": [
- { "name": "callFrameId", "$ref": "CallFrameId", "description": "Call frame identifier to evaluate on." }
- ],
- "returns": [
- { "name": "callFrames", "type": "array", "items": { "$ref": "CallFrame" }, "description": "New stack trace." },
- { "name": "result", "type": "object", "description": "VM-specific description." },
- { "name": "asyncStackTrace", "$ref": "StackTrace", "optional": true, "description": "Async stack trace, if any." }
- ],
- "hidden": true,
- "description": "Restarts particular call frame from the beginning."
- },
- {
- "name": "getScriptSource",
- "parameters": [
- { "name": "scriptId", "$ref": "ScriptId", "description": "Id of the script to get source for." }
- ],
- "returns": [
- { "name": "scriptSource", "type": "string", "description": "Script source." }
- ],
- "description": "Returns source for the script with given id."
- },
- {
- "name": "getFunctionDetails",
- "hidden": true,
- "parameters": [
- { "name": "functionId", "$ref": "Runtime.RemoteObjectId", "description": "Id of the function to get details for." }
- ],
- "returns": [
- { "name": "details", "$ref": "FunctionDetails", "description": "Information about the function." }
- ],
- "description": "Returns detailed information on given function."
- },
- {
- "name": "getGeneratorObjectDetails",
- "hidden": true,
- "parameters": [
- { "name": "objectId", "$ref": "Runtime.RemoteObjectId", "description": "Id of the generator object to get details for." }
- ],
- "returns": [
- { "name": "details", "$ref": "GeneratorObjectDetails", "description": "Information about the generator object." }
- ],
- "description": "Returns detailed information on given generator object."
- },
- {
- "name": "getCollectionEntries",
- "hidden": true,
- "parameters": [
- { "name": "objectId", "$ref": "Runtime.RemoteObjectId", "description": "Id of the collection to get entries for." }
- ],
- "returns": [
- { "name": "entries", "type": "array", "items": { "$ref": "CollectionEntry" }, "description": "Array of collection entries." }
- ],
- "description": "Returns entries of given collection."
- },
- {
- "name": "setPauseOnExceptions",
- "parameters": [
- { "name": "state", "type": "string", "enum": ["none", "uncaught", "all"], "description": "Pause on exceptions mode." }
- ],
- "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>."
- },
- {
- "name": "evaluateOnCallFrame",
- "parameters": [
- { "name": "callFrameId", "$ref": "CallFrameId", "description": "Call frame identifier to evaluate on." },
- { "name": "expression", "type": "string", "description": "Expression to evaluate." },
- { "name": "objectGroup", "type": "string", "optional": true, "description": "String object group name to put result into (allows rapid releasing resulting object handles using <code>releaseObjectGroup</code>)." },
- { "name": "includeCommandLineAPI", "type": "boolean", "optional": true, "description": "Specifies whether command line API should be available to the evaluated expression, defaults to false.", "hidden": true },
- { "name": "doNotPauseOnExceptionsAndMuteConsole", "type": "boolean", "optional": true, "description": "Specifies whether evaluation should stop on exceptions and mute console. Overrides setPauseOnException state.", "hidden": true },
- { "name": "returnByValue", "type": "boolean", "optional": true, "description": "Whether the result is expected to be a JSON object that should be sent by value." },
- { "name": "generatePreview", "type": "boolean", "optional": true, "hidden": true, "description": "Whether preview should be generated for the result." }
- ],
- "returns": [
- { "name": "result", "$ref": "Runtime.RemoteObject", "description": "Object wrapper for the evaluation result." },
- { "name": "wasThrown", "type": "boolean", "optional": true, "description": "True if the result was thrown during the evaluation." },
- { "name": "exceptionDetails", "$ref": "ExceptionDetails", "optional": true, "hidden": true, "description": "Exception details."}
- ],
- "description": "Evaluates expression on a given call frame."
- },
- {
- "name": "compileScript",
- "hidden": true,
- "parameters": [
- { "name": "expression", "type": "string", "description": "Expression to compile." },
- { "name": "sourceURL", "type": "string", "description": "Source url to be set for the script." },
- { "name": "persistScript", "type": "boolean", "description": "Specifies whether the compiled script should be persisted." },
- { "name": "executionContextId", "$ref": "Runtime.ExecutionContextId", "optional": true, "description": "Specifies in which isolated context to perform script run. Each content script lives in an isolated context and this parameter may be used to specify one of those contexts. If the parameter is omitted or 0 the evaluation will be performed in the context of the inspected page." }
- ],
- "returns": [
- { "name": "scriptId", "$ref": "ScriptId", "optional": true, "description": "Id of the script." },
- { "name": "exceptionDetails", "$ref": "ExceptionDetails", "optional": true, "description": "Exception details."}
- ],
- "description": "Compiles expression."
- },
- {
- "name": "runScript",
- "hidden": true,
- "parameters": [
- { "name": "scriptId", "$ref": "ScriptId", "description": "Id of the script to run." },
- { "name": "executionContextId", "$ref": "Runtime.ExecutionContextId", "optional": true, "description": "Specifies in which isolated context to perform script run. Each content script lives in an isolated context and this parameter may be used to specify one of those contexts. If the parameter is omitted or 0 the evaluation will be performed in the context of the inspected page." },
- { "name": "objectGroup", "type": "string", "optional": true, "description": "Symbolic group name that can be used to release multiple objects." },
- { "name": "doNotPauseOnExceptionsAndMuteConsole", "type": "boolean", "optional": true, "description": "Specifies whether script run should stop on exceptions and mute console. Overrides setPauseOnException state." }
- ],
- "returns": [
- { "name": "result", "$ref": "Runtime.RemoteObject", "description": "Run result." },
- { "name": "exceptionDetails", "$ref": "ExceptionDetails", "optional": true, "description": "Exception details."}
- ],
- "description": "Runs script with given id in a given context."
- },
- {
- "name": "setVariableValue",
- "parameters": [
- { "name": "scopeNumber", "type": "integer", "description": "0-based number of scope as was listed in scope chain. Only 'local', 'closure' and 'catch' scope types are allowed. Other scopes could be manipulated manually." },
- { "name": "variableName", "type": "string", "description": "Variable name." },
- { "name": "newValue", "$ref": "Runtime.CallArgument", "description": "New variable value." },
- { "name": "callFrameId", "$ref": "CallFrameId", "optional": true, "description": "Id of callframe that holds variable." },
- { "name": "functionObjectId", "$ref": "Runtime.RemoteObjectId", "optional": true, "description": "Object id of closure (function) that holds variable." }
- ],
- "hidden": true,
- "description": "Changes value of variable in a callframe or a closure. Either callframe or function must be specified. Object-based scopes are not supported and must be mutated manually."
- },
- {
- "name": "getStepInPositions",
- "parameters": [
- { "name": "callFrameId", "$ref": "CallFrameId", "description": "Id of a call frame where the current statement should be analized" }
- ],
- "returns": [
- { "name": "stepInPositions", "type": "array", "items": { "$ref": "Location" }, "optional": true, "description": "experimental" }
- ],
- "hidden": true,
- "description": "Lists all positions where step-in is possible for a current statement in a specified call frame"
- },
- {
- "name": "getBacktrace",
- "returns": [
- { "name": "callFrames", "type": "array", "items": { "$ref": "CallFrame" }, "description": "Call stack the virtual machine stopped on." },
- { "name": "asyncStackTrace", "$ref": "StackTrace", "optional": true, "description": "Async stack trace, if any." }
- ],
- "hidden": true,
- "description": "Returns call stack including variables changed since VM was paused. VM must be paused."
- },
- {
- "name": "skipStackFrames",
- "parameters": [
- { "name": "script", "type": "string", "optional": true, "description": "Regular expression defining the scripts to ignore while stepping." },
- { "name": "skipContentScripts", "type": "boolean", "optional": true, "description": "True, if all content scripts should be ignored." }
- ],
- "hidden": true,
- "description": "Makes backend skip steps in the sources with names matching given pattern. VM will try leave blacklisted scripts by performing 'step in' several times, finally resorting to 'step out' if unsuccessful."
- },
- {
- "name": "setAsyncCallStackDepth",
- "parameters": [
- { "name": "maxDepth", "type": "integer", "description": "Maximum depth of async call stacks. Setting to <code>0</code> will effectively disable collecting async call stacks (default)." }
- ],
- "hidden": true,
- "description": "Enables or disables async call stacks tracking."
- },
- {
- "name": "enablePromiseTracker",
- "parameters": [
- { "name": "captureStacks", "type": "boolean", "optional": true, "description": "Whether to capture stack traces for promise creation and settlement events (default: false)." }
- ],
- "hidden": true,
- "description": "Enables promise tracking, information about <code>Promise</code>s created or updated will now be stored on the backend."
- },
- {
- "name": "disablePromiseTracker",
- "hidden": true,
- "description": "Disables promise tracking."
- },
- {
- "name": "getPromises",
- "returns": [
- { "name": "promises", "type": "array", "items": { "$ref": "PromiseDetails" }, "description": "Information about stored promises." }
- ],
- "hidden": true,
- "description": "Returns detailed information about all <code>Promise</code>s that were created or updated after the <code>enablePromiseTracker</code> command, and have not been garbage collected yet."
- },
- {
- "name": "getPromiseById",
- "parameters": [
- { "name": "promiseId", "type": "integer" },
- { "name": "objectGroup", "type": "string", "optional": true, "description": "Symbolic group name that can be used to release multiple objects." }
- ],
- "returns": [
- { "name": "promise", "$ref": "Runtime.RemoteObject", "description": "Object wrapper for <code>Promise</code> with specified ID, if any." }
- ],
- "hidden": true,
- "description": "Returns <code>Promise</code> with specified ID."
- },
- {
- "name": "flushAsyncOperationEvents",
- "hidden": true,
- "description": "Fires pending <code>asyncOperationStarted</code> events (if any), as if a debugger stepping session has just been started."
- },
- {
- "name": "setAsyncOperationBreakpoint",
- "parameters": [
- { "name": "operationId", "type": "integer", "description": "ID of the async operation to set breakpoint for." }
- ],
- "hidden": true,
- "description": "Sets breakpoint on AsyncOperation callback handler."
- },
- {
- "name": "removeAsyncOperationBreakpoint",
- "parameters": [
- { "name": "operationId", "type": "integer", "description": "ID of the async operation to remove breakpoint for." }
- ],
- "hidden": true,
- "description": "Removes AsyncOperation breakpoint."
- }
- ],
- "events": [
- {
- "name": "globalObjectCleared",
- "description": "Called when global has been cleared and debugger client should reset its state. Happens upon navigation or reload."
- },
- {
- "name": "scriptParsed",
- "parameters": [
- { "name": "scriptId", "$ref": "ScriptId", "description": "Identifier of the script parsed." },
- { "name": "url", "type": "string", "description": "URL or name of the script parsed (if any)." },
- { "name": "startLine", "type": "integer", "description": "Line offset of the script within the resource with given URL (for script tags)." },
- { "name": "startColumn", "type": "integer", "description": "Column offset of the script within the resource with given URL." },
- { "name": "endLine", "type": "integer", "description": "Last line of the script." },
- { "name": "endColumn", "type": "integer", "description": "Length of the last line of the script." },
- { "name": "isContentScript", "type": "boolean", "optional": true, "description": "Determines whether this script is a user extension script." },
- { "name": "isInternalScript", "type": "boolean", "optional": true, "description": "Determines whether this script is an internal script.", "hidden": true },
- { "name": "sourceMapURL", "type": "string", "optional": true, "description": "URL of source map associated with script (if any)." },
- { "name": "hasSourceURL", "type": "boolean", "optional": true, "description": "True, if this script has sourceURL.", "hidden": true }
- ],
- "description": "Fired when virtual machine parses script. This event is also fired for all known and uncollected scripts upon enabling debugger."
- },
- {
- "name": "scriptFailedToParse",
- "parameters": [
- { "name": "scriptId", "$ref": "ScriptId", "description": "Identifier of the script parsed." },
- { "name": "url", "type": "string", "description": "URL or name of the script parsed (if any)." },
- { "name": "startLine", "type": "integer", "description": "Line offset of the script within the resource with given URL (for script tags)." },
- { "name": "startColumn", "type": "integer", "description": "Column offset of the script within the resource with given URL." },
- { "name": "endLine", "type": "integer", "description": "Last line of the script." },
- { "name": "endColumn", "type": "integer", "description": "Length of the last line of the script." },
- { "name": "isContentScript", "type": "boolean", "optional": true, "description": "Determines whether this script is a user extension script." },
- { "name": "isInternalScript", "type": "boolean", "optional": true, "description": "Determines whether this script is an internal script.", "hidden": true },
- { "name": "sourceMapURL", "type": "string", "optional": true, "description": "URL of source map associated with script (if any)." },
- { "name": "hasSourceURL", "type": "boolean", "optional": true, "description": "True, if this script has sourceURL.", "hidden": true }
- ],
- "description": "Fired when virtual machine fails to parse the script."
- },
- {
- "name": "breakpointResolved",
- "parameters": [
- { "name": "breakpointId", "$ref": "BreakpointId", "description": "Breakpoint unique identifier." },
- { "name": "location", "$ref": "Location", "description": "Actual breakpoint location." }
- ],
- "description": "Fired when breakpoint is resolved to an actual script and location."
- },
- {
- "name": "paused",
- "parameters": [
- { "name": "callFrames", "type": "array", "items": { "$ref": "CallFrame" }, "description": "Call stack the virtual machine stopped on." },
- { "name": "reason", "type": "string", "enum": [ "XHR", "DOM", "EventListener", "exception", "assert", "CSPViolation", "debugCommand", "promiseRejection", "AsyncOperation", "other" ], "description": "Pause reason." },
- { "name": "data", "type": "object", "optional": true, "description": "Object containing break-specific auxiliary properties." },
- { "name": "hitBreakpoints", "type": "array", "optional": true, "items": { "type": "string" }, "description": "Hit breakpoints IDs", "hidden": true },
- { "name": "asyncStackTrace", "$ref": "StackTrace", "optional": true, "description": "Async stack trace, if any.", "hidden": true }
- ],
- "description": "Fired when the virtual machine stopped on breakpoint or exception or any other stop criteria."
- },
- {
- "name": "resumed",
- "description": "Fired when the virtual machine resumed execution."
- },
- {
- "name": "promiseUpdated",
- "parameters": [
- { "name": "eventType", "type": "string", "enum": ["new", "update", "gc"], "description": "Type of the event." },
- { "name": "promise", "$ref": "PromiseDetails", "description": "Information about the updated <code>Promise</code>." }
- ],
- "description": "Fired when a <code>Promise</code> is created, updated or garbage collected.",
- "hidden": true
- },
- {
- "name": "asyncOperationStarted",
- "parameters": [
- { "name": "operation", "$ref": "AsyncOperation", "description": "Information about the async operation." }
- ],
- "description": "Fired when an async operation is scheduled (while in a debugger stepping session).",
- "hidden": true
- },
- {
- "name": "asyncOperationCompleted",
- "parameters": [
- { "name": "id", "type": "integer", "description": "ID of the async operation that was completed." }
- ],
- "description": "Fired when an async operation is completed (while in a debugger stepping session).",
- "hidden": true
- }
- ]
- },
- {
- "domain": "DOMDebugger",
- "description": "DOM debugging allows setting breakpoints on particular DOM operations and events. JavaScript execution will stop on these operations as if there was a regular breakpoint set.",
- "types": [
- {
- "id": "DOMBreakpointType",
- "type": "string",
- "enum": ["subtree-modified", "attribute-modified", "node-removed"],
- "description": "DOM breakpoint type."
- }
- ],
- "commands": [
- {
- "name": "setDOMBreakpoint",
- "parameters": [
- { "name": "nodeId", "$ref": "DOM.NodeId", "description": "Identifier of the node to set breakpoint on." },
- { "name": "type", "$ref": "DOMBreakpointType", "description": "Type of the operation to stop upon." }
- ],
- "description": "Sets breakpoint on particular operation with DOM."
- },
- {
- "name": "removeDOMBreakpoint",
- "parameters": [
- { "name": "nodeId", "$ref": "DOM.NodeId", "description": "Identifier of the node to remove breakpoint from." },
- { "name": "type", "$ref": "DOMBreakpointType", "description": "Type of the breakpoint to remove." }
- ],
- "description": "Removes DOM breakpoint that was set using <code>setDOMBreakpoint</code>."
- },
- {
- "name": "setEventListenerBreakpoint",
- "parameters": [
- { "name": "eventName", "type": "string", "description": "DOM Event name to stop on (any DOM event will do)." },
- { "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 }
- ],
- "description": "Sets breakpoint on particular DOM event."
- },
- {
- "name": "removeEventListenerBreakpoint",
- "parameters": [
- { "name": "eventName", "type": "string", "description": "Event name." },
- { "name": "targetName", "type": "string", "optional": true, "description": "EventTarget interface name.", "hidden": true }
- ],
- "description": "Removes breakpoint on particular DOM event."
- },
- {
- "name": "setInstrumentationBreakpoint",
- "parameters": [
- { "name": "eventName", "type": "string", "description": "Instrumentation name to stop on." }
- ],
- "description": "Sets breakpoint on particular native event.",
- "hidden": true
- },
- {
- "name": "removeInstrumentationBreakpoint",
+ "name": "removeXHRBreakpoint",
"parameters": [
- { "name": "eventName", "type": "string", "description": "Instrumentation name to stop on." }
+ { "name": "url", "type": "string", "description": "Resource URL substring." }
],
- "description": "Removes breakpoint on particular native event.",
- "hidden": true
+ "description": "Removes breakpoint from XMLHttpRequest."
},
{
- "name": "setXHRBreakpoint",
+ "name": "getEventListeners",
+ "experimental": true,
"parameters": [
- { "name": "url", "type": "string", "description": "Resource URL substring. All XHRs having this substring in the URL will get stopped upon." }
+ { "name": "objectId", "$ref": "Runtime.RemoteObjectId", "description": "Identifier of the object to return listeners for." },
+ { "name": "depth", "type": "integer", "optional": true, "description": "The maximum depth at which Node children should be retrieved, defaults to 1. Use -1 for the entire subtree or provide an integer larger than 0.", "experimental": true },
+ { "name": "pierce", "type": "boolean", "optional": true, "description": "Whether or not iframes and shadow roots should be traversed when returning the subtree (default is false). Reports listeners for all contexts if pierce is enabled.", "experimental": true }
],
- "description": "Sets breakpoint on XMLHttpRequest."
- },
- {
- "name": "removeXHRBreakpoint",
- "parameters": [
- { "name": "url", "type": "string", "description": "Resource URL substring." }
+ "returns": [
+ { "name": "listeners", "type": "array", "items": { "$ref": "EventListener" }, "description": "Array of relevant listeners." }
],
- "description": "Removes breakpoint from XMLHttpRequest."
+ "description": "Returns event listeners of the given object."
}
]
},
{
- "domain": "Profiler",
- "hidden": true,
+ "domain": "Target",
+ "description": "Supports additional targets discovery and allows to attach to them.",
+ "experimental": true,
"types": [
{
- "id": "CPUProfileNode",
- "type": "object",
- "description": "CPU Profile node. Holds callsite information, execution statistics and child nodes.",
- "properties": [
- { "name": "functionName", "type": "string", "description": "Function name." },
- { "name": "scriptId", "$ref": "Debugger.ScriptId", "description": "Script identifier." },
- { "name": "url", "type": "string", "description": "URL." },
- { "name": "lineNumber", "type": "integer", "description": "1-based line number of the function start position." },
- { "name": "columnNumber", "type": "integer", "description": "1-based column number of the function start position." },
- { "name": "hitCount", "type": "integer", "description": "Number of samples where this node was on top of the call stack." },
- { "name": "callUID", "type": "number", "description": "Call UID." },
- { "name": "children", "type": "array", "items": { "$ref": "CPUProfileNode" }, "description": "Child nodes." },
- { "name": "deoptReason", "type": "string", "description": "The reason of being not optimized. The function may be deoptimized or marked as don't optimize."},
- { "name": "id", "type": "integer", "description": "Unique id of the node." },
- { "name": "positionTicks", "type": "array", "items": { "$ref": "PositionTickInfo" }, "description": "An array of source position ticks." }
- ]
+ "id": "TargetID",
+ "type": "string"
+ },
+ {
+ "id": "BrowserContextID",
+ "type": "string"
},
{
- "id": "CPUProfile",
+ "id": "TargetInfo",
"type": "object",
- "description": "Profile.",
"properties": [
- { "name": "head", "$ref": "CPUProfileNode" },
- { "name": "startTime", "type": "number", "description": "Profiling start time in seconds." },
- { "name": "endTime", "type": "number", "description": "Profiling end time in seconds." },
- { "name": "samples", "optional": true, "type": "array", "items": { "type": "integer" }, "description": "Ids of samples top nodes." },
- { "name": "timestamps", "optional": true, "type": "array", "items": { "type": "number" }, "description": "Timestamps of the samples in microseconds." }
+ { "name": "targetId", "$ref": "TargetID" },
+ { "name": "type", "type": "string" },
+ { "name": "title", "type": "string" },
+ { "name": "url", "type": "string" }
]
},
{
- "id": "PositionTickInfo",
+ "id": "RemoteLocation",
"type": "object",
- "description": "Specifies a number of samples attributed to a certain source position.",
"properties": [
- { "name": "line", "type": "integer", "description": "Source line number (1-based)." },
- { "name": "ticks", "type": "integer", "description": "Number of samples attributed to the source line." }
+ { "name": "host", "type": "string" },
+ { "name": "port", "type": "integer" }
]
}
],
"commands": [
{
- "name": "enable"
- },
- {
- "name": "disable"
- },
- {
- "name": "setSamplingInterval",
+ "name": "setDiscoverTargets",
+ "description": "Controls whether to discover available targets and notify via <code>targetCreated/targetDestroyed</code> events.",
"parameters": [
- { "name": "interval", "type": "integer", "description": "New sampling interval in microseconds." }
- ],
- "description": "Changes CPU profiler sampling interval. Must be called before CPU profiles recording started."
- },
- {
- "name": "start"
- },
- {
- "name": "stop",
- "returns": [
- { "name": "profile", "$ref": "CPUProfile", "description": "Recorded profile." }
+ { "name": "discover", "type": "boolean", "description": "Whether to discover available targets." }
]
- }
- ],
- "events": [
- {
- "name": "consoleProfileStarted",
- "parameters": [
- { "name": "id", "type": "string" },
- { "name": "location", "$ref": "Debugger.Location", "description": "Location of console.profile()." },
- { "name": "title", "type": "string", "optional": true, "description": "Profile title passed as argument to console.profile()." }
-
- ],
- "description": "Sent when new profile recodring is started using console.profile() call."
},
{
- "name": "consoleProfileFinished",
+ "name": "setAutoAttach",
+ "description": "Controls whether to automatically attach to new targets which are considered to be related to this one. When turned on, attaches to all existing related targets as well. When turned off, automatically detaches from all currently attached targets.",
"parameters": [
- { "name": "id", "type": "string" },
- { "name": "location", "$ref": "Debugger.Location", "description": "Location of console.profileEnd()." },
- { "name": "profile", "$ref": "CPUProfile" },
- { "name": "title", "type": "string", "optional": true, "description": "Profile title passed as argunet to console.profile()." }
+ { "name": "autoAttach", "type": "boolean", "description": "Whether to auto-attach to related targets." },
+ { "name": "waitForDebuggerOnStart", "type": "boolean", "description": "Whether to pause new targets when attaching to them. Use <code>Runtime.runIfWaitingForDebugger</code> to run paused targets." }
]
- }
- ]
- },
- {
- "domain": "HeapProfiler",
- "hidden": true,
- "types": [
- {
- "id": "HeapSnapshotObjectId",
- "type": "string",
- "description": "Heap snapshot object id."
- }
- ],
- "commands": [
- {
- "name": "enable"
- },
- {
- "name": "disable"
},
{
- "name": "startTrackingHeapObjects",
+ "name": "setAttachToFrames",
"parameters": [
- { "name": "trackAllocations", "type": "boolean", "optional": true }
+ { "name": "value", "type": "boolean", "description": "Whether to attach to frames." }
]
},
{
- "name": "stopTrackingHeapObjects",
+ "name": "setRemoteLocations",
+ "description": "Enables target discovery for the specified locations, when <code>setDiscoverTargets</code> was set to <code>true</code>.",
"parameters": [
- { "name": "reportProgress", "type": "boolean", "optional": true, "description": "If true 'reportHeapSnapshotProgress' events will be generated while snapshot is being taken when the tracking is stopped." }
+ { "name": "locations", "type": "array", "items": { "$ref": "RemoteLocation" }, "description": "List of remote locations." }
]
-
},
{
- "name": "takeHeapSnapshot",
+ "name": "sendMessageToTarget",
+ "description": "Sends protocol message to the target with given id.",
"parameters": [
- { "name": "reportProgress", "type": "boolean", "optional": true, "description": "If true 'reportHeapSnapshotProgress' events will be generated while snapshot is being taken." }
+ { "name": "targetId", "type": "string" },
+ { "name": "message", "type": "string" }
]
},
{
- "name": "collectGarbage"
- },
- {
- "name": "getObjectByHeapObjectId",
+ "name": "getTargetInfo",
+ "description": "Returns information about a target.",
"parameters": [
- { "name": "objectId", "$ref": "HeapSnapshotObjectId" },
- { "name": "objectGroup", "type": "string", "optional": true, "description": "Symbolic group name that can be used to release multiple objects." }
+ { "name": "targetId", "$ref": "TargetID" }
],
"returns": [
- { "name": "result", "$ref": "Runtime.RemoteObject", "description": "Evaluation result." }
+ { "name": "targetInfo","$ref": "TargetInfo" }
]
},
{
- "name": "addInspectedHeapObject",
+ "name": "activateTarget",
+ "description": "Activates (focuses) the target.",
"parameters": [
- { "name": "heapObjectId", "$ref": "HeapSnapshotObjectId", "description": "Heap snapshot object id to be accessible by means of $x command line API." }
- ],
- "description": "Enables console to refer to the node with given id via $x (see Command Line API for more details $x functions)."
+ { "name": "targetId", "$ref": "TargetID" }
+ ]
},
{
- "name": "getHeapObjectId",
+ "name": "closeTarget",
+ "description": "Closes the target. If the target is a page that gets closed too.",
"parameters": [
- { "name": "objectId", "$ref": "Runtime.RemoteObjectId", "description": "Identifier of the object to get heap object id for." }
+ { "name": "targetId", "$ref": "TargetID" }
],
"returns": [
- { "name": "heapSnapshotObjectId", "$ref": "HeapSnapshotObjectId", "description": "Id of the heap snapshot object corresponding to the passed remote object id." }
+ { "name": "success", "type": "boolean" }
]
- }
- ],
- "events": [
+ },
{
- "name": "addHeapSnapshotChunk",
+ "name": "attachToTarget",
+ "description": "Attaches to the target with given id.",
"parameters": [
- { "name": "chunk", "type": "string" }
+ { "name": "targetId", "$ref": "TargetID" }
+ ],
+ "returns": [
+ { "name": "success", "type": "boolean", "description": "Whether attach succeeded." }
]
},
{
- "name": "resetProfiles"
- },
- {
- "name": "reportHeapSnapshotProgress",
+ "name": "detachFromTarget",
+ "description": "Detaches from the target with given id.",
"parameters": [
- { "name": "done", "type": "integer" },
- { "name": "total", "type": "integer" },
- { "name": "finished", "type": "boolean", "optional": true }
+ { "name": "targetId", "$ref": "TargetID" }
]
},
{
- "name": "lastSeenObjectId",
- "description": "If heap objects tracking has been started then backend regulary sends a current value for last seen object id and corresponding timestamp. If the were changes in the heap since last event then one or more heapStatsUpdate events will be sent before a new lastSeenObjectId event.",
- "parameters": [
- { "name": "lastSeenObjectId", "type": "integer" },
- { "name": "timestamp", "type": "number" }
+ "name": "createBrowserContext",
+ "description": "Creates a new empty BrowserContext. Similar to an incognito profile but you can have more than one.",
+ "returns": [
+ { "name": "browserContextId", "$ref": "BrowserContextID", "description": "The id of the context created." }
]
},
{
- "name": "heapStatsUpdate",
- "description": "If heap objects tracking has been started then backend may send update for one or more fragments",
+ "name": "disposeBrowserContext",
+ "description": "Deletes a BrowserContext, will fail of any open page uses it.",
"parameters": [
- { "name": "statsUpdate", "type": "array", "items": { "type": "integer" }, "description": "An array of triplets. Each triplet describes a fragment. The first integer is the fragment index, the second integer is a total count of objects for the fragment, the third integer is a total size of the objects for the fragment."}
+ { "name": "browserContextId", "$ref": "BrowserContextID" }
+ ],
+ "returns": [
+ { "name": "success", "type": "boolean" }
]
- }
- ]
- },
- {
- "domain": "Worker",
- "hidden": true,
- "types": [],
- "commands": [
- {
- "name": "enable"
- },
- {
- "name": "disable"
},
{
- "name": "sendMessageToWorker",
+ "name": "createTarget",
+ "description": "Creates a new page.",
"parameters": [
- { "name": "workerId", "type": "string" },
- { "name": "message", "type": "string" }
+ { "name": "url", "type": "string", "description": "The initial URL the page will be navigated to." },
+ { "name": "width", "type": "integer", "description": "Frame width in DIP (headless chrome only).", "optional": true },
+ { "name": "height", "type": "integer", "description": "Frame height in DIP (headless chrome only).", "optional": true },
+ { "name": "browserContextId", "$ref": "BrowserContextID", "description": "The browser context to create the page in (headless chrome only).", "optional": true }
+ ],
+ "returns": [
+ { "name": "targetId", "$ref": "TargetID", "description": "The id of the page opened." }
]
},
{
- "name": "connectToWorker",
- "parameters": [
- { "name": "workerId", "type": "string" }
+ "name": "getTargets",
+ "description": "Retrieves a list of available targets.",
+ "returns": [
+ { "name": "targetInfos", "type": "array", "items": { "$ref": "TargetInfo" }, "description": "The list of targets." }
]
- },
+ }
+ ],
+ "events": [
{
- "name": "disconnectFromWorker",
+ "name": "targetCreated",
+ "description": "Issued when a possible inspection target is created.",
"parameters": [
- { "name": "workerId", "type": "string" }
+ { "name": "targetInfo", "$ref": "TargetInfo" }
]
},
{
- "name": "setAutoconnectToWorkers",
+ "name": "targetDestroyed",
+ "description": "Issued when a target is destroyed.",
"parameters": [
- { "name": "value", "type": "boolean" }
+ { "name": "targetId", "$ref": "TargetID" }
]
- }
- ],
- "events": [
+ },
{
- "name": "workerCreated",
+ "name": "attachedToTarget",
+ "description": "Issued when attached to target because of auto-attach or <code>attachToTarget</code> command.",
"parameters": [
- { "name": "workerId", "type": "string" },
- { "name": "url", "type": "string" },
- { "name": "inspectorConnected", "type": "boolean" }
+ { "name": "targetInfo", "$ref": "TargetInfo" },
+ { "name": "waitingForDebugger", "type": "boolean" }
]
},
{
- "name": "workerTerminated",
+ "name": "detachedFromTarget",
+ "description": "Issued when detached from target for any reason (including <code>detachFromTarget</code> command).",
"parameters": [
- { "name": "workerId", "type": "string" }
+ { "name": "targetId", "$ref": "TargetID" }
]
},
{
- "name": "dispatchMessageFromWorker",
+ "name": "receivedMessageFromTarget",
+ "description": "Notifies about new protocol message from attached target.",
"parameters": [
- { "name": "workerId", "type": "string" },
+ { "name": "targetId", "$ref": "TargetID" },
{ "name": "message", "type": "string" }
]
}
@@ -4114,7 +3550,7 @@
},
{
"domain": "ServiceWorker",
- "hidden": true,
+ "experimental": true,
"types": [
{
"id": "ServiceWorkerRegistration",
@@ -4123,7 +3559,7 @@
"properties": [
{ "name": "registrationId", "type": "string" },
{ "name": "scopeURL", "type": "string" },
- { "name": "isDeleted", "type": "boolean", "optional": true }
+ { "name": "isDeleted", "type": "boolean" }
]
},
{
@@ -4133,356 +3569,124 @@
},
{
"id": "ServiceWorkerVersionStatus",
- "type": "string",
- "enum": ["new", "installing", "installed", "activating", "activated", "redundant"]
- },
- {
- "id": "ServiceWorkerVersion",
- "type": "object",
- "description": "ServiceWorker version.",
- "properties": [
- { "name": "versionId", "type": "string" },
- { "name": "registrationId", "type": "string" },
- { "name": "scriptURL", "type": "string" },
- { "name": "runningStatus", "$ref": "ServiceWorkerVersionRunningStatus" },
- { "name": "status", "$ref": "ServiceWorkerVersionStatus" },
- { "name": "scriptLastModified", "type": "number", "optional": true, "description": "The Last-Modified header value of the main script." },
- { "name": "scriptResponseTime", "type": "number", "optional": true, "description": "The time at which the response headers of the main script were received from the server. For cached script it is the last time the cache entry was validated." }
- ]
- },
- {
- "id": "ServiceWorkerErrorMessage",
- "type": "object",
- "description": "ServiceWorker error message.",
- "properties": [
- { "name": "errorMessage", "type": "string" },
- { "name": "registrationId", "type": "string" },
- { "name": "versionId", "type": "string" },
- { "name": "sourceURL", "type": "string" },
- { "name": "lineNumber", "type": "integer" },
- { "name": "columnNumber", "type": "integer" }
- ]
- }
- ],
- "commands": [
- {
- "name": "enable",
- "handlers": ["browser"]
- },
- {
- "name": "disable",
- "handlers": ["browser"]
- },
- {
- "name": "sendMessage",
- "parameters": [
- { "name": "workerId", "type": "string" },
- { "name": "message", "type": "string" }
- ],
- "handlers": ["browser"]
- },
- {
- "name": "stop",
- "parameters": [
- { "name": "workerId", "type": "string" }
- ],
- "handlers": ["browser"]
- },
- {
- "name": "unregister",
- "parameters": [
- { "name": "scopeURL", "type": "string" }
- ],
- "handlers": ["browser"]
- },
- {
- "name": "updateRegistration",
- "parameters": [
- { "name": "scopeURL", "type": "string" }
- ],
- "handlers": ["browser"]
- },
- {
- "name": "startWorker",
- "parameters": [
- { "name": "scopeURL", "type": "string" }
- ],
- "handlers": ["browser"]
- },
- {
- "name": "stopWorker",
- "parameters": [
- { "name": "versionId", "type": "string" }
- ],
- "handlers": ["browser"]
- },
- {
- "name": "inspectWorker",
- "parameters": [
- { "name": "versionId", "type": "string" }
- ],
- "handlers": ["browser"]
- },
- {
- "name": "setDebugOnStart",
- "parameters": [
- { "name": "debugOnStart", "type": "boolean" }
- ],
- "handlers": ["browser"]
- },
- {
- "name": "deliverPushMessage",
- "parameters": [
- { "name": "origin", "type": "string" },
- { "name": "registrationId", "type": "string" },
- { "name": "data", "type": "string" }
- ],
- "handlers": ["browser"]
- }
- ],
- "events": [
- {
- "name": "workerCreated",
- "parameters": [
- { "name": "workerId", "type": "string" },
- { "name": "url", "type": "string" }
- ],
- "handlers": ["browser"]
- },
- {
- "name": "workerTerminated",
- "parameters": [
- { "name": "workerId", "type": "string" }
- ],
- "handlers": ["browser"]
- },
- {
- "name": "dispatchMessage",
- "parameters": [
- { "name": "workerId", "type": "string" },
- { "name": "message", "type": "string" }
- ],
- "handlers": ["browser"]
- },
- {
- "name": "workerRegistrationUpdated",
- "parameters": [
- { "name": "registrations", "type": "array", "items": { "$ref": "ServiceWorkerRegistration" } }
- ],
- "handlers": ["browser"]
- },
- {
- "name": "workerVersionUpdated",
- "parameters": [
- { "name": "versions", "type": "array", "items": { "$ref": "ServiceWorkerVersion" } }
- ],
- "handlers": ["browser"]
- },
- {
- "name": "workerErrorReported",
- "parameters": [
- { "name": "errorMessage", "$ref": "ServiceWorkerErrorMessage" }
- ],
- "handlers": ["browser"]
- },
- {
- "name": "debugOnStartUpdated",
- "parameters": [
- { "name": "debugOnStart", "type": "boolean" }
- ],
- "handlers": ["browser"]
- }
- ]
- },
- {
- "domain": "Canvas",
- "hidden": true,
- "types": [
- {
- "id": "ResourceId",
- "type": "string",
- "description": "Unique resource identifier."
- },
- {
- "id": "ResourceStateDescriptor",
- "type": "object",
- "description": "Resource state descriptor.",
- "properties": [
- { "name": "name", "type": "string", "description": "State name." },
- { "name": "enumValueForName", "type": "string", "optional": true, "description": "String representation of the enum value, if <code>name</code> stands for an enum." },
- { "name": "value", "$ref": "CallArgument", "optional": true, "description": "The value associated with the particular state." },
- { "name": "values", "type": "array", "items": { "$ref": "ResourceStateDescriptor" }, "optional": true, "description": "Array of values associated with the particular state. Either <code>value</code> or <code>values</code> will be specified." },
- { "name": "isArray", "type": "boolean", "optional": true, "description": "True iff the given <code>values</code> items stand for an array rather than a list of grouped states." }
- ]
- },
- {
- "id": "ResourceState",
- "type": "object",
- "description": "Resource state.",
- "properties": [
- { "name": "id", "$ref": "ResourceId" },
- { "name": "traceLogId", "$ref": "TraceLogId" },
- { "name": "descriptors", "type": "array", "items": { "$ref": "ResourceStateDescriptor" }, "optional": true, "description": "Describes current <code>Resource</code> state." },
- { "name": "imageURL", "type": "string", "optional": true, "description": "Screenshot image data URL." }
- ]
- },
- {
- "id": "CallArgument",
- "type": "object",
- "properties": [
- { "name": "description", "type": "string", "description": "String representation of the object." },
- { "name": "enumName", "type": "string", "optional": true, "description": "Enum name, if any, that stands for the value (for example, a WebGL enum name)." },
- { "name": "resourceId", "$ref": "ResourceId", "optional": true, "description": "Resource identifier. Specified for <code>Resource</code> objects only." },
- { "name": "type", "type": "string", "optional": true, "enum": ["object", "function", "undefined", "string", "number", "boolean"], "description": "Object type. Specified for non <code>Resource</code> objects only." },
- { "name": "subtype", "type": "string", "optional": true, "enum": ["array", "null", "node", "regexp", "date", "map", "set", "iterator", "generator", "error"], "description": "Object subtype hint. Specified for <code>object</code> type values only." },
- { "name": "remoteObject", "$ref": "Runtime.RemoteObject", "optional": true, "description": "The <code>RemoteObject</code>, if requested." }
- ]
+ "type": "string",
+ "enum": ["new", "installing", "installed", "activating", "activated", "redundant"]
},
{
- "id": "Call",
+ "id": "ServiceWorkerVersion",
"type": "object",
+ "description": "ServiceWorker version.",
"properties": [
- { "name": "contextId", "$ref": "ResourceId" },
- { "name": "functionName", "type": "string", "optional": true },
- { "name": "arguments", "type": "array", "items": { "$ref": "CallArgument" }, "optional": true },
- { "name": "result", "$ref": "CallArgument", "optional": true },
- { "name": "isDrawingCall", "type": "boolean", "optional": true },
- { "name": "isFrameEndCall", "type": "boolean", "optional": true },
- { "name": "property", "type": "string", "optional": true },
- { "name": "value", "$ref": "CallArgument", "optional": true },
- { "name": "sourceURL", "type": "string", "optional": true },
- { "name": "lineNumber", "type": "integer", "optional": true },
- { "name": "columnNumber", "type": "integer", "optional": true }
+ { "name": "versionId", "type": "string" },
+ { "name": "registrationId", "type": "string" },
+ { "name": "scriptURL", "type": "string" },
+ { "name": "runningStatus", "$ref": "ServiceWorkerVersionRunningStatus" },
+ { "name": "status", "$ref": "ServiceWorkerVersionStatus" },
+ { "name": "scriptLastModified", "type": "number", "optional": true, "description": "The Last-Modified header value of the main script." },
+ { "name": "scriptResponseTime", "type": "number", "optional": true, "description": "The time at which the response headers of the main script were received from the server. For cached script it is the last time the cache entry was validated." },
+ { "name": "controlledClients", "type": "array", "optional": true, "items": { "$ref": "Target.TargetID" } },
+ { "name": "targetId", "$ref": "Target.TargetID", "optional": true }
]
},
{
- "id": "TraceLogId",
- "type": "string",
- "description": "Unique trace log identifier."
- },
- {
- "id": "TraceLog",
+ "id": "ServiceWorkerErrorMessage",
"type": "object",
+ "description": "ServiceWorker error message.",
"properties": [
- { "name": "id", "$ref": "TraceLogId" },
- { "name": "calls", "type": "array", "items": { "$ref": "Call" } },
- { "name": "contexts", "type": "array", "items": { "$ref": "CallArgument" } },
- { "name": "startOffset", "type": "integer" },
- { "name": "alive", "type": "boolean" },
- { "name": "totalAvailableCalls", "type": "number" }
+ { "name": "errorMessage", "type": "string" },
+ { "name": "registrationId", "type": "string" },
+ { "name": "versionId", "type": "string" },
+ { "name": "sourceURL", "type": "string" },
+ { "name": "lineNumber", "type": "integer" },
+ { "name": "columnNumber", "type": "integer" }
]
}
],
"commands": [
{
- "name": "enable",
- "description": "Enables Canvas inspection."
+ "name": "enable"
},
{
- "name": "disable",
- "description": "Disables Canvas inspection."
+ "name": "disable"
},
{
- "name": "dropTraceLog",
+ "name": "unregister",
"parameters": [
- { "name": "traceLogId", "$ref": "TraceLogId" }
+ { "name": "scopeURL", "type": "string" }
]
},
{
- "name": "hasUninstrumentedCanvases",
- "returns": [
- { "name": "result", "type": "boolean" }
- ],
- "description": "Checks if there is any uninstrumented canvas in the inspected page."
+ "name": "updateRegistration",
+ "parameters": [
+ { "name": "scopeURL", "type": "string" }
+ ]
},
{
- "name": "captureFrame",
+ "name": "startWorker",
"parameters": [
- { "name": "frameId", "$ref": "Page.FrameId", "optional": true, "description": "Identifier of the frame containing document whose canvases are to be captured. If omitted, main frame is assumed." }
- ],
- "returns": [
- { "name": "traceLogId", "$ref": "TraceLogId", "description": "Identifier of the trace log containing captured canvas calls." }
- ],
- "description": "Starts (or continues) a canvas frame capturing which will be stopped automatically after the next frame is prepared."
+ { "name": "scopeURL", "type": "string" }
+ ]
},
{
- "name": "startCapturing",
+ "name": "skipWaiting",
"parameters": [
- { "name": "frameId", "$ref": "Page.FrameId", "optional": true, "description": "Identifier of the frame containing document whose canvases are to be captured. If omitted, main frame is assumed." }
- ],
- "returns": [
- { "name": "traceLogId", "$ref": "TraceLogId", "description": "Identifier of the trace log containing captured canvas calls." }
- ],
- "description": "Starts (or continues) consecutive canvas frames capturing. The capturing is stopped by the corresponding stopCapturing command."
+ { "name": "scopeURL", "type": "string" }
+ ]
},
{
- "name": "stopCapturing",
+ "name": "stopWorker",
"parameters": [
- { "name": "traceLogId", "$ref": "TraceLogId" }
+ { "name": "versionId", "type": "string" }
]
},
{
- "name": "getTraceLog",
+ "name": "inspectWorker",
"parameters": [
- { "name": "traceLogId", "$ref": "TraceLogId" },
- { "name": "startOffset", "type": "integer", "optional": true },
- { "name": "maxLength", "type": "integer", "optional": true }
- ],
- "returns": [
- { "name": "traceLog", "$ref": "TraceLog" }
+ { "name": "versionId", "type": "string" }
]
},
{
- "name": "replayTraceLog",
+ "name": "setForceUpdateOnPageLoad",
"parameters": [
- { "name": "traceLogId", "$ref": "TraceLogId" },
- { "name": "stepNo", "type": "integer", "description": "Last call index in the trace log to replay (zero based)." }
- ],
- "returns": [
- { "name": "resourceState", "$ref": "ResourceState" },
- { "name": "replayTime", "type": "number", "description": "Replay time (in milliseconds)." }
+ { "name": "forceUpdateOnPageLoad", "type": "boolean" }
]
},
{
- "name": "getResourceState",
+ "name": "deliverPushMessage",
"parameters": [
- { "name": "traceLogId", "$ref": "TraceLogId" },
- { "name": "resourceId", "$ref": "ResourceId" }
- ],
- "returns": [
- { "name": "resourceState", "$ref": "ResourceState" }
+ { "name": "origin", "type": "string" },
+ { "name": "registrationId", "type": "string" },
+ { "name": "data", "type": "string" }
]
},
{
- "name": "evaluateTraceLogCallArgument",
+ "name": "dispatchSyncEvent",
"parameters": [
- { "name": "traceLogId", "$ref": "TraceLogId" },
- { "name": "callIndex", "type": "integer", "description": "Index of the call to evaluate on (zero based)." },
- { "name": "argumentIndex", "type": "integer", "description": "Index of the argument to evaluate (zero based). Provide <code>-1</code> to evaluate call result." },
- { "name": "objectGroup", "type": "string", "optional": true, "description": "String object group name to put result into (allows rapid releasing resulting object handles using <code>Runtime.releaseObjectGroup</code>)." }
- ],
- "returns": [
- { "name": "result", "$ref": "Runtime.RemoteObject", "optional": true, "description": "Object wrapper for the evaluation result." },
- { "name": "resourceState", "$ref": "ResourceState", "optional": true, "description": "State of the <code>Resource</code> object." }
- ],
- "description": "Evaluates a given trace call argument or its result."
+ { "name": "origin", "type": "string" },
+ { "name": "registrationId", "type": "string" },
+ { "name": "tag", "type": "string" },
+ { "name": "lastChance", "type": "boolean" }
+ ]
}
],
"events": [
{
- "name": "contextCreated",
+ "name": "workerRegistrationUpdated",
"parameters": [
- { "name": "frameId", "$ref": "Page.FrameId", "description": "Identifier of the frame containing a canvas with a context." }
- ],
- "description": "Fired when a canvas context has been created in the given frame. The context may not be instrumented (see hasUninstrumentedCanvases command)."
+ { "name": "registrations", "type": "array", "items": { "$ref": "ServiceWorkerRegistration" } }
+ ]
},
{
- "name": "traceLogsRemoved",
+ "name": "workerVersionUpdated",
"parameters": [
- { "name": "frameId", "$ref": "Page.FrameId", "optional": true, "description": "If given, trace logs from the given frame were removed." },
- { "name": "traceLogId", "$ref": "TraceLogId", "optional": true, "description": "If given, trace log with the given ID was removed." }
- ],
- "description": "Fired when a set of trace logs were removed from the backend. If no parameters are given, all trace logs were removed."
+ { "name": "versions", "type": "array", "items": { "$ref": "ServiceWorkerVersion" } }
+ ]
+ },
+ {
+ "name": "workerErrorReported",
+ "parameters": [
+ { "name": "errorMessage", "$ref": "ServiceWorkerErrorMessage" }
+ ]
}
]
},
@@ -4492,7 +3696,7 @@
{
"id": "TouchPoint",
"type": "object",
- "hidden": true,
+ "experimental": true,
"properties": [
{ "name": "state", "type": "string", "enum": ["touchPressed", "touchReleased", "touchMoved", "touchStationary", "touchCancelled"], "description": "State of the touch point." },
{ "name": "x", "type": "integer", "description": "X coordinate of the event relative to the main frame's viewport."},
@@ -4507,7 +3711,7 @@
{
"id": "GestureSourceType",
"type": "string",
- "hidden": true,
+ "experimental": true,
"enum": ["default", "touch", "mouse"]
}
],
@@ -4522,14 +3726,14 @@
{ "name": "unmodifiedText", "type": "string", "optional": true, "description": "Text that would have been generated by the keyboard if no modifiers were pressed (except for shift). Useful for shortcut (accelerator) key handling (default: \"\")." },
{ "name": "keyIdentifier", "type": "string", "optional": true, "description": "Unique key identifier (e.g., 'U+0041') (default: \"\")." },
{ "name": "code", "type": "string", "optional": true, "description": "Unique DOM defined string value for each physical key (e.g., 'KeyA') (default: \"\")." },
+ { "name": "key", "type": "string", "optional": true, "description": "Unique DOM defined string value describing the meaning of the key in the context of active modifiers, keyboard layout, etc (e.g., 'AltGr') (default: \"\")." },
{ "name": "windowsVirtualKeyCode", "type": "integer", "optional": true, "description": "Windows virtual key code (default: 0)." },
{ "name": "nativeVirtualKeyCode", "type": "integer", "optional": true, "description": "Native virtual key code (default: 0)." },
{ "name": "autoRepeat", "type": "boolean", "optional": true, "description": "Whether the event was generated from auto repeat (default: false)." },
{ "name": "isKeypad", "type": "boolean", "optional": true, "description": "Whether the event was generated from the keypad (default: false)." },
{ "name": "isSystemKey", "type": "boolean", "optional": true, "description": "Whether the event was a system key event (default: false)." }
],
- "description": "Dispatches a key event to the page.",
- "handlers": ["browser"]
+ "description": "Dispatches a key event to the page."
},
{
"name": "dispatchMouseEvent",
@@ -4542,12 +3746,11 @@
{ "name": "button", "type": "string", "enum": ["none", "left", "middle", "right"], "optional": true, "description": "Mouse button (default: \"none\")." },
{ "name": "clickCount", "type": "integer", "optional": true, "description": "Number of times the mouse button was clicked (default: 0)." }
],
- "description": "Dispatches a mouse event to the page.",
- "handlers": ["browser"]
+ "description": "Dispatches a mouse event to the page."
},
{
"name": "dispatchTouchEvent",
- "hidden": true,
+ "experimental": true,
"parameters": [
{ "name": "type", "type": "string", "enum": ["touchStart", "touchEnd", "touchMove"], "description": "Type of the touch event." },
{ "name": "touchPoints", "type": "array", "items": { "$ref": "TouchPoint" }, "description": "Touch points." },
@@ -4558,7 +3761,7 @@
},
{
"name": "emulateTouchFromMouseEvent",
- "hidden": true,
+ "experimental": true,
"parameters": [
{ "name": "type", "type": "string", "enum": ["mousePressed", "mouseReleased", "mouseMoved", "mouseWheel"], "description": "Type of the mouse event." },
{ "name": "x", "type": "integer", "description": "X coordinate of the mouse pointer in DIP."},
@@ -4570,12 +3773,10 @@
{ "name": "modifiers", "type": "integer", "optional": true, "description": "Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8 (default: 0)." },
{ "name": "clickCount", "type": "integer", "optional": true, "description": "Number of times the mouse button was clicked (default: 0)." }
],
- "description": "Emulates touch event from the mouse event parameters.",
- "handlers": ["browser"]
+ "description": "Emulates touch event from the mouse event parameters."
},
{
"name": "synthesizePinchGesture",
- "async": true,
"parameters": [
{ "name": "x", "type": "integer", "description": "X coordinate of the start of the gesture in CSS pixels." },
{ "name": "y", "type": "integer", "description": "Y coordinate of the start of the gesture in CSS pixels." },
@@ -4584,12 +3785,10 @@
{ "name": "gestureSourceType", "$ref": "GestureSourceType", "optional": true, "description": "Which type of input events to be generated (default: 'default', which queries the platform for the preferred input type)." }
],
"description": "Synthesizes a pinch gesture over a time period by issuing appropriate touch events.",
- "hidden": true,
- "handlers": ["browser"]
+ "experimental": true
},
{
"name": "synthesizeScrollGesture",
- "async": true,
"parameters": [
{ "name": "x", "type": "integer", "description": "X coordinate of the start of the gesture in CSS pixels." },
{ "name": "y", "type": "integer", "description": "Y coordinate of the start of the gesture in CSS pixels." },
@@ -4599,15 +3798,16 @@
{ "name": "yOverscroll", "type": "integer", "optional": true, "description": "The number of additional pixels to scroll back along the Y axis, in addition to the given distance." },
{ "name": "preventFling", "type": "boolean", "optional": true, "description": "Prevent fling (default: true)." },
{ "name": "speed", "type": "integer", "optional": true, "description": "Swipe speed in pixels per second (default: 800)." },
- { "name": "gestureSourceType", "$ref": "GestureSourceType", "optional": true, "description": "Which type of input events to be generated (default: 'default', which queries the platform for the preferred input type)." }
+ { "name": "gestureSourceType", "$ref": "GestureSourceType", "optional": true, "description": "Which type of input events to be generated (default: 'default', which queries the platform for the preferred input type)." },
+ { "name": "repeatCount", "type": "integer", "optional": true, "description": "The number of times to repeat the gesture (default: 0)." },
+ { "name": "repeatDelayMs", "type": "integer", "optional": true, "description": "The number of milliseconds delay between each repeat. (default: 250)." },
+ { "name": "interactionMarkerName", "type": "string", "optional": true, "description": "The name of the interaction markers to generate, if not empty (default: \"\")." }
],
"description": "Synthesizes a scroll gesture over a time period by issuing appropriate touch events.",
- "hidden": true,
- "handlers": ["browser"]
+ "experimental": true
},
{
"name": "synthesizeTapGesture",
- "async": true,
"parameters": [
{ "name": "x", "type": "integer", "description": "X coordinate of the start of the gesture in CSS pixels." },
{ "name": "y", "type": "integer", "description": "Y coordinate of the start of the gesture in CSS pixels." },
@@ -4616,15 +3816,15 @@
{ "name": "gestureSourceType", "$ref": "GestureSourceType", "optional": true, "description": "Which type of input events to be generated (default: 'default', which queries the platform for the preferred input type)." }
],
"description": "Synthesizes a tap gesture over a time period by issuing appropriate touch events.",
- "hidden": true,
- "handlers": ["browser"]
+ "experimental": true
}
],
"events": []
},
{
"domain": "LayerTree",
- "hidden": true,
+ "experimental": true,
+ "dependencies": ["DOM"],
"types": [
{
"id": "LayerId",
@@ -4787,7 +3987,7 @@
},
{
"domain": "DeviceOrientation",
- "hidden": true,
+ "experimental": true,
"commands": [
{
"name": "setDeviceOrientationOverride",
@@ -4806,32 +4006,66 @@
},
{
"domain": "Tracing",
+ "dependencies": ["IO"],
+ "experimental": true,
+ "types": [
+ {
+ "id": "MemoryDumpConfig",
+ "type": "object",
+ "description": "Configuration for memory dump. Used only when \"memory-infra\" category is enabled."
+ },
+ {
+ "id": "TraceConfig",
+ "type": "object",
+ "properties": [
+ { "name": "recordMode", "type": "string", "optional": true, "enum": ["recordUntilFull", "recordContinuously", "recordAsMuchAsPossible", "echoToConsole"], "description": "Controls how the trace buffer stores data." },
+ { "name": "enableSampling", "type": "boolean", "optional": true, "description": "Turns on JavaScript stack sampling." },
+ { "name": "enableSystrace", "type": "boolean", "optional": true, "description": "Turns on system tracing." },
+ { "name": "enableArgumentFilter", "type": "boolean", "optional": true, "description": "Turns on argument filter." },
+ { "name": "includedCategories", "type": "array", "items": { "type": "string" }, "optional": true, "description": "Included category filters." },
+ { "name": "excludedCategories", "type": "array", "items": { "type": "string" }, "optional": true, "description": "Excluded category filters." },
+ { "name": "syntheticDelays", "type": "array", "items": { "type": "string" }, "optional": true, "description": "Configuration to synthesize the delays in tracing." },
+ { "name": "memoryDumpConfig", "$ref": "MemoryDumpConfig", "optional": true, "description": "Configuration for memory dump triggers. Used only when \"memory-infra\" category is enabled." }
+ ]
+ }
+ ],
"commands": [
{
"name": "start",
- "async": true,
"description": "Start trace events collection.",
"parameters": [
- { "name": "categories", "type": "string", "optional": true, "description": "Category/tag filter" },
- { "name": "options", "type": "string", "optional": true, "description": "Tracing options" },
- { "name": "bufferUsageReportingInterval", "type": "number", "optional": true, "description": "If set, the agent will issue bufferUsage events at this interval, specified in milliseconds" }
- ],
- "handlers": ["browser", "renderer"]
+ { "name": "categories", "type": "string", "optional": true, "deprecated": true, "description": "Category/tag filter" },
+ { "name": "options", "type": "string", "optional": true, "deprecated": true, "description": "Tracing options" },
+ { "name": "bufferUsageReportingInterval", "type": "number", "optional": true, "description": "If set, the agent will issue bufferUsage events at this interval, specified in milliseconds" },
+ { "name": "transferMode", "type": "string", "enum": ["ReportEvents", "ReturnAsStream"], "optional": true, "description": "Whether to report trace events as series of dataCollected events or to save trace to a stream (defaults to <code>ReportEvents</code>)." },
+ { "name": "traceConfig", "$ref": "TraceConfig", "optional": true, "description": "" }
+ ]
},
{
"name": "end",
- "async": true,
- "description": "Stop trace events collection.",
- "handlers": ["browser", "renderer"]
+ "description": "Stop trace events collection."
},
{
"name": "getCategories",
- "async": true,
"description": "Gets supported tracing categories.",
"returns": [
{ "name": "categories", "type": "array", "items": { "type": "string" }, "description": "A list of supported tracing categories." }
- ],
- "handlers": ["browser"]
+ ]
+ },
+ {
+ "name": "requestMemoryDump",
+ "description": "Request a global memory dump.",
+ "returns": [
+ { "name": "dumpGuid", "type": "string", "description": "GUID of the resulting global memory dump." },
+ { "name": "success", "type": "boolean", "description": "True iff the global memory dump succeeded." }
+ ]
+ },
+ {
+ "name": "recordClockSyncMarker",
+ "description": "Record a clock sync marker in the trace.",
+ "parameters": [
+ { "name": "syncId", "type": "string", "description": "The ID of this clock sync marker" }
+ ]
}
],
"events": [
@@ -4840,13 +4074,14 @@
"parameters": [
{ "name": "value", "type": "array", "items": { "type": "object" } }
],
- "description": "Contains an bucket of collected trace events. When tracing is stopped collected events will be send as a sequence of dataCollected events followed by tracingComplete event.",
- "handlers": ["browser"]
+ "description": "Contains an bucket of collected trace events. When tracing is stopped collected events will be send as a sequence of dataCollected events followed by tracingComplete event."
},
{
"name": "tracingComplete",
"description": "Signals that tracing is stopped and there is no trace buffers pending flush, all data were delivered via dataCollected events.",
- "handlers": ["browser"]
+ "parameters": [
+ { "name": "stream", "$ref": "IO.StreamHandle", "optional": true, "description": "A handle of the stream that holds resulting trace data." }
+ ]
},
{
"name": "bufferUsage",
@@ -4854,106 +4089,50 @@
{ "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." },
{ "name": "eventCount", "type": "number", "optional": true, "description": "An approximate number of events in the trace log." },
{ "name": "value", "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." }
- ],
- "handlers": ["browser"]
- }
- ]
- },
- {
- "domain": "Power",
- "hidden": true,
- "types": [
- {
- "id": "PowerEvent",
- "type": "object",
- "properties": [
- { "name": "type", "type": "string", "description": "Power Event Type." },
- { "name": "timestamp", "type": "number", "description": "Power Event Time, in milliseconds." },
- { "name": "value", "type": "number", "description": "Power Event Value." }
- ],
- "description": "PowerEvent item"
- }
- ],
- "commands": [
- {
- "name": "start",
- "description": "Start power events collection.",
- "parameters": [],
- "handlers": ["browser", "frontend"]
- },
- {
- "name": "end",
- "description": "Stop power events collection.",
- "parameters": [],
- "handlers": ["browser", "frontend"]
- },
- {
- "name": "canProfilePower",
- "description": "Tells whether power profiling is supported.",
- "returns": [
- { "name": "result", "type": "boolean", "description": "True if power profiling is supported." }
- ],
- "hidden": true,
- "handlers": ["browser", "frontend"]
- },
- {
- "name": "getAccuracyLevel",
- "description": "Describes the accuracy level of the data provider.",
- "returns": [
- { "name": "result", "type": "string", "enum": ["high", "moderate", "low"] }
- ],
- "handlers": ["browser", "frontend"]
- }
- ],
- "events": [
- {
- "name": "dataAvailable",
- "parameters": [
- {"name": "value", "type": "array", "items": { "$ref": "PowerEvent" }, "description": "List of power events." }
- ],
- "handlers": ["browser", "frontend"]
+ ]
}
]
},
{
"domain": "Animation",
- "hidden": true,
+ "experimental": true,
+ "dependencies": ["Runtime", "DOM"],
"types": [
{
- "id": "AnimationPlayer",
+ "id": "Animation",
"type": "object",
- "hidden": true,
+ "experimental": true,
"properties": [
- { "name": "id", "type": "string", "description": "<code>AnimationPlayer</code>'s id." },
- { "name": "pausedState", "type": "boolean", "hidden": "true", "description": "<code>AnimationPlayer</code>'s internal paused state." },
- { "name": "playState", "type": "string", "description": "<code>AnimationPlayer</code>'s play state." },
- { "name": "playbackRate", "type": "number", "description": "<code>AnimationPlayer</code>'s playback rate." },
- { "name": "startTime", "type": "number", "description": "<code>AnimationPlayer</code>'s start time." },
- { "name": "currentTime", "type": "number", "description": "<code>AnimationPlayer</code>'s current time." },
- { "name": "source", "$ref": "AnimationNode", "description": "<code>AnimationPlayer</code>'s source animation node." },
- { "name": "type", "type": "string", "enum": ["CSSTransition", "CSSAnimation", "WebAnimation"], "description": "Animation type of <code>AnimationPlayer</code>." }
+ { "name": "id", "type": "string", "description": "<code>Animation</code>'s id." },
+ { "name": "name", "type": "string", "description": "<code>Animation</code>'s name." },
+ { "name": "pausedState", "type": "boolean", "experimental": true, "description": "<code>Animation</code>'s internal paused state." },
+ { "name": "playState", "type": "string", "description": "<code>Animation</code>'s play state." },
+ { "name": "playbackRate", "type": "number", "description": "<code>Animation</code>'s playback rate." },
+ { "name": "startTime", "type": "number", "description": "<code>Animation</code>'s start time." },
+ { "name": "currentTime", "type": "number", "description": "<code>Animation</code>'s current time." },
+ { "name": "source", "$ref": "AnimationEffect", "description": "<code>Animation</code>'s source animation node." },
+ { "name": "type", "type": "string", "enum": ["CSSTransition", "CSSAnimation", "WebAnimation"], "description": "Animation type of <code>Animation</code>." },
+ { "name": "cssId", "type": "string", "optional": true, "description": "A unique ID for <code>Animation</code> representing the sources that triggered this CSS animation/transition."}
],
- "description": "AnimationPlayer instance."
+ "description": "Animation instance."
},
{
- "id": "AnimationNode",
+ "id": "AnimationEffect",
"type": "object",
- "hidden": true,
+ "experimental": true,
"properties": [
- { "name": "delay", "type": "number", "description": "<code>AnimationNode</code>'s delay." },
- { "name": "endDelay", "type": "number", "description": "<code>AnimationNode</code>'s end delay." },
- { "name": "playbackRate", "type": "number", "description": "<code>AnimationNode</code>'s playbackRate." },
- { "name": "iterationStart", "type": "number", "description": "<code>AnimationNode</code>'s iteration start." },
- { "name": "iterations", "type": "number", "description": "<code>AnimationNode</code>'s iterations." },
- { "name": "duration", "type": "number", "description": "<code>AnimationNode</code>'s iteration duration." },
- { "name": "direction", "type": "string", "description": "<code>AnimationNode</code>'s playback direction." },
- { "name": "fill", "type": "string", "description": "<code>AnimationNode</code>'s fill mode." },
- { "name": "name", "type": "string", "description": "<code>AnimationNode</code>'s name." },
- { "name": "backendNodeId", "$ref": "DOM.BackendNodeId", "description": "<code>AnimationNode</code>'s target node." },
- { "name": "keyframesRule", "$ref": "KeyframesRule", "optional": true, "description": "<code>AnimationNode</code>'s keyframes." },
- { "name": "easing", "type": "string", "description": "<code>AnimationNode</code>'s timing function." }
- ],
- "description": "AnimationNode instance"
+ { "name": "delay", "type": "number", "description": "<code>AnimationEffect</code>'s delay." },
+ { "name": "endDelay", "type": "number", "description": "<code>AnimationEffect</code>'s end delay." },
+ { "name": "iterationStart", "type": "number", "description": "<code>AnimationEffect</code>'s iteration start." },
+ { "name": "iterations", "type": "number", "description": "<code>AnimationEffect</code>'s iterations." },
+ { "name": "duration", "type": "number", "description": "<code>AnimationEffect</code>'s iteration duration." },
+ { "name": "direction", "type": "string", "description": "<code>AnimationEffect</code>'s playback direction." },
+ { "name": "fill", "type": "string", "description": "<code>AnimationEffect</code>'s fill mode." },
+ { "name": "backendNodeId", "$ref": "DOM.BackendNodeId", "description": "<code>AnimationEffect</code>'s target node." },
+ { "name": "keyframesRule", "$ref": "KeyframesRule", "optional": true, "description": "<code>AnimationEffect</code>'s keyframes." },
+ { "name": "easing", "type": "string", "description": "<code>AnimationEffect</code>'s timing function." }
+ ],
+ "description": "AnimationEffect instance"
},
{
"id": "KeyframesRule",
@@ -4969,7 +4148,7 @@
"type": "object",
"properties": [
{ "name": "offset", "type": "string", "description": "Keyframe's time offset." },
- { "name": "easing", "type": "string", "description": "<code>AnimationNode</code>'s timing function." }
+ { "name": "easing", "type": "string", "description": "<code>AnimationEffect</code>'s timing function." }
],
"description": "Keyframe Style"
}
@@ -4980,16 +4159,8 @@
"description": "Enables animation domain notifications."
},
{
- "name": "getAnimationPlayersForNode",
- "parameters": [
- { "name": "nodeId", "$ref": "DOM.NodeId", "description": "Id of the node to get animation players for." },
- { "name": "includeSubtreeAnimations", "type": "boolean", "description": "Include animations from elements subtree." }
- ],
- "returns": [
- { "name": "animationPlayers", "type": "array", "items": { "$ref": "AnimationPlayer" }, "description": "Array of animation players." }
- ],
- "description": "Returns animation players relevant to the node.",
- "hidden": true
+ "name": "disable",
+ "description": "Disables animation domain notifications."
},
{
"name": "getPlaybackRate",
@@ -5006,43 +4177,86 @@
"description": "Sets the playback rate of the document timeline."
},
{
- "name": "setCurrentTime",
+ "name": "getCurrentTime",
+ "parameters": [
+ { "name": "id", "type": "string", "description": "Id of animation." }
+ ],
+ "returns": [
+ { "name": "currentTime", "type": "number", "description": "Current time of the page." }
+ ],
+ "description": "Returns the current time of the an animation."
+ },
+ {
+ "name": "setPaused",
"parameters": [
- { "name": "currentTime", "type": "number", "description": "Current time for the page animation timeline" }
+ { "name": "animations", "type": "array", "items": { "type": "string" }, "description": "Animations to set the pause state of." },
+ { "name": "paused", "type": "boolean", "description": "Paused state to set to." }
],
- "description": "Sets the current time of the document timeline."
+ "description": "Sets the paused state of a set of animations."
},
{
"name": "setTiming",
"parameters": [
- { "name": "playerId", "type": "string", "description": "AnimationPlayer id." },
+ { "name": "animationId", "type": "string", "description": "Animation id." },
{ "name": "duration", "type": "number", "description": "Duration of the animation." },
{ "name": "delay", "type": "number", "description": "Delay of the animation." }
],
"description": "Sets the timing of an animation node."
+ },
+ {
+ "name": "seekAnimations",
+ "parameters": [
+ { "name": "animations", "type": "array", "items": { "type": "string" }, "description": "List of animation ids to seek." },
+ { "name": "currentTime", "type": "number", "description": "Set the current time of each animation." }
+ ],
+ "description": "Seek a set of animations to a particular time within each animation."
+ },
+ {
+ "name": "releaseAnimations",
+ "parameters": [
+ { "name": "animations", "type": "array", "items": { "type": "string" }, "description": "List of animation ids to seek." }
+ ],
+ "description": "Releases a set of animations to no longer be manipulated."
+ },
+ {
+ "name": "resolveAnimation",
+ "parameters": [
+ { "name": "animationId", "type": "string", "description": "Animation id." }
+ ],
+ "returns": [
+ { "name": "remoteObject", "$ref": "Runtime.RemoteObject", "description": "Corresponding remote object." }
+ ],
+ "description": "Gets the remote object of the Animation."
}
],
"events": [
{
- "name": "animationPlayerCreated",
+ "name": "animationCreated",
+ "parameters": [
+ { "name": "id", "type": "string", "description": "Id of the animation that was created." }
+ ],
+ "description": "Event for each animation that has been created."
+ },
+ {
+ "name": "animationStarted",
"parameters": [
- { "name": "player", "$ref": "AnimationPlayer", "description": "AnimationPlayer that was created." },
- { "name": "resetTimeline", "type": "boolean", "description": "Whether the timeline should be reset." }
+ { "name": "animation", "$ref": "Animation", "description": "Animation that was started." }
],
- "description": "Event for each animation player that has been created."
+ "description": "Event for animation that has been started."
},
{
- "name": "animationPlayerCanceled",
+ "name": "animationCanceled",
"parameters": [
- { "name": "playerId", "type": "string", "description": "Id of the AnimationPlayer that was cancelled." }
+ { "name": "id", "type": "string", "description": "Id of the animation that was cancelled."}
],
- "description": "Event for AnimationPlayers in the frontend that have been cancelled."
+ "description": "Event for when an animation has been cancelled."
}
]
},
{
"domain": "Accessibility",
- "hidden": true,
+ "experimental": true,
+ "dependencies": ["DOM"],
"types": [
{
"id": "AXNodeId",
@@ -5052,23 +4266,31 @@
{
"id": "AXValueType",
"type": "string",
- "enum": [ "boolean", "tristate", "booleanOrUndefined", "idref", "idrefList", "integer", "number", "string", "token", "tokenList", "domRelation", "role", "internalRole" ],
+ "enum": [ "boolean", "tristate", "booleanOrUndefined", "idref", "idrefList", "integer", "node", "nodeList", "number", "string", "computedString", "token", "tokenList", "domRelation", "role", "internalRole", "valueUndefined" ],
"description": "Enum of possible property types."
},
{
- "id": "AXPropertySourceType",
+ "id": "AXValueSourceType",
"type": "string",
- "enum": [ "attribute", "implicit", "style" ],
+ "enum": [ "attribute", "implicit", "style", "contents", "placeholder", "relatedElement" ],
"description": "Enum of possible property sources."
},
+ { "id": "AXValueNativeSourceType",
+ "type": "string",
+ "enum": [ "figcaption", "label", "labelfor", "labelwrapped", "legend", "tablecaption", "title", "other" ],
+ "description": "Enum of possible native property sources (as a subtype of a particular AXValueSourceType)."
+ },
{
- "id": "AXPropertySource",
+ "id": "AXValueSource",
"type": "object",
"properties": [
- { "name": "name", "type": "string", "description": "The name/label of this source." },
- { "name": "sourceType", "$ref": "AXPropertySourceType", "description": "What type of source this is." },
- { "name": "value", "type": "any", "description": "The value of this property source." },
- { "name": "type", "$ref": "AXValueType", "description": "What type the value should be interpreted as." },
+ { "name": "type", "$ref": "AXValueSourceType", "description": "What type of source this is." },
+ { "name": "value", "$ref": "AXValue", "description": "The value of this property source.", "optional": true },
+ { "name": "attribute", "type": "string", "description": "The name of the relevant attribute, if any.", "optional": true },
+ { "name": "attributeValue", "$ref": "AXValue", "description": "The value of the relevant attribute, if any.", "optional": true },
+ { "name": "superseded", "type": "boolean", "description": "Whether this source is superseded by a higher priority source.", "optional": true },
+ { "name": "nativeSource", "$ref": "AXValueNativeSourceType", "description": "The native markup source for this value, e.g. a <label> element.", "optional": true },
+ { "name": "nativeSourceValue", "$ref": "AXValue", "description": "The value, such as a node or node list, of the native source.", "optional": true },
{ "name": "invalid", "type": "boolean", "description": "Whether the value for this property is invalid.", "optional": true },
{ "name": "invalidReason", "type": "string", "description": "Reason for the value being invalid, if it is.", "optional": true }
],
@@ -5078,8 +4300,9 @@
"id": "AXRelatedNode",
"type": "object",
"properties": [
+ { "name": "backendDOMNodeId", "$ref": "DOM.BackendNodeId", "description": "The BackendNodeId of the related DOM node." },
{ "name": "idref", "type": "string", "description": "The IDRef value provided, if any.", "optional": true },
- { "name": "backendNodeId", "$ref": "DOM.BackendNodeId", "description": "The BackendNodeId of the related node." }
+ { "name": "text", "type": "string", "description": "The text alternative of this node in the current context.", "optional": true }
]
},
{
@@ -5095,18 +4318,16 @@
"type": "object",
"properties": [
{ "name": "type", "$ref": "AXValueType", "description": "The type of this value." },
-
{ "name": "value", "type": "any", "description": "The computed value of this property.", "optional": true },
- { "name": "relatedNodeValue", "$ref": "AXRelatedNode", "description": "The related node value, if any.", "optional": true },
- { "name": "relatedNodeArrayValue", "type": "array", "items": { "$ref": "AXRelatedNode" }, "description": "Multiple relted nodes, if applicable.", "optional": true },
- { "name": "sources", "type": "array", "items": { "$ref": "AXPropertySource" }, "description": "The sources which contributed to the computation of this property.", "optional": true }
+ { "name": "relatedNodes", "type": "array", "items": { "$ref": "AXRelatedNode" }, "description": "One or more related nodes, if applicable.", "optional": true },
+ { "name": "sources", "type": "array", "items": { "$ref": "AXValueSource" }, "description": "The sources which contributed to the computation of this property.", "optional": true }
],
"description": "A single computed AX property."
},
{
"id": "AXGlobalStates",
"type": "string",
- "enum": [ "disabled", "hidden", "hiddenRoot", "invalid" ],
+ "enum": [ "disabled", "hidden", "hiddenRoot", "invalid", "keyshortcuts", "roledescription" ],
"description": "States which apply to every AX node."
},
{
@@ -5119,18 +4340,18 @@
"id": "AXWidgetAttributes",
"type": "string",
"enum": [ "autocomplete", "haspopup", "level", "multiselectable", "orientation", "multiline", "readonly", "required", "valuemin", "valuemax", "valuetext" ],
- "Description": "Attributes which apply to widgets."
+ "description": "Attributes which apply to widgets."
},
{
"id": "AXWidgetStates",
"type": "string",
- "enum": [ "checked", "expanded", "pressed", "selected" ],
+ "enum": [ "checked", "expanded", "modal", "pressed", "selected" ],
"description": "States which apply to widgets."
},
{
"id": "AXRelationshipAttributes",
"type": "string",
- "enum": [ "activedescendant", "flowto", "controls", "describedby", "labelledby", "owns" ],
+ "enum": [ "activedescendant", "controls", "describedby", "details", "errormessage", "flowto", "labelledby", "owns" ],
"description": "Relationships between elements other than parent/child/sibling."
},
{
@@ -5138,27 +4359,202 @@
"type": "object",
"properties": [
{ "name": "nodeId", "$ref": "AXNodeId", "description": "Unique identifier for this node." },
- { "name": "role", "$ref": "AXValue", "description": "This <code>Node</code>'s role, whether explicit or implicit." },
+ { "name": "ignored", "type": "boolean", "description": "Whether this node is ignored for accessibility" },
+ { "name": "ignoredReasons", "type": "array", "items": { "$ref": "AXProperty" }, "description": "Collection of reasons why this node is hidden.", "optional": true },
+ { "name": "role", "$ref": "AXValue", "description": "This <code>Node</code>'s role, whether explicit or implicit.", "optional": true},
{ "name": "name", "$ref": "AXValue", "description": "The accessible name for this <code>Node</code>.", "optional": true },
{ "name": "description", "$ref": "AXValue", "description": "The accessible description for this <code>Node</code>.", "optional": true },
{ "name": "value", "$ref": "AXValue", "description": "The value for this <code>Node</code>.", "optional": true },
- { "name": "help", "$ref": "AXValue", "description": "Help.", "optional": true },
- { "name": "properties", "type": "array", "items": { "$ref": "AXProperty" }, "description": "All other properties" }
+ { "name": "properties", "type": "array", "items": { "$ref": "AXProperty" }, "description": "All other properties", "optional": true },
+ { "name": "childIds", "type": "array", "items": { "$ref": "AXNodeId" }, "description": "IDs for each of this node's child nodes.", "optional": true },
+ { "name": "backendDOMNodeId", "$ref": "DOM.BackendNodeId", "description": "The backend ID for the associated DOM node, if any.", "optional": true }
],
"description": "A node in the accessibility tree."
}
],
"commands": [
{
- "name": "getAXNode",
+ "name": "getPartialAXTree",
"parameters": [
- { "name": "nodeId", "$ref": "DOM.NodeId", "description": "ID of node to get accessibility node for." }
+ { "name": "nodeId", "$ref": "DOM.NodeId", "description": "ID of node to get the partial accessibility tree for." },
+ { "name": "fetchRelatives", "type": "boolean", "description": "Whether to fetch this nodes ancestors, siblings and children. Defaults to true.", "optional": true }
],
"returns": [
- { "name": "accessibilityNode", "$ref": "AXNode", "description": "The <code>Accessibility.AXNode</code> for this DOM node, if it exists.", "optional": true }
+ { "name": "nodes", "type": "array", "items": { "$ref": "AXNode" }, "description": "The <code>Accessibility.AXNode</code> for this DOM node, if it exists, plus its ancestors, siblings and children, if requested." }
+ ],
+ "description": "Fetches the accessibility node and partial accessibility tree for this DOM node, if it exists.",
+ "experimental": true
+ }
+ ]
+ },
+ {
+ "domain": "Storage",
+ "experimental": true,
+ "types": [
+ {
+ "id": "StorageType",
+ "type": "string",
+ "enum": [
+ "appcache",
+ "cookies",
+ "file_systems",
+ "indexeddb",
+ "local_storage",
+ "shader_cache",
+ "websql",
+ "service_workers",
+ "cache_storage",
+ "all"
+ ],
+ "description": "Enum of possible storage types."
+ }
+ ],
+ "commands": [
+ {
+ "name": "clearDataForOrigin",
+ "parameters": [
+ { "name": "origin", "type": "string", "description": "Security origin." },
+ { "name": "storageTypes", "type": "string", "description": "Comma separated origin names." }
+ ],
+ "description": "Clears storage for origin."
+ }
+ ]
+ },
+ {
+ "domain": "Log",
+ "description": "Provides access to log entries.",
+ "dependencies": ["Runtime", "Network"],
+ "experimental": true,
+ "types": [
+ {
+ "id": "LogEntry",
+ "type": "object",
+ "description": "Log entry.",
+ "properties": [
+ { "name": "source", "type": "string", "enum": ["xml", "javascript", "network", "storage", "appcache", "rendering", "security", "deprecation", "worker", "violation", "intervention", "other"], "description": "Log entry source." },
+ { "name": "level", "type": "string", "enum": ["verbose", "info", "warning", "error"], "description": "Log entry severity." },
+ { "name": "text", "type": "string", "description": "Logged text." },
+ { "name": "timestamp", "$ref": "Runtime.Timestamp", "description": "Timestamp when this entry was added." },
+ { "name": "url", "type": "string", "optional": true, "description": "URL of the resource if known." },
+ { "name": "lineNumber", "type": "integer", "optional": true, "description": "Line number in the resource." },
+ { "name": "stackTrace", "$ref": "Runtime.StackTrace", "optional": true, "description": "JavaScript stack trace." },
+ { "name": "networkRequestId", "$ref": "Network.RequestId", "optional": true, "description": "Identifier of the network request associated with this entry." },
+ { "name": "workerId", "type": "string", "optional": true, "description": "Identifier of the worker associated with this entry." }
+ ]
+ },
+ {
+ "id": "ViolationSetting",
+ "type": "object",
+ "description": "Violation configuration setting.",
+ "properties": [
+ { "name": "name", "type": "string", "enum": ["longTask", "longLayout", "blockedEvent", "blockedParser", "discouragedAPIUse", "handler", "recurringHandler"], "description": "Violation type." },
+ { "name": "threshold", "type": "number", "description": "Time threshold to trigger upon." }
+ ]
+ }
+ ],
+ "commands": [
+ {
+ "name": "enable",
+ "description": "Enables log domain, sends the entries collected so far to the client by means of the <code>entryAdded</code> notification."
+ },
+ {
+ "name": "disable",
+ "description": "Disables log domain, prevents further log entries from being reported to the client."
+ },
+ {
+ "name": "clear",
+ "description": "Clears the log."
+ },
+ {
+ "name": "startViolationsReport",
+ "parameters": [
+ { "name": "config", "type": "array", "items": { "$ref": "ViolationSetting" }, "description": "Configuration for violations." }
+ ],
+ "description": "start violation reporting."
+ },
+ {
+ "name": "stopViolationsReport",
+ "description": "Stop violation reporting."
+ }
+ ],
+ "events": [
+ {
+ "name": "entryAdded",
+ "parameters": [
+ { "name": "entry", "$ref": "LogEntry", "description": "The entry." }
+ ],
+ "description": "Issued when new message was logged."
+ }
+ ]
+ },
+ {
+ "domain": "SystemInfo",
+ "description": "The SystemInfo domain defines methods and events for querying low-level system information.",
+ "experimental": true,
+ "types": [
+ {
+ "id": "GPUDevice",
+ "type": "object",
+ "properties": [
+ { "name": "vendorId", "type": "number", "description": "PCI ID of the GPU vendor, if available; 0 otherwise." },
+ { "name": "deviceId", "type": "number", "description": "PCI ID of the GPU device, if available; 0 otherwise." },
+ { "name": "vendorString", "type": "string", "description": "String description of the GPU vendor, if the PCI ID is not available." },
+ { "name": "deviceString", "type": "string", "description": "String description of the GPU device, if the PCI ID is not available." }
+ ],
+ "description": "Describes a single graphics processor (GPU)."
+ },
+ {
+ "id": "GPUInfo",
+ "type": "object",
+ "properties": [
+ { "name": "devices", "type": "array", "items": { "$ref": "GPUDevice" }, "description": "The graphics devices on the system. Element 0 is the primary GPU." },
+ { "name": "auxAttributes", "type": "object", "optional": true, "description": "An optional dictionary of additional GPU related attributes." },
+ { "name": "featureStatus", "type": "object", "optional": true, "description": "An optional dictionary of graphics features and their status." },
+ { "name": "driverBugWorkarounds", "type": "array", "items": { "type": "string" }, "description": "An optional array of GPU driver bug workarounds." }
],
- "description": "Fetches the accessibility node for this DOM node, if it exists.",
- "hidden": true
+ "description": "Provides information about the GPU(s) on the system."
+ }
+ ],
+ "commands": [
+ {
+ "name": "getInfo",
+ "description": "Returns information about the system.",
+ "returns": [
+ { "name": "gpu", "$ref": "GPUInfo", "description": "Information about the GPUs on the system." },
+ { "name": "modelName", "type": "string", "description": "A platform-dependent description of the model of the machine. On Mac OS, this is, for example, 'MacBookPro'. Will be the empty string if not supported." },
+ { "name": "modelVersion", "type": "string", "description": "A platform-dependent description of the version of the machine. On Mac OS, this is, for example, '10.1'. Will be the empty string if not supported." }
+ ]
+ }
+ ]
+ },
+ {
+ "domain": "Tethering",
+ "description": "The Tethering domain defines methods and events for browser port binding.",
+ "experimental": true,
+ "commands": [
+ {
+ "name": "bind",
+ "description": "Request browser port binding.",
+ "parameters": [
+ { "name": "port", "type": "integer", "description": "Port number to bind." }
+ ]
+ },
+ {
+ "name": "unbind",
+ "description": "Request browser port unbinding.",
+ "parameters": [
+ { "name": "port", "type": "integer", "description": "Port number to unbind." }
+ ]
+ }
+ ],
+ "events": [
+ {
+ "name": "accepted",
+ "description": "Informs that port was successfully bound and got a specified connection id.",
+ "parameters": [
+ {"name": "port", "type": "integer", "description": "Port number that was successfully bound." },
+ {"name": "connectionId", "type": "string", "description": "Connection id to be used." }
+ ]
}
]
}]
diff --git a/source/ProtocolGenerator/js_protocol.json b/source/ProtocolGenerator/js_protocol.json
new file mode 100644
index 0000000..6e7be57
--- /dev/null
+++ b/source/ProtocolGenerator/js_protocol.json
@@ -0,0 +1,1084 @@
+{
+ "version": { "major": "1", "minor": "2" },
+ "domains": [
+ {
+ "domain": "Schema",
+ "description": "Provides information about the protocol schema.",
+ "types": [
+ {
+ "id": "Domain",
+ "type": "object",
+ "description": "Description of the protocol domain.",
+ "properties": [
+ { "name": "name", "type": "string", "description": "Domain name." },
+ { "name": "version", "type": "string", "description": "Domain version." }
+ ]
+ }
+ ],
+ "commands": [
+ {
+ "name": "getDomains",
+ "description": "Returns supported domains.",
+ "handlers": ["browser", "renderer"],
+ "returns": [
+ { "name": "domains", "type": "array", "items": { "$ref": "Domain" }, "description": "List of supported domains." }
+ ]
+ }
+ ]
+ },
+ {
+ "domain": "Runtime",
+ "description": "Runtime domain exposes JavaScript runtime by means of remote evaluation and mirror objects. Evaluation results are returned as mirror object that expose object type, string representation and unique identifier that can be used for further object reference. Original objects are maintained in memory unless they are either explicitly released or are released along with the other objects in their object group.",
+ "types": [
+ {
+ "id": "ScriptId",
+ "type": "string",
+ "description": "Unique script identifier."
+ },
+ {
+ "id": "RemoteObjectId",
+ "type": "string",
+ "description": "Unique object identifier."
+ },
+ {
+ "id": "UnserializableValue",
+ "type": "string",
+ "enum": ["Infinity", "NaN", "-Infinity", "-0"],
+ "description": "Primitive value which cannot be JSON-stringified."
+ },
+ {
+ "id": "RemoteObject",
+ "type": "object",
+ "description": "Mirror object referencing original JavaScript object.",
+ "properties": [
+ { "name": "type", "type": "string", "enum": ["object", "function", "undefined", "string", "number", "boolean", "symbol"], "description": "Object type." },
+ { "name": "subtype", "type": "string", "optional": true, "enum": ["array", "null", "node", "regexp", "date", "map", "set", "iterator", "generator", "error", "proxy", "promise", "typedarray"], "description": "Object subtype hint. Specified for <code>object</code> type values only." },
+ { "name": "className", "type": "string", "optional": true, "description": "Object class (constructor) name. Specified for <code>object</code> type values only." },
+ { "name": "value", "type": "any", "optional": true, "description": "Remote object value in case of primitive values or JSON values (if it was requested)." },
+ { "name": "unserializableValue", "$ref": "UnserializableValue", "optional": true, "description": "Primitive value which can not be JSON-stringified does not have <code>value</code>, but gets this property." },
+ { "name": "description", "type": "string", "optional": true, "description": "String representation of the object." },
+ { "name": "objectId", "$ref": "RemoteObjectId", "optional": true, "description": "Unique object identifier (for non-primitive values)." },
+ { "name": "preview", "$ref": "ObjectPreview", "optional": true, "description": "Preview containing abbreviated property values. Specified for <code>object</code> type values only.", "experimental": true },
+ { "name": "customPreview", "$ref": "CustomPreview", "optional": true, "experimental": true}
+ ]
+ },
+ {
+ "id": "CustomPreview",
+ "type": "object",
+ "experimental": true,
+ "properties": [
+ { "name": "header", "type": "string"},
+ { "name": "hasBody", "type": "boolean"},
+ { "name": "formatterObjectId", "$ref": "RemoteObjectId"},
+ { "name": "bindRemoteObjectFunctionId", "$ref": "RemoteObjectId" },
+ { "name": "configObjectId", "$ref": "RemoteObjectId", "optional": true }
+ ]
+ },
+ {
+ "id": "ObjectPreview",
+ "type": "object",
+ "experimental": true,
+ "description": "Object containing abbreviated remote object value.",
+ "properties": [
+ { "name": "type", "type": "string", "enum": ["object", "function", "undefined", "string", "number", "boolean", "symbol"], "description": "Object type." },
+ { "name": "subtype", "type": "string", "optional": true, "enum": ["array", "null", "node", "regexp", "date", "map", "set", "iterator", "generator", "error"], "description": "Object subtype hint. Specified for <code>object</code> type values only." },
+ { "name": "description", "type": "string", "optional": true, "description": "String representation of the object." },
+ { "name": "overflow", "type": "boolean", "description": "True iff some of the properties or entries of the original object did not fit." },
+ { "name": "properties", "type": "array", "items": { "$ref": "PropertyPreview" }, "description": "List of the properties." },
+ { "name": "entries", "type": "array", "items": { "$ref": "EntryPreview" }, "optional": true, "description": "List of the entries. Specified for <code>map</code> and <code>set</code> subtype values only." }
+ ]
+ },
+ {
+ "id": "PropertyPreview",
+ "type": "object",
+ "experimental": true,
+ "properties": [
+ { "name": "name", "type": "string", "description": "Property name." },
+ { "name": "type", "type": "string", "enum": ["object", "function", "undefined", "string", "number", "boolean", "symbol", "accessor"], "description": "Object type. Accessor means that the property itself is an accessor property." },
+ { "name": "value", "type": "string", "optional": true, "description": "User-friendly property value string." },
+ { "name": "valuePreview", "$ref": "ObjectPreview", "optional": true, "description": "Nested value preview." },
+ { "name": "subtype", "type": "string", "optional": true, "enum": ["array", "null", "node", "regexp", "date", "map", "set", "iterator", "generator", "error"], "description": "Object subtype hint. Specified for <code>object</code> type values only." }
+ ]
+ },
+ {
+ "id": "EntryPreview",
+ "type": "object",
+ "experimental": true,
+ "properties": [
+ { "name": "key", "$ref": "ObjectPreview", "optional": true, "description": "Preview of the key. Specified for map-like collection entries." },
+ { "name": "value", "$ref": "ObjectPreview", "description": "Preview of the value." }
+ ]
+ },
+ {
+ "id": "PropertyDescriptor",
+ "type": "object",
+ "description": "Object property descriptor.",
+ "properties": [
+ { "name": "name", "type": "string", "description": "Property name or symbol description." },
+ { "name": "value", "$ref": "RemoteObject", "optional": true, "description": "The value associated with the property." },
+ { "name": "writable", "type": "boolean", "optional": true, "description": "True if the value associated with the property may be changed (data descriptors only)." },
+ { "name": "get", "$ref": "RemoteObject", "optional": true, "description": "A function which serves as a getter for the property, or <code>undefined</code> if there is no getter (accessor descriptors only)." },
+ { "name": "set", "$ref": "RemoteObject", "optional": true, "description": "A function which serves as a setter for the property, or <code>undefined</code> if there is no setter (accessor descriptors only)." },
+ { "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." },
+ { "name": "enumerable", "type": "boolean", "description": "True if this property shows up during enumeration of the properties on the corresponding object." },
+ { "name": "wasThrown", "type": "boolean", "optional": true, "description": "True if the result was thrown during the evaluation." },
+ { "name": "isOwn", "optional": true, "type": "boolean", "description": "True if the property is owned for the object." },
+ { "name": "symbol", "$ref": "RemoteObject", "optional": true, "description": "Property symbol object, if the property is of the <code>symbol</code> type." }
+ ]
+ },
+ {
+ "id": "InternalPropertyDescriptor",
+ "type": "object",
+ "description": "Object internal property descriptor. This property isn't normally visible in JavaScript code.",
+ "properties": [
+ { "name": "name", "type": "string", "description": "Conventional property name." },
+ { "name": "value", "$ref": "RemoteObject", "optional": true, "description": "The value associated with the property." }
+ ]
+ },
+ {
+ "id": "CallArgument",
+ "type": "object",
+ "description": "Represents function call argument. Either remote object id <code>objectId</code>, primitive <code>value</code>, unserializable primitive value or neither of (for undefined) them should be specified.",
+ "properties": [
+ { "name": "value", "type": "any", "optional": true, "description": "Primitive value." },
+ { "name": "unserializableValue", "$ref": "UnserializableValue", "optional": true, "description": "Primitive value which can not be JSON-stringified." },
+ { "name": "objectId", "$ref": "RemoteObjectId", "optional": true, "description": "Remote object handle." }
+ ]
+ },
+ {
+ "id": "ExecutionContextId",
+ "type": "integer",
+ "description": "Id of an execution context."
+ },
+ {
+ "id": "ExecutionContextDescription",
+ "type": "object",
+ "description": "Description of an isolated world.",
+ "properties": [
+ { "name": "id", "$ref": "ExecutionContextId", "description": "Unique id of the execution context. It can be used to specify in which execution context script evaluation should be performed." },
+ { "name": "origin", "type": "string", "description": "Execution context origin." },
+ { "name": "name", "type": "string", "description": "Human readable name describing given context." },
+ { "name": "auxData", "type": "object", "optional": true, "description": "Embedder-specific auxiliary data." }
+ ]
+ },
+ {
+ "id": "ExceptionDetails",
+ "type": "object",
+ "description": "Detailed information about exception (or error) that was thrown during script compilation or execution.",
+ "properties": [
+ { "name": "exceptionId", "type": "integer", "description": "Exception id." },
+ { "name": "text", "type": "string", "description": "Exception text, which should be used together with exception object when available." },
+ { "name": "lineNumber", "type": "integer", "description": "Line number of the exception location (0-based)." },
+ { "name": "columnNumber", "type": "integer", "description": "Column number of the exception location (0-based)." },
+ { "name": "scriptId", "$ref": "ScriptId", "optional": true, "description": "Script ID of the exception location." },
+ { "name": "url", "type": "string", "optional": true, "description": "URL of the exception location, to be used when the script was not reported." },
+ { "name": "stackTrace", "$ref": "StackTrace", "optional": true, "description": "JavaScript stack trace if available." },
+ { "name": "exception", "$ref": "RemoteObject", "optional": true, "description": "Exception object if available." },
+ { "name": "executionContextId", "$ref": "ExecutionContextId", "optional": true, "description": "Identifier of the context where exception happened." }
+ ]
+ },
+ {
+ "id": "Timestamp",
+ "type": "number",
+ "description": "Number of milliseconds since epoch."
+ },
+ {
+ "id": "CallFrame",
+ "type": "object",
+ "description": "Stack entry for runtime errors and assertions.",
+ "properties": [
+ { "name": "functionName", "type": "string", "description": "JavaScript function name." },
+ { "name": "scriptId", "$ref": "ScriptId", "description": "JavaScript script id." },
+ { "name": "url", "type": "string", "description": "JavaScript script name or url." },
+ { "name": "lineNumber", "type": "integer", "description": "JavaScript script line number (0-based)." },
+ { "name": "columnNumber", "type": "integer", "description": "JavaScript script column number (0-based)." }
+ ]
+ },
+ {
+ "id": "StackTrace",
+ "type": "object",
+ "description": "Call frames for assertions or error messages.",
+ "properties": [
+ { "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." },
+ { "name": "callFrames", "type": "array", "items": { "$ref": "CallFrame" }, "description": "JavaScript function name." },
+ { "name": "parent", "$ref": "StackTrace", "optional": true, "description": "Asynchronous JavaScript stack trace that preceded this stack, if available." },
+ { "name": "promiseCreationFrame", "$ref": "CallFrame", "optional": true, "experimental": true, "description": "Creation frame of the Promise which produced the next synchronous trace when resolved, if available." }
+ ]
+ }
+ ],
+ "commands": [
+ {
+ "name": "evaluate",
+ "parameters": [
+ { "name": "expression", "type": "string", "description": "Expression to evaluate." },
+ { "name": "objectGroup", "type": "string", "optional": true, "description": "Symbolic group name that can be used to release multiple objects." },
+ { "name": "includeCommandLineAPI", "type": "boolean", "optional": true, "description": "Determines whether Command Line API should be available during the evaluation." },
+ { "name": "silent", "type": "boolean", "optional": true, "description": "In silent mode exceptions thrown during evaluation are not reported and do not pause execution. Overrides <code>setPauseOnException</code> state." },
+ { "name": "contextId", "$ref": "ExecutionContextId", "optional": true, "description": "Specifies in which execution context to perform evaluation. If the parameter is omitted the evaluation will be performed in the context of the inspected page." },
+ { "name": "returnByValue", "type": "boolean", "optional": true, "description": "Whether the result is expected to be a JSON object that should be sent by value." },
+ { "name": "generatePreview", "type": "boolean", "optional": true, "experimental": true, "description": "Whether preview should be generated for the result." },
+ { "name": "userGesture", "type": "boolean", "optional": true, "experimental": true, "description": "Whether execution should be treated as initiated by user in the UI." },
+ { "name": "awaitPromise", "type": "boolean", "optional":true, "description": "Whether execution should wait for promise to be resolved. If the result of evaluation is not a Promise, it's considered to be an error." }
+ ],
+ "returns": [
+ { "name": "result", "$ref": "RemoteObject", "description": "Evaluation result." },
+ { "name": "exceptionDetails", "$ref": "ExceptionDetails", "optional": true, "description": "Exception details."}
+ ],
+ "description": "Evaluates expression on global object."
+ },
+ {
+ "name": "awaitPromise",
+ "parameters": [
+ { "name": "promiseObjectId", "$ref": "RemoteObjectId", "description": "Identifier of the promise." },
+ { "name": "returnByValue", "type": "boolean", "optional": true, "description": "Whether the result is expected to be a JSON object that should be sent by value." },
+ { "name": "generatePreview", "type": "boolean", "optional": true, "description": "Whether preview should be generated for the result." }
+ ],
+ "returns": [
+ { "name": "result", "$ref": "RemoteObject", "description": "Promise result. Will contain rejected value if promise was rejected." },
+ { "name": "exceptionDetails", "$ref": "ExceptionDetails", "optional": true, "description": "Exception details if stack strace is available."}
+ ],
+ "description": "Add handler to promise with given promise object id."
+ },
+ {
+ "name": "callFunctionOn",
+ "parameters": [
+ { "name": "objectId", "$ref": "RemoteObjectId", "description": "Identifier of the object to call function on." },
+ { "name": "functionDeclaration", "type": "string", "description": "Declaration of the function to call." },
+ { "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." },
+ { "name": "silent", "type": "boolean", "optional": true, "description": "In silent mode exceptions thrown during evaluation are not reported and do not pause execution. Overrides <code>setPauseOnException</code> state." },
+ { "name": "returnByValue", "type": "boolean", "optional": true, "description": "Whether the result is expected to be a JSON object which should be sent by value." },
+ { "name": "generatePreview", "type": "boolean", "optional": true, "experimental": true, "description": "Whether preview should be generated for the result." },
+ { "name": "userGesture", "type": "boolean", "optional": true, "experimental": true, "description": "Whether execution should be treated as initiated by user in the UI." },
+ { "name": "awaitPromise", "type": "boolean", "optional":true, "description": "Whether execution should wait for promise to be resolved. If the result of evaluation is not a Promise, it's considered to be an error." }
+ ],
+ "returns": [
+ { "name": "result", "$ref": "RemoteObject", "description": "Call result." },
+ { "name": "exceptionDetails", "$ref": "ExceptionDetails", "optional": true, "description": "Exception details."}
+ ],
+ "description": "Calls function with given declaration on the given object. Object group of the result is inherited from the target object."
+ },
+ {
+ "name": "getProperties",
+ "parameters": [
+ { "name": "objectId", "$ref": "RemoteObjectId", "description": "Identifier of the object to return properties for." },
+ { "name": "ownProperties", "optional": true, "type": "boolean", "description": "If true, returns properties belonging only to the element itself, not to its prototype chain." },
+ { "name": "accessorPropertiesOnly", "optional": true, "type": "boolean", "description": "If true, returns accessor properties (with getter/setter) only; internal properties are not returned either.", "experimental": true },
+ { "name": "generatePreview", "type": "boolean", "optional": true, "experimental": true, "description": "Whether preview should be generated for the results." }
+ ],
+ "returns": [
+ { "name": "result", "type": "array", "items": { "$ref": "PropertyDescriptor" }, "description": "Object properties." },
+ { "name": "internalProperties", "optional": true, "type": "array", "items": { "$ref": "InternalPropertyDescriptor" }, "description": "Internal object properties (only of the element itself)." },
+ { "name": "exceptionDetails", "$ref": "ExceptionDetails", "optional": true, "description": "Exception details."}
+ ],
+ "description": "Returns properties of a given object. Object group of the result is inherited from the target object."
+ },
+ {
+ "name": "releaseObject",
+ "parameters": [
+ { "name": "objectId", "$ref": "RemoteObjectId", "description": "Identifier of the object to release." }
+ ],
+ "description": "Releases remote object with given id."
+ },
+ {
+ "name": "releaseObjectGroup",
+ "parameters": [
+ { "name": "objectGroup", "type": "string", "description": "Symbolic object group name." }
+ ],
+ "description": "Releases all remote objects that belong to a given group."
+ },
+ {
+ "name": "runIfWaitingForDebugger",
+ "description": "Tells inspected instance to run if it was waiting for debugger to attach."
+ },
+ {
+ "name": "enable",
+ "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."
+ },
+ {
+ "name": "disable",
+ "description": "Disables reporting of execution contexts creation."
+ },
+ {
+ "name": "discardConsoleEntries",
+ "description": "Discards collected exceptions and console API calls."
+ },
+ {
+ "name": "setCustomObjectFormatterEnabled",
+ "parameters": [
+ {
+ "name": "enabled",
+ "type": "boolean"
+ }
+ ],
+ "experimental": true
+ },
+ {
+ "name": "compileScript",
+ "parameters": [
+ { "name": "expression", "type": "string", "description": "Expression to compile." },
+ { "name": "sourceURL", "type": "string", "description": "Source url to be set for the script." },
+ { "name": "persistScript", "type": "boolean", "description": "Specifies whether the compiled script should be persisted." },
+ { "name": "executionContextId", "$ref": "ExecutionContextId", "optional": true, "description": "Specifies in which execution context to perform script run. If the parameter is omitted the evaluation will be performed in the context of the inspected page." }
+ ],
+ "returns": [
+ { "name": "scriptId", "$ref": "ScriptId", "optional": true, "description": "Id of the script." },
+ { "name": "exceptionDetails", "$ref": "ExceptionDetails", "optional": true, "description": "Exception details."}
+ ],
+ "description": "Compiles expression."
+ },
+ {
+ "name": "runScript",
+ "parameters": [
+ { "name": "scriptId", "$ref": "ScriptId", "description": "Id of the script to run." },
+ { "name": "executionContextId", "$ref": "ExecutionContextId", "optional": true, "description": "Specifies in which execution context to perform script run. If the parameter is omitted the evaluation will be performed in the context of the inspected page." },
+ { "name": "objectGroup", "type": "string", "optional": true, "description": "Symbolic group name that can be used to release multiple objects." },
+ { "name": "silent", "type": "boolean", "optional": true, "description": "In silent mode exceptions thrown during evaluation are not reported and do not pause execution. Overrides <code>setPauseOnException</code> state." },
+ { "name": "includeCommandLineAPI", "type": "boolean", "optional": true, "description": "Determines whether Command Line API should be available during the evaluation." },
+ { "name": "returnByValue", "type": "boolean", "optional": true, "description": "Whether the result is expected to be a JSON object which should be sent by value." },
+ { "name": "generatePreview", "type": "boolean", "optional": true, "description": "Whether preview should be generated for the result." },
+ { "name": "awaitPromise", "type": "boolean", "optional": true, "description": "Whether execution should wait for promise to be resolved. If the result of evaluation is not a Promise, it's considered to be an error." }
+ ],
+ "returns": [
+ { "name": "result", "$ref": "RemoteObject", "description": "Run result." },
+ { "name": "exceptionDetails", "$ref": "ExceptionDetails", "optional": true, "description": "Exception details."}
+ ],
+ "description": "Runs script with given id in a given context."
+ }
+ ],
+ "events": [
+ {
+ "name": "executionContextCreated",
+ "parameters": [
+ { "name": "context", "$ref": "ExecutionContextDescription", "description": "A newly created execution contex." }
+ ],
+ "description": "Issued when new execution context is created."
+ },
+ {
+ "name": "executionContextDestroyed",
+ "parameters": [
+ { "name": "executionContextId", "$ref": "ExecutionContextId", "description": "Id of the destroyed context" }
+ ],
+ "description": "Issued when execution context is destroyed."
+ },
+ {
+ "name": "executionContextsCleared",
+ "description": "Issued when all executionContexts were cleared in browser"
+ },
+ {
+ "name": "exceptionThrown",
+ "description": "Issued when exception was thrown and unhandled.",
+ "parameters": [
+ { "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp of the exception." },
+ { "name": "exceptionDetails", "$ref": "ExceptionDetails" }
+ ]
+ },
+ {
+ "name": "exceptionRevoked",
+ "description": "Issued when unhandled exception was revoked.",
+ "parameters": [
+ { "name": "reason", "type": "string", "description": "Reason describing why exception was revoked." },
+ { "name": "exceptionId", "type": "integer", "description": "The id of revoked exception, as reported in <code>exceptionUnhandled</code>." }
+ ]
+ },
+ {
+ "name": "consoleAPICalled",
+ "description": "Issued when console API was called.",
+ "parameters": [
+ { "name": "type", "type": "string", "enum": ["log", "debug", "info", "error", "warning", "dir", "dirxml", "table", "trace", "clear", "startGroup", "startGroupCollapsed", "endGroup", "assert", "profile", "profileEnd", "count", "timeEnd"], "description": "Type of the call." },
+ { "name": "args", "type": "array", "items": { "$ref": "RemoteObject" }, "description": "Call arguments." },
+ { "name": "executionContextId", "$ref": "ExecutionContextId", "description": "Identifier of the context where the call was made." },
+ { "name": "timestamp", "$ref": "Timestamp", "description": "Call timestamp." },
+ { "name": "stackTrace", "$ref": "StackTrace", "optional": true, "description": "Stack trace captured when the call was made." }
+ ]
+ },
+ {
+ "name": "inspectRequested",
+ "description": "Issued when object should be inspected (for example, as a result of inspect() command line API call).",
+ "parameters": [
+ { "name": "object", "$ref": "RemoteObject" },
+ { "name": "hints", "type": "object" }
+ ]
+ }
+ ]
+ },
+ {
+ "domain": "Debugger",
+ "description": "Debugger domain exposes JavaScript debugging capabilities. It allows setting and removing breakpoints, stepping through execution, exploring stack traces, etc.",
+ "dependencies": ["Runtime"],
+ "types": [
+ {
+ "id": "BreakpointId",
+ "type": "string",
+ "description": "Breakpoint identifier."
+ },
+ {
+ "id": "CallFrameId",
+ "type": "string",
+ "description": "Call frame identifier."
+ },
+ {
+ "id": "Location",
+ "type": "object",
+ "properties": [
+ { "name": "scriptId", "$ref": "Runtime.ScriptId", "description": "Script identifier as reported in the <code>Debugger.scriptParsed</code>." },
+ { "name": "lineNumber", "type": "integer", "description": "Line number in the script (0-based)." },
+ { "name": "columnNumber", "type": "integer", "optional": true, "description": "Column number in the script (0-based)." }
+ ],
+ "description": "Location in the source code."
+ },
+ {
+ "id": "ScriptPosition",
+ "experimental": true,
+ "type": "object",
+ "properties": [
+ { "name": "lineNumber", "type": "integer" },
+ { "name": "columnNumber", "type": "integer" }
+ ],
+ "description": "Location in the source code."
+ },
+ {
+ "id": "CallFrame",
+ "type": "object",
+ "properties": [
+ { "name": "callFrameId", "$ref": "CallFrameId", "description": "Call frame identifier. This identifier is only valid while the virtual machine is paused." },
+ { "name": "functionName", "type": "string", "description": "Name of the JavaScript function called on this call frame." },
+ { "name": "functionLocation", "$ref": "Location", "optional": true, "experimental": true, "description": "Location in the source code." },
+ { "name": "location", "$ref": "Location", "description": "Location in the source code." },
+ { "name": "scopeChain", "type": "array", "items": { "$ref": "Scope" }, "description": "Scope chain for this call frame." },
+ { "name": "this", "$ref": "Runtime.RemoteObject", "description": "<code>this</code> object for this call frame." },
+ { "name": "returnValue", "$ref": "Runtime.RemoteObject", "optional": true, "description": "The value being returned, if the function is at return point." }
+ ],
+ "description": "JavaScript call frame. Array of call frames form the call stack."
+ },
+ {
+ "id": "Scope",
+ "type": "object",
+ "properties": [
+ { "name": "type", "type": "string", "enum": ["global", "local", "with", "closure", "catch", "block", "script", "eval", "module"], "description": "Scope type." },
+ { "name": "object", "$ref": "Runtime.RemoteObject", "description": "Object representing the scope. For <code>global</code> and <code>with</code> scopes it represents the actual object; for the rest of the scopes, it is artificial transient object enumerating scope variables as its properties." },
+ { "name": "name", "type": "string", "optional": true },
+ { "name": "startLocation", "$ref": "Location", "optional": true, "description": "Location in the source code where scope starts" },
+ { "name": "endLocation", "$ref": "Location", "optional": true, "description": "Location in the source code where scope ends" }
+ ],
+ "description": "Scope description."
+ },
+ {
+ "id": "SearchMatch",
+ "type": "object",
+ "description": "Search match for resource.",
+ "properties": [
+ { "name": "lineNumber", "type": "number", "description": "Line number in resource content." },
+ { "name": "lineContent", "type": "string", "description": "Line with match content." }
+ ],
+ "experimental": true
+ },
+ {
+ "id": "BreakLocation",
+ "type": "object",
+ "properties": [
+ { "name": "scriptId", "$ref": "Runtime.ScriptId", "description": "Script identifier as reported in the <code>Debugger.scriptParsed</code>." },
+ { "name": "lineNumber", "type": "integer", "description": "Line number in the script (0-based)." },
+ { "name": "columnNumber", "type": "integer", "optional": true, "description": "Column number in the script (0-based)." },
+ { "name": "type", "type": "string", "enum": [ "debuggerStatement", "call", "return" ], "optional": true }
+ ],
+ "experimental": true
+ }
+ ],
+ "commands": [
+ {
+ "name": "enable",
+ "description": "Enables debugger for the given page. Clients should not assume that the debugging has been enabled until the result for this command is received."
+ },
+ {
+ "name": "disable",
+ "description": "Disables debugger for given page."
+ },
+ {
+ "name": "setBreakpointsActive",
+ "parameters": [
+ { "name": "active", "type": "boolean", "description": "New value for breakpoints active state." }
+ ],
+ "description": "Activates / deactivates all breakpoints on the page."
+ },
+ {
+ "name": "setSkipAllPauses",
+ "parameters": [
+ { "name": "skip", "type": "boolean", "description": "New value for skip pauses state." }
+ ],
+ "description": "Makes page not interrupt on any pauses (breakpoint, exception, dom exception etc)."
+ },
+ {
+ "name": "setBreakpointByUrl",
+ "parameters": [
+ { "name": "lineNumber", "type": "integer", "description": "Line number to set breakpoint at." },
+ { "name": "url", "type": "string", "optional": true, "description": "URL of the resources to set breakpoint on." },
+ { "name": "urlRegex", "type": "string", "optional": true, "description": "Regex pattern for the URLs of the resources to set breakpoints on. Either <code>url</code> or <code>urlRegex</code> must be specified." },
+ { "name": "columnNumber", "type": "integer", "optional": true, "description": "Offset in the line to set breakpoint at." },
+ { "name": "condition", "type": "string", "optional": true, "description": "Expression to use as a breakpoint condition. When specified, debugger will only stop on the breakpoint if this expression evaluates to true." }
+ ],
+ "returns": [
+ { "name": "breakpointId", "$ref": "BreakpointId", "description": "Id of the created breakpoint for further reference." },
+ { "name": "locations", "type": "array", "items": { "$ref": "Location" }, "description": "List of the locations this breakpoint resolved into upon addition." }
+ ],
+ "description": "Sets JavaScript breakpoint at given location specified either by URL or URL regex. Once this command is issued, all existing parsed scripts will have breakpoints resolved and returned in <code>locations</code> property. Further matching script parsing will result in subsequent <code>breakpointResolved</code> events issued. This logical breakpoint will survive page reloads."
+ },
+ {
+ "name": "setBreakpoint",
+ "parameters": [
+ { "name": "location", "$ref": "Location", "description": "Location to set breakpoint in." },
+ { "name": "condition", "type": "string", "optional": true, "description": "Expression to use as a breakpoint condition. When specified, debugger will only stop on the breakpoint if this expression evaluates to true." }
+ ],
+ "returns": [
+ { "name": "breakpointId", "$ref": "BreakpointId", "description": "Id of the created breakpoint for further reference." },
+ { "name": "actualLocation", "$ref": "Location", "description": "Location this breakpoint resolved into." }
+ ],
+ "description": "Sets JavaScript breakpoint at a given location."
+ },
+ {
+ "name": "removeBreakpoint",
+ "parameters": [
+ { "name": "breakpointId", "$ref": "BreakpointId" }
+ ],
+ "description": "Removes JavaScript breakpoint."
+ },
+ {
+ "name": "getPossibleBreakpoints",
+ "parameters": [
+ { "name": "start", "$ref": "Location", "description": "Start of range to search possible breakpoint locations in." },
+ { "name": "end", "$ref": "Location", "optional": true, "description": "End of range to search possible breakpoint locations in (excluding). When not specifed, end of scripts is used as end of range." },
+ { "name": "restrictToFunction", "type": "boolean", "optional": true, "description": "Only consider locations which are in the same (non-nested) function as start." }
+ ],
+ "returns": [
+ { "name": "locations", "type": "array", "items": { "$ref": "BreakLocation" }, "description": "List of the possible breakpoint locations." }
+ ],
+ "description": "Returns possible locations for breakpoint. scriptId in start and end range locations should be the same.",
+ "experimental": true
+ },
+ {
+ "name": "continueToLocation",
+ "parameters": [
+ { "name": "location", "$ref": "Location", "description": "Location to continue to." }
+ ],
+ "description": "Continues execution until specific location is reached."
+ },
+ {
+ "name": "stepOver",
+ "description": "Steps over the statement."
+ },
+ {
+ "name": "stepInto",
+ "description": "Steps into the function call."
+ },
+ {
+ "name": "stepOut",
+ "description": "Steps out of the function call."
+ },
+ {
+ "name": "pause",
+ "description": "Stops on the next JavaScript statement."
+ },
+ {
+ "name": "scheduleStepIntoAsync",
+ "description": "Steps into next scheduled async task if any is scheduled before next pause. Returns success when async task is actually scheduled, returns error if no task were scheduled or another scheduleStepIntoAsync was called.",
+ "experimental": true
+ },
+ {
+ "name": "resume",
+ "description": "Resumes JavaScript execution."
+ },
+ {
+ "name": "searchInContent",
+ "parameters": [
+ { "name": "scriptId", "$ref": "Runtime.ScriptId", "description": "Id of the script to search in." },
+ { "name": "query", "type": "string", "description": "String to search for." },
+ { "name": "caseSensitive", "type": "boolean", "optional": true, "description": "If true, search is case sensitive." },
+ { "name": "isRegex", "type": "boolean", "optional": true, "description": "If true, treats string parameter as regex." }
+ ],
+ "returns": [
+ { "name": "result", "type": "array", "items": { "$ref": "SearchMatch" }, "description": "List of search matches." }
+ ],
+ "experimental": true,
+ "description": "Searches for given string in script content."
+ },
+ {
+ "name": "setScriptSource",
+ "parameters": [
+ { "name": "scriptId", "$ref": "Runtime.ScriptId", "description": "Id of the script to edit." },
+ { "name": "scriptSource", "type": "string", "description": "New content of the script." },
+ { "name": "dryRun", "type": "boolean", "optional": true, "description": " If true the change will not actually be applied. Dry run may be used to get result description without actually modifying the code." }
+ ],
+ "returns": [
+ { "name": "callFrames", "type": "array", "optional": true, "items": { "$ref": "CallFrame" }, "description": "New stack trace in case editing has happened while VM was stopped." },
+ { "name": "stackChanged", "type": "boolean", "optional": true, "description": "Whether current call stack was modified after applying the changes." },
+ { "name": "asyncStackTrace", "$ref": "Runtime.StackTrace", "optional": true, "description": "Async stack trace, if any." },
+ { "name": "exceptionDetails", "optional": true, "$ref": "Runtime.ExceptionDetails", "description": "Exception details if any." }
+ ],
+ "description": "Edits JavaScript source live."
+ },
+ {
+ "name": "restartFrame",
+ "parameters": [
+ { "name": "callFrameId", "$ref": "CallFrameId", "description": "Call frame identifier to evaluate on." }
+ ],
+ "returns": [
+ { "name": "callFrames", "type": "array", "items": { "$ref": "CallFrame" }, "description": "New stack trace." },
+ { "name": "asyncStackTrace", "$ref": "Runtime.StackTrace", "optional": true, "description": "Async stack trace, if any." }
+ ],
+ "description": "Restarts particular call frame from the beginning."
+ },
+ {
+ "name": "getScriptSource",
+ "parameters": [
+ { "name": "scriptId", "$ref": "Runtime.ScriptId", "description": "Id of the script to get source for." }
+ ],
+ "returns": [
+ { "name": "scriptSource", "type": "string", "description": "Script source." }
+ ],
+ "description": "Returns source for the script with given id."
+ },
+ {
+ "name": "setPauseOnExceptions",
+ "parameters": [
+ { "name": "state", "type": "string", "enum": ["none", "uncaught", "all"], "description": "Pause on exceptions mode." }
+ ],
+ "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>."
+ },
+ {
+ "name": "evaluateOnCallFrame",
+ "parameters": [
+ { "name": "callFrameId", "$ref": "CallFrameId", "description": "Call frame identifier to evaluate on." },
+ { "name": "expression", "type": "string", "description": "Expression to evaluate." },
+ { "name": "objectGroup", "type": "string", "optional": true, "description": "String object group name to put result into (allows rapid releasing resulting object handles using <code>releaseObjectGroup</code>)." },
+ { "name": "includeCommandLineAPI", "type": "boolean", "optional": true, "description": "Specifies whether command line API should be available to the evaluated expression, defaults to false." },
+ { "name": "silent", "type": "boolean", "optional": true, "description": "In silent mode exceptions thrown during evaluation are not reported and do not pause execution. Overrides <code>setPauseOnException</code> state." },
+ { "name": "returnByValue", "type": "boolean", "optional": true, "description": "Whether the result is expected to be a JSON object that should be sent by value." },
+ { "name": "generatePreview", "type": "boolean", "optional": true, "experimental": true, "description": "Whether preview should be generated for the result." },
+ { "name": "throwOnSideEffect", "type": "boolean", "optional": true, "experimental": true, "description": "Whether to throw an exception if side effect cannot be ruled out during evaluation." }
+ ],
+ "returns": [
+ { "name": "result", "$ref": "Runtime.RemoteObject", "description": "Object wrapper for the evaluation result." },
+ { "name": "exceptionDetails", "$ref": "Runtime.ExceptionDetails", "optional": true, "description": "Exception details."}
+ ],
+ "description": "Evaluates expression on a given call frame."
+ },
+ {
+ "name": "setVariableValue",
+ "parameters": [
+ { "name": "scopeNumber", "type": "integer", "description": "0-based number of scope as was listed in scope chain. Only 'local', 'closure' and 'catch' scope types are allowed. Other scopes could be manipulated manually." },
+ { "name": "variableName", "type": "string", "description": "Variable name." },
+ { "name": "newValue", "$ref": "Runtime.CallArgument", "description": "New variable value." },
+ { "name": "callFrameId", "$ref": "CallFrameId", "description": "Id of callframe that holds variable." }
+ ],
+ "description": "Changes value of variable in a callframe. Object-based scopes are not supported and must be mutated manually."
+ },
+ {
+ "name": "setAsyncCallStackDepth",
+ "parameters": [
+ { "name": "maxDepth", "type": "integer", "description": "Maximum depth of async call stacks. Setting to <code>0</code> will effectively disable collecting async call stacks (default)." }
+ ],
+ "description": "Enables or disables async call stacks tracking."
+ },
+ {
+ "name": "setBlackboxPatterns",
+ "parameters": [
+ { "name": "patterns", "type": "array", "items": { "type": "string" }, "description": "Array of regexps that will be used to check script url for blackbox state." }
+ ],
+ "experimental": true,
+ "description": "Replace previous blackbox patterns with passed ones. 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' several times, finally resorting to 'step out' if unsuccessful."
+ },
+ {
+ "name": "setBlackboxedRanges",
+ "parameters": [
+ { "name": "scriptId", "$ref": "Runtime.ScriptId", "description": "Id of the script." },
+ { "name": "positions", "type": "array", "items": { "$ref": "ScriptPosition" } }
+ ],
+ "experimental": true,
+ "description": "Makes backend skip steps in the script in blackboxed ranges. VM will try leave blacklisted scripts by performing 'step in' several times, finally resorting to 'step out' if unsuccessful. Positions array contains positions where blackbox state is changed. First interval isn't blackboxed. Array should be sorted."
+ }
+ ],
+ "events": [
+ {
+ "name": "scriptParsed",
+ "parameters": [
+ { "name": "scriptId", "$ref": "Runtime.ScriptId", "description": "Identifier of the script parsed." },
+ { "name": "url", "type": "string", "description": "URL or name of the script parsed (if any)." },
+ { "name": "startLine", "type": "integer", "description": "Line offset of the script within the resource with given URL (for script tags)." },
+ { "name": "startColumn", "type": "integer", "description": "Column offset of the script within the resource with given URL." },
+ { "name": "endLine", "type": "integer", "description": "Last line of the script." },
+ { "name": "endColumn", "type": "integer", "description": "Length of the last line of the script." },
+ { "name": "executionContextId", "$ref": "Runtime.ExecutionContextId", "description": "Specifies script creation context." },
+ { "name": "hash", "type": "string", "description": "Content hash of the script."},
+ { "name": "executionContextAuxData", "type": "object", "optional": true, "description": "Embedder-specific auxiliary data." },
+ { "name": "isLiveEdit", "type": "boolean", "optional": true, "description": "True, if this script is generated as a result of the live edit operation.", "experimental": true },
+ { "name": "sourceMapURL", "type": "string", "optional": true, "description": "URL of source map associated with script (if any)." },
+ { "name": "hasSourceURL", "type": "boolean", "optional": true, "description": "True, if this script has sourceURL.", "experimental": true },
+ { "name": "isModule", "type": "boolean", "optional": true, "description": "True, if this script is ES6 module.", "experimental": true },
+ { "name": "length", "type": "integer", "optional": true, "description": "This script length.", "experimental": true }
+ ],
+ "description": "Fired when virtual machine parses script. This event is also fired for all known and uncollected scripts upon enabling debugger."
+ },
+ {
+ "name": "scriptFailedToParse",
+ "parameters": [
+ { "name": "scriptId", "$ref": "Runtime.ScriptId", "description": "Identifier of the script parsed." },
+ { "name": "url", "type": "string", "description": "URL or name of the script parsed (if any)." },
+ { "name": "startLine", "type": "integer", "description": "Line offset of the script within the resource with given URL (for script tags)." },
+ { "name": "startColumn", "type": "integer", "description": "Column offset of the script within the resource with given URL." },
+ { "name": "endLine", "type": "integer", "description": "Last line of the script." },
+ { "name": "endColumn", "type": "integer", "description": "Length of the last line of the script." },
+ { "name": "executionContextId", "$ref": "Runtime.ExecutionContextId", "description": "Specifies script creation context." },
+ { "name": "hash", "type": "string", "description": "Content hash of the script."},
+ { "name": "executionContextAuxData", "type": "object", "optional": true, "description": "Embedder-specific auxiliary data." },
+ { "name": "sourceMapURL", "type": "string", "optional": true, "description": "URL of source map associated with script (if any)." },
+ { "name": "hasSourceURL", "type": "boolean", "optional": true, "description": "True, if this script has sourceURL.", "experimental": true },
+ { "name": "isModule", "type": "boolean", "optional": true, "description": "True, if this script is ES6 module.", "experimental": true },
+ { "name": "length", "type": "integer", "optional": true, "description": "This script length.", "experimental": true }
+ ],
+ "description": "Fired when virtual machine fails to parse the script."
+ },
+ {
+ "name": "breakpointResolved",
+ "parameters": [
+ { "name": "breakpointId", "$ref": "BreakpointId", "description": "Breakpoint unique identifier." },
+ { "name": "location", "$ref": "Location", "description": "Actual breakpoint location." }
+ ],
+ "description": "Fired when breakpoint is resolved to an actual script and location."
+ },
+ {
+ "name": "paused",
+ "parameters": [
+ { "name": "callFrames", "type": "array", "items": { "$ref": "CallFrame" }, "description": "Call stack the virtual machine stopped on." },
+ { "name": "reason", "type": "string", "enum": [ "XHR", "DOM", "EventListener", "exception", "assert", "debugCommand", "promiseRejection", "OOM", "other", "ambiguous" ], "description": "Pause reason." },
+ { "name": "data", "type": "object", "optional": true, "description": "Object containing break-specific auxiliary properties." },
+ { "name": "hitBreakpoints", "type": "array", "optional": true, "items": { "type": "string" }, "description": "Hit breakpoints IDs" },
+ { "name": "asyncStackTrace", "$ref": "Runtime.StackTrace", "optional": true, "description": "Async stack trace, if any." }
+ ],
+ "description": "Fired when the virtual machine stopped on breakpoint or exception or any other stop criteria."
+ },
+ {
+ "name": "resumed",
+ "description": "Fired when the virtual machine resumed execution."
+ }
+ ]
+ },
+ {
+ "domain": "Console",
+ "description": "This domain is deprecated - use Runtime or Log instead.",
+ "dependencies": ["Runtime"],
+ "deprecated": true,
+ "types": [
+ {
+ "id": "ConsoleMessage",
+ "type": "object",
+ "description": "Console message.",
+ "properties": [
+ { "name": "source", "type": "string", "enum": ["xml", "javascript", "network", "console-api", "storage", "appcache", "rendering", "security", "other", "deprecation", "worker"], "description": "Message source." },
+ { "name": "level", "type": "string", "enum": ["log", "warning", "error", "debug", "info"], "description": "Message severity." },
+ { "name": "text", "type": "string", "description": "Message text." },
+ { "name": "url", "type": "string", "optional": true, "description": "URL of the message origin." },
+ { "name": "line", "type": "integer", "optional": true, "description": "Line number in the resource that generated this message (1-based)." },
+ { "name": "column", "type": "integer", "optional": true, "description": "Column number in the resource that generated this message (1-based)." }
+ ]
+ }
+ ],
+ "commands": [
+ {
+ "name": "enable",
+ "description": "Enables console domain, sends the messages collected so far to the client by means of the <code>messageAdded</code> notification."
+ },
+ {
+ "name": "disable",
+ "description": "Disables console domain, prevents further console messages from being reported to the client."
+ },
+ {
+ "name": "clearMessages",
+ "description": "Does nothing."
+ }
+ ],
+ "events": [
+ {
+ "name": "messageAdded",
+ "parameters": [
+ { "name": "message", "$ref": "ConsoleMessage", "description": "Console message that has been added." }
+ ],
+ "description": "Issued when new console message is added."
+ }
+ ]
+ },
+ {
+ "domain": "Profiler",
+ "dependencies": ["Runtime", "Debugger"],
+ "types": [
+ {
+ "id": "ProfileNode",
+ "type": "object",
+ "description": "Profile node. Holds callsite information, execution statistics and child nodes.",
+ "properties": [
+ { "name": "id", "type": "integer", "description": "Unique id of the node." },
+ { "name": "callFrame", "$ref": "Runtime.CallFrame", "description": "Function location." },
+ { "name": "hitCount", "type": "integer", "optional": true, "experimental": true, "description": "Number of samples where this node was on top of the call stack." },
+ { "name": "children", "type": "array", "items": { "type": "integer" }, "optional": true, "description": "Child node ids." },
+ { "name": "deoptReason", "type": "string", "optional": true, "description": "The reason of being not optimized. The function may be deoptimized or marked as don't optimize."},
+ { "name": "positionTicks", "type": "array", "items": { "$ref": "PositionTickInfo" }, "optional": true, "experimental": true, "description": "An array of source position ticks." }
+ ]
+ },
+ {
+ "id": "Profile",
+ "type": "object",
+ "description": "Profile.",
+ "properties": [
+ { "name": "nodes", "type": "array", "items": { "$ref": "ProfileNode" }, "description": "The list of profile nodes. First item is the root node." },
+ { "name": "startTime", "type": "number", "description": "Profiling start timestamp in microseconds." },
+ { "name": "endTime", "type": "number", "description": "Profiling end timestamp in microseconds." },
+ { "name": "samples", "optional": true, "type": "array", "items": { "type": "integer" }, "description": "Ids of samples top nodes." },
+ { "name": "timeDeltas", "optional": true, "type": "array", "items": { "type": "integer" }, "description": "Time intervals between adjacent samples in microseconds. The first delta is relative to the profile startTime." }
+ ]
+ },
+ {
+ "id": "PositionTickInfo",
+ "type": "object",
+ "experimental": true,
+ "description": "Specifies a number of samples attributed to a certain source position.",
+ "properties": [
+ { "name": "line", "type": "integer", "description": "Source line number (1-based)." },
+ { "name": "ticks", "type": "integer", "description": "Number of samples attributed to the source line." }
+ ]
+ },
+ { "id": "CoverageRange",
+ "type": "object",
+ "description": "Coverage data for a source range.",
+ "properties": [
+ { "name": "startLineNumber", "type": "integer", "description": "JavaScript script line number (0-based) for the range start." },
+ { "name": "startColumnNumber", "type": "integer", "description": "JavaScript script column number (0-based) for the range start." },
+ { "name": "endLineNumber", "type": "integer", "description": "JavaScript script line number (0-based) for the range end." },
+ { "name": "endColumnNumber", "type": "integer", "description": "JavaScript script column number (0-based) for the range end." },
+ { "name": "startOffset", "type": "integer", "description": "JavaScript script source offset for the range start." },
+ { "name": "endOffset", "type": "integer", "description": "JavaScript script source offset for the range end." },
+ { "name": "count", "type": "integer", "description": "Collected execution count of the source range." }
+ ],
+ "experimental": true
+ },
+ { "id": "FunctionCoverage",
+ "type": "object",
+ "description": "Coverage data for a JavaScript function.",
+ "properties": [
+ { "name": "functionName", "type": "string", "description": "JavaScript function name." },
+ { "name": "ranges", "type": "array", "items": { "$ref": "CoverageRange" }, "description": "Source ranges inside the function with coverage data." }
+ ],
+ "experimental": true
+ },
+ {
+ "id": "ScriptCoverage",
+ "type": "object",
+ "description": "Coverage data for a JavaScript script.",
+ "properties": [
+ { "name": "scriptId", "$ref": "Runtime.ScriptId", "description": "JavaScript script id." },
+ { "name": "url", "type": "string", "description": "JavaScript script name or url." },
+ { "name": "functions", "type": "array", "items": { "$ref": "FunctionCoverage" }, "description": "Functions contained in the script that has coverage data." }
+ ],
+ "experimental": true
+ }
+ ],
+ "commands": [
+ {
+ "name": "enable"
+ },
+ {
+ "name": "disable"
+ },
+ {
+ "name": "setSamplingInterval",
+ "parameters": [
+ { "name": "interval", "type": "integer", "description": "New sampling interval in microseconds." }
+ ],
+ "description": "Changes CPU profiler sampling interval. Must be called before CPU profiles recording started."
+ },
+ {
+ "name": "start"
+ },
+ {
+ "name": "stop",
+ "returns": [
+ { "name": "profile", "$ref": "Profile", "description": "Recorded profile." }
+ ]
+ },
+ {
+ "name": "startPreciseCoverage",
+ "description": "Enable precise code coverage. Coverage data for JavaScript executed before enabling precise code coverage may be incomplete. Enabling prevents running optimized code and resets execution counters.",
+ "experimental": true
+ },
+ {
+ "name": "stopPreciseCoverage",
+ "description": "Disable precise code coverage. Disabling releases unnecessary execution count records and allows executing optimized code.",
+ "experimental": true
+ },
+ {
+ "name": "takePreciseCoverage",
+ "returns": [
+ { "name": "result", "type": "array", "items": { "$ref": "ScriptCoverage" }, "description": "Coverage data for the current isolate." }
+ ],
+ "description": "Collect coverage data for the current isolate, and resets execution counters. Precise code coverage needs to have started.",
+ "experimental": true
+ },
+ {
+ "name": "getBestEffortCoverage",
+ "returns": [
+ { "name": "result", "type": "array", "items": { "$ref": "ScriptCoverage" }, "description": "Coverage data for the current isolate." }
+ ],
+ "description": "Collect coverage data for the current isolate. The coverage data may be incomplete due to garbage collection.",
+ "experimental": true
+ }
+ ],
+ "events": [
+ {
+ "name": "consoleProfileStarted",
+ "parameters": [
+ { "name": "id", "type": "string" },
+ { "name": "location", "$ref": "Debugger.Location", "description": "Location of console.profile()." },
+ { "name": "title", "type": "string", "optional": true, "description": "Profile title passed as an argument to console.profile()." }
+ ],
+ "description": "Sent when new profile recodring is started using console.profile() call."
+ },
+ {
+ "name": "consoleProfileFinished",
+ "parameters": [
+ { "name": "id", "type": "string" },
+ { "name": "location", "$ref": "Debugger.Location", "description": "Location of console.profileEnd()." },
+ { "name": "profile", "$ref": "Profile" },
+ { "name": "title", "type": "string", "optional": true, "description": "Profile title passed as an argument to console.profile()." }
+ ]
+ }
+ ]
+ },
+ {
+ "domain": "HeapProfiler",
+ "dependencies": ["Runtime"],
+ "experimental": true,
+ "types": [
+ {
+ "id": "HeapSnapshotObjectId",
+ "type": "string",
+ "description": "Heap snapshot object id."
+ },
+ {
+ "id": "SamplingHeapProfileNode",
+ "type": "object",
+ "description": "Sampling Heap Profile node. Holds callsite information, allocation statistics and child nodes.",
+ "properties": [
+ { "name": "callFrame", "$ref": "Runtime.CallFrame", "description": "Function location." },
+ { "name": "selfSize", "type": "number", "description": "Allocations size in bytes for the node excluding children." },
+ { "name": "children", "type": "array", "items": { "$ref": "SamplingHeapProfileNode" }, "description": "Child nodes." }
+ ]
+ },
+ {
+ "id": "SamplingHeapProfile",
+ "type": "object",
+ "description": "Profile.",
+ "properties": [
+ { "name": "head", "$ref": "SamplingHeapProfileNode" }
+ ]
+ }
+ ],
+ "commands": [
+ {
+ "name": "enable"
+ },
+ {
+ "name": "disable"
+ },
+ {
+ "name": "startTrackingHeapObjects",
+ "parameters": [
+ { "name": "trackAllocations", "type": "boolean", "optional": true }
+ ]
+ },
+ {
+ "name": "stopTrackingHeapObjects",
+ "parameters": [
+ { "name": "reportProgress", "type": "boolean", "optional": true, "description": "If true 'reportHeapSnapshotProgress' events will be generated while snapshot is being taken when the tracking is stopped." }
+ ]
+ },
+ {
+ "name": "takeHeapSnapshot",
+ "parameters": [
+ { "name": "reportProgress", "type": "boolean", "optional": true, "description": "If true 'reportHeapSnapshotProgress' events will be generated while snapshot is being taken." }
+ ]
+ },
+ {
+ "name": "collectGarbage"
+ },
+ {
+ "name": "getObjectByHeapObjectId",
+ "parameters": [
+ { "name": "objectId", "$ref": "HeapSnapshotObjectId" },
+ { "name": "objectGroup", "type": "string", "optional": true, "description": "Symbolic group name that can be used to release multiple objects." }
+ ],
+ "returns": [
+ { "name": "result", "$ref": "Runtime.RemoteObject", "description": "Evaluation result." }
+ ]
+ },
+ {
+ "name": "addInspectedHeapObject",
+ "parameters": [
+ { "name": "heapObjectId", "$ref": "HeapSnapshotObjectId", "description": "Heap snapshot object id to be accessible by means of $x command line API." }
+ ],
+ "description": "Enables console to refer to the node with given id via $x (see Command Line API for more details $x functions)."
+ },
+ {
+ "name": "getHeapObjectId",
+ "parameters": [
+ { "name": "objectId", "$ref": "Runtime.RemoteObjectId", "description": "Identifier of the object to get heap object id for." }
+ ],
+ "returns": [
+ { "name": "heapSnapshotObjectId", "$ref": "HeapSnapshotObjectId", "description": "Id of the heap snapshot object corresponding to the passed remote object id." }
+ ]
+ },
+ {
+ "name": "startSampling",
+ "parameters": [
+ { "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." }
+ ]
+ },
+ {
+ "name": "stopSampling",
+ "returns": [
+ { "name": "profile", "$ref": "SamplingHeapProfile", "description": "Recorded sampling heap profile." }
+ ]
+ }
+ ],
+ "events": [
+ {
+ "name": "addHeapSnapshotChunk",
+ "parameters": [
+ { "name": "chunk", "type": "string" }
+ ]
+ },
+ {
+ "name": "resetProfiles"
+ },
+ {
+ "name": "reportHeapSnapshotProgress",
+ "parameters": [
+ { "name": "done", "type": "integer" },
+ { "name": "total", "type": "integer" },
+ { "name": "finished", "type": "boolean", "optional": true }
+ ]
+ },
+ {
+ "name": "lastSeenObjectId",
+ "description": "If heap objects tracking has been started then backend regulary sends a current value for last seen object id and corresponding timestamp. If the were changes in the heap since last event then one or more heapStatsUpdate events will be sent before a new lastSeenObjectId event.",
+ "parameters": [
+ { "name": "lastSeenObjectId", "type": "integer" },
+ { "name": "timestamp", "type": "number" }
+ ]
+ },
+ {
+ "name": "heapStatsUpdate",
+ "description": "If heap objects tracking has been started then backend may send update for one or more fragments",
+ "parameters": [
+ { "name": "statsUpdate", "type": "array", "items": { "type": "integer" }, "description": "An array of triplets. Each triplet describes a fragment. The first integer is the fragment index, the second integer is a total count of objects for the fragment, the third integer is a total size of the objects for the fragment."}
+ ]
+ }
+ ]
+ }]
+}
\ No newline at end of file
--
GitLab