cookies field.",
"handlers": [
"browser"
],
"async": true,
"hidden": 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,
"hidden": true,
"redirect": "Network"
},
{
"name": "getResourceTree",
"description": "Returns present frame / resource tree structure.",
"returns": [
{
"name": "frameTree",
"$ref": "FrameResourceTree",
"description": "Present frame / resource tree structure."
}
],
"hidden": true
},
{
"name": "captureScreenshot",
"async": true,
"description": "Capture page screenshot.",
"parameters": [],
"returns": [
{
"name": "data",
"type": "string",
"description": "Base64-encoded image data (PNG)."
}
],
"hidden": true,
"handlers": [
"browser"
]
},
{
"name": "canScreencast",
"description": "Tells whether screencast is supported.",
"returns": [
{
"name": "result",
"type": "boolean",
"description": "True if screencast is supported."
}
],
"hidden": true,
"handlers": [
"browser"
]
},
{
"name": "startScreencast",
"description": "Starts sending each frame using the screencastFrame 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."
}
],
"hidden": true,
"handlers": [
"browser",
"renderer"
]
},
{
"name": "stopScreencast",
"description": "Stops sending each frame in the screencastFrame.",
"hidden": true,
"handlers": [
"browser",
"renderer"
]
},
{
"name": "screencastFrameAck",
"description": "Acknowledges that a screencast frame has been received by the frontend.",
"parameters": [
{
"name": "frameNumber",
"type": "integer",
"description": "Frame number."
}
],
"hidden": true,
"handlers": [
"browser"
]
},
{
"name": "setShowViewportSizeOnResize",
"description": "Paints viewport size upon main frame resize.",
"parameters": [
{
"name": "show",
"type": "boolean",
"description": "Whether to paint size or not."
},
{
"name": "showGrid",
"type": "boolean",
"optional": true,
"description": "Whether to paint grid as well."
}
],
"hidden": true
}
],
"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."
}
],
"hidden": true
},
{
"name": "frameStoppedLoading",
"description": "Fired when frame has stopped loading.",
"parameters": [
{
"name": "frameId",
"$ref": "FrameId",
"description": "Id of the frame that has stopped loading."
}
],
"hidden": 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."
}
],
"hidden": 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."
}
],
"hidden": true
},
{
"name": "frameResized",
"hidden": true
},
{
"name": "screencastFrame",
"description": "Compressed image data requested by the startScreencast.",
"parameters": [
{
"name": "data",
"type": "string",
"description": "Base64-encoded compressed image."
},
{
"name": "metadata",
"$ref": "ScreencastFrameMetadata",
"description": "Screencast frame metadata."
},
{
"name": "frameNumber",
"type": "integer",
"optional": true,
"description": "Frame number."
}
],
"hidden": true,
"handlers": [
"browser"
]
},
{
"name": "screencastVisibilityChanged",
"description": "Fired when the page with currently enabled screencast was shown or hidden .",
"parameters": [
{
"name": "visible",
"type": "boolean",
"description": "True if the page is visible."
}
],
"hidden": true,
"handlers": [
"browser"
]
}
]
},
{
"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": "RemoteObjectId",
"type": "string",
"description": "Unique object identifier."
},
{
"id": "RemoteObject",
"type": "object",
"description": "Mirror object referencing original JavaScript object.",
"properties": [
{
"name": "type",
"type": "string",
"enum": [
"object",
"function",
"undefined",
"string",
"number",
"boolean",
"symbol"
],
"description": "Object type."
},
{
"name": "subtype",
"type": "string",
"optional": true,
"enum": [
"array",
"null",
"node",
"regexp",
"date",
"map",
"set",
"iterator",
"generator",
"error"
],
"description": "Object subtype hint. Specified for object type values only."
},
{
"name": "className",
"type": "string",
"optional": true,
"description": "Object class (constructor) name. Specified for object type values only."
},
{
"name": "value",
"type": "any",
"optional": true,
"description": "Remote object value in case of primitive values or JSON values (if it was requested), or description string if the value can not be JSON-stringified (like NaN, Infinity, -Infinity, -0)."
},
{
"name": "description",
"type": "string",
"optional": true,
"description": "String representation of the object."
},
{
"name": "objectId",
"$ref": "RemoteObjectId",
"optional": true,
"description": "Unique object identifier (for non-primitive values)."
},
{
"name": "preview",
"$ref": "ObjectPreview",
"optional": true,
"description": "Preview containing abbreviated property values. Specified for object type values only.",
"hidden": true
},
{
"name": "customPreview",
"$ref": "CustomPreview",
"optional": true,
"hidden": true
}
]
},
{
"id": "EntryPreview",
"type": "object",
"hidden": 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 undefined 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 undefined if there is no setter (accessor descriptors only)."
},
{
"name": "configurable",
"type": "boolean",
"description": "True if the type of this property descriptor may be changed and if the property may be deleted from the corresponding object."
},
{
"name": "enumerable",
"type": "boolean",
"description": "True if this property shows up during enumeration of the properties on the corresponding object."
},
{
"name": "wasThrown",
"type": "boolean",
"optional": true,
"description": "True if the result was thrown during the evaluation."
},
{
"name": "isOwn",
"optional": true,
"type": "boolean",
"description": "True if the property is owned for the object.",
"hidden": true
},
{
"name": "symbol",
"$ref": "RemoteObject",
"optional": true,
"description": "Property symbol object, if the property is of the symbol type.",
"hidden": true
}
]
},
{
"id": "InternalPropertyDescriptor",
"type": "object",
"description": "Object internal property descriptor. This property isn't normally visible in JavaScript code.",
"properties": [
{
"name": "name",
"type": "string",
"description": "Conventional property name."
},
{
"name": "value",
"$ref": "RemoteObject",
"optional": true,
"description": "The value associated with the property."
}
],
"hidden": true
},
{
"id": "CallArgument",
"type": "object",
"description": "Represents function call argument. Either remote object id objectId or primitive value or neither of (for undefined) them should be specified.",
"properties": [
{
"name": "value",
"type": "any",
"optional": true,
"description": "Primitive value, or description string if the value can not be JSON-stringified (like NaN, Infinity, -Infinity, -0)."
},
{
"name": "objectId",
"$ref": "RemoteObjectId",
"optional": true,
"description": "Remote object handle."
},
{
"name": "type",
"optional": true,
"hidden": true,
"type": "string",
"enum": [
"object",
"function",
"undefined",
"string",
"number",
"boolean",
"symbol"
],
"description": "Object type."
}
]
},
{
"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": "type",
"type": "string",
"optional": true,
"description": "Context type. It is used e.g. to distinguish content scripts from web page script.",
"hidden": true
},
{
"name": "origin",
"type": "string",
"description": "Execution context origin.",
"hidden": true
},
{
"name": "name",
"type": "string",
"description": "Human readable name describing given context.",
"hidden": true
},
{
"name": "frameId",
"type": "string",
"description": "Id of the owning frame. May be an empty string if the context is not associated with a frame."
}
]
}
],
"commands": [
{
"name": "evaluate",
"parameters": [
{
"name": "expression",
"type": "string",
"description": "Expression to evaluate."
},
{
"name": "objectGroup",
"type": "string",
"optional": true,
"description": "Symbolic group name that can be used to release multiple objects."
},
{
"name": "includeCommandLineAPI",
"type": "boolean",
"optional": true,
"description": "Determines whether Command Line API should be available during the evaluation.",
"hidden": true
},
{
"name": "doNotPauseOnExceptionsAndMuteConsole",
"type": "boolean",
"optional": true,
"description": "Specifies whether evaluation should stop on exceptions and mute console. Overrides setPauseOnException state.",
"hidden": true
},
{
"name": "contextId",
"$ref": "ExecutionContextId",
"optional": true,
"description": "Specifies in which isolated context to perform evaluation. Each content script lives in an isolated context and this parameter may be used to specify one of those contexts. If the parameter is omitted or 0 the evaluation will be performed in the context of the inspected page."
},
{
"name": "returnByValue",
"type": "boolean",
"optional": true,
"description": "Whether the result is expected to be a JSON object that should be sent by value."
},
{
"name": "generatePreview",
"type": "boolean",
"optional": true,
"hidden": true,
"description": "Whether preview should be generated for the result."
}
],
"returns": [
{
"name": "result",
"$ref": "RemoteObject",
"description": "Evaluation result."
},
{
"name": "wasThrown",
"type": "boolean",
"optional": true,
"description": "True if the result was thrown during the evaluation."
},
{
"name": "exceptionDetails",
"$ref": "Debugger.ExceptionDetails",
"optional": true,
"hidden": true,
"description": "Exception details."
}
],
"description": "Evaluates expression on global object."
},
{
"name": "callFunctionOn",
"parameters": [
{
"name": "objectId",
"$ref": "RemoteObjectId",
"description": "Identifier of the object to call function on."
},
{
"name": "functionDeclaration",
"type": "string",
"description": "Declaration of the function to call."
},
{
"name": "arguments",
"type": "array",
"items": {
"$ref": "CallArgument",
"description": "Call argument."
},
"optional": true,
"description": "Call arguments. All call arguments must belong to the same JavaScript world as the target object."
},
{
"name": "doNotPauseOnExceptionsAndMuteConsole",
"type": "boolean",
"optional": true,
"description": "Specifies whether function call should stop on exceptions and mute console. Overrides setPauseOnException state.",
"hidden": true
},
{
"name": "returnByValue",
"type": "boolean",
"optional": true,
"description": "Whether the result is expected to be a JSON object which should be sent by value."
},
{
"name": "generatePreview",
"type": "boolean",
"optional": true,
"hidden": true,
"description": "Whether preview should be generated for the result."
}
],
"returns": [
{
"name": "result",
"$ref": "RemoteObject",
"description": "Call result."
},
{
"name": "wasThrown",
"type": "boolean",
"optional": true,
"description": "True if the result was thrown during the evaluation."
}
],
"description": "Calls function with given declaration on the given object. Object group of the result is inherited from the target object."
},
{
"name": "getProperties",
"parameters": [
{
"name": "objectId",
"$ref": "RemoteObjectId",
"description": "Identifier of the object to return properties for."
},
{
"name": "ownProperties",
"optional": true,
"type": "boolean",
"description": "If true, returns properties belonging only to the element itself, not to its prototype chain."
},
{
"name": "accessorPropertiesOnly",
"optional": true,
"type": "boolean",
"description": "If true, returns accessor properties (with getter/setter) only; internal properties are not returned either.",
"hidden": true
},
{
"name": "generatePreview",
"type": "boolean",
"optional": true,
"hidden": true,
"description": "Whether preview should be generated for the results."
}
],
"returns": [
{
"name": "result",
"type": "array",
"items": {
"$ref": "PropertyDescriptor"
},
"description": "Object properties."
},
{
"name": "internalProperties",
"optional": true,
"type": "array",
"items": {
"$ref": "InternalPropertyDescriptor"
},
"description": "Internal object properties (only of the element itself).",
"hidden": true
},
{
"name": "exceptionDetails",
"$ref": "Debugger.ExceptionDetails",
"optional": true,
"hidden": true,
"description": "Exception details."
}
],
"description": "Returns properties of a given object. Object group of the result is inherited from the target object."
},
{
"name": "run",
"hidden": true,
"description": "Tells inspected instance(worker or page) that it can run in case it was started paused."
},
{
"name": "enable",
"description": "Enables reporting of execution contexts creation by means of executionContextCreated event. When the reporting gets enabled the event will be sent immediately for each existing execution context."
},
{
"name": "disable",
"hidden": true,
"description": "Disables reporting of execution contexts creation."
}
],
"events": [
{
"name": "executionContextCreated",
"parameters": [
{
"name": "context",
"$ref": "ExecutionContextDescription",
"description": "A newly created execution contex."
}
],
"description": "Issued when new execution context is created."
},
{
"name": "executionContextDestroyed",
"parameters": [
{
"name": "executionContextId",
"$ref": "ExecutionContextId",
"description": "Id of the destroyed context"
}
],
"description": "Issued when execution context is destroyed."
},
{
"name": "executionContextsCleared",
"description": "Issued when all executionContexts were cleared in browser"
}
]
},
{
"domain": "DOM",
"description": "This domain exposes DOM read/write operations. Each DOM Node is represented with its mirror object that has an id. This id 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.Note that iframe owner elements will return corresponding document elements as their child nodes.
Node's nodeType."
},
{
"name": "nodeName",
"type": "string",
"description": "Node's nodeName."
},
{
"name": "backendNodeId",
"$ref": "BackendNodeId"
}
],
"hidden": 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 nodeId. Backend will only push node with given id 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": "Node's nodeType."
},
{
"name": "nodeName",
"type": "string",
"description": "Node's nodeName."
},
{
"name": "localName",
"type": "string",
"description": "Node's localName."
},
{
"name": "nodeValue",
"type": "string",
"description": "Node's nodeValue."
},
{
"name": "childNodeCount",
"type": "integer",
"optional": true,
"description": "Child count for Container 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 Element node in the form of flat array [name1, value1, name2, value2]."
},
{
"name": "documentURL",
"type": "string",
"optional": true,
"description": "Document URL that Document or FrameOwner node points to."
},
{
"name": "baseURL",
"type": "string",
"optional": true,
"description": "Base URL that Document or FrameOwner node uses for URL completion.",
"hidden": true
},
{
"name": "publicId",
"type": "string",
"optional": true,
"description": "DocumentType's publicId."
},
{
"name": "systemId",
"type": "string",
"optional": true,
"description": "DocumentType's systemId."
},
{
"name": "internalSubset",
"type": "string",
"optional": true,
"description": "DocumentType's internalSubset."
},
{
"name": "xmlVersion",
"type": "string",
"optional": true,
"description": "Document's XML version in case of XML documents."
},
{
"name": "name",
"type": "string",
"optional": true,
"description": "Attr's name."
},
{
"name": "value",
"type": "string",
"optional": true,
"description": "Attr's value."
},
{
"name": "pseudoType",
"$ref": "PseudoType",
"optional": true,
"description": "Pseudo element type for this node."
},
{
"name": "shadowRootType",
"$ref": "ShadowRootType",
"optional": true,
"description": "Shadow root type."
},
{
"name": "frameId",
"$ref": "Page.FrameId",
"optional": true,
"description": "Frame ID for frame owner elements.",
"hidden": true
},
{
"name": "contentDocument",
"$ref": "Node",
"optional": true,
"description": "Content document for frame owner elements."
},
{
"name": "shadowRoots",
"type": "array",
"optional": true,
"items": {
"$ref": "Node"
},
"description": "Shadow root list for given element host.",
"hidden": true
},
{
"name": "templateContent",
"$ref": "Node",
"optional": true,
"description": "Content document fragment for template elements.",
"hidden": true
},
{
"name": "pseudoElements",
"type": "array",
"items": {
"$ref": "Node"
},
"optional": true,
"description": "Pseudo elements associated with this node.",
"hidden": true
},
{
"name": "importedDocument",
"$ref": "Node",
"optional": true,
"description": "Import document for the HTMLImport links."
},
{
"name": "distributedNodes",
"type": "array",
"items": {
"$ref": "BackendNode"
},
"optional": true,
"description": "Distributed nodes for given insertion point.",
"hidden": true
}
],
"description": "DOM interaction is implemented in terms of mirror objects that represent the actual DOM nodes. DOMNode is a base node mirror type."
},
{
"id": "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.",
"hidden": true
},
{
"id": "BoxModel",
"type": "object",
"hidden": 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",
"hidden": 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",
"hidden": 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,
"hidden": true
},
{
"name": "contentColor",
"$ref": "RGBA",
"optional": true,
"description": "The content box highlight fill color (default: transparent)."
},
{
"name": "paddingColor",
"$ref": "RGBA",
"optional": true,
"description": "The padding highlight fill color (default: transparent)."
},
{
"name": "borderColor",
"$ref": "RGBA",
"optional": true,
"description": "The border highlight fill color (default: transparent)."
},
{
"name": "marginColor",
"$ref": "RGBA",
"optional": true,
"description": "The margin highlight fill color (default: transparent)."
},
{
"name": "eventTargetColor",
"$ref": "RGBA",
"optional": true,
"hidden": true,
"description": "The event target element highlight fill color (default: transparent)."
},
{
"name": "shapeColor",
"$ref": "RGBA",
"optional": true,
"hidden": true,
"description": "The shape outside fill color (default: transparent)."
},
{
"name": "shapeMarginColor",
"$ref": "RGBA",
"optional": true,
"hidden": true,
"description": "The shape margin fill color (default: transparent)."
}
],
"description": "Configuration data for the highlighting of page elements."
},
{
"id": "InspectMode",
"type": "string",
"hidden": 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."
},
{
"name": "getDocument",
"returns": [
{
"name": "root",
"$ref": "Node",
"description": "Resulting node."
}
],
"description": "Returns the root DOM node to the caller."
},
{
"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 querySelector 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 querySelectorAll on a given node."
},
{
"name": "getOuterHTML",
"parameters": [
{
"name": "nodeId",
"$ref": "NodeId",
"optional": true,
"description": "Identifier of the node."
},
{
"name": "backendNodeId",
"$ref": "BackendNodeId",
"optional": true,
"description": "Identifier of the backend node."
},
{
"name": "objectId",
"$ref": "Runtime.RemoteObjectId",
"optional": true,
"description": "JavaScript object id of the node wrapper."
}
],
"returns": [
{
"name": "outerHTML",
"type": "string",
"description": "Outer HTML markup."
}
],
"description": "Returns node's HTML markup."
},
{
"name": "requestChildNodes",
"parameters": [
{
"name": "nodeId",
"$ref": "NodeId",
"description": "Id of the node to get children for."
},
{
"name": "depth",
"type": "integer",
"optional": true,
"description": "The maximum depth at which children should be retrieved, defaults to 1. Use -1 for the entire subtree or provide an integer larger than 0.",
"hidden": true
}
],
"description": "Requests that children of the node with given id are returned to the caller in form of setChildNodes events where not only immediate children are retrieved, but all children down to the specified depth."
},
{
"name": "highlightNode",
"parameters": [
{
"name": "highlightConfig",
"$ref": "HighlightConfig",
"description": "A descriptor for the highlight appearance."
},
{
"name": "nodeId",
"$ref": "NodeId",
"optional": true,
"description": "Identifier of the node to highlight."
},
{
"name": "backendNodeId",
"$ref": "BackendNodeId",
"optional": true,
"description": "Identifier of the backend node to highlight."
},
{
"name": "objectId",
"$ref": "Runtime.RemoteObjectId",
"optional": true,
"description": "JavaScript object id of the node to be highlighted.",
"hidden": true
}
],
"description": "Highlights DOM node with given id or with the given JavaScript object wrapper. Either nodeId or objectId must be specified."
},
{
"name": "hideHighlight",
"description": "Hides DOM node highlight."
},
{
"name": "pushNodeByPathToFrontend",
"parameters": [
{
"name": "path",
"type": "string",
"description": "Path to node in the proprietary format."
}
],
"returns": [
{
"name": "nodeId",
"$ref": "NodeId",
"description": "Id of the node for given path."
}
],
"description": "Requests that the node is sent to the caller given its path. // FIXME, use XPath",
"hidden": true
},
{
"name": "pushNodesByBackendIdsToFrontend",
"parameters": [
{
"name": "backendNodeIds",
"type": "array",
"items": {
"$ref": "BackendNodeId"
},
"description": "The array of backend node ids."
}
],
"returns": [
{
"name": "nodeIds",
"type": "array",
"items": {
"$ref": "NodeId"
},
"description": "The array of ids of pushed nodes that correspond to the backend ids specified in backendNodeIds."
}
],
"description": "Requests that a batch of nodes is sent to the caller given their backend node ids.",
"hidden": true
},
{
"name": "getAttributes",
"parameters": [
{
"name": "nodeId",
"$ref": "NodeId",
"description": "Id of the node to retrieve attibutes for."
}
],
"returns": [
{
"name": "attributes",
"type": "array",
"items": {
"type": "string"
},
"description": "An interleaved array of node attribute names and values."
}
],
"description": "Returns attributes for the specified node."
}
],
"events": [
{
"name": "documentUpdated",
"description": "Fired when Document has been totally updated. Node ids are no longer valid."
},
{
"name": "inspectNodeRequested",
"parameters": [
{
"name": "backendNodeId",
"$ref": "BackendNodeId",
"description": "Id of the node to inspect."
}
],
"description": "Fired when the node should be inspected. This happens after call to setInspectMode.",
"hidden": true
},
{
"name": "setChildNodes",
"parameters": [
{
"name": "parentId",
"$ref": "NodeId",
"description": "Parent node id to populate with children."
},
{
"name": "nodes",
"type": "array",
"items": {
"$ref": "Node"
},
"description": "Child nodes array."
}
],
"description": "Fired when backend wants to provide client with the missing DOM structure. This happens upon most of the calls requesting node ids."
},
{
"name": "attributeModified",
"parameters": [
{
"name": "nodeId",
"$ref": "NodeId",
"description": "Id of the node that has changed."
},
{
"name": "name",
"type": "string",
"description": "Attribute name."
},
{
"name": "value",
"type": "string",
"description": "Attribute value."
}
],
"description": "Fired when Element's attribute is modified."
},
{
"name": "attributeRemoved",
"parameters": [
{
"name": "nodeId",
"$ref": "NodeId",
"description": "Id of the node that has changed."
},
{
"name": "name",
"type": "string",
"description": "A ttribute name."
}
],
"description": "Fired when Element's attribute is removed."
},
{
"name": "inlineStyleInvalidated",
"parameters": [
{
"name": "nodeIds",
"type": "array",
"items": {
"$ref": "NodeId"
},
"description": "Ids of the nodes for which the inline styles have been invalidated."
}
],
"description": "Fired when Element's inline style is modified via a CSS property modification.",
"hidden": true
},
{
"name": "characterDataModified",
"parameters": [
{
"name": "nodeId",
"$ref": "NodeId",
"description": "Id of the node that has changed."
},
{
"name": "characterData",
"type": "string",
"description": "New text value."
}
],
"description": "Mirrors DOMCharacterDataModified event."
},
{
"name": "childNodeCountUpdated",
"parameters": [
{
"name": "nodeId",
"$ref": "NodeId",
"description": "Id of the node that has changed."
},
{
"name": "childNodeCount",
"type": "integer",
"description": "New node count."
}
],
"description": "Fired when Container's child node count has changed."
},
{
"name": "childNodeInserted",
"parameters": [
{
"name": "parentNodeId",
"$ref": "NodeId",
"description": "Id of the node that has changed."
},
{
"name": "previousNodeId",
"$ref": "NodeId",
"description": "If of the previous siblint."
},
{
"name": "node",
"$ref": "Node",
"description": "Inserted node data."
}
],
"description": "Mirrors DOMNodeInserted event."
},
{
"name": "childNodeRemoved",
"parameters": [
{
"name": "parentNodeId",
"$ref": "NodeId",
"description": "Parent id."
},
{
"name": "nodeId",
"$ref": "NodeId",
"description": "Id of the node that has been removed."
}
],
"description": "Mirrors DOMNodeRemoved event."
},
{
"name": "shadowRootPushed",
"parameters": [
{
"name": "hostId",
"$ref": "NodeId",
"description": "Host element id."
},
{
"name": "root",
"$ref": "Node",
"description": "Shadow root."
}
],
"description": "Called when shadow root is pushed into the element.",
"hidden": 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.",
"hidden": 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.",
"hidden": 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.",
"hidden": 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.",
"hidden": true
}
]
},
{
"domain": "CSS",
"hidden": true,
"description": "This domain exposes CSS read/write operations. All CSS objects (stylesheets, rules, and styles) have an associated id used in subsequent operations on the related object. Each object type has a specific id structure, and those are not interchangeable between objects of different kinds. CSS objects can be loaded using the get*ForNode() calls (which accept a DOM node id). A client can also discover all the existing stylesheets with the getAllStyleSheets() method (or keeping track of the styleSheetAdded/styleSheetRemoved events) and subsequently load the required stylesheet contents using the getStyleSheet[Text]() methods.",
"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": "PseudoIdMatches",
"type": "object",
"properties": [
{
"name": "pseudoId",
"type": "integer",
"description": "Pseudo style identifier (see enum PseudoId in ComputedStyleConstants.h)."
},
{
"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": "Selector",
"type": "object",
"properties": [
{
"name": "value",
"type": "string",
"description": "Selector text."
},
{
"name": "range",
"$ref": "SourceRange",
"optional": true,
"description": "Selector range in the underlying resource (if available)."
}
],
"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": "Selector"
},
"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": "CSS stylesheet metainformation."
},
{
"id": "CSSRule",
"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": "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": "SourceRange",
"type": "object",
"properties": [
{
"name": "startLine",
"type": "integer",
"description": "Start line of range."
},
{
"name": "startColumn",
"type": "integer",
"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 false 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 false if absent)."
},
{
"name": "implicit",
"type": "boolean",
"optional": true,
"description": "Whether the property is implicit (implies false 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 true 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": "parentStyleSheetId",
"$ref": "StyleSheetId",
"optional": true,
"description": "Identifier of the stylesheet containing this object (if exists)."
},
{
"name": "mediaList",
"type": "array",
"items": {
"$ref": "MediaQuery"
},
"optional": true,
"hidden": true,
"description": "Array of media queries."
}
],
"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.",
"hidden": 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": "Media query expression descriptor.",
"hidden": true
},
{
"id": "PlatformFontUsage",
"type": "object",
"properties": [
{
"name": "familyName",
"type": "string",
"description": "Font's family name reported by platform."
},
{
"name": "glyphCount",
"type": "number",
"description": "Amount of glyphs that were rendered with this font."
}
],
"description": "Information about amount of glyphs that were rendered with given font.",
"hidden": true
}
],
"commands": [
{
"name": "enable",
"async": true,
"description": "Enables the CSS agent for the given page. Clients should not assume that the CSS agent has been enabled until the result of this command is received."
},
{
"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": "PseudoIdMatches"
},
"optional": true,
"description": "Pseudo style matches for this node."
},
{
"name": "inherited",
"type": "array",
"items": {
"$ref": "InheritedStyleEntry"
},
"optional": true,
"description": "A chain of inherited styles (from the immediate node parent up to the DOM tree root)."
}
],
"description": "Returns requested styles for a DOM node identified by nodeId."
},
{
"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 nodeId."
},
{
"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 nodeId."
},
{
"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."
}
],
"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": "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."
},
{
"name": "layoutEditorChange",
"parameters": [
{
"name": "styleSheetId",
"$ref": "StyleSheetId",
"description": "Identifier of the stylesheet where the modification occurred."
},
{
"name": "changeRange",
"$ref": "SourceRange",
"description": "Range where the modification occurred."
}
]
}
]
},
{
"domain": "Debugger",
"description": "Debugger domain exposes JavaScript debugging capabilities. It allows setting and removing breakpoints, stepping through execution, exploring stack traces, etc.",
"types": [
{
"id": "BreakpointId",
"type": "string",
"description": "Breakpoint identifier."
},
{
"id": "ScriptId",
"type": "string",
"description": "Unique script identifier."
},
{
"id": "CallFrameId",
"type": "string",
"description": "Call frame identifier."
},
{
"id": "Location",
"type": "object",
"properties": [
{
"name": "scriptId",
"$ref": "ScriptId",
"description": "Script identifier as reported in the Debugger.scriptParsed."
},
{
"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": "FunctionDetails",
"hidden": true,
"type": "object",
"properties": [
{
"name": "location",
"$ref": "Location",
"optional": true,
"description": "Location of the function, none for native functions."
},
{
"name": "functionName",
"type": "string",
"description": "Name of the function."
},
{
"name": "isGenerator",
"type": "boolean",
"description": "Whether this is a generator function."
},
{
"name": "scopeChain",
"type": "array",
"optional": true,
"items": {
"$ref": "Scope"
},
"description": "Scope chain for this closure."
}
],
"description": "Information about the function."
},
{
"id": "GeneratorObjectDetails",
"hidden": true,
"type": "object",
"properties": [
{
"name": "function",
"$ref": "Runtime.RemoteObject",
"description": "Generator function."
},
{
"name": "functionName",
"type": "string",
"description": "Name of the generator function."
},
{
"name": "status",
"type": "string",
"enum": [
"running",
"suspended",
"closed"
],
"description": "Current generator object status."
},
{
"name": "location",
"$ref": "Location",
"optional": true,
"description": "If suspended, location where generator function was suspended (e.g. location of the last 'yield'). Otherwise, location of the generator function."
}
],
"description": "Information about the generator object."
},
{
"id": "CollectionEntry",
"hidden": true,
"type": "object",
"properties": [
{
"name": "key",
"$ref": "Runtime.RemoteObject",
"optional": true,
"description": "Entry key of a map-like collection, otherwise not provided."
},
{
"name": "value",
"$ref": "Runtime.RemoteObject",
"description": "Entry value."
}
],
"description": "Collection entry."
},
{
"id": "CallFrame",
"type": "object",
"properties": [
{
"name": "callFrameId",
"$ref": "CallFrameId",
"description": "Call frame identifier. This identifier is only valid while the virtual machine is paused."
},
{
"name": "functionName",
"type": "string",
"description": "Name of the JavaScript function called on this call frame."
},
{
"name": "functionLocation",
"$ref": "Location",
"optional": true,
"hidden": true,
"description": "Location in the source code."
},
{
"name": "location",
"$ref": "Location",
"description": "Location in the source code."
},
{
"name": "scopeChain",
"type": "array",
"items": {
"$ref": "Scope"
},
"description": "Scope chain for this call frame."
},
{
"name": "this",
"$ref": "Runtime.RemoteObject",
"description": "this object for this call frame."
},
{
"name": "returnValue",
"$ref": "Runtime.RemoteObject",
"optional": true,
"hidden": true,
"description": "The value being returned, if the function is at return point."
}
],
"description": "JavaScript call frame. Array of call frames form the call stack."
},
{
"id": "StackTrace",
"type": "object",
"properties": [
{
"name": "callFrames",
"type": "array",
"items": {
"$ref": "CallFrame"
},
"description": "Call frames of the stack trace."
},
{
"name": "description",
"type": "string",
"optional": true,
"description": "String label of this stack trace. For async traces this may be a name of the function that initiated the async call."
},
{
"name": "asyncStackTrace",
"$ref": "StackTrace",
"optional": true,
"description": "Async stack trace, if any."
}
],
"description": "JavaScript call stack, including async stack traces.",
"hidden": true
},
{
"id": "Scope",
"type": "object",
"properties": [
{
"name": "type",
"type": "string",
"enum": [
"global",
"local",
"with",
"closure",
"catch",
"block",
"script"
],
"description": "Scope type."
},
{
"name": "object",
"$ref": "Runtime.RemoteObject",
"description": "Object representing the scope. For global and with scopes it represents the actual object; for the rest of the scopes, it is artificial transient object enumerating scope variables as its properties."
}
],
"description": "Scope description."
},
{
"id": "ExceptionDetails",
"type": "object",
"description": "Detailed information on exception (or error) that was thrown during script compilation or execution.",
"properties": [
{
"name": "text",
"type": "string",
"description": "Exception text."
},
{
"name": "url",
"type": "string",
"optional": true,
"description": "URL of the message origin."
},
{
"name": "scriptId",
"type": "string",
"optional": true,
"description": "Script ID of the message origin."
},
{
"name": "line",
"type": "integer",
"optional": true,
"description": "Line number in the resource that generated this message."
},
{
"name": "column",
"type": "integer",
"optional": true,
"description": "Column number in the resource that generated this message."
},
{
"name": "stackTrace",
"$ref": "Console.StackTrace",
"optional": true,
"description": "JavaScript stack trace for assertions and error messages."
}
]
},
{
"id": "SetScriptSourceError",
"type": "object",
"properties": [
{
"name": "compileError",
"optional": true,
"type": "object",
"properties": [
{
"name": "message",
"type": "string",
"description": "Compiler error message"
},
{
"name": "lineNumber",
"type": "integer",
"description": "Compile error line number (1-based)"
},
{
"name": "columnNumber",
"type": "integer",
"description": "Compile error column number (1-based)"
}
]
}
],
"description": "Error data for setScriptSource command. compileError is a case type for uncompilable script source error.",
"hidden": true
},
{
"id": "PromiseDetails",
"type": "object",
"description": "Information about the promise. All fields but id are optional and if present they reflect the new state of the property on the promise with given id.",
"properties": [
{
"name": "id",
"type": "integer",
"description": "Unique id of the promise."
},
{
"name": "status",
"type": "string",
"optional": true,
"enum": [
"pending",
"resolved",
"rejected"
],
"description": "Status of the promise."
},
{
"name": "parentId",
"type": "integer",
"optional": true,
"description": "Id of the parent promise."
},
{
"name": "callFrame",
"$ref": "Console.CallFrame",
"optional": true,
"description": "Top call frame on promise creation."
},
{
"name": "creationTime",
"type": "number",
"optional": true,
"description": "Creation time of the promise."
},
{
"name": "settlementTime",
"type": "number",
"optional": true,
"description": "Settlement time of the promise."
},
{
"name": "creationStack",
"$ref": "Console.StackTrace",
"optional": true,
"description": "JavaScript stack trace on promise creation."
},
{
"name": "asyncCreationStack",
"$ref": "Console.AsyncStackTrace",
"optional": true,
"description": "JavaScript asynchronous stack trace on promise creation, if available."
},
{
"name": "settlementStack",
"$ref": "Console.StackTrace",
"optional": true,
"description": "JavaScript stack trace on promise settlement."
},
{
"name": "asyncSettlementStack",
"$ref": "Console.AsyncStackTrace",
"optional": true,
"description": "JavaScript asynchronous stack trace on promise settlement, if available."
}
],
"hidden": true
},
{
"id": "AsyncOperation",
"type": "object",
"description": "Information about the async operation.",
"properties": [
{
"name": "id",
"type": "integer",
"description": "Unique id of the async operation."
},
{
"name": "description",
"type": "string",
"description": "String description of the async operation."
},
{
"name": "stackTrace",
"$ref": "Console.StackTrace",
"optional": true,
"description": "Stack trace where async operation was scheduled."
},
{
"name": "asyncStackTrace",
"$ref": "Console.AsyncStackTrace",
"optional": true,
"description": "Asynchronous stack trace where async operation was scheduled, if available."
}
],
"hidden": true
},
{
"id": "SearchMatch",
"type": "object",
"description": "Search match for resource.",
"properties": [
{
"name": "lineNumber",
"type": "number",
"description": "Line number in resource content."
},
{
"name": "lineContent",
"type": "string",
"description": "Line with match content."
}
],
"hidden": true
}
],
"commands": [
{
"name": "enable",
"description": "Enables debugger for the given page. Clients should not assume that the debugging has been enabled until the result for this command is received."
},
{
"name": "disable",
"description": "Disables debugger for given page."
},
{
"name": "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 url or urlRegex 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 locations property. Further matching script parsing will result in subsequent breakpointResolved events issued. This logical breakpoint will survive page reloads."
},
{
"name": "removeBreakpoint",
"parameters": [
{
"name": "breakpointId",
"$ref": "BreakpointId"
}
],
"description": "Removes JavaScript breakpoint."
},
{
"name": "continueToLocation",
"parameters": [
{
"name": "location",
"$ref": "Location",
"description": "Location to continue to."
},
{
"name": "interstatementLocation",
"type": "boolean",
"optional": true,
"hidden": true,
"description": "Allows breakpoints at the intemediate positions inside statements."
}
],
"description": "Continues execution until specific location is reached."
},
{
"name": "stepOver",
"description": "Steps over the statement."
},
{
"name": "stepInto",
"description": "Steps into the function call."
},
{
"name": "stepOut",
"description": "Steps out of the function call."
},
{
"name": "pause",
"description": "Stops on the next JavaScript statement."
},
{
"name": "resume",
"description": "Resumes JavaScript execution."
},
{
"name": "canSetScriptSource",
"returns": [
{
"name": "result",
"type": "boolean",
"description": "True if setScriptSource is supported."
}
],
"description": "Always returns true."
},
{
"name": "getScriptSource",
"parameters": [
{
"name": "scriptId",
"$ref": "ScriptId",
"description": "Id of the script to get source for."
}
],
"returns": [
{
"name": "scriptSource",
"type": "string",
"description": "Script source."
}
],
"description": "Returns source for the script with given id."
}
],
"events": [
{
"name": "globalObjectCleared",
"description": "Called when global has been cleared and debugger client should reset its state. Happens upon navigation or reload."
},
{
"name": "scriptParsed",
"parameters": [
{
"name": "scriptId",
"$ref": "ScriptId",
"description": "Identifier of the script parsed."
},
{
"name": "url",
"type": "string",
"description": "URL or name of the script parsed (if any)."
},
{
"name": "startLine",
"type": "integer",
"description": "Line offset of the script within the resource with given URL (for script tags)."
},
{
"name": "startColumn",
"type": "integer",
"description": "Column offset of the script within the resource with given URL."
},
{
"name": "endLine",
"type": "integer",
"description": "Last line of the script."
},
{
"name": "endColumn",
"type": "integer",
"description": "Length of the last line of the script."
},
{
"name": "isContentScript",
"type": "boolean",
"optional": true,
"description": "Determines whether this script is a user extension script."
},
{
"name": "isInternalScript",
"type": "boolean",
"optional": true,
"description": "Determines whether this script is an internal script.",
"hidden": true
},
{
"name": "sourceMapURL",
"type": "string",
"optional": true,
"description": "URL of source map associated with script (if any)."
},
{
"name": "hasSourceURL",
"type": "boolean",
"optional": true,
"description": "True, if this script has sourceURL.",
"hidden": true
}
],
"description": "Fired when virtual machine parses script. This event is also fired for all known and uncollected scripts upon enabling debugger."
},
{
"name": "scriptFailedToParse",
"parameters": [
{
"name": "scriptId",
"$ref": "ScriptId",
"description": "Identifier of the script parsed."
},
{
"name": "url",
"type": "string",
"description": "URL or name of the script parsed (if any)."
},
{
"name": "startLine",
"type": "integer",
"description": "Line offset of the script within the resource with given URL (for script tags)."
},
{
"name": "startColumn",
"type": "integer",
"description": "Column offset of the script within the resource with given URL."
},
{
"name": "endLine",
"type": "integer",
"description": "Last line of the script."
},
{
"name": "endColumn",
"type": "integer",
"description": "Length of the last line of the script."
},
{
"name": "isContentScript",
"type": "boolean",
"optional": true,
"description": "Determines whether this script is a user extension script."
},
{
"name": "isInternalScript",
"type": "boolean",
"optional": true,
"description": "Determines whether this script is an internal script.",
"hidden": true
},
{
"name": "sourceMapURL",
"type": "string",
"optional": true,
"description": "URL of source map associated with script (if any)."
},
{
"name": "hasSourceURL",
"type": "boolean",
"optional": true,
"description": "True, if this script has sourceURL.",
"hidden": true
}
],
"description": "Fired when virtual machine fails to parse the script."
},
{
"name": "breakpointResolved",
"parameters": [
{
"name": "breakpointId",
"$ref": "BreakpointId",
"description": "Breakpoint unique identifier."
},
{
"name": "location",
"$ref": "Location",
"description": "Actual breakpoint location."
}
],
"description": "Fired when breakpoint is resolved to an actual script and location."
},
{
"name": "paused",
"parameters": [
{
"name": "callFrames",
"type": "array",
"items": {
"$ref": "CallFrame"
},
"description": "Call stack the virtual machine stopped on."
},
{
"name": "reason",
"type": "string",
"enum": [
"XHR",
"DOM",
"EventListener",
"exception",
"assert",
"CSPViolation",
"debugCommand",
"promiseRejection",
"AsyncOperation",
"other"
],
"description": "Pause reason."
},
{
"name": "data",
"type": "object",
"optional": true,
"description": "Object containing break-specific auxiliary properties."
},
{
"name": "hitBreakpoints",
"type": "array",
"optional": true,
"items": {
"type": "string"
},
"description": "Hit breakpoints IDs",
"hidden": true
},
{
"name": "asyncStackTrace",
"$ref": "StackTrace",
"optional": true,
"description": "Async stack trace, if any.",
"hidden": true
}
],
"description": "Fired when the virtual machine stopped on breakpoint or exception or any other stop criteria."
},
{
"name": "resumed",
"description": "Fired when the virtual machine resumed execution."
},
{
"name": "promiseUpdated",
"parameters": [
{
"name": "eventType",
"type": "string",
"enum": [
"new",
"update",
"gc"
],
"description": "Type of the event."
},
{
"name": "promise",
"$ref": "PromiseDetails",
"description": "Information about the updated Promise."
}
],
"description": "Fired when a Promise is created, updated or garbage collected.",
"hidden": true
},
{
"name": "asyncOperationStarted",
"parameters": [
{
"name": "operation",
"$ref": "AsyncOperation",
"description": "Information about the async operation."
}
],
"description": "Fired when an async operation is scheduled (while in a debugger stepping session).",
"hidden": true
},
{
"name": "asyncOperationCompleted",
"parameters": [
{
"name": "id",
"type": "integer",
"description": "ID of the async operation that was completed."
}
],
"description": "Fired when an async operation is completed (while in a debugger stepping session).",
"hidden": true
}
]
},
{
"domain": "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": "TimeSinceEpoch",
"type": "number",
"description": "UTC time in seconds, counted from January 1, 1970."
},
{
"id": "MonotonicTime",
"type": "number",
"description": "Monotonically increasing time in seconds since an arbitrary point in the past."
},
{
"id": "Headers",
"type": "object",
"description": "Request / response headers as keys / values of JSON object."
},
{
"id": "ResourceTiming",
"type": "object",
"description": "Timing information for the request.",
"properties": [
{
"name": "requestTime",
"type": "number",
"description": "Timing's requestTime is a baseline in seconds, while the other numbers are ticks in milliseconds relatively to this requestTime."
},
{
"name": "proxyStart",
"type": "number",
"description": "Started resolving proxy."
},
{
"name": "proxyEnd",
"type": "number",
"description": "Finished resolving proxy."
},
{
"name": "dnsStart",
"type": "number",
"description": "Started DNS address resolve."
},
{
"name": "dnsEnd",
"type": "number",
"description": "Finished DNS address resolve."
},
{
"name": "connectStart",
"type": "number",
"description": "Started connecting to the remote host."
},
{
"name": "connectEnd",
"type": "number",
"description": "Connected to the remote host."
},
{
"name": "sslStart",
"type": "number",
"description": "Started SSL handshake."
},
{
"name": "sslEnd",
"type": "number",
"description": "Finished SSL handshake."
},
{
"name": "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",
"$ref": "Security.MixedContentType",
"optional": true,
"description": "The mixed content type of the request."
},
{
"name": "initialPriority",
"$ref": "ResourcePriority",
"description": "Priority of the resource request at the time request is sent."
},
{
"name": "referrerPolicy",
"type": "string",
"enum": [
"unsafe-url",
"no-referrer-when-downgrade",
"no-referrer",
"origin",
"origin-when-cross-origin",
"same-origin",
"strict-origin",
"strict-origin-when-cross-origin"
],
"description": "The referrer policy of the request, as defined in https://www.w3.org/TR/referrer-policy/"
},
{
"name": "isLinkPreload",
"type": "boolean",
"optional": true,
"description": "Whether is loaded via link preload."
}
]
},
{
"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": "TimeSinceEpoch",
"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, or the empty string if not applicable."
},
{
"name": "keyExchangeGroup",
"type": "string",
"optional": true,
"description": "(EC)DH group used by the connection, if applicable."
},
{
"name": "cipher",
"type": "string",
"description": "Cipher name."
},
{
"name": "mac",
"type": "string",
"optional": true,
"description": "TLS MAC. Note that AEAD ciphers do not have separate MACs."
},
{
"name": "certificateId",
"$ref": "Security.CertificateId",
"description": "Certificate ID value."
},
{
"name": "subjectName",
"type": "string",
"description": "Certificate subject name."
},
{
"name": "sanList",
"type": "array",
"items": {
"type": "string"
},
"description": "Subject Alternative Name (SAN) DNS names and IP addresses."
},
{
"name": "issuer",
"type": "string",
"description": "Name of the issuing CA."
},
{
"name": "validFrom",
"$ref": "TimeSinceEpoch",
"description": "Certificate valid from date."
},
{
"name": "validTo",
"$ref": "TimeSinceEpoch",
"description": "Certificate valid to (expiration) date"
},
{
"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": "number",
"description": "HTTP response status code."
},
{
"name": "statusText",
"type": "string",
"description": "HTTP response status text."
},
{
"name": "headers",
"$ref": "Headers",
"description": "HTTP response headers."
},
{
"name": "headersText",
"type": "string",
"optional": true,
"description": "HTTP response headers text."
},
{
"name": "mimeType",
"type": "string",
"description": "Resource mimeType as determined by the browser."
},
{
"name": "requestHeaders",
"$ref": "Headers",
"optional": true,
"description": "Refined HTTP request headers that were actually transmitted over the network."
},
{
"name": "requestHeadersText",
"type": "string",
"optional": true,
"description": "HTTP request headers text."
},
{
"name": "connectionReused",
"type": "boolean",
"description": "Specifies whether physical connection was actually reused for this request."
},
{
"name": "connectionId",
"type": "number",
"description": "Physical connection id that was actually used for this request."
},
{
"name": "remoteIPAddress",
"type": "string",
"optional": true,
"experimental": true,
"description": "Remote IP address."
},
{
"name": "remotePort",
"type": "integer",
"optional": true,
"experimental": true,
"description": "Remote port."
},
{
"name": "fromDiskCache",
"type": "boolean",
"optional": true,
"description": "Specifies that the request was served from the disk cache."
},
{
"name": "fromServiceWorker",
"type": "boolean",
"optional": true,
"description": "Specifies that the request was served from the ServiceWorker."
},
{
"name": "encodedDataLength",
"type": "number",
"optional": false,
"description": "Total number of bytes received for this request so far."
},
{
"name": "timing",
"$ref": "ResourceTiming",
"optional": true,
"description": "Timing information for the given request."
},
{
"name": "protocol",
"type": "string",
"optional": true,
"description": "Protocol used to fetch this request."
},
{
"name": "securityState",
"$ref": "Security.SecurityState",
"description": "Security state of the request resource."
},
{
"name": "securityDetails",
"$ref": "SecurityDetails",
"optional": true,
"description": "Security details for the request."
}
]
},
{
"id": "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",
"preload",
"other"
],
"description": "Type of this initiator."
},
{
"name": "stack",
"$ref": "Runtime.StackTrace",
"optional": true,
"description": "Initiator JavaScript stack trace, set for Script only."
},
{
"name": "url",
"type": "string",
"optional": true,
"description": "Initiator URL, set for Parser type or for Script type (when script is importing module)."
},
{
"name": "lineNumber",
"type": "number",
"optional": true,
"description": "Initiator line number, set for Parser type or for Script type (when script is importing module) (0-based)."
}
]
}
],
"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)."
}
]
},
{
"name": "disable",
"description": "Disables network tracking, prevents network events from being sent to the client."
},
{
"name": "setUserAgentOverride",
"description": "Allows overriding user agent with the given string.",
"parameters": [
{
"name": "userAgent",
"type": "string",
"description": "User agent to use."
}
]
},
{
"name": "getResponseBody",
"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": "clearBrowserCache",
"description": "Clears browser cache."
},
{
"name": "setCacheDisabled",
"parameters": [
{
"name": "cacheDisabled",
"type": "boolean",
"description": "Cache disabled state."
}
],
"description": "Toggles ignoring cache for each request. If true, cache will not be used."
}
],
"events": [
{
"name": "requestWillBeSent",
"description": "Fired when page is about to send HTTP request.",
"parameters": [
{
"name": "requestId",
"$ref": "RequestId",
"description": "Request identifier."
},
{
"name": "loaderId",
"$ref": "LoaderId",
"description": "Loader identifier. Empty string if the request is fetched form worker."
},
{
"name": "documentURL",
"type": "string",
"description": "URL of the document this request is loaded for."
},
{
"name": "request",
"$ref": "Request",
"description": "Request data."
},
{
"name": "timestamp",
"$ref": "MonotonicTime",
"description": "Timestamp."
},
{
"name": "wallTime",
"$ref": "TimeSinceEpoch",
"experimental": true,
"description": "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": "frameId",
"optional": true,
"$ref": "Page.FrameId",
"description": "Frame identifier.",
"experimental": true
}
]
},
{
"name": "responseReceived",
"description": "Fired when HTTP response is available.",
"parameters": [
{
"name": "requestId",
"$ref": "RequestId",
"description": "Request identifier."
},
{
"name": "loaderId",
"$ref": "LoaderId",
"description": "Loader identifier. Empty string if the request is fetched form worker."
},
{
"name": "timestamp",
"$ref": "MonotonicTime",
"description": "Timestamp."
},
{
"name": "type",
"$ref": "Page.ResourceType",
"description": "Resource type."
},
{
"name": "response",
"$ref": "Response",
"description": "Response data."
},
{
"name": "frameId",
"optional": true,
"$ref": "Page.FrameId",
"description": "Frame identifier.",
"experimental": true
}
]
},
{
"name": "dataReceived",
"description": "Fired when data chunk was received over the network.",
"parameters": [
{
"name": "requestId",
"$ref": "RequestId",
"description": "Request identifier."
},
{
"name": "timestamp",
"$ref": "MonotonicTime",
"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": "MonotonicTime",
"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": "MonotonicTime",
"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
}
]
}
]
}
]
}