Accessibility

[Experimental]

-

Dependencies: DOM

types

Type ID

Type

Description

Flags

AXNodeId

String

Unique accessibility node identifier.

-

AXValueType

Enum of possible property types.

-

AXValueSourceType

Enum of possible property sources.

-

AXValueNativeSourceType

Enum of possible native property sources (as a subtype of a particular AXValueSourceType).

-

AXValueSource

Object

A single source for a computed AX property.

-

PROPERTIES:

Name	Type	Description	Flags
type	$REF: AXValueSourceType	What type of source this is.	-
value	$REF: AXValue	The value of this property source.	[OPTIONAL]
attribute	String	The name of the relevant attribute, if any.	[OPTIONAL]
attributeValue	$REF: AXValue	The value of the relevant attribute, if any.	[OPTIONAL]
superseded	Boolean	Whether this source is superseded by a higher priority source.	[OPTIONAL]
nativeSource	$REF: AXValueNativeSourceType	The native markup source for this value, e.g. a <label> element.	[OPTIONAL]
nativeSourceValue	$REF: AXValue	The value, such as a node or node list, of the native source.	[OPTIONAL]
invalid	Boolean	Whether the value for this property is invalid.	[OPTIONAL]
invalidReason	String	Reason for the value being invalid, if it is.	[OPTIONAL]

AXRelatedNode

Object

-

PROPERTIES:

Name	Type	Description	Flags
backendDOMNodeId	$REF: DOM.BackendNodeId	The BackendNodeId of the related DOM node.	-
idref	String	The IDRef value provided, if any.	[OPTIONAL]
text	String	The text alternative of this node in the current context.	[OPTIONAL]

AXProperty

Object

-

PROPERTIES:

Name	Type	Description	Flags
name	$REF: AXPropertyName	The name of this property.	-
value	$REF: AXValue	The value of this property.	-

AXValue

Object

A single computed AX property.

-

PROPERTIES:

Name	Type	Description	Flags
type	$REF: AXValueType	The type of this value.	-
value	Any	The computed value of this property.	[OPTIONAL]
relatedNodes	Array (of) $REF: AXRelatedNode	One or more related nodes, if applicable.	[OPTIONAL]
sources	Array (of) $REF: AXValueSource	The sources which contributed to the computation of this property.	[OPTIONAL]

AXPropertyName

Values of AXProperty name: - from 'busy' to 'roledescription': states which apply to every AX node - from 'live' to 'root': attributes which apply to nodes in live regions - from 'autocomplete' to 'valuetext': attributes which apply to widgets - from 'checked' to 'selected': states which apply to widgets - from 'activedescendant' to 'owns' - relationships between elements other than parent/child/sibling.

-

AXNode

Object

A node in the accessibility tree.

-

PROPERTIES:

Name	Type	Description	Flags
nodeId	$REF: AXNodeId	Unique identifier for this node.	-
ignored	Boolean	Whether this node is ignored for accessibility	-
ignoredReasons	Array (of) $REF: AXProperty	Collection of reasons why this node is hidden.	[OPTIONAL]
role	$REF: AXValue	This `Node`'s role, whether explicit or implicit.	[OPTIONAL]
name	$REF: AXValue	The accessible name for this `Node`.	[OPTIONAL]
description	$REF: AXValue	The accessible description for this `Node`.	[OPTIONAL]
value	$REF: AXValue	The value for this `Node`.	[OPTIONAL]
properties	Array (of) $REF: AXProperty	All other properties	[OPTIONAL]
childIds	Array (of) $REF: AXNodeId	IDs for each of this node's child nodes.	[OPTIONAL]
backendDOMNodeId	$REF: DOM.BackendNodeId	The backend ID for the associated DOM node, if any.	[OPTIONAL]

commands

Name

Description

Flags

disable

Disables the accessibility domain.

-

enable

Enables the accessibility domain which causes `AXNodeId`s to remain consistent between method calls. This turns on accessibility for the page, which can impact performance until accessibility is disabled.

-

getPartialAXTree

Fetches the accessibility node and partial accessibility tree for this DOM node, if it exists.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: DOM.NodeId	Identifier of the node to get the partial accessibility tree for.	[OPTIONAL]
backendNodeId	$REF: DOM.BackendNodeId	Identifier of the backend node to get the partial accessibility tree for.	[OPTIONAL]
objectId	$REF: Runtime.RemoteObjectId	JavaScript object id of the node wrapper to get the partial accessibility tree for.	[OPTIONAL]
fetchRelatives	Boolean	Whether to fetch this nodes ancestors, siblings and children. Defaults to true.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
nodes	Array (of) $REF: AXNode	The `Accessibility.AXNode` for this DOM node, if it exists, plus its ancestors, siblings and children, if requested.	-

getFullAXTree

Fetches the entire accessibility tree for the root Document

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
depth	Integer	The maximum depth at which descendants of the root node should be retrieved. If omitted, the full tree is returned.	[OPTIONAL]
max_depth	Integer	Deprecated. This parameter has been renamed to `depth`. If depth is not provided, max_depth will be used.	[OPTIONAL] [DEPRECATED]
frameId	$REF: Page.FrameId	The frame for whose document the AX tree should be retrieved. If omited, the root frame is used.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
nodes	Array (of) $REF: AXNode	-	-

getChildAXNodes

Fetches a particular accessibility node by AXNodeId. Requires `enable()` to have been called previously.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
id	$REF: AXNodeId	-	-
frameId	$REF: Page.FrameId	The frame in whose document the node resides. If omitted, the root frame is used.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
nodes	Array (of) $REF: AXNode	-	-

queryAXTree

Query a DOM node's accessibility subtree for accessible name and role. This command computes the name and role for all nodes in the subtree, including those that are ignored for accessibility, and returns those that mactch the specified name and role. If no DOM node is specified, or the DOM node does not exist, the command returns an error. If neither `accessibleName` or `role` is specified, it returns all the accessibility nodes in the subtree.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: DOM.NodeId	Identifier of the node for the root to query.	[OPTIONAL]
backendNodeId	$REF: DOM.BackendNodeId	Identifier of the backend node for the root to query.	[OPTIONAL]
objectId	$REF: Runtime.RemoteObjectId	JavaScript object id of the node wrapper for the root to query.	[OPTIONAL]
accessibleName	String	Find nodes with this computed name.	[OPTIONAL]
role	String	Find nodes with this computed role.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
nodes	Array (of) $REF: AXNode	A list of `Accessibility.AXNode` matching the specified attributes, including nodes that are ignored for accessibility.	-

Animation

[Experimental]

-

Dependencies: Runtime, DOM

types

Type ID

Type

Description

Flags

Animation

Object

Animation instance.

-

PROPERTIES:

Name	Type	Description	Flags
id	String	`Animation`'s id.	-
name	String	`Animation`'s name.	-
pausedState	Boolean	`Animation`'s internal paused state.	-
playState	String	`Animation`'s play state.	-
playbackRate	Number	`Animation`'s playback rate.	-
startTime	Number	`Animation`'s start time.	-
currentTime	Number	`Animation`'s current time.	-
type	"CSSTransition", "CSSAnimation", "WebAnimation"String [Hover] Enum	Animation type of `Animation`.	-
source	$REF: AnimationEffect	`Animation`'s source animation node.	[OPTIONAL]
cssId	String	A unique ID for `Animation` representing the sources that triggered this CSS animation/transition.	[OPTIONAL]

AnimationEffect

Object

AnimationEffect instance

-

PROPERTIES:

Name	Type	Description	Flags
delay	Number	`AnimationEffect`'s delay.	-
endDelay	Number	`AnimationEffect`'s end delay.	-
iterationStart	Number	`AnimationEffect`'s iteration start.	-
iterations	Number	`AnimationEffect`'s iterations.	-
duration	Number	`AnimationEffect`'s iteration duration.	-
direction	String	`AnimationEffect`'s playback direction.	-
fill	String	`AnimationEffect`'s fill mode.	-
backendNodeId	$REF: DOM.BackendNodeId	`AnimationEffect`'s target node.	[OPTIONAL]
keyframesRule	$REF: KeyframesRule	`AnimationEffect`'s keyframes.	[OPTIONAL]
easing	String	`AnimationEffect`'s timing function.	-

KeyframesRule

Object

Keyframes Rule

-

PROPERTIES:

Name	Type	Description	Flags
name	String	CSS keyframed animation's name.	[OPTIONAL]
keyframes	Array (of) $REF: KeyframeStyle	List of animation keyframes.	-

KeyframeStyle

Object

Keyframe Style

-

PROPERTIES:

Name	Type	Description	Flags
offset	String	Keyframe's time offset.	-
easing	String	`AnimationEffect`'s timing function.	-

commands

Name

Description

Flags

disable

Disables animation domain notifications.

-

enable

Enables animation domain notifications.

-

getCurrentTime

Returns the current time of the an animation.

-

PARAMETERS:

Name	Type	Description	Flags
id	String	Id of animation.	-

RETURNS:

Name	Type	Description	Flags
currentTime	Number	Current time of the page.	-

getPlaybackRate

Gets the playback rate of the document timeline.

-

RETURNS:

Name	Type	Description	Flags
playbackRate	Number	Playback rate for animations on page.	-

releaseAnimations

Releases a set of animations to no longer be manipulated.

-

PARAMETERS:

Name	Type	Description	Flags
animations	Array (of) String	List of animation ids to seek.	-

resolveAnimation

Gets the remote object of the Animation.

-

PARAMETERS:

Name	Type	Description	Flags
animationId	String	Animation id.	-

RETURNS:

Name	Type	Description	Flags
remoteObject	$REF: Runtime.RemoteObject	Corresponding remote object.	-

seekAnimations

Seek a set of animations to a particular time within each animation.

-

PARAMETERS:

Name	Type	Description	Flags
animations	Array (of) String	List of animation ids to seek.	-
currentTime	Number	Set the current time of each animation.	-

setPaused

Sets the paused state of a set of animations.

-

PARAMETERS:

Name	Type	Description	Flags
animations	Array (of) String	Animations to set the pause state of.	-
paused	Boolean	Paused state to set to.	-

setPlaybackRate

Sets the playback rate of the document timeline.

-

PARAMETERS:

Name	Type	Description	Flags
playbackRate	Number	Playback rate for animations on page	-

setTiming

Sets the timing of an animation node.

-

PARAMETERS:

Name	Type	Description	Flags
animationId	String	Animation id.	-
duration	Number	Duration of the animation.	-
delay	Number	Delay of the animation.	-

Audits

[Experimental]

Audits domain allows investigation of page violations and possible improvements.

Dependencies: Network

types

Type ID

Type

Description

Flags

AffectedCookie

Object

Information about a cookie that is affected by an inspector issue.

-

PROPERTIES:

Name	Type	Description	Flags
name	String	The following three properties uniquely identify a cookie	-
path	String	-	-
domain	String	-	-

AffectedRequest

Object

Information about a request that is affected by an inspector issue.

-

PROPERTIES:

Name	Type	Description	Flags
requestId	$REF: Network.RequestId	The unique request id.	-
url	String	-	[OPTIONAL]

AffectedFrame

Object

Information about the frame affected by an inspector issue.

-

PROPERTIES:

Name	Type	Description	Flags
frameId	$REF: Page.FrameId	-	-

SameSiteCookieExclusionReason

-

SameSiteCookieWarningReason

-

SameSiteCookieOperation

-

SameSiteCookieIssueDetails

Object

This information is currently necessary, as the front-end has a difficult time finding a specific cookie. With this, we can convey specific error information without the cookie.

-

PROPERTIES:

Name	Type	Description	Flags
cookie	$REF: AffectedCookie	If AffectedCookie is not set then rawCookieLine contains the raw Set-Cookie header string. This hints at a problem where the cookie line is syntactically or semantically malformed in a way that no valid cookie could be created.	[OPTIONAL]
rawCookieLine	String	-	[OPTIONAL]
cookieWarningReasons	Array (of) $REF: SameSiteCookieWarningReason	-	-
cookieExclusionReasons	Array (of) $REF: SameSiteCookieExclusionReason	-	-
operation	$REF: SameSiteCookieOperation	Optionally identifies the site-for-cookies and the cookie url, which may be used by the front-end as additional context.	-
siteForCookies	String	-	[OPTIONAL]
cookieUrl	String	-	[OPTIONAL]
request	$REF: AffectedRequest	-	[OPTIONAL]

MixedContentResolutionStatus

-

MixedContentResourceType

-

MixedContentIssueDetails

Object

-

PROPERTIES:

Name	Type	Description	Flags
resourceType	$REF: MixedContentResourceType	The type of resource causing the mixed content issue (css, js, iframe, form,...). Marked as optional because it is mapped to from blink::mojom::RequestContextType, which will be replaced by network::mojom::RequestDestination	[OPTIONAL]
resolutionStatus	$REF: MixedContentResolutionStatus	The way the mixed content issue is being resolved.	-
insecureURL	String	The unsafe http url causing the mixed content issue.	-
mainResourceURL	String	The url responsible for the call to an unsafe url.	-
request	$REF: AffectedRequest	The mixed content request. Does not always exist (e.g. for unsafe form submission urls).	[OPTIONAL]
frame	$REF: AffectedFrame	Optional because not every mixed content issue is necessarily linked to a frame.	[OPTIONAL]

BlockedByResponseReason

Enum indicating the reason a response has been blocked. These reasons are refinements of the net error BLOCKED_BY_RESPONSE.

-

BlockedByResponseIssueDetails

Object

Details for a request that has been blocked with the BLOCKED_BY_RESPONSE code. Currently only used for COEP/COOP, but may be extended to include some CSP errors in the future.

-

PROPERTIES:

Name	Type	Description	Flags
request	$REF: AffectedRequest	-	-
parentFrame	$REF: AffectedFrame	-	[OPTIONAL]
blockedFrame	$REF: AffectedFrame	-	[OPTIONAL]
reason	$REF: BlockedByResponseReason	-	-

HeavyAdResolutionStatus

-

HeavyAdReason

-

HeavyAdIssueDetails

Object

-

PROPERTIES:

Name	Type	Description	Flags
resolution	$REF: HeavyAdResolutionStatus	The resolution status, either blocking the content or warning.	-
reason	$REF: HeavyAdReason	The reason the ad was blocked, total network or cpu or peak cpu.	-
frame	$REF: AffectedFrame	The frame that was blocked.	-

ContentSecurityPolicyViolationType

-

SourceCodeLocation

Object

-

PROPERTIES:

Name	Type	Description	Flags
scriptId	$REF: Runtime.ScriptId	-	[OPTIONAL]
url	String	-	-
lineNumber	Integer	-	-
columnNumber	Integer	-	-

ContentSecurityPolicyIssueDetails

Object

-

PROPERTIES:

Name	Type	Description	Flags
blockedURL	String	The url not included in allowed sources.	[OPTIONAL]
violatedDirective	String	Specific directive that is violated, causing the CSP issue.	-
isReportOnly	Boolean	-	-
contentSecurityPolicyViolationType	$REF: ContentSecurityPolicyViolationType	-	-
frameAncestor	$REF: AffectedFrame	-	[OPTIONAL]
sourceCodeLocation	$REF: SourceCodeLocation	-	[OPTIONAL]
violatingNodeId	$REF: DOM.BackendNodeId	-	[OPTIONAL]

SharedArrayBufferIssueType

-

SharedArrayBufferIssueDetails

Object

Details for a issue arising from an SAB being instantiated in, or transferred to a context that is not cross-origin isolated.

-

PROPERTIES:

Name	Type	Description	Flags
sourceCodeLocation	$REF: SourceCodeLocation	-	-
isWarning	Boolean	-	-
type	$REF: SharedArrayBufferIssueType	-	-

TwaQualityEnforcementViolationType

-

TrustedWebActivityIssueDetails

Object

-

PROPERTIES:

Name	Type	Description	Flags
url	String	The url that triggers the violation.	-
violationType	$REF: TwaQualityEnforcementViolationType	-	-
httpStatusCode	Integer	-	[OPTIONAL]
packageName	String	The package name of the Trusted Web Activity client app. This field is only used when violation type is kDigitalAssetLinks.	[OPTIONAL]
signature	String	The signature of the Trusted Web Activity client app. This field is only used when violation type is kDigitalAssetLinks.	[OPTIONAL]

LowTextContrastIssueDetails

Object

-

PROPERTIES:

Name	Type	Description	Flags
violatingNodeId	$REF: DOM.BackendNodeId	-	-
violatingNodeSelector	String	-	-
contrastRatio	Number	-	-
thresholdAA	Number	-	-
thresholdAAA	Number	-	-
fontSize	String	-	-
fontWeight	String	-	-

CorsIssueDetails

Object

Details for a CORS related issue, e.g. a warning or error related to CORS RFC1918 enforcement.

-

PROPERTIES:

Name	Type	Description	Flags
corsErrorStatus	$REF: Network.CorsErrorStatus	-	-
isWarning	Boolean	-	-
request	$REF: AffectedRequest	-	-
location	$REF: SourceCodeLocation	-	[OPTIONAL]
initiatorOrigin	String	-	[OPTIONAL]
resourceIPAddressSpace	$REF: Network.IPAddressSpace	-	[OPTIONAL]
clientSecurityState	$REF: Network.ClientSecurityState	-	[OPTIONAL]

AttributionReportingIssueType

-

AttributionReportingIssueDetails

Object

Details for issues around "Attribution Reporting API" usage. Explainer: https://github.com/WICG/conversion-measurement-api

-

PROPERTIES:

Name	Type	Description	Flags
violationType	$REF: AttributionReportingIssueType	-	-
frame	$REF: AffectedFrame	-	[OPTIONAL]
request	$REF: AffectedRequest	-	[OPTIONAL]
violatingNodeId	$REF: DOM.BackendNodeId	-	[OPTIONAL]
invalidParameter	String	-	[OPTIONAL]

QuirksModeIssueDetails

Object

Details for issues about documents in Quirks Mode or Limited Quirks Mode that affects page layouting.

-

PROPERTIES:

Name	Type	Description	Flags
isLimitedQuirksMode	Boolean	If false, it means the document's mode is "quirks" instead of "limited-quirks".	-
documentNodeId	$REF: DOM.BackendNodeId	-	-
url	String	-	-
frameId	$REF: Page.FrameId	-	-
loaderId	$REF: Network.LoaderId	-	-

NavigatorUserAgentIssueDetails

Object

-

PROPERTIES:

Name	Type	Description	Flags
url	String	-	-
location	$REF: SourceCodeLocation	-	[OPTIONAL]

WasmCrossOriginModuleSharingIssueDetails

Object

-

PROPERTIES:

Name	Type	Description	Flags
wasmModuleUrl	String	-	-
sourceOrigin	String	-	-
targetOrigin	String	-	-
isWarning	Boolean	-	-

GenericIssueErrorType

-

GenericIssueDetails

Object

Depending on the concrete errorType, different properties are set.

-

PROPERTIES:

Name	Type	Description	Flags
errorType	$REF: GenericIssueErrorType	Issues with the same errorType are aggregated in the frontend.	-
frameId	$REF: Page.FrameId	-	[OPTIONAL]

InspectorIssueCode

A unique identifier for the type of issue. Each type may use one of the optional fields in InspectorIssueDetails to convey more specific information about the kind of issue.

-

InspectorIssueDetails

Object

This struct holds a list of optional fields with additional information specific to the kind of issue. When adding a new issue code, please also add a new optional field to this type.

-

PROPERTIES:

Name	Type	Description	Flags
sameSiteCookieIssueDetails	$REF: SameSiteCookieIssueDetails	-	[OPTIONAL]
mixedContentIssueDetails	$REF: MixedContentIssueDetails	-	[OPTIONAL]
blockedByResponseIssueDetails	$REF: BlockedByResponseIssueDetails	-	[OPTIONAL]
heavyAdIssueDetails	$REF: HeavyAdIssueDetails	-	[OPTIONAL]
contentSecurityPolicyIssueDetails	$REF: ContentSecurityPolicyIssueDetails	-	[OPTIONAL]
sharedArrayBufferIssueDetails	$REF: SharedArrayBufferIssueDetails	-	[OPTIONAL]
twaQualityEnforcementDetails	$REF: TrustedWebActivityIssueDetails	-	[OPTIONAL]
lowTextContrastIssueDetails	$REF: LowTextContrastIssueDetails	-	[OPTIONAL]
corsIssueDetails	$REF: CorsIssueDetails	-	[OPTIONAL]
attributionReportingIssueDetails	$REF: AttributionReportingIssueDetails	-	[OPTIONAL]
quirksModeIssueDetails	$REF: QuirksModeIssueDetails	-	[OPTIONAL]
navigatorUserAgentIssueDetails	$REF: NavigatorUserAgentIssueDetails	-	[OPTIONAL]
wasmCrossOriginModuleSharingIssue	$REF: WasmCrossOriginModuleSharingIssueDetails	-	[OPTIONAL]
genericIssueDetails	$REF: GenericIssueDetails	-	[OPTIONAL]

IssueId

String

A unique id for a DevTools inspector issue. Allows other entities (e.g. exceptions, CDP message, console messages, etc.) to reference an issue.

-

InspectorIssue

Object

An inspector issue reported from the back-end.

-

PROPERTIES:

Name	Type	Description	Flags
code	$REF: InspectorIssueCode	-	-
details	$REF: InspectorIssueDetails	-	-
issueId	$REF: IssueId	A unique id for this issue. May be omitted if no other entity (e.g. exception, CDP message, etc.) is referencing this issue.	[OPTIONAL]

commands

Name

Description

Flags

getEncodedResponse

Returns the response body and size if it were re-encoded with the specified settings. Only applies to images.

-

PARAMETERS:

Name	Type	Description	Flags
requestId	$REF: Network.RequestId	Identifier of the network request to get content for.	-
encoding	"webp", "jpeg", "png"String [Hover] Enum	The encoding to use.	-
quality	Number	The quality of the encoding (0-1). (defaults to 1)	[OPTIONAL]
sizeOnly	Boolean	Whether to only return the size information (defaults to false).	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
body	String	The encoded body as a base64 string. Omitted if sizeOnly is true. (Encoded as a base64 string when passed over JSON)	[OPTIONAL]
originalSize	Integer	Size before re-encoding.	-
encodedSize	Integer	Size after re-encoding.	-

disable

Disables issues domain, prevents further issues from being reported to the client.

-

enable

Enables issues domain, sends the issues collected so far to the client by means of the `issueAdded` event.

-

checkContrast

Runs the contrast check for the target page. Found issues are reported using Audits.issueAdded event.

-

PARAMETERS:

Name	Type	Description	Flags
reportAAA	Boolean	Whether to report WCAG AAA level issues. Default is false.	[OPTIONAL]

BackgroundService

[Experimental]

Defines events for background web platform features.

types

Type ID

Type

Description

Flags

ServiceName

The Background Service that will be associated with the commands/events. Every Background Service operates independently, but they share the same API.

-

EventMetadata

Object

A key-value pair for additional event information to pass along.

-

PROPERTIES:

Name	Type	Description	Flags
key	String	-	-
value	String	-	-

BackgroundServiceEvent

Object

-

PROPERTIES:

Name	Type	Description	Flags
timestamp	$REF: Network.TimeSinceEpoch	Timestamp of the event (in seconds).	-
origin	String	The origin this event belongs to.	-
serviceWorkerRegistrationId	$REF: ServiceWorker.RegistrationID	The Service Worker ID that initiated the event.	-
service	$REF: ServiceName	The Background Service this event belongs to.	-
eventName	String	A description of the event.	-
instanceId	String	An identifier that groups related events together.	-
eventMetadata	Array (of) $REF: EventMetadata	A list of event-specific information.	-

Browser

The Browser domain defines methods and events for browser managing.

types

Type ID

Type

Description

Flags

BrowserContextID

String

-

[EXPERIMENTAL]

WindowID

Integer

-

[EXPERIMENTAL]

WindowState

The state of the browser window.

[EXPERIMENTAL]

Bounds

Object

Browser window bounds information

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
left	Integer	The offset from the left edge of the screen to the window in pixels.	[OPTIONAL]
top	Integer	The offset from the top edge of the screen to the window in pixels.	[OPTIONAL]
width	Integer	The window width in pixels.	[OPTIONAL]
height	Integer	The window height in pixels.	[OPTIONAL]
windowState	$REF: WindowState	The window state. Default to normal.	[OPTIONAL]

PermissionType

-

[EXPERIMENTAL]

PermissionSetting

-

[EXPERIMENTAL]

PermissionDescriptor

Object

Definition of PermissionDescriptor defined in the Permissions API: https://w3c.github.io/permissions/#dictdef-permissiondescriptor.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
name	String	Name of permission. See https://cs.chromium.org/chromium/src/third_party/blink/renderer/modules/permissions/permission_descriptor.idl for valid permission names.	-
sysex	Boolean	For "midi" permission, may also specify sysex control.	[OPTIONAL]
userVisibleOnly	Boolean	For "push" permission, may specify userVisibleOnly. Note that userVisibleOnly = true is the only currently supported type.	[OPTIONAL]
allowWithoutSanitization	Boolean	For "clipboard" permission, may specify allowWithoutSanitization.	[OPTIONAL]
panTiltZoom	Boolean	For "camera" permission, may specify panTiltZoom.	[OPTIONAL]

BrowserCommandId

Browser command ids used by executeBrowserCommand.

[EXPERIMENTAL]

Bucket

Object

Chrome histogram bucket.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
low	Integer	Minimum value (inclusive).	-
high	Integer	Maximum value (exclusive).	-
count	Integer	Number of samples.	-

Histogram

Object

Chrome histogram.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
name	String	Name.	-
sum	Integer	Sum of sample values.	-
count	Integer	Total number of samples.	-
buckets	Array (of) $REF: Bucket	Buckets.	-

commands

Name

Description

Flags

setPermission

Set permission settings for given origin.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
permission	$REF: PermissionDescriptor	Descriptor of permission to override.	-
setting	$REF: PermissionSetting	Setting of the permission.	-
origin	String	Origin the permission applies to, all origins if not specified.	[OPTIONAL]
browserContextId	$REF: BrowserContextID	Context to override. When omitted, default browser context is used.	[OPTIONAL]

grantPermissions

Grant specific permissions to the given origin and reject all others.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
permissions	Array (of) $REF: PermissionType	-	-
origin	String	Origin the permission applies to, all origins if not specified.	[OPTIONAL]
browserContextId	$REF: BrowserContextID	BrowserContext to override permissions. When omitted, default browser context is used.	[OPTIONAL]

resetPermissions

Reset all permission management for all origins.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
browserContextId	$REF: BrowserContextID	BrowserContext to reset permissions. When omitted, default browser context is used.	[OPTIONAL]

setDownloadBehavior

Set the behavior when downloading a file.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
behavior	"deny", "allow", "allowAndName", "default"String [Hover] Enum	Whether to allow all or deny all download requests, or use default Chrome behavior if available (otherwise deny). \|allowAndName\| allows download and names files according to their dowmload guids.	-
browserContextId	$REF: BrowserContextID	BrowserContext to set download behavior. When omitted, default browser context is used.	[OPTIONAL]
downloadPath	String	The default path to save downloaded files to. This is required if behavior is set to 'allow' or 'allowAndName'.	[OPTIONAL]
eventsEnabled	Boolean	Whether to emit download events (defaults to false).	[OPTIONAL]

cancelDownload

Cancel a download if in progress

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
guid	String	Global unique identifier of the download.	-
browserContextId	$REF: BrowserContextID	BrowserContext to perform the action in. When omitted, default browser context is used.	[OPTIONAL]

close

Close browser gracefully.

-

crash

Crashes browser on the main thread.

[EXPERIMENTAL]

crashGpuProcess

Crashes GPU process.

[EXPERIMENTAL]

getVersion

Returns version information.

-

RETURNS:

Name	Type	Description	Flags
protocolVersion	String	Protocol version.	-
product	String	Product name.	-
revision	String	Product revision.	-
userAgent	String	User-Agent.	-
jsVersion	String	V8 version.	-

getBrowserCommandLine

Returns the command line switches for the browser process if, and only if --enable-automation is on the commandline.

[EXPERIMENTAL]

RETURNS:

Name	Type	Description	Flags
arguments	Array (of) String	Commandline parameters	-

getHistograms

Get Chrome histograms.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
query	String	Requested substring in name. Only histograms which have query as a substring in their name are extracted. An empty or absent query returns all histograms.	[OPTIONAL]
delta	Boolean	If true, retrieve delta since last call.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
histograms	Array (of) $REF: Histogram	Histograms.	-

getHistogram

Get a Chrome histogram by name.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
name	String	Requested histogram name.	-
delta	Boolean	If true, retrieve delta since last call.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
histogram	$REF: Histogram	Histogram.	-

getWindowBounds

Get position and size of the browser window.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
windowId	$REF: WindowID	Browser window id.	-

RETURNS:

Name	Type	Description	Flags
bounds	$REF: Bounds	Bounds information of the window. When window state is 'minimized', the restored window position and size are returned.	-

getWindowForTarget

Get the browser window that contains the devtools target.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
targetId	$REF: Target.TargetID	Devtools agent host id. If called as a part of the session, associated targetId is used.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
windowId	$REF: WindowID	Browser window id.	-
bounds	$REF: Bounds	Bounds information of the window. When window state is 'minimized', the restored window position and size are returned.	-

setWindowBounds

Set position and/or size of the browser window.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
windowId	$REF: WindowID	Browser window id.	-
bounds	$REF: Bounds	New window bounds. The 'minimized', 'maximized' and 'fullscreen' states cannot be combined with 'left', 'top', 'width' or 'height'. Leaves unspecified fields unchanged.	-

setDockTile

Set dock tile details, platform-specific.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
badgeLabel	String	-	[OPTIONAL]
image	String	Png encoded image. (Encoded as a base64 string when passed over JSON)	[OPTIONAL]

executeBrowserCommand

Invoke custom browser commands used by telemetry.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
commandId	$REF: BrowserCommandId	-	-

CSS

[Experimental]

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 keep track of stylesheets via the `styleSheetAdded`/`styleSheetRemoved` events and subsequently load the required stylesheet contents using the `getStyleSheet[Text]()` methods.

Dependencies: DOM, Page

types

Type ID

Type

Description

Flags

StyleSheetId

String

-

StyleSheetOrigin

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.

-

PseudoElementMatches

Object

CSS rule collection for a single pseudo style.

-

PROPERTIES:

Name	Type	Description	Flags
pseudoType	$REF: DOM.PseudoType	Pseudo element type.	-
matches	Array (of) $REF: RuleMatch	Matches of CSS rules applicable to the pseudo style.	-

InheritedStyleEntry

Object

Inherited CSS rule collection from ancestor node.

-

PROPERTIES:

Name	Type	Description	Flags
inlineStyle	$REF: CSSStyle	The ancestor node's inline style, if any, in the style inheritance chain.	[OPTIONAL]
matchedCSSRules	Array (of) $REF: RuleMatch	Matches of CSS rules matching the ancestor node in the style inheritance chain.	-

RuleMatch

Object

Match data for a CSS rule.

-

PROPERTIES:

Name	Type	Description	Flags
rule	$REF: CSSRule	CSS rule in the match.	-
matchingSelectors	Array (of) Integer	Matching selector indices in the rule's selectorList selectors (0-based).	-

Value

Object

Data for a simple selector (these are delimited by commas in a selector list).

-

PROPERTIES:

Name	Type	Description	Flags
text	String	Value text.	-
range	$REF: SourceRange	Value range in the underlying resource (if available).	[OPTIONAL]

SelectorList

Object

Selector list data.

-

PROPERTIES:

Name	Type	Description	Flags
selectors	Array (of) $REF: Value	Selectors in the list.	-
text	String	Rule selector text.	-

CSSStyleSheetHeader

Object

CSS stylesheet metainformation.

-

PROPERTIES:

Name	Type	Description	Flags
styleSheetId	$REF: StyleSheetId	The stylesheet identifier.	-
frameId	$REF: Page.FrameId	Owner frame identifier.	-
sourceURL	String	Stylesheet resource URL. Empty if this is a constructed stylesheet created using new CSSStyleSheet() (but non-empty if this is a constructed sylesheet imported as a CSS module script).	-
sourceMapURL	String	URL of source map associated with the stylesheet (if any).	[OPTIONAL]
origin	$REF: StyleSheetOrigin	Stylesheet origin.	-
title	String	Stylesheet title.	-
ownerNode	$REF: DOM.BackendNodeId	The backend id for the owner node of the stylesheet.	[OPTIONAL]
disabled	Boolean	Denotes whether the stylesheet is disabled.	-
hasSourceURL	Boolean	Whether the sourceURL field value comes from the sourceURL comment.	[OPTIONAL]
isInline	Boolean	Whether this stylesheet is created for STYLE tag by parser. This flag is not set for document.written STYLE tags.	-
isMutable	Boolean	Whether this stylesheet is mutable. Inline stylesheets become mutable after they have been modified via CSSOM API. <link> element's stylesheets become mutable only if DevTools modifies them. Constructed stylesheets (new CSSStyleSheet()) are mutable immediately after creation.	-
isConstructed	Boolean	True if this stylesheet is created through new CSSStyleSheet() or imported as a CSS module script.	-
startLine	Number	Line offset of the stylesheet within the resource (zero based).	-
startColumn	Number	Column offset of the stylesheet within the resource (zero based).	-
length	Number	Size of the content (in characters).	-
endLine	Number	Line offset of the end of the stylesheet within the resource (zero based).	-
endColumn	Number	Column offset of the end of the stylesheet within the resource (zero based).	-

CSSRule

Object

CSS rule representation.

-

PROPERTIES:

