"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":"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)."
"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",
"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.",
"experimental":true
},
{
"name":"navigateToHistoryEntry",
"parameters":[
{
"name":"entryId",
"type":"integer",
"description":"Unique id of the entry to navigate to."
}
],
"description":"Navigates current page to the given history entry.",
"experimental":true
},
{
"name":"getCookies",
"returns":[
{
"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.",
"experimental":true,
"redirect":"Network"
},
{
"name":"deleteCookie",
"parameters":[
{
"name":"cookieName",
"type":"string",
"description":"Name of the cookie to remove."
},
{
"name":"url",
"type":"string",
"description":"URL to match cooke domain and path."
}
],
"description":"Deletes browser cookie with given name, domain and path.",
"experimental":true,
"redirect":"Network"
},
{
"name":"getResourceTree",
"description":"Returns present frame / resource tree structure.",
"returns":[
{
"name":"frameTree",
"$ref":"FrameResourceTree",
"description":"Present frame / resource tree structure."
}
],
"experimental":true
},
{
"name":"getResourceContent",
"description":"Returns content of the given resource.",
"parameters":[
{
"name":"frameId",
"$ref":"FrameId",
"description":"Frame id to get resource for."
},
{
"name":"url",
"type":"string",
"description":"URL of the resource to get content for."
}
],
"returns":[
{
"name":"content",
"type":"string",
"description":"Resource content."
},
{
"name":"base64Encoded",
"type":"boolean",
"description":"True, if content was served as base64."
}
],
"experimental":true
},
{
"name":"searchInResource",
"description":"Searches for given string in resource content.",
"parameters":[
{
"name":"frameId",
"$ref":"FrameId",
"description":"Frame id for resource to search in."
},
{
"name":"url",
"type":"string",
"description":"URL of the resource 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":"Debugger.SearchMatch"
},
"description":"List of search matches."
}
],
"experimental":true
},
{
"name":"setDocumentContent",
"description":"Sets given markup as the document's HTML.",
"parameters":[
{
"name":"frameId",
"$ref":"FrameId",
"description":"Frame id to set HTML for."
},
{
"name":"html",
"type":"string",
"description":"HTML content to set."
}
],
"experimental":true
},
{
"name":"setDeviceMetricsOverride",
"description":"Overrides the values of device screen dimensions (window.screen.width, window.screen.height, window.innerWidth, window.innerHeight, and \"device-width\"/\"device-height\"-related CSS media query results).",
"parameters":[
{
"name":"width",
"type":"integer",
"description":"Overriding width value in pixels (minimum 0, maximum 10000000). 0 disables the override."
},
{
"name":"height",
"type":"integer",
"description":"Overriding height value in pixels (minimum 0, maximum 10000000). 0 disables the override."
},
{
"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."
},
{
"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."
}
],
"redirect":"Emulation",
"experimental":true
},
{
"name":"clearDeviceMetricsOverride",
"description":"Clears the overriden device metrics.",
"redirect":"Emulation",
"experimental":true
},
{
"name":"setGeolocationOverride",
"description":"Overrides the Geolocation Position or Error. Omitting any of the parameters emulates position unavailable.",
"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"
}
],
"redirect":"Emulation"
},
{
"name":"clearGeolocationOverride",
"description":"Clears the overriden Geolocation Position and Error.",
"redirect":"Emulation"
},
{
"name":"setDeviceOrientationOverride",
"description":"Overrides the Device Orientation.",
"parameters":[
{
"name":"alpha",
"type":"number",
"description":"Mock alpha"
},
{
"name":"beta",
"type":"number",
"description":"Mock beta"
},
{
"name":"gamma",
"type":"number",
"description":"Mock gamma"
}
],
"redirect":"DeviceOrientation",
"experimental":true
},
{
"name":"clearDeviceOrientationOverride",
"description":"Clears the overridden Device Orientation.",
"redirect":"DeviceOrientation",
"experimental":true
},
{
"name":"setTouchEmulationEnabled",
"parameters":[
{
"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":"Fired once navigation of the frame has completed. Frame is now associated with the new loader.",
"parameters":[
{
"name":"frame",
"$ref":"Frame",
"description":"Frame object."
}
]
},
{
"name":"frameDetached",
"description":"Fired when frame has been detached from its parent.",
"parameters":[
{
"name":"frameId",
"$ref":"FrameId",
"description":"Id of the frame that has been detached."
}
]
},
{
"name":"frameStartedLoading",
"description":"Fired when frame has started loading.",
"parameters":[
{
"name":"frameId",
"$ref":"FrameId",
"description":"Id of the frame that has started loading."
}
],
"experimental":true
},
{
"name":"frameStoppedLoading",
"description":"Fired when frame has stopped loading.",
"parameters":[
{
"name":"frameId",
"$ref":"FrameId",
"description":"Id of the frame that has stopped loading."
}
],
"experimental":true
},
{
"name":"frameScheduledNavigation",
"description":"Fired when frame schedules a potential navigation.",
"parameters":[
{
"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."
}
],
"experimental":true
},
{
"name":"frameClearedScheduledNavigation",
"description":"Fired when frame no longer has a scheduled navigation.",
"parameters":[
{
"name":"frameId",
"$ref":"FrameId",
"description":"Id of the frame that has cleared its scheduled navigation."
}
],
"experimental":true
},
{
"name":"frameResized",
"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."
},
{
"name":"type",
"$ref":"DialogType",
"description":"Dialog type."
}
]
},
{
"name":"javascriptDialogClosed",
"description":"Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) has been closed.",
"parameters":[
{
"name":"result",
"type":"boolean",
"description":"Whether dialog was confirmed."
}
]
},
{
"name":"screencastFrame",
"description":"Compressed image data requested by the <code>startScreencast</code>.",
"parameters":[
{
"name":"data",
"type":"string",
"description":"Base64-encoded compressed image."
},
{
"name":"metadata",
"$ref":"ScreencastFrameMetadata",
"description":"Screencast frame metadata."
},
{
"name":"sessionId",
"type":"integer",
"description":"Frame number."
}
],
"experimental":true
},
{
"name":"screencastVisibilityChanged",
"description":"Fired when the page with currently enabled screencast was shown or hidden </code>.",
"parameters":[
{
"name":"visible",
"type":"boolean",
"description":"True if the page is visible."
}
],
"experimental":true
},
{
"name":"interstitialShown",
"description":"Fired when interstitial page was shown"
},
{
"name":"interstitialHidden",
"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."
"description":"True for showing scroll bottleneck rects"
}
]
},
{
"name":"setShowViewportSizeOnResize",
"description":"Paints viewport size upon main frame resize.",
"parameters":[
{
"name":"show",
"type":"boolean",
"description":"Whether to paint size or not."
}
]
},
{
"name":"setPausedInDebuggerMessage",
"parameters":[
{
"name":"message",
"type":"string",
"optional":true,
"description":"The message to display, also triggers resume and step over controls."
}
]
},
{
"name":"setSuspended",
"parameters":[
{
"name":"suspended",
"type":"boolean",
"description":"Whether overlay should be suspended and not consume any resources until resumed."
}
]
},
{
"name":"setInspectMode",
"description":"Enters the 'inspect' mode. In this mode, elements that user is hovering over are highlighted. Backend then generates 'inspectNodeRequested' event upon element selection.",
"parameters":[
{
"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>."
}
]
},
{
"name":"highlightRect",
"description":"Highlights given rectangle. Coordinates are absolute with respect to the main frame viewport.",
"parameters":[
{
"name":"x",
"type":"integer",
"description":"X coordinate"
},
{
"name":"y",
"type":"integer",
"description":"Y coordinate"
},
{
"name":"width",
"type":"integer",
"description":"Rectangle width"
},
{
"name":"height",
"type":"integer",
"description":"Rectangle height"
},
{
"name":"color",
"$ref":"DOM.RGBA",
"optional":true,
"description":"The highlight fill color (default: transparent)."
},
{
"name":"outlineColor",
"$ref":"DOM.RGBA",
"optional":true,
"description":"The highlight outline color (default: transparent)."
}
]
},
{
"name":"highlightQuad",
"description":"Highlights given quad. Coordinates are absolute with respect to the main frame viewport.",
"parameters":[
{
"name":"quad",
"$ref":"DOM.Quad",
"description":"Quad to highlight"
},
{
"name":"color",
"$ref":"DOM.RGBA",
"optional":true,
"description":"The highlight fill color (default: transparent)."
},
{
"name":"outlineColor",
"$ref":"DOM.RGBA",
"optional":true,
"description":"The highlight outline color (default: transparent)."
}
]
},
{
"name":"highlightNode",
"description":"Highlights DOM node with given id or with the given JavaScript object wrapper. Either nodeId or objectId must be specified.",
"parameters":[
{
"name":"highlightConfig",
"$ref":"HighlightConfig",
"description":"A descriptor for the highlight appearance."
},
{
"name":"nodeId",
"$ref":"DOM.NodeId",
"optional":true,
"description":"Identifier of the node to highlight."
},
{
"name":"backendNodeId",
"$ref":"DOM.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."
}
]
},
{
"name":"highlightFrame",
"description":"Highlights owner element of the frame with given id.",
"parameters":[
{
"name":"frameId",
"$ref":"Page.FrameId",
"description":"Identifier of the frame to highlight."
},
{
"name":"contentColor",
"$ref":"DOM.RGBA",
"optional":true,
"description":"The content box highlight fill color (default: transparent)."
},
{
"name":"contentOutlineColor",
"$ref":"DOM.RGBA",
"optional":true,
"description":"The content box highlight outline color (default: transparent)."
}
]
},
{
"name":"hideHighlight",
"description":"Hides any highlight."
},
{
"name":"getHighlightObjectForTest",
"description":"For testing.",
"parameters":[
{
"name":"nodeId",
"$ref":"DOM.NodeId",
"description":"Id of the node to get highlight object for."
}
],
"returns":[
{
"name":"highlight",
"type":"object",
"description":"Highlight data for the node."
}
]
}
],
"events":[
{
"name":"nodeHighlightRequested",
"description":"Fired when the node should be highlighted. This happens after call to <code>setInspectMode</code>.",
"description":"Fired when the node should be inspected. This happens after call to <code>setInspectMode</code> or when user manually inspects an element.",
"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":[
{
"name":"setDeviceMetricsOverride",
"description":"Overrides the values of device screen dimensions (window.screen.width, window.screen.height, window.innerWidth, window.innerHeight, and \"device-width\"/\"device-height\"-related CSS media query results).",
"parameters":[
{
"name":"width",
"type":"integer",
"description":"Overriding width value in pixels (minimum 0, maximum 10000000). 0 disables the override."
},
{
"name":"height",
"type":"integer",
"description":"Overriding height value in pixels (minimum 0, maximum 10000000). 0 disables the override."
},
{
"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,
"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."
},
{
"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":"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."
}
]
},
{
"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"
}
]
},
{
"name":"clearGeolocationOverride",
"description":"Clears the overriden Geolocation Position and Error.",
"experimental":true
},
{
"name":"setTouchEmulationEnabled",
"parameters":[
{
"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":"Media type to emulate. Empty string disables the override."
}
],
"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."
}
],
"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."
"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."
"description":"Handles a certificate error that fired a certificateError event.",
"parameters":[
{
"name":"eventId",
"type":"integer",
"description":"The ID of the event."
},
{
"name":"action",
"$ref":"CertificateErrorAction",
"description":"The action to take on the certificate error."
}
]
},
{
"name":"setOverrideCertificateErrors",
"description":"Enable/disable overriding certificate errors. If enabled, all certificate error events need to be handled by the DevTools client and should be answered with handleCertificateError commands.",
"parameters":[
{
"name":"override",
"type":"boolean",
"description":"If true, certificate errors will be overridden."
"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.",
"description":"There is a certificate error. If overriding certificate errors is enabled, then it should be handled with the handleCertificateError command. Note: this event does not fire if the certificate error has been allowed internally.",
"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.",
"description":"Authorization challenge for HTTP status code 401 or 407.",
"properties":[
{
"name":"source",
"type":"string",
"optional":true,
"enum":[
"Server",
"Proxy"
],
"description":"Source of the authentication challenge."
},
{
"name":"origin",
"type":"string",
"description":"Origin of the challenger."
},
{
"name":"scheme",
"type":"string",
"description":"The authentication scheme used, such as basic or digest"
},
{
"name":"realm",
"type":"string",
"description":"The realm of the challenge. May be empty."
}
],
"experimental":true
},
{
"id":"AuthChallengeResponse",
"type":"object",
"description":"Response to an AuthChallenge.",
"properties":[
{
"name":"response",
"type":"string",
"enum":[
"Default",
"CancelAuth",
"ProvideCredentials"
],
"description":"The decision on what to do in response to the authorization challenge. Default means deferring to the default behavior of the net stack, which will likely either the Cancel authentication or display a popup dialog box."
},
{
"name":"username",
"type":"string",
"optional":true,
"description":"The username to provide, possibly empty. Should only be set if response is ProvideCredentials."
},
{
"name":"password",
"type":"string",
"optional":true,
"description":"The password to provide, possibly empty. Should only be set if response is ProvideCredentials."
"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."
}
],
"experimental":true
},
{
"name":"canClearBrowserCache",
"description":"Tells whether clearing browser cache is supported.",
"returns":[
{
"name":"result",
"type":"boolean",
"description":"True if browser cache can be cleared."
}
]
},
{
"name":"clearBrowserCache",
"description":"Clears browser cache."
},
{
"name":"canClearBrowserCookies",
"description":"Tells whether clearing browser cookies is supported.",
"returns":[
{
"name":"result",
"type":"boolean",
"description":"True if browser cookies can be cleared."
"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.",
"experimental":true
},
{
"name":"deleteCookie",
"parameters":[
{
"name":"cookieName",
"type":"string",
"description":"Name of the cookie to remove."
},
{
"name":"url",
"type":"string",
"description":"URL to match cooke domain and path."
}
],
"description":"Deletes browser cookie with given name, domain and path.",
"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",
"description":"Tells whether emulation of network conditions is supported.",
"returns":[
{
"name":"result",
"type":"boolean",
"description":"True if emulation of network conditions is supported."
}
],
"experimental":true
},
{
"name":"emulateNetworkConditions",
"description":"Activates emulation of network conditions.",
"parameters":[
{
"name":"offline",
"type":"boolean",
"description":"True to emulate internet disconnection."
"description":"Whether or not HTTP requests should be intercepted and Network.requestIntercepted events sent."
}
],
"experimental":true
},
{
"name":"continueInterceptedRequest",
"description":"Response to Network.requestIntercepted which either modifies the request to continue with any modifications, or blocks it, or completes it with the provided response bytes. If a network fetch occurs as a result which encounters a redirect an additional Network.requestIntercepted event will be sent with the same InterceptionId.",
"description":"If set the requests completes using with the provided base64 encoded raw response, including HTTP status line and headers etc... Must not be set in response to an authChallenge."
"description":"Each request the page makes will have a unique id, however if any redirects are encountered while processing that fetch, they will be reported with the same id as the original fetch. Likewise if HTTP authentication is needed then the same fetch id will be used."
"description":"Details of the Authorization Challenge encountered. If this is set then continueInterceptedRequest must contain an authChallengeResponse."
"description":"Identifier of the frame containing document whose manifest is retrieved."
}
],
"returns":[
{
"name":"manifestURL",
"type":"string",
"description":"Manifest URL for document in the given frame."
}
],
"description":"Returns manifest URL for document in the given frame."
},
{
"name":"getApplicationCacheForFrame",
"parameters":[
{
"name":"frameId",
"$ref":"Page.FrameId",
"description":"Identifier of the frame containing document whose application cache is retrieved."
}
],
"returns":[
{
"name":"applicationCache",
"$ref":"ApplicationCache",
"description":"Relevant application cache data for the document in given frame."
}
],
"description":"Returns relevant application cache data for the document in given frame."
}
],
"events":[
{
"name":"applicationCacheStatusUpdated",
"parameters":[
{
"name":"frameId",
"$ref":"Page.FrameId",
"description":"Identifier of the frame containing document whose application cache updated status."
},
{
"name":"manifestURL",
"type":"string",
"description":"Manifest URL."
},
{
"name":"status",
"type":"integer",
"description":"Updated application cache status."
}
]
},
{
"name":"networkStateUpdated",
"parameters":[
{
"name":"isNowOnline",
"type":"boolean"
}
]
}
]
},
{
"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":"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.",
"experimental":true
},
{
"id":"BackendNode",
"type":"object",
"properties":[
{
"name":"nodeType",
"type":"integer",
"description":"<code>Node</code>'s nodeType."
},
{
"name":"nodeName",
"type":"string",
"description":"<code>Node</code>'s nodeName."
},
{
"name":"backendNodeId",
"$ref":"BackendNodeId"
}
],
"experimental":true,
"description":"Backend node with a friendly name."
},
{
"id":"PseudoType",
"type":"string",
"enum":[
"first-line",
"first-letter",
"before",
"after",
"backdrop",
"selection",
"first-line-inherited",
"scrollbar",
"scrollbar-thumb",
"scrollbar-button",
"scrollbar-track",
"scrollbar-track-piece",
"scrollbar-corner",
"resizer",
"input-list-button"
],
"description":"Pseudo element type."
},
{
"id":"ShadowRootType",
"type":"string",
"enum":[
"user-agent",
"open",
"closed"
],
"description":"Shadow root type."
},
{
"id":"Node",
"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."
"description":"<code>Document</code>'s XML version in case of XML documents."
},
{
"name":"name",
"type":"string",
"optional":true,
"description":"<code>Attr</code>'s name."
},
{
"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.",
"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.",
"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.",
"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."
},
{
"id":"RGBA",
"type":"object",
"properties":[
{
"name":"r",
"type":"integer",
"description":"The red component, in the [0-255] range."
},
{
"name":"g",
"type":"integer",
"description":"The green component, in the [0-255] range."
},
{
"name":"b",
"type":"integer",
"description":"The blue component, in the [0-255] range."
},
{
"name":"a",
"type":"number",
"optional":true,
"description":"The alpha component, in the [0-1] range (default: 1)."
}
],
"description":"A structure holding an RGBA color."
},
{
"id":"Quad",
"type":"array",
"items":{
"type":"number"
},
"minItems":8,
"maxItems":8,
"description":"An array of quad vertices, x immediately followed by y for each point, points clock-wise.",
"experimental":true
},
{
"id":"BoxModel",
"type":"object",
"experimental":true,
"properties":[
{
"name":"content",
"$ref":"Quad",
"description":"Content box"
},
{
"name":"padding",
"$ref":"Quad",
"description":"Padding box"
},
{
"name":"border",
"$ref":"Quad",
"description":"Border box"
},
{
"name":"margin",
"$ref":"Quad",
"description":"Margin box"
},
{
"name":"width",
"type":"integer",
"description":"Node width"
},
{
"name":"height",
"type":"integer",
"description":"Node height"
},
{
"name":"shapeOutside",
"$ref":"ShapeOutsideInfo",
"optional":true,
"description":"Shape outside coordinates"
}
],
"description":"Box model."
},
{
"id":"ShapeOutsideInfo",
"type":"object",
"experimental":true,
"properties":[
{
"name":"bounds",
"$ref":"Quad",
"description":"Shape bounds"
},
{
"name":"shape",
"type":"array",
"items":{
"type":"any"
},
"description":"Shape coordinate details"
},
{
"name":"marginShape",
"type":"array",
"items":{
"type":"any"
},
"description":"Margin shape bounds"
}
],
"description":"CSS Shape Outside details."
},
{
"id":"Rect",
"type":"object",
"experimental":true,
"properties":[
{
"name":"x",
"type":"number",
"description":"X coordinate"
},
{
"name":"y",
"type":"number",
"description":"Y coordinate"
},
{
"name":"width",
"type":"number",
"description":"Rectangle width"
},
{
"name":"height",
"type":"number",
"description":"Rectangle height"
}
],
"description":"Rectangle."
}
],
"commands":[
{
"name":"enable",
"description":"Enables DOM agent for the given page."
},
{
"name":"disable",
"description":"Disables DOM agent for the given page."
},
{
"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 (and optionally the subtree) to the caller."
"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."
"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.",
"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."
},
{
"name":"querySelector",
"parameters":[
{
"name":"nodeId",
"$ref":"NodeId",
"description":"Id of the node to query upon."
},
{
"name":"selector",
"type":"string",
"description":"Selector string."
}
],
"returns":[
{
"name":"nodeId",
"$ref":"NodeId",
"description":"Query selector result."
}
],
"description":"Executes <code>querySelector</code> on a given node."
},
{
"name":"querySelectorAll",
"parameters":[
{
"name":"nodeId",
"$ref":"NodeId",
"description":"Id of the node to query upon."
},
{
"name":"selector",
"type":"string",
"description":"Selector string."
}
],
"returns":[
{
"name":"nodeIds",
"type":"array",
"items":{
"$ref":"NodeId"
},
"description":"Query selector result."
}
],
"description":"Executes <code>querySelectorAll</code> on a given node."
},
{
"name":"setNodeName",
"parameters":[
{
"name":"nodeId",
"$ref":"NodeId",
"description":"Id of the node to set name for."
},
{
"name":"name",
"type":"string",
"description":"New node's name."
}
],
"returns":[
{
"name":"nodeId",
"$ref":"NodeId",
"description":"New node's id."
}
],
"description":"Sets node name for a node with given id."
},
{
"name":"setNodeValue",
"parameters":[
{
"name":"nodeId",
"$ref":"NodeId",
"description":"Id of the node to set value for."
},
{
"name":"value",
"type":"string",
"description":"New node's value."
}
],
"description":"Sets node value for a node with given id."
},
{
"name":"removeNode",
"parameters":[
{
"name":"nodeId",
"$ref":"NodeId",
"description":"Id of the node to remove."
}
],
"description":"Removes node with given id."
},
{
"name":"setAttributeValue",
"parameters":[
{
"name":"nodeId",
"$ref":"NodeId",
"description":"Id of the element to set attribute for."
},
{
"name":"name",
"type":"string",
"description":"Attribute name."
},
{
"name":"value",
"type":"string",
"description":"Attribute value."
}
],
"description":"Sets attribute for an element with given id."
},
{
"name":"setAttributesAsText",
"parameters":[
{
"name":"nodeId",
"$ref":"NodeId",
"description":"Id of the element to set attributes for."
},
{
"name":"text",
"type":"string",
"description":"Text with a number of attributes. Will parse this text using HTML parser."
},
{
"name":"name",
"type":"string",
"optional":true,
"description":"Attribute name to replace with new attributes derived from text in case text parsed successfully."
}
],
"description":"Sets attributes on element with given id. This method is useful when user edits some existing attribute value and types in several attribute name/value pairs."
},
{
"name":"removeAttribute",
"parameters":[
{
"name":"nodeId",
"$ref":"NodeId",
"description":"Id of the element to remove attribute from."
},
{
"name":"name",
"type":"string",
"description":"Name of the attribute to remove."
}
],
"description":"Removes attribute with given name from an element with given id."
},
{
"name":"getOuterHTML",
"parameters":[
{
"name":"nodeId",
"$ref":"NodeId",
"description":"Id of the node to get markup for."
}
],
"returns":[
{
"name":"outerHTML",
"type":"string",
"description":"Outer HTML markup."
}
],
"description":"Returns node's HTML markup."
},
{
"name":"setOuterHTML",
"parameters":[
{
"name":"nodeId",
"$ref":"NodeId",
"description":"Id of the node to set markup for."
},
{
"name":"outerHTML",
"type":"string",
"description":"Outer HTML markup to set."
}
],
"description":"Sets node HTML markup, returns new node id."
},
{
"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.",
"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.",
"experimental":true
},
{
"name":"getSearchResults",
"parameters":[
{
"name":"searchId",
"type":"string",
"description":"Unique search session identifier."
},
{
"name":"fromIndex",
"type":"integer",
"description":"Start index of the search result to be returned."
},
{
"name":"toIndex",
"type":"integer",
"description":"End index of the search result to be returned."
}
],
"returns":[
{
"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.",
"experimental":true
},
{
"name":"discardSearchResults",
"parameters":[
{
"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.",
"experimental":true
},
{
"name":"requestNode",
"parameters":[
{
"name":"objectId",
"$ref":"Runtime.RemoteObjectId",
"description":"JavaScript object id to convert into node."
}
],
"returns":[
{
"name":"nodeId",
"$ref":"NodeId",
"description":"Node id for given object."
}
],
"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."
"description":"Called when shadow root is pushed into the element.",
"experimental":true
},
{
"name":"shadowRootPopped",
"parameters":[
{
"name":"hostId",
"$ref":"NodeId",
"description":"Host element id."
},
{
"name":"rootId",
"$ref":"NodeId",
"description":"Shadow root id."
}
],
"description":"Called when shadow root is popped from the element.",
"experimental":true
},
{
"name":"pseudoElementAdded",
"parameters":[
{
"name":"parentId",
"$ref":"NodeId",
"description":"Pseudo element's parent element id."
},
{
"name":"pseudoElement",
"$ref":"Node",
"description":"The added pseudo element."
}
],
"description":"Called when a pseudo element is added to an element.",
"experimental":true
},
{
"name":"pseudoElementRemoved",
"parameters":[
{
"name":"parentId",
"$ref":"NodeId",
"description":"Pseudo element's parent element id."
},
{
"name":"pseudoElementId",
"$ref":"NodeId",
"description":"The removed pseudo element id."
}
],
"description":"Called when a pseudo element is removed from an element.",
"experimental":true
},
{
"name":"distributedNodesUpdated",
"parameters":[
{
"name":"insertionPointId",
"$ref":"NodeId",
"description":"Insertion point where distrubuted nodes were updated."
},
{
"name":"distributedNodes",
"type":"array",
"items":{
"$ref":"BackendNode"
},
"description":"Distributed nodes for given insertion point."
}
],
"description":"Called when distrubution is changed.",
"experimental":true
}
]
},
{
"domain":"CSS",
"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",
"type":"string"
},
{
"id":"StyleSheetOrigin",
"type":"string",
"enum":[
"injected",
"user-agent",
"inspector",
"regular"
],
"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":"PseudoElementMatches",
"type":"object",
"properties":[
{
"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."
},
{
"id":"InheritedStyleEntry",
"type":"object",
"properties":[
{
"name":"inlineStyle",
"$ref":"CSSStyle",
"optional":true,
"description":"The ancestor node's inline style, if any, in the style inheritance chain."
},
{
"name":"matchedCSSRules",
"type":"array",
"items":{
"$ref":"RuleMatch"
},
"description":"Matches of CSS rules matching the ancestor node in the style inheritance chain."
}
],
"description":"Inherited CSS rule collection from ancestor node."
},
{
"id":"RuleMatch",
"type":"object",
"properties":[
{
"name":"rule",
"$ref":"CSSRule",
"description":"CSS rule in the match."
},
{
"name":"matchingSelectors",
"type":"array",
"items":{
"type":"integer"
},
"description":"Matching selector indices in the rule's selectorList selectors (0-based)."
}
],
"description":"Match data for a CSS rule."
},
{
"id":"Value",
"type":"object",
"properties":[
{
"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)."
},
{
"id":"SelectorList",
"type":"object",
"properties":[
{
"name":"selectors",
"type":"array",
"items":{
"$ref":"Value"
},
"description":"Selectors in the list."
},
{
"name":"text",
"type":"string",
"description":"Rule selector text."
}
],
"description":"Selector list data."
},
{
"id":"CSSStyleSheetHeader",
"type":"object",
"properties":[
{
"name":"styleSheetId",
"$ref":"StyleSheetId",
"description":"The stylesheet identifier."
},
{
"name":"frameId",
"$ref":"Page.FrameId",
"description":"Owner frame identifier."
},
{
"name":"sourceURL",
"type":"string",
"description":"Stylesheet resource URL."
},
{
"name":"sourceMapURL",
"type":"string",
"optional":true,
"description":"URL of source map associated with the stylesheet (if any)."
},
{
"name":"origin",
"$ref":"StyleSheetOrigin",
"description":"Stylesheet origin."
},
{
"name":"title",
"type":"string",
"description":"Stylesheet title."
},
{
"name":"ownerNode",
"$ref":"DOM.BackendNodeId",
"optional":true,
"description":"The backend id for the owner node of the stylesheet."
},
{
"name":"disabled",
"type":"boolean",
"description":"Denotes whether the stylesheet is disabled."
},
{
"name":"hasSourceURL",
"type":"boolean",
"optional":true,
"description":"Whether the sourceURL field value comes from the sourceURL comment."
},
{
"name":"isInline",
"type":"boolean",
"description":"Whether this stylesheet is created for STYLE tag by parser. This flag is not set for document.written STYLE tags."
},
{
"name":"startLine",
"type":"number",
"description":"Line offset of the stylesheet within the resource (zero based)."
},
{
"name":"startColumn",
"type":"number",
"description":"Column offset of the stylesheet within the resource (zero based)."
"description":"The css style sheet identifier (absent for user agent stylesheet and user-specified stylesheet rules) this rule came from."
},
{
"name":"selectorList",
"$ref":"SelectorList",
"description":"Rule selector data."
},
{
"name":"origin",
"$ref":"StyleSheetOrigin",
"description":"Parent stylesheet's origin."
},
{
"name":"style",
"$ref":"CSSStyle",
"description":"Associated style declaration."
},
{
"name":"media",
"type":"array",
"items":{
"$ref":"CSSMedia"
},
"optional":true,
"description":"Media list array (for rules involving media queries). The array enumerates media queries starting with the innermost one, going outwards."
}
],
"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."
"description":"Start column of range (inclusive)."
},
{
"name":"endLine",
"type":"integer",
"description":"End line of range"
},
{
"name":"endColumn",
"type":"integer",
"description":"End column of range (exclusive)."
}
],
"description":"Text range within a resource. All numbers are zero-based."
},
{
"id":"ShorthandEntry",
"type":"object",
"properties":[
{
"name":"name",
"type":"string",
"description":"Shorthand name."
},
{
"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)."
}
]
},
{
"id":"CSSComputedStyleProperty",
"type":"object",
"properties":[
{
"name":"name",
"type":"string",
"description":"Computed style property name."
},
{
"name":"value",
"type":"string",
"description":"Computed style property value."
}
]
},
{
"id":"CSSStyle",
"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":"cssProperties",
"type":"array",
"items":{
"$ref":"CSSProperty"
},
"description":"CSS properties in the style."
},
{
"name":"shorthandEntries",
"type":"array",
"items":{
"$ref":"ShorthandEntry"
},
"description":"Computed values for all shorthands found in the style."
},
{
"name":"cssText",
"type":"string",
"optional":true,
"description":"Style declaration text (if available)."
},
{
"name":"range",
"$ref":"SourceRange",
"optional":true,
"description":"Style declaration range in the enclosing stylesheet (if available)."
}
],
"description":"CSS style representation."
},
{
"id":"CSSProperty",
"type":"object",
"properties":[
{
"name":"name",
"type":"string",
"description":"The property name."
},
{
"name":"value",
"type":"string",
"description":"The property value."
},
{
"name":"important",
"type":"boolean",
"optional":true,
"description":"Whether the property has \"!important\" annotation (implies <code>false</code> if absent)."
},
{
"name":"implicit",
"type":"boolean",
"optional":true,
"description":"Whether the property is implicit (implies <code>false</code> if absent)."
},
{
"name":"text",
"type":"string",
"optional":true,
"description":"The full property text as specified in the style."
},
{
"name":"parsedOk",
"type":"boolean",
"optional":true,
"description":"Whether the property is understood by the browser (implies <code>true</code> if absent)."
},
{
"name":"disabled",
"type":"boolean",
"optional":true,
"description":"Whether the property is disabled by the user (present for source-based properties only)."
},
{
"name":"range",
"$ref":"SourceRange",
"optional":true,
"description":"The entire property range in the enclosing style declaration (if available)."
}
],
"description":"CSS property declaration data."
},
{
"id":"CSSMedia",
"type":"object",
"properties":[
{
"name":"text",
"type":"string",
"description":"Media query text."
},
{
"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":"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."
},
{
"id":"MediaQuery",
"type":"object",
"properties":[
{
"name":"expressions",
"type":"array",
"items":{
"$ref":"MediaQueryExpression"
},
"description":"Array of media query expressions."
},
{
"name":"active",
"type":"boolean",
"description":"Whether the media query condition is satisfied."
}
],
"description":"Media query descriptor.",
"experimental":true
},
{
"id":"MediaQueryExpression",
"type":"object",
"properties":[
{
"name":"value",
"type":"number",
"description":"Media query expression value."
},
{
"name":"unit",
"type":"string",
"description":"Media query expression units."
},
{
"name":"feature",
"type":"string",
"description":"Media query expression feature."
},
{
"name":"valueRange",
"$ref":"SourceRange",
"optional":true,
"description":"The associated range of the value text in the enclosing stylesheet (if available)."
},
{
"name":"computedLength",
"type":"number",
"optional":true,
"description":"Computed length of media query expression (if applicable)."
"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
}
],
"commands":[
{
"name":"enable",
"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."
},
{
"name":"disable",
"description":"Disables the CSS agent for the given page."
},
{
"name":"getMatchedStylesForNode",
"parameters":[
{
"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":"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>."
},
{
"name":"getInlineStylesForNode",
"parameters":[
{
"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%\")."
}
],
"description":"Returns the styles defined inline (explicitly in the \"style\" attribute and implicitly, using DOM attributes) for a DOM node identified by <code>nodeId</code>."
},
{
"name":"getComputedStyleForNode",
"parameters":[
{
"name":"nodeId",
"$ref":"DOM.NodeId"
}
],
"returns":[
{
"name":"computedStyle",
"type":"array",
"items":{
"$ref":"CSSComputedStyleProperty"
},
"description":"Computed style for the specified DOM node."
}
],
"description":"Returns the computed style for a DOM node identified by <code>nodeId</code>."
},
{
"name":"getPlatformFontsForNode",
"parameters":[
{
"name":"nodeId",
"$ref":"DOM.NodeId"
}
],
"returns":[
{
"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.",
"experimental":true
},
{
"name":"getStyleSheetText",
"parameters":[
{
"name":"styleSheetId",
"$ref":"StyleSheetId"
}
],
"returns":[
{
"name":"text",
"type":"string",
"description":"The stylesheet text."
}
],
"description":"Returns the current textual content and the URL for a stylesheet."
},
{
"name":"collectClassNames",
"parameters":[
{
"name":"styleSheetId",
"$ref":"StyleSheetId"
}
],
"returns":[
{
"name":"classNames",
"type":"array",
"items":{
"type":"string"
},
"description":"Class name list."
}
],
"description":"Returns all class names from specified stylesheet.",
"experimental":true
},
{
"name":"setStyleSheetText",
"parameters":[
{
"name":"styleSheetId",
"$ref":"StyleSheetId"
},
{
"name":"text",
"type":"string"
}
],
"returns":[
{
"name":"sourceMapURL",
"type":"string",
"optional":true,
"description":"URL of source map associated with script (if any)."
}
],
"description":"Sets the new stylesheet text."
},
{
"name":"setRuleSelector",
"parameters":[
{
"name":"styleSheetId",
"$ref":"StyleSheetId"
},
{
"name":"range",
"$ref":"SourceRange"
},
{
"name":"selector",
"type":"string"
}
],
"returns":[
{
"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":[
{
"name":"styleSheetId",
"$ref":"StyleSheetId"
},
{
"name":"range",
"$ref":"SourceRange"
},
{
"name":"text",
"type":"string"
}
],
"returns":[
{
"name":"media",
"$ref":"CSSMedia",
"description":"The resulting CSS media rule after modification."
}
],
"description":"Modifies the rule selector."
},
{
"name":"createStyleSheet",
"parameters":[
{
"name":"frameId",
"$ref":"Page.FrameId",
"description":"Identifier of the frame where \"via-inspector\" stylesheet should be created."
}
],
"returns":[
{
"name":"styleSheetId",
"$ref":"StyleSheetId",
"description":"Identifier of the created \"via-inspector\" stylesheet."
}
],
"description":"Creates a new special \"via-inspector\" stylesheet in the frame with given <code>frameId</code>."
},
{
"name":"addRule",
"parameters":[
{
"name":"styleSheetId",
"$ref":"StyleSheetId",
"description":"The css style sheet identifier where a new rule should be inserted."
},
{
"name":"ruleText",
"type":"string",
"description":"The text of a new rule."
},
{
"name":"location",
"$ref":"SourceRange",
"description":"Text position of a new rule in the target style sheet."
}
],
"returns":[
{
"name":"rule",
"$ref":"CSSRule",
"description":"The newly created rule."
}
],
"description":"Inserts a new rule with the given <code>ruleText</code> in a stylesheet with given <code>styleSheetId</code>, at the position specified by <code>location</code>."
},
{
"name":"forcePseudoState",
"parameters":[
{
"name":"nodeId",
"$ref":"DOM.NodeId",
"description":"The element id for which to force the pseudo state."
},
{
"name":"forcedPseudoClasses",
"type":"array",
"items":{
"type":"string",
"enum":[
"active",
"focus",
"hover",
"visited"
]
},
"description":"Element pseudo classes to force when computing the element's style."
}
],
"description":"Ensures that the given node will have specified pseudo-classes whenever its style is computed by the browser."
},
{
"name":"getMediaQueries",
"returns":[
{
"name":"medias",
"type":"array",
"items":{
"$ref":"CSSMedia"
}
}
],
"description":"Returns all media queries parsed by the rendering engine.",
"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).",
"description":"The list of rules with an indication of whether these were used",
"experimental":true
}
],
"events":[
{
"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":[
{
"name":"styleSheetId",
"$ref":"StyleSheetId"
}
],
"description":"Fired whenever a stylesheet is changed as a result of the client operation."
},
{
"name":"styleSheetAdded",
"parameters":[
{
"name":"header",
"$ref":"CSSStyleSheetHeader",
"description":"Added stylesheet metainfo."
}
],
"description":"Fired whenever an active document stylesheet is added."
},
{
"name":"styleSheetRemoved",
"parameters":[
{
"name":"styleSheetId",
"$ref":"StyleSheetId",
"description":"Identifier of the removed stylesheet."
}
],
"description":"Fired whenever an active document stylesheet is removed."
"description":"This domain facilitates obtaining document snapshots with DOM, layout, and style information.",
"dependencies":[
"CSS",
"DOM",
"Page"
],
"types":[
{
"id":"DOMNode",
"type":"object",
"properties":[
{
"name":"nodeType",
"type":"integer",
"description":"<code>Node</code>'s nodeType."
},
{
"name":"nodeName",
"type":"string",
"description":"<code>Node</code>'s nodeName."
},
{
"name":"nodeValue",
"type":"string",
"description":"<code>Node</code>'s nodeValue."
},
{
"name":"backendNodeId",
"$ref":"DOM.BackendNodeId",
"description":"<code>Node</code>'s id, corresponds to DOM.Node.backendNodeId."
},
{
"name":"childNodeIndexes",
"type":"array",
"items":{
"type":"integer"
},
"optional":true,
"description":"The indexes of the node's child nodes in the <code>domNodes</code> array returned by <code>getSnapshot</code>, if any."
},
{
"name":"attributes",
"type":"array",
"items":{
"$ref":"NameValue"
},
"optional":true,
"description":"Attributes of an <code>Element</code> node."
},
{
"name":"pseudoElementIndexes",
"type":"array",
"items":{
"type":"integer"
},
"optional":true,
"description":"Indexes of pseudo elements associated with this node in the <code>domNodes</code> array returned by <code>getSnapshot</code>, if any."
},
{
"name":"layoutNodeIndex",
"type":"integer",
"optional":true,
"description":"The index of the node's related layout tree node in the <code>layoutTreeNodes</code> array returned by <code>getSnapshot</code>, if any."
},
{
"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."
"description":"Frame ID for frame owner elements."
},
{
"name":"contentDocumentIndex",
"type":"integer",
"optional":true,
"description":"The index of a frame owner element's content document in the <code>domNodes</code> array returned by <code>getSnapshot</code>, if any."
},
{
"name":"importedDocumentIndex",
"type":"integer",
"optional":true,
"description":"Index of the imported document's node of a link element in the <code>domNodes</code> array returned by <code>getSnapshot</code>, if any."
},
{
"name":"templateContentIndex",
"type":"integer",
"optional":true,
"description":"Index of the content node of a template element in the <code>domNodes</code> array returned by <code>getSnapshot</code>."
},
{
"name":"pseudoType",
"$ref":"DOM.PseudoType",
"optional":true,
"description":"Type of a pseudo element node."
}
],
"description":"A Node in the DOM tree."
},
{
"id":"LayoutTreeNode",
"type":"object",
"properties":[
{
"name":"domNodeIndex",
"type":"integer",
"description":"The index of the related DOM node in the <code>domNodes</code> array returned by <code>getSnapshot</code>."
},
{
"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":"CSS.InlineTextBox"
},
"description":"The post-layout inline text nodes, if any."
},
{
"name":"styleIndex",
"type":"integer",
"optional":true,
"description":"Index into the <code>computedStyles</code> array returned by <code>getSnapshot</code>."
}
],
"description":"Details of an element in the DOM tree with a LayoutObject."
},
{
"id":"ComputedStyle",
"type":"object",
"properties":[
{
"name":"properties",
"type":"array",
"items":{
"$ref":"NameValue"
},
"description":"Name/value pairs of computed style properties."
}
],
"description":"A subset of the full ComputedStyle as defined by the request whitelist."
},
{
"id":"NameValue",
"type":"object",
"properties":[
{
"name":"name",
"type":"string",
"description":"Attribute/property name."
},
{
"name":"value",
"type":"string",
"description":"Attribute/property value."
}
],
"description":"A name/value pair."
}
],
"commands":[
{
"name":"getSnapshot",
"parameters":[
{
"name":"computedStyleWhitelist",
"type":"array",
"items":{
"type":"string"
},
"description":"Whitelist of computed styles to return."
}
],
"returns":[
{
"name":"domNodes",
"type":"array",
"items":{
"$ref":"DOMNode"
},
"description":"The nodes in the DOM tree. The DOMNode at index 0 corresponds to the root document."
},
{
"name":"layoutTreeNodes",
"type":"array",
"items":{
"$ref":"LayoutTreeNode"
},
"description":"The nodes in the layout tree."
},
{
"name":"computedStyles",
"type":"array",
"items":{
"$ref":"ComputedStyle"
},
"description":"Whitelisted ComputedStyle properties for each node in the layout tree."
}
],
"description":"Returns a document snapshot, including the full DOM tree of the root node (including iframes, template contents, and imported documents) in a flattened array, as well as layout and white-listed computed style information for the nodes. Shadow DOM in the returned DOM tree is flattened. "
"description":"Input/Output operations for streams produced by DevTools.",
"experimental":true,
"types":[
{
"id":"StreamHandle",
"type":"string"
}
],
"commands":[
{
"name":"read",
"description":"Read a chunk of the stream",
"parameters":[
{
"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)."
}
],
"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":"close",
"description":"Close the stream, discard any temporary backing storage.",
"parameters":[
{
"name":"handle",
"$ref":"StreamHandle",
"description":"Handle of the stream to close."
}
]
}
]
},
{
"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.",
"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.",
"description":"Returns event listeners of the given object."
}
]
},
{
"domain":"Target",
"description":"Supports additional targets discovery and allows to attach to them.",
"experimental":true,
"types":[
{
"id":"TargetID",
"type":"string"
},
{
"id":"BrowserContextID",
"type":"string"
},
{
"id":"TargetInfo",
"type":"object",
"properties":[
{
"name":"targetId",
"$ref":"TargetID"
},
{
"name":"type",
"type":"string"
},
{
"name":"title",
"type":"string"
},
{
"name":"url",
"type":"string"
}
]
},
{
"id":"RemoteLocation",
"type":"object",
"properties":[
{
"name":"host",
"type":"string"
},
{
"name":"port",
"type":"integer"
}
]
}
],
"commands":[
{
"name":"setDiscoverTargets",
"description":"Controls whether to discover available targets and notify via <code>targetCreated/targetDestroyed</code> events.",
"parameters":[
{
"name":"discover",
"type":"boolean",
"description":"Whether to discover available targets."
}
]
},
{
"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":"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."
}
]
},
{
"name":"setAttachToFrames",
"parameters":[
{
"name":"value",
"type":"boolean",
"description":"Whether to attach to frames."
}
]
},
{
"name":"setRemoteLocations",
"description":"Enables target discovery for the specified locations, when <code>setDiscoverTargets</code> was set to <code>true</code>.",
"parameters":[
{
"name":"locations",
"type":"array",
"items":{
"$ref":"RemoteLocation"
},
"description":"List of remote locations."
}
]
},
{
"name":"sendMessageToTarget",
"description":"Sends protocol message to the target with given id.",
"description":"Returns information about a target.",
"parameters":[
{
"name":"targetId",
"$ref":"TargetID"
}
],
"returns":[
{
"name":"targetInfo",
"$ref":"TargetInfo"
}
]
},
{
"name":"activateTarget",
"description":"Activates (focuses) the target.",
"parameters":[
{
"name":"targetId",
"$ref":"TargetID"
}
]
},
{
"name":"closeTarget",
"description":"Closes the target. If the target is a page that gets closed too.",
"parameters":[
{
"name":"targetId",
"$ref":"TargetID"
}
],
"returns":[
{
"name":"success",
"type":"boolean"
}
]
},
{
"name":"attachToTarget",
"description":"Attaches to the target with given id.",
"parameters":[
{
"name":"targetId",
"$ref":"TargetID"
}
],
"returns":[
{
"name":"success",
"type":"boolean",
"description":"Whether attach succeeded."
}
]
},
{
"name":"detachFromTarget",
"description":"Detaches from the target with given id.",
"parameters":[
{
"name":"targetId",
"$ref":"TargetID"
}
]
},
{
"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":"disposeBrowserContext",
"description":"Deletes a BrowserContext, will fail of any open page uses it.",
"parameters":[
{
"name":"browserContextId",
"$ref":"BrowserContextID"
}
],
"returns":[
{
"name":"success",
"type":"boolean"
}
]
},
{
"name":"createTarget",
"description":"Creates a new page.",
"parameters":[
{
"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":"getTargets",
"description":"Retrieves a list of available targets.",
"returns":[
{
"name":"targetInfos",
"type":"array",
"items":{
"$ref":"TargetInfo"
},
"description":"The list of targets."
}
]
}
],
"events":[
{
"name":"targetCreated",
"description":"Issued when a possible inspection target is created.",
"parameters":[
{
"name":"targetInfo",
"$ref":"TargetInfo"
}
]
},
{
"name":"targetDestroyed",
"description":"Issued when a target is destroyed.",
"parameters":[
{
"name":"targetId",
"$ref":"TargetID"
}
]
},
{
"name":"attachedToTarget",
"description":"Issued when attached to target because of auto-attach or <code>attachToTarget</code> command.",
"parameters":[
{
"name":"targetInfo",
"$ref":"TargetInfo"
},
{
"name":"waitingForDebugger",
"type":"boolean"
}
]
},
{
"name":"detachedFromTarget",
"description":"Issued when detached from target for any reason (including <code>detachFromTarget</code> command).",
"parameters":[
{
"name":"targetId",
"$ref":"TargetID"
}
]
},
{
"name":"receivedMessageFromTarget",
"description":"Notifies about new protocol message from attached target.",
"parameters":[
{
"name":"targetId",
"$ref":"TargetID"
},
{
"name":"message",
"type":"string"
}
]
}
]
},
{
"domain":"ServiceWorker",
"experimental":true,
"types":[
{
"id":"ServiceWorkerRegistration",
"type":"object",
"description":"ServiceWorker registration.",
"properties":[
{
"name":"registrationId",
"type":"string"
},
{
"name":"scopeURL",
"type":"string"
},
{
"name":"isDeleted",
"type":"boolean"
}
]
},
{
"id":"ServiceWorkerVersionRunningStatus",
"type":"string",
"enum":[
"stopped",
"starting",
"running",
"stopping"
]
},
{
"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."
},
{
"name":"controlledClients",
"type":"array",
"optional":true,
"items":{
"$ref":"Target.TargetID"
}
},
{
"name":"targetId",
"$ref":"Target.TargetID",
"optional":true
}
]
},
{
"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"
},
{
"name":"disable"
},
{
"name":"unregister",
"parameters":[
{
"name":"scopeURL",
"type":"string"
}
]
},
{
"name":"updateRegistration",
"parameters":[
{
"name":"scopeURL",
"type":"string"
}
]
},
{
"name":"startWorker",
"parameters":[
{
"name":"scopeURL",
"type":"string"
}
]
},
{
"name":"skipWaiting",
"parameters":[
{
"name":"scopeURL",
"type":"string"
}
]
},
{
"name":"stopWorker",
"parameters":[
{
"name":"versionId",
"type":"string"
}
]
},
{
"name":"inspectWorker",
"parameters":[
{
"name":"versionId",
"type":"string"
}
]
},
{
"name":"setForceUpdateOnPageLoad",
"parameters":[
{
"name":"forceUpdateOnPageLoad",
"type":"boolean"
}
]
},
{
"name":"deliverPushMessage",
"parameters":[
{
"name":"origin",
"type":"string"
},
{
"name":"registrationId",
"type":"string"
},
{
"name":"data",
"type":"string"
}
]
},
{
"name":"dispatchSyncEvent",
"parameters":[
{
"name":"origin",
"type":"string"
},
{
"name":"registrationId",
"type":"string"
},
{
"name":"tag",
"type":"string"
},
{
"name":"lastChance",
"type":"boolean"
}
]
}
],
"events":[
{
"name":"workerRegistrationUpdated",
"parameters":[
{
"name":"registrations",
"type":"array",
"items":{
"$ref":"ServiceWorkerRegistration"
}
}
]
},
{
"name":"workerVersionUpdated",
"parameters":[
{
"name":"versions",
"type":"array",
"items":{
"$ref":"ServiceWorkerVersion"
}
}
]
},
{
"name":"workerErrorReported",
"parameters":[
{
"name":"errorMessage",
"$ref":"ServiceWorkerErrorMessage"
}
]
}
]
},
{
"domain":"Input",
"types":[
{
"id":"TouchPoint",
"type":"object",
"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."
},
{
"name":"y",
"type":"integer",
"description":"Y coordinate of the event relative to the main frame's viewport. 0 refers to the top of the viewport and Y increases as it proceeds towards the bottom of the viewport."
},
{
"name":"radiusX",
"type":"integer",
"optional":true,
"description":"X radius of the touch area (default: 1)."
},
{
"name":"radiusY",
"type":"integer",
"optional":true,
"description":"Y radius of the touch area (default: 1)."
},
{
"name":"rotationAngle",
"type":"number",
"optional":true,
"description":"Rotation angle (default: 0.0)."
},
{
"name":"force",
"type":"number",
"optional":true,
"description":"Force (default: 1.0)."
},
{
"name":"id",
"type":"number",
"optional":true,
"description":"Identifier used to track touch sources between events, must be unique within an event."
"description":"Time at which the event occurred. Measured in UTC time in seconds since January 1, 1970 (default: current time)."
},
{
"name":"text",
"type":"string",
"optional":true,
"description":"Text as generated by processing a virtual key code with a keyboard layout. Not needed for for <code>keyUp</code> and <code>rawKeyDown</code> events (default: \"\")"
},
{
"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: \"\")."
"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: \"\")."
"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."
},
{
"name":"dispatchMouseEvent",
"parameters":[
{
"name":"type",
"type":"string",
"enum":[
"mousePressed",
"mouseReleased",
"mouseMoved"
],
"description":"Type of the mouse event."
},
{
"name":"x",
"type":"integer",
"description":"X coordinate of the event relative to the main frame's viewport."
},
{
"name":"y",
"type":"integer",
"description":"Y coordinate of the event relative to the main frame's viewport. 0 refers to the top of the viewport and Y increases as it proceeds towards the bottom of the viewport."
"description":"A list of supported tracing categories."
}
]
},
{
"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":[
{
"name":"dataCollected",
"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."
},
{
"name":"tracingComplete",
"description":"Signals that tracing is stopped and there is no trace buffers pending flush, all data were delivered via dataCollected events.",
"parameters":[
{
"name":"stream",
"$ref":"IO.StreamHandle",
"optional":true,
"description":"A handle of the stream that holds resulting trace data."
}
]
},
{
"name":"bufferUsage",
"parameters":[
{
"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."
"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":"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."
"description":"The offset from the left edge of the screen to the window in pixels."
},
{
"name":"top",
"type":"integer",
"optional":true,
"description":"The offset from the top edge of the screen to the window in pixels."
},
{
"name":"width",
"type":"integer",
"optional":true,
"description":"The window width in pixels."
},
{
"name":"height",
"type":"integer",
"optional":true,
"description":"The window height in pixels."
},
{
"name":"windowState",
"$ref":"WindowState",
"optional":true,
"description":"The window state. Default to normal."
}
]
}
],
"commands":[
{
"name":"getWindowForTarget",
"description":"Get the browser window that contains the devtools target.",
"parameters":[
{
"name":"targetId",
"$ref":"Target.TargetID",
"description":"Devtools agent host id."
}
],
"returns":[
{
"name":"windowId",
"$ref":"WindowID",
"description":"Browser window id."
},
{
"name":"bounds",
"$ref":"Bounds",
"description":"Bounds information of the window. When window state is 'minimized', the restored window position and size are returned."
}
]
},
{
"name":"setWindowBounds",
"description":"Set position and/or size of the browser window.",
"parameters":[
{
"name":"windowId",
"$ref":"WindowID",
"description":"Browser window id."
},
{
"name":"bounds",
"$ref":"Bounds",
"description":"New window bounds. The 'minimized', 'maximized' and 'fullscreen' states cannot be combined with 'left', 'top', 'width' or 'height'. Leaves unspecified fields unchanged."
}
]
},
{
"name":"getWindowBounds",
"description":"Get position and size of the browser window.",
"parameters":[
{
"name":"windowId",
"$ref":"WindowID",
"description":"Browser window id."
}
],
"returns":[
{
"name":"bounds",
"$ref":"Bounds",
"description":"Bounds information of the window. When window state is 'minimized', the restored window position and size are returned."
"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.",
"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."
"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."
"description":"Console context descriptor for calls on non-default console context (not console.*): 'anonymous#unique-logger-id' for call on unnamed context, 'name#unique-logger-id' for call on named context."
"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":"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."
"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.",
"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."
"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."
"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.",
"description":"If heap objects tracking has been started then backend regularly 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.",
"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."
