Google Git
Sign in
chromium / chromium / src / 7207cbae19a618301e477d224f5b8da2a7c6e77a / . / third_party / blink / renderer / core / inspector / browser_protocol-1.2.json
blob: 6e3e7e12dede66f36416f82d94b12cdd9b2e0ce5 [file] [log] [blame]
{
"version": { "major": "1", "minor": "2" },
"domains": [{
"domain": "Inspector",
"experimental": true,
"types": [],
"commands": [
{
"name": "enable",
"description": "Enables inspector domain notifications.",
"handlers": ["browser"]
},
{
"name": "disable",
"description": "Disables inspector domain notifications.",
"handlers": ["browser"]
}
],
"events": [
{
"name": "detached",
"description": "Fired when remote debugging connection is about to be terminated. Contains detach reason.",
"parameters": [
{ "name": "reason", "type": "string", "description": "The reason why connection has been terminated." }
],
"handlers": ["browser"]
},
{
"name": "targetCrashed",
"description": "Fired when debugging target has crashed",
"handlers": ["browser"]
}
]
},
{
"domain": "Memory",
"experimental": true,
"types": [
{
"id": "PressureLevel",
"type": "string",
"enum": ["moderate", "critical"],
"description": "Memory pressure level."
}
],
"commands": [
{
"name": "getDOMCounters",
"returns": [
{ "name": "documents", "type": "integer" },
{ "name": "nodes", "type": "integer" },
{ "name": "jsEventListeners", "type": "integer" }
]
},
{
"name": "setPressureNotificationsSuppressed",
"description": "Enable/disable suppressing memory pressure notifications in all processes.",
"parameters": [
{ "name": "suppressed", "type": "boolean", "description": "If true, memory pressure notifications will be suppressed."}
],
"handlers": ["browser"]
},
{
"name": "simulatePressureNotification",
"description": "Simulate a memory pressure notification in all processes.",
"parameters": [
{ "name": "level", "$ref": "PressureLevel", "description": "Memory pressure level of the notification." }
],
"handlers": ["browser"]
}
]
},
{
"domain": "Page",
"description": "Actions and events related to the inspected page belong to the page domain.",
"dependencies": ["Debugger", "DOM"],
"types": [
{
"id": "ResourceType",
"type": "string",
"enum": ["Document", "Stylesheet", "Image", "Media", "Font", "Script", "TextTrack", "XHR", "Fetch", "EventSource", "WebSocket", "Manifest", "Other"],
"description": "Resource type as it was perceived by the rendering engine."
},
{
"id": "FrameId",
"type": "string",
"description": "Unique frame identifier."
},
{
"id": "Frame",
"type": "object",
"description": "Information about the Frame on the page.",
"properties": [
{ "name": "id", "type": "string", "description": "Frame unique identifier." },
{ "name": "parentId", "type": "string", "optional": true, "description": "Parent frame identifier." },
{ "name": "loaderId", "$ref": "Network.LoaderId", "description": "Identifier of the loader associated with this frame." },
{ "name": "name", "type": "string", "optional": true, "description": "Frame's name as specified in the tag." },
{ "name": "url", "type": "string", "description": "Frame document's URL." },
{ "name": "securityOrigin", "type": "string", "description": "Frame document's security origin." },
{ "name": "mimeType", "type": "string", "description": "Frame document's mimeType as determined by the browser." }
]
},
{
"id": "FrameResource",
"type": "object",
"description": "Information about the Resource on the page.",
"properties": [
{ "name": "url", "type": "string", "description": "Resource URL." },
{ "name": "type", "$ref": "ResourceType", "description": "Type of this resource." },
{ "name": "mimeType", "type": "string", "description": "Resource mimeType as determined by the browser." },
{ "name": "failed", "type": "boolean", "optional": true, "description": "True if the resource failed to load." },
{ "name": "canceled", "type": "boolean", "optional": true, "description": "True if the resource was canceled during loading." }
],
"experimental": true
},
{
"id": "FrameResourceTree",
"type": "object",
"description": "Information about the Frame hierarchy along with their cached resources.",
"properties": [
{ "name": "frame", "$ref": "Frame", "description": "Frame information for this tree item." },
{ "name": "childFrames", "type": "array", "optional": true, "items": { "$ref": "FrameResourceTree" }, "description": "Child frames." },
{ "name": "resources", "type": "array", "items": { "$ref": "FrameResource" }, "description": "Information about frame resources." }
],
"experimental": true
},
{
"id": "ScriptIdentifier",
"type": "string",
"description": "Unique script identifier.",
"experimental": true
},
{
"id": "NavigationEntry",
"type": "object",
"description": "Navigation history entry.",
"properties": [
{ "name": "id", "type": "integer", "description": "Unique id of the navigation history entry." },
{ "name": "url", "type": "string", "description": "URL of the navigation history entry." },
{ "name": "title", "type": "string", "description": "Title of the navigation history entry." }
],
"experimental": true
},
{
"id": "ScreencastFrameMetadata",
"type": "object",
"description": "Screencast frame metadata.",
"properties": [
{ "name": "offsetTop", "type": "number", "experimental": true, "description": "Top offset in DIP." },
{ "name": "pageScaleFactor", "type": "number", "experimental": true, "description": "Page scale factor." },
{ "name": "deviceWidth", "type": "number", "experimental": true, "description": "Device screen width in DIP." },
{ "name": "deviceHeight", "type": "number", "experimental": true, "description": "Device screen height in DIP." },
{ "name": "scrollOffsetX", "type": "number", "experimental": true, "description": "Position of horizontal scroll in CSS pixels." },
{ "name": "scrollOffsetY", "type": "number", "experimental": true, "description": "Position of vertical scroll in CSS pixels." },
{ "name": "timestamp", "type": "number", "optional": true, "experimental": true, "description": "Frame swap timestamp." }
],
"experimental": true
},
{
"id": "DialogType",
"description": "Javascript dialog type.",
"type": "string",
"enum": ["alert", "confirm", "prompt", "beforeunload"],
"experimental": true
},
{
"id": "AppManifestError",
"description": "Error while paring app manifest.",
"type": "object",
"properties": [
{ "name": "message", "type": "string", "description": "Error message." },
{ "name": "critical", "type": "integer", "description": "If criticial, this is a non-recoverable parse error." },
{ "name": "line", "type": "integer", "description": "Error line." },
{ "name": "column", "type": "integer", "description": "Error column." }
],
"experimental": true
},
{
"id": "NavigationResponse",
"description": "Proceed: allow the navigation; Cancel: cancel the navigation; CancelAndIgnore: cancels the navigation and makes the requester of the navigation acts like the request was never made.",
"type": "string",
"enum": ["Proceed", "Cancel", "CancelAndIgnore"],
"experimental": true
}
],
"commands": [
{
"name": "enable",
"description": "Enables page domain notifications.",
"handlers": ["browser", "renderer"]
},
{
"name": "disable",
"description": "Disables page domain notifications.",
"handlers": ["browser", "renderer"]
},
{
"name": "addScriptToEvaluateOnLoad",
"parameters": [
{ "name": "scriptSource", "type": "string" }
],
"returns": [
{ "name": "identifier", "$ref": "ScriptIdentifier", "description": "Identifier of the added script." }
],
"experimental": true
},
{
"name": "removeScriptToEvaluateOnLoad",
"parameters": [
{ "name": "identifier", "$ref": "ScriptIdentifier" }
],
"experimental": true
},
{
"name": "setAutoAttachToCreatedPages",
"parameters": [
{ "name": "autoAttach", "type": "boolean", "description": "If true, browser will open a new inspector window for every page created from this one." }
],
"description": "Controls whether browser will open a new inspector window for connected pages.",
"experimental": true
},
{
"name": "reload",
"parameters": [
{ "name": "ignoreCache", "type": "boolean", "optional": true, "description": "If true, browser cache is ignored (as if the user pressed Shift+refresh)." },
{ "name": "scriptToEvaluateOnLoad", "type": "string", "optional": true, "description": "If set, the script will be injected into all frames of the inspected page after reload." }
],
"description": "Reloads given page optionally ignoring the cache.",
"handlers": ["browser", "renderer"]
},
{
"name": "navigate",
"parameters": [
{ "name": "url", "type": "string", "description": "URL to navigate the page to." }
],
"returns": [
{ "name": "frameId", "$ref": "FrameId", "experimental": true, "description": "Frame id that will be navigated." }
],
"description": "Navigates current page to the given URL.",
"handlers": ["browser", "renderer"]
},
{
"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,
"handlers": ["browser"]
},
{
"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,
"handlers": ["browser"]
},
{
"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.",
"handlers": ["browser"],
"async": true,
"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.",
"handlers": ["browser"],
"async": true,
"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",
"async": true,
"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",
"async": true,
"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." }
],
"handlers": ["browser"],
"redirect": "Emulation",
"experimental": true
},
{
"name": "clearDeviceMetricsOverride",
"description": "Clears the overriden device metrics.",
"handlers": ["browser"],
"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",
"handlers": ["browser"]
},
{
"name": "clearGeolocationOverride",
"description": "Clears the overriden Geolocation Position and Error.",
"redirect": "Emulation",
"handlers": ["browser"]
},
{
"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": "Toggles mouse event-based touch event emulation.",
"experimental": true,
"redirect": "Emulation",
"handlers": ["browser", "renderer"]
},
{
"name": "captureScreenshot",
"async": true,
"description": "Capture page screenshot.",
"returns": [
{ "name": "data", "type": "string", "description": "Base64-encoded image data (PNG)." }
],
"experimental": true,
"handlers": ["browser"]
},
{
"name": "startScreencast",
"description": "Starts sending each frame using the <code>screencastFrame</code> event.",
"parameters": [
{ "name": "format", "type": "string", "optional": true, "enum": ["jpeg", "png"], "description": "Image compression format." },
{ "name": "quality", "type": "integer", "optional": true, "description": "Compression quality from range [0..100]." },
{ "name": "maxWidth", "type": "integer", "optional": true, "description": "Maximum screenshot width." },
{ "name": "maxHeight", "type": "integer", "optional": true, "description": "Maximum screenshot height." },
{ "name": "everyNthFrame", "type": "integer", "optional": true, "description": "Send every n-th frame." }
],
"experimental": true,
"handlers": ["browser", "renderer"]
},
{
"name": "stopScreencast",
"description": "Stops sending each frame in the <code>screencastFrame</code>.",
"experimental": true,
"handlers": ["browser", "renderer"]
},
{
"name": "screencastFrameAck",
"description": "Acknowledges that a screencast frame has been received by the frontend.",
"parameters": [
{ "name": "sessionId", "type": "integer", "description": "Frame number." }
],
"experimental": true,
"handlers": ["browser"]
},
{
"name": "handleJavaScriptDialog",
"description": "Accepts or dismisses a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload).",
"parameters": [
{ "name": "accept", "type": "boolean", "description": "Whether to accept or dismiss the dialog." },
{ "name": "promptText", "type": "string", "optional": true, "description": "The text to enter into the dialog prompt before accepting. Used only if this is a prompt dialog." }
],
"handlers": ["browser"]
},
{
"name": "setColorPickerEnabled",
"parameters": [
{ "name": "enabled", "type": "boolean", "description": "Shows / hides color picker" }
],
"description": "Shows / hides color picker",
"experimental": true,
"handlers": ["browser"]
},
{
"name": "configureOverlay",
"parameters": [
{ "name": "suspended", "type": "boolean", "optional": true, "description": "Whether overlay should be suspended and not consume any resources." },
{ "name": "message", "type": "string", "optional": true, "description": "Overlay message to display." }
],
"experimental": true,
"description": "Configures overlay."
},
{
"name": "getAppManifest",
"experimental": true,
"returns": [
{ "name": "url", "type": "string", "description": "Manifest location." },
{ "name": "errors", "type": "array", "items": { "$ref": "AppManifestError" } },
{ "name": "data", "type": "string", "optional": true, "description": "Manifest content." }
],
"handlers": ["none"]
},
{
"name": "setBlockedEventsWarningThreshold",
"experimental": true,
"parameters": [
{ "name": "threshold", "type": "number", "description": "If set to a positive number, specifies threshold in seconds for input event latency that will cause a console warning about blocked event to be issued. If zero or less, the warning is disabled." }
]
}
],
"events": [
{
"name": "domContentEventFired",
"parameters": [
{ "name": "timestamp", "type": "number" }
]
},
{
"name": "loadEventFired",
"parameters": [
{ "name": "timestamp", "type": "number" }
]
},
{
"name": "frameAttached",
"description": "Fired when frame has been attached to its parent.",
"parameters": [
{ "name": "frameId", "$ref": "FrameId", "description": "Id of the frame that has been attached." },
{ "name": "parentFrameId", "$ref": "FrameId", "description": "Parent frame identifier." }
]
},
{
"name": "frameNavigated",
"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,
"handlers": ["browser"]
},
{
"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,
"handlers": ["browser"]
},
{
"name": "colorPicked",
"description": "Fired when a color has been picked.",
"parameters": [
{ "name": "color", "$ref": "DOM.RGBA", "description": "RGBA of the picked color." }
],
"experimental": true,
"handlers": ["browser"]
},
{
"name": "interstitialShown",
"description": "Fired when interstitial page was shown",
"handlers": ["browser"]
},
{
"name": "interstitialHidden",
"description": "Fired when interstitial page was hidden",
"handlers": ["browser"]
}
]
},
{
"domain": "Rendering",
"description": "This domain allows to control rendering of the page.",
"experimental": true,
"commands": [
{
"name": "setShowPaintRects",
"description": "Requests that backend shows paint rectangles",
"parameters": [
{ "name": "result", "type": "boolean", "description": "True for showing paint rectangles" }
]
},
{
"name": "setShowDebugBorders",
"description": "Requests that backend shows debug borders on layers",
"parameters": [
{ "name": "show", "type": "boolean", "description": "True for showing debug borders" }
]
},
{
"name": "setShowFPSCounter",
"description": "Requests that backend shows the FPS counter",
"parameters": [
{ "name": "show", "type": "boolean", "description": "True for showing the FPS counter" }
]
},
{
"name": "setShowScrollBottleneckRects",
"description": "Requests that backend shows scroll bottleneck rects",
"parameters": [
{ "name": "show", "type": "boolean", "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." }
]
}
]
},
{
"domain": "Emulation",
"description": "This domain emulates different environments for the page.",
"types": [
{
"id": "ScreenOrientation",
"type": "object",
"description": "Screen orientation.",
"properties": [
{ "name": "type", "type": "string", "enum": ["portraitPrimary", "portraitSecondary", "landscapePrimary", "landscapeSecondary"], "description": "Orientation type." },
{ "name": "angle", "type": "integer", "description": "Orientation angle." }
]
},
{
"id": "VirtualTimePolicy",
"type": "string",
"enum": [
"advance",
"pause",
"pauseIfNetworkFetchesPending"
],
"experimental": true,
"description": "advance: If the scheduler runs out of immediate work, the virtual time base may fast forward to allow the next delayed task (if any) to run; pause: The virtual time base may not advance; pauseIfNetworkFetchesPending: The virtual time base may not advance if there are any pending resource fetches."
}
],
"commands": [
{
"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, "experimental": true, "description": "X offset to shift resulting view image by. Ignored in |fitWindow| mode." },
{ "name": "offsetY", "type": "number", "optional": true, "experimental": true, "description": "Y offset to shift resulting view image by. Ignored in |fitWindow| mode." },
{ "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." }
],
"handlers": ["browser"]
},
{
"name": "clearDeviceMetricsOverride",
"description": "Clears the overriden device metrics.",
"handlers": ["browser"]
},
{
"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)." }
],
"handlers": ["browser"]
},
{
"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"}
],
"handlers": ["browser"]
},
{
"name": "clearGeolocationOverride",
"description": "Clears the overriden Geolocation Position and Error.",
"experimental": true,
"handlers": ["browser"]
},
{
"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": "Toggles mouse event-based touch event emulation.",
"handlers": ["browser", "renderer"]
},
{
"name": "setEmulatedMedia",
"parameters": [
{ "name": "media", "type": "string", "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,
"handlers": ["browser"]
},
{
"name": "setVirtualTimePolicy",
"description": "Turns on virtual time for all frames (replacing real-time with a synthetic time source) and sets the current virtual time policy. Note this supersedes any previous time budget.",
"parameters": [
{ "name": "policy", "$ref": "VirtualTimePolicy" },
{ "name": "budget", "type": "integer", "optional": true, "description": "If set, after this many virtual milliseconds have elapsed virtual time will be paused and a virtualTimeBudgetExpired event is sent." }
],
"experimental": true
}
],
"events": [
{
"name": "virtualTimeBudgetExpired",
"experimental": true,
"description": "Notification sent after the virual time budget for the current VirtualTimePolicy has run out."
}
]
},
{
"domain": "Security",
"description": "Security",
"experimental": true,
"types": [
{
"id": "CertificateId",
"type": "integer",
"description": "An internal certificate ID value."
},
{
"id": "SecurityState",
"type": "string",
"enum": ["unknown", "neutral", "insecure", "secure", "info"],
"description": "The security level of a page or resource."
},
{
"id": "SecurityStateExplanation",
"type": "object",
"properties": [
{ "name": "securityState", "$ref": "SecurityState", "description": "Security state representing the severity of the factor being explained." },
{ "name": "summary", "type": "string", "description": "Short phrase describing the type of factor." },
{ "name": "description", "type": "string", "description": "Full text explanation of the factor." },
{ "name": "certificateId", "$ref": "CertificateId", "optional": true, "description": "Associated certificate id." }
],
"description": "An explanation of an factor contributing to the security state."
},
{
"id": "MixedContentStatus",
"type": "object",
"properties": [
{ "name": "ranInsecureContent", "type": "boolean", "description": "True if the page ran insecure content such as scripts." },
{ "name": "displayedInsecureContent", "type": "boolean", "description": "True if the page displayed insecure content such as images." },
{ "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 mixed content on the page."
}
],
"commands": [
{
"name": "enable",
"description": "Enables tracking security state changes.",
"handlers": ["browser"]
},
{
"name": "disable",
"description": "Disables tracking security state changes.",
"handlers": ["browser"]
}
],
"events": [
{
"name": "securityStateChanged",
"description": "The security state of the page changed.",
"parameters": [
{ "name": "securityState", "$ref": "SecurityState", "description": "Security state." },
{ "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.", "optional": true },
{ "name": "mixedContentStatus", "$ref": "MixedContentStatus", "description": "Information about mixed content on the page.", "optional": true },
{ "name": "schemeIsCryptographic", "type": "boolean", "description": "True if the page was loaded over cryptographic transport such as HTTPS.", "optional": true }
],
"handlers": ["browser"]
}
]
},
{
"domain": "Network",
"description": "Network domain allows tracking network activities of the page. It exposes information about http, file, data and other requests and responses, their headers, bodies, timing, etc.",
"dependencies": ["Runtime", "Security"],
"types": [
{
"id": "LoaderId",
"type": "string",
"description": "Unique loader identifier."
},
{
"id": "RequestId",
"type": "string",
"description": "Unique request identifier."
},
{
"id": "Timestamp",
"type": "number",
"description": "Number of seconds since epoch."
},
{
"id": "Headers",
"type": "object",
"description": "Request / response headers as keys / values of JSON object."
},
{
"id": "ConnectionType",
"type": "string",
"enum": ["none", "cellular2g", "cellular3g", "cellular4g", "bluetooth", "ethernet", "wifi", "wimax", "other"],
"description": "Loading priority of a resource request."
},
{
"id": "CookieSameSite",
"type": "string",
"enum": ["Strict", "Lax"],
"description": "Represents the cookie's 'SameSite' status: https://tools.ietf.org/html/draft-west-first-party-cookies"
},
{
"id": "ResourceTiming",
"type": "object",
"description": "Timing information for the request.",
"properties": [
{ "name": "requestTime", "type": "number", "description": "Timing's requestTime is a baseline in seconds, while the other numbers are ticks in milliseconds relatively to this requestTime." },
{ "name": "proxyStart", "type": "number", "description": "Started resolving proxy." },
{ "name": "proxyEnd", "type": "number", "description": "Finished resolving proxy." },
{ "name": "dnsStart", "type": "number", "description": "Started DNS address resolve." },
{ "name": "dnsEnd", "type": "number", "description": "Finished DNS address resolve." },
{ "name": "connectStart", "type": "number", "description": "Started connecting to the remote host." },
{ "name": "connectEnd", "type": "number", "description": "Connected to the remote host." },
{ "name": "sslStart", "type": "number", "description": "Started SSL handshake." },
{ "name": "sslEnd", "type": "number", "description": "Finished SSL handshake." },
{ "name": "workerStart", "type": "number", "description": "Started running ServiceWorker.", "experimental": true },
{ "name": "workerReady", "type": "number", "description": "Finished Starting ServiceWorker.", "experimental": true },
{ "name": "sendStart", "type": "number", "description": "Started sending request." },
{ "name": "sendEnd", "type": "number", "description": "Finished sending request." },
{ "name": "pushStart", "type": "number", "description": "Time the server started pushing request.", "experimental": true },
{ "name": "pushEnd", "type": "number", "description": "Time the server finished pushing request.", "experimental": true },
{ "name": "receiveHeadersEnd", "type": "number", "description": "Finished receiving response headers." }
]
},
{
"id": "ResourcePriority",
"type": "string",
"enum": ["VeryLow", "Low", "Medium", "High", "VeryHigh"],
"description": "Loading priority of a resource request."
},
{
"id": "Request",
"type": "object",
"description": "HTTP request data.",
"properties": [
{ "name": "url", "type": "string", "description": "Request URL." },
{ "name": "method", "type": "string", "description": "HTTP request method." },
{ "name": "headers", "$ref": "Headers", "description": "HTTP request headers." },
{ "name": "postData", "type": "string", "optional": true, "description": "HTTP POST request data." },
{ "name": "mixedContentType", "optional": true, "type": "string", "enum": ["blockable", "optionally-blockable", "none"], "description": "The mixed content status of the request, as defined in http://www.w3.org/TR/mixed-content/" },
{ "name": "initialPriority", "$ref": "ResourcePriority", "description": "Priority of the resource request at the time request is sent."}
]
},
{
"id": "CertificateSubject",
"type": "object",
"description": "Subject of a certificate.",
"properties": [
{ "name": "name", "type": "string", "description": "Certificate subject name." },
{ "name": "sanDnsNames", "type": "array", "items": { "type": "string" }, "description": "Subject Alternative Name (SAN) DNS names." },
{ "name": "sanIpAddresses", "type": "array", "items": { "type": "string" }, "description": "Subject Alternative Name (SAN) IP addresses." }
]
},
{
"id": "CertificateDetails",
"type": "object",
"description": "Details about a request's certificate.",
"properties": [
{ "name": "subject", "$ref": "CertificateSubject", "description": "Certificate subject." },
{ "name": "issuer", "type": "string", "description": "Name of the issuing CA." },
{ "name": "validFrom", "$ref": "Timestamp", "description": "Certificate valid from date." },
{ "name": "validTo", "$ref": "Timestamp", "description": "Certificate valid to (expiration) date" }
]
},
{
"id": "SignedCertificateTimestamp",
"type" : "object",
"description": "Details of a signed certificate timestamp (SCT).",
"properties": [
{ "name": "status", "type": "string", "description": "Validation status." },
{ "name": "origin", "type": "string", "description": "Origin." },
{ "name": "logDescription", "type": "string", "description": "Log name / description." },
{ "name": "logId", "type": "string", "description": "Log ID." },
{ "name": "timestamp", "$ref": "Timestamp", "description": "Issuance date." },
{ "name": "hashAlgorithm", "type": "string", "description": "Hash algorithm." },
{ "name": "signatureAlgorithm", "type": "string", "description": "Signature algorithm." },
{ "name": "signatureData", "type": "string", "description": "Signature data." }
]
},
{
"id": "SecurityDetails",
"type": "object",
"description": "Security details about a request.",
"properties": [
{ "name": "protocol", "type": "string", "description": "Protocol name (e.g. \"TLS 1.2\" or \"QUIC\")." },
{ "name": "keyExchange", "type": "string", "description": "Key Exchange used by the connection." },
{ "name": "cipher", "type": "string", "description": "Cipher name." },
{ "name": "mac", "type": "string", "optional": true, "description": "TLS MAC. Note that AEAD ciphers do not have separate MACs." },
{ "name": "certificateId", "$ref": "Security.CertificateId", "description": "Certificate ID value." },
{ "name": "signedCertificateTimestampList", "type": "array", "items": { "$ref": "SignedCertificateTimestamp" }, "description": "List of signed certificate timestamps (SCTs)." }
]
},
{
"id": "BlockedReason",
"type": "string",
"description": "The reason why request was blocked.",
"enum": ["csp", "mixed-content", "origin", "inspector", "subresource-filter", "other"],
"experimental": true
},
{
"id": "Response",
"type": "object",
"description": "HTTP response data.",
"properties": [
{ "name": "url", "type": "string", "description": "Response URL. This URL can be different from CachedResource.url in case of redirect." },
{ "name": "status", "type": "integer", "description": "HTTP response status code." },
{ "name": "statusText", "type": "string", "description": "HTTP response status text." },
{ "name": "headers", "$ref": "Headers", "description": "HTTP response headers." },
{ "name": "headersText", "type": "string", "optional": true, "description": "HTTP response headers text." },
{ "name": "mimeType", "type": "string", "description": "Resource mimeType as determined by the browser." },
{ "name": "requestHeaders", "$ref": "Headers", "optional": true, "description": "Refined HTTP request headers that were actually transmitted over the network." },
{ "name": "requestHeadersText", "type": "string", "optional": true, "description": "HTTP request headers text." },
{ "name": "connectionReused", "type": "boolean", "description": "Specifies whether physical connection was actually reused for this request." },
{ "name": "connectionId", "type": "number", "description": "Physical connection id that was actually used for this request." },
{ "name": "remoteIPAddress", "type": "string", "optional": true, "experimental": true, "description": "Remote IP address." },
{ "name": "remotePort", "type": "integer", "optional": true, "experimental": true, "description": "Remote port."},
{ "name": "fromDiskCache", "type": "boolean", "optional": true, "description": "Specifies that the request was served from the disk cache." },
{ "name": "fromServiceWorker", "type": "boolean", "optional": true, "description": "Specifies that the request was served from the ServiceWorker." },
{ "name": "encodedDataLength", "type": "number", "optional": false, "description": "Total number of bytes received for this request so far." },
{ "name": "timing", "$ref": "ResourceTiming", "optional": true, "description": "Timing information for the given request." },
{ "name": "protocol", "type": "string", "optional": true, "description": "Protocol used to fetch this request." },
{ "name": "securityState", "$ref": "Security.SecurityState", "description": "Security state of the request resource." },
{ "name": "securityDetails", "$ref": "SecurityDetails", "optional": true, "description": "Security details for the request." }
]
},
{
"id": "WebSocketRequest",
"type": "object",
"description": "WebSocket request data.",
"experimental": true,
"properties": [
{ "name": "headers", "$ref": "Headers", "description": "HTTP request headers." }
]
},
{
"id": "WebSocketResponse",
"type": "object",
"description": "WebSocket response data.",
"experimental": true,
"properties": [
{ "name": "status", "type": "integer", "description": "HTTP response status code." },
{ "name": "statusText", "type": "string", "description": "HTTP response status text." },
{ "name": "headers", "$ref": "Headers", "description": "HTTP response headers." },
{ "name": "headersText", "type": "string", "optional": true, "description": "HTTP response headers text." },
{ "name": "requestHeaders", "$ref": "Headers", "optional": true, "description": "HTTP request headers." },
{ "name": "requestHeadersText", "type": "string", "optional": true, "description": "HTTP request headers text." }
]
},
{
"id": "WebSocketFrame",
"type": "object",
"description": "WebSocket frame data.",
"experimental": true,
"properties": [
{ "name": "opcode", "type": "number", "description": "WebSocket frame opcode." },
{ "name": "mask", "type": "boolean", "description": "WebSocke frame mask." },
{ "name": "payloadData", "type": "string", "description": "WebSocke frame payload data." }
]
},
{
"id": "CachedResource",
"type": "object",
"description": "Information about the cached resource.",
"properties": [
{ "name": "url", "type": "string", "description": "Resource URL. This is the url of the original network request." },
{ "name": "type", "$ref": "Page.ResourceType", "description": "Type of this resource." },
{ "name": "response", "$ref": "Response", "optional": true, "description": "Cached response data." },
{ "name": "bodySize", "type": "number", "description": "Cached response body size." }
]
},
{
"id": "Initiator",
"type": "object",
"description": "Information about the request initiator.",
"properties": [
{ "name": "type", "type": "string", "enum": ["parser", "script", "other"], "description": "Type of this initiator." },
{ "name": "stack", "$ref": "Runtime.StackTrace", "optional": true, "description": "Initiator JavaScript stack trace, set for Script only." },
{ "name": "url", "type": "string", "optional": true, "description": "Initiator URL, set for Parser type only." },
{ "name": "lineNumber", "type": "number", "optional": true, "description": "Initiator line number, set for Parser type only (0-based)." }
]
},
{
"id": "Cookie",
"type": "object",
"description": "Cookie object",
"properties": [
{ "name": "name", "type": "string", "description": "Cookie name." },
{ "name": "value", "type": "string", "description": "Cookie value." },
{ "name": "domain", "type": "string", "description": "Cookie domain." },
{ "name": "path", "type": "string", "description": "Cookie path." },
{ "name": "expires", "type": "number", "description": "Cookie expiration date as the number of seconds since the UNIX epoch." },
{ "name": "size", "type": "integer", "description": "Cookie size." },
{ "name": "httpOnly", "type": "boolean", "description": "True if cookie is http-only." },
{ "name": "secure", "type": "boolean", "description": "True if cookie is secure." },
{ "name": "session", "type": "boolean", "description": "True in case of session cookie." },
{ "name": "sameSite", "$ref": "CookieSameSite", "optional": true, "description": "Cookie SameSite type." }
],
"experimental": true
}
],
"commands": [
{
"name": "enable",
"description": "Enables network tracking, network events will now be delivered to the client.",
"parameters": [
{ "name": "maxTotalBufferSize", "type": "integer", "optional": true, "experimental": true, "description": "Buffer size in bytes to use when preserving network payloads (XHRs, etc)." },
{ "name": "maxResourceBufferSize", "type": "integer", "optional": true, "experimental": true, "description": "Per-resource buffer size in bytes to use when preserving network payloads (XHRs, etc)." }
],
"handlers": ["renderer", "browser"]
},
{
"name": "disable",
"description": "Disables network tracking, prevents network events from being sent to the client.",
"handlers": ["renderer", "browser"]
},
{
"name": "setUserAgentOverride",
"description": "Allows overriding user agent with the given string.",
"parameters": [
{ "name": "userAgent", "type": "string", "description": "User agent to use." }
]
},
{
"name": "setExtraHTTPHeaders",
"description": "Specifies whether to always send extra HTTP headers with the requests from this page.",
"parameters": [
{ "name": "headers", "$ref": "Headers", "description": "Map with extra HTTP headers." }
]
},
{
"name": "getResponseBody",
"async": true,
"description": "Returns content served for the given request.",
"parameters": [
{ "name": "requestId", "$ref": "RequestId", "description": "Identifier of the network request to get content for." }
],
"returns": [
{ "name": "body", "type": "string", "description": "Response body." },
{ "name": "base64Encoded", "type": "boolean", "description": "True, if content was sent as base64." }
]
},
{
"name": "addBlockedURL",
"description": "Blocks specific URL from loading.",
"parameters": [
{ "name": "url", "type": "string", "description": "URL to block." }
],
"experimental": true
},
{
"name": "removeBlockedURL",
"description": "Cancels blocking of a specific URL from loading.",
"parameters": [
{ "name": "url", "type": "string", "description": "URL to stop blocking." }
],
"experimental": true
},
{
"name": "replayXHR",
"description": "This method sends a new XMLHttpRequest which is identical to the original one. The following parameters should be identical: method, url, async, request body, extra headers, withCredentials attribute, user, password.",
"parameters": [
{ "name": "requestId", "$ref": "RequestId", "description": "Identifier of XHR to replay." }
],
"experimental": true
},
{
"name": "setMonitoringXHREnabled",
"parameters": [
{ "name": "enabled", "type": "boolean", "description": "Monitoring enabled state." }
],
"description": "Toggles monitoring of XMLHttpRequest. If <code>true</code>, console will receive messages upon each XHR issued.",
"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.",
"handlers": ["browser"]
},
{
"name": "canClearBrowserCookies",
"description": "Tells whether clearing browser cookies is supported.",
"returns": [
{ "name": "result", "type": "boolean", "description": "True if browser cookies can be cleared." }
]
},
{
"name": "clearBrowserCookies",
"description": "Clears browser cookies.",
"handlers": ["browser"]
},
{
"name": "getCookies",
"parameters": [
{ "name": "urls", "type": "array", "items": { "type": "string" }, "optional": true, "description": "The list of URLs for which applicable cookies will be fetched" }
],
"returns": [
{ "name": "cookies", "type": "array", "items": { "$ref": "Cookie" }, "description": "Array of cookie objects." }
],
"description": "Returns all browser cookies. Depending on the backend support, will return detailed cookie information in the <code>cookies</code> field.",
"handlers": ["browser"],
"async": true,
"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.",
"handlers": ["browser"],
"async": true,
"experimental": true
},
{
"name": "setCookie",
"parameters": [
{ "name": "url", "type": "string", "description": "The request-URI to associate with the setting of the cookie. This value can affect the default domain and path values of the created cookie." },
{ "name": "name", "type": "string", "description": "The name of the cookie." },
{ "name": "value", "type": "string", "description": "The value of the cookie." },
{ "name": "domain", "type": "string", "optional": true, "description": "If omitted, the cookie becomes a host-only cookie." },
{ "name": "path", "type": "string", "optional": true, "description": "Defaults to the path portion of the url parameter." },
{ "name": "secure", "type": "boolean", "optional": true, "description": "Defaults ot false." },
{ "name": "httpOnly", "type": "boolean", "optional": true, "description": "Defaults to false." },
{ "name": "sameSite", "$ref": "CookieSameSite", "optional": true, "description": "Defaults to browser default behavior." },
{ "name": "expirationDate", "$ref": "Timestamp", "optional": true, "description": "If omitted, the cookie becomes a session cookie." }
],
"returns": [
{ "name": "success", "type": "boolean", "description": "True if successfully set cookie." }
],
"description": "Sets a cookie with the given cookie data; may overwrite equivalent cookies if they exist.",
"handlers": ["browser"],
"async": true,
"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,
"handlers": ["browser"]
},
{
"name": "emulateNetworkConditions",
"description": "Activates emulation of network conditions.",
"parameters": [
{ "name": "offline", "type": "boolean", "description": "True to emulate internet disconnection." },
{ "name": "latency", "type": "number", "description": "Additional latency (ms)." },
{ "name": "downloadThroughput", "type": "number", "description": "Maximal aggregated download throughput." },
{ "name": "uploadThroughput", "type": "number", "description": "Maximal aggregated upload throughput." },
{ "name": "connectionType", "$ref": "ConnectionType", "optional": true, "description": "Connection type if known."}
],
"handlers": ["browser", "renderer"]
},
{
"name": "setCacheDisabled",
"parameters": [
{ "name": "cacheDisabled", "type": "boolean", "description": "Cache disabled state." }
],
"description": "Toggles ignoring cache for each request. If <code>true</code>, cache will not be used."
},
{
"name": "setBypassServiceWorker",
"parameters": [
{ "name": "bypass", "type": "boolean", "description": "Bypass service worker and load from network." }
],
"experimental": true,
"description": "Toggles ignoring of service worker for each request."
},
{
"name": "setDataSizeLimitsForTest",
"parameters": [
{ "name": "maxTotalSize", "type": "integer", "description": "Maximum total buffer size." },
{ "name": "maxResourceSize", "type": "integer", "description": "Maximum per-resource size." }
],
"description": "For testing.",
"experimental": true
},
{
"name": "getCertificateDetails",
"description": "Returns details for the given certificate.",
"parameters": [
{ "name": "certificateId", "$ref": "Security.CertificateId", "description": "ID of the certificate to get details for." }
],
"returns": [
{ "name": "result", "$ref": "CertificateDetails", "description": "Certificate details." }
],
"handlers": ["browser"],
"experimental": true
},
{
"name": "showCertificateViewer",
"description": "Displays native dialog with the certificate details.",
"parameters": [
{ "name": "certificateId", "$ref": "Security.CertificateId", "description": "Certificate id." }
],
"handlers": ["browser"],
"experimental": true
}
],
"events": [
{
"name": "resourceChangedPriority",
"description": "Fired when resource loading priority is changed",
"parameters": [
{ "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
{ "name": "newPriority", "$ref": "ResourcePriority", "description": "New priority" },
{ "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." }
],
"experimental": true
},
{
"name": "requestWillBeSent",
"description": "Fired when page is about to send HTTP request.",
"parameters": [
{ "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
{ "name": "frameId", "$ref": "Page.FrameId", "description": "Frame identifier.", "experimental": true },
{ "name": "loaderId", "$ref": "LoaderId", "description": "Loader identifier." },
{ "name": "documentURL", "type": "string", "description": "URL of the document this request is loaded for." },
{ "name": "request", "$ref": "Request", "description": "Request data." },
{ "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
{ "name": "wallTime", "$ref": "Timestamp", "experimental": true, "description": "UTC Timestamp." },
{ "name": "initiator", "$ref": "Initiator", "description": "Request initiator." },
{ "name": "redirectResponse", "optional": true, "$ref": "Response", "description": "Redirect response data." },
{ "name": "type", "$ref": "Page.ResourceType", "optional": true, "experimental": true, "description": "Type of this resource." }
]
},
{
"name": "requestServedFromCache",
"description": "Fired if request ended up loading from cache.",
"parameters": [
{ "name": "requestId", "$ref": "RequestId", "description": "Request identifier." }
]
},
{
"name": "responseReceived",
"description": "Fired when HTTP response is available.",
"parameters": [
{ "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
{ "name": "frameId", "$ref": "Page.FrameId", "description": "Frame identifier.", "experimental": true },
{ "name": "loaderId", "$ref": "LoaderId", "description": "Loader identifier." },
{ "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
{ "name": "type", "$ref": "Page.ResourceType", "description": "Resource type." },
{ "name": "response", "$ref": "Response", "description": "Response data." }
]
},
{
"name": "dataReceived",
"description": "Fired when data chunk was received over the network.",
"parameters": [
{ "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
{ "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
{ "name": "dataLength", "type": "integer", "description": "Data chunk length." },
{ "name": "encodedDataLength", "type": "integer", "description": "Actual bytes received (might be less than dataLength for compressed encodings)." }
]
},
{
"name": "loadingFinished",
"description": "Fired when HTTP request has finished loading.",
"parameters": [
{ "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
{ "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
{ "name": "encodedDataLength", "type": "number", "description": "Total number of bytes received for this request." }
]
},
{
"name": "loadingFailed",
"description": "Fired when HTTP request has failed to load.",
"parameters": [
{ "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
{ "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
{ "name": "type", "$ref": "Page.ResourceType", "description": "Resource type." },
{ "name": "errorText", "type": "string", "description": "User friendly error message." },
{ "name": "canceled", "type": "boolean", "optional": true, "description": "True if loading was canceled." },
{ "name": "blockedReason", "$ref": "BlockedReason", "optional": true, "description": "The reason why loading was blocked, if any.", "experimental": true }
]
},
{
"name": "webSocketWillSendHandshakeRequest",
"description": "Fired when WebSocket is about to initiate handshake.",
"parameters": [
{ "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
{ "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
{ "name": "wallTime", "$ref": "Timestamp", "experimental": true, "description": "UTC Timestamp." },
{ "name": "request", "$ref": "WebSocketRequest", "description": "WebSocket request data." }
],
"experimental": true
},
{
"name": "webSocketHandshakeResponseReceived",
"description": "Fired when WebSocket handshake response becomes available.",
"parameters": [
{ "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
{ "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
{ "name": "response", "$ref": "WebSocketResponse", "description": "WebSocket response data." }
],
"experimental": true
},
{
"name": "webSocketCreated",
"description": "Fired upon WebSocket creation.",
"parameters": [
{ "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
{ "name": "url", "type": "string", "description": "WebSocket request URL." },
{ "name": "initiator", "$ref": "Initiator", "optional": true, "description": "Request initiator." }
],
"experimental": true
},
{
"name": "webSocketClosed",
"description": "Fired when WebSocket is closed.",
"parameters": [
{ "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
{ "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." }
],
"experimental": true
},
{
"name": "webSocketFrameReceived",
"description": "Fired when WebSocket frame is received.",
"parameters": [
{ "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
{ "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
{ "name": "response", "$ref": "WebSocketFrame", "description": "WebSocket response data." }
],
"experimental": true
},
{
"name": "webSocketFrameError",
"description": "Fired when WebSocket frame error occurs.",
"parameters": [
{ "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
{ "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
{ "name": "errorMessage", "type": "string", "description": "WebSocket frame error message." }
],
"experimental": true
},
{
"name": "webSocketFrameSent",
"description": "Fired when WebSocket frame is sent.",
"parameters": [
{ "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
{ "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
{ "name": "response", "$ref": "WebSocketFrame", "description": "WebSocket response data." }
],
"experimental": true
},
{
"name": "eventSourceMessageReceived",
"description": "Fired when EventSource message is received.",
"parameters": [
{ "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
{ "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
{ "name": "eventName", "type": "string", "description": "Message type." },
{ "name": "eventId", "type": "string", "description": "Message identifier." },
{ "name": "data", "type": "string", "description": "Message content." }
],
"experimental": true
}
]
},
{
"domain": "Database",
"experimental": true,
"types": [
{
"id": "DatabaseId",
"type": "string",
"description": "Unique identifier of Database object.",
"experimental": true
},
{
"id": "Database",
"type": "object",
"description": "Database object.",
"experimental": true,
"properties": [
{ "name": "id", "$ref": "DatabaseId", "description": "Database ID." },
{ "name": "domain", "type": "string", "description": "Database domain." },
{ "name": "name", "type": "string", "description": "Database name." },
{ "name": "version", "type": "string", "description": "Database version." }
]
},
{
"id": "Error",
"type": "object",
"description": "Database error.",
"properties": [
{ "name": "message", "type": "string", "description": "Error message." },
{ "name": "code", "type": "integer", "description": "Error code." }
]
}
],
"commands": [
{
"name": "enable",
"description": "Enables database tracking, database events will now be delivered to the client."
},
{
"name": "disable",
"description": "Disables database tracking, prevents database events from being sent to the client."
},
{
"name": "getDatabaseTableNames",
"parameters": [
{ "name": "databaseId", "$ref": "DatabaseId" }
],
"returns": [
{ "name": "tableNames", "type": "array", "items": { "type": "string" } }
]
},
{
"name": "executeSQL",
"async": true,
"parameters": [
{ "name": "databaseId", "$ref": "DatabaseId" },
{ "name": "query", "type": "string" }
],
"returns": [
{ "name": "columnNames", "type": "array", "optional": true, "items": { "type": "string" } },
{ "name": "values", "type": "array", "optional": true, "items": { "type": "any" }},
{ "name": "sqlError", "$ref": "Error", "optional": true }
]
}
],
"events": [
{
"name": "addDatabase",
"parameters": [
{ "name": "database", "$ref": "Database" }
]
}
]
},
{
"domain": "IndexedDB",
"dependencies": ["Runtime"],
"experimental": true,
"types": [
{
"id": "DatabaseWithObjectStores",
"type": "object",
"description": "Database with an array of object stores.",
"properties": [
{ "name": "name", "type": "string", "description": "Database name." },
{ "name": "version", "type": "integer", "description": "Database version." },
{ "name": "objectStores", "type": "array", "items": { "$ref": "ObjectStore" }, "description": "Object stores in this database." }
]
},
{
"id": "ObjectStore",
"type": "object",
"description": "Object store.",
"properties": [
{ "name": "name", "type": "string", "description": "Object store name." },
{ "name": "keyPath", "$ref": "KeyPath", "description": "Object store key path." },
{ "name": "autoIncrement", "type": "boolean", "description": "If true, object store has auto increment flag set." },
{ "name": "indexes", "type": "array", "items": { "$ref": "ObjectStoreIndex" }, "description": "Indexes in this object store." }
]
},
{
"id": "ObjectStoreIndex",
"type": "object",
"description": "Object store index.",
"properties": [
{ "name": "name", "type": "string", "description": "Index name." },
{ "name": "keyPath", "$ref": "KeyPath", "description": "Index key path." },
{ "name": "unique", "type": "boolean", "description": "If true, index is unique." },
{ "name": "multiEntry", "type": "boolean", "description": "If true, index allows multiple entries for a key." }
]
},
{
"id": "Key",
"type": "object",
"description": "Key.",
"properties": [
{ "name": "type", "type": "string", "enum": ["number", "string", "date", "array"], "description": "Key type." },
{ "name": "number", "type": "number", "optional": true, "description": "Number value." },
{ "name": "string", "type": "string", "optional": true, "description": "String value." },
{ "name": "date", "type": "number", "optional": true, "description": "Date value." },
{ "name": "array", "type": "array", "optional": true, "items": { "$ref": "Key" }, "description": "Array value." }
]
},
{
"id": "KeyRange",
"type": "object",
"description": "Key range.",
"properties": [
{ "name": "lower", "$ref": "Key", "optional": true, "description": "Lower bound." },
{ "name": "upper", "$ref": "Key", "optional": true, "description": "Upper bound." },
{ "name": "lowerOpen", "type": "boolean", "description": "If true lower bound is open." },
{ "name": "upperOpen", "type": "boolean", "description": "If true upper bound is open." }
]
},
{
"id": "DataEntry",
"type": "object",
"description": "Data entry.",
"properties": [
{ "name": "key", "$ref": "Runtime.RemoteObject", "description": "Key object." },
{ "name": "primaryKey", "$ref": "Runtime.RemoteObject", "description": "Primary key object." },
{ "name": "value", "$ref": "Runtime.RemoteObject", "description": "Value object." }
]
},
{
"id": "KeyPath",
"type": "object",
"description": "Key path.",
"properties": [
{ "name": "type", "type": "string", "enum": ["null", "string", "array"], "description": "Key path type." },
{ "name": "string", "type": "string", "optional": true, "description": "String value." },
{ "name": "array", "type": "array", "optional": true, "items": { "type": "string" }, "description": "Array value." }
]
}
],
"commands": [
{
"name": "enable",
"description": "Enables events from backend."
},
{
"name": "disable",
"description": "Disables events from backend."
},
{
"name": "requestDatabaseNames",
"async": true,
"parameters": [
{ "name": "securityOrigin", "type": "string", "description": "Security origin." }
],
"returns": [
{ "name": "databaseNames", "type": "array", "items": { "type": "string" }, "description": "Database names for origin." }
],
"description": "Requests database names for given security origin."
},
{
"name": "requestDatabase",
"async": true,
"parameters": [
{ "name": "securityOrigin", "type": "string", "description": "Security origin." },
{ "name": "databaseName", "type": "string", "description": "Database name." }
],
"returns": [
{ "name": "databaseWithObjectStores", "$ref": "DatabaseWithObjectStores", "description": "Database with an array of object stores." }
],
"description": "Requests database with given name in given frame."
},
{
"name": "requestData",
"async": true,
"parameters": [
{ "name": "securityOrigin", "type": "string", "description": "Security origin." },
{ "name": "databaseName", "type": "string", "description": "Database name." },
{ "name": "objectStoreName", "type": "string", "description": "Object store name." },
{ "name": "indexName", "type": "string", "description": "Index name, empty string for object store data requests." },
{ "name": "skipCount", "type": "integer", "description": "Number of records to skip." },
{ "name": "pageSize", "type": "integer", "description": "Number of records to fetch." },
{ "name": "keyRange", "$ref": "KeyRange", "optional": true, "description": "Key range." }
],
"returns": [
{ "name": "objectStoreDataEntries", "type": "array", "items": { "$ref": "DataEntry" }, "description": "Array of object store data entries." },
{ "name": "hasMore", "type": "boolean", "description": "If true, there are more entries to fetch in the given range." }
],
"description": "Requests data from object store or index."
},
{
"name": "clearObjectStore",
"async": true,
"parameters": [
{ "name": "securityOrigin", "type": "string", "description": "Security origin." },
{ "name": "databaseName", "type": "string", "description": "Database name." },
{ "name": "objectStoreName", "type": "string", "description": "Object store name." }
],
"returns": [
],
"description": "Clears all entries from an object store."
}
]
},
{
"domain": "CacheStorage",
"experimental": true,
"types": [
{
"id": "CacheId",
"type": "string",
"description": "Unique identifier of the Cache object."
},
{
"id": "DataEntry",
"type": "object",
"description": "Data entry.",
"properties": [
{ "name": "request", "type": "string", "description": "Request url spec." },
{ "name": "response", "type": "string", "description": "Response stataus text." }
]
},
{
"id": "Cache",
"type": "object",
"description": "Cache identifier.",
"properties": [
{ "name": "cacheId", "$ref": "CacheId", "description": "An opaque unique id of the cache." },
{ "name": "securityOrigin", "type": "string", "description": "Security origin of the cache." },
{ "name": "cacheName", "type": "string", "description": "The name of the cache." }
]
}
],
"commands": [
{
"name": "requestCacheNames",
"async": true,
"parameters": [
{ "name": "securityOrigin", "type": "string", "description": "Security origin." }
],
"returns": [
{ "name": "caches", "type": "array", "items": { "$ref": "Cache" }, "description": "Caches for the security origin." }
],
"description": "Requests cache names."
},
{
"name": "requestEntries",
"async": true,
"parameters": [
{ "name": "cacheId", "$ref": "CacheId", "description": "ID of cache to get entries from." },
{ "name": "skipCount", "type": "integer", "description": "Number of records to skip." },
{ "name": "pageSize", "type": "integer", "description": "Number of records to fetch." }
],
"returns": [
{ "name": "cacheDataEntries", "type": "array", "items": { "$ref": "DataEntry" }, "description": "Array of object store data entries." },
{ "name": "hasMore", "type": "boolean", "description": "If true, there are more entries to fetch in the given range." }
],
"description": "Requests data from cache."
},
{
"name": "deleteCache",
"async": true,
"parameters": [
{ "name": "cacheId", "$ref": "CacheId", "description": "Id of cache for deletion." }
],
"description": "Deletes a cache."
},
{
"name": "deleteEntry",
"async": true,
"parameters": [
{ "name": "cacheId", "$ref": "CacheId", "description": "Id of cache where the entry will be deleted." },
{ "name": "request", "type": "string", "description": "URL spec of the request." }
],
"description": "Deletes a cache entry."
}
]
},
{
"domain": "DOMStorage",
"experimental": true,
"description": "Query and modify DOM storage.",
"types": [
{
"id": "StorageId",
"type": "object",
"description": "DOM Storage identifier.",
"experimental": true,
"properties": [
{ "name": "securityOrigin", "type": "string", "description": "Security origin for the storage." },
{ "name": "isLocalStorage", "type": "boolean", "description": "Whether the storage is local storage (not session storage)." }
]
},
{
"id": "Item",
"type": "array",
"description": "DOM Storage item.",
"experimental": true,
"items": { "type": "string" }
}
],
"commands": [
{
"name": "enable",
"description": "Enables storage tracking, storage events will now be delivered to the client."
},
{
"name": "disable",
"description": "Disables storage tracking, prevents storage events from being sent to the client."
},
{
"name": "getDOMStorageItems",
"parameters": [
{ "name": "storageId", "$ref": "StorageId" }
],
"returns": [
{ "name": "entries", "type": "array", "items": { "$ref": "Item" } }
]
},
{
"name": "setDOMStorageItem",
"parameters": [
{ "name": "storageId", "$ref": "StorageId" },
{ "name": "key", "type": "string" },
{ "name": "value", "type": "string" }
]
},
{
"name": "removeDOMStorageItem",
"parameters": [
{ "name": "storageId", "$ref": "StorageId" },
{ "name": "key", "type": "string" }
]
}
],
"events": [
{
"name": "domStorageItemsCleared",
"parameters": [
{ "name": "storageId", "$ref": "StorageId" }
]
},
{
"name": "domStorageItemRemoved",
"parameters": [
{ "name": "storageId", "$ref": "StorageId" },
{ "name": "key", "type": "string" }
]
},
{
"name": "domStorageItemAdded",
"parameters": [
{ "name": "storageId", "$ref": "StorageId" },
{ "name": "key", "type": "string" },
{ "name": "newValue", "type": "string" }
]
},
{
"name": "domStorageItemUpdated",
"parameters": [
{ "name": "storageId", "$ref": "StorageId" },
{ "name": "key", "type": "string" },
{ "name": "oldValue", "type": "string" },
{ "name": "newValue", "type": "string" }
]
}
]
},
{
"domain": "ApplicationCache",
"experimental": true,
"types": [
{
"id": "ApplicationCacheResource",
"type": "object",
"description": "Detailed application cache resource information.",
"properties": [
{ "name": "url", "type": "string", "description": "Resource url." },
{ "name": "size", "type": "integer", "description": "Resource size." },
{ "name": "type", "type": "string", "description": "Resource type." }
]
},
{
"id": "ApplicationCache",
"type": "object",
"description": "Detailed application cache information.",
"properties": [
{ "name": "manifestURL", "type": "string", "description": "Manifest URL." },
{ "name": "size", "type": "number", "description": "Application cache size." },
{ "name": "creationTime", "type": "number", "description": "Application cache creation time." },
{ "name": "updateTime", "type": "number", "description": "Application cache update time." },
{ "name": "resources", "type": "array", "items": { "$ref": "ApplicationCacheResource" }, "description": "Application cache resources." }
]
},
{
"id": "FrameWithManifest",
"type": "object",
"description": "Frame identifier - manifest URL pair.",
"properties": [
{ "name": "frameId", "$ref": "Page.FrameId", "description": "Frame identifier." },
{ "name": "manifestURL", "type": "string", "description": "Manifest URL." },
{ "name": "status", "type": "integer", "description": "Application cache status." }
]
}
],
"commands": [
{
"name": "getFramesWithManifests",
"returns": [
{ "name": "frameIds", "type": "array", "items": { "$ref": "FrameWithManifest" }, "description": "Array of frame identifiers with manifest urls for each frame containing a document associated with some application cache." }
],
"description": "Returns array of frame identifiers with manifest urls for each frame containing a document associated with some application cache."
},
{
"name": "enable",
"description": "Enables application cache domain notifications."
},
{
"name": "getManifestForFrame",
"parameters": [
{ "name": "frameId", "$ref": "Page.FrameId", "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." },
{ "name": "nodeType", "type": "integer", "description": "<code>Node</code>'s nodeType." },
{ "name": "nodeName", "type": "string", "description": "<code>Node</code>'s nodeName." },
{ "name": "localName", "type": "string", "description": "<code>Node</code>'s localName." },
{ "name": "nodeValue", "type": "string", "description": "<code>Node</code>'s nodeValue." },
{ "name": "childNodeCount", "type": "integer", "optional": true, "description": "Child count for <code>Container</code> nodes." },
{ "name": "children", "type": "array", "optional": true, "items": { "$ref": "Node" }, "description": "Child nodes of this node when requested with children." },
{ "name": "attributes", "type": "array", "optional": true, "items": { "type": "string" }, "description": "Attributes of the <code>Element</code> node in the form of flat array <code>[name1, value1, name2, value2]</code>." },
{ "name": "documentURL", "type": "string", "optional": true, "description": "Document URL that <code>Document</code> or <code>FrameOwner</code> node points to." },
{ "name": "baseURL", "type": "string", "optional": true, "description": "Base URL that <code>Document</code> or <code>FrameOwner</code> node uses for URL completion.", "experimental": true },
{ "name": "publicId", "type": "string", "optional": true, "description": "<code>DocumentType</code>'s publicId." },
{ "name": "systemId", "type": "string", "optional": true, "description": "<code>DocumentType</code>'s systemId." },
{ "name": "internalSubset", "type": "string", "optional": true, "description": "<code>DocumentType</code>'s internalSubset." },
{ "name": "xmlVersion", "type": "string", "optional": true, "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 }
],
"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."
},
{
"id": "HighlightConfig",
"type": "object",
"properties": [
{ "name": "showInfo", "type": "boolean", "optional": true, "description": "Whether the node info tooltip should be shown (default: false)." },
{ "name": "showRulers", "type": "boolean", "optional": true, "description": "Whether the rulers should be shown (default: false)." },
{ "name": "showExtensionLines", "type": "boolean", "optional": true, "description": "Whether the extension lines from node to the rulers should be shown (default: false)." },
{ "name": "displayAsMaterial", "type": "boolean", "optional": true, "experimental": true},
{ "name": "contentColor", "$ref": "RGBA", "optional": true, "description": "The content box highlight fill color (default: transparent)." },
{ "name": "paddingColor", "$ref": "RGBA", "optional": true, "description": "The padding highlight fill color (default: transparent)." },
{ "name": "borderColor", "$ref": "RGBA", "optional": true, "description": "The border highlight fill color (default: transparent)." },
{ "name": "marginColor", "$ref": "RGBA", "optional": true, "description": "The margin highlight fill color (default: transparent)." },
{ "name": "eventTargetColor", "$ref": "RGBA", "optional": true, "experimental": true, "description": "The event target element highlight fill color (default: transparent)." },
{ "name": "shapeColor", "$ref": "RGBA", "optional": true, "experimental": true, "description": "The shape outside fill color (default: transparent)." },
{ "name": "shapeMarginColor", "$ref": "RGBA", "optional": true, "experimental": true, "description": "The shape margin fill color (default: transparent)." },
{ "name": "selectorList", "type": "string", "optional": true, "description": "Selectors to highlight relevant nodes."}
],
"description": "Configuration data for the highlighting of page elements."
},
{
"id": "InspectMode",
"type": "string",
"experimental": true,
"enum": [
"searchForNode",
"searchForUAShadowDOM",
"showLayoutEditor",
"none"
]
}
],
"commands": [
{
"name": "enable",
"description": "Enables DOM agent for the given page."
},
{
"name": "disable",
"description": "Disables DOM agent for the given page."
},