Name	Type	Description	Flags
styleSheetId	$REF: StyleSheetId	The css style sheet identifier (absent for user agent stylesheet and user-specified stylesheet rules) this rule came from.	[OPTIONAL]
selectorList	$REF: SelectorList	Rule selector data.	-
origin	$REF: StyleSheetOrigin	Parent stylesheet's origin.	-
style	$REF: CSSStyle	Associated style declaration.	-
media	Array (of) $REF: CSSMedia	Media list array (for rules involving media queries). The array enumerates media queries starting with the innermost one, going outwards.	[OPTIONAL]
containerQueries	Array (of) $REF: CSSContainerQuery	Container query list array (for rules involving container queries). The array enumerates container queries starting with the innermost one, going outwards.	[OPTIONAL] [EXPERIMENTAL]

RuleUsage

Object

CSS coverage information.

-

PROPERTIES:

Name	Type	Description	Flags
styleSheetId	$REF: StyleSheetId	The css style sheet identifier (absent for user agent stylesheet and user-specified stylesheet rules) this rule came from.	-
startOffset	Number	Offset of the start of the rule (including selector) from the beginning of the stylesheet.	-
endOffset	Number	Offset of the end of the rule body from the beginning of the stylesheet.	-
used	Boolean	Indicates whether the rule was actually used by some element in the page.	-

SourceRange

Object

Text range within a resource. All numbers are zero-based.

-

PROPERTIES:

Name	Type	Description	Flags
startLine	Integer	Start line of range.	-
startColumn	Integer	Start column of range (inclusive).	-
endLine	Integer	End line of range	-
endColumn	Integer	End column of range (exclusive).	-

ShorthandEntry

Object

-

PROPERTIES:

Name	Type	Description	Flags
name	String	Shorthand name.	-
value	String	Shorthand value.	-
important	Boolean	Whether the property has "!important" annotation (implies `false` if absent).	[OPTIONAL]

CSSComputedStyleProperty

Object

-

PROPERTIES:

Name	Type	Description	Flags
name	String	Computed style property name.	-
value	String	Computed style property value.	-

CSSStyle

Object

CSS style representation.

-

PROPERTIES:

Name	Type	Description	Flags
styleSheetId	$REF: StyleSheetId	The css style sheet identifier (absent for user agent stylesheet and user-specified stylesheet rules) this rule came from.	[OPTIONAL]
cssProperties	Array (of) $REF: CSSProperty	CSS properties in the style.	-
shorthandEntries	Array (of) $REF: ShorthandEntry	Computed values for all shorthands found in the style.	-
cssText	String	Style declaration text (if available).	[OPTIONAL]
range	$REF: SourceRange	Style declaration range in the enclosing stylesheet (if available).	[OPTIONAL]

CSSProperty

Object

CSS property declaration data.

-

PROPERTIES:

Name	Type	Description	Flags
name	String	The property name.	-
value	String	The property value.	-
important	Boolean	Whether the property has "!important" annotation (implies `false` if absent).	[OPTIONAL]
implicit	Boolean	Whether the property is implicit (implies `false` if absent).	[OPTIONAL]
text	String	The full property text as specified in the style.	[OPTIONAL]
parsedOk	Boolean	Whether the property is understood by the browser (implies `true` if absent).	[OPTIONAL]
disabled	Boolean	Whether the property is disabled by the user (present for source-based properties only).	[OPTIONAL]
range	$REF: SourceRange	The entire property range in the enclosing style declaration (if available).	[OPTIONAL]

CSSMedia

Object

CSS media rule descriptor.

-

PROPERTIES:

Name	Type	Description	Flags
text	String	Media query text.	-
source	"mediaRule", "importRule", "linkedSheet", "inlineSheet"String [Hover] Enum	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.	-
sourceURL	String	URL of the document containing the media query description.	[OPTIONAL]
range	$REF: SourceRange	The associated rule (@media or @import) header range in the enclosing stylesheet (if available).	[OPTIONAL]
styleSheetId	$REF: StyleSheetId	Identifier of the stylesheet containing this object (if exists).	[OPTIONAL]
mediaList	Array (of) $REF: MediaQuery	Array of media queries.	[OPTIONAL]

MediaQuery

Object

Media query descriptor.

-

PROPERTIES:

Name	Type	Description	Flags
expressions	Array (of) $REF: MediaQueryExpression	Array of media query expressions.	-
active	Boolean	Whether the media query condition is satisfied.	-

MediaQueryExpression

Object

Media query expression descriptor.

-

PROPERTIES:

Name	Type	Description	Flags
value	Number	Media query expression value.	-
unit	String	Media query expression units.	-
feature	String	Media query expression feature.	-
valueRange	$REF: SourceRange	The associated range of the value text in the enclosing stylesheet (if available).	[OPTIONAL]
computedLength	Number	Computed length of media query expression (if applicable).	[OPTIONAL]

CSSContainerQuery

Object

CSS container query rule descriptor.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
text	String	Container query text.	-
range	$REF: SourceRange	The associated rule header range in the enclosing stylesheet (if available).	[OPTIONAL]
styleSheetId	$REF: StyleSheetId	Identifier of the stylesheet containing this object (if exists).	[OPTIONAL]
name	String	Optional name for the container.	[OPTIONAL]

PlatformFontUsage

Object

Information about amount of glyphs that were rendered with given font.

-

PROPERTIES:

Name	Type	Description	Flags
familyName	String	Font's family name reported by platform.	-
isCustomFont	Boolean	Indicates if the font was downloaded or resolved locally.	-
glyphCount	Number	Amount of glyphs that were rendered with this font.	-

FontVariationAxis

Object

Information about font variation axes for variable fonts

-

PROPERTIES:

Name	Type	Description	Flags
tag	String	The font-variation-setting tag (a.k.a. "axis tag").	-
name	String	Human-readable variation name in the default language (normally, "en").	-
minValue	Number	The minimum value (inclusive) the font supports for this tag.	-
maxValue	Number	The maximum value (inclusive) the font supports for this tag.	-
defaultValue	Number	The default value.	-

FontFace

Object

Properties of a web font: https://www.w3.org/TR/2008/REC-CSS2-20080411/fonts.html#font-descriptions and additional information such as platformFontFamily and fontVariationAxes.

-

PROPERTIES:

Name	Type	Description	Flags
fontFamily	String	The font-family.	-
fontStyle	String	The font-style.	-
fontVariant	String	The font-variant.	-
fontWeight	String	The font-weight.	-
fontStretch	String	The font-stretch.	-
unicodeRange	String	The unicode-range.	-
src	String	The src.	-
platformFontFamily	String	The resolved platform font family	-
fontVariationAxes	Array (of) $REF: FontVariationAxis	Available variation settings (a.k.a. "axes").	[OPTIONAL]

CSSKeyframesRule

Object

CSS keyframes rule representation.

-

PROPERTIES:

Name	Type	Description	Flags
animationName	$REF: Value	Animation name.	-
keyframes	Array (of) $REF: CSSKeyframeRule	List of keyframes.	-

CSSKeyframeRule

Object

CSS keyframe rule representation.

-

PROPERTIES:

Name	Type	Description	Flags
styleSheetId	$REF: StyleSheetId	The css style sheet identifier (absent for user agent stylesheet and user-specified stylesheet rules) this rule came from.	[OPTIONAL]
origin	$REF: StyleSheetOrigin	Parent stylesheet's origin.	-
keyText	$REF: Value	Associated key text.	-
style	$REF: CSSStyle	Associated style declaration.	-

StyleDeclarationEdit

Object

A descriptor of operation to mutate style declaration text.

-

PROPERTIES:

Name	Type	Description	Flags
styleSheetId	$REF: StyleSheetId	The css style sheet identifier.	-
range	$REF: SourceRange	The range of the style text in the enclosing stylesheet.	-
text	String	New style text.	-

commands

Name

Description

Flags

addRule

Inserts a new rule with the given `ruleText` in a stylesheet with given `styleSheetId`, at the position specified by `location`.

-

PARAMETERS:

Name	Type	Description	Flags
styleSheetId	$REF: StyleSheetId	The css style sheet identifier where a new rule should be inserted.	-
ruleText	String	The text of a new rule.	-
location	$REF: SourceRange	Text position of a new rule in the target style sheet.	-

RETURNS:

Name	Type	Description	Flags
rule	$REF: CSSRule	The newly created rule.	-

collectClassNames

Returns all class names from specified stylesheet.

-

PARAMETERS:

Name	Type	Description	Flags
styleSheetId	$REF: StyleSheetId	-	-

RETURNS:

Name	Type	Description	Flags
classNames	Array (of) String	Class name list.	-

createStyleSheet

Creates a new special "via-inspector" stylesheet in the frame with given `frameId`.

-

PARAMETERS:

Name	Type	Description	Flags
frameId	$REF: Page.FrameId	Identifier of the frame where "via-inspector" stylesheet should be created.	-

RETURNS:

Name	Type	Description	Flags
styleSheetId	$REF: StyleSheetId	Identifier of the created "via-inspector" stylesheet.	-

disable

Disables the CSS agent for the given page.

-

enable

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.

-

forcePseudoState

Ensures that the given node will have specified pseudo-classes whenever its style is computed by the browser.

-

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: DOM.NodeId	The element id for which to force the pseudo state.	-
forcedPseudoClasses	Array (of) String	Element pseudo classes to force when computing the element's style.	-

getBackgroundColors

-

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: DOM.NodeId	Id of the node to get background colors for.	-

RETURNS:

Name	Type	Description	Flags
backgroundColors	Array (of) String	The range of background colors behind this element, if it contains any visible text. If no visible text is present, this will be undefined. In the case of a flat background color, this will consist of simply that color. In the case of a gradient, this will consist of each of the color stops. For anything more complicated, this will be an empty array. Images will be ignored (as if the image had failed to load).	[OPTIONAL]
computedFontSize	String	The computed font size for this node, as a CSS computed value string (e.g. '12px').	[OPTIONAL]
computedFontWeight	String	The computed font weight for this node, as a CSS computed value string (e.g. 'normal' or '100').	[OPTIONAL]

getComputedStyleForNode

Returns the computed style for a DOM node identified by `nodeId`.

-

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: DOM.NodeId	-	-

RETURNS:

Name	Type	Description	Flags
computedStyle	Array (of) $REF: CSSComputedStyleProperty	Computed style for the specified DOM node.	-

getInlineStylesForNode

Returns the styles defined inline (explicitly in the "style" attribute and implicitly, using DOM attributes) for a DOM node identified by `nodeId`.

-

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: DOM.NodeId	-	-

RETURNS:

Name	Type	Description	Flags
inlineStyle	$REF: CSSStyle	Inline style for the specified DOM node.	[OPTIONAL]
attributesStyle	$REF: CSSStyle	Attribute-defined element style (e.g. resulting from "width=20 height=100%").	[OPTIONAL]

getMatchedStylesForNode

Returns requested styles for a DOM node identified by `nodeId`.

-

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: DOM.NodeId	-	-

RETURNS:

Name	Type	Description	Flags
inlineStyle	$REF: CSSStyle	Inline style for the specified DOM node.	[OPTIONAL]
attributesStyle	$REF: CSSStyle	Attribute-defined element style (e.g. resulting from "width=20 height=100%").	[OPTIONAL]
matchedCSSRules	Array (of) $REF: RuleMatch	CSS rules matching this node, from all applicable stylesheets.	[OPTIONAL]
pseudoElements	Array (of) $REF: PseudoElementMatches	Pseudo style matches for this node.	[OPTIONAL]
inherited	Array (of) $REF: InheritedStyleEntry	A chain of inherited styles (from the immediate node parent up to the DOM tree root).	[OPTIONAL]
cssKeyframesRules	Array (of) $REF: CSSKeyframesRule	A list of CSS keyframed animations matching this node.	[OPTIONAL]

getMediaQueries

Returns all media queries parsed by the rendering engine.

-

RETURNS:

Name	Type	Description	Flags
medias	Array (of) $REF: CSSMedia	-	-

getPlatformFontsForNode

Requests information about platform fonts which we used to render child TextNodes in the given node.

-

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: DOM.NodeId	-	-

RETURNS:

Name	Type	Description	Flags
fonts	Array (of) $REF: PlatformFontUsage	Usage statistics for every employed platform font.	-

getStyleSheetText

Returns the current textual content for a stylesheet.

-

PARAMETERS:

Name	Type	Description	Flags
styleSheetId	$REF: StyleSheetId	-	-

RETURNS:

Name	Type	Description	Flags
text	String	The stylesheet text.	-

trackComputedStyleUpdates

Starts tracking the given computed styles for updates. The specified array of properties replaces the one previously specified. Pass empty array to disable tracking. Use takeComputedStyleUpdates to retrieve the list of nodes that had properties modified. The changes to computed style properties are only tracked for nodes pushed to the front-end by the DOM agent. If no changes to the tracked properties occur after the node has been pushed to the front-end, no updates will be issued for the node.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
propertiesToTrack	Array (of) $REF: CSSComputedStyleProperty	-	-

takeComputedStyleUpdates

Polls the next batch of computed style updates.

[EXPERIMENTAL]

RETURNS:

Name	Type	Description	Flags
nodeIds	Array (of) $REF: DOM.NodeId	The list of node Ids that have their tracked computed styles updated	-

setEffectivePropertyValueForNode

Find a rule with the given active property for the given node and set the new value for this property

-

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: DOM.NodeId	The element id for which to set property.	-
propertyName	String	-	-
value	String	-	-

setKeyframeKey

Modifies the keyframe rule key text.

-

PARAMETERS:

Name	Type	Description	Flags
styleSheetId	$REF: StyleSheetId	-	-
range	$REF: SourceRange	-	-
keyText	String	-	-

RETURNS:

Name	Type	Description	Flags
keyText	$REF: Value	The resulting key text after modification.	-

setMediaText

Modifies the rule selector.

-

PARAMETERS:

Name	Type	Description	Flags
styleSheetId	$REF: StyleSheetId	-	-
range	$REF: SourceRange	-	-
text	String	-	-

RETURNS:

Name	Type	Description	Flags
media	$REF: CSSMedia	The resulting CSS media rule after modification.	-

setContainerQueryText

Modifies the expression of a container query.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
styleSheetId	$REF: StyleSheetId	-	-
range	$REF: SourceRange	-	-
text	String	-	-

RETURNS:

Name	Type	Description	Flags
containerQuery	$REF: CSSContainerQuery	The resulting CSS container query rule after modification.	-

setRuleSelector

Modifies the rule selector.

-

PARAMETERS:

Name	Type	Description	Flags
styleSheetId	$REF: StyleSheetId	-	-
range	$REF: SourceRange	-	-
selector	String	-	-

RETURNS:

Name	Type	Description	Flags
selectorList	$REF: SelectorList	The resulting selector list after modification.	-

setStyleSheetText

Sets the new stylesheet text.

-

PARAMETERS:

Name	Type	Description	Flags
styleSheetId	$REF: StyleSheetId	-	-
text	String	-	-

RETURNS:

Name	Type	Description	Flags
sourceMapURL	String	URL of source map associated with script (if any).	[OPTIONAL]

setStyleTexts

Applies specified style edits one after another in the given order.

-

PARAMETERS:

Name	Type	Description	Flags
edits	Array (of) $REF: StyleDeclarationEdit	-	-

RETURNS:

Name	Type	Description	Flags
styles	Array (of) $REF: CSSStyle	The resulting styles after modification.	-

startRuleUsageTracking

Enables the selector recording.

-

stopRuleUsageTracking

Stop tracking rule usage and return the list of rules that were used since last call to `takeCoverageDelta` (or since start of coverage instrumentation)

-

RETURNS:

Name	Type	Description	Flags
ruleUsage	Array (of) $REF: RuleUsage	-	-

takeCoverageDelta

Obtain list of rules that became used since last call to this method (or since start of coverage instrumentation)

-

RETURNS:

Name	Type	Description	Flags
coverage	Array (of) $REF: RuleUsage	-	-
timestamp	Number	Monotonically increasing time, in seconds.	-

setLocalFontsEnabled

Enables/disables rendering of local CSS fonts (enabled by default).

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
enabled	Boolean	Whether rendering of local fonts is enabled.	-

events

Name

Description

Flags

fontsUpdated

Fires whenever a web font is updated. A non-empty font parameter indicates a successfully loaded web font

-

PARAMETERS:

Name	Type	Description	Flags
font	$REF: FontFace	The web font that has loaded.	[OPTIONAL]

mediaQueryResultChanged

Fires whenever a MediaQuery result changes (for example, after a browser window has been resized.) The current implementation considers only viewport-dependent media features.

-

styleSheetAdded

Fired whenever an active document stylesheet is added.

-

PARAMETERS:

Name	Type	Description	Flags
header	$REF: CSSStyleSheetHeader	Added stylesheet metainfo.	-

styleSheetChanged

Fired whenever a stylesheet is changed as a result of the client operation.

-

PARAMETERS:

Name	Type	Description	Flags
styleSheetId	$REF: StyleSheetId	-	-

styleSheetRemoved

Fired whenever an active document stylesheet is removed.

-

PARAMETERS:

Name	Type	Description	Flags
styleSheetId	$REF: StyleSheetId	Identifier of the removed stylesheet.	-

CacheStorage

[Experimental]

-

types

Type ID

Type

Description

Flags

CacheId

String

Unique identifier of the Cache object.

-

CachedResponseType

type of HTTP response cached

-

DataEntry

Object

Data entry.

-

PROPERTIES:

Name	Type	Description	Flags
requestURL	String	Request URL.	-
requestMethod	String	Request method.	-
requestHeaders	Array (of) $REF: Header	Request headers	-
responseTime	Number	Number of seconds since epoch.	-
responseStatus	Integer	HTTP response status code.	-
responseStatusText	String	HTTP response status text.	-
responseType	$REF: CachedResponseType	HTTP response type	-
responseHeaders	Array (of) $REF: Header	Response headers	-

Cache

Object

Cache identifier.

-

PROPERTIES:

Name	Type	Description	Flags
cacheId	$REF: CacheId	An opaque unique id of the cache.	-
securityOrigin	String	Security origin of the cache.	-
cacheName	String	The name of the cache.	-

PROPERTIES:

Name	Type	Description	Flags
name	String	-	-
value	String	-	-

CachedResponse

Object

Cached response

-

PROPERTIES:

Name	Type	Description	Flags
body	String	Entry content, base64-encoded. (Encoded as a base64 string when passed over JSON)	-

commands

Name

Description

Flags

deleteCache

Deletes a cache.

-

PARAMETERS:

Name	Type	Description	Flags
cacheId	$REF: CacheId	Id of cache for deletion.	-

deleteEntry

Deletes a cache entry.

-

PARAMETERS:

Name	Type	Description	Flags
cacheId	$REF: CacheId	Id of cache where the entry will be deleted.	-
request	String	URL spec of the request.	-

requestCacheNames

Requests cache names.

-

PARAMETERS:

Name	Type	Description	Flags
securityOrigin	String	Security origin.	-

RETURNS:

Name	Type	Description	Flags
caches	Array (of) $REF: Cache	Caches for the security origin.	-

requestCachedResponse

Fetches cache entry.

-

PARAMETERS:

Name	Type	Description	Flags
cacheId	$REF: CacheId	Id of cache that contains the entry.	-
requestURL	String	URL spec of the request.	-
requestHeaders	Array (of) $REF: Header	headers of the request.	-

RETURNS:

Name	Type	Description	Flags
response	$REF: CachedResponse	Response read from the cache.	-

requestEntries

Requests data from cache.

-

PARAMETERS:

Name	Type	Description	Flags
cacheId	$REF: CacheId	ID of cache to get entries from.	-
skipCount	Integer	Number of records to skip.	[OPTIONAL]
pageSize	Integer	Number of records to fetch.	[OPTIONAL]
pathFilter	String	If present, only return the entries containing this substring in the path	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
cacheDataEntries	Array (of) $REF: DataEntry	Array of object store data entries.	-
returnCount	Number	Count of returned entries from this storage. If pathFilter is empty, it is the count of all entries from this storage.	-

Cast

[Experimental]

A domain for interacting with Cast, Presentation API, and Remote Playback API functionalities.

DOM

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.

Dependencies: Runtime

types

Type ID

Type

Description

Flags

NodeId

Integer

Unique DOM node identifier.

-

BackendNodeId

Integer

Unique DOM node identifier used to reference a node that may not have been pushed to the front-end.

-

BackendNode

Object

Backend node with a friendly name.

-

PROPERTIES:

Name	Type	Description	Flags
nodeType	Integer	`Node`'s nodeType.	-
nodeName	String	`Node`'s nodeName.	-
backendNodeId	$REF: BackendNodeId	-	-

PseudoType

Pseudo element type.

-

ShadowRootType

Shadow root type.

-

CompatibilityMode

Document compatibility mode.

-

Node

Object

DOM interaction is implemented in terms of mirror objects that represent the actual DOM nodes. DOMNode is a base node mirror type.

-

PROPERTIES:

Name	Type	Description	Flags
nodeId	$REF: NodeId	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.	-
parentId	$REF: NodeId	The id of the parent node if any.	[OPTIONAL]
backendNodeId	$REF: BackendNodeId	The BackendNodeId for this node.	-
nodeType	Integer	`Node`'s nodeType.	-
nodeName	String	`Node`'s nodeName.	-
localName	String	`Node`'s localName.	-
nodeValue	String	`Node`'s nodeValue.	-
childNodeCount	Integer	Child count for `Container` nodes.	[OPTIONAL]
children	Array (of) $REF: Node	Child nodes of this node when requested with children.	[OPTIONAL]
attributes	Array (of) String	Attributes of the `Element` node in the form of flat array `[name1, value1, name2, value2]`.	[OPTIONAL]
documentURL	String	Document URL that `Document` or `FrameOwner` node points to.	[OPTIONAL]
baseURL	String	Base URL that `Document` or `FrameOwner` node uses for URL completion.	[OPTIONAL]
publicId	String	`DocumentType`'s publicId.	[OPTIONAL]
systemId	String	`DocumentType`'s systemId.	[OPTIONAL]
internalSubset	String	`DocumentType`'s internalSubset.	[OPTIONAL]
xmlVersion	String	`Document`'s XML version in case of XML documents.	[OPTIONAL]
name	String	`Attr`'s name.	[OPTIONAL]
value	String	`Attr`'s value.	[OPTIONAL]
pseudoType	$REF: PseudoType	Pseudo element type for this node.	[OPTIONAL]
shadowRootType	$REF: ShadowRootType	Shadow root type.	[OPTIONAL]
frameId	$REF: Page.FrameId	Frame ID for frame owner elements.	[OPTIONAL]
contentDocument	$REF: Node	Content document for frame owner elements.	[OPTIONAL]
shadowRoots	Array (of) $REF: Node	Shadow root list for given element host.	[OPTIONAL]
templateContent	$REF: Node	Content document fragment for template elements.	[OPTIONAL]
pseudoElements	Array (of) $REF: Node	Pseudo elements associated with this node.	[OPTIONAL]
importedDocument	$REF: Node	Deprecated, as the HTML Imports API has been removed (crbug.com/937746). This property used to return the imported document for the HTMLImport links. The property is always undefined now.	[OPTIONAL] [DEPRECATED]
distributedNodes	Array (of) $REF: BackendNode	Distributed nodes for given insertion point.	[OPTIONAL]
isSVG	Boolean	Whether the node is SVG.	[OPTIONAL]
compatibilityMode	$REF: CompatibilityMode	-	[OPTIONAL]

RGBA

Object

A structure holding an RGBA color.

-

PROPERTIES:

Name	Type	Description	Flags
r	Integer	The red component, in the [0-255] range.	-
g	Integer	The green component, in the [0-255] range.	-
b	Integer	The blue component, in the [0-255] range.	-
a	Number	The alpha component, in the [0-1] range (default: 1).	[OPTIONAL]

Quad

Array (of)
Number

An array of quad vertices, x immediately followed by y for each point, points clock-wise.

-

BoxModel

Object

Box model.

-

PROPERTIES:

Name	Type	Description	Flags
content	$REF: Quad	Content box	-
padding	$REF: Quad	Padding box	-
border	$REF: Quad	Border box	-
margin	$REF: Quad	Margin box	-
width	Integer	Node width	-
height	Integer	Node height	-
shapeOutside	$REF: ShapeOutsideInfo	Shape outside coordinates	[OPTIONAL]

ShapeOutsideInfo

Object

CSS Shape Outside details.

-

PROPERTIES:

Name	Type	Description	Flags
bounds	$REF: Quad	Shape bounds	-
shape	Array (of) Any	Shape coordinate details	-
marginShape	Array (of) Any	Margin shape bounds	-

Rect

Object

Rectangle.

-

PROPERTIES:

Name	Type	Description	Flags
x	Number	X coordinate	-
y	Number	Y coordinate	-
width	Number	Rectangle width	-
height	Number	Rectangle height	-

CSSComputedStyleProperty

Object

-

PROPERTIES:

Name	Type	Description	Flags
name	String	Computed style property name.	-
value	String	Computed style property value.	-

commands

Name

Description

Flags

collectClassNamesFromSubtree

Collects class names for the node with given id and all of it's child nodes.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: NodeId	Id of the node to collect class names.	-

RETURNS:

Name	Type	Description	Flags
classNames	Array (of) String	Class name list.	-

copyTo

Creates a deep copy of the specified node and places it into the target container before the given anchor.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: NodeId	Id of the node to copy.	-
targetNodeId	$REF: NodeId	Id of the element to drop the copy into.	-
insertBeforeNodeId	$REF: NodeId	Drop the copy before this node (if absent, the copy becomes the last child of `targetNodeId`).	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
nodeId	$REF: NodeId	Id of the node clone.	-

describeNode

Describes node given its id, does not require domain to be enabled. Does not start tracking any objects, can be used for automation.

-

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: NodeId	Identifier of the node.	[OPTIONAL]
backendNodeId	$REF: BackendNodeId	Identifier of the backend node.	[OPTIONAL]
objectId	$REF: Runtime.RemoteObjectId	JavaScript object id of the node wrapper.	[OPTIONAL]
depth	Integer	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.	[OPTIONAL]
pierce	Boolean	Whether or not iframes and shadow roots should be traversed when returning the subtree (default is false).	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
node	$REF: Node	Node description.	-

scrollIntoViewIfNeeded

Scrolls the specified rect of the given node into view if not already visible. Note: exactly one between nodeId, backendNodeId and objectId should be passed to identify the node.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: NodeId	Identifier of the node.	[OPTIONAL]
backendNodeId	$REF: BackendNodeId	Identifier of the backend node.	[OPTIONAL]
objectId	$REF: Runtime.RemoteObjectId	JavaScript object id of the node wrapper.	[OPTIONAL]
rect	$REF: Rect	The rect to be scrolled into view, relative to the node's border box, in CSS pixels. When omitted, center of the node will be used, similar to Element.scrollIntoView.	[OPTIONAL]

disable

Disables DOM agent for the given page.

-

discardSearchResults

Discards search results from the session with the given id. `getSearchResults` should no longer be called for that search.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
searchId	String	Unique search session identifier.	-

enable

Enables DOM agent for the given page.

-

focus

Focuses the given element.

-

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: NodeId	Identifier of the node.	[OPTIONAL]
backendNodeId	$REF: BackendNodeId	Identifier of the backend node.	[OPTIONAL]
objectId	$REF: Runtime.RemoteObjectId	JavaScript object id of the node wrapper.	[OPTIONAL]

getAttributes

Returns attributes for the specified node.

-

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: NodeId	Id of the node to retrieve attibutes for.	-

RETURNS:

Name	Type	Description	Flags
attributes	Array (of) String	An interleaved array of node attribute names and values.	-

getBoxModel

Returns boxes for the given node.

-

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: NodeId	Identifier of the node.	[OPTIONAL]
backendNodeId	$REF: BackendNodeId	Identifier of the backend node.	[OPTIONAL]
objectId	$REF: Runtime.RemoteObjectId	JavaScript object id of the node wrapper.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
model	$REF: BoxModel	Box model for the node.	-

getContentQuads

Returns quads that describe node position on the page. This method might return multiple quads for inline nodes.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: NodeId	Identifier of the node.	[OPTIONAL]
backendNodeId	$REF: BackendNodeId	Identifier of the backend node.	[OPTIONAL]
objectId	$REF: Runtime.RemoteObjectId	JavaScript object id of the node wrapper.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
quads	Array (of) $REF: Quad	Quads that describe node layout relative to viewport.	-

getDocument

Returns the root DOM node (and optionally the subtree) to the caller.

-

PARAMETERS:

Name	Type	Description	Flags
depth	Integer	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.	[OPTIONAL]
pierce	Boolean	Whether or not iframes and shadow roots should be traversed when returning the subtree (default is false).	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
root	$REF: Node	Resulting node.	-

getFlattenedDocument

Returns the root DOM node (and optionally the subtree) to the caller. Deprecated, as it is not designed to work well with the rest of the DOM agent. Use DOMSnapshot.captureSnapshot instead.

[DEPRECATED]

PARAMETERS:

Name	Type	Description	Flags
depth	Integer	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.	[OPTIONAL]
pierce	Boolean	Whether or not iframes and shadow roots should be traversed when returning the subtree (default is false).	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
nodes	Array (of) $REF: Node	Resulting node.	-

getNodesForSubtreeByStyle

Finds nodes with a given computed style in a subtree.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: NodeId	Node ID pointing to the root of a subtree.	-
computedStyles	Array (of) $REF: CSSComputedStyleProperty	The style to filter nodes by (includes nodes if any of properties matches).	-
pierce	Boolean	Whether or not iframes and shadow roots in the same target should be traversed when returning the results (default is false).	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
nodeIds	Array (of) $REF: NodeId	Resulting nodes.	-

getNodeForLocation

Returns node id at given location. Depending on whether DOM domain is enabled, nodeId is either returned or not.

-

PARAMETERS:

Name	Type	Description	Flags
x	Integer	X coordinate.	-
y	Integer	Y coordinate.	-
includeUserAgentShadowDOM	Boolean	False to skip to the nearest non-UA shadow root ancestor (default: false).	[OPTIONAL]
ignorePointerEventsNone	Boolean	Whether to ignore pointer-events: none on elements and hit test them.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
backendNodeId	$REF: BackendNodeId	Resulting node.	-
frameId	$REF: Page.FrameId	Frame this node belongs to.	-
nodeId	$REF: NodeId	Id of the node at given coordinates, only when enabled and requested document.	[OPTIONAL]

getOuterHTML

Returns node's HTML markup.

-

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: NodeId	Identifier of the node.	[OPTIONAL]
backendNodeId	$REF: BackendNodeId	Identifier of the backend node.	[OPTIONAL]
objectId	$REF: Runtime.RemoteObjectId	JavaScript object id of the node wrapper.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
outerHTML	String	Outer HTML markup.	-

getRelayoutBoundary

Returns the id of the nearest ancestor that is a relayout boundary.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: NodeId	Id of the node.	-

RETURNS:

Name	Type	Description	Flags
nodeId	$REF: NodeId	Relayout boundary node id for the given node.	-

getSearchResults

Returns search results from given `fromIndex` to given `toIndex` from the search with the given identifier.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
searchId	String	Unique search session identifier.	-
fromIndex	Integer	Start index of the search result to be returned.	-
toIndex	Integer	End index of the search result to be returned.	-

RETURNS:

Name	Type	Description	Flags
nodeIds	Array (of) $REF: NodeId	Ids of the search result nodes.	-

hideHighlight
REDIRECT: Overlay

Hides any highlight.

-

highlightNode
REDIRECT: Overlay

Highlights DOM node.

-

highlightRect
REDIRECT: Overlay

Highlights given rectangle.

-

markUndoableState

Marks last undoable state.

[EXPERIMENTAL]

moveTo

Moves node into the new container, places it before the given anchor.

-

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: NodeId	Id of the node to move.	-
targetNodeId	$REF: NodeId	Id of the element to drop the moved node into.	-
insertBeforeNodeId	$REF: NodeId	Drop node before this one (if absent, the moved node becomes the last child of `targetNodeId`).	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
nodeId	$REF: NodeId	New id of the moved node.	-

performSearch

Searches for a given string in the DOM tree. Use `getSearchResults` to access search results or `cancelSearch` to end this search session.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
query	String	Plain text or query selector or XPath search query.	-
includeUserAgentShadowDOM	Boolean	True to search in user agent shadow DOM.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
searchId	String	Unique search session identifier.	-
resultCount	Integer	Number of search results.	-

pushNodeByPathToFrontend

Requests that the node is sent to the caller given its path. // FIXME, use XPath

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
path	String	Path to node in the proprietary format.	-

RETURNS:

Name	Type	Description	Flags
nodeId	$REF: NodeId	Id of the node for given path.	-

pushNodesByBackendIdsToFrontend

Requests that a batch of nodes is sent to the caller given their backend node ids.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
backendNodeIds	Array (of) $REF: BackendNodeId	The array of backend node ids.	-

RETURNS:

Name	Type	Description	Flags
nodeIds	Array (of) $REF: NodeId	The array of ids of pushed nodes that correspond to the backend ids specified in backendNodeIds.	-

querySelector

Executes `querySelector` on a given node.

-

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: NodeId	Id of the node to query upon.	-
selector	String	Selector string.	-

RETURNS:

Name	Type	Description	Flags
nodeId	$REF: NodeId	Query selector result.	-

querySelectorAll

Executes `querySelectorAll` on a given node.

-

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: NodeId	Id of the node to query upon.	-
selector	String	Selector string.	-

RETURNS:

Name	Type	Description	Flags
nodeIds	Array (of) $REF: NodeId	Query selector result.	-

redo

Re-does the last undone action.

[EXPERIMENTAL]

removeAttribute

Removes attribute with given name from an element with given id.

-

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: NodeId	Id of the element to remove attribute from.	-
name	String	Name of the attribute to remove.	-

removeNode

Removes node with given id.

-

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: NodeId	Id of the node to remove.	-

requestChildNodes

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.

-

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: NodeId	Id of the node to get children for.	-
depth	Integer	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.	[OPTIONAL]
pierce	Boolean	Whether or not iframes and shadow roots should be traversed when returning the sub-tree (default is false).	[OPTIONAL]

requestNode

Requests that the node is sent to the caller given the JavaScript node object reference. All nodes that form the path from the node to the root are also sent to the client as a series of `setChildNodes` notifications.

-

PARAMETERS:

Name	Type	Description	Flags
objectId	$REF: Runtime.RemoteObjectId	JavaScript object id to convert into node.	-

RETURNS:

Name	Type	Description	Flags
nodeId	$REF: NodeId	Node id for given object.	-

resolveNode

Resolves the JavaScript node object for a given NodeId or BackendNodeId.

-

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: NodeId	Id of the node to resolve.	[OPTIONAL]
backendNodeId	$REF: DOM.BackendNodeId	Backend identifier of the node to resolve.	[OPTIONAL]
objectGroup	String	Symbolic group name that can be used to release multiple objects.	[OPTIONAL]
executionContextId	$REF: Runtime.ExecutionContextId	Execution context in which to resolve the node.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
object	$REF: Runtime.RemoteObject	JavaScript object wrapper for given node.	-

setAttributeValue

Sets attribute for an element with given id.

-

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: NodeId	Id of the element to set attribute for.	-
name	String	Attribute name.	-
value	String	Attribute value.	-

setAttributesAsText

Sets attributes on element with given id. This method is useful when user edits some existing attribute value and types in several attribute name/value pairs.

-

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: NodeId	Id of the element to set attributes for.	-
text	String	Text with a number of attributes. Will parse this text using HTML parser.	-
name	String	Attribute name to replace with new attributes derived from text in case text parsed successfully.	[OPTIONAL]

setFileInputFiles

Sets files for the given file input element.

-

PARAMETERS:

Name	Type	Description	Flags
files	Array (of) String	Array of file paths to set.	-
nodeId	$REF: NodeId	Identifier of the node.	[OPTIONAL]
backendNodeId	$REF: BackendNodeId	Identifier of the backend node.	[OPTIONAL]
objectId	$REF: Runtime.RemoteObjectId	JavaScript object id of the node wrapper.	[OPTIONAL]

setNodeStackTracesEnabled

Sets if stack traces should be captured for Nodes. See `Node.getNodeStackTraces`. Default is disabled.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
enable	Boolean	Enable or disable.	-

getNodeStackTraces

Gets stack traces associated with a Node. As of now, only provides stack trace for Node creation.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: NodeId	Id of the node to get stack traces for.	-

RETURNS:

Name	Type	Description	Flags
creation	$REF: Runtime.StackTrace	Creation stack trace, if available.	[OPTIONAL]

getFileInfo

Returns file information for the given File wrapper.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
objectId	$REF: Runtime.RemoteObjectId	JavaScript object id of the node wrapper.	-

RETURNS:

Name	Type	Description	Flags
path	String	-	-

setInspectedNode

Enables console to refer to the node with given id via $x (see Command Line API for more details $x functions).

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: NodeId	DOM node id to be accessible by means of $x command line API.	-

setNodeName

Sets node name for a node with given id.

-

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: NodeId	Id of the node to set name for.	-
name	String	New node's name.	-

RETURNS:

Name	Type	Description	Flags
nodeId	$REF: NodeId	New node's id.	-

setNodeValue

Sets node value for a node with given id.

-

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: NodeId	Id of the node to set value for.	-
value	String	New node's value.	-

setOuterHTML

Sets node HTML markup, returns new node id.

-

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: NodeId	Id of the node to set markup for.	-
outerHTML	String	Outer HTML markup to set.	-

undo

Undoes the last performed action.

[EXPERIMENTAL]

getFrameOwner

Returns iframe node that owns iframe with the given domain.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
frameId	$REF: Page.FrameId	-	-

RETURNS:

Name	Type	Description	Flags
backendNodeId	$REF: BackendNodeId	Resulting node.	-
nodeId	$REF: NodeId	Id of the node at given coordinates, only when enabled and requested document.	[OPTIONAL]

getContainerForNode

Returns the container of the given node based on container query conditions. If containerName is given, it will find the nearest container with a matching name; otherwise it will find the nearest container regardless of its container name.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: NodeId	-	-
containerName	String	-	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
nodeId	$REF: NodeId	The container node for the given node, or null if not found.	[OPTIONAL]

getQueryingDescendantsForContainer

Returns the descendants of a container query container that have container queries against this container.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: NodeId	Id of the container node to find querying descendants from.	-

RETURNS:

Name	Type	Description	Flags
nodeIds	Array (of) $REF: NodeId	Descendant nodes with container queries against the given container.	-

events

Name

Description

Flags

attributeModified

Fired when `Element`'s attribute is modified.

-

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: NodeId	Id of the node that has changed.	-
name	String	Attribute name.	-
value	String	Attribute value.	-

attributeRemoved

Fired when `Element`'s attribute is removed.

-

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: NodeId	Id of the node that has changed.	-
name	String	A ttribute name.	-

characterDataModified

Mirrors `DOMCharacterDataModified` event.

-

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: NodeId	Id of the node that has changed.	-
characterData	String	New text value.	-

childNodeCountUpdated

Fired when `Container`'s child node count has changed.

-

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: NodeId	Id of the node that has changed.	-
childNodeCount	Integer	New node count.	-

childNodeInserted

Mirrors `DOMNodeInserted` event.

-

PARAMETERS:

Name	Type	Description	Flags
parentNodeId	$REF: NodeId	Id of the node that has changed.	-
previousNodeId	$REF: NodeId	If of the previous siblint.	-
node	$REF: Node	Inserted node data.	-

childNodeRemoved

Mirrors `DOMNodeRemoved` event.

-

PARAMETERS:

Name	Type	Description	Flags
parentNodeId	$REF: NodeId	Parent id.	-
nodeId	$REF: NodeId	Id of the node that has been removed.	-

distributedNodesUpdated

Called when distribution is changed.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
insertionPointId	$REF: NodeId	Insertion point where distributed nodes were updated.	-
distributedNodes	Array (of) $REF: BackendNode	Distributed nodes for given insertion point.	-

documentUpdated

Fired when `Document` has been totally updated. Node ids are no longer valid.

-

inlineStyleInvalidated

Fired when `Element`'s inline style is modified via a CSS property modification.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
nodeIds	Array (of) $REF: NodeId	Ids of the nodes for which the inline styles have been invalidated.	-

pseudoElementAdded

Called when a pseudo element is added to an element.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
parentId	$REF: NodeId	Pseudo element's parent element id.	-
pseudoElement	$REF: Node	The added pseudo element.	-

pseudoElementRemoved

Called when a pseudo element is removed from an element.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
parentId	$REF: NodeId	Pseudo element's parent element id.	-
pseudoElementId	$REF: NodeId	The removed pseudo element id.	-

setChildNodes

Fired when backend wants to provide client with the missing DOM structure. This happens upon most of the calls requesting node ids.

-

PARAMETERS:

Name	Type	Description	Flags
parentId	$REF: NodeId	Parent node id to populate with children.	-
nodes	Array (of) $REF: Node	Child nodes array.	-

shadowRootPopped

Called when shadow root is popped from the element.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
hostId	$REF: NodeId	Host element id.	-
rootId	$REF: NodeId	Shadow root id.	-

shadowRootPushed

Called when shadow root is pushed into the element.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
hostId	$REF: NodeId	Host element id.	-
root	$REF: Node	Shadow root.	-

DOMDebugger

DOM debugging allows setting breakpoints on particular DOM operations and events. JavaScript execution will stop on these operations as if there was a regular breakpoint set.

Dependencies: DOM, Debugger, Runtime

types

Type ID

Type

Description

Flags

DOMBreakpointType

DOM breakpoint type.

-

CSPViolationType

CSP Violation type.

[EXPERIMENTAL]

EventListener

Object

Object event listener.

-

PROPERTIES:

Name	Type	Description	Flags
type	String	`EventListener`'s type.	-
useCapture	Boolean	`EventListener`'s useCapture.	-
passive	Boolean	`EventListener`'s passive flag.	-
once	Boolean	`EventListener`'s once flag.	-
scriptId	$REF: Runtime.ScriptId	Script id of the handler code.	-
lineNumber	Integer	Line number in the script (0-based).	-
columnNumber	Integer	Column number in the script (0-based).	-
handler	$REF: Runtime.RemoteObject	Event handler function value.	[OPTIONAL]
originalHandler	$REF: Runtime.RemoteObject	Event original handler function value.	[OPTIONAL]
backendNodeId	$REF: DOM.BackendNodeId	Node the listener is added to (if any).	[OPTIONAL]

commands

Name

Description

Flags

getEventListeners

Returns event listeners of the given object.

-

PARAMETERS:

Name	Type	Description	Flags
objectId	$REF: Runtime.RemoteObjectId	Identifier of the object to return listeners for.	-
depth	Integer	The maximum depth at which Node children should be retrieved, defaults to 1. Use -1 for the entire subtree or provide an integer larger than 0.	[OPTIONAL]
pierce	Boolean	Whether or not iframes and shadow roots should be traversed when returning the subtree (default is false). Reports listeners for all contexts if pierce is enabled.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
listeners	Array (of) $REF: EventListener	Array of relevant listeners.	-

removeDOMBreakpoint

Removes DOM breakpoint that was set using `setDOMBreakpoint`.

-

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: DOM.NodeId	Identifier of the node to remove breakpoint from.	-
type	$REF: DOMBreakpointType	Type of the breakpoint to remove.	-

removeEventListenerBreakpoint

Removes breakpoint on particular DOM event.

-

PARAMETERS:

Name	Type	Description	Flags
eventName	String	Event name.	-
targetName	String	EventTarget interface name.	[OPTIONAL] [EXPERIMENTAL]

removeInstrumentationBreakpoint

Removes breakpoint on particular native event.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
eventName	String	Instrumentation name to stop on.	-

removeXHRBreakpoint

Removes breakpoint from XMLHttpRequest.

-

PARAMETERS:

Name	Type	Description	Flags
url	String	Resource URL substring.	-

setBreakOnCSPViolation

Sets breakpoint on particular CSP violations.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
violationTypes	Array (of) $REF: CSPViolationType	CSP Violations to stop upon.	-

setDOMBreakpoint

Sets breakpoint on particular operation with DOM.

-

PARAMETERS:

Name	Type	Description	Flags
nodeId	$REF: DOM.NodeId	Identifier of the node to set breakpoint on.	-
type	$REF: DOMBreakpointType	Type of the operation to stop upon.	-

setEventListenerBreakpoint

Sets breakpoint on particular DOM event.

-

PARAMETERS:

Name	Type	Description	Flags
eventName	String	DOM Event name to stop on (any DOM event will do).	-
targetName	String	EventTarget interface name to stop on. If equal to `"*"` or not provided, will stop on any EventTarget.	[OPTIONAL] [EXPERIMENTAL]

setInstrumentationBreakpoint

Sets breakpoint on particular native event.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
eventName	String	Instrumentation name to stop on.	-

setXHRBreakpoint

Sets breakpoint on XMLHttpRequest.

-

PARAMETERS:

Name	Type	Description	Flags
url	String	Resource URL substring. All XHRs having this substring in the URL will get stopped upon.	-

DOMSnapshot

[Experimental]

This domain facilitates obtaining document snapshots with DOM, layout, and style information.

Dependencies: CSS, DOM, DOMDebugger, Page

types

Type ID

Type

Description

Flags

DOMNode

Object

A Node in the DOM tree.

-

PROPERTIES:

Name	Type	Description	Flags
nodeType	Integer	`Node`'s nodeType.	-
nodeName	String	`Node`'s nodeName.	-
nodeValue	String	`Node`'s nodeValue.	-
textValue	String	Only set for textarea elements, contains the text value.	[OPTIONAL]
inputValue	String	Only set for input elements, contains the input's associated text value.	[OPTIONAL]
inputChecked	Boolean	Only set for radio and checkbox input elements, indicates if the element has been checked	[OPTIONAL]
optionSelected	Boolean	Only set for option elements, indicates if the element has been selected	[OPTIONAL]
backendNodeId	$REF: DOM.BackendNodeId	`Node`'s id, corresponds to DOM.Node.backendNodeId.	-
childNodeIndexes	Array (of) Integer	The indexes of the node's child nodes in the `domNodes` array returned by `getSnapshot`, if any.	[OPTIONAL]
attributes	Array (of) $REF: NameValue	Attributes of an `Element` node.	[OPTIONAL]
pseudoElementIndexes	Array (of) Integer	Indexes of pseudo elements associated with this node in the `domNodes` array returned by `getSnapshot`, if any.	[OPTIONAL]
layoutNodeIndex	Integer	The index of the node's related layout tree node in the `layoutTreeNodes` array returned by `getSnapshot`, if any.	[OPTIONAL]
documentURL	String	Document URL that `Document` or `FrameOwner` node points to.	[OPTIONAL]
baseURL	String	Base URL that `Document` or `FrameOwner` node uses for URL completion.	[OPTIONAL]
contentLanguage	String	Only set for documents, contains the document's content language.	[OPTIONAL]
documentEncoding	String	Only set for documents, contains the document's character set encoding.	[OPTIONAL]
publicId	String	`DocumentType` node's publicId.	[OPTIONAL]
systemId	String	`DocumentType` node's systemId.	[OPTIONAL]
frameId	$REF: Page.FrameId	Frame ID for frame owner elements and also for the document node.	[OPTIONAL]
contentDocumentIndex	Integer	The index of a frame owner element's content document in the `domNodes` array returned by `getSnapshot`, if any.	[OPTIONAL]
pseudoType	$REF: DOM.PseudoType	Type of a pseudo element node.	[OPTIONAL]
shadowRootType	$REF: DOM.ShadowRootType	Shadow root type.	[OPTIONAL]
isClickable	Boolean	Whether this DOM node responds to mouse clicks. This includes nodes that have had click event listeners attached via JavaScript as well as anchor tags that naturally navigate when clicked.	[OPTIONAL]
eventListeners	Array (of) $REF: DOMDebugger.EventListener	Details of the node's event listeners, if any.	[OPTIONAL]
currentSourceURL	String	The selected url for nodes with a srcset attribute.	[OPTIONAL]
originURL	String	The url of the script (if any) that generates this node.	[OPTIONAL]
scrollOffsetX	Number	Scroll offsets, set when this node is a Document.	[OPTIONAL]
scrollOffsetY	Number	-	[OPTIONAL]

InlineTextBox

Object

Details of post layout rendered text positions. The exact layout should not be regarded as stable and may change between versions.

-

PROPERTIES:

Name	Type	Description	Flags
boundingBox	$REF: DOM.Rect	The bounding box in document coordinates. Note that scroll offset of the document is ignored.	-
startCharacterIndex	Integer	The starting index in characters, for this post layout textbox substring. Characters that would be represented as a surrogate pair in UTF-16 have length 2.	-
numCharacters	Integer	The number of characters in this post layout textbox substring. Characters that would be represented as a surrogate pair in UTF-16 have length 2.	-

LayoutTreeNode

Object

Details of an element in the DOM tree with a LayoutObject.

-

PROPERTIES:

Name	Type	Description	Flags
domNodeIndex	Integer	The index of the related DOM node in the `domNodes` array returned by `getSnapshot`.	-
boundingBox	$REF: DOM.Rect	The bounding box in document coordinates. Note that scroll offset of the document is ignored.	-
layoutText	String	Contents of the LayoutText, if any.	[OPTIONAL]
inlineTextNodes	Array (of) $REF: InlineTextBox	The post-layout inline text nodes, if any.	[OPTIONAL]
styleIndex	Integer	Index into the `computedStyles` array returned by `getSnapshot`.	[OPTIONAL]
paintOrder	Integer	Global paint order index, which is determined by the stacking order of the nodes. Nodes that are painted together will have the same index. Only provided if includePaintOrder in getSnapshot was true.	[OPTIONAL]
isStackingContext	Boolean	Set to true to indicate the element begins a new stacking context.	[OPTIONAL]

ComputedStyle

Object

A subset of the full ComputedStyle as defined by the request whitelist.

-

PROPERTIES:

Name	Type	Description	Flags
properties	Array (of) $REF: NameValue	Name/value pairs of computed style properties.	-

NameValue

Object

A name/value pair.

-

PROPERTIES:

Name	Type	Description	Flags
name	String	Attribute/property name.	-
value	String	Attribute/property value.	-

StringIndex

Integer

Index of the string in the strings table.

-

ArrayOfStrings

Array (of)
$REF: StringIndex

Index of the string in the strings table.

-

RareStringData

Object

Data that is only present on rare nodes.

-

PROPERTIES:

Name	Type	Description	Flags
index	Array (of) Integer	-	-
value	Array (of) $REF: StringIndex	-	-

RareBooleanData

Object

-

PROPERTIES:

Name	Type	Description	Flags
index	Array (of) Integer	-	-

RareIntegerData

Object

-

PROPERTIES:

Name	Type	Description	Flags
index	Array (of) Integer	-	-
value	Array (of) Integer	-	-

Rectangle

Array (of)
Number

-

DocumentSnapshot

Object

Document snapshot.

-

PROPERTIES:

Name	Type	Description	Flags
documentURL	$REF: StringIndex	Document URL that `Document` or `FrameOwner` node points to.	-
title	$REF: StringIndex	Document title.	-
baseURL	$REF: StringIndex	Base URL that `Document` or `FrameOwner` node uses for URL completion.	-
contentLanguage	$REF: StringIndex	Contains the document's content language.	-
encodingName	$REF: StringIndex	Contains the document's character set encoding.	-
publicId	$REF: StringIndex	`DocumentType` node's publicId.	-
systemId	$REF: StringIndex	`DocumentType` node's systemId.	-
frameId	$REF: StringIndex	Frame ID for frame owner elements and also for the document node.	-
nodes	$REF: NodeTreeSnapshot	A table with dom nodes.	-
layout	$REF: LayoutTreeSnapshot	The nodes in the layout tree.	-
textBoxes	$REF: TextBoxSnapshot	The post-layout inline text nodes.	-
scrollOffsetX	Number	Horizontal scroll offset.	[OPTIONAL]
scrollOffsetY	Number	Vertical scroll offset.	[OPTIONAL]
contentWidth	Number	Document content width.	[OPTIONAL]
contentHeight	Number	Document content height.	[OPTIONAL]

NodeTreeSnapshot

Object

Table containing nodes.

-

PROPERTIES:

Name	Type	Description	Flags
parentIndex	Array (of) Integer	Parent node index.	[OPTIONAL]
nodeType	Array (of) Integer	`Node`'s nodeType.	[OPTIONAL]
shadowRootType	$REF: RareStringData	Type of the shadow root the `Node` is in. String values are equal to the `ShadowRootType` enum.	[OPTIONAL]
nodeName	Array (of) $REF: StringIndex	`Node`'s nodeName.	[OPTIONAL]
nodeValue	Array (of) $REF: StringIndex	`Node`'s nodeValue.	[OPTIONAL]
backendNodeId	Array (of) $REF: DOM.BackendNodeId	`Node`'s id, corresponds to DOM.Node.backendNodeId.	[OPTIONAL]
attributes	Array (of) $REF: ArrayOfStrings	Attributes of an `Element` node. Flatten name, value pairs.	[OPTIONAL]
textValue	$REF: RareStringData	Only set for textarea elements, contains the text value.	[OPTIONAL]
inputValue	$REF: RareStringData	Only set for input elements, contains the input's associated text value.	[OPTIONAL]
inputChecked	$REF: RareBooleanData	Only set for radio and checkbox input elements, indicates if the element has been checked	[OPTIONAL]
optionSelected	$REF: RareBooleanData	Only set for option elements, indicates if the element has been selected	[OPTIONAL]
contentDocumentIndex	$REF: RareIntegerData	The index of the document in the list of the snapshot documents.	[OPTIONAL]
pseudoType	$REF: RareStringData	Type of a pseudo element node.	[OPTIONAL]
isClickable	$REF: RareBooleanData	Whether this DOM node responds to mouse clicks. This includes nodes that have had click event listeners attached via JavaScript as well as anchor tags that naturally navigate when clicked.	[OPTIONAL]
currentSourceURL	$REF: RareStringData	The selected url for nodes with a srcset attribute.	[OPTIONAL]
originURL	$REF: RareStringData	The url of the script (if any) that generates this node.	[OPTIONAL]

LayoutTreeSnapshot

Object

Table of details of an element in the DOM tree with a LayoutObject.

-

PROPERTIES:

Name	Type	Description	Flags
nodeIndex	Array (of) Integer	Index of the corresponding node in the `NodeTreeSnapshot` array returned by `captureSnapshot`.	-
styles	Array (of) $REF: ArrayOfStrings	Array of indexes specifying computed style strings, filtered according to the `computedStyles` parameter passed to `captureSnapshot`.	-
bounds	Array (of) $REF: Rectangle	The absolute position bounding box.	-
text	Array (of) $REF: StringIndex	Contents of the LayoutText, if any.	-
stackingContexts	$REF: RareBooleanData	Stacking context information.	-
paintOrders	Array (of) Integer	Global paint order index, which is determined by the stacking order of the nodes. Nodes that are painted together will have the same index. Only provided if includePaintOrder in captureSnapshot was true.	[OPTIONAL]
offsetRects	Array (of) $REF: Rectangle	The offset rect of nodes. Only available when includeDOMRects is set to true	[OPTIONAL]
scrollRects	Array (of) $REF: Rectangle	The scroll rect of nodes. Only available when includeDOMRects is set to true	[OPTIONAL]
clientRects	Array (of) $REF: Rectangle	The client rect of nodes. Only available when includeDOMRects is set to true	[OPTIONAL]
blendedBackgroundColors	Array (of) $REF: StringIndex	The list of background colors that are blended with colors of overlapping elements.	[OPTIONAL] [EXPERIMENTAL]
textColorOpacities	Array (of) Number	The list of computed text opacities.	[OPTIONAL] [EXPERIMENTAL]

TextBoxSnapshot

Object

Table of details of the post layout rendered text positions. The exact layout should not be regarded as stable and may change between versions.

-

PROPERTIES:

Name	Type	Description	Flags
layoutIndex	Array (of) Integer	Index of the layout tree node that owns this box collection.	-
bounds	Array (of) $REF: Rectangle	The absolute position bounding box.	-
start	Array (of) Integer	The starting index in characters, for this post layout textbox substring. Characters that would be represented as a surrogate pair in UTF-16 have length 2.	-
length	Array (of) Integer	The number of characters in this post layout textbox substring. Characters that would be represented as a surrogate pair in UTF-16 have length 2.	-

commands

Name

Description

Flags

disable

Disables DOM snapshot agent for the given page.

-

enable

Enables DOM snapshot agent for the given page.

-

getSnapshot

Returns a document snapshot, including the full DOM tree of the root node (including iframes, template contents, and imported documents) in a flattened array, as well as layout and white-listed computed style information for the nodes. Shadow DOM in the returned DOM tree is flattened.

[DEPRECATED]

PARAMETERS:

Name	Type	Description	Flags
computedStyleWhitelist	Array (of) String	Whitelist of computed styles to return.	-
includeEventListeners	Boolean	Whether or not to retrieve details of DOM listeners (default false).	[OPTIONAL]
includePaintOrder	Boolean	Whether to determine and include the paint order index of LayoutTreeNodes (default false).	[OPTIONAL]
includeUserAgentShadowTree	Boolean	Whether to include UA shadow tree in the snapshot (default false).	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
domNodes	Array (of) $REF: DOMNode	The nodes in the DOM tree. The DOMNode at index 0 corresponds to the root document.	-
layoutTreeNodes	Array (of) $REF: LayoutTreeNode	The nodes in the layout tree.	-
computedStyles	Array (of) $REF: ComputedStyle	Whitelisted ComputedStyle properties for each node in the layout tree.	-

captureSnapshot

Returns a document snapshot, including the full DOM tree of the root node (including iframes, template contents, and imported documents) in a flattened array, as well as layout and white-listed computed style information for the nodes. Shadow DOM in the returned DOM tree is flattened.

-

PARAMETERS:

Name	Type	Description	Flags
computedStyles	Array (of) String	Whitelist of computed styles to return.	-
includePaintOrder	Boolean	Whether to include layout object paint orders into the snapshot.	[OPTIONAL]
includeDOMRects	Boolean	Whether to include DOM rectangles (offsetRects, clientRects, scrollRects) into the snapshot	[OPTIONAL]
includeBlendedBackgroundColors	Boolean	Whether to include blended background colors in the snapshot (default: false). Blended background color is achieved by blending background colors of all elements that overlap with the current element.	[OPTIONAL] [EXPERIMENTAL]
includeTextColorOpacities	Boolean	Whether to include text color opacity in the snapshot (default: false). An element might have the opacity property set that affects the text color of the element. The final text color opacity is computed based on the opacity of all overlapping elements.	[OPTIONAL] [EXPERIMENTAL]

RETURNS:

Name	Type	Description	Flags
documents	Array (of) $REF: DocumentSnapshot	The nodes in the DOM tree. The DOMNode at index 0 corresponds to the root document.	-
strings	Array (of) String	Shared string table that all string properties refer to with indexes.	-

DOMStorage

[Experimental]

Query and modify DOM storage.

commands

Name

Description

Flags

clear

-

PARAMETERS:

Name	Type	Description	Flags
storageId	$REF: StorageId	-	-

disable

Disables storage tracking, prevents storage events from being sent to the client.

-

enable

Enables storage tracking, storage events will now be delivered to the client.

-

getDOMStorageItems

-

PARAMETERS:

Name	Type	Description	Flags
storageId	$REF: StorageId	-	-

RETURNS:

Name	Type	Description	Flags
entries	Array (of) $REF: Item	-	-

removeDOMStorageItem

-

PARAMETERS:

Name	Type	Description	Flags
storageId	$REF: StorageId	-	-
key	String	-	-

setDOMStorageItem

-

PARAMETERS:

Name	Type	Description	Flags
storageId	$REF: StorageId	-	-
key	String	-	-
value	String	-	-

Database

[Experimental]

-

DeviceOrientation

[Experimental]

-

Emulation

This domain emulates different environments for the page.

Dependencies: DOM, Page, Runtime

types

Type ID

Type

Description

Flags

ScreenOrientation

Object

Screen orientation.

-

PROPERTIES:

Name	Type	Description	Flags
type	"portraitPrimary", "portraitSecondary", "landscapePrimary", "landscapeSecondary"String [Hover] Enum	Orientation type.	-
angle	Integer	Orientation angle.	-

DisplayFeature

Object

-

PROPERTIES:

Name	Type	Description	Flags
orientation	"vertical", "horizontal"String [Hover] Enum	Orientation of a display feature in relation to screen	-
offset	Integer	The offset from the screen origin in either the x (for vertical orientation) or y (for horizontal orientation) direction.	-
maskLength	Integer	A display feature may mask content such that it is not physically displayed - this length along with the offset describes this area. A display feature that only splits content will have a 0 mask_length.	-

MediaFeature

Object

-

PROPERTIES:

Name	Type	Description	Flags
name	String	-	-
value	String	-	-

VirtualTimePolicy

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.

[EXPERIMENTAL]

UserAgentBrandVersion

Object

Used to specify User Agent Cient Hints to emulate. See https://wicg.github.io/ua-client-hints

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
brand	String	-	-
version	String	-	-

UserAgentMetadata

Object

Used to specify User Agent Cient Hints to emulate. See https://wicg.github.io/ua-client-hints Missing optional values will be filled in by the target with what it would normally use.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
brands	Array (of) $REF: UserAgentBrandVersion	-	[OPTIONAL]
fullVersion	String	-	[OPTIONAL]
platform	String	-	-
platformVersion	String	-	-
architecture	String	-	-
model	String	-	-
mobile	Boolean	-	-

DisabledImageType

Enum of image types that can be disabled.

[EXPERIMENTAL]

commands

Name

Description

Flags

canEmulate

Tells whether emulation is supported.

-

RETURNS:

Name	Type	Description	Flags
result	Boolean	True if emulation is supported.	-

clearDeviceMetricsOverride

Clears the overridden device metrics.

-

clearGeolocationOverride

Clears the overridden Geolocation Position and Error.

-

resetPageScaleFactor

Requests that page scale factor is reset to initial values.

[EXPERIMENTAL]

setFocusEmulationEnabled

Enables or disables simulating a focused and active page.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
enabled	Boolean	Whether to enable to disable focus emulation.	-

setAutoDarkModeOverride

Automatically render all web contents using a dark theme.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
enabled	Boolean	Whether to enable or disable automatic dark mode. If not specified, any existing override will be cleared.	[OPTIONAL]

setCPUThrottlingRate

Enables CPU throttling to emulate slow CPUs.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
rate	Number	Throttling rate as a slowdown factor (1 is no throttle, 2 is 2x slowdown, etc).	-

setDefaultBackgroundColorOverride

Sets or clears an override of the default background color of the frame. This override is used if the content does not specify one.

-

PARAMETERS:

Name	Type	Description	Flags
color	$REF: DOM.RGBA	RGBA of the default background color. If not specified, any existing override will be cleared.	[OPTIONAL]

setDeviceMetricsOverride

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	Type	Description	Flags
width	Integer	Overriding width value in pixels (minimum 0, maximum 10000000). 0 disables the override.	-
height	Integer	Overriding height value in pixels (minimum 0, maximum 10000000). 0 disables the override.	-
deviceScaleFactor	Number	Overriding device scale factor value. 0 disables the override.	-
mobile	Boolean	Whether to emulate mobile device. This includes viewport meta tag, overlay scrollbars, text autosizing and more.	-
scale	Number	Scale to apply to resulting view image.	[OPTIONAL] [EXPERIMENTAL]
screenWidth	Integer	Overriding screen width value in pixels (minimum 0, maximum 10000000).	[OPTIONAL] [EXPERIMENTAL]
screenHeight	Integer	Overriding screen height value in pixels (minimum 0, maximum 10000000).	[OPTIONAL] [EXPERIMENTAL]
positionX	Integer	Overriding view X position on screen in pixels (minimum 0, maximum 10000000).	[OPTIONAL] [EXPERIMENTAL]
positionY	Integer	Overriding view Y position on screen in pixels (minimum 0, maximum 10000000).	[OPTIONAL] [EXPERIMENTAL]
dontSetVisibleSize	Boolean	Do not set visible view size, rely upon explicit setVisibleSize call.	[OPTIONAL] [EXPERIMENTAL]
screenOrientation	$REF: ScreenOrientation	Screen orientation override.	[OPTIONAL]
viewport	$REF: Page.Viewport	If set, the visible area of the page will be overridden to this viewport. This viewport change is not observed by the page, e.g. viewport-relative elements do not change positions.	[OPTIONAL] [EXPERIMENTAL]
displayFeature	$REF: DisplayFeature	If set, the display feature of a multi-segment screen. If not set, multi-segment support is turned-off.	[OPTIONAL] [EXPERIMENTAL]

setScrollbarsHidden

-

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
hidden	Boolean	Whether scrollbars should be always hidden.	-

setDocumentCookieDisabled

-

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
disabled	Boolean	Whether document.coookie API should be disabled.	-

setEmitTouchEventsForMouse

-

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
enabled	Boolean	Whether touch emulation based on mouse input should be enabled.	-
configuration	"mobile", "desktop"String [Hover] Enum	Touch/gesture events configuration. Default: current platform.	[OPTIONAL]

setEmulatedMedia

Emulates the given media type or media feature for CSS media queries.

-

PARAMETERS:

Name	Type	Description	Flags
media	String	Media type to emulate. Empty string disables the override.	[OPTIONAL]
features	Array (of) $REF: MediaFeature	Media features to emulate.	[OPTIONAL]

setEmulatedVisionDeficiency

Emulates the given vision deficiency.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
type	"none", "achromatopsia", "blurredVision", "deuteranopia", "protanopia", "tritanopia"String [Hover] Enum	Vision deficiency to emulate.	-

setGeolocationOverride

Overrides the Geolocation Position or Error. Omitting any of the parameters emulates position unavailable.

-

PARAMETERS:

Name	Type	Description	Flags
latitude	Number	Mock latitude	[OPTIONAL]
longitude	Number	Mock longitude	[OPTIONAL]
accuracy	Number	Mock accuracy	[OPTIONAL]

setIdleOverride

Overrides the Idle state.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
isUserActive	Boolean	Mock isUserActive	-
isScreenUnlocked	Boolean	Mock isScreenUnlocked	-

clearIdleOverride

Clears Idle state overrides.

[EXPERIMENTAL]

setNavigatorOverrides

Overrides value returned by the javascript navigator object.

[EXPERIMENTAL]
[DEPRECATED]

PARAMETERS:

Name	Type	Description	Flags
platform	String	The platform navigator.platform should return.	-

setPageScaleFactor

Sets a specified page scale factor.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
pageScaleFactor	Number	Page scale factor.	-

setScriptExecutionDisabled

Switches script execution in the page.

-

PARAMETERS:

Name	Type	Description	Flags
value	Boolean	Whether script execution should be disabled in the page.	-

setTouchEmulationEnabled

Enables touch on platforms which do not support them.

-

PARAMETERS:

Name	Type	Description	Flags
enabled	Boolean	Whether the touch event emulation should be enabled.	-
maxTouchPoints	Integer	Maximum touch points supported. Defaults to one.	[OPTIONAL]

setVirtualTimePolicy

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.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
policy	$REF: VirtualTimePolicy	-	-
budget	Number	If set, after this many virtual milliseconds have elapsed virtual time will be paused and a virtualTimeBudgetExpired event is sent.	[OPTIONAL]
maxVirtualTimeTaskStarvationCount	Integer	If set this specifies the maximum number of tasks that can be run before virtual is forced forwards to prevent deadlock.	[OPTIONAL]
waitForNavigation	Boolean	If set the virtual time policy change should be deferred until any frame starts navigating. Note any previous deferred policy change is superseded.	[OPTIONAL]
initialVirtualTime	$REF: Network.TimeSinceEpoch	If set, base::Time::Now will be overridden to initially return this value.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
virtualTimeTicksBase	Number	Absolute timestamp at which virtual time was first enabled (up time in milliseconds).	-

setLocaleOverride

Overrides default host system locale with the specified one.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
locale	String	ICU style C locale (e.g. "en_US"). If not specified or empty, disables the override and restores default host system locale.	[OPTIONAL]

setTimezoneOverride

Overrides default host system timezone with the specified one.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
timezoneId	String	The timezone identifier. If empty, disables the override and restores default host system timezone.	-

setVisibleSize

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]
[DEPRECATED]

PARAMETERS:

Name	Type	Description	Flags
width	Integer	Frame width (DIP).	-
height	Integer	Frame height (DIP).	-

setDisabledImageTypes

-

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
imageTypes	Array (of) $REF: DisabledImageType	Image types to disable.	-

setUserAgentOverride

Allows overriding user agent with the given string.

-

PARAMETERS:

Name	Type	Description	Flags
userAgent	String	User agent to use.	-
acceptLanguage	String	Browser langugage to emulate.	[OPTIONAL]
platform	String	The platform navigator.platform should return.	[OPTIONAL]
userAgentMetadata	$REF: UserAgentMetadata	To be sent in Sec-CH-UA-* headers and returned in navigator.userAgentData	[OPTIONAL] [EXPERIMENTAL]

HeadlessExperimental

[Experimental]

This domain provides experimental commands only supported in headless mode.

Dependencies: Page, Runtime

commands

Name

Description

Flags

beginFrame

Sends a BeginFrame to the target and returns when the frame was completed. Optionally captures a screenshot from the resulting frame. Requires that the target was created with enabled BeginFrameControl. Designed for use with --run-all-compositor-stages-before-draw, see also https://goo.gl/3zHXhB for more background.

-

PARAMETERS:

Name	Type	Description	Flags
frameTimeTicks	Number	Timestamp of this BeginFrame in Renderer TimeTicks (milliseconds of uptime). If not set, the current time will be used.	[OPTIONAL]
interval	Number	The interval between BeginFrames that is reported to the compositor, in milliseconds. Defaults to a 60 frames/second interval, i.e. about 16.666 milliseconds.	[OPTIONAL]
noDisplayUpdates	Boolean	Whether updates should not be committed and drawn onto the display. False by default. If true, only side effects of the BeginFrame will be run, such as layout and animations, but any visual updates may not be visible on the display or in screenshots.	[OPTIONAL]
screenshot	$REF: ScreenshotParams	If set, a screenshot of the frame will be captured and returned in the response. Otherwise, no screenshot will be captured. Note that capturing a screenshot can fail, for example, during renderer initialization. In such a case, no screenshot data will be returned.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
hasDamage	Boolean	Whether the BeginFrame resulted in damage and, thus, a new frame was committed to the display. Reported for diagnostic uses, may be removed in the future.	-
screenshotData	String	Base64-encoded image data of the screenshot, if one was requested and successfully taken. (Encoded as a base64 string when passed over JSON)	[OPTIONAL]

disable

Disables headless events for the target.

-

enable

Enables headless events for the target.

-

IO

Input/Output operations for streams produced by DevTools.

commands

Name

Description

Flags

close

Close the stream, discard any temporary backing storage.

-

PARAMETERS:

Name	Type	Description	Flags
handle	$REF: StreamHandle	Handle of the stream to close.	-

read

Read a chunk of the stream

-

PARAMETERS:

Name	Type	Description	Flags
handle	$REF: StreamHandle	Handle of the stream to read.	-
offset	Integer	Seek to the specified offset before reading (if not specificed, proceed with offset following the last read). Some types of streams may only support sequential reads.	[OPTIONAL]
size	Integer	Maximum number of bytes to read (left upon the agent discretion if not specified).	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
base64Encoded	Boolean	Set if the data is base64-encoded	[OPTIONAL]
data	String	Data that were read.	-
eof	Boolean	Set if the end-of-file condition occurred while reading.	-

resolveBlob

Return UUID of Blob object specified by a remote object id.

-

PARAMETERS:

Name	Type	Description	Flags
objectId	$REF: Runtime.RemoteObjectId	Object id of a Blob object wrapper.	-

RETURNS:

Name	Type	Description	Flags
uuid	String	UUID of the specified Blob.	-

IndexedDB

[Experimental]

-

Dependencies: Runtime

types

Type ID

Type

Description

Flags

DatabaseWithObjectStores

Object

Database with an array of object stores.

-

PROPERTIES:

Name	Type	Description	Flags
name	String	Database name.	-
version	Number	Database version (type is not 'integer', as the standard requires the version number to be 'unsigned long long')	-
objectStores	Array (of) $REF: ObjectStore	Object stores in this database.	-

ObjectStore

Object

Object store.

-

PROPERTIES:

Name	Type	Description	Flags
name	String	Object store name.	-
keyPath	$REF: KeyPath	Object store key path.	-
autoIncrement	Boolean	If true, object store has auto increment flag set.	-
indexes	Array (of) $REF: ObjectStoreIndex	Indexes in this object store.	-

ObjectStoreIndex

Object

Object store index.

-

PROPERTIES:

Name	Type	Description	Flags
name	String	Index name.	-
keyPath	$REF: KeyPath	Index key path.	-
unique	Boolean	If true, index is unique.	-
multiEntry	Boolean	If true, index allows multiple entries for a key.	-

Key

Object

Key.

-

PROPERTIES:

Name	Type	Description	Flags
type	"number", "string", "date", "array"String [Hover] Enum	Key type.	-
number	Number	Number value.	[OPTIONAL]
string	String	String value.	[OPTIONAL]
date	Number	Date value.	[OPTIONAL]
array	Array (of) $REF: Key	Array value.	[OPTIONAL]

KeyRange

Object

Key range.

-

PROPERTIES:

Name	Type	Description	Flags
lower	$REF: Key	Lower bound.	[OPTIONAL]
upper	$REF: Key	Upper bound.	[OPTIONAL]
lowerOpen	Boolean	If true lower bound is open.	-
upperOpen	Boolean	If true upper bound is open.	-

DataEntry

Object

Data entry.

-

PROPERTIES:

Name	Type	Description	Flags
key	$REF: Runtime.RemoteObject	Key object.	-
primaryKey	$REF: Runtime.RemoteObject	Primary key object.	-
value	$REF: Runtime.RemoteObject	Value object.	-

KeyPath

Object

Key path.

-

PROPERTIES:

Name	Type	Description	Flags
type	"null", "string", "array"String [Hover] Enum	Key path type.	-
string	String	String value.	[OPTIONAL]
array	Array (of) String	Array value.	[OPTIONAL]

commands

Name

Description

Flags

clearObjectStore

Clears all entries from an object store.

-

PARAMETERS:

Name	Type	Description	Flags
securityOrigin	String	Security origin.	-
databaseName	String	Database name.	-
objectStoreName	String	Object store name.	-

deleteDatabase

Deletes a database.

-

PARAMETERS:

Name	Type	Description	Flags
securityOrigin	String	Security origin.	-
databaseName	String	Database name.	-

deleteObjectStoreEntries

Delete a range of entries from an object store

-

PARAMETERS:

Name	Type	Description	Flags
securityOrigin	String	-	-
databaseName	String	-	-
objectStoreName	String	-	-
keyRange	$REF: KeyRange	Range of entry keys to delete	-

disable

Disables events from backend.

-

enable

Enables events from backend.

-

requestData

Requests data from object store or index.

-

PARAMETERS:

Name	Type	Description	Flags
securityOrigin	String	Security origin.	-
databaseName	String	Database name.	-
objectStoreName	String	Object store name.	-
indexName	String	Index name, empty string for object store data requests.	-
skipCount	Integer	Number of records to skip.	-
pageSize	Integer	Number of records to fetch.	-
keyRange	$REF: KeyRange	Key range.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
objectStoreDataEntries	Array (of) $REF: DataEntry	Array of object store data entries.	-
hasMore	Boolean	If true, there are more entries to fetch in the given range.	-

getMetadata

Gets metadata of an object store

-

PARAMETERS:

Name	Type	Description	Flags
securityOrigin	String	Security origin.	-
databaseName	String	Database name.	-
objectStoreName	String	Object store name.	-

RETURNS:

Name	Type	Description	Flags
entriesCount	Number	the entries count	-
keyGeneratorValue	Number	the current value of key generator, to become the next inserted key into the object store. Valid if objectStore.autoIncrement is true.	-

requestDatabase

Requests database with given name in given frame.

-

PARAMETERS:

Name	Type	Description	Flags
securityOrigin	String	Security origin.	-
databaseName	String	Database name.	-

RETURNS:

Name	Type	Description	Flags
databaseWithObjectStores	$REF: DatabaseWithObjectStores	Database with an array of object stores.	-

requestDatabaseNames

Requests database names for given security origin.

-

PARAMETERS:

Name	Type	Description	Flags
securityOrigin	String	Security origin.	-

RETURNS:

Name	Type	Description	Flags
databaseNames	Array (of) String	Database names for origin.	-

Input

-

types

Type ID

Type

Description

Flags

TouchPoint

Object

-

PROPERTIES:

Name	Type	Description	Flags
x	Number	X coordinate of the event relative to the main frame's viewport in CSS pixels.	-
y	Number	Y coordinate of the event relative to the main frame's viewport in CSS pixels. 0 refers to the top of the viewport and Y increases as it proceeds towards the bottom of the viewport.	-
radiusX	Number	X radius of the touch area (default: 1.0).	[OPTIONAL]
radiusY	Number	Y radius of the touch area (default: 1.0).	[OPTIONAL]
rotationAngle	Number	Rotation angle (default: 0.0).	[OPTIONAL]
force	Number	Force (default: 1.0).	[OPTIONAL]
tangentialPressure	Number	The normalized tangential pressure, which has a range of [-1,1] (default: 0).	[OPTIONAL] [EXPERIMENTAL]
tiltX	Integer	The plane angle between the Y-Z plane and the plane containing both the stylus axis and the Y axis, in degrees of the range [-90,90], a positive tiltX is to the right (default: 0)	[OPTIONAL] [EXPERIMENTAL]
tiltY	Integer	The plane angle between the X-Z plane and the plane containing both the stylus axis and the X axis, in degrees of the range [-90,90], a positive tiltY is towards the user (default: 0).	[OPTIONAL] [EXPERIMENTAL]
twist	Integer	The clockwise rotation of a pen stylus around its own major axis, in degrees in the range [0,359] (default: 0).	[OPTIONAL] [EXPERIMENTAL]
id	Number	Identifier used to track touch sources between events, must be unique within an event.	[OPTIONAL]

GestureSourceType

-

[EXPERIMENTAL]

MouseButton

-

TimeSinceEpoch

Number

UTC time in seconds, counted from January 1, 1970.

-

DragDataItem

Object

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
mimeType	String	Mime type of the dragged data.	-
data	String	Depending of the value of `mimeType`, it contains the dragged link, text, HTML markup or any other data.	-
title	String	Title associated with a link. Only valid when `mimeType` == "text/uri-list".	[OPTIONAL]
baseURL	String	Stores the base URL for the contained markup. Only valid when `mimeType` == "text/html".	[OPTIONAL]

DragData

Object

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
items	Array (of) $REF: DragDataItem	-	-
files	Array (of) String	List of filenames that should be included when dropping	[OPTIONAL]
dragOperationsMask	Integer	Bit field representing allowed drag operations. Copy = 1, Link = 2, Move = 16	-

commands

Name

Description

Flags

dispatchDragEvent

Dispatches a drag event into the page.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
type	"dragEnter", "dragOver", "drop", "dragCancel"String [Hover] Enum	Type of the drag event.	-
x	Number	X coordinate of the event relative to the main frame's viewport in CSS pixels.	-
y	Number	Y coordinate of the event relative to the main frame's viewport in CSS pixels. 0 refers to the top of the viewport and Y increases as it proceeds towards the bottom of the viewport.	-
data	$REF: DragData	-	-
modifiers	Integer	Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8 (default: 0).	[OPTIONAL]

dispatchKeyEvent

Dispatches a key event to the page.

-

PARAMETERS:

Name	Type	Description	Flags
type	"keyDown", "keyUp", "rawKeyDown", "char"String [Hover] Enum	Type of the key event.	-
modifiers	Integer	Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8 (default: 0).	[OPTIONAL]
timestamp	$REF: TimeSinceEpoch	Time at which the event occurred.	[OPTIONAL]
text	String	Text as generated by processing a virtual key code with a keyboard layout. Not needed for for `keyUp` and `rawKeyDown` events (default: "")	[OPTIONAL]
unmodifiedText	String	Text that would have been generated by the keyboard if no modifiers were pressed (except for shift). Useful for shortcut (accelerator) key handling (default: "").	[OPTIONAL]
keyIdentifier	String	Unique key identifier (e.g., 'U+0041') (default: "").	[OPTIONAL]
code	String	Unique DOM defined string value for each physical key (e.g., 'KeyA') (default: "").	[OPTIONAL]
key	String	Unique DOM defined string value describing the meaning of the key in the context of active modifiers, keyboard layout, etc (e.g., 'AltGr') (default: "").	[OPTIONAL]
windowsVirtualKeyCode	Integer	Windows virtual key code (default: 0).	[OPTIONAL]
nativeVirtualKeyCode	Integer	Native virtual key code (default: 0).	[OPTIONAL]
autoRepeat	Boolean	Whether the event was generated from auto repeat (default: false).	[OPTIONAL]
isKeypad	Boolean	Whether the event was generated from the keypad (default: false).	[OPTIONAL]
isSystemKey	Boolean	Whether the event was a system key event (default: false).	[OPTIONAL]
location	Integer	Whether the event was from the left or right side of the keyboard. 1=Left, 2=Right (default: 0).	[OPTIONAL]
commands	Array (of) String	Editing commands to send with the key event (e.g., 'selectAll') (default: []). These are related to but not equal the command names used in `document.execCommand` and NSStandardKeyBindingResponding. See https://source.chromium.org/chromium/chromium/src/+/master:third_party/blink/renderer/core/editing/commands/editor_command_names.h for valid command names.	[OPTIONAL] [EXPERIMENTAL]

insertText

This method emulates inserting text that doesn't come from a key press, for example an emoji keyboard or an IME.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
text	String	The text to insert.	-

imeSetComposition

This method sets the current candidate text for ime. Use imeCommitComposition to commit the final text. Use imeSetComposition with empty string as text to cancel composition.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
text	String	The text to insert	-
selectionStart	Integer	selection start	-
selectionEnd	Integer	selection end	-
replacementStart	Integer	replacement start	[OPTIONAL]
replacementEnd	Integer	replacement end	[OPTIONAL]

dispatchMouseEvent

Dispatches a mouse event to the page.

-

PARAMETERS:

Name	Type	Description	Flags
type	"mousePressed", "mouseReleased", "mouseMoved", "mouseWheel"String [Hover] Enum	Type of the mouse event.	-
x	Number	X coordinate of the event relative to the main frame's viewport in CSS pixels.	-
y	Number	Y coordinate of the event relative to the main frame's viewport in CSS pixels. 0 refers to the top of the viewport and Y increases as it proceeds towards the bottom of the viewport.	-
modifiers	Integer	Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8 (default: 0).	[OPTIONAL]
timestamp	$REF: TimeSinceEpoch	Time at which the event occurred.	[OPTIONAL]
button	$REF: MouseButton	Mouse button (default: "none").	[OPTIONAL]
buttons	Integer	A number indicating which buttons are pressed on the mouse when a mouse event is triggered. Left=1, Right=2, Middle=4, Back=8, Forward=16, None=0.	[OPTIONAL]
clickCount	Integer	Number of times the mouse button was clicked (default: 0).	[OPTIONAL]
force	Number	The normalized pressure, which has a range of [0,1] (default: 0).	[OPTIONAL] [EXPERIMENTAL]
tangentialPressure	Number	The normalized tangential pressure, which has a range of [-1,1] (default: 0).	[OPTIONAL] [EXPERIMENTAL]
tiltX	Integer	The plane angle between the Y-Z plane and the plane containing both the stylus axis and the Y axis, in degrees of the range [-90,90], a positive tiltX is to the right (default: 0).	[OPTIONAL] [EXPERIMENTAL]
tiltY	Integer	The plane angle between the X-Z plane and the plane containing both the stylus axis and the X axis, in degrees of the range [-90,90], a positive tiltY is towards the user (default: 0).	[OPTIONAL] [EXPERIMENTAL]
twist	Integer	The clockwise rotation of a pen stylus around its own major axis, in degrees in the range [0,359] (default: 0).	[OPTIONAL] [EXPERIMENTAL]
deltaX	Number	X delta in CSS pixels for mouse wheel event (default: 0).	[OPTIONAL]
deltaY	Number	Y delta in CSS pixels for mouse wheel event (default: 0).	[OPTIONAL]
pointerType	"mouse", "pen"String [Hover] Enum	Pointer type (default: "mouse").	[OPTIONAL]

dispatchTouchEvent

Dispatches a touch event to the page.

-

PARAMETERS:

Name	Type	Description	Flags
type	"touchStart", "touchEnd", "touchMove", "touchCancel"String [Hover] Enum	Type of the touch event. TouchEnd and TouchCancel must not contain any touch points, while TouchStart and TouchMove must contains at least one.	-
touchPoints	Array (of) $REF: TouchPoint	Active touch points on the touch device. One event per any changed point (compared to previous touch event in a sequence) is generated, emulating pressing/moving/releasing points one by one.	-
modifiers	Integer	Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8 (default: 0).	[OPTIONAL]
timestamp	$REF: TimeSinceEpoch	Time at which the event occurred.	[OPTIONAL]

emulateTouchFromMouseEvent

Emulates touch event from the mouse event parameters.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
type	"mousePressed", "mouseReleased", "mouseMoved", "mouseWheel"String [Hover] Enum	Type of the mouse event.	-
x	Integer	X coordinate of the mouse pointer in DIP.	-
y	Integer	Y coordinate of the mouse pointer in DIP.	-
button	$REF: MouseButton	Mouse button. Only "none", "left", "right" are supported.	-
timestamp	$REF: TimeSinceEpoch	Time at which the event occurred (default: current time).	[OPTIONAL]
deltaX	Number	X delta in DIP for mouse wheel event (default: 0).	[OPTIONAL]
deltaY	Number	Y delta in DIP for mouse wheel event (default: 0).	[OPTIONAL]
modifiers	Integer	Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8 (default: 0).	[OPTIONAL]
clickCount	Integer	Number of times the mouse button was clicked (default: 0).	[OPTIONAL]

setIgnoreInputEvents

Ignores input events (useful while auditing page).

-

PARAMETERS:

Name	Type	Description	Flags
ignore	Boolean	Ignores input events processing when set to true.	-

setInterceptDrags

Prevents default drag and drop behavior and instead emits `Input.dragIntercepted` events. Drag and drop behavior can be directly controlled via `Input.dispatchDragEvent`.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
enabled	Boolean	-	-

synthesizePinchGesture

Synthesizes a pinch gesture over a time period by issuing appropriate touch events.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
x	Number	X coordinate of the start of the gesture in CSS pixels.	-
y	Number	Y coordinate of the start of the gesture in CSS pixels.	-
scaleFactor	Number	Relative scale factor after zooming (>1.0 zooms in, <1.0 zooms out).	-
relativeSpeed	Integer	Relative pointer speed in pixels per second (default: 800).	[OPTIONAL]
gestureSourceType	$REF: GestureSourceType	Which type of input events to be generated (default: 'default', which queries the platform for the preferred input type).	[OPTIONAL]

synthesizeScrollGesture

Synthesizes a scroll gesture over a time period by issuing appropriate touch events.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
x	Number	X coordinate of the start of the gesture in CSS pixels.	-
y	Number	Y coordinate of the start of the gesture in CSS pixels.	-
xDistance	Number	The distance to scroll along the X axis (positive to scroll left).	[OPTIONAL]
yDistance	Number	The distance to scroll along the Y axis (positive to scroll up).	[OPTIONAL]
xOverscroll	Number	The number of additional pixels to scroll back along the X axis, in addition to the given distance.	[OPTIONAL]
yOverscroll	Number	The number of additional pixels to scroll back along the Y axis, in addition to the given distance.	[OPTIONAL]
preventFling	Boolean	Prevent fling (default: true).	[OPTIONAL]
speed	Integer	Swipe speed in pixels per second (default: 800).	[OPTIONAL]
gestureSourceType	$REF: GestureSourceType	Which type of input events to be generated (default: 'default', which queries the platform for the preferred input type).	[OPTIONAL]
repeatCount	Integer	The number of times to repeat the gesture (default: 0).	[OPTIONAL]
repeatDelayMs	Integer	The number of milliseconds delay between each repeat. (default: 250).	[OPTIONAL]
interactionMarkerName	String	The name of the interaction markers to generate, if not empty (default: "").	[OPTIONAL]

synthesizeTapGesture

Synthesizes a tap gesture over a time period by issuing appropriate touch events.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
x	Number	X coordinate of the start of the gesture in CSS pixels.	-
y	Number	Y coordinate of the start of the gesture in CSS pixels.	-
duration	Integer	Duration between touchdown and touchup events in ms (default: 50).	[OPTIONAL]
tapCount	Integer	Number of times to perform the tap (e.g. 2 for double tap, default: 1).	[OPTIONAL]
gestureSourceType	$REF: GestureSourceType	Which type of input events to be generated (default: 'default', which queries the platform for the preferred input type).	[OPTIONAL]

Inspector

[Experimental]

-

LayerTree

[Experimental]

-

Dependencies: DOM

types

Type ID

Type

Description

Flags

LayerId

String

Unique Layer identifier.

-

SnapshotId

String

Unique snapshot identifier.

-

ScrollRect

Object

Rectangle where scrolling happens on the main thread.

-

PROPERTIES:

Name	Type	Description	Flags
rect	$REF: DOM.Rect	Rectangle itself.	-
type	"RepaintsOnScroll", "TouchEventHandler", "WheelEventHandler"String [Hover] Enum	Reason for rectangle to force scrolling on the main thread	-

StickyPositionConstraint

Object

Sticky position constraints.

-

PROPERTIES:

Name	Type	Description	Flags
stickyBoxRect	$REF: DOM.Rect	Layout rectangle of the sticky element before being shifted	-
containingBlockRect	$REF: DOM.Rect	Layout rectangle of the containing block of the sticky element	-
nearestLayerShiftingStickyBox	$REF: LayerId	The nearest sticky layer that shifts the sticky box	[OPTIONAL]
nearestLayerShiftingContainingBlock	$REF: LayerId	The nearest sticky layer that shifts the containing block	[OPTIONAL]

PictureTile

Object

Serialized fragment of layer picture along with its offset within the layer.

-

PROPERTIES:

Name	Type	Description	Flags
x	Number	Offset from owning layer left boundary	-
y	Number	Offset from owning layer top boundary	-
picture	String	Base64-encoded snapshot data. (Encoded as a base64 string when passed over JSON)	-

Layer

Object

Information about a compositing layer.

-

PROPERTIES:

Name	Type	Description	Flags
layerId	$REF: LayerId	The unique id for this layer.	-
parentLayerId	$REF: LayerId	The id of parent (not present for root).	[OPTIONAL]
backendNodeId	$REF: DOM.BackendNodeId	The backend id for the node associated with this layer.	[OPTIONAL]
offsetX	Number	Offset from parent layer, X coordinate.	-
offsetY	Number	Offset from parent layer, Y coordinate.	-
width	Number	Layer width.	-
height	Number	Layer height.	-
transform	Array (of) Number	Transformation matrix for layer, default is identity matrix	[OPTIONAL]
anchorX	Number	Transform anchor point X, absent if no transform specified	[OPTIONAL]
anchorY	Number	Transform anchor point Y, absent if no transform specified	[OPTIONAL]
anchorZ	Number	Transform anchor point Z, absent if no transform specified	[OPTIONAL]
paintCount	Integer	Indicates how many time this layer has painted.	-
drawsContent	Boolean	Indicates whether this layer hosts any content, rather than being used for transform/scrolling purposes only.	-
invisible	Boolean	Set if layer is not visible.	[OPTIONAL]
scrollRects	Array (of) $REF: ScrollRect	Rectangles scrolling on main thread only.	[OPTIONAL]
stickyPositionConstraint	$REF: StickyPositionConstraint	Sticky position constraint information	[OPTIONAL]

PaintProfile

Array (of)
Number

Array of timings, one per paint step.

-

commands

Name

Description

Flags

compositingReasons

Provides the reasons why the given layer was composited.

-

PARAMETERS:

Name	Type	Description	Flags
layerId	$REF: LayerId	The id of the layer for which we want to get the reasons it was composited.	-

RETURNS:

Name	Type	Description	Flags
compositingReasons	Array (of) String	A list of strings specifying reasons for the given layer to become composited.	[DEPRECATED]
compositingReasonIds	Array (of) String	A list of strings specifying reason IDs for the given layer to become composited.	-

disable

Disables compositing tree inspection.

-

enable

Enables compositing tree inspection.

-

loadSnapshot

Returns the snapshot identifier.

-

PARAMETERS:

Name	Type	Description	Flags
tiles	Array (of) $REF: PictureTile	An array of tiles composing the snapshot.	-

RETURNS:

Name	Type	Description	Flags
snapshotId	$REF: SnapshotId	The id of the snapshot.	-

makeSnapshot

Returns the layer snapshot identifier.

-

PARAMETERS:

Name	Type	Description	Flags
layerId	$REF: LayerId	The id of the layer.	-

RETURNS:

Name	Type	Description	Flags
snapshotId	$REF: SnapshotId	The id of the layer snapshot.	-

profileSnapshot

-

PARAMETERS:

Name	Type	Description	Flags
snapshotId	$REF: SnapshotId	The id of the layer snapshot.	-
minRepeatCount	Integer	The maximum number of times to replay the snapshot (1, if not specified).	[OPTIONAL]
minDuration	Number	The minimum duration (in seconds) to replay the snapshot.	[OPTIONAL]
clipRect	$REF: DOM.Rect	The clip rectangle to apply when replaying the snapshot.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
timings	Array (of) $REF: PaintProfile	The array of paint profiles, one per run.	-

releaseSnapshot

Releases layer snapshot captured by the back-end.

-

PARAMETERS:

Name	Type	Description	Flags
snapshotId	$REF: SnapshotId	The id of the layer snapshot.	-

replaySnapshot

Replays the layer snapshot and returns the resulting bitmap.

-

PARAMETERS:

Name	Type	Description	Flags
snapshotId	$REF: SnapshotId	The id of the layer snapshot.	-
fromStep	Integer	The first step to replay from (replay from the very start if not specified).	[OPTIONAL]
toStep	Integer	The last step to replay to (replay till the end if not specified).	[OPTIONAL]
scale	Number	The scale to apply while replaying (defaults to 1).	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
dataURL	String	A data: URL for resulting image.	-

snapshotCommandLog

Replays the layer snapshot and returns canvas log.

-

PARAMETERS:

Name	Type	Description	Flags
snapshotId	$REF: SnapshotId	The id of the layer snapshot.	-

RETURNS:

Name	Type	Description	Flags
commandLog	Array (of) Object	The array of canvas function calls.	-

Log

Provides access to log entries.

Dependencies: Runtime, Network

types

Type ID

Type

Description

Flags

LogEntry

Object

Log entry.

-

PROPERTIES:

Name	Type	Description	Flags
source	"xml", "javascript", "network", "storage", "appcache", "rendering", "security", "deprecation", "worker", "violation", "intervention", "recommendation", "other"String [Hover] Enum	Log entry source.	-
level	"verbose", "info", "warning", "error"String [Hover] Enum	Log entry severity.	-
text	String	Logged text.	-
category	"cors"String [Hover] Enum	-	[OPTIONAL]
timestamp	$REF: Runtime.Timestamp	Timestamp when this entry was added.	-
url	String	URL of the resource if known.	[OPTIONAL]
lineNumber	Integer	Line number in the resource.	[OPTIONAL]
stackTrace	$REF: Runtime.StackTrace	JavaScript stack trace.	[OPTIONAL]
networkRequestId	$REF: Network.RequestId	Identifier of the network request associated with this entry.	[OPTIONAL]
workerId	String	Identifier of the worker associated with this entry.	[OPTIONAL]
args	Array (of) $REF: Runtime.RemoteObject	Call arguments.	[OPTIONAL]

ViolationSetting

Object

Violation configuration setting.

-

PROPERTIES:

Name	Type	Description	Flags
name	"longTask", "longLayout", "blockedEvent", "blockedParser", "discouragedAPIUse", "handler", "recurringHandler"String [Hover] Enum	Violation type.	-
threshold	Number	Time threshold to trigger upon.	-

Memory

[Experimental]

-

types

Type ID

Type

Description

Flags

PressureLevel

Memory pressure level.

-

SamplingProfileNode

Object

Heap profile sample.

-

PROPERTIES:

Name	Type	Description	Flags
size	Number	Size of the sampled allocation.	-
total	Number	Total bytes attributed to this sample.	-
stack	Array (of) String	Execution stack at the point of allocation.	-

SamplingProfile

Object

Array of heap profile samples.

-

PROPERTIES:

Name	Type	Description	Flags
samples	Array (of) $REF: SamplingProfileNode	-	-
modules	Array (of) $REF: Module	-	-

Module

Object

Executable module information

-

PROPERTIES:

Name	Type	Description	Flags
name	String	Name of the module.	-
uuid	String	UUID of the module.	-
baseAddress	String	Base address where the module is loaded into memory. Encoded as a decimal or hexadecimal (0x prefixed) string.	-
size	Number	Size of the module in bytes.	-

commands

Name

Description

Flags

getDOMCounters

-

RETURNS:

Name	Type	Description	Flags
documents	Integer	-	-
nodes	Integer	-	-
jsEventListeners	Integer	-	-

prepareForLeakDetection

-

forciblyPurgeJavaScriptMemory

Simulate OomIntervention by purging V8 memory.

-

setPressureNotificationsSuppressed

Enable/disable suppressing memory pressure notifications in all processes.

-

PARAMETERS:

Name	Type	Description	Flags
suppressed	Boolean	If true, memory pressure notifications will be suppressed.	-

simulatePressureNotification

Simulate a memory pressure notification in all processes.

-

PARAMETERS:

Name	Type	Description	Flags
level	$REF: PressureLevel	Memory pressure level of the notification.	-

startSampling

Start collecting native memory profile.

-

PARAMETERS:

Name	Type	Description	Flags
samplingInterval	Integer	Average number of bytes between samples.	[OPTIONAL]
suppressRandomness	Boolean	Do not randomize intervals between samples.	[OPTIONAL]

stopSampling

Stop collecting native memory profile.

-

getAllTimeSamplingProfile

Retrieve native memory allocations profile collected since renderer process startup.

-

RETURNS:

Name	Type	Description	Flags
profile	$REF: SamplingProfile	-	-

getBrowserSamplingProfile

Retrieve native memory allocations profile collected since browser process startup.

-

RETURNS:

Name	Type	Description	Flags
profile	$REF: SamplingProfile	-	-

getSamplingProfile

Retrieve native memory allocations profile collected since last `startSampling` call.

-

RETURNS:

Name	Type	Description	Flags
profile	$REF: SamplingProfile	-	-

Network

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: Debugger, Runtime, Security

types

Type ID

Type

Description

Flags

ResourceType

Resource type as it was perceived by the rendering engine.

-

LoaderId

String

Unique loader identifier.

-

RequestId

String

Unique request identifier.

-

InterceptionId

String

Unique intercepted request identifier.

-

ErrorReason

Network level fetch failure reason.

-

TimeSinceEpoch

Number

UTC time in seconds, counted from January 1, 1970.

-

MonotonicTime

Number

Monotonically increasing time in seconds since an arbitrary point in the past.

-

Headers

Object

Request / response headers as keys / values of JSON object.

-

WARNING, NO PROPERTIES DEFINED

ConnectionType

The underlying connection technology that the browser is supposedly using.

-

CookieSameSite

Represents the cookie's 'SameSite' status: https://tools.ietf.org/html/draft-west-first-party-cookies

-

CookiePriority

Represents the cookie's 'Priority' status: https://tools.ietf.org/html/draft-west-cookie-priority-00

[EXPERIMENTAL]

CookieSourceScheme

Represents the source scheme of the origin that originally set the cookie. A value of "Unset" allows protocol clients to emulate legacy cookie scope for the scheme. This is a temporary ability and it will be removed in the future.

[EXPERIMENTAL]

ResourceTiming

Object

Timing information for the request.

-

PROPERTIES:

Name	Type	Description	Flags
requestTime	Number	Timing's requestTime is a baseline in seconds, while the other numbers are ticks in milliseconds relatively to this requestTime.	-
proxyStart	Number	Started resolving proxy.	-
proxyEnd	Number	Finished resolving proxy.	-
dnsStart	Number	Started DNS address resolve.	-
dnsEnd	Number	Finished DNS address resolve.	-
connectStart	Number	Started connecting to the remote host.	-
connectEnd	Number	Connected to the remote host.	-
sslStart	Number	Started SSL handshake.	-
sslEnd	Number	Finished SSL handshake.	-
workerStart	Number	Started running ServiceWorker.	[EXPERIMENTAL]
workerReady	Number	Finished Starting ServiceWorker.	[EXPERIMENTAL]
workerFetchStart	Number	Started fetch event.	[EXPERIMENTAL]
workerRespondWithSettled	Number	Settled fetch event respondWith promise.	[EXPERIMENTAL]
sendStart	Number	Started sending request.	-
sendEnd	Number	Finished sending request.	-
pushStart	Number	Time the server started pushing request.	[EXPERIMENTAL]
pushEnd	Number	Time the server finished pushing request.	[EXPERIMENTAL]
receiveHeadersEnd	Number	Finished receiving response headers.	-

ResourcePriority

Loading priority of a resource request.

-

PostDataEntry

Object

Post data entry for HTTP request

-

PROPERTIES:

Name	Type	Description	Flags
bytes	String	-	[OPTIONAL]

Request

Object

HTTP request data.

-

PROPERTIES:

Name	Type	Description	Flags
url	String	Request URL (without fragment).	-
urlFragment	String	Fragment of the requested URL starting with hash, if present.	[OPTIONAL]
method	String	HTTP request method.	-
headers	$REF: Headers	HTTP request headers.	-
postData	String	HTTP POST request data.	[OPTIONAL]
hasPostData	Boolean	True when the request has POST data. Note that postData might still be omitted when this flag is true when the data is too long.	[OPTIONAL]
postDataEntries	Array (of) $REF: PostDataEntry	Request body elements. This will be converted from base64 to binary	[OPTIONAL] [EXPERIMENTAL]
mixedContentType	$REF: Security.MixedContentType	The mixed content type of the request.	[OPTIONAL]
initialPriority	$REF: ResourcePriority	Priority of the resource request at the time request is sent.	-
referrerPolicy	"unsafe-url", "no-referrer-when-downgrade", "no-referrer", "origin", "origin-when-cross-origin", "same-origin", "strict-origin", "strict-origin-when-cross-origin"String [Hover] Enum	The referrer policy of the request, as defined in https://www.w3.org/TR/referrer-policy/	-
isLinkPreload	Boolean	Whether is loaded via link preload.	[OPTIONAL]
trustTokenParams	$REF: TrustTokenParams	Set for requests when the TrustToken API is used. Contains the parameters passed by the developer (e.g. via "fetch") as understood by the backend.	[OPTIONAL] [EXPERIMENTAL]
isSameSite	Boolean	True if this resource request is considered to be the 'same site' as the request correspondinfg to the main frame.	[OPTIONAL] [EXPERIMENTAL]

SignedCertificateTimestamp

Object

Details of a signed certificate timestamp (SCT).

-

PROPERTIES:

Name	Type	Description	Flags
status	String	Validation status.	-
origin	String	Origin.	-
logDescription	String	Log name / description.	-
logId	String	Log ID.	-
timestamp	$REF: TimeSinceEpoch	Issuance date.	-
hashAlgorithm	String	Hash algorithm.	-
signatureAlgorithm	String	Signature algorithm.	-
signatureData	String	Signature data.	-

SecurityDetails

Object

Security details about a request.

-

PROPERTIES:

Name	Type	Description	Flags
protocol	String	Protocol name (e.g. "TLS 1.2" or "QUIC").	-
keyExchange	String	Key Exchange used by the connection, or the empty string if not applicable.	-
keyExchangeGroup	String	(EC)DH group used by the connection, if applicable.	[OPTIONAL]
cipher	String	Cipher name.	-
mac	String	TLS MAC. Note that AEAD ciphers do not have separate MACs.	[OPTIONAL]
certificateId	$REF: Security.CertificateId	Certificate ID value.	-
subjectName	String	Certificate subject name.	-
sanList	Array (of) String	Subject Alternative Name (SAN) DNS names and IP addresses.	-
issuer	String	Name of the issuing CA.	-
validFrom	$REF: TimeSinceEpoch	Certificate valid from date.	-
validTo	$REF: TimeSinceEpoch	Certificate valid to (expiration) date	-
signedCertificateTimestampList	Array (of) $REF: SignedCertificateTimestamp	List of signed certificate timestamps (SCTs).	-
certificateTransparencyCompliance	$REF: CertificateTransparencyCompliance	Whether the request complied with Certificate Transparency policy	-

CertificateTransparencyCompliance

Whether the request complied with Certificate Transparency policy.

-

BlockedReason

The reason why request was blocked.

-

CorsError

The reason why request was blocked.

-

CorsErrorStatus

Object

-

PROPERTIES:

Name	Type	Description	Flags
corsError	$REF: CorsError	-	-
failedParameter	String	-	-

ServiceWorkerResponseSource

Source of serviceworker response.

-

TrustTokenParams

Object

Determines what type of Trust Token operation is executed and depending on the type, some additional parameters. The values are specified in third_party/blink/renderer/core/fetch/trust_token.idl.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
type	$REF: TrustTokenOperationType	-	-
refreshPolicy	"UseCached", "Refresh"String [Hover] Enum	Only set for "token-redemption" type and determine whether to request a fresh SRR or use a still valid cached SRR.	-
issuers	Array (of) String	Origins of issuers from whom to request tokens or redemption records.	[OPTIONAL]

TrustTokenOperationType

-

[EXPERIMENTAL]

Response

Object

HTTP response data.

-

PROPERTIES:

Name	Type	Description	Flags
url	String	Response URL. This URL can be different from CachedResource.url in case of redirect.	-
status	Integer	HTTP response status code.	-
statusText	String	HTTP response status text.	-
headers	$REF: Headers	HTTP response headers.	-
headersText	String	HTTP response headers text. This has been replaced by the headers in Network.responseReceivedExtraInfo.	[OPTIONAL] [DEPRECATED]
mimeType	String	Resource mimeType as determined by the browser.	-
requestHeaders	$REF: Headers	Refined HTTP request headers that were actually transmitted over the network.	[OPTIONAL]
requestHeadersText	String	HTTP request headers text. This has been replaced by the headers in Network.requestWillBeSentExtraInfo.	[OPTIONAL] [DEPRECATED]
connectionReused	Boolean	Specifies whether physical connection was actually reused for this request.	-
connectionId	Number	Physical connection id that was actually used for this request.	-
remoteIPAddress	String	Remote IP address.	[OPTIONAL]
remotePort	Integer	Remote port.	[OPTIONAL]
fromDiskCache	Boolean	Specifies that the request was served from the disk cache.	[OPTIONAL]
fromServiceWorker	Boolean	Specifies that the request was served from the ServiceWorker.	[OPTIONAL]
fromPrefetchCache	Boolean	Specifies that the request was served from the prefetch cache.	[OPTIONAL]
encodedDataLength	Number	Total number of bytes received for this request so far.	-
timing	$REF: ResourceTiming	Timing information for the given request.	[OPTIONAL]
serviceWorkerResponseSource	$REF: ServiceWorkerResponseSource	Response source of response from ServiceWorker.	[OPTIONAL]
responseTime	$REF: TimeSinceEpoch	The time at which the returned response was generated.	[OPTIONAL]
cacheStorageCacheName	String	Cache Storage Cache Name.	[OPTIONAL]
protocol	String	Protocol used to fetch this request.	[OPTIONAL]
securityState	$REF: Security.SecurityState	Security state of the request resource.	-
securityDetails	$REF: SecurityDetails	Security details for the request.	[OPTIONAL]

WebSocketRequest

Object

WebSocket request data.

-

PROPERTIES:

Name	Type	Description	Flags
headers	$REF: Headers	HTTP request headers.	-

WebSocketResponse

Object

WebSocket response data.

-

PROPERTIES:

Name	Type	Description	Flags
status	Integer	HTTP response status code.	-
statusText	String	HTTP response status text.	-
headers	$REF: Headers	HTTP response headers.	-
headersText	String	HTTP response headers text.	[OPTIONAL]
requestHeaders	$REF: Headers	HTTP request headers.	[OPTIONAL]
requestHeadersText	String	HTTP request headers text.	[OPTIONAL]

WebSocketFrame

Object

WebSocket message data. This represents an entire WebSocket message, not just a fragmented frame as the name suggests.

-

PROPERTIES:

Name	Type	Description	Flags
opcode	Number	WebSocket message opcode.	-
mask	Boolean	WebSocket message mask.	-
payloadData	String	WebSocket message payload data. If the opcode is 1, this is a text message and payloadData is a UTF-8 string. If the opcode isn't 1, then payloadData is a base64 encoded string representing binary data.	-

CachedResource

Object

Information about the cached resource.

-

PROPERTIES:

Name	Type	Description	Flags
url	String	Resource URL. This is the url of the original network request.	-
type	$REF: ResourceType	Type of this resource.	-
response	$REF: Response	Cached response data.	[OPTIONAL]
bodySize	Number	Cached response body size.	-

Initiator

Object

Information about the request initiator.

-

PROPERTIES:

Name	Type	Description	Flags
type	"parser", "script", "preload", "SignedExchange", "preflight", "other"String [Hover] Enum	Type of this initiator.	-
stack	$REF: Runtime.StackTrace	Initiator JavaScript stack trace, set for Script only.	[OPTIONAL]
url	String	Initiator URL, set for Parser type or for Script type (when script is importing module) or for SignedExchange type.	[OPTIONAL]
lineNumber	Number	Initiator line number, set for Parser type or for Script type (when script is importing module) (0-based).	[OPTIONAL]
columnNumber	Number	Initiator column number, set for Parser type or for Script type (when script is importing module) (0-based).	[OPTIONAL]
requestId	$REF: RequestId	Set if another request triggered this request (e.g. preflight).	[OPTIONAL]

PROPERTIES:

Name	Type	Description	Flags
name	String	Cookie name.	-
value	String	Cookie value.	-
domain	String	Cookie domain.	-
path	String	Cookie path.	-
expires	Number	Cookie expiration date as the number of seconds since the UNIX epoch.	-
size	Integer	Cookie size.	-
httpOnly	Boolean	True if cookie is http-only.	-
secure	Boolean	True if cookie is secure.	-
session	Boolean	True in case of session cookie.	-
sameSite	$REF: CookieSameSite	Cookie SameSite type.	[OPTIONAL]
priority	$REF: CookiePriority	Cookie Priority	[EXPERIMENTAL]
sameParty	Boolean	True if cookie is SameParty.	[EXPERIMENTAL]
sourceScheme	$REF: CookieSourceScheme	Cookie source scheme type.	[EXPERIMENTAL]
sourcePort	Integer	Cookie source port. Valid values are {-1, [1, 65535]}, -1 indicates an unspecified port. An unspecified port value allows protocol clients to emulate legacy cookie scope for the port. This is a temporary ability and it will be removed in the future.	[EXPERIMENTAL]

SetCookieBlockedReason

Types of reasons why a cookie may not be stored from a response.

[EXPERIMENTAL]

CookieBlockedReason

Types of reasons why a cookie may not be sent with a request.

[EXPERIMENTAL]

BlockedSetCookieWithReason

Object

A cookie which was not stored from a response with the corresponding reason.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
blockedReasons	Array (of) $REF: SetCookieBlockedReason	The reason(s) this cookie was blocked.	-
cookieLine	String	The string representing this individual cookie as it would appear in the header. This is not the entire "cookie" or "set-cookie" header which could have multiple cookies.	-
cookie	$REF: Cookie	The cookie object which represents the cookie which was not stored. It is optional because sometimes complete cookie information is not available, such as in the case of parsing errors.	[OPTIONAL]

BlockedCookieWithReason

Object

A cookie with was not sent with a request with the corresponding reason.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
blockedReasons	Array (of) $REF: CookieBlockedReason	The reason(s) the cookie was blocked.	-
cookie	$REF: Cookie	The cookie object representing the cookie which was not sent.	-

CookieParam

Object

Cookie parameter object

-

PROPERTIES:

Name	Type	Description	Flags
name	String	Cookie name.	-
value	String	Cookie value.	-
url	String	The request-URI to associate with the setting of the cookie. This value can affect the default domain, path, source port, and source scheme values of the created cookie.	[OPTIONAL]
domain	String	Cookie domain.	[OPTIONAL]
path	String	Cookie path.	[OPTIONAL]
secure	Boolean	True if cookie is secure.	[OPTIONAL]
httpOnly	Boolean	True if cookie is http-only.	[OPTIONAL]
sameSite	$REF: CookieSameSite	Cookie SameSite type.	[OPTIONAL]
expires	$REF: TimeSinceEpoch	Cookie expiration date, session cookie if not set	[OPTIONAL]
priority	$REF: CookiePriority	Cookie Priority.	[OPTIONAL] [EXPERIMENTAL]
sameParty	Boolean	True if cookie is SameParty.	[OPTIONAL] [EXPERIMENTAL]
sourceScheme	$REF: CookieSourceScheme	Cookie source scheme type.	[OPTIONAL] [EXPERIMENTAL]
sourcePort	Integer	Cookie source port. Valid values are {-1, [1, 65535]}, -1 indicates an unspecified port. An unspecified port value allows protocol clients to emulate legacy cookie scope for the port. This is a temporary ability and it will be removed in the future.	[OPTIONAL] [EXPERIMENTAL]

AuthChallenge

Object

Authorization challenge for HTTP status code 401 or 407.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
source	"Server", "Proxy"String [Hover] Enum	Source of the authentication challenge.	[OPTIONAL]
origin	String	Origin of the challenger.	-
scheme	String	The authentication scheme used, such as basic or digest	-
realm	String	The realm of the challenge. May be empty.	-

AuthChallengeResponse

Object

Response to an AuthChallenge.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
response	"Default", "CancelAuth", "ProvideCredentials"String [Hover] Enum	The decision on what to do in response to the authorization challenge. Default means deferring to the default behavior of the net stack, which will likely either the Cancel authentication or display a popup dialog box.	-
username	String	The username to provide, possibly empty. Should only be set if response is ProvideCredentials.	[OPTIONAL]
password	String	The password to provide, possibly empty. Should only be set if response is ProvideCredentials.	[OPTIONAL]

InterceptionStage

Stages of the interception to begin intercepting. Request will intercept before the request is sent. Response will intercept after the response is received.

[EXPERIMENTAL]

RequestPattern

Object

Request pattern for interception.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
urlPattern	String	Wildcards (`''` -> zero or more, `'?'` -> exactly one) are allowed. Escape character is backslash. Omitting is equivalent to `""`.	[OPTIONAL]
resourceType	$REF: ResourceType	If set, only requests for matching resource types will be intercepted.	[OPTIONAL]
interceptionStage	$REF: InterceptionStage	Stage at which to begin intercepting requests. Default is Request.	[OPTIONAL]

SignedExchangeSignature

Object

Information about a signed exchange signature. https://wicg.github.io/webpackage/draft-yasskin-httpbis-origin-signed-exchanges-impl.html#rfc.section.3.1

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
label	String	Signed exchange signature label.	-
signature	String	The hex string of signed exchange signature.	-
integrity	String	Signed exchange signature integrity.	-
certUrl	String	Signed exchange signature cert Url.	[OPTIONAL]
certSha256	String	The hex string of signed exchange signature cert sha256.	[OPTIONAL]
validityUrl	String	Signed exchange signature validity Url.	-
date	Integer	Signed exchange signature date.	-
expires	Integer	Signed exchange signature expires.	-
certificates	Array (of) String	The encoded certificates.	[OPTIONAL]

SignedExchangeHeader

Object

Information about a signed exchange header. https://wicg.github.io/webpackage/draft-yasskin-httpbis-origin-signed-exchanges-impl.html#cbor-representation

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
requestUrl	String	Signed exchange request URL.	-
responseCode	Integer	Signed exchange response code.	-
responseHeaders	$REF: Headers	Signed exchange response headers.	-
signatures	Array (of) $REF: SignedExchangeSignature	Signed exchange response signature.	-
headerIntegrity	String	Signed exchange header integrity hash in the form of "sha256-<base64-hash-value>".	-

SignedExchangeErrorField

Field type for a signed exchange related error.

[EXPERIMENTAL]

SignedExchangeError

Object

Information about a signed exchange response.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
message	String	Error message.	-
signatureIndex	Integer	The index of the signature which caused the error.	[OPTIONAL]
errorField	$REF: SignedExchangeErrorField	The field which caused the error.	[OPTIONAL]

SignedExchangeInfo

Object

Information about a signed exchange response.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
outerResponse	$REF: Response	The outer response of signed HTTP exchange which was received from network.	-
header	$REF: SignedExchangeHeader	Information about the signed exchange header.	[OPTIONAL]
securityDetails	$REF: SecurityDetails	Security details for the signed exchange header.	[OPTIONAL]
errors	Array (of) $REF: SignedExchangeError	Errors occurred while handling the signed exchagne.	[OPTIONAL]

ContentEncoding

List of content encodings supported by the backend.

[EXPERIMENTAL]

PrivateNetworkRequestPolicy

-

[EXPERIMENTAL]

IPAddressSpace

-

[EXPERIMENTAL]

ConnectTiming

Object

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
requestTime	Number	Timing's requestTime is a baseline in seconds, while the other numbers are ticks in milliseconds relatively to this requestTime. Matches ResourceTiming's requestTime for the same request (but not for redirected requests).	-

ClientSecurityState

Object

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
initiatorIsSecureContext	Boolean	-	-
initiatorIPAddressSpace	$REF: IPAddressSpace	-	-
privateNetworkRequestPolicy	$REF: PrivateNetworkRequestPolicy	-	-

CrossOriginOpenerPolicyValue

-

[EXPERIMENTAL]

CrossOriginOpenerPolicyStatus

Object

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
value	$REF: CrossOriginOpenerPolicyValue	-	-
reportOnlyValue	$REF: CrossOriginOpenerPolicyValue	-	-
reportingEndpoint	String	-	[OPTIONAL]
reportOnlyReportingEndpoint	String	-	[OPTIONAL]

CrossOriginEmbedderPolicyValue

-

[EXPERIMENTAL]

CrossOriginEmbedderPolicyStatus

Object

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
value	$REF: CrossOriginEmbedderPolicyValue	-	-
reportOnlyValue	$REF: CrossOriginEmbedderPolicyValue	-	-
reportingEndpoint	String	-	[OPTIONAL]
reportOnlyReportingEndpoint	String	-	[OPTIONAL]

SecurityIsolationStatus

Object

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
coop	$REF: CrossOriginOpenerPolicyStatus	-	[OPTIONAL]
coep	$REF: CrossOriginEmbedderPolicyStatus	-	[OPTIONAL]

ReportStatus

The status of a Reporting API report.

[EXPERIMENTAL]

ReportId

String

-

[EXPERIMENTAL]

ReportingApiReport

Object

An object representing a report generated by the Reporting API.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
id	$REF: ReportId	-	-
initiatorUrl	String	The URL of the document that triggered the report.	-
destination	String	The name of the endpoint group that should be used to deliver the report.	-
type	String	The type of the report (specifies the set of data that is contained in the report body).	-
timestamp	$REF: Network.TimeSinceEpoch	When the report was generated.	-
depth	Integer	How many uploads deep the related request was.	-
completedAttempts	Integer	The number of delivery attempts made so far, not including an active attempt.	-
body	Object	-	-
status	$REF: ReportStatus	-	-

LoadNetworkResourcePageResult

Object

An object providing the result of a network resource load.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
success	Boolean	-	-
netError	Number	Optional values used for error reporting.	[OPTIONAL]
netErrorName	String	-	[OPTIONAL]
httpStatusCode	Number	-	[OPTIONAL]
stream	$REF: IO.StreamHandle	If successful, one of the following two fields holds the result.	[OPTIONAL]
headers	$REF: Network.Headers	Response headers.	[OPTIONAL]

LoadNetworkResourceOptions

Object

An options object that may be extended later to better support CORS, CORB and streaming.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
disableCache	Boolean	-	-
includeCredentials	Boolean	-	-

commands

Name

Description

Flags

setAcceptedEncodings

Sets a list of content encodings that will be accepted. Empty list means no encoding is accepted.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
encodings	Array (of) $REF: ContentEncoding	List of accepted content encodings.	-

clearAcceptedEncodingsOverride

Clears accepted encodings set by setAcceptedEncodings

[EXPERIMENTAL]

canClearBrowserCache

Tells whether clearing browser cache is supported.

[DEPRECATED]

RETURNS:

Name	Type	Description	Flags
result	Boolean	True if browser cache can be cleared.	-

canClearBrowserCookies

Tells whether clearing browser cookies is supported.

[DEPRECATED]

RETURNS:

Name	Type	Description	Flags
result	Boolean	True if browser cookies can be cleared.	-

canEmulateNetworkConditions

Tells whether emulation of network conditions is supported.

[DEPRECATED]

RETURNS:

Name	Type	Description	Flags
result	Boolean	True if emulation of network conditions is supported.	-

clearBrowserCache

Clears browser cache.

-

clearBrowserCookies

Clears browser cookies.

-

continueInterceptedRequest

Response to Network.requestIntercepted which either modifies the request to continue with any modifications, or blocks it, or completes it with the provided response bytes. If a network fetch occurs as a result which encounters a redirect an additional Network.requestIntercepted event will be sent with the same InterceptionId. Deprecated, use Fetch.continueRequest, Fetch.fulfillRequest and Fetch.failRequest instead.

[EXPERIMENTAL]
[DEPRECATED]

PARAMETERS:

Name	Type	Description	Flags
interceptionId	$REF: InterceptionId	-	-
errorReason	$REF: ErrorReason	If set this causes the request to fail with the given reason. Passing `Aborted` for requests marked with `isNavigationRequest` also cancels the navigation. Must not be set in response to an authChallenge.	[OPTIONAL]
rawResponse	String	If set the requests completes using with the provided base64 encoded raw response, including HTTP status line and headers etc... Must not be set in response to an authChallenge. (Encoded as a base64 string when passed over JSON)	[OPTIONAL]
url	String	If set the request url will be modified in a way that's not observable by page. Must not be set in response to an authChallenge.	[OPTIONAL]
method	String	If set this allows the request method to be overridden. Must not be set in response to an authChallenge.	[OPTIONAL]
postData	String	If set this allows postData to be set. Must not be set in response to an authChallenge.	[OPTIONAL]
headers	$REF: Headers	If set this allows the request headers to be changed. Must not be set in response to an authChallenge.	[OPTIONAL]
authChallengeResponse	$REF: AuthChallengeResponse	Response to a requestIntercepted with an authChallenge. Must not be set otherwise.	[OPTIONAL]

deleteCookies

Deletes browser cookies with matching name and url or domain/path pair.

-

PARAMETERS:

Name	Type	Description	Flags
name	String	Name of the cookies to remove.	-
url	String	If specified, deletes all the cookies with the given name where domain and path match provided URL.	[OPTIONAL]
domain	String	If specified, deletes only cookies with the exact domain.	[OPTIONAL]
path	String	If specified, deletes only cookies with the exact path.	[OPTIONAL]

disable

Disables network tracking, prevents network events from being sent to the client.

-

emulateNetworkConditions

Activates emulation of network conditions.

-

PARAMETERS:

Name	Type	Description	Flags
offline	Boolean	True to emulate internet disconnection.	-
latency	Number	Minimum latency from request sent to response headers received (ms).	-
downloadThroughput	Number	Maximal aggregated download throughput (bytes/sec). -1 disables download throttling.	-
uploadThroughput	Number	Maximal aggregated upload throughput (bytes/sec). -1 disables upload throttling.	-
connectionType	$REF: ConnectionType	Connection type if known.	[OPTIONAL]

enable

Enables network tracking, network events will now be delivered to the client.

-

PARAMETERS:

Name	Type	Description	Flags
maxTotalBufferSize	Integer	Buffer size in bytes to use when preserving network payloads (XHRs, etc).	[OPTIONAL] [EXPERIMENTAL]
maxResourceBufferSize	Integer	Per-resource buffer size in bytes to use when preserving network payloads (XHRs, etc).	[OPTIONAL] [EXPERIMENTAL]
maxPostDataSize	Integer	Longest post body size (in bytes) that would be included in requestWillBeSent notification	[OPTIONAL]

getAllCookies

Returns all browser cookies. Depending on the backend support, will return detailed cookie information in the `cookies` field.

-

RETURNS:

Name	Type	Description	Flags
cookies	Array (of) $REF: Cookie	Array of cookie objects.	-

getCertificate

Returns the DER-encoded certificate.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
origin	String	Origin to get certificate for.	-

RETURNS:

Name	Type	Description	Flags
tableNames	Array (of) String	-	-

getCookies

Returns all browser cookies for the current URL. Depending on the backend support, will return detailed cookie information in the `cookies` field.

-

PARAMETERS:

Name	Type	Description	Flags
urls	Array (of) String	The list of URLs for which applicable cookies will be fetched. If not specified, it's assumed to be set to the list containing the URLs of the page and all of its subframes.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
cookies	Array (of) $REF: Cookie	Array of cookie objects.	-

getResponseBody

Returns content served for the given request.

-

PARAMETERS:

Name	Type	Description	Flags
requestId	$REF: RequestId	Identifier of the network request to get content for.	-

RETURNS:

Name	Type	Description	Flags
body	String	Response body.	-
base64Encoded	Boolean	True, if content was sent as base64.	-

getRequestPostData

Returns post data sent with the request. Returns an error when no data was sent with the request.

-

PARAMETERS:

Name	Type	Description	Flags
requestId	$REF: RequestId	Identifier of the network request to get content for.	-

RETURNS:

Name	Type	Description	Flags
postData	String	Request body string, omitting files from multipart requests	-

getResponseBodyForInterception

Returns content served for the given currently intercepted request.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
interceptionId	$REF: InterceptionId	Identifier for the intercepted request to get body for.	-

RETURNS:

Name	Type	Description	Flags
body	String	Response body.	-
base64Encoded	Boolean	True, if content was sent as base64.	-

takeResponseBodyForInterceptionAsStream

Returns a handle to the stream representing the response body. Note that after this command, the intercepted request can't be continued as is -- you either need to cancel it or to provide the response body. The stream only supports sequential read, IO.read will fail if the position is specified.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
interceptionId	$REF: InterceptionId	-	-

RETURNS:

Name	Type	Description	Flags
stream	$REF: IO.StreamHandle	-	-

replayXHR

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.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
requestId	$REF: RequestId	Identifier of XHR to replay.	-

searchInResponseBody

Searches for given string in response content.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
requestId	$REF: RequestId	Identifier of the network response to search.	-
query	String	String to search for.	-
caseSensitive	Boolean	If true, search is case sensitive.	[OPTIONAL]
isRegex	Boolean	If true, treats string parameter as regex.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
result	Array (of) $REF: Debugger.SearchMatch	List of search matches.	-

setBlockedURLs

Blocks URLs from loading.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
urls	Array (of) String	URL patterns to block. Wildcards ('*') are allowed.	-

setBypassServiceWorker

Toggles ignoring of service worker for each request.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
bypass	Boolean	Bypass service worker and load from network.	-

setCacheDisabled

Toggles ignoring cache for each request. If `true`, cache will not be used.

-

PARAMETERS:

Name	Type	Description	Flags
cacheDisabled	Boolean	Cache disabled state.	-

setCookie

Sets a cookie with the given cookie data; may overwrite equivalent cookies if they exist.

-

PARAMETERS:

Name	Type	Description	Flags
name	String	Cookie name.	-
value	String	Cookie value.	-
url	String	The request-URI to associate with the setting of the cookie. This value can affect the default domain, path, source port, and source scheme values of the created cookie.	[OPTIONAL]
domain	String	Cookie domain.	[OPTIONAL]
path	String	Cookie path.	[OPTIONAL]
secure	Boolean	True if cookie is secure.	[OPTIONAL]
httpOnly	Boolean	True if cookie is http-only.	[OPTIONAL]
sameSite	$REF: CookieSameSite	Cookie SameSite type.	[OPTIONAL]
expires	$REF: TimeSinceEpoch	Cookie expiration date, session cookie if not set	[OPTIONAL]
priority	$REF: CookiePriority	Cookie Priority type.	[OPTIONAL] [EXPERIMENTAL]
sameParty	Boolean	True if cookie is SameParty.	[OPTIONAL] [EXPERIMENTAL]
sourceScheme	$REF: CookieSourceScheme	Cookie source scheme type.	[OPTIONAL] [EXPERIMENTAL]
sourcePort	Integer	Cookie source port. Valid values are {-1, [1, 65535]}, -1 indicates an unspecified port. An unspecified port value allows protocol clients to emulate legacy cookie scope for the port. This is a temporary ability and it will be removed in the future.	[OPTIONAL] [EXPERIMENTAL]

RETURNS:

Name	Type	Description	Flags
success	Boolean	Always set to true. If an error occurs, the response indicates protocol error.	[DEPRECATED]

setCookies

Sets given cookies.

-

PARAMETERS:

Name	Type	Description	Flags
cookies	Array (of) $REF: CookieParam	Cookies to be set.	-

setExtraHTTPHeaders

Specifies whether to always send extra HTTP headers with the requests from this page.

-

PARAMETERS:

Name	Type	Description	Flags
headers	$REF: Headers	Map with extra HTTP headers.	-

setAttachDebugStack

Specifies whether to attach a page script stack id in requests

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
enabled	Boolean	Whether to attach a page script stack for debugging purpose.	-

setRequestInterception

Sets the requests to intercept that match the provided patterns and optionally resource types. Deprecated, please use Fetch.enable instead.

[EXPERIMENTAL]
[DEPRECATED]

PARAMETERS:

Name	Type	Description	Flags
patterns	Array (of) $REF: RequestPattern	Requests matching any of these patterns will be forwarded and wait for the corresponding continueInterceptedRequest call.	-

setUserAgentOverride
REDIRECT: Emulation

Allows overriding user agent with the given string.

-

PARAMETERS:

Name	Type	Description	Flags
userAgent	String	User agent to use.	-
acceptLanguage	String	Browser langugage to emulate.	[OPTIONAL]
platform	String	The platform navigator.platform should return.	[OPTIONAL]
userAgentMetadata	$REF: Emulation.UserAgentMetadata	To be sent in Sec-CH-UA-* headers and returned in navigator.userAgentData	[OPTIONAL] [EXPERIMENTAL]

getSecurityIsolationStatus

Returns information about the COEP/COOP isolation status.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
frameId	$REF: Page.FrameId	If no frameId is provided, the status of the target is provided.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
status	$REF: SecurityIsolationStatus	-	-

enableReportingApi

Enables tracking for the Reporting API, events generated by the Reporting API will now be delivered to the client. Enabling triggers 'reportingApiReportAdded' for all existing reports.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
enable	Boolean	Whether to enable or disable events for the Reporting API	-

loadNetworkResource

Fetches the resource and returns the content.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
frameId	$REF: Page.FrameId	Frame id to get the resource for. Mandatory for frame targets, and should be omitted for worker targets.	[OPTIONAL]
url	String	URL of the resource to get content for.	-
options	$REF: LoadNetworkResourceOptions	Options for the request.	-

RETURNS:

Name	Type	Description	Flags
resource	$REF: LoadNetworkResourcePageResult	-	-

events

Name

Description

Flags

dataReceived

Fired when data chunk was received over the network.

-

PARAMETERS:

Name	Type	Description	Flags
requestId	$REF: RequestId	Request identifier.	-
timestamp	$REF: MonotonicTime	Timestamp.	-
dataLength	Integer	Data chunk length.	-
encodedDataLength	Integer	Actual bytes received (might be less than dataLength for compressed encodings).	-

eventSourceMessageReceived

Fired when EventSource message is received.

-

PARAMETERS:

Name	Type	Description	Flags
requestId	$REF: RequestId	Request identifier.	-
timestamp	$REF: MonotonicTime	Timestamp.	-
eventName	String	Message type.	-
eventId	String	Message identifier.	-
data	String	Message content.	-

loadingFailed

Fired when HTTP request has failed to load.

-

PARAMETERS:

Name	Type	Description	Flags
requestId	$REF: RequestId	Request identifier.	-
timestamp	$REF: MonotonicTime	Timestamp.	-
type	$REF: ResourceType	Resource type.	-
errorText	String	User friendly error message.	-
canceled	Boolean	True if loading was canceled.	[OPTIONAL]
blockedReason	$REF: BlockedReason	The reason why loading was blocked, if any.	[OPTIONAL]
corsErrorStatus	$REF: CorsErrorStatus	The reason why loading was blocked by CORS, if any.	[OPTIONAL]

loadingFinished

Fired when HTTP request has finished loading.

-

PARAMETERS:

Name	Type	Description	Flags
requestId	$REF: RequestId	Request identifier.	-
timestamp	$REF: MonotonicTime	Timestamp.	-
encodedDataLength	Number	Total number of bytes received for this request.	-
shouldReportCorbBlocking	Boolean	Set when 1) response was blocked by Cross-Origin Read Blocking and also 2) this needs to be reported to the DevTools console.	[OPTIONAL]

requestIntercepted

Details of an intercepted HTTP request, which must be either allowed, blocked, modified or mocked. Deprecated, use Fetch.requestPaused instead.

[EXPERIMENTAL]
[DEPRECATED]

PARAMETERS:

Name	Type	Description	Flags
interceptionId	$REF: InterceptionId	Each request the page makes will have a unique id, however if any redirects are encountered while processing that fetch, they will be reported with the same id as the original fetch. Likewise if HTTP authentication is needed then the same fetch id will be used.	-
request	$REF: Request	-	-
frameId	$REF: Page.FrameId	The id of the frame that initiated the request.	-
resourceType	$REF: ResourceType	How the requested resource will be used.	-
isNavigationRequest	Boolean	Whether this is a navigation request, which can abort the navigation completely.	-
isDownload	Boolean	Set if the request is a navigation that will result in a download. Only present after response is received from the server (i.e. HeadersReceived stage).	[OPTIONAL]
redirectUrl	String	Redirect location, only sent if a redirect was intercepted.	[OPTIONAL]
authChallenge	$REF: AuthChallenge	Details of the Authorization Challenge encountered. If this is set then continueInterceptedRequest must contain an authChallengeResponse.	[OPTIONAL]
responseErrorReason	$REF: ErrorReason	Response error if intercepted at response stage or if redirect occurred while intercepting request.	[OPTIONAL]
responseStatusCode	Integer	Response code if intercepted at response stage or if redirect occurred while intercepting request or auth retry occurred.	[OPTIONAL]
responseHeaders	$REF: Headers	Response headers if intercepted at the response stage or if redirect occurred while intercepting request or auth retry occurred.	[OPTIONAL]
requestId	$REF: RequestId	If the intercepted request had a corresponding requestWillBeSent event fired for it, then this requestId will be the same as the requestId present in the requestWillBeSent event.	[OPTIONAL]

requestServedFromCache

Fired if request ended up loading from cache.

-

PARAMETERS:

Name	Type	Description	Flags
requestId	$REF: RequestId	Request identifier.	-

requestWillBeSent

Fired when page is about to send HTTP request.

-

PARAMETERS:

Name	Type	Description	Flags
requestId	$REF: RequestId	Request identifier.	-
loaderId	$REF: LoaderId	Loader identifier. Empty string if the request is fetched from worker.	-
documentURL	String	URL of the document this request is loaded for.	-
request	$REF: Request	Request data.	-
timestamp	$REF: MonotonicTime	Timestamp.	-
wallTime	$REF: TimeSinceEpoch	Timestamp.	-
initiator	$REF: Initiator	Request initiator.	-
redirectHasExtraInfo	Boolean	In the case that redirectResponse is populated, this flag indicates whether requestWillBeSentExtraInfo and responseReceivedExtraInfo events will be or were emitted for the request which was just redirected.	[EXPERIMENTAL]
redirectResponse	$REF: Response	Redirect response data.	[OPTIONAL]
type	$REF: ResourceType	Type of this resource.	[OPTIONAL]
frameId	$REF: Page.FrameId	Frame identifier.	[OPTIONAL]
hasUserGesture	Boolean	Whether the request is initiated by a user gesture. Defaults to false.	[OPTIONAL]

resourceChangedPriority

Fired when resource loading priority is changed

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
requestId	$REF: RequestId	Request identifier.	-
newPriority	$REF: ResourcePriority	New priority	-
timestamp	$REF: MonotonicTime	Timestamp.	-

signedExchangeReceived

Fired when a signed exchange was received over the network

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
requestId	$REF: RequestId	Request identifier.	-
info	$REF: SignedExchangeInfo	Information about the signed exchange response.	-

responseReceived

Fired when HTTP response is available.

-

PARAMETERS:

Name	Type	Description	Flags
requestId	$REF: RequestId	Request identifier.	-
loaderId	$REF: LoaderId	Loader identifier. Empty string if the request is fetched from worker.	-
timestamp	$REF: MonotonicTime	Timestamp.	-
type	$REF: ResourceType	Resource type.	-
response	$REF: Response	Response data.	-
hasExtraInfo	Boolean	Indicates whether requestWillBeSentExtraInfo and responseReceivedExtraInfo events will be or were emitted for this request.	[EXPERIMENTAL]
frameId	$REF: Page.FrameId	Frame identifier.	[OPTIONAL]

webSocketClosed

Fired when WebSocket is closed.

-

PARAMETERS:

Name	Type	Description	Flags
requestId	$REF: RequestId	Request identifier.	-
timestamp	$REF: MonotonicTime	Timestamp.	-

webSocketCreated

Fired upon WebSocket creation.

-

PARAMETERS:

Name	Type	Description	Flags
requestId	$REF: RequestId	Request identifier.	-
url	String	WebSocket request URL.	-
initiator	$REF: Initiator	Request initiator.	[OPTIONAL]

webSocketFrameError

Fired when WebSocket message error occurs.

-

PARAMETERS:

Name	Type	Description	Flags
requestId	$REF: RequestId	Request identifier.	-
timestamp	$REF: MonotonicTime	Timestamp.	-
errorMessage	String	WebSocket error message.	-

webSocketFrameReceived

Fired when WebSocket message is received.

-

PARAMETERS:

Name	Type	Description	Flags
requestId	$REF: RequestId	Request identifier.	-
timestamp	$REF: MonotonicTime	Timestamp.	-
response	$REF: WebSocketFrame	WebSocket response data.	-

webSocketFrameSent

Fired when WebSocket message is sent.

-

PARAMETERS:

Name	Type	Description	Flags
requestId	$REF: RequestId	Request identifier.	-
timestamp	$REF: MonotonicTime	Timestamp.	-
response	$REF: WebSocketFrame	WebSocket response data.	-

webSocketHandshakeResponseReceived

Fired when WebSocket handshake response becomes available.

-

PARAMETERS:

Name	Type	Description	Flags
requestId	$REF: RequestId	Request identifier.	-
timestamp	$REF: MonotonicTime	Timestamp.	-
response	$REF: WebSocketResponse	WebSocket response data.	-

webSocketWillSendHandshakeRequest

Fired when WebSocket is about to initiate handshake.

-

PARAMETERS:

Name	Type	Description	Flags
requestId	$REF: RequestId	Request identifier.	-
timestamp	$REF: MonotonicTime	Timestamp.	-
wallTime	$REF: TimeSinceEpoch	UTC Timestamp.	-
request	$REF: WebSocketRequest	WebSocket request data.	-

webTransportCreated

Fired upon WebTransport creation.

-

PARAMETERS:

Name	Type	Description	Flags
transportId	$REF: RequestId	WebTransport identifier.	-
url	String	WebTransport request URL.	-
timestamp	$REF: MonotonicTime	Timestamp.	-
initiator	$REF: Initiator	Request initiator.	[OPTIONAL]

webTransportConnectionEstablished

Fired when WebTransport handshake is finished.

-

PARAMETERS:

Name	Type	Description	Flags
transportId	$REF: RequestId	WebTransport identifier.	-
timestamp	$REF: MonotonicTime	Timestamp.	-

webTransportClosed

Fired when WebTransport is disposed.

-

PARAMETERS:

Name	Type	Description	Flags
transportId	$REF: RequestId	WebTransport identifier.	-
timestamp	$REF: MonotonicTime	Timestamp.	-

requestWillBeSentExtraInfo

Fired when additional information about a requestWillBeSent event is available from the network stack. Not every requestWillBeSent event will have an additional requestWillBeSentExtraInfo fired for it, and there is no guarantee whether requestWillBeSent or requestWillBeSentExtraInfo will be fired first for the same request.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
requestId	$REF: RequestId	Request identifier. Used to match this information to an existing requestWillBeSent event.	-
associatedCookies	Array (of) $REF: BlockedCookieWithReason	A list of cookies potentially associated to the requested URL. This includes both cookies sent with the request and the ones not sent; the latter are distinguished by having blockedReason field set.	-
headers	$REF: Headers	Raw request headers as they will be sent over the wire.	-
connectTiming	$REF: ConnectTiming	Connection timing information for the request.	[EXPERIMENTAL]
clientSecurityState	$REF: ClientSecurityState	The client security state set for the request.	[OPTIONAL]

responseReceivedExtraInfo

Fired when additional information about a responseReceived event is available from the network stack. Not every responseReceived event will have an additional responseReceivedExtraInfo for it, and responseReceivedExtraInfo may be fired before or after responseReceived.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
requestId	$REF: RequestId	Request identifier. Used to match this information to another responseReceived event.	-
blockedCookies	Array (of) $REF: BlockedSetCookieWithReason	A list of cookies which were not stored from the response along with the corresponding reasons for blocking. The cookies here may not be valid due to syntax errors, which are represented by the invalid cookie line string instead of a proper cookie.	-
headers	$REF: Headers	Raw response headers as they were received over the wire.	-
resourceIPAddressSpace	$REF: IPAddressSpace	The IP address space of the resource. The address space can only be determined once the transport established the connection, so we can't send it in `requestWillBeSentExtraInfo`.	-
statusCode	Integer	The status code of the response. This is useful in cases the request failed and no responseReceived event is triggered, which is the case for, e.g., CORS errors. This is also the correct status code for cached requests, where the status in responseReceived is a 200 and this will be 304.	-
headersText	String	Raw response header text as it was received over the wire. The raw text may not always be available, such as in the case of HTTP/2 or QUIC.	[OPTIONAL]

trustTokenOperationDone

Fired exactly once for each Trust Token operation. Depending on the type of the operation and whether the operation succeeded or failed, the event is fired before the corresponding request was sent or after the response was received.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
status	"Ok", "InvalidArgument", "FailedPrecondition", "ResourceExhausted", "AlreadyExists", "Unavailable", "BadResponse", "InternalError", "UnknownError", "FulfilledLocally"String [Hover] Enum	Detailed success or error status of the operation. 'AlreadyExists' also signifies a successful operation, as the result of the operation already exists und thus, the operation was abort preemptively (e.g. a cache hit).	-
type	$REF: TrustTokenOperationType	-	-
requestId	$REF: RequestId	-	-
topLevelOrigin	String	Top level origin. The context in which the operation was attempted.	[OPTIONAL]
issuerOrigin	String	Origin of the issuer in case of a "Issuance" or "Redemption" operation.	[OPTIONAL]
issuedTokenCount	Integer	The number of obtained Trust Tokens on a successful "Issuance" operation.	[OPTIONAL]

subresourceWebBundleMetadataReceived

Fired once when parsing the .wbn file has succeeded. The event contains the information about the web bundle contents.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
requestId	$REF: RequestId	Request identifier. Used to match this information to another event.	-
urls	Array (of) String	A list of URLs of resources in the subresource Web Bundle.	-

subresourceWebBundleMetadataError

Fired once when parsing the .wbn file has failed.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
requestId	$REF: RequestId	Request identifier. Used to match this information to another event.	-
errorMessage	String	Error message	-

subresourceWebBundleInnerResponseParsed

Fired when handling requests for resources within a .wbn file. Note: this will only be fired for resources that are requested by the webpage.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
innerRequestId	$REF: RequestId	Request identifier of the subresource request	-
innerRequestURL	String	URL of the subresource resource.	-
bundleRequestId	$REF: RequestId	Bundle request identifier. Used to match this information to another event. This made be absent in case when the instrumentation was enabled only after webbundle was parsed.	[OPTIONAL]

subresourceWebBundleInnerResponseError

Fired when request for resources within a .wbn file failed.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
innerRequestId	$REF: RequestId	Request identifier of the subresource request	-
innerRequestURL	String	URL of the subresource resource.	-
errorMessage	String	Error message	-
bundleRequestId	$REF: RequestId	Bundle request identifier. Used to match this information to another event. This made be absent in case when the instrumentation was enabled only after webbundle was parsed.	[OPTIONAL]

reportingApiReportAdded

Is sent whenever a new report is added. And after 'enableReportingApi' for all existing reports.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
report	$REF: ReportingApiReport	-	-

reportingApiReportUpdated

-

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
report	$REF: ReportingApiReport	-	-

Overlay

[Experimental]

This domain provides various functionality related to drawing atop the inspected page.

Dependencies: DOM, Page, Runtime

Page

Actions and events related to the inspected page belong to the page domain.

Dependencies: Debugger, DOM, IO, Network, Runtime

types

Type ID

Type

Description

Flags

FrameId

String

Unique frame identifier.

-

AdFrameType

Indicates whether a frame has been identified as an ad.

[EXPERIMENTAL]

AdFrameExplanation

-

[EXPERIMENTAL]

AdFrameStatus

Object

Indicates whether a frame has been identified as an ad and why.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
adFrameType	$REF: AdFrameType	-	-
explanations	Array (of) $REF: AdFrameExplanation	-	[OPTIONAL]

SecureContextType

Indicates whether the frame is a secure context and why it is the case.

[EXPERIMENTAL]

CrossOriginIsolatedContextType

Indicates whether the frame is cross-origin isolated and why it is the case.

[EXPERIMENTAL]

GatedAPIFeatures

-

[EXPERIMENTAL]

PermissionsPolicyFeature

All Permissions Policy features. This enum should match the one defined in third_party/blink/renderer/core/permissions_policy/permissions_policy_features.json5.

[EXPERIMENTAL]

PermissionsPolicyBlockReason

Reason for a permissions policy feature to be disabled.

[EXPERIMENTAL]

PermissionsPolicyBlockLocator

Object

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
frameId	$REF: FrameId	-	-
blockReason	$REF: PermissionsPolicyBlockReason	-	-

PermissionsPolicyFeatureState

Object

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
feature	$REF: PermissionsPolicyFeature	-	-
allowed	Boolean	-	-
locator	$REF: PermissionsPolicyBlockLocator	-	[OPTIONAL]

OriginTrialTokenStatus

Origin Trial(https://www.chromium.org/blink/origin-trials) support. Status for an Origin Trial token.

[EXPERIMENTAL]

OriginTrialStatus

Status for an Origin Trial.

[EXPERIMENTAL]

OriginTrialUsageRestriction

-

[EXPERIMENTAL]

OriginTrialToken

Object

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
origin	String	-	-
matchSubDomains	Boolean	-	-
trialName	String	-	-
expiryTime	$REF: Network.TimeSinceEpoch	-	-
isThirdParty	Boolean	-	-
usageRestriction	$REF: OriginTrialUsageRestriction	-	-

OriginTrialTokenWithStatus

Object

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
rawTokenText	String	-	-
parsedToken	$REF: OriginTrialToken	`parsedToken` is present only when the token is extractable and parsable.	[OPTIONAL]
status	$REF: OriginTrialTokenStatus	-	-

OriginTrial

Object

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
trialName	String	-	-
status	$REF: OriginTrialStatus	-	-
tokensWithStatus	Array (of) $REF: OriginTrialTokenWithStatus	-	-

Frame

Object

Information about the Frame on the page.

-

PROPERTIES:

Name	Type	Description	Flags
id	$REF: FrameId	Frame unique identifier.	-
parentId	$REF: FrameId	Parent frame identifier.	[OPTIONAL]
loaderId	$REF: Network.LoaderId	Identifier of the loader associated with this frame.	-
name	String	Frame's name as specified in the tag.	[OPTIONAL]
url	String	Frame document's URL without fragment.	-
urlFragment	String	Frame document's URL fragment including the '#'.	[OPTIONAL] [EXPERIMENTAL]
domainAndRegistry	String	Frame document's registered domain, taking the public suffixes list into account. Extracted from the Frame's url. Example URLs: http://www.google.com/file.html -> "google.com" http://a.b.co.uk/file.html -> "b.co.uk"	[EXPERIMENTAL]
securityOrigin	String	Frame document's security origin.	-
mimeType	String	Frame document's mimeType as determined by the browser.	-
unreachableUrl	String	If the frame failed to load, this contains the URL that could not be loaded. Note that unlike url above, this URL may contain a fragment.	[OPTIONAL] [EXPERIMENTAL]
adFrameStatus	$REF: AdFrameStatus	Indicates whether this frame was tagged as an ad and why.	[OPTIONAL] [EXPERIMENTAL]
secureContextType	$REF: SecureContextType	Indicates whether the main document is a secure context and explains why that is the case.	[EXPERIMENTAL]
crossOriginIsolatedContextType	$REF: CrossOriginIsolatedContextType	Indicates whether this is a cross origin isolated context.	[EXPERIMENTAL]
gatedAPIFeatures	Array (of) $REF: GatedAPIFeatures	Indicated which gated APIs / features are available.	[EXPERIMENTAL]

FrameResource

Object

Information about the Resource on the page.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
url	String	Resource URL.	-
type	$REF: Network.ResourceType	Type of this resource.	-
mimeType	String	Resource mimeType as determined by the browser.	-
lastModified	$REF: Network.TimeSinceEpoch	last-modified timestamp as reported by server.	[OPTIONAL]
contentSize	Number	Resource content size.	[OPTIONAL]
failed	Boolean	True if the resource failed to load.	[OPTIONAL]
canceled	Boolean	True if the resource was canceled during loading.	[OPTIONAL]

FrameResourceTree

Object

Information about the Frame hierarchy along with their cached resources.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
frame	$REF: Frame	Frame information for this tree item.	-
childFrames	Array (of) $REF: FrameResourceTree	Child frames.	[OPTIONAL]
resources	Array (of) $REF: FrameResource	Information about frame resources.	-

FrameTree

Object

Information about the Frame hierarchy.

-

PROPERTIES:

Name	Type	Description	Flags
frame	$REF: Frame	Frame information for this tree item.	-
childFrames	Array (of) $REF: FrameTree	Child frames.	[OPTIONAL]

ScriptIdentifier

String

Unique script identifier.

-

TransitionType

Transition type.

-

NavigationEntry

Object

Navigation history entry.

-

PROPERTIES:

Name	Type	Description	Flags
id	Integer	Unique id of the navigation history entry.	-
url	String	URL of the navigation history entry.	-
userTypedURL	String	URL that the user typed in the url bar.	-
title	String	Title of the navigation history entry.	-
transitionType	$REF: TransitionType	Transition type.	-

ScreencastFrameMetadata

Object

Screencast frame metadata.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
offsetTop	Number	Top offset in DIP.	-
pageScaleFactor	Number	Page scale factor.	-
deviceWidth	Number	Device screen width in DIP.	-
deviceHeight	Number	Device screen height in DIP.	-
scrollOffsetX	Number	Position of horizontal scroll in CSS pixels.	-
scrollOffsetY	Number	Position of vertical scroll in CSS pixels.	-
timestamp	$REF: Network.TimeSinceEpoch	Frame swap timestamp.	[OPTIONAL]

DialogType

Javascript dialog type.

-

AppManifestError

Object

Error while paring app manifest.

-

PROPERTIES:

Name	Type	Description	Flags
message	String	Error message.	-
critical	Integer	If criticial, this is a non-recoverable parse error.	-
line	Integer	Error line.	-
column	Integer	Error column.	-

AppManifestParsedProperties

Object

Parsed app manifest properties.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
scope	String	Computed scope value	-

LayoutViewport

Object

Layout viewport position and dimensions.

-

PROPERTIES:

Name	Type	Description	Flags
pageX	Integer	Horizontal offset relative to the document (CSS pixels).	-
pageY	Integer	Vertical offset relative to the document (CSS pixels).	-
clientWidth	Integer	Width (CSS pixels), excludes scrollbar if present.	-
clientHeight	Integer	Height (CSS pixels), excludes scrollbar if present.	-

VisualViewport

Object

Visual viewport position, dimensions, and scale.

-

PROPERTIES:

Name	Type	Description	Flags
offsetX	Number	Horizontal offset relative to the layout viewport (CSS pixels).	-
offsetY	Number	Vertical offset relative to the layout viewport (CSS pixels).	-
pageX	Number	Horizontal offset relative to the document (CSS pixels).	-
pageY	Number	Vertical offset relative to the document (CSS pixels).	-
clientWidth	Number	Width (CSS pixels), excludes scrollbar if present.	-
clientHeight	Number	Height (CSS pixels), excludes scrollbar if present.	-
scale	Number	Scale relative to the ideal viewport (size at width=device-width).	-
zoom	Number	Page zoom factor (CSS to device independent pixels ratio).	[OPTIONAL]

Viewport

Object

Viewport for capturing screenshot.

-

PROPERTIES:

Name	Type	Description	Flags
x	Number	X offset in device independent pixels (dip).	-
y	Number	Y offset in device independent pixels (dip).	-
width	Number	Rectangle width in device independent pixels (dip).	-
height	Number	Rectangle height in device independent pixels (dip).	-
scale	Number	Page scale factor.	-

FontFamilies

Object

Generic font families collection.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
standard	String	The standard font-family.	[OPTIONAL]
fixed	String	The fixed font-family.	[OPTIONAL]
serif	String	The serif font-family.	[OPTIONAL]
sansSerif	String	The sansSerif font-family.	[OPTIONAL]
cursive	String	The cursive font-family.	[OPTIONAL]
fantasy	String	The fantasy font-family.	[OPTIONAL]
pictograph	String	The pictograph font-family.	[OPTIONAL]

FontSizes

Object

Default font sizes.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
standard	Integer	Default standard font size.	[OPTIONAL]
fixed	Integer	Default fixed font size.	[OPTIONAL]

ClientNavigationReason

-

[EXPERIMENTAL]

ClientNavigationDisposition

-

[EXPERIMENTAL]

InstallabilityErrorArgument

Object

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
name	String	Argument name (e.g. name:'minimum-icon-size-in-pixels').	-
value	String	Argument value (e.g. value:'64').	-

InstallabilityError

Object

The installability error

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
errorId	String	The error id (e.g. 'manifest-missing-suitable-icon').	-
errorArguments	Array (of) $REF: InstallabilityErrorArgument	The list of error arguments (e.g. {name:'minimum-icon-size-in-pixels', value:'64'}).	-

ReferrerPolicy

The referring-policy used for the navigation.

[EXPERIMENTAL]

CompilationCacheParams

Object

Per-script compilation cache parameters for `Page.produceCompilationCache`

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
url	String	The URL of the script to produce a compilation cache entry for.	-
eager	Boolean	A hint to the backend whether eager compilation is recommended. (the actual compilation mode used is upon backend discretion).	[OPTIONAL]

NavigationType

The type of a frameNavigated event.

[EXPERIMENTAL]

BackForwardCacheNotRestoredReason

List of not restored reasons for back-forward cache.

[EXPERIMENTAL]

BackForwardCacheNotRestoredReasonType

Types of not restored reasons for back-forward cache.

[EXPERIMENTAL]

BackForwardCacheNotRestoredExplanation

Object

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
type	$REF: BackForwardCacheNotRestoredReasonType	Type of the reason	-
reason	$REF: BackForwardCacheNotRestoredReason	Not restored reason	-

commands

Name

Description

Flags

addScriptToEvaluateOnLoad

Deprecated, please use addScriptToEvaluateOnNewDocument instead.

[EXPERIMENTAL]
[DEPRECATED]

PARAMETERS:

Name	Type	Description	Flags
scriptSource	String	-	-

RETURNS:

Name	Type	Description	Flags
identifier	$REF: ScriptIdentifier	Identifier of the added script.	-

addScriptToEvaluateOnNewDocument

Evaluates given script in every frame upon creation (before loading frame's scripts).

-

PARAMETERS:

Name	Type	Description	Flags
source	String	-	-
worldName	String	If specified, creates an isolated world with the given name and evaluates given script in it. This world name will be used as the ExecutionContextDescription::name when the corresponding event is emitted.	[OPTIONAL] [EXPERIMENTAL]
includeCommandLineAPI	Boolean	Specifies whether command line API should be available to the script, defaults to false.	[OPTIONAL] [EXPERIMENTAL]

RETURNS:

Name	Type	Description	Flags
identifier	$REF: ScriptIdentifier	Identifier of the added script.	-

bringToFront

Brings page to front (activates tab).

-

captureScreenshot

Capture page screenshot.

-

PARAMETERS:

Name	Type	Description	Flags
format	"jpeg", "png", "webp"String [Hover] Enum	Image compression format (defaults to png).	[OPTIONAL]
quality	Integer	Compression quality from range [0..100] (jpeg only).	[OPTIONAL]
clip	$REF: Viewport	Capture the screenshot of a given region only.	[OPTIONAL]
fromSurface	Boolean	Capture the screenshot from the surface, rather than the view. Defaults to true.	[OPTIONAL] [EXPERIMENTAL]
captureBeyondViewport	Boolean	Capture the screenshot beyond the viewport. Defaults to false.	[OPTIONAL] [EXPERIMENTAL]

RETURNS:

Name	Type	Description	Flags
data	String	Base64-encoded image data. (Encoded as a base64 string when passed over JSON)	-

captureSnapshot

Returns a snapshot of the page as a string. For MHTML format, the serialization includes iframes, shadow DOM, external resources, and element-inline styles.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
format	"mhtml"String [Hover] Enum	Format (defaults to mhtml).	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
data	String	Serialized page data.	-

clearDeviceMetricsOverride
REDIRECT: Emulation

Clears the overridden device metrics.

[EXPERIMENTAL]
[DEPRECATED]

clearDeviceOrientationOverride
REDIRECT: DeviceOrientation

Clears the overridden Device Orientation.

[EXPERIMENTAL]
[DEPRECATED]

clearGeolocationOverride
REDIRECT: Emulation

Clears the overridden Geolocation Position and Error.

[DEPRECATED]

createIsolatedWorld

Creates an isolated world for the given frame.

-

PARAMETERS:

Name	Type	Description	Flags
frameId	$REF: FrameId	Id of the frame in which the isolated world should be created.	-
worldName	String	An optional name which is reported in the Execution Context.	[OPTIONAL]
grantUniveralAccess	Boolean	Whether or not universal access should be granted to the isolated world. This is a powerful option, use with caution.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
executionContextId	$REF: Runtime.ExecutionContextId	Execution context of the isolated world.	-

deleteCookie
REDIRECT: Network

Deletes browser cookie with given name, domain and path.

[EXPERIMENTAL]
[DEPRECATED]

PARAMETERS:

Name	Type	Description	Flags
cookieName	String	Name of the cookie to remove.	-
url	String	URL to match cooke domain and path.	-

disable

Disables page domain notifications.

-

enable

Enables page domain notifications.

-

getAppManifest

-

RETURNS:

Name	Type	Description	Flags
url	String	Manifest location.	-
errors	Array (of) $REF: AppManifestError	-	-
data	String	Manifest content.	[OPTIONAL]
parsed	$REF: AppManifestParsedProperties	Parsed manifest properties	[OPTIONAL] [EXPERIMENTAL]

getInstallabilityErrors

-

[EXPERIMENTAL]

RETURNS:

Name	Type	Description	Flags
installabilityErrors	Array (of) $REF: InstallabilityError	-	-

getManifestIcons

-

[EXPERIMENTAL]

RETURNS:

Name	Type	Description	Flags
primaryIcon	String	-	[OPTIONAL]

getAppId

Returns the unique (PWA) app id. Only returns values if the feature flag 'WebAppEnableManifestId' is enabled

[EXPERIMENTAL]

RETURNS:

Name	Type	Description	Flags
appId	String	App id, either from manifest's id attribute or computed from start_url	[OPTIONAL]
recommendedId	String	Recommendation for manifest's id attribute to match current id computed from start_url	[OPTIONAL]

getCookies
REDIRECT: Network

Returns all browser cookies. Depending on the backend support, will return detailed cookie information in the `cookies` field.

[EXPERIMENTAL]
[DEPRECATED]

RETURNS:

Name	Type	Description	Flags
cookies	Array (of) $REF: Network.Cookie	Array of cookie objects.	-

getFrameTree

Returns present frame tree structure.

-

RETURNS:

Name	Type	Description	Flags
frameTree	$REF: FrameTree	Present frame tree structure.	-

getLayoutMetrics

Returns metrics relating to the layouting of the page, such as viewport bounds/scale.

-

RETURNS:

Name	Type	Description	Flags
layoutViewport	$REF: LayoutViewport	Deprecated metrics relating to the layout viewport. Can be in DP or in CSS pixels depending on the `enable-use-zoom-for-dsf` flag. Use `cssLayoutViewport` instead.	[DEPRECATED]
visualViewport	$REF: VisualViewport	Deprecated metrics relating to the visual viewport. Can be in DP or in CSS pixels depending on the `enable-use-zoom-for-dsf` flag. Use `cssVisualViewport` instead.	[DEPRECATED]
contentSize	$REF: DOM.Rect	Deprecated size of scrollable area. Can be in DP or in CSS pixels depending on the `enable-use-zoom-for-dsf` flag. Use `cssContentSize` instead.	[DEPRECATED]
cssLayoutViewport	$REF: LayoutViewport	Metrics relating to the layout viewport in CSS pixels.	-
cssVisualViewport	$REF: VisualViewport	Metrics relating to the visual viewport in CSS pixels.	-
cssContentSize	$REF: DOM.Rect	Size of scrollable area in CSS pixels.	-

getNavigationHistory

Returns navigation history for the current page.

-

RETURNS:

Name	Type	Description	Flags
currentIndex	Integer	Index of the current navigation history entry.	-
entries	Array (of) $REF: NavigationEntry	Array of navigation history entries.	-

resetNavigationHistory

Resets navigation history for the current page.

-

getResourceContent

Returns content of the given resource.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
frameId	$REF: FrameId	Frame id to get resource for.	-
url	String	URL of the resource to get content for.	-

RETURNS:

Name	Type	Description	Flags
content	String	Resource content.	-
base64Encoded	Boolean	True, if content was served as base64.	-

getResourceTree

Returns present frame / resource tree structure.

[EXPERIMENTAL]

RETURNS:

Name	Type	Description	Flags
frameTree	$REF: FrameResourceTree	Present frame / resource tree structure.	-

handleJavaScriptDialog

Accepts or dismisses a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload).

-

PARAMETERS:

Name	Type	Description	Flags
accept	Boolean	Whether to accept or dismiss the dialog.	-
promptText	String	The text to enter into the dialog prompt before accepting. Used only if this is a prompt dialog.	[OPTIONAL]

navigate

Navigates current page to the given URL.

-

PARAMETERS:

Name	Type	Description	Flags
url	String	URL to navigate the page to.	-
referrer	String	Referrer URL.	[OPTIONAL]
transitionType	$REF: TransitionType	Intended transition type.	[OPTIONAL]
frameId	$REF: FrameId	Frame id to navigate, if not specified navigates the top frame.	[OPTIONAL]
referrerPolicy	$REF: ReferrerPolicy	Referrer-policy used for the navigation.	[OPTIONAL] [EXPERIMENTAL]

RETURNS:

Name	Type	Description	Flags
frameId	$REF: FrameId	Frame id that has navigated (or failed to navigate)	-
loaderId	$REF: Network.LoaderId	Loader identifier.	[OPTIONAL]
errorText	String	User friendly error message, present if and only if navigation has failed.	[OPTIONAL]

navigateToHistoryEntry

Navigates current page to the given history entry.

-

PARAMETERS:

Name	Type	Description	Flags
entryId	Integer	Unique id of the entry to navigate to.	-

printToPDF

Print page as PDF.

-

PARAMETERS:

Name	Type	Description	Flags
landscape	Boolean	Paper orientation. Defaults to false.	[OPTIONAL]
displayHeaderFooter	Boolean	Display header and footer. Defaults to false.	[OPTIONAL]
printBackground	Boolean	Print background graphics. Defaults to false.	[OPTIONAL]
scale	Number	Scale of the webpage rendering. Defaults to 1.	[OPTIONAL]
paperWidth	Number	Paper width in inches. Defaults to 8.5 inches.	[OPTIONAL]
paperHeight	Number	Paper height in inches. Defaults to 11 inches.	[OPTIONAL]
marginTop	Number	Top margin in inches. Defaults to 1cm (~0.4 inches).	[OPTIONAL]
marginBottom	Number	Bottom margin in inches. Defaults to 1cm (~0.4 inches).	[OPTIONAL]
marginLeft	Number	Left margin in inches. Defaults to 1cm (~0.4 inches).	[OPTIONAL]
marginRight	Number	Right margin in inches. Defaults to 1cm (~0.4 inches).	[OPTIONAL]
pageRanges	String	Paper ranges to print, e.g., '1-5, 8, 11-13'. Defaults to the empty string, which means print all pages.	[OPTIONAL]
ignoreInvalidPageRanges	Boolean	Whether to silently ignore invalid but successfully parsed page ranges, such as '3-2'. Defaults to false.	[OPTIONAL]
headerTemplate	String	HTML template for the print header. Should be valid HTML markup with following classes used to inject printing values into them: - `date`: formatted print date - `title`: document title - `url`: document location - `pageNumber`: current page number - `totalPages`: total pages in the document For example, `<span class=title></span>` would generate span containing the title.	[OPTIONAL]
footerTemplate	String	HTML template for the print footer. Should use the same format as the `headerTemplate`.	[OPTIONAL]
preferCSSPageSize	Boolean	Whether or not to prefer page size as defined by css. Defaults to false, in which case the content will be scaled to fit the paper size.	[OPTIONAL]
transferMode	"ReturnAsBase64", "ReturnAsStream"String [Hover] Enum	return as stream	[OPTIONAL] [EXPERIMENTAL]

RETURNS:

Name	Type	Description	Flags
data	String	Base64-encoded pdf data. Empty if \|returnAsStream\| is specified. (Encoded as a base64 string when passed over JSON)	-
stream	$REF: IO.StreamHandle	A handle of the stream that holds resulting PDF data.	[OPTIONAL] [EXPERIMENTAL]

reload

Reloads given page optionally ignoring the cache.

-

PARAMETERS:

Name	Type	Description	Flags
ignoreCache	Boolean	If true, browser cache is ignored (as if the user pressed Shift+refresh).	[OPTIONAL]
scriptToEvaluateOnLoad	String	If set, the script will be injected into all frames of the inspected page after reload. Argument will be ignored if reloading dataURL origin.	[OPTIONAL]

removeScriptToEvaluateOnLoad

Deprecated, please use removeScriptToEvaluateOnNewDocument instead.

[EXPERIMENTAL]
[DEPRECATED]

PARAMETERS:

Name	Type	Description	Flags
identifier	$REF: ScriptIdentifier	-	-

removeScriptToEvaluateOnNewDocument

Removes given script from the list.

-

PARAMETERS:

Name	Type	Description	Flags
identifier	$REF: ScriptIdentifier	-	-

screencastFrameAck

Acknowledges that a screencast frame has been received by the frontend.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
sessionId	Integer	Frame number.	-

searchInResource

Searches for given string in resource content.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
frameId	$REF: FrameId	Frame id for resource to search in.	-
url	String	URL of the resource to search in.	-
query	String	String to search for.	-
caseSensitive	Boolean	If true, search is case sensitive.	[OPTIONAL]
isRegex	Boolean	If true, treats string parameter as regex.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
result	Array (of) $REF: Debugger.SearchMatch	List of search matches.	-

setAdBlockingEnabled

Enable Chrome's experimental ad filter on all sites.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
enabled	Boolean	Whether to block ads.	-

setBypassCSP

Enable page Content Security Policy by-passing.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
enabled	Boolean	Whether to bypass page CSP.	-

getPermissionsPolicyState

Get Permissions Policy state on given frame.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
frameId	$REF: FrameId	-	-

RETURNS:

Name	Type	Description	Flags
states	Array (of) $REF: PermissionsPolicyFeatureState	-	-

getOriginTrials

Get Origin Trials on given frame.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
frameId	$REF: FrameId	-	-

RETURNS:

Name	Type	Description	Flags
originTrials	Array (of) $REF: OriginTrial	-	-

setDeviceMetricsOverride
REDIRECT: Emulation

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).

[EXPERIMENTAL]
[DEPRECATED]

PARAMETERS:

Name	Type	Description	Flags
width	Integer	Overriding width value in pixels (minimum 0, maximum 10000000). 0 disables the override.	-
height	Integer	Overriding height value in pixels (minimum 0, maximum 10000000). 0 disables the override.	-
deviceScaleFactor	Number	Overriding device scale factor value. 0 disables the override.	-
mobile	Boolean	Whether to emulate mobile device. This includes viewport meta tag, overlay scrollbars, text autosizing and more.	-
scale	Number	Scale to apply to resulting view image.	[OPTIONAL]
screenWidth	Integer	Overriding screen width value in pixels (minimum 0, maximum 10000000).	[OPTIONAL]
screenHeight	Integer	Overriding screen height value in pixels (minimum 0, maximum 10000000).	[OPTIONAL]
positionX	Integer	Overriding view X position on screen in pixels (minimum 0, maximum 10000000).	[OPTIONAL]
positionY	Integer	Overriding view Y position on screen in pixels (minimum 0, maximum 10000000).	[OPTIONAL]
dontSetVisibleSize	Boolean	Do not set visible view size, rely upon explicit setVisibleSize call.	[OPTIONAL]
screenOrientation	$REF: Emulation.ScreenOrientation	Screen orientation override.	[OPTIONAL]
viewport	$REF: Viewport	The viewport dimensions and scale. If not set, the override is cleared.	[OPTIONAL]

setDeviceOrientationOverride
REDIRECT: DeviceOrientation

Overrides the Device Orientation.

[EXPERIMENTAL]
[DEPRECATED]

PARAMETERS:

Name	Type	Description	Flags
alpha	Number	Mock alpha	-
beta	Number	Mock beta	-
gamma	Number	Mock gamma	-

setFontFamilies

Set generic font families.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
fontFamilies	$REF: FontFamilies	Specifies font families to set. If a font family is not specified, it won't be changed.	-

setFontSizes

Set default font sizes.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
fontSizes	$REF: FontSizes	Specifies font sizes to set. If a font size is not specified, it won't be changed.	-

setDocumentContent

Sets given markup as the document's HTML.

-

PARAMETERS:

Name	Type	Description	Flags
frameId	$REF: FrameId	Frame id to set HTML for.	-
html	String	HTML content to set.	-

setDownloadBehavior

Set the behavior when downloading a file.

[EXPERIMENTAL]
[DEPRECATED]

PARAMETERS:

Name	Type	Description	Flags
behavior	"deny", "allow", "default"String [Hover] Enum	Whether to allow all or deny all download requests, or use default Chrome behavior if available (otherwise deny).	-
downloadPath	String	The default path to save downloaded files to. This is required if behavior is set to 'allow'	[OPTIONAL]

setGeolocationOverride
REDIRECT: Emulation

Overrides the Geolocation Position or Error. Omitting any of the parameters emulates position unavailable.

[DEPRECATED]

PARAMETERS:

Name	Type	Description	Flags
latitude	Number	Mock latitude	[OPTIONAL]
longitude	Number	Mock longitude	[OPTIONAL]
accuracy	Number	Mock accuracy	[OPTIONAL]

setLifecycleEventsEnabled

Controls whether page will emit lifecycle events.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
enabled	Boolean	If true, starts emitting lifecycle events.	-

setTouchEmulationEnabled
REDIRECT: Emulation

Toggles mouse event-based touch event emulation.

[EXPERIMENTAL]
[DEPRECATED]

PARAMETERS:

Name	Type	Description	Flags
enabled	Boolean	Whether the touch event emulation should be enabled.	-
configuration	"mobile", "desktop"String [Hover] Enum	Touch/gesture events configuration. Default: current platform.	[OPTIONAL]

startScreencast

Starts sending each frame using the `screencastFrame` event.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
format	"jpeg", "png"String [Hover] Enum	Image compression format.	[OPTIONAL]
quality	Integer	Compression quality from range [0..100].	[OPTIONAL]
maxWidth	Integer	Maximum screenshot width.	[OPTIONAL]
maxHeight	Integer	Maximum screenshot height.	[OPTIONAL]
everyNthFrame	Integer	Send every n-th frame.	[OPTIONAL]

stopLoading

Force the page stop all navigations and pending resource fetches.

-

crash

Crashes renderer on the IO thread, generates minidumps.

[EXPERIMENTAL]

close

Tries to close page, running its beforeunload hooks, if any.

[EXPERIMENTAL]

setWebLifecycleState

Tries to update the web lifecycle state of the page. It will transition the page to the given state according to: https://github.com/WICG/web-lifecycle/

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
state	"frozen", "active"String [Hover] Enum	Target lifecycle state	-

stopScreencast

Stops sending each frame in the `screencastFrame`.

[EXPERIMENTAL]

produceCompilationCache

Requests backend to produce compilation cache for the specified scripts. `scripts` are appeneded to the list of scripts for which the cache would be produced. The list may be reset during page navigation. When script with a matching URL is encountered, the cache is optionally produced upon backend discretion, based on internal heuristics. See also: `Page.compilationCacheProduced`.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
scripts	Array (of) $REF: CompilationCacheParams	-	-

addCompilationCache

Seeds compilation cache for given url. Compilation cache does not survive cross-process navigation.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
url	String	-	-
data	String	Base64-encoded data (Encoded as a base64 string when passed over JSON)	-

clearCompilationCache

Clears seeded compilation cache.

[EXPERIMENTAL]

generateTestReport

Generates a report for testing.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
message	String	Message to be displayed in the report.	-
group	String	Specifies the endpoint group to deliver the report to.	[OPTIONAL]

waitForDebugger

Pauses page execution. Can be resumed using generic Runtime.runIfWaitingForDebugger.

[EXPERIMENTAL]

setInterceptFileChooserDialog

Intercept file chooser requests and transfer control to protocol clients. When file chooser interception is enabled, native file chooser dialog is not shown. Instead, a protocol event `Page.fileChooserOpened` is emitted.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
enabled	Boolean	-	-

events

Name

Description

Flags

domContentEventFired

-

PARAMETERS:

Name	Type	Description	Flags
timestamp	$REF: Network.MonotonicTime	-	-

fileChooserOpened

Emitted only when `page.interceptFileChooser` is enabled.

-

PARAMETERS:

Name	Type	Description	Flags
frameId	$REF: FrameId	Id of the frame containing input node.	[EXPERIMENTAL]
backendNodeId	$REF: DOM.BackendNodeId	Input node id.	[EXPERIMENTAL]
mode	"selectSingle", "selectMultiple"String [Hover] Enum	Input mode.	-

frameAttached

Fired when frame has been attached to its parent.

-

PARAMETERS:

Name	Type	Description	Flags
frameId	$REF: FrameId	Id of the frame that has been attached.	-
parentFrameId	$REF: FrameId	Parent frame identifier.	-
stack	$REF: Runtime.StackTrace	JavaScript stack trace of when frame was attached, only set if frame initiated from script.	[OPTIONAL]

frameClearedScheduledNavigation

Fired when frame no longer has a scheduled navigation.

[DEPRECATED]

PARAMETERS:

Name	Type	Description	Flags
frameId	$REF: FrameId	Id of the frame that has cleared its scheduled navigation.	-

frameDetached

Fired when frame has been detached from its parent.

-

PARAMETERS:

Name	Type	Description	Flags
frameId	$REF: FrameId	Id of the frame that has been detached.	-
reason	"remove", "swap"String [Hover] Enum	-	[EXPERIMENTAL]

frameNavigated

Fired once navigation of the frame has completed. Frame is now associated with the new loader.

-

PARAMETERS:

Name	Type	Description	Flags
frame	$REF: Frame	Frame object.	-
type	$REF: NavigationType	-	[EXPERIMENTAL]

documentOpened

Fired when opening document to write to.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
frame	$REF: Frame	Frame object.	-

frameResized

-

[EXPERIMENTAL]

frameRequestedNavigation

Fired when a renderer-initiated navigation is requested. Navigation may still be cancelled after the event is issued.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
frameId	$REF: FrameId	Id of the frame that is being navigated.	-
reason	$REF: ClientNavigationReason	The reason for the navigation.	-
url	String	The destination URL for the requested navigation.	-
disposition	$REF: ClientNavigationDisposition	The disposition for the navigation.	-

frameScheduledNavigation

Fired when frame schedules a potential navigation.

[DEPRECATED]

PARAMETERS:

Name	Type	Description	Flags
frameId	$REF: FrameId	Id of the frame that has scheduled a navigation.	-
delay	Number	Delay (in seconds) until the navigation is scheduled to begin. The navigation is not guaranteed to start.	-
reason	$REF: ClientNavigationReason	The reason for the navigation.	-
url	String	The destination URL for the scheduled navigation.	-

frameStartedLoading

Fired when frame has started loading.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
frameId	$REF: FrameId	Id of the frame that has started loading.	-

frameStoppedLoading

Fired when frame has stopped loading.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
frameId	$REF: FrameId	Id of the frame that has stopped loading.	-

downloadWillBegin

Fired when page is about to start a download. Deprecated. Use Browser.downloadWillBegin instead.

[EXPERIMENTAL]
[DEPRECATED]

PARAMETERS:

Name	Type	Description	Flags
frameId	$REF: FrameId	Id of the frame that caused download to begin.	-
guid	String	Global unique identifier of the download.	-
url	String	URL of the resource being downloaded.	-
suggestedFilename	String	Suggested file name of the resource (the actual name of the file saved on disk may differ).	-

downloadProgress

Fired when download makes progress. Last call has |done| == true. Deprecated. Use Browser.downloadProgress instead.

[EXPERIMENTAL]
[DEPRECATED]

PARAMETERS:

Name	Type	Description	Flags
guid	String	Global unique identifier of the download.	-
totalBytes	Number	Total expected bytes to download.	-
receivedBytes	Number	Total bytes received.	-
state	"inProgress", "completed", "canceled"String [Hover] Enum	Download status.	-

interstitialHidden

Fired when interstitial page was hidden

-

interstitialShown

Fired when interstitial page was shown

-

javascriptDialogClosed

Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) has been closed.

-

PARAMETERS:

Name	Type	Description	Flags
result	Boolean	Whether dialog was confirmed.	-
userInput	String	User input in case of prompt.	-

javascriptDialogOpening

Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) is about to open.

-

PARAMETERS:

Name	Type	Description	Flags
url	String	Frame url.	-
message	String	Message that will be displayed by the dialog.	-
type	$REF: DialogType	Dialog type.	-
hasBrowserHandler	Boolean	True iff browser is capable showing or acting on the given dialog. When browser has no dialog handler for given target, calling alert while Page domain is engaged will stall the page execution. Execution can be resumed via calling Page.handleJavaScriptDialog.	-
defaultPrompt	String	Default dialog prompt.	[OPTIONAL]

lifecycleEvent

Fired for top level page lifecycle events such as navigation, load, paint, etc.

-

PARAMETERS:

Name	Type	Description	Flags
frameId	$REF: FrameId	Id of the frame.	-
loaderId	$REF: Network.LoaderId	Loader identifier. Empty string if the request is fetched from worker.	-
name	String	-	-
timestamp	$REF: Network.MonotonicTime	-	-

backForwardCacheNotUsed

Fired for failed bfcache history navigations if BackForwardCache feature is enabled. Do not assume any ordering with the Page.frameNavigated event. This event is fired only for main-frame history navigation where the document changes (non-same-document navigations), when bfcache navigation fails.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
loaderId	$REF: Network.LoaderId	The loader id for the associated navgation.	-
frameId	$REF: FrameId	The frame id of the associated frame.	-
notRestoredExplanations	Array (of) $REF: BackForwardCacheNotRestoredExplanation	Array of reasons why the page could not be cached. This must not be empty.	-

loadEventFired

-

PARAMETERS:

Name	Type	Description	Flags
timestamp	$REF: Network.MonotonicTime	-	-

navigatedWithinDocument

Fired when same-document navigation happens, e.g. due to history API usage or anchor navigation.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
frameId	$REF: FrameId	Id of the frame.	-
url	String	Frame's new url.	-

screencastFrame

Compressed image data requested by the `startScreencast`.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
data	String	Base64-encoded compressed image. (Encoded as a base64 string when passed over JSON)	-
metadata	$REF: ScreencastFrameMetadata	Screencast frame metadata.	-
sessionId	Integer	Frame number.	-

screencastVisibilityChanged

Fired when the page with currently enabled screencast was shown or hidden `.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
visible	Boolean	True if the page is visible.	-

windowOpen

Fired when a new window is going to be opened, via window.open(), link click, form submission, etc.

-

PARAMETERS:

Name	Type	Description	Flags
url	String	The URL for the new window.	-
windowName	String	Window name.	-
windowFeatures	Array (of) String	An array of enabled window features.	-
userGesture	Boolean	Whether or not it was triggered by user gesture.	-

compilationCacheProduced

Issued for every compilation cache generated. Is only available if Page.setGenerateCompilationCache is enabled.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
url	String	-	-
data	String	Base64-encoded data (Encoded as a base64 string when passed over JSON)	-

Performance

-

PerformanceTimeline

[Experimental]

Reporting of performance timeline events, as specified in https://w3c.github.io/performance-timeline/#dom-performanceobserver.

Dependencies: DOM, Network

types

Type ID

Type

Description

Flags

LargestContentfulPaint

Object

See https://github.com/WICG/LargestContentfulPaint and largest_contentful_paint.idl

-

PROPERTIES:

Name	Type	Description	Flags
renderTime	$REF: Network.TimeSinceEpoch	-	-
loadTime	$REF: Network.TimeSinceEpoch	-	-
size	Number	The number of pixels being painted.	-
elementId	String	The id attribute of the element, if available.	[OPTIONAL]
url	String	The URL of the image (may be trimmed).	[OPTIONAL]
nodeId	$REF: DOM.BackendNodeId	-	[OPTIONAL]

LayoutShiftAttribution

Object

-

PROPERTIES:

Name	Type	Description	Flags
previousRect	$REF: DOM.Rect	-	-
currentRect	$REF: DOM.Rect	-	-
nodeId	$REF: DOM.BackendNodeId	-	[OPTIONAL]

LayoutShift

Object

See https://wicg.github.io/layout-instability/#sec-layout-shift and layout_shift.idl

-

PROPERTIES:

Name	Type	Description	Flags
value	Number	Score increment produced by this event.	-
hadRecentInput	Boolean	-	-
lastInputTime	$REF: Network.TimeSinceEpoch	-	-
sources	Array (of) $REF: LayoutShiftAttribution	-	-

TimelineEvent

Object

-

PROPERTIES:

Name	Type	Description	Flags
frameId	$REF: Page.FrameId	Identifies the frame that this event is related to. Empty for non-frame targets.	-
type	String	The event type, as specified in https://w3c.github.io/performance-timeline/#dom-performanceentry-entrytype This determines which of the optional "details" fiedls is present.	-
name	String	Name may be empty depending on the type.	-
time	$REF: Network.TimeSinceEpoch	Time in seconds since Epoch, monotonically increasing within document lifetime.	-
duration	Number	Event duration, if applicable.	[OPTIONAL]
lcpDetails	$REF: LargestContentfulPaint	-	[OPTIONAL]
layoutShiftDetails	$REF: LayoutShift	-	[OPTIONAL]

Security

types

Type ID

Type

Description

Flags

CertificateId

Integer

An internal certificate ID value.

-

MixedContentType

A description of mixed content (HTTP resources on HTTPS pages), as defined by https://www.w3.org/TR/mixed-content/#categories

-

SecurityState

The security level of a page or resource.

-

CertificateSecurityState

Object

Details about the security state of the page certificate.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
protocol	String	Protocol name (e.g. "TLS 1.2" or "QUIC").	-
keyExchange	String	Key Exchange used by the connection, or the empty string if not applicable.	-
keyExchangeGroup	String	(EC)DH group used by the connection, if applicable.	[OPTIONAL]
cipher	String	Cipher name.	-
mac	String	TLS MAC. Note that AEAD ciphers do not have separate MACs.	[OPTIONAL]
certificate	Array (of) String	Page certificate.	-
subjectName	String	Certificate subject name.	-
issuer	String	Name of the issuing CA.	-
validFrom	$REF: Network.TimeSinceEpoch	Certificate valid from date.	-
validTo	$REF: Network.TimeSinceEpoch	Certificate valid to (expiration) date	-
certificateNetworkError	String	The highest priority network error code, if the certificate has an error.	[OPTIONAL]
certificateHasWeakSignature	Boolean	True if the certificate uses a weak signature aglorithm.	-
certificateHasSha1Signature	Boolean	True if the certificate has a SHA1 signature in the chain.	-
modernSSL	Boolean	True if modern SSL	-
obsoleteSslProtocol	Boolean	True if the connection is using an obsolete SSL protocol.	-
obsoleteSslKeyExchange	Boolean	True if the connection is using an obsolete SSL key exchange.	-
obsoleteSslCipher	Boolean	True if the connection is using an obsolete SSL cipher.	-
obsoleteSslSignature	Boolean	True if the connection is using an obsolete SSL signature.	-

SafetyTipStatus

-

[EXPERIMENTAL]

SafetyTipInfo

Object

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
safetyTipStatus	$REF: SafetyTipStatus	Describes whether the page triggers any safety tips or reputation warnings. Default is unknown.	-
safeUrl	String	The URL the safety tip suggested ("Did you mean?"). Only filled in for lookalike matches.	[OPTIONAL]

VisibleSecurityState

Object

Security state information about the page.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
securityState	$REF: SecurityState	The security level of the page.	-
certificateSecurityState	$REF: CertificateSecurityState	Security state details about the page certificate.	[OPTIONAL]
safetyTipInfo	$REF: SafetyTipInfo	The type of Safety Tip triggered on the page. Note that this field will be set even if the Safety Tip UI was not actually shown.	[OPTIONAL]
securityStateIssueIds	Array (of) String	Array of security state issues ids.	-

SecurityStateExplanation

Object

An explanation of an factor contributing to the security state.

-

PROPERTIES:

Name	Type	Description	Flags
securityState	$REF: SecurityState	Security state representing the severity of the factor being explained.	-
title	String	Title describing the type of factor.	-
summary	String	Short phrase describing the type of factor.	-
description	String	Full text explanation of the factor.	-
mixedContentType	$REF: MixedContentType	The type of mixed content described by the explanation.	-
certificate	Array (of) String	Page certificate.	-
recommendations	Array (of) String	Recommendations to fix any issues.	[OPTIONAL]

InsecureContentStatus

Object

Information about insecure content on the page.

[DEPRECATED]

PROPERTIES:

Name	Type	Description	Flags
ranMixedContent	Boolean	Always false.	-
displayedMixedContent	Boolean	Always false.	-
containedMixedForm	Boolean	Always false.	-
ranContentWithCertErrors	Boolean	Always false.	-
displayedContentWithCertErrors	Boolean	Always false.	-
ranInsecureContentStyle	$REF: SecurityState	Always set to unknown.	-
displayedInsecureContentStyle	$REF: SecurityState	Always set to unknown.	-

CertificateErrorAction

The action to take when a certificate error occurs. continue will continue processing the request and cancel will cancel the request.

-

events

Name

Description

Flags

certificateError

There is a certificate error. If overriding certificate errors is enabled, then it should be handled with the `handleCertificateError` command. Note: this event does not fire if the certificate error has been allowed internally. Only one client per target should override certificate errors at the same time.

[DEPRECATED]

PARAMETERS:

Name	Type	Description	Flags
eventId	Integer	The ID of the event.	-
errorType	String	The type of the error.	-
requestURL	String	The url that was requested.	-

visibleSecurityStateChanged

The security state of the page changed.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
visibleSecurityState	$REF: VisibleSecurityState	Security state information about the page.	-

securityStateChanged

The security state of the page changed.

-

PARAMETERS:

Name	Type	Description	Flags
securityState	$REF: SecurityState	Security state.	-
schemeIsCryptographic	Boolean	True if the page was loaded over cryptographic transport such as HTTPS.	[DEPRECATED]
explanations	Array (of) $REF: SecurityStateExplanation	List of explanations for the security state. If the overall security state is `insecure` or `warning`, at least one corresponding explanation should be included.	-
insecureContentStatus	$REF: InsecureContentStatus	Information about insecure content on the page.	[DEPRECATED]
summary	String	Overrides user-visible description of the state.	[OPTIONAL]

ServiceWorker

[Experimental]

-

Dependencies: Target

types

Type ID

Type

Description

Flags

RegistrationID

String

-

ServiceWorkerRegistration

Object

ServiceWorker registration.

-

PROPERTIES:

Name	Type	Description	Flags
registrationId	$REF: RegistrationID	-	-
scopeURL	String	-	-
isDeleted	Boolean	-	-

ServiceWorkerVersionRunningStatus

-

ServiceWorkerVersionStatus

-

ServiceWorkerVersion

Object

ServiceWorker version.

-

PROPERTIES:

Name	Type	Description	Flags
versionId	String	-	-
registrationId	$REF: RegistrationID	-	-
scriptURL	String	-	-
runningStatus	$REF: ServiceWorkerVersionRunningStatus	-	-
status	$REF: ServiceWorkerVersionStatus	-	-
scriptLastModified	Number	The Last-Modified header value of the main script.	[OPTIONAL]
scriptResponseTime	Number	The time at which the response headers of the main script were received from the server. For cached script it is the last time the cache entry was validated.	[OPTIONAL]
controlledClients	Array (of) $REF: Target.TargetID	-	[OPTIONAL]
targetId	$REF: Target.TargetID	-	[OPTIONAL]

ServiceWorkerErrorMessage

Object

ServiceWorker error message.

-

PROPERTIES:

Name	Type	Description	Flags
errorMessage	String	-	-
registrationId	$REF: RegistrationID	-	-
versionId	String	-	-
sourceURL	String	-	-
lineNumber	Integer	-	-
columnNumber	Integer	-	-

commands

Name

Description

Flags

deliverPushMessage

-

PARAMETERS:

Name	Type	Description	Flags
origin	String	-	-
registrationId	$REF: RegistrationID	-	-
data	String	-	-

disable

-

dispatchSyncEvent

-

PARAMETERS:

Name	Type	Description	Flags
origin	String	-	-
registrationId	$REF: RegistrationID	-	-
tag	String	-	-
lastChance	Boolean	-	-

dispatchPeriodicSyncEvent

-

PARAMETERS:

Name	Type	Description	Flags
origin	String	-	-
registrationId	$REF: RegistrationID	-	-
tag	String	-	-

enable

-

inspectWorker

-

PARAMETERS:

Name	Type	Description	Flags
versionId	String	-	-

setForceUpdateOnPageLoad

-

PARAMETERS:

Name	Type	Description	Flags
forceUpdateOnPageLoad	Boolean	-	-

skipWaiting

-

PARAMETERS:

Name	Type	Description	Flags
scopeURL	String	-	-

startWorker

-

PARAMETERS:

Name	Type	Description	Flags
scopeURL	String	-	-

stopAllWorkers

-

stopWorker

-

PARAMETERS:

Name	Type	Description	Flags
versionId	String	-	-

unregister

-

PARAMETERS:

Name	Type	Description	Flags
scopeURL	String	-	-

updateRegistration

-

PARAMETERS:

Name	Type	Description	Flags
scopeURL	String	-	-

Storage

[Experimental]

-

Dependencies: Browser, Network

commands

Name

Description

Flags

clearDataForOrigin

Clears storage for origin.

-

PARAMETERS:

Name	Type	Description	Flags
origin	String	Security origin.	-
storageTypes	String	Comma separated list of StorageType to clear.	-

getCookies

Returns all browser cookies.

-

PARAMETERS:

Name	Type	Description	Flags
browserContextId	$REF: Browser.BrowserContextID	Browser context to use when called on the browser endpoint.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
cookies	Array (of) $REF: Network.Cookie	Array of cookie objects.	-

setCookies

Sets given cookies.

-

PARAMETERS:

Name	Type	Description	Flags
cookies	Array (of) $REF: Network.CookieParam	Cookies to be set.	-
browserContextId	$REF: Browser.BrowserContextID	Browser context to use when called on the browser endpoint.	[OPTIONAL]

clearCookies

Clears cookies.

-

PARAMETERS:

Name	Type	Description	Flags
browserContextId	$REF: Browser.BrowserContextID	Browser context to use when called on the browser endpoint.	[OPTIONAL]

getUsageAndQuota

Returns usage and quota in bytes.

-

PARAMETERS:

Name	Type	Description	Flags
origin	String	Security origin.	-

RETURNS:

Name	Type	Description	Flags
usage	Number	Storage usage (bytes).	-
quota	Number	Storage quota (bytes).	-
overrideActive	Boolean	Whether or not the origin has an active storage quota override	-
usageBreakdown	Array (of) $REF: UsageForType	Storage usage per type (bytes).	-

overrideQuotaForOrigin

Override quota for the specified origin

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
origin	String	Security origin.	-
quotaSize	Number	The quota size (in bytes) to override the original quota with. If this is called multiple times, the overridden quota will be equal to the quotaSize provided in the final call. If this is called without specifying a quotaSize, the quota will be reset to the default value for the specified origin. If this is called multiple times with different origins, the override will be maintained for each origin until it is disabled (called without a quotaSize).	[OPTIONAL]

trackCacheStorageForOrigin

Registers origin to be notified when an update occurs to its cache storage list.

-

PARAMETERS:

Name	Type	Description	Flags
origin	String	Security origin.	-

trackIndexedDBForOrigin

Registers origin to be notified when an update occurs to its IndexedDB.

-

PARAMETERS:

Name	Type	Description	Flags
origin	String	Security origin.	-

untrackCacheStorageForOrigin

Unregisters origin from receiving notifications for cache storage.

-

PARAMETERS:

Name	Type	Description	Flags
origin	String	Security origin.	-

untrackIndexedDBForOrigin

Unregisters origin from receiving notifications for IndexedDB.

-

PARAMETERS:

Name	Type	Description	Flags
origin	String	Security origin.	-

getTrustTokens

Returns the number of stored Trust Tokens per issuer for the current browsing context.

[EXPERIMENTAL]

RETURNS:

Name	Type	Description	Flags
tokens	Array (of) $REF: TrustTokens	-	-

clearTrustTokens

Removes all Trust Tokens issued by the provided issuerOrigin. Leaves other stored data, including the issuer's Redemption Records, intact.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
issuerOrigin	String	-	-

RETURNS:

Name	Type	Description	Flags
didDeleteTokens	Boolean	True if any tokens were deleted, false otherwise.	-

SystemInfo

[Experimental]

The SystemInfo domain defines methods and events for querying low-level system information.

types

Type ID

Type

Description

Flags

GPUDevice

Object

Describes a single graphics processor (GPU).

-

PROPERTIES:

Name	Type	Description	Flags
vendorId	Number	PCI ID of the GPU vendor, if available; 0 otherwise.	-
deviceId	Number	PCI ID of the GPU device, if available; 0 otherwise.	-
subSysId	Number	Sub sys ID of the GPU, only available on Windows.	[OPTIONAL]
revision	Number	Revision of the GPU, only available on Windows.	[OPTIONAL]
vendorString	String	String description of the GPU vendor, if the PCI ID is not available.	-
deviceString	String	String description of the GPU device, if the PCI ID is not available.	-
driverVendor	String	String description of the GPU driver vendor.	-
driverVersion	String	String description of the GPU driver version.	-

Size

Object

Describes the width and height dimensions of an entity.

-

PROPERTIES:

Name	Type	Description	Flags
width	Integer	Width in pixels.	-
height	Integer	Height in pixels.	-

VideoDecodeAcceleratorCapability

Object

Describes a supported video decoding profile with its associated minimum and maximum resolutions.

-

PROPERTIES:

Name	Type	Description	Flags
profile	String	Video codec profile that is supported, e.g. VP9 Profile 2.	-
maxResolution	$REF: Size	Maximum video dimensions in pixels supported for this \|profile\|.	-
minResolution	$REF: Size	Minimum video dimensions in pixels supported for this \|profile\|.	-

VideoEncodeAcceleratorCapability

Object

Describes a supported video encoding profile with its associated maximum resolution and maximum framerate.

-

PROPERTIES:

Name	Type	Description	Flags
profile	String	Video codec profile that is supported, e.g H264 Main.	-
maxResolution	$REF: Size	Maximum video dimensions in pixels supported for this \|profile\|.	-
maxFramerateNumerator	Integer	Maximum encoding framerate in frames per second supported for this \|profile\|, as fraction's numerator and denominator, e.g. 24/1 fps, 24000/1001 fps, etc.	-
maxFramerateDenominator	Integer	-	-

SubsamplingFormat

YUV subsampling type of the pixels of a given image.

-

ImageType

Image format of a given image.

-

ImageDecodeAcceleratorCapability

Object

Describes a supported image decoding profile with its associated minimum and maximum resolutions and subsampling.

-

PROPERTIES:

Name	Type	Description	Flags
imageType	$REF: ImageType	Image coded, e.g. Jpeg.	-
maxDimensions	$REF: Size	Maximum supported dimensions of the image in pixels.	-
minDimensions	$REF: Size	Minimum supported dimensions of the image in pixels.	-
subsamplings	Array (of) $REF: SubsamplingFormat	Optional array of supported subsampling formats, e.g. 4:2:0, if known.	-

GPUInfo

Object

Provides information about the GPU(s) on the system.

-

PROPERTIES:

Name	Type	Description	Flags
devices	Array (of) $REF: GPUDevice	The graphics devices on the system. Element 0 is the primary GPU.	-
auxAttributes	Object	An optional dictionary of additional GPU related attributes.	[OPTIONAL]
featureStatus	Object	An optional dictionary of graphics features and their status.	[OPTIONAL]
driverBugWorkarounds	Array (of) String	An optional array of GPU driver bug workarounds.	-
videoDecoding	Array (of) $REF: VideoDecodeAcceleratorCapability	Supported accelerated video decoding capabilities.	-
videoEncoding	Array (of) $REF: VideoEncodeAcceleratorCapability	Supported accelerated video encoding capabilities.	-
imageDecoding	Array (of) $REF: ImageDecodeAcceleratorCapability	Supported accelerated image decoding capabilities.	-

ProcessInfo

Object

Represents process info.

-

PROPERTIES:

Name	Type	Description	Flags
type	String	Specifies process type.	-
id	Integer	Specifies process id.	-
cpuTime	Number	Specifies cumulative CPU usage in seconds across all threads of the process since the process start.	-

Target

Supports additional targets discovery and allows to attach to them.

types

Type ID

Type

Description

Flags

TargetID

String

-

SessionID

String

Unique identifier of attached debugging session.

-

TargetInfo

Object

-

PROPERTIES:

Name	Type	Description	Flags
targetId	$REF: TargetID	-	-
type	String	-	-
title	String	-	-
url	String	-	-
attached	Boolean	Whether the target has an attached client.	-
openerId	$REF: TargetID	Opener target Id	[OPTIONAL]
canAccessOpener	Boolean	Whether the target has access to the originating window.	[EXPERIMENTAL]
openerFrameId	$REF: Page.FrameId	Frame id of originating window (is only set if target has an opener).	[OPTIONAL] [EXPERIMENTAL]
browserContextId	$REF: Browser.BrowserContextID	-	[OPTIONAL] [EXPERIMENTAL]

RemoteLocation

Object

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
host	String	-	-
port	Integer	-	-

commands

Name

Description

Flags

activateTarget

Activates (focuses) the target.

-

PARAMETERS:

Name	Type	Description	Flags
targetId	$REF: TargetID	-	-

attachToTarget

Attaches to the target with given id.

-

PARAMETERS:

Name	Type	Description	Flags
targetId	$REF: TargetID	-	-
flatten	Boolean	Enables "flat" access to the session via specifying sessionId attribute in the commands. We plan to make this the default, deprecate non-flattened mode, and eventually retire it. See crbug.com/991325.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
sessionId	$REF: SessionID	Id assigned to the session.	-

attachToBrowserTarget

Attaches to the browser target, only uses flat sessionId mode.

[EXPERIMENTAL]

RETURNS:

Name	Type	Description	Flags
sessionId	$REF: SessionID	Id assigned to the session.	-

closeTarget

Closes the target. If the target is a page that gets closed too.

-

PARAMETERS:

Name	Type	Description	Flags
targetId	$REF: TargetID	-	-

RETURNS:

Name	Type	Description	Flags
success	Boolean	Always set to true. If an error occurs, the response indicates protocol error.	[DEPRECATED]

exposeDevToolsProtocol

Inject object to the target's main frame that provides a communication channel with browser target. Injected object will be available as `window[bindingName]`. The object has the follwing API: - `binding.send(json)` - a method to send messages over the remote debugging protocol - `binding.onmessage = json => handleMessage(json)` - a callback that will be called for the protocol notifications and command responses.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
targetId	$REF: TargetID	-	-
bindingName	String	Binding name, 'cdp' if not specified.	[OPTIONAL]

createBrowserContext

Creates a new empty BrowserContext. Similar to an incognito profile but you can have more than one.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
disposeOnDetach	Boolean	If specified, disposes this context when debugging session disconnects.	[OPTIONAL]
proxyServer	String	Proxy server, similar to the one passed to --proxy-server	[OPTIONAL]
proxyBypassList	String	Proxy bypass list, similar to the one passed to --proxy-bypass-list	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
browserContextId	$REF: Browser.BrowserContextID	The id of the context created.	-

getBrowserContexts

Returns all browser contexts created with `Target.createBrowserContext` method.

[EXPERIMENTAL]

RETURNS:

Name	Type	Description	Flags
browserContextIds	Array (of) $REF: Browser.BrowserContextID	An array of browser context ids.	-

createTarget

Creates a new page.

-

PARAMETERS:

Name	Type	Description	Flags
url	String	The initial URL the page will be navigated to. An empty string indicates about:blank.	-
width	Integer	Frame width in DIP (headless chrome only).	[OPTIONAL]
height	Integer	Frame height in DIP (headless chrome only).	[OPTIONAL]
browserContextId	$REF: Browser.BrowserContextID	The browser context to create the page in.	[OPTIONAL] [EXPERIMENTAL]
enableBeginFrameControl	Boolean	Whether BeginFrames for this target will be controlled via DevTools (headless chrome only, not supported on MacOS yet, false by default).	[OPTIONAL] [EXPERIMENTAL]
newWindow	Boolean	Whether to create a new Window or Tab (chrome-only, false by default).	[OPTIONAL]
background	Boolean	Whether to create the target in background or foreground (chrome-only, false by default).	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
targetId	$REF: TargetID	The id of the page opened.	-

detachFromTarget

Detaches session with given id.

-

PARAMETERS:

Name	Type	Description	Flags
sessionId	$REF: SessionID	Session to detach.	[OPTIONAL]
targetId	$REF: TargetID	Deprecated.	[OPTIONAL] [DEPRECATED]

disposeBrowserContext

Deletes a BrowserContext. All the belonging pages will be closed without calling their beforeunload hooks.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
browserContextId	$REF: Browser.BrowserContextID	-	-

getTargetInfo

Returns information about a target.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
targetId	$REF: TargetID	-	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
targetInfo	$REF: TargetInfo	-	-

getTargets

Retrieves a list of available targets.

-

RETURNS:

Name	Type	Description	Flags
targetInfos	Array (of) $REF: TargetInfo	The list of targets.	-

sendMessageToTarget

Sends protocol message over session with given id. Consider using flat mode instead; see commands attachToTarget, setAutoAttach, and crbug.com/991325.

[DEPRECATED]

PARAMETERS:

Name	Type	Description	Flags
message	String	-	-
sessionId	$REF: SessionID	Identifier of the session.	[OPTIONAL]
targetId	$REF: TargetID	Deprecated.	[OPTIONAL] [DEPRECATED]

setAutoAttach

Controls whether to automatically attach to new targets which are considered to be related to this one. When turned on, attaches to all existing related targets as well. When turned off, automatically detaches from all currently attached targets. This also clears all targets added by `autoAttachRelated` from the list of targets to watch for creation of related targets.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
autoAttach	Boolean	Whether to auto-attach to related targets.	-
waitForDebuggerOnStart	Boolean	Whether to pause new targets when attaching to them. Use `Runtime.runIfWaitingForDebugger` to run paused targets.	-
flatten	Boolean	Enables "flat" access to the session via specifying sessionId attribute in the commands. We plan to make this the default, deprecate non-flattened mode, and eventually retire it. See crbug.com/991325.	[OPTIONAL]

autoAttachRelated

Adds the specified target to the list of targets that will be monitored for any related target creation (such as child frames, child workers and new versions of service worker) and reported through `attachedToTarget`. The specified target is also auto-attached. This cancels the effect of any previous `setAutoAttach` and is also cancelled by subsequent `setAutoAttach`. Only available at the Browser target.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
targetId	$REF: TargetID	-	-
waitForDebuggerOnStart	Boolean	Whether to pause new targets when attaching to them. Use `Runtime.runIfWaitingForDebugger` to run paused targets.	-

setDiscoverTargets

Controls whether to discover available targets and notify via `targetCreated/targetInfoChanged/targetDestroyed` events.

-

PARAMETERS:

Name	Type	Description	Flags
discover	Boolean	Whether to discover available targets.	-

setRemoteLocations

Enables target discovery for the specified locations, when `setDiscoverTargets` was set to `true`.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
locations	Array (of) $REF: RemoteLocation	List of remote locations.	-

events

Name

Description

Flags

attachedToTarget

Issued when attached to target because of auto-attach or `attachToTarget` command.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
sessionId	$REF: SessionID	Identifier assigned to the session used to send/receive messages.	-
targetInfo	$REF: TargetInfo	-	-
waitingForDebugger	Boolean	-	-

detachedFromTarget

Issued when detached from target for any reason (including `detachFromTarget` command). Can be issued multiple times per target if multiple sessions have been attached to it.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
sessionId	$REF: SessionID	Detached session identifier.	-
targetId	$REF: TargetID	Deprecated.	[OPTIONAL] [DEPRECATED]

receivedMessageFromTarget

Notifies about a new protocol message received from the session (as reported in `attachedToTarget` event).

-

PARAMETERS:

Name	Type	Description	Flags
sessionId	$REF: SessionID	Identifier of a session which sends a message.	-
message	String	-	-
targetId	$REF: TargetID	Deprecated.	[OPTIONAL] [DEPRECATED]

targetCreated

Issued when a possible inspection target is created.

-

PARAMETERS:

Name	Type	Description	Flags
targetInfo	$REF: TargetInfo	-	-

targetDestroyed

Issued when a target is destroyed.

-

PARAMETERS:

Name	Type	Description	Flags
targetId	$REF: TargetID	-	-

targetCrashed

Issued when a target has crashed.

-

PARAMETERS:

Name	Type	Description	Flags
targetId	$REF: TargetID	-	-
status	String	Termination status type.	-
errorCode	Integer	Termination error code.	-

targetInfoChanged

Issued when some information about a target has changed. This only happens between `targetCreated` and `targetDestroyed`.

-

PARAMETERS:

Name	Type	Description	Flags
targetInfo	$REF: TargetInfo	-	-

Tethering

[Experimental]

The Tethering domain defines methods and events for browser port binding.

Tracing

[Experimental]

-

Dependencies: IO

types

Type ID

Type

Description

Flags

MemoryDumpConfig

Object

Configuration for memory dump. Used only when "memory-infra" category is enabled.

-

WARNING, NO PROPERTIES DEFINED

TraceConfig

Object

-

PROPERTIES:

Name	Type	Description	Flags
recordMode	"recordUntilFull", "recordContinuously", "recordAsMuchAsPossible", "echoToConsole"String [Hover] Enum	Controls how the trace buffer stores data.	[OPTIONAL]
enableSampling	Boolean	Turns on JavaScript stack sampling.	[OPTIONAL]
enableSystrace	Boolean	Turns on system tracing.	[OPTIONAL]
enableArgumentFilter	Boolean	Turns on argument filter.	[OPTIONAL]
includedCategories	Array (of) String	Included category filters.	[OPTIONAL]
excludedCategories	Array (of) String	Excluded category filters.	[OPTIONAL]
syntheticDelays	Array (of) String	Configuration to synthesize the delays in tracing.	[OPTIONAL]
memoryDumpConfig	$REF: MemoryDumpConfig	Configuration for memory dump triggers. Used only when "memory-infra" category is enabled.	[OPTIONAL]

StreamFormat

Data format of a trace. Can be either the legacy JSON format or the protocol buffer format. Note that the JSON format will be deprecated soon.

-

StreamCompression

Compression type to use for traces returned via streams.

-

MemoryDumpLevelOfDetail

Details exposed when memory request explicitly declared. Keep consistent with memory_dump_request_args.h and memory_instrumentation.mojom

-

TracingBackend

Backend type to use for tracing. `chrome` uses the Chrome-integrated tracing service and is supported on all platforms. `system` is only supported on Chrome OS and uses the Perfetto system tracing service. `auto` chooses `system` when the perfettoConfig provided to Tracing.start specifies at least one non-Chrome data source; otherwise uses `chrome`.

-

commands

Name

Description

Flags

end

Stop trace events collection.

-

getCategories

Gets supported tracing categories.

-

RETURNS:

Name	Type	Description	Flags
categories	Array (of) String	A list of supported tracing categories.	-

recordClockSyncMarker

Record a clock sync marker in the trace.

-

PARAMETERS:

Name	Type	Description	Flags
syncId	String	The ID of this clock sync marker	-

requestMemoryDump

Request a global memory dump.

-

PARAMETERS:

Name	Type	Description	Flags
deterministic	Boolean	Enables more deterministic results by forcing garbage collection	[OPTIONAL]
levelOfDetail	$REF: MemoryDumpLevelOfDetail	Specifies level of details in memory dump. Defaults to "detailed".	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
dumpGuid	String	GUID of the resulting global memory dump.	-
success	Boolean	True iff the global memory dump succeeded.	-

start

Start trace events collection.

-

PARAMETERS:

Name	Type	Description	Flags
categories	String	Category/tag filter	[OPTIONAL] [DEPRECATED]
options	String	Tracing options	[OPTIONAL] [DEPRECATED]
bufferUsageReportingInterval	Number	If set, the agent will issue bufferUsage events at this interval, specified in milliseconds	[OPTIONAL]
transferMode	"ReportEvents", "ReturnAsStream"String [Hover] Enum	Whether to report trace events as series of dataCollected events or to save trace to a stream (defaults to `ReportEvents`).	[OPTIONAL]
streamFormat	$REF: StreamFormat	Trace data format to use. This only applies when using `ReturnAsStream` transfer mode (defaults to `json`).	[OPTIONAL]
streamCompression	$REF: StreamCompression	Compression format to use. This only applies when using `ReturnAsStream` transfer mode (defaults to `none`)	[OPTIONAL]
traceConfig	$REF: TraceConfig	-	[OPTIONAL]
perfettoConfig	String	Base64-encoded serialized perfetto.protos.TraceConfig protobuf message When specified, the parameters `categories`, `options`, `traceConfig` are ignored. (Encoded as a base64 string when passed over JSON)	[OPTIONAL]
tracingBackend	$REF: TracingBackend	Backend type (defaults to `auto`)	[OPTIONAL]

events

Name

Description

Flags

bufferUsage

-

PARAMETERS:

Name	Type	Description	Flags
percentFull	Number	A number in range [0..1] that indicates the used size of event buffer as a fraction of its total size.	[OPTIONAL]
eventCount	Number	An approximate number of events in the trace log.	[OPTIONAL]
value	Number	A number in range [0..1] that indicates the used size of event buffer as a fraction of its total size.	[OPTIONAL]

dataCollected

Contains an bucket of collected trace events. When tracing is stopped collected events will be send as a sequence of dataCollected events followed by tracingComplete event.

-

PARAMETERS:

Name	Type	Description	Flags
value	Array (of) Object	-	-

tracingComplete

Signals that tracing is stopped and there is no trace buffers pending flush, all data were delivered via dataCollected events.

-

PARAMETERS:

Name	Type	Description	Flags
dataLossOccurred	Boolean	Indicates whether some trace data is known to have been lost, e.g. because the trace ring buffer wrapped around.	-
stream	$REF: IO.StreamHandle	A handle of the stream that holds resulting trace data.	[OPTIONAL]
traceFormat	$REF: StreamFormat	Trace data format of returned stream.	[OPTIONAL]
streamCompression	$REF: StreamCompression	Compression format of returned stream.	[OPTIONAL]

Fetch

A domain for letting clients substitute browser's network layer with client code.

Dependencies: Network, IO, Page

types

Type ID

Type

Description

Flags

RequestId

String

Unique request identifier.

-

RequestStage

Stages of the request to handle. Request will intercept before the request is sent. Response will intercept after the response is received (but before response body is received).

-

RequestPattern

Object

-

PROPERTIES:

Name	Type	Description	Flags
urlPattern	String	Wildcards (`''` -> zero or more, `'?'` -> exactly one) are allowed. Escape character is backslash. Omitting is equivalent to `""`.	[OPTIONAL]
resourceType	$REF: Network.ResourceType	If set, only requests for matching resource types will be intercepted.	[OPTIONAL]
requestStage	$REF: RequestStage	Stage at which to begin intercepting requests. Default is Request.	[OPTIONAL]

HeaderEntry

Object

Response HTTP header entry

-

PROPERTIES:

Name	Type	Description	Flags
name	String	-	-
value	String	-	-

AuthChallenge

Object

Authorization challenge for HTTP status code 401 or 407.

-

PROPERTIES:

Name	Type	Description	Flags
source	"Server", "Proxy"String [Hover] Enum	Source of the authentication challenge.	[OPTIONAL]
origin	String	Origin of the challenger.	-
scheme	String	The authentication scheme used, such as basic or digest	-
realm	String	The realm of the challenge. May be empty.	-

AuthChallengeResponse

Object

Response to an AuthChallenge.

-

PROPERTIES:

Name	Type	Description	Flags
response	"Default", "CancelAuth", "ProvideCredentials"String [Hover] Enum	The decision on what to do in response to the authorization challenge. Default means deferring to the default behavior of the net stack, which will likely either the Cancel authentication or display a popup dialog box.	-
username	String	The username to provide, possibly empty. Should only be set if response is ProvideCredentials.	[OPTIONAL]
password	String	The password to provide, possibly empty. Should only be set if response is ProvideCredentials.	[OPTIONAL]

commands

Name

Description

Flags

disable

Disables the fetch domain.

-

enable

Enables issuing of requestPaused events. A request will be paused until client calls one of failRequest, fulfillRequest or continueRequest/continueWithAuth.

-

PARAMETERS:

Name	Type	Description	Flags
patterns	Array (of) $REF: RequestPattern	If specified, only requests matching any of these patterns will produce fetchRequested event and will be paused until clients response. If not set, all requests will be affected.	[OPTIONAL]
handleAuthRequests	Boolean	If true, authRequired events will be issued and requests will be paused expecting a call to continueWithAuth.	[OPTIONAL]

failRequest

Causes the request to fail with specified reason.

-

PARAMETERS:

Name	Type	Description	Flags
requestId	$REF: RequestId	An id the client received in requestPaused event.	-
errorReason	$REF: Network.ErrorReason	Causes the request to fail with the given reason.	-

fulfillRequest

Provides response to the request.

-

PARAMETERS:

Name	Type	Description	Flags
requestId	$REF: RequestId	An id the client received in requestPaused event.	-
responseCode	Integer	An HTTP response code.	-
responseHeaders	Array (of) $REF: HeaderEntry	Response headers.	[OPTIONAL]
binaryResponseHeaders	String	Alternative way of specifying response headers as a \0-separated series of name: value pairs. Prefer the above method unless you need to represent some non-UTF8 values that can't be transmitted over the protocol as text. (Encoded as a base64 string when passed over JSON)	[OPTIONAL]
body	String	A response body. If absent, original response body will be used if the request is intercepted at the response stage and empty body will be used if the request is intercepted at the request stage. (Encoded as a base64 string when passed over JSON)	[OPTIONAL]
responsePhrase	String	A textual representation of responseCode. If absent, a standard phrase matching responseCode is used.	[OPTIONAL]

continueRequest

Continues the request, optionally modifying some of its parameters.

-

PARAMETERS:

Name	Type	Description	Flags
requestId	$REF: RequestId	An id the client received in requestPaused event.	-
url	String	If set, the request url will be modified in a way that's not observable by page.	[OPTIONAL]
method	String	If set, the request method is overridden.	[OPTIONAL]
postData	String	If set, overrides the post data in the request. (Encoded as a base64 string when passed over JSON)	[OPTIONAL]
headers	Array (of) $REF: HeaderEntry	If set, overrides the request headers.	[OPTIONAL]
interceptResponse	Boolean	If set, overrides response interception behavior for this request.	[OPTIONAL] [EXPERIMENTAL]

continueWithAuth

Continues a request supplying authChallengeResponse following authRequired event.

-

PARAMETERS:

Name	Type	Description	Flags
requestId	$REF: RequestId	An id the client received in authRequired event.	-
authChallengeResponse	$REF: AuthChallengeResponse	Response to with an authChallenge.	-

continueResponse

Continues loading of the paused response, optionally modifying the response headers. If either responseCode or headers are modified, all of them must be present.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
requestId	$REF: RequestId	An id the client received in requestPaused event.	-
responseCode	Integer	An HTTP response code. If absent, original response code will be used.	[OPTIONAL]
responsePhrase	String	A textual representation of responseCode. If absent, a standard phrase matching responseCode is used.	[OPTIONAL]
responseHeaders	Array (of) $REF: HeaderEntry	Response headers. If absent, original response headers will be used.	[OPTIONAL]
binaryResponseHeaders	String	Alternative way of specifying response headers as a \0-separated series of name: value pairs. Prefer the above method unless you need to represent some non-UTF8 values that can't be transmitted over the protocol as text. (Encoded as a base64 string when passed over JSON)	[OPTIONAL]

getResponseBody

Causes the body of the response to be received from the server and returned as a single string. May only be issued for a request that is paused in the Response stage and is mutually exclusive with takeResponseBodyForInterceptionAsStream. Calling other methods that affect the request or disabling fetch domain before body is received results in an undefined behavior.

-

PARAMETERS:

Name	Type	Description	Flags
requestId	$REF: RequestId	Identifier for the intercepted request to get body for.	-

RETURNS:

Name	Type	Description	Flags
body	String	Response body.	-
base64Encoded	Boolean	True, if content was sent as base64.	-

takeResponseBodyAsStream

Returns a handle to the stream representing the response body. The request must be paused in the HeadersReceived stage. Note that after this command the request can't be continued as is -- client either needs to cancel it or to provide the response body. The stream only supports sequential read, IO.read will fail if the position is specified. This method is mutually exclusive with getResponseBody. Calling other methods that affect the request or disabling fetch domain before body is received results in an undefined behavior.

-

PARAMETERS:

Name	Type	Description	Flags
requestId	$REF: RequestId	-	-

RETURNS:

Name	Type	Description	Flags
stream	$REF: IO.StreamHandle	-	-

events

Name

Description

Flags

requestPaused

Issued when the domain is enabled and the request URL matches the specified filter. The request is paused until the client responds with one of continueRequest, failRequest or fulfillRequest. The stage of the request can be determined by presence of responseErrorReason and responseStatusCode -- the request is at the response stage if either of these fields is present and in the request stage otherwise.

-

PARAMETERS:

Name	Type	Description	Flags
requestId	$REF: RequestId	Each request the page makes will have a unique id.	-
request	$REF: Network.Request	The details of the request.	-
frameId	$REF: Page.FrameId	The id of the frame that initiated the request.	-
resourceType	$REF: Network.ResourceType	How the requested resource will be used.	-
responseErrorReason	$REF: Network.ErrorReason	Response error if intercepted at response stage.	[OPTIONAL]
responseStatusCode	Integer	Response code if intercepted at response stage.	[OPTIONAL]
responseStatusText	String	Response status text if intercepted at response stage.	[OPTIONAL]
responseHeaders	Array (of) $REF: HeaderEntry	Response headers if intercepted at the response stage.	[OPTIONAL]
networkId	$REF: RequestId	If the intercepted request had a corresponding Network.requestWillBeSent event fired for it, then this networkId will be the same as the requestId present in the requestWillBeSent event.	[OPTIONAL]

authRequired

Issued when the domain is enabled with handleAuthRequests set to true. The request is paused until client responds with continueWithAuth.

-

PARAMETERS:

Name	Type	Description	Flags
requestId	$REF: RequestId	Each request the page makes will have a unique id.	-
request	$REF: Network.Request	The details of the request.	-
frameId	$REF: Page.FrameId	The id of the frame that initiated the request.	-
resourceType	$REF: Network.ResourceType	How the requested resource will be used.	-
authChallenge	$REF: AuthChallenge	Details of the Authorization Challenge encountered. If this is set, client should respond with continueRequest that contains AuthChallengeResponse.	-

WebAudio

[Experimental]

This domain allows inspection of Web Audio API. https://webaudio.github.io/web-audio-api/

types

Type ID Type Description Flags

GraphObjectId String An unique ID for a graph object (AudioContext, AudioNode, AudioParam) in Web Audio API -

ContextType

Enum of BaseAudioContext types

-

ContextState

Enum of AudioContextState from the spec

-

NodeType String Enum of AudioNode types -

ChannelCountMode

Enum of AudioNode::ChannelCountMode from the spec

-

ChannelInterpretation

Enum of AudioNode::ChannelInterpretation from the spec

-

ParamType String Enum of AudioParam types -

AutomationRate

Enum of AudioParam::AutomationRate from the spec

-

ContextRealtimeData Object Fields in AudioContext that change in real-time. -

PROPERTIES:

Name	Type	Description	Flags
currentTime	Number	The current context time in second in BaseAudioContext.	-
renderCapacity	Number	The time spent on rendering graph divided by render quantum duration, and multiplied by 100. 100 means the audio renderer reached the full capacity and glitch may occur.	-
callbackIntervalMean	Number	A running mean of callback interval.	-
callbackIntervalVariance	Number	A running variance of callback interval.	-

BaseAudioContext Object Protocol object for BaseAudioContext -

PROPERTIES:

Name	Type	Description	Flags
contextId	$REF: GraphObjectId	-	-
contextType	$REF: ContextType	-	-
contextState	$REF: ContextState	-	-
realtimeData	$REF: ContextRealtimeData	-	[OPTIONAL]
callbackBufferSize	Number	Platform-dependent callback buffer size.	-
maxOutputChannelCount	Number	Number of output channels supported by audio hardware in use.	-
sampleRate	Number	Context sample rate.	-

AudioListener Object Protocol object for AudioListener -

PROPERTIES:

Name	Type	Description	Flags
listenerId	$REF: GraphObjectId	-	-
contextId	$REF: GraphObjectId	-	-

AudioNode Object Protocol object for AudioNode -

PROPERTIES:

Name	Type	Description	Flags
nodeId	$REF: GraphObjectId	-	-
contextId	$REF: GraphObjectId	-	-
nodeType	$REF: NodeType	-	-
numberOfInputs	Number	-	-
numberOfOutputs	Number	-	-
channelCount	Number	-	-
channelCountMode	$REF: ChannelCountMode	-	-
channelInterpretation	$REF: ChannelInterpretation	-	-

AudioParam Object Protocol object for AudioParam -

PROPERTIES:

Name	Type	Description	Flags
paramId	$REF: GraphObjectId	-	-
nodeId	$REF: GraphObjectId	-	-
contextId	$REF: GraphObjectId	-	-
paramType	$REF: ParamType	-	-
rate	$REF: AutomationRate	-	-
defaultValue	Number	-	-
minValue	Number	-	-
maxValue	Number	-	-

events

Name

Description

Flags

contextCreated

Notifies that a new BaseAudioContext has been created.

-

PARAMETERS:

Name	Type	Description	Flags
context	$REF: BaseAudioContext	-	-

contextWillBeDestroyed

Notifies that an existing BaseAudioContext will be destroyed.

-

PARAMETERS:

Name	Type	Description	Flags
contextId	$REF: GraphObjectId	-	-

contextChanged

Notifies that existing BaseAudioContext has changed some properties (id stays the same)..

-

PARAMETERS:

Name	Type	Description	Flags
context	$REF: BaseAudioContext	-	-

audioListenerCreated

Notifies that the construction of an AudioListener has finished.

-

PARAMETERS:

Name	Type	Description	Flags
listener	$REF: AudioListener	-	-

audioListenerWillBeDestroyed

Notifies that a new AudioListener has been created.

-

PARAMETERS:

Name	Type	Description	Flags
contextId	$REF: GraphObjectId	-	-
listenerId	$REF: GraphObjectId	-	-

audioNodeCreated

Notifies that a new AudioNode has been created.

-

PARAMETERS:

Name	Type	Description	Flags
node	$REF: AudioNode	-	-

audioNodeWillBeDestroyed

Notifies that an existing AudioNode has been destroyed.

-

PARAMETERS:

Name	Type	Description	Flags
contextId	$REF: GraphObjectId	-	-
nodeId	$REF: GraphObjectId	-	-

audioParamCreated

Notifies that a new AudioParam has been created.

-

PARAMETERS:

Name	Type	Description	Flags
param	$REF: AudioParam	-	-

audioParamWillBeDestroyed

Notifies that an existing AudioParam has been destroyed.

-

PARAMETERS:

Name	Type	Description	Flags
contextId	$REF: GraphObjectId	-	-
nodeId	$REF: GraphObjectId	-	-
paramId	$REF: GraphObjectId	-	-

nodesConnected

Notifies that two AudioNodes are connected.

-

PARAMETERS:

Name	Type	Description	Flags
contextId	$REF: GraphObjectId	-	-
sourceId	$REF: GraphObjectId	-	-
destinationId	$REF: GraphObjectId	-	-
sourceOutputIndex	Number	-	[OPTIONAL]
destinationInputIndex	Number	-	[OPTIONAL]

nodesDisconnected

Notifies that AudioNodes are disconnected. The destination can be null, and it means all the outgoing connections from the source are disconnected.

-

PARAMETERS:

Name	Type	Description	Flags
contextId	$REF: GraphObjectId	-	-
sourceId	$REF: GraphObjectId	-	-
destinationId	$REF: GraphObjectId	-	-
sourceOutputIndex	Number	-	[OPTIONAL]
destinationInputIndex	Number	-	[OPTIONAL]

nodeParamConnected

Notifies that an AudioNode is connected to an AudioParam.

-

PARAMETERS:

Name	Type	Description	Flags
contextId	$REF: GraphObjectId	-	-
sourceId	$REF: GraphObjectId	-	-
destinationId	$REF: GraphObjectId	-	-
sourceOutputIndex	Number	-	[OPTIONAL]

nodeParamDisconnected

Notifies that an AudioNode is disconnected to an AudioParam.

-

PARAMETERS:

Name	Type	Description	Flags
contextId	$REF: GraphObjectId	-	-
sourceId	$REF: GraphObjectId	-	-
destinationId	$REF: GraphObjectId	-	-
sourceOutputIndex	Number	-	[OPTIONAL]

WebAuthn

[Experimental]

This domain allows configuring virtual authenticators to test the WebAuthn API.

types

Type ID

Type

Description

Flags

AuthenticatorId

String

-

AuthenticatorProtocol

-

Ctap2Version

-

AuthenticatorTransport

-

VirtualAuthenticatorOptions

Object

-

PROPERTIES:

Name	Type	Description	Flags
protocol	$REF: AuthenticatorProtocol	-	-
ctap2Version	$REF: Ctap2Version	Defaults to ctap2_0. Ignored if \|protocol\| == u2f.	[OPTIONAL]
transport	$REF: AuthenticatorTransport	-	-
hasResidentKey	Boolean	Defaults to false.	[OPTIONAL]
hasUserVerification	Boolean	Defaults to false.	[OPTIONAL]
hasLargeBlob	Boolean	If set to true, the authenticator will support the largeBlob extension. https://w3c.github.io/webauthn#largeBlob Defaults to false.	[OPTIONAL]
hasCredBlob	Boolean	If set to true, the authenticator will support the credBlob extension. https://fidoalliance.org/specs/fido-v2.1-rd-20201208/fido-client-to-authenticator-protocol-v2.1-rd-20201208.html#sctn-credBlob-extension Defaults to false.	[OPTIONAL]
automaticPresenceSimulation	Boolean	If set to true, tests of user presence will succeed immediately. Otherwise, they will not be resolved. Defaults to true.	[OPTIONAL]
isUserVerified	Boolean	Sets whether User Verification succeeds or fails for an authenticator. Defaults to false.	[OPTIONAL]

Credential

Object

-

PROPERTIES:

Name	Type	Description	Flags
credentialId	String	-	-
isResidentCredential	Boolean	-	-
rpId	String	Relying Party ID the credential is scoped to. Must be set when adding a credential.	[OPTIONAL]
privateKey	String	The ECDSA P-256 private key in PKCS#8 format. (Encoded as a base64 string when passed over JSON)	-
userHandle	String	An opaque byte sequence with a maximum size of 64 bytes mapping the credential to a specific user. (Encoded as a base64 string when passed over JSON)	[OPTIONAL]
signCount	Integer	Signature counter. This is incremented by one for each successful assertion. See https://w3c.github.io/webauthn/#signature-counter	-
largeBlob	String	The large blob associated with the credential. See https://w3c.github.io/webauthn/#sctn-large-blob-extension (Encoded as a base64 string when passed over JSON)	[OPTIONAL]

commands

Name

Description

Flags

enable

Enable the WebAuthn domain and start intercepting credential storage and retrieval with a virtual authenticator.

-

disable

Disable the WebAuthn domain.

-

addVirtualAuthenticator

Creates and adds a virtual authenticator.

-

PARAMETERS:

Name	Type	Description	Flags
options	$REF: VirtualAuthenticatorOptions	-	-

RETURNS:

Name	Type	Description	Flags
authenticatorId	$REF: AuthenticatorId	-	-

removeVirtualAuthenticator

Removes the given authenticator.

-

PARAMETERS:

Name	Type	Description	Flags
authenticatorId	$REF: AuthenticatorId	-	-

addCredential

Adds the credential to the specified authenticator.

-

PARAMETERS:

Name	Type	Description	Flags
authenticatorId	$REF: AuthenticatorId	-	-
credential	$REF: Credential	-	-

getCredential

Returns a single credential stored in the given virtual authenticator that matches the credential ID.

-

PARAMETERS:

Name	Type	Description	Flags
authenticatorId	$REF: AuthenticatorId	-	-
credentialId	String	-	-

RETURNS:

Name	Type	Description	Flags
credential	$REF: Credential	-	-

getCredentials

Returns all the credentials stored in the given virtual authenticator.

-

PARAMETERS:

Name	Type	Description	Flags
authenticatorId	$REF: AuthenticatorId	-	-

RETURNS:

Name	Type	Description	Flags
credentials	Array (of) $REF: Credential	-	-

removeCredential

Removes a credential from the authenticator.

-

PARAMETERS:

Name	Type	Description	Flags
authenticatorId	$REF: AuthenticatorId	-	-
credentialId	String	-	-

clearCredentials

Clears all the credentials from the specified device.

-

PARAMETERS:

Name	Type	Description	Flags
authenticatorId	$REF: AuthenticatorId	-	-

setUserVerified

Sets whether User Verification succeeds or fails for an authenticator. The default is true.

-

PARAMETERS:

Name	Type	Description	Flags
authenticatorId	$REF: AuthenticatorId	-	-
isUserVerified	Boolean	-	-

setAutomaticPresenceSimulation

Sets whether tests of user presence will succeed immediately (if true) or fail to resolve (if false) for an authenticator. The default is true.

-

PARAMETERS:

Name	Type	Description	Flags
authenticatorId	$REF: AuthenticatorId	-	-
enabled	Boolean	-	-

Media

[Experimental]

This domain allows detailed inspection of media elements

types

Type ID

Type

Description

Flags

PlayerId

String

Players will get an ID that is unique within the agent context.

-

Timestamp

Number

-

PlayerMessage

Object

Have one type per entry in MediaLogRecord::Type Corresponds to kMessage

-

PROPERTIES:

Name	Type	Description	Flags
level	"error", "warning", "info", "debug"String [Hover] Enum	Keep in sync with MediaLogMessageLevel We are currently keeping the message level 'error' separate from the PlayerError type because right now they represent different things, this one being a DVLOG(ERROR) style log message that gets printed based on what log level is selected in the UI, and the other is a representation of a media::PipelineStatus object. Soon however we're going to be moving away from using PipelineStatus for errors and introducing a new error type which should hopefully let us integrate the error log level into the PlayerError type.	-
message	String	-	-

PlayerProperty

Object

Corresponds to kMediaPropertyChange

-

PROPERTIES:

Name	Type	Description	Flags
name	String	-	-
value	String	-	-

PlayerEvent

Object

Corresponds to kMediaEventTriggered

-

PROPERTIES:

Name	Type	Description	Flags
timestamp	$REF: Timestamp	-	-
value	String	-	-

PlayerError

Object

Corresponds to kMediaError

-

PROPERTIES:

Name	Type	Description	Flags
type	"pipeline_error", "media_error"String [Hover] Enum	-	-
errorCode	String	When this switches to using media::Status instead of PipelineStatus we can remove "errorCode" and replace it with the fields from a Status instance. This also seems like a duplicate of the error level enum - there is a todo bug to have that level removed and use this instead. (crbug.com/1068454)	-

events

Name

Description

Flags

playerPropertiesChanged

This can be called multiple times, and can be used to set / override / remove player properties. A null propValue indicates removal.

-

PARAMETERS:

Name	Type	Description	Flags
playerId	$REF: PlayerId	-	-
properties	Array (of) $REF: PlayerProperty	-	-

playerEventsAdded

Send events as a list, allowing them to be batched on the browser for less congestion. If batched, events must ALWAYS be in chronological order.

-

PARAMETERS:

Name	Type	Description	Flags
playerId	$REF: PlayerId	-	-
events	Array (of) $REF: PlayerEvent	-	-

playerMessagesLogged

Send a list of any messages that need to be delivered.

-

PARAMETERS:

Name	Type	Description	Flags
playerId	$REF: PlayerId	-	-
messages	Array (of) $REF: PlayerMessage	-	-

playerErrorsRaised

Send a list of any errors that need to be delivered.

-

PARAMETERS:

Name	Type	Description	Flags
playerId	$REF: PlayerId	-	-
errors	Array (of) $REF: PlayerError	-	-

playersCreated

Called whenever a player is created, or when a new agent joins and receives a list of active players. If an agent is restored, it will receive the full list of player ids and all events again.

-

PARAMETERS:

Name	Type	Description	Flags
players	Array (of) $REF: PlayerId	-	-

Name	Description	Flags
disable	Disables inspector domain notifications.	-
enable	Enables inspector domain notifications.	-

Name	Description	Flags
enable	Enables the Media domain	-
disable	Disables the Media domain.	-

Available Browser API Domains

Accessibility

types

commands

Animation

types

commands

events

Audits

types

commands

events

BackgroundService

types

commands

events

Browser

types

commands

events

CSS

types

commands

events

CacheStorage

types

commands

Cast

types

commands

events

DOM

types

commands

events

DOMDebugger

types

commands

DOMSnapshot

types

commands

DOMStorage

types

commands

events

Database

types

commands

events

DeviceOrientation

commands

Emulation

types

commands

events

HeadlessExperimental

types

commands

events

IO

types

commands

IndexedDB

types

commands

Input

types

commands

events

Inspector

commands

events

LayerTree

types

commands

events

Log

types

commands

events