Accessibility

[Experimental]

-

Dependencies: DOM

TYPES

Type ID

Type

Description

Flags

AXNode

OBJECT

A node in the accessibility tree.

-

PROPERTIES:

Name	Type	Description	Flags
nodeId	"$ref": AXNodeId	Unique identifier for this node.	-
ignored	"type": BOOLEAN	Whether this node is ignored for accessibility	-
ignoredReasons	"type": ARRAY "items": { "$ref": AXProperty }	Collection of reasons why this node is hidden.	[OPTIONAL]
role	"$ref": AXValue	This `Node`'s role, whether explicit or implicit.	[OPTIONAL]
chromeRole	"$ref": AXValue	This `Node`'s Chrome raw role.	[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	"type": ARRAY "items": { "$ref": AXProperty }	All other properties	[OPTIONAL]
parentId	"$ref": AXNodeId	ID for this node's parent.	[OPTIONAL]
childIds	"type": ARRAY "items": { "$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]
frameId	"$ref": Page.FrameId	The frame ID for the frame associated with this nodes document.	[OPTIONAL]

AXNodeId

STRING

Unique accessibility node identifier.

-

AXProperty

OBJECT

-

PROPERTIES:

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

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.

-

AXRelatedNode

OBJECT

-

PROPERTIES:

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

AXValue

OBJECT

A single computed AX property.

-

PROPERTIES:

Name	Type	Description	Flags
type	"$ref": AXValueType	The type of this value.	-
value	"type": ANY	The computed value of this property.	[OPTIONAL]
relatedNodes	"type": ARRAY "items": { "$ref": AXRelatedNode }	One or more related nodes, if applicable.	[OPTIONAL]
sources	"type": ARRAY "items": { "$ref": AXValueSource }	The sources which contributed to the computation of this property.	[OPTIONAL]

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	"type": STRING	The name of the relevant attribute, if any.	[OPTIONAL]
attributeValue	"$ref": AXValue	The value of the relevant attribute, if any.	[OPTIONAL]
superseded	"type": 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 `{@code <label>}` element.	[OPTIONAL]
nativeSourceValue	"$ref": AXValue	The value, such as a node or node list, of the native source.	[OPTIONAL]
invalid	"type": BOOLEAN	Whether the value for this property is invalid.	[OPTIONAL]
invalidReason	"type": STRING	Reason for the value being invalid, if it is.	[OPTIONAL]

AXValueSourceType

Enum of possible property sources.

-

AXValueType

Enum of possible property types.

-

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.

-

getAXNodeAndAncestors

Fetches a node and all ancestors up to and including the root. Requires `enable()` to have been called previously.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
nodeId	"$ref": DOM.NodeId	Identifier of the node to get.	[OPTIONAL]
backendNodeId	"$ref": DOM.BackendNodeId	Identifier of the backend node to get.	[OPTIONAL]
objectId	"$ref": RunTime.RemoteObjectId	JavaScript object id of the node wrapper to get.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
nodes	"type": ARRAY "items": { "$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	"type": ARRAY "items": { "$ref": AXNode }	-	-

getFullAXTree

Fetches the entire accessibility tree for the root Document

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
depth	"type": INTEGER	The maximum depth at which descendants of the root node should be retrieved. If omitted, the full tree is returned.	[OPTIONAL]
frameId	"$ref": Page.FrameId	The frame for whose document the AX tree should be retrieved. If omitted, the root frame is used.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
nodes	"type": ARRAY "items": { "$ref": AXNode }	-	-

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	"type": BOOLEAN	Whether to fetch this node's ancestors, siblings and children. Defaults to true.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
nodes	"type": ARRAY "items": { "$ref": AXNode }	The `Accessibility.AXNode` for this DOM node, if it exists, plus its ancestors, siblings and children, if requested.	-

getRootAXNode

Fetches the root node. Requires `enable()` to have been called previously.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
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
node	"$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 match 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	"type": STRING	Find nodes with this computed name.	[OPTIONAL]
role	"type": STRING	Find nodes with this computed role.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
nodes	"type": ARRAY "items": { "$ref": AXNode }	A list of `Accessibility.AXNode` matching the specified attributes, including nodes that are ignored for accessibility.	-

Animation

[Experimental]

-

Dependencies: DOM, RunTime

TYPES

Type ID

Type

Description

Flags

AnimationEffect

OBJECT

AnimationEffect instance

-

PROPERTIES:

Name	Type	Description	Flags
delay	"type": NUMBER	`AnimationEffect`'s delay.	-
endDelay	"type": NUMBER	`AnimationEffect`'s end delay.	-
iterationStart	"type": NUMBER	`AnimationEffect`'s iteration start.	-
iterations	"type": NUMBER	`AnimationEffect`'s iterations.	-
duration	"type": NUMBER	`AnimationEffect`'s iteration duration. Milliseconds for time based animations and percentage [0 - 100] for scroll driven animations (i.e. when viewOrScrollTimeline exists).	-
direction	"type": STRING	`AnimationEffect`'s playback direction.	-
fill	"type": STRING	`AnimationEffect`'s fill mode.	-
backendNodeId	"$ref": DOM.BackendNodeId	`AnimationEffect`'s target node.	[OPTIONAL]
keyframesRule	"$ref": KeyframesRule	`AnimationEffect`'s keyframes.	[OPTIONAL]
easing	"type": STRING	`AnimationEffect`'s timing function.	-

KeyframeStyle

OBJECT

Keyframe Style

-

PROPERTIES:

Name	Type	Description	Flags
offset	"type": STRING	Keyframe's time offset.	-
easing	"type": STRING	`AnimationEffect`'s timing function.	-

KeyframesRule

OBJECT

Keyframes Rule

-

PROPERTIES:

Name	Type	Description	Flags
name	"type": STRING	CSS keyframed animation's name.	[OPTIONAL]
keyframes	"type": ARRAY "items": { "$ref": KeyframeStyle }	List of animation keyframes.	-

ViewOrScrollTimeline

OBJECT

Timeline instance

-

PROPERTIES:

Name	Type	Description	Flags
sourceNodeId	"$ref": DOM.BackendNodeId	Scroll container node	[OPTIONAL]
startOffset	"type": NUMBER	Represents the starting scroll position of the timeline as a length offset in pixels from scroll origin.	[OPTIONAL]
endOffset	"type": NUMBER	Represents the ending scroll position of the timeline as a length offset in pixels from scroll origin.	[OPTIONAL]
subjectNodeId	"$ref": DOM.BackendNodeId	The element whose principal box's visibility in the scrollport defined the progress of the timeline. Does not exist for animations with ScrollTimeline	[OPTIONAL]
axis	"$ref": DOM.ScrollOrientation	Orientation of the scroll	-

_Animation

OBJECT

_Animation instance.

-

PROPERTIES:

Name	Type	Description	Flags
id	"type": STRING	`Animation`'s id.	-
name	"type": STRING	`Animation`'s name.	-
pausedState	"type": BOOLEAN	`Animation`'s internal paused state.	-
playState	"type": STRING	`Animation`'s play state.	-
playbackRate	"type": NUMBER	`Animation`'s playback rate.	-
startTime	"type": NUMBER	`Animation`'s start time. Milliseconds for time based animations and percentage [0 - 100] for scroll driven animations (i.e. when viewOrScrollTimeline exists).	-
currentTime	"type": NUMBER	`Animation`'s current time.	-
type	"CSSAnimation", "CSSTransition", "WebAnimation"String [Hover] Enum "type": STRING	Animation type of `Animation`.	-
source	"$ref": AnimationEffect	`Animation`'s source animation node.	[OPTIONAL]
cssId	"type": STRING	A unique ID for `Animation` representing the sources that triggered this CSS animation/transition.	[OPTIONAL]
viewOrScrollTimeline	"$ref": ViewOrScrollTimeline	View or scroll timeline	[OPTIONAL]

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	"type": STRING	Id of animation.	-

RETURNS:

Name	Type	Description	Flags
currentTime	"type": NUMBER	Current time of the page.	-

getPlaybackRate

Gets the playback rate of the document timeline.

-

RETURNS:

Name	Type	Description	Flags
playbackRate	"type": NUMBER	Playback rate for animations on page.	-

releaseAnimations

Releases a set of animations to no longer be manipulated.

-

PARAMETERS:

Name	Type	Description	Flags
animations	"type": ARRAY "items": { "type": STRING }	List of animation ids to seek.	-

resolveAnimation

Gets the remote object of the Animation.

-

PARAMETERS:

Name	Type	Description	Flags
animationId	"type": 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	"type": ARRAY "items": { "type": STRING }	List of animation ids to seek.	-
currentTime	"type": NUMBER	Set the current time of each animation.	-

setPaused

Sets the paused state of a set of animations.

-

PARAMETERS:

Name	Type	Description	Flags
animations	"type": ARRAY "items": { "type": STRING }	Animations to set the pause state of.	-
paused	"type": BOOLEAN	Paused state to set to.	-

setPlaybackRate

Sets the playback rate of the document timeline.

-

PARAMETERS:

Name	Type	Description	Flags
playbackRate	"type": NUMBER	Playback rate for animations on page	-

setTiming

Sets the timing of an animation node.

-

PARAMETERS:

Name	Type	Description	Flags
animationId	"type": STRING	Animation id.	-
duration	"type": NUMBER	Duration of the animation.	-
delay	"type": 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	"type": STRING	The following three properties uniquely identify a cookie	-
path	"type": STRING	-	-
domain	"type": STRING	-	-

AffectedFrame

OBJECT

Information about the frame affected by an inspector issue.

-

PROPERTIES:

Name	Type	Description	Flags
frameId	"$ref": Page.FrameId	-	-

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.	[OPTIONAL]
url	"type": STRING	-	-

AttributionReportingIssueDetails

OBJECT

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

-

PROPERTIES:

Name	Type	Description	Flags
violationType	"$ref": AttributionReportingIssueType	-	-
request	"$ref": AffectedRequest	-	[OPTIONAL]
violatingNodeId	"$ref": DOM.BackendNodeId	-	[OPTIONAL]
invalidParameter	"type": STRING	-	[OPTIONAL]

AttributionReportingIssueType

-

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

BlockedByResponseReason

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

-

BounceTrackingIssueDetails

OBJECT

This issue warns about sites in the redirect chain of a finished navigation that may be flagged as trackers and have their state cleared if they don't receive a user interaction. Note that in this context 'site' means eTLD+1. For example, if the URL `https://example.test:80/bounce` was in the redirect chain, the site reported would be `example.test`.

-

PROPERTIES:

Name	Type	Description	Flags
trackingSites	"type": ARRAY "items": { "type": STRING }	-	-

ClientHintIssueDetails

OBJECT

This issue tracks client hints related issues. It's used to deprecate old features, encourage the use of new ones, and provide general guidance.

-

PROPERTIES:

Name	Type	Description	Flags
sourceCodeLocation	"$ref": SourceCodeLocation	-	-
clientHintIssueReason	"$ref": ClientHintIssueReason	-	-

ClientHintIssueReason

-

ContentSecurityPolicyIssueDetails

OBJECT

-

PROPERTIES:

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

ContentSecurityPolicyViolationType

-

CookieDeprecationMetadataIssueDetails

OBJECT

This issue warns about third-party sites that are accessing cookies on the current page, and have been permitted due to having a global metadata grant. Note that in this context 'site' means eTLD+1. For example, if the URL `https://example.test:80/web_page` was accessing cookies, the site reported would be `example.test`.

-

PROPERTIES:

Name	Type	Description	Flags
allowedSites	"type": ARRAY "items": { "type": STRING }	-	-
optOutPercentage	"type": NUMBER	-	-
isOptOutTopLevel	"type": BOOLEAN	-	-
operation	"$ref": CookieOperation	-	-

CookieExclusionReason

-

CookieIssueDetails

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	"type": STRING	-	[OPTIONAL]
cookieWarningReasons	"type": ARRAY "items": { "$ref": CookieWarningReason }	-	-
cookieExclusionReasons	"type": ARRAY "items": { "$ref": CookieExclusionReason }	-	-
operation	"$ref": CookieOperation	Optionally identifies the site-for-cookies and the cookie url, which may be used by the front-end as additional context.	-
siteForCookies	"type": STRING	-	[OPTIONAL]
cookieUrl	"type": STRING	-	[OPTIONAL]
request	"$ref": AffectedRequest	-	[OPTIONAL]
insight	"$ref": CookieIssueInsight	The recommended solution to the issue.	[OPTIONAL]

CookieIssueInsight

OBJECT

Information about the suggested solution to a cookie issue.

-

PROPERTIES:

Name	Type	Description	Flags
type	"$ref": InsightType	-	-
tableEntryUrl	"type": STRING	Link to table entry in third-party cookie migration readiness list.	[OPTIONAL]

CookieOperation

-

CookieWarningReason

-

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	"type": BOOLEAN	-	-
request	"$ref": AffectedRequest	-	-
location	"$ref": SourceCodeLocation	-	[OPTIONAL]
initiatorOrigin	"type": STRING	-	[OPTIONAL]
resourceIPAddressSpace	"$ref": Network.IPAddressSpace	-	[OPTIONAL]
clientSecurityState	"$ref": Network.ClientSecurityState	-	[OPTIONAL]

DeprecationIssueDetails

OBJECT

This issue tracks information needed to print a deprecation message. https://source.chromium.org/chromium/chromium/src/+/main:third_party/blink/renderer/core/frame/third_party/blink/renderer/core/frame/deprecation/README.md

-

PROPERTIES:

Name	Type	Description	Flags
affectedFrame	"$ref": AffectedFrame	-	[OPTIONAL]
sourceCodeLocation	"$ref": SourceCodeLocation	-	-
type	"type": STRING	One of the deprecation names from third_party/blink/renderer/core/frame/deprecation/deprecation.json5	-

ElementAccessibilityIssueDetails

OBJECT

This issue warns about errors in the select or summary element content model.

-

PROPERTIES:

Name	Type	Description	Flags
nodeId	"$ref": DOM.BackendNodeId	-	-
elementAccessibilityIssueReason	"$ref": ElementAccessibilityIssueReason	-	-
hasDisallowedAttributes	"type": BOOLEAN	-	-

ElementAccessibilityIssueReason

-

FailedRequestInfo

OBJECT

-

PROPERTIES:

Name	Type	Description	Flags
url	"type": STRING	The URL that failed to load.	-
failureMessage	"type": STRING	The failure message for the failed request.	-
requestId	"$ref": Network.RequestId	-	[OPTIONAL]

FederatedAuthRequestIssueDetails

OBJECT

-

PROPERTIES:

Name	Type	Description	Flags
federatedAuthRequestIssueReason	"$ref": FederatedAuthRequestIssueReason	-	-

FederatedAuthRequestIssueReason

Represents the failure reason when a federated authentication reason fails. Should be updated alongside RequestIdTokenStatus in third_party/blink/public/mojom/devtools/inspector_issue.mojom to include all cases except for success.

-

FederatedAuthUserInfoRequestIssueDetails

OBJECT

-

PROPERTIES:

Name	Type	Description	Flags
federatedAuthUserInfoRequestIssueReason	"$ref": FederatedAuthUserInfoRequestIssueReason	-	-

FederatedAuthUserInfoRequestIssueReason

Represents the failure reason when a getUserInfo() call fails. Should be updated alongside FederatedAuthUserInfoRequestResult in third_party/blink/public/mojom/devtools/inspector_issue.mojom.

-

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]
violatingNodeId	"$ref": DOM.BackendNodeId	-	[OPTIONAL]
violatingNodeAttribute	"type": STRING	-	[OPTIONAL]
request	"$ref": AffectedRequest	-	[OPTIONAL]

GenericIssueErrorType

-

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

HeavyAdReason

-

HeavyAdResolutionStatus

-

InsightType

Represents the category of insight that a cookie issue falls under.

-

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]

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
cookieIssueDetails	"$ref": CookieIssueDetails	-	[OPTIONAL]
mixedContentIssueDetails	"$ref": MixedContentIssueDetails	-	[OPTIONAL]
blockedByResponseIssueDetails	"$ref": BlockedByResponseIssueDetails	-	[OPTIONAL]
heavyAdIssueDetails	"$ref": HeavyAdIssueDetails	-	[OPTIONAL]
contentSecurityPolicyIssueDetails	"$ref": ContentSecurityPolicyIssueDetails	-	[OPTIONAL]
sharedArrayBufferIssueDetails	"$ref": SharedArrayBufferIssueDetails	-	[OPTIONAL]
lowTextContrastIssueDetails	"$ref": LowTextContrastIssueDetails	-	[OPTIONAL]
corsIssueDetails	"$ref": CorsIssueDetails	-	[OPTIONAL]
attributionReportingIssueDetails	"$ref": AttributionReportingIssueDetails	-	[OPTIONAL]
quirksModeIssueDetails	"$ref": QuirksModeIssueDetails	-	[OPTIONAL]
partitioningBlobURLIssueDetails	"$ref": PartitioningBlobURLIssueDetails	-	[OPTIONAL]
navigatorUserAgentIssueDetails	"$ref": NavigatorUserAgentIssueDetails	-	[OPTIONAL] [DEPRECATED]
genericIssueDetails	"$ref": GenericIssueDetails	-	[OPTIONAL]
deprecationIssueDetails	"$ref": DeprecationIssueDetails	-	[OPTIONAL]
clientHintIssueDetails	"$ref": ClientHintIssueDetails	-	[OPTIONAL]
federatedAuthRequestIssueDetails	"$ref": FederatedAuthRequestIssueDetails	-	[OPTIONAL]
bounceTrackingIssueDetails	"$ref": BounceTrackingIssueDetails	-	[OPTIONAL]
cookieDeprecationMetadataIssueDetails	"$ref": CookieDeprecationMetadataIssueDetails	-	[OPTIONAL]
stylesheetLoadingIssueDetails	"$ref": StylesheetLoadingIssueDetails	-	[OPTIONAL]
propertyRuleIssueDetails	"$ref": PropertyRuleIssueDetails	-	[OPTIONAL]
federatedAuthUserInfoRequestIssueDetails	"$ref": FederatedAuthUserInfoRequestIssueDetails	-	[OPTIONAL]
sharedDictionaryIssueDetails	"$ref": SharedDictionaryIssueDetails	-	[OPTIONAL]
elementAccessibilityIssueDetails	"$ref": ElementAccessibilityIssueDetails	-	[OPTIONAL]
sriMessageSignatureIssueDetails	"$ref": SRIMessageSignatureIssueDetails	-	[OPTIONAL]
unencodedDigestIssueDetails	"$ref": UnencodedDigestIssueDetails	-	[OPTIONAL]
userReidentificationIssueDetails	"$ref": UserReidentificationIssueDetails	-	[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.

-

LowTextContrastIssueDetails

OBJECT

-

PROPERTIES:

Name	Type	Description	Flags
violatingNodeId	"$ref": DOM.BackendNodeId	-	-
violatingNodeSelector	"type": STRING	-	-
contrastRatio	"type": NUMBER	-	-
thresholdAA	"type": NUMBER	-	-
thresholdAAA	"type": NUMBER	-	-
fontSize	"type": STRING	-	-
fontWeight	"type": STRING	-	-

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	"type": STRING	The unsafe http url causing the mixed content issue.	-
mainResourceURL	"type": 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]

MixedContentResolutionStatus

-

MixedContentResourceType

-

NavigatorUserAgentIssueDetails

OBJECT

-

[DEPRECATED]

PROPERTIES:

Name	Type	Description	Flags
url	"type": STRING	-	-
location	"$ref": SourceCodeLocation	-	[OPTIONAL]

PartitioningBlobURLInfo

-

PartitioningBlobURLIssueDetails

OBJECT

-

PROPERTIES:

Name	Type	Description	Flags
url	"type": STRING	The BlobURL that failed to load.	-
partitioningBlobURLInfo	"$ref": PartitioningBlobURLInfo	Additional information about the Partitioning Blob URL issue.	-

PropertyRuleIssueDetails

OBJECT

This issue warns about errors in property rules that lead to property registrations being ignored.

-

PROPERTIES:

Name	Type	Description	Flags
sourceCodeLocation	"$ref": SourceCodeLocation	Source code position of the property rule.	-
propertyRuleIssueReason	"$ref": PropertyRuleIssueReason	Reason why the property rule was discarded.	-
propertyValue	"type": STRING	The value of the property rule property that failed to parse	[OPTIONAL]

PropertyRuleIssueReason

-

QuirksModeIssueDetails

OBJECT

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

-

PROPERTIES:

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

SRIMessageSignatureError

-

SRIMessageSignatureIssueDetails

OBJECT

-

PROPERTIES:

Name	Type	Description	Flags
error	"$ref": SRIMessageSignatureError	-	-
signatureBase	"type": STRING	-	-
integrityAssertions	"type": ARRAY "items": { "type": STRING }	-	-
request	"$ref": AffectedRequest	-	-

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	"type": BOOLEAN	-	-
type	"$ref": SharedArrayBufferIssueType	-	-

SharedArrayBufferIssueType

-

SharedDictionaryError

-

SharedDictionaryIssueDetails

OBJECT

-

PROPERTIES:

Name	Type	Description	Flags
sharedDictionaryError	"$ref": SharedDictionaryError	-	-
request	"$ref": AffectedRequest	-	-

SourceCodeLocation

OBJECT

-

PROPERTIES:

Name	Type	Description	Flags
scriptId	"$ref": RunTime.ScriptId	-	[OPTIONAL]
url	"type": STRING	-	-
lineNumber	"type": INTEGER	-	-
columnNumber	"type": INTEGER	-	-

StyleSheetLoadingIssueReason

-

StylesheetLoadingIssueDetails

OBJECT

This issue warns when a referenced stylesheet couldn't be loaded.

-

PROPERTIES:

Name	Type	Description	Flags
sourceCodeLocation	"$ref": SourceCodeLocation	Source code position that referenced the failing stylesheet.	-
styleSheetLoadingIssueReason	"$ref": StyleSheetLoadingIssueReason	Reason why the stylesheet couldn't be loaded.	-
failedRequestInfo	"$ref": FailedRequestInfo	Contains additional info when the failure was due to a request.	[OPTIONAL]

UnencodedDigestError

-

UnencodedDigestIssueDetails

OBJECT

-

PROPERTIES:

Name	Type	Description	Flags
error	"$ref": UnencodedDigestError	-	-
request	"$ref": AffectedRequest	-	-

UserReidentificationIssueDetails

OBJECT

This issue warns about uses of APIs that may be considered misuse to re-identify users.

-

PROPERTIES:

Name	Type	Description	Flags
type	"$ref": UserReidentificationIssueType	-	-
request	"$ref": AffectedRequest	Applies to BlockedFrameNavigation and BlockedSubresource issue types.	[OPTIONAL]
sourceCodeLocation	"$ref": SourceCodeLocation	Applies to NoisedCanvasReadback issue type.	[OPTIONAL]

UserReidentificationIssueType

-

COMMANDS

Name

Description

Flags

checkContrast

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

-

PARAMETERS:

Name	Type	Description	Flags
reportAAA	"type": BOOLEAN	Whether to report WCAG AAA level issues. Default is false.	[OPTIONAL]

checkFormsIssues

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

-

RETURNS:

Name	Type	Description	Flags
formIssues	"type": ARRAY "items": { "$ref": GenericIssueDetails }	-	-

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.

-

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	"jpeg", "png", "webp"String [Hover] Enum "type": STRING	The encoding to use.	-
quality	"type": NUMBER	The quality of the encoding (0-1). (defaults to 1)	[OPTIONAL]
sizeOnly	"type": BOOLEAN	Whether to only return the size information (defaults to false).	[OPTIONAL]

RETURNS:

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

Autofill

[Experimental]

Defines commands and events for Autofill.

TYPES

Type ID

Type

Description

Flags

Address

OBJECT

-

PROPERTIES:

Name	Type	Description	Flags
fields	"type": ARRAY "items": { "$ref": AddressField }	fields and values defining an address.	-

AddressField

OBJECT

-

PROPERTIES:

Name	Type	Description	Flags
name	"type": STRING	address field name, for example GIVEN_NAME.	-
value	"type": STRING	address field value, for example Jon Doe.	-

AddressFields

OBJECT

A list of address fields.

-

PROPERTIES:

Name	Type	Description	Flags
fields	"type": ARRAY "items": { "$ref": AddressField }	-	-

AddressUI

OBJECT

Defines how an address can be displayed like in chrome://settings/addresses. Address UI is a two dimensional array, each inner array is an "address information line", and when rendered in a UI surface should be displayed as such. The following address UI for instance: [[{name: "GIVE_NAME", value: "Jon"}, {name: "FAMILY_NAME", value: "Doe"}], [{name: "CITY", value: "Munich"}, {name: "ZIP", value: "81456"}]] should allow the receiver to render: Jon Doe Munich 81456

-

PROPERTIES:

Name	Type	Description	Flags
addressFields	"type": ARRAY "items": { "$ref": AddressFields }	A two dimension array containing the representation of values from an address profile.	-

CreditCard

OBJECT

-

PROPERTIES:

Name	Type	Description	Flags
number	"type": STRING	16-digit credit card number.	-
name	"type": STRING	Name of the credit card owner.	-
expiryMonth	"type": STRING	2-digit expiry month.	-
expiryYear	"type": STRING	4-digit expiry year.	-
cvc	"type": STRING	3-digit card verification code.	-

FilledField

OBJECT

-

PROPERTIES:

Name	Type	Description	Flags
htmlType	"type": STRING	The type of the field, e.g text, password etc.	-
id	"type": STRING	the html id	-
name	"type": STRING	the html name	-
value	"type": STRING	the field value	-
autofillType	"type": STRING	The actual field type, e.g FAMILY_NAME	-
fillingStrategy	"$ref": FillingStrategy	The filling strategy	-
frameId	"$ref": Page.FrameId	The frame the field belongs to	-
fieldId	"$ref": DOM.BackendNodeId	The form field's DOM node	-

FillingStrategy

Specified whether a filled field was done so by using the html autocomplete attribute or autofill heuristics.

-

BackgroundService

[Experimental]

Defines events for background web platform features.

TYPES

Type ID

Type

Description

Flags

BackgroundServiceEvent

OBJECT

-

PROPERTIES:

Name	Type	Description	Flags
timestamp	"$ref": Network.TimeSinceEpoch	Timestamp of the event (in seconds).	-
origin	"type": 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	"type": STRING	A description of the event.	-
instanceId	"type": STRING	An identifier that groups related events together.	-
eventMetadata	"type": ARRAY "items": { "$ref": EventMetadata }	A list of event-specific information.	-
storageKey	"type": STRING	Storage key this event belongs to.	-

EventMetadata

OBJECT

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

-

PROPERTIES:

Name	Type	Description	Flags
key	"type": STRING	-	-
value	"type": STRING	-	-

ServiceName

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

-

BluetoothEmulation

[Experimental]

This domain allows configuring virtual Bluetooth devices to test the web-bluetooth API.

TYPES

Type ID

Type

Description

Flags

CentralState

Indicates the various states of Central.

-

CharacteristicOperationType

Indicates the various types of characteristic operation.

-

CharacteristicProperties

OBJECT

Describes the properties of a characteristic. This follows Bluetooth Core Specification BT 4.2 Vol 3 Part G 3.3.1. Characteristic Properties.

-

PROPERTIES:

Name	Type	Description	Flags
broadcast	"type": BOOLEAN	-	[OPTIONAL]
read	"type": BOOLEAN	-	[OPTIONAL]
writeWithoutResponse	"type": BOOLEAN	-	[OPTIONAL]
write	"type": BOOLEAN	-	[OPTIONAL]
notify	"type": BOOLEAN	-	[OPTIONAL]
indicate	"type": BOOLEAN	-	[OPTIONAL]
authenticatedSignedWrites	"type": BOOLEAN	-	[OPTIONAL]
extendedProperties	"type": BOOLEAN	-	[OPTIONAL]

CharacteristicWriteType

Indicates the various types of characteristic write.

-

DescriptorOperationType

Indicates the various types of descriptor operation.

-

GATTOperationType

Indicates the various types of GATT event.

-

ManufacturerData

OBJECT

Stores the manufacturer data

-

PROPERTIES:

Name	Type	Description	Flags
key	"type": INTEGER	Company identifier https://bitbucket.org/bluetooth-SIG/public/src/main/assigned_numbers/company_identifiers/company_identifiers.yaml https://usb.org/developers	-
data	"type": STRING	Manufacturer-specific data (Encoded as a base64 string when passed over JSON)	-

ScanEntry

OBJECT

Stores the advertisement packet information that is sent by a Bluetooth device.

-

PROPERTIES:

Name	Type	Description	Flags
deviceAddress	"type": STRING	-	-
rssi	"type": INTEGER	-	-
scanRecord	"$ref": ScanRecord	-	-

ScanRecord

OBJECT

Stores the byte data of the advertisement packet sent by a Bluetooth device.

-

PROPERTIES:

Name	Type	Description	Flags
name	"type": STRING	-	[OPTIONAL]
uuids	"type": ARRAY "items": { "type": STRING }	-	[OPTIONAL]
appearance	"type": INTEGER	Stores the external appearance description of the device.	[OPTIONAL]
txPower	"type": INTEGER	Stores the transmission power of a broadcasting device.	[OPTIONAL]
manufacturerData	"type": ARRAY "items": { "$ref": ManufacturerData }	Key is the company identifier and the value is an array of bytes of manufacturer specific data.	[OPTIONAL]

COMMANDS

Name

Description

Flags

addCharacteristic

-

PARAMETERS:

Name	Type	Description	Flags
serviceId	"type": STRING	-	-
characteristicUuid	"type": STRING	-	-
properties	"$ref": CharacteristicProperties	-	-

RETURNS:

Name	Type	Description	Flags
characteristicId	"type": STRING	An identifier that uniquely represents this characteristic.	-

addDescriptor

Adds a descriptor with |descriptorUuid| to the characteristic respresented by |characteristicId|.

-

PARAMETERS:

Name	Type	Description	Flags
characteristicId	"type": STRING	-	-
descriptorUuid	"type": STRING	-	-

RETURNS:

Name	Type	Description	Flags
descriptorId	"type": STRING	An identifier that uniquely represents this descriptor.	-

addService

Adds a service with |serviceUuid| to the peripheral with |address|.

-

PARAMETERS:

Name	Type	Description	Flags
address	"type": STRING	-	-
serviceUuid	"type": STRING	-	-

RETURNS:

Name	Type	Description	Flags
serviceId	"type": STRING	An identifier that uniquely represents this service.	-

disable

Disable the BluetoothEmulation domain.

-

enable

Enable the BluetoothEmulation domain.

-

PARAMETERS:

Name	Type	Description	Flags
state	"$ref": CentralState	State of the simulated central.	-
leSupported	"type": BOOLEAN	If the simulated central supports low-energy.	-

removeCharacteristic

Removes the characteristic respresented by |characteristicId| from the simulated central.

-

PARAMETERS:

Name	Type	Description	Flags
characteristicId	"type": STRING	-	-

removeDescriptor

Removes the descriptor with |descriptorId| from the simulated central.

-

PARAMETERS:

Name	Type	Description	Flags
descriptorId	"type": STRING	-	-

removeService

Removes the service respresented by |serviceId| from the simulated central.

-

PARAMETERS:

Name	Type	Description	Flags
serviceId	"type": STRING	-	-

setSimulatedCentralState

Set the state of the simulated central.

-

PARAMETERS:

Name	Type	Description	Flags
state	"$ref": CentralState	State of the simulated central.	-

simulateAdvertisement

Simulates an advertisement packet described in |entry| being received by the central.

-

PARAMETERS:

Name	Type	Description	Flags
entry	"$ref": ScanEntry	-	-

simulateCharacteristicOperationResponse

-

PARAMETERS:

Name	Type	Description	Flags
characteristicId	"type": STRING	-	-
type	"$ref": CharacteristicOperationType	-	-
code	"type": INTEGER	-	-
data	"type": STRING	-	[OPTIONAL]

simulateDescriptorOperationResponse

-

PARAMETERS:

Name	Type	Description	Flags
descriptorId	"type": STRING	-	-
type	"$ref": DescriptorOperationType	-	-
code	"type": INTEGER	-	-
data	"type": STRING	-	[OPTIONAL]

simulateGATTDisconnection

Simulates a GATT disconnection from the peripheral with |address|.

-

PARAMETERS:

Name	Type	Description	Flags
address	"type": STRING	-	-

simulateGATTOperationResponse

-

PARAMETERS:

Name	Type	Description	Flags
address	"type": STRING	-	-
type	"$ref": GATTOperationType	-	-
code	"type": INTEGER	-	-

simulatePreconnectedPeripheral

-

PARAMETERS:

Name	Type	Description	Flags
address	"type": STRING	-	-
name	"type": STRING	-	-
manufacturerData	"type": ARRAY "items": { "$ref": ManufacturerData }	-	-
knownServiceUuids	"type": ARRAY "items": { "type": STRING }	-	-

EVENTS

Name

Description

Flags

characteristicOperationReceived

-

PARAMETERS:

Name	Type	Description	Flags
characteristicId	"type": STRING	-	-
type	"$ref": CharacteristicOperationType	-	-
data	"type": STRING	-	[OPTIONAL]
writeType	"$ref": CharacteristicWriteType	-	[OPTIONAL]

descriptorOperationReceived

-

PARAMETERS:

Name	Type	Description	Flags
descriptorId	"type": STRING	-	-
type	"$ref": DescriptorOperationType	-	-
data	"type": STRING	-	[OPTIONAL]

gattOperationReceived

Event for when a GATT operation of |type| to the peripheral with |address| happened.

-

PARAMETERS:

Name	Type	Description	Flags
address	"type": STRING	-	-
type	"$ref": GATTOperationType	-	-

Browser

The Browser domain defines methods and events for browser managing.

TYPES

Type ID

Type

Description

Flags

Bounds

OBJECT

Browser window bounds information

[EXPERIMENTAL]

PROPERTIES:

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

BrowserCommandId

Browser command ids used by executeBrowserCommand.

[EXPERIMENTAL]

BrowserContextID

STRING

-

[EXPERIMENTAL]

Bucket

OBJECT

Chrome histogram bucket.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
low	"type": INTEGER	Minimum value (inclusive).	-
high	"type": INTEGER	Maximum value (exclusive).	-
count	"type": INTEGER	Number of samples.	-

Histogram

OBJECT

Chrome histogram.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
name	"type": STRING	Name.	-
sum	"type": INTEGER	Sum of sample values.	-
count	"type": INTEGER	Total number of samples.	-
buckets	"type": ARRAY "items": { "$ref": Bucket }	Buckets.	-

PermissionDescriptor

OBJECT

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

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
name	"type": 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	"type": BOOLEAN	For "midi" permission, may also specify sysex control.	[OPTIONAL]
userVisibleOnly	"type": BOOLEAN	For "push" permission, may specify userVisibleOnly. Note that userVisibleOnly = true is the only currently supported type.	[OPTIONAL]
allowWithoutSanitization	"type": BOOLEAN	For "clipboard" permission, may specify allowWithoutSanitization.	[OPTIONAL]
allowWithoutGesture	"type": BOOLEAN	For "fullscreen" permission, must specify allowWithoutGesture:true.	[OPTIONAL]
panTiltZoom	"type": BOOLEAN	For "camera" permission, may specify panTiltZoom.	[OPTIONAL]

PermissionSetting

-

[EXPERIMENTAL]

PermissionType

-

[EXPERIMENTAL]

PrivacySandboxAPI

-

[EXPERIMENTAL]

WindowID

INTEGER

-

[EXPERIMENTAL]

WindowState

The state of the browser window.

[EXPERIMENTAL]

COMMANDS

Name

Description

Flags

addPrivacySandboxCoordinatorKeyConfig

Configures encryption keys used with a given privacy sandbox API to talk to a trusted coordinator. Since this is intended for test automation only, coordinatorOrigin must be a .test domain. No existing coordinator configuration for the origin may exist.

-

PARAMETERS:

Name	Type	Description	Flags
api	"$ref": PrivacySandboxAPI	-	-
coordinatorOrigin	"type": STRING	-	-
keyConfig	"type": STRING	-	-
browserContextId	"$ref": BrowserContextID	BrowserContext to perform the action in. When omitted, default browser context is used.	[OPTIONAL]

addPrivacySandboxEnrollmentOverride

Allows a site to use privacy sandbox features that require enrollment without the site actually being enrolled. Only supported on page targets.

-

PARAMETERS:

Name	Type	Description	Flags
url	"type": STRING	-	-

cancelDownload

Cancel a download if in progress

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
guid	"type": 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]

executeBrowserCommand

Invoke custom browser commands used by telemetry.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
commandId	"$ref": BrowserCommandId	-	-

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	"type": ARRAY "items": { "type": STRING }	Commandline parameters	-

getHistogram

Get a Chrome histogram by name.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
name	"type": STRING	Requested histogram name.	-
delta	"type": BOOLEAN	If true, retrieve delta since last delta call.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
histogram	"$ref": Histogram	Histogram.	-

getHistograms

Get Chrome histograms.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
query	"type": 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	"type": BOOLEAN	If true, retrieve delta since last delta call.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
histograms	"type": ARRAY "items": { "$ref": Histogram }	Histograms.	-

getVersion

Returns version information.

-

RETURNS:

Name	Type	Description	Flags
protocolVersion	"type": STRING	Protocol version.	-
product	"type": STRING	Product name.	-
revision	"type": STRING	Product revision.	-
userAgent	"type": STRING	User-Agent.	-
jsVersion	"type": STRING	V8 version.	-

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

grantPermissions

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

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
permissions	"type": ARRAY "items": { "$ref": PermissionType }	-	-
origin	"type": 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.

-

PARAMETERS:

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

setContentsSize

Set size of the browser contents resizing browser window as necessary.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
windowId	"$ref": WindowID	Browser window id.	-
width	"type": INTEGER	The window contents width in DIP. Assumes current width if omitted. Must be specified if 'height' is omitted.	[OPTIONAL]
height	"type": INTEGER	The window contents height in DIP. Assumes current height if omitted. Must be specified if 'width' is omitted.	[OPTIONAL]

setDockTile

Set dock tile details, platform-specific.

[EXPERIMENTAL]

PARAMETERS:

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

setDownloadBehavior

Set the behavior when downloading a file.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
behavior	"allow", "allowAndName", "default", "deny"String [Hover] Enum "type": STRING	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 download guids.	-
browserContextId	"$ref": BrowserContextID	BrowserContext to set download behavior. When omitted, default browser context is used.	[OPTIONAL]
downloadPath	"type": STRING	The default path to save downloaded files to. This is required if behavior is set to 'allow' or 'allowAndName'.	[OPTIONAL]
eventsEnabled	"type": BOOLEAN	Whether to emit download events (defaults to false).	[OPTIONAL]

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	"type": 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]

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

EVENTS

Name

Description

Flags

downloadProgress

Fired when download makes progress. Last call has |done| == true.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
guid	"type": STRING	Global unique identifier of the download.	-
totalBytes	"type": NUMBER	Total expected bytes to download.	-
receivedBytes	"type": NUMBER	Total bytes received.	-
state	"canceled", "completed", "inProgress"String [Hover] Enum "type": STRING	Download status.	-
filePath	"type": STRING	If download is "completed", provides the path of the downloaded file. Depending on the platform, it is not guaranteed to be set, nor the file is guaranteed to exist.	[OPTIONAL] [EXPERIMENTAL]

downloadWillBegin

Fired when page is about to start a download.

[EXPERIMENTAL]

PARAMETERS:

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

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

CSSAnimationStyle

OBJECT

CSS style coming from animations with the name of the animation.

-

PROPERTIES:

Name	Type	Description	Flags
name	"type": STRING	The name of the animation.	[OPTIONAL]
style	"$ref": CSSStyle	The style coming from the animation.	-

CSSComputedStyleProperty

OBJECT

-

PROPERTIES:

Name	Type	Description	Flags
name	"type": STRING	Computed style property name.	-
value	"type": STRING	Computed style property value.	-

CSSContainerQuery

OBJECT

CSS container query rule descriptor.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
text	"type": 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	"type": STRING	Optional name for the container.	[OPTIONAL]
physicalAxes	"$ref": DOM.PhysicalAxes	Optional physical axes queried for the container.	[OPTIONAL]
logicalAxes	"$ref": DOM.LogicalAxes	Optional logical axes queried for the container.	[OPTIONAL]
queriesScrollState	"type": BOOLEAN	true if the query contains scroll-state() queries.	[OPTIONAL]
queriesAnchored	"type": BOOLEAN	true if the query contains anchored() queries.	[OPTIONAL]

CSSFontPaletteValuesRule

OBJECT

CSS font-palette-values 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.	-
fontPaletteName	"$ref": Value	Associated font palette name.	-
style	"$ref": CSSStyle	Associated style declaration.	-

CSSFunctionConditionNode

OBJECT

CSS function conditional block representation.

-

PROPERTIES:

Name	Type	Description	Flags
media	"$ref": CSSMedia	Media query for this conditional block. Only one type of condition should be set.	[OPTIONAL]
containerQueries	"$ref": CSSContainerQuery	Container query for this conditional block. Only one type of condition should be set.	[OPTIONAL]
supports	"$ref": CSSSupports	@supports CSS at-rule condition. Only one type of condition should be set.	[OPTIONAL]
children	"type": ARRAY "items": { "$ref": CSSFunctionNode }	Block body.	-
conditionText	"type": STRING	The condition text.	-

CSSFunctionNode

OBJECT

Section of the body of a CSS function rule.

-

PROPERTIES:

Name	Type	Description	Flags
condition	"$ref": CSSFunctionConditionNode	A conditional block. If set, style should not be set.	[OPTIONAL]
style	"$ref": CSSStyle	Values set by this node. If set, condition should not be set.	[OPTIONAL]

CSSFunctionParameter

OBJECT

CSS function argument representation.

-

PROPERTIES:

Name	Type	Description	Flags
name	"type": STRING	The parameter name.	-
type	"type": STRING	The parameter type.	-

CSSFunctionRule

OBJECT

CSS function at-rule representation.

-

PROPERTIES:

Name	Type	Description	Flags
name	"$ref": Value	Name of the function.	-
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.	-
parameters	"type": ARRAY "items": { "$ref": CSSFunctionParameter }	List of parameters.	-
children	"type": ARRAY "items": { "$ref": CSSFunctionNode }	Function body.	-

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

CSSKeyframesRule

OBJECT

CSS keyframes rule representation.

-

PROPERTIES:

Name	Type	Description	Flags
animationName	"$ref": Value	Animation name.	-
keyframes	"type": ARRAY "items": { "$ref": CSSKeyframeRule }	List of keyframes.	-

CSSLayer

OBJECT

CSS Layer at-rule descriptor.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
text	"type": STRING	Layer name.	-
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]

CSSLayerData

OBJECT

CSS Layer data.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
name	"type": STRING	Layer name.	-
subLayers	"type": ARRAY "items": { "$ref": CSSLayerData }	Direct sub-layers	[OPTIONAL]
order	"type": NUMBER	Layer order. The order determines the order of the layer in the cascade order. A higher number has higher priority in the cascade order.	-

CSSMedia

OBJECT

CSS media rule descriptor.

-

PROPERTIES:

Name	Type	Description	Flags
text	"type": STRING	Media query text.	-
source	"importRule", "inlineSheet", "linkedSheet", "mediaRule"String [Hover] Enum "type": STRING	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	"type": 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	"type": ARRAY "items": { "$ref": MediaQuery }	Array of media queries.	[OPTIONAL]

CSSPositionTryRule

OBJECT

CSS @position-try rule representation.

-

PROPERTIES:

Name	Type	Description	Flags
name	"$ref": Value	The prelude dashed-ident name	-
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.	-
style	"$ref": CSSStyle	Associated style declaration.	-
active	"type": BOOLEAN	-	-

CSSProperty

OBJECT

CSS property declaration data.

-

PROPERTIES:

Name	Type	Description	Flags
name	"type": STRING	The property name.	-
value	"type": STRING	The property value.	-
important	"type": BOOLEAN	Whether the property has "!important" annotation (implies `false` if absent).	[OPTIONAL]
implicit	"type": BOOLEAN	Whether the property is implicit (implies `false` if absent).	[OPTIONAL]
text	"type": STRING	The full property text as specified in the style.	[OPTIONAL]
parsedOk	"type": BOOLEAN	Whether the property is understood by the browser (implies `true` if absent).	[OPTIONAL]
disabled	"type": 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]
longhandProperties	"type": ARRAY "items": { "$ref": CSSProperty }	Parsed longhand components of this property if it is a shorthand. This field will be empty if the given property is not a shorthand.	[OPTIONAL] [EXPERIMENTAL]

CSSPropertyRegistration

OBJECT

Representation of a custom property registration through CSS.registerProperty

-

PROPERTIES:

Name	Type	Description	Flags
propertyName	"type": STRING	-	-
initialValue	"$ref": Value	-	[OPTIONAL]
inherits	"type": BOOLEAN	-	-
syntax	"type": STRING	-	-

CSSPropertyRule

OBJECT

CSS property at-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.	-
propertyName	"$ref": Value	Associated property name.	-
style	"$ref": CSSStyle	Associated style declaration.	-

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.	-
nestingSelectors	"type": ARRAY "items": { "type": STRING }	Array of selectors from ancestor style rules, sorted by distance from the current rule.	[OPTIONAL] [EXPERIMENTAL]
origin	"$ref": StyleSheetOrigin	Parent stylesheet's origin.	-
style	"$ref": CSSStyle	Associated style declaration.	-
media	"type": ARRAY "items": { "$ref": CSSMedia }	Media list array (for rules involving media queries). The array enumerates media queries starting with the innermost one, going outwards.	[OPTIONAL]
containerQueries	"type": ARRAY "items": { "$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]
supports	"type": ARRAY "items": { "$ref": CSSSupports }	@supports CSS at-rule array. The array enumerates @supports at-rules starting with the innermost one, going outwards.	[OPTIONAL] [EXPERIMENTAL]
layers	"type": ARRAY "items": { "$ref": CSSLayer }	Cascade layer array. Contains the layer hierarchy that this rule belongs to starting with the innermost layer and going outwards.	[OPTIONAL] [EXPERIMENTAL]
scopes	"type": ARRAY "items": { "$ref": CSSScope }	@scope CSS at-rule array. The array enumerates @scope at-rules starting with the innermost one, going outwards.	[OPTIONAL] [EXPERIMENTAL]
ruleTypes	"type": ARRAY "items": { "$ref": CSSRuleType }	The array keeps the types of ancestor CSSRules from the innermost going outwards.	[OPTIONAL] [EXPERIMENTAL]
startingStyles	"type": ARRAY "items": { "$ref": CSSStartingStyle }	@starting-style CSS at-rule array. The array enumerates @starting-style at-rules starting with the innermost one, going outwards.	[OPTIONAL] [EXPERIMENTAL]

CSSRuleType

Enum indicating the type of a CSS rule, used to represent the order of a style rule's ancestors. This list only contains rule types that are collected during the ancestor rule collection.

[EXPERIMENTAL]

CSSScope

OBJECT

CSS Scope at-rule descriptor.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
text	"type": STRING	Scope rule 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]

CSSStartingStyle

OBJECT

CSS Starting Style at-rule descriptor.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
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]

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	"type": ARRAY "items": { "$ref": CSSProperty }	CSS properties in the style.	-
shorthandEntries	"type": ARRAY "items": { "$ref": ShorthandEntry }	Computed values for all shorthands found in the style.	-
cssText	"type": STRING	Style declaration text (if available).	[OPTIONAL]
range	"$ref": SourceRange	Style declaration range in the enclosing stylesheet (if available).	[OPTIONAL]

CSSStyleSheetHeader

OBJECT

CSS stylesheet metainformation.

-

PROPERTIES:

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

CSSSupports

OBJECT

CSS Supports at-rule descriptor.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
text	"type": STRING	Supports rule text.	-
active	"type": BOOLEAN	Whether the supports condition is satisfied.	-
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]

CSSTryRule

OBJECT

CSS try 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.	-
style	"$ref": CSSStyle	Associated style declaration.	-

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	"type": STRING	The font-family.	-
fontStyle	"type": STRING	The font-style.	-
fontVariant	"type": STRING	The font-variant.	-
fontWeight	"type": STRING	The font-weight.	-
fontStretch	"type": STRING	The font-stretch.	-
fontDisplay	"type": STRING	The font-display.	-
unicodeRange	"type": STRING	The unicode-range.	-
src	"type": STRING	The src.	-
platformFontFamily	"type": STRING	The resolved platform font family	-
fontVariationAxes	"type": ARRAY "items": { "$ref": FontVariationAxis }	Available variation settings (a.k.a. "axes").	[OPTIONAL]

FontVariationAxis

OBJECT

Information about font variation axes for variable fonts

-

PROPERTIES:

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

InheritedAnimatedStyleEntry

OBJECT

Inherited CSS style collection for animated styles from ancestor node.

-

PROPERTIES:

Name	Type	Description	Flags
animationStyles	"type": ARRAY "items": { "$ref": CSSAnimationStyle }	Styles coming from the animations of the ancestor, if any, in the style inheritance chain.	[OPTIONAL]
transitionsStyle	"$ref": CSSStyle	The style coming from the transitions of the ancestor, if any, in the style inheritance chain.	[OPTIONAL]

InheritedPseudoElementMatches

OBJECT

Inherited pseudo element matches from pseudos of an ancestor node.

-

PROPERTIES:

Name	Type	Description	Flags
pseudoElements	"type": ARRAY "items": { "$ref": PseudoElementMatches }	Matches of pseudo styles from the pseudos of an ancestor node.	-

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	"type": ARRAY "items": { "$ref": RuleMatch }	Matches of CSS rules matching the ancestor node in the style inheritance chain.	-

MediaQuery

OBJECT

Media query descriptor.

-

PROPERTIES:

Name	Type	Description	Flags
expressions	"type": ARRAY "items": { "$ref": MediaQueryExpression }	Array of media query expressions.	-
active	"type": BOOLEAN	Whether the media query condition is satisfied.	-

MediaQueryExpression

OBJECT

Media query expression descriptor.

-

PROPERTIES:

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

PlatformFontUsage

OBJECT

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

-

PROPERTIES:

Name	Type	Description	Flags
familyName	"type": STRING	Font's family name reported by platform.	-
postScriptName	"type": STRING	Font's PostScript name reported by platform.	-
isCustomFont	"type": BOOLEAN	Indicates if the font was downloaded or resolved locally.	-
glyphCount	"type": NUMBER	Amount of glyphs that were rendered with this font.	-

PseudoElementMatches

OBJECT

CSS rule collection for a single pseudo style.

-

PROPERTIES:

Name	Type	Description	Flags
pseudoType	"$ref": DOM.PseudoType	Pseudo element type.	-
pseudoIdentifier	"type": STRING	Pseudo element custom ident.	[OPTIONAL]
matches	"type": ARRAY "items": { "$ref": RuleMatch }	Matches of CSS rules applicable to the pseudo style.	-

RuleMatch

OBJECT

Match data for a CSS rule.

-

PROPERTIES:

Name	Type	Description	Flags
rule	"$ref": CSSRule	CSS rule in the match.	-
matchingSelectors	"type": ARRAY "items": { "type": INTEGER }	Matching selector indices in the rule's selectorList selectors (0-based).	-

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	"type": NUMBER	Offset of the start of the rule (including selector) from the beginning of the stylesheet.	-
endOffset	"type": NUMBER	Offset of the end of the rule body from the beginning of the stylesheet.	-
used	"type": BOOLEAN	Indicates whether the rule was actually used by some element in the page.	-

SelectorList

OBJECT

Selector list data.

-

PROPERTIES:

Name	Type	Description	Flags
selectors	"type": ARRAY "items": { "$ref": Value }	Selectors in the list.	-
text	"type": STRING	Rule selector text.	-

ShorthandEntry

OBJECT

-

PROPERTIES:

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

SourceRange

OBJECT

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

-

PROPERTIES:

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

Specificity

OBJECT

Specificity: https://drafts.csswg.org/selectors/#specificity-rules

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
a	"type": INTEGER	The a component, which represents the number of ID selectors.	-
b	"type": INTEGER	The b component, which represents the number of class selectors, attributes selectors, and pseudo-classes.	-
c	"type": INTEGER	The c component, which represents the number of type selectors and pseudo-elements.	-

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	"type": STRING	New style text.	-

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.

-

Value

OBJECT

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

-

PROPERTIES:

Name	Type	Description	Flags
text	"type": STRING	Value text.	-
range	"$ref": SourceRange	Value range in the underlying resource (if available).	[OPTIONAL]
specificity	"$ref": Specificity	Specificity of the selector.	[OPTIONAL] [EXPERIMENTAL]

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	"type": STRING	The text of a new rule.	-
location	"$ref": SourceRange	Text position of a new rule in the target style sheet.	-
nodeForPropertySyntaxValidation	"$ref": DOM.NodeId	NodeId for the DOM node in whose context custom property declarations for registered properties should be validated. If omitted, declarations in the new rule text can only be validated statically, which may produce incorrect results if the declaration contains a var() for example.	[OPTIONAL] [EXPERIMENTAL]

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	"type": ARRAY "items": { "type": 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.	-
force	"type": BOOLEAN	If true, creates a new stylesheet for every call. If false, returns a stylesheet previously created by a call with force=false for the frame's document if it exists or creates a new stylesheet (default: false).	[OPTIONAL]

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	"type": ARRAY "items": { "type": STRING }	Element pseudo classes to force when computing the element's style.	-

forceStartingStyle

Ensures that the given node is in its starting-style state.

-

PARAMETERS:

Name	Type	Description	Flags
nodeId	"$ref": DOM.NodeId	The element id for which to force the starting-style state.	-
forced	"type": BOOLEAN	Boolean indicating if this is on or off.	-

getAnimatedStylesForNode

Returns the styles coming from animations & transitions including the animation & transition styles coming from inheritance chain.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
nodeId	"$ref": DOM.NodeId	-	-

RETURNS:

Name	Type	Description	Flags
animationStyles	"type": ARRAY "items": { "$ref": CSSAnimationStyle }	Styles coming from animations.	[OPTIONAL]
transitionsStyle	"$ref": CSSStyle	Style coming from transitions.	[OPTIONAL]
inherited	"type": ARRAY "items": { "$ref": InheritedAnimatedStyleEntry }	Inherited style entries for animationsStyle and transitionsStyle from the inheritance chain of the element.	[OPTIONAL]

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	"type": ARRAY "items": { "type": 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	"type": STRING	The computed font size for this node, as a CSS computed value string (e.g. '12px').	[OPTIONAL]
computedFontWeight	"type": 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	"type": ARRAY "items": { "$ref": CSSComputedStyleProperty }	Computed style for the specified DOM node.	-

getEnvironmentVariables

Returns the values of the default UA-defined environment variables used in env()

[EXPERIMENTAL]

RETURNS:

Name	Type	Description	Flags
environmentVariables	"type": OBJECT	-	-

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]

getLayersForNode

Returns all layers parsed by the rendering engine for the tree scope of a node. Given a DOM element identified by nodeId, getLayersForNode returns the root layer for the nearest ancestor document or shadow root. The layer root contains the full layer tree for the tree scope and their ordering.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
nodeId	"$ref": DOM.NodeId	-	-

RETURNS:

Name	Type	Description	Flags
rootLayer	"$ref": CSSLayerData	-	-

getLocationForSelector

Given a CSS selector text and a style sheet ID, getLocationForSelector returns an array of locations of the CSS selector in the style sheet.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
styleSheetId	"$ref": StyleSheetId	-	-
selectorText	"type": STRING	-	-

RETURNS:

Name	Type	Description	Flags
ranges	"type": ARRAY "items": { "$ref": SourceRange }	-	-

getLonghandProperties

-

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
shorthandName	"type": STRING	-	-
value	"type": STRING	-	-

RETURNS:

Name	Type	Description	Flags
longhandProperties	"type": ARRAY "items": { "$ref": CSSProperty }	-	-

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	"type": ARRAY "items": { "$ref": RuleMatch }	CSS rules matching this node, from all applicable stylesheets.	[OPTIONAL]
pseudoElements	"type": ARRAY "items": { "$ref": PseudoElementMatches }	Pseudo style matches for this node.	[OPTIONAL]
inherited	"type": ARRAY "items": { "$ref": InheritedStyleEntry }	A chain of inherited styles (from the immediate node parent up to the DOM tree root).	[OPTIONAL]
inheritedPseudoElements	"type": ARRAY "items": { "$ref": InheritedPseudoElementMatches }	A chain of inherited pseudo element styles (from the immediate node parent up to the DOM tree root).	[OPTIONAL]
cssKeyframesRules	"type": ARRAY "items": { "$ref": CSSKeyframesRule }	A list of CSS keyframed animations matching this node.	[OPTIONAL]
cssPositionTryRules	"type": ARRAY "items": { "$ref": CSSPositionTryRule }	A list of CSS @position-try rules matching this node, based on the position-try-fallbacks property.	[OPTIONAL]
activePositionFallbackIndex	"type": INTEGER	Index of the active fallback in the applied position-try-fallback property, will not be set if there is no active position-try fallback.	[OPTIONAL]
cssPropertyRules	"type": ARRAY "items": { "$ref": CSSPropertyRule }	A list of CSS at-property rules matching this node.	[OPTIONAL]
cssPropertyRegistrations	"type": ARRAY "items": { "$ref": CSSPropertyRegistration }	A list of CSS property registrations matching this node.	[OPTIONAL]
cssFontPaletteValuesRule	"$ref": CSSFontPaletteValuesRule	A font-palette-values rule matching this node.	[OPTIONAL]
parentLayoutNodeId	"$ref": DOM.NodeId	Id of the first parent element that does not have display: contents.	[OPTIONAL] [EXPERIMENTAL]
cssFunctionRules	"type": ARRAY "items": { "$ref": CSSFunctionRule }	A list of CSS at-function rules referenced by styles of this node.	[OPTIONAL] [EXPERIMENTAL]

getMediaQueries

Returns all media queries parsed by the rendering engine.

-

RETURNS:

Name	Type	Description	Flags
medias	"type": ARRAY "items": { "$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	"type": ARRAY "items": { "$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	"type": STRING	The stylesheet text.	-

resolveValues

Resolve the specified values in the context of the provided element. For example, a value of '1em' is evaluated according to the computed 'font-size' of the element and a value 'calc(1px + 2px)' will be resolved to '3px'. If the `propertyName` was specified the `values` are resolved as if they were property's declaration. If a value cannot be parsed according to the provided property syntax, the value is parsed using combined syntax as if null `propertyName` was provided. If the value cannot be resolved even then, return the provided value without any changes.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
values	"type": ARRAY "items": { "type": STRING }	Substitution functions (var()/env()/attr()) and cascade-dependent keywords (revert/revert-layer) do not work.	-
nodeId	"$ref": DOM.NodeId	Id of the node in whose context the expression is evaluated	-
propertyName	"type": STRING	Only longhands and custom property names are accepted.	[OPTIONAL]
pseudoType	"$ref": DOM.PseudoType	Pseudo element type, only works for pseudo elements that generate elements in the tree, such as ::before and ::after.	[OPTIONAL]
pseudoIdentifier	"type": STRING	Pseudo element custom ident.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
results	"type": ARRAY "items": { "type": STRING }	-	-

setContainerQueryText

Modifies the expression of a container query.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
styleSheetId	"$ref": StyleSheetId	-	-
range	"$ref": SourceRange	-	-
text	"type": STRING	-	-

RETURNS:

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

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	"type": STRING	-	-
value	"type": STRING	-	-

setKeyframeKey

Modifies the keyframe rule key text.

-

PARAMETERS:

Name	Type	Description	Flags
styleSheetId	"$ref": StyleSheetId	-	-
range	"$ref": SourceRange	-	-
keyText	"type": STRING	-	-

RETURNS:

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

setLocalFontsEnabled

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

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
enabled	"type": BOOLEAN	Whether rendering of local fonts is enabled.	-

setMediaText

Modifies the rule selector.

-

PARAMETERS:

Name	Type	Description	Flags
styleSheetId	"$ref": StyleSheetId	-	-
range	"$ref": SourceRange	-	-
text	"type": STRING	-	-

RETURNS:

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

setPropertyRulePropertyName

Modifies the property rule property name.

-

PARAMETERS:

Name	Type	Description	Flags
styleSheetId	"$ref": StyleSheetId	-	-
range	"$ref": SourceRange	-	-
propertyName	"type": STRING	-	-

RETURNS:

Name	Type	Description	Flags
propertyName	"$ref": Value	The resulting key text after modification.	-

setRuleSelector

Modifies the rule selector.

-

PARAMETERS:

Name	Type	Description	Flags
styleSheetId	"$ref": StyleSheetId	-	-
range	"$ref": SourceRange	-	-
selector	"type": STRING	-	-

RETURNS:

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

setScopeText

Modifies the expression of a scope at-rule.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
styleSheetId	"$ref": StyleSheetId	-	-
range	"$ref": SourceRange	-	-
text	"type": STRING	-	-

RETURNS:

Name	Type	Description	Flags
scope	"$ref": CSSScope	The resulting CSS Scope rule after modification.	-

setStyleSheetText

Sets the new stylesheet text.

-

PARAMETERS:

Name	Type	Description	Flags
styleSheetId	"$ref": StyleSheetId	-	-
text	"type": STRING	-	-

RETURNS:

Name	Type	Description	Flags
sourceMapURL	"type": 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	"type": ARRAY "items": { "$ref": StyleDeclarationEdit }	-	-
nodeForPropertySyntaxValidation	"$ref": DOM.NodeId	NodeId for the DOM node in whose context custom property declarations for registered properties should be validated. If omitted, declarations in the new rule text can only be validated statically, which may produce incorrect results if the declaration contains a var() for example.	[OPTIONAL] [EXPERIMENTAL]

RETURNS:

Name	Type	Description	Flags
styles	"type": ARRAY "items": { "$ref": CSSStyle }	The resulting styles after modification.	-

setSupportsText

Modifies the expression of a supports at-rule.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
styleSheetId	"$ref": StyleSheetId	-	-
range	"$ref": SourceRange	-	-
text	"type": STRING	-	-

RETURNS:

Name	Type	Description	Flags
supports	"$ref": CSSSupports	The resulting CSS Supports rule 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	"type": ARRAY "items": { "$ref": RuleUsage }	-	-

takeComputedStyleUpdates

Polls the next batch of computed style updates.

[EXPERIMENTAL]

RETURNS:

Name	Type	Description	Flags
nodeIds	"type": ARRAY "items": { "$ref": DOM.NodeId }	The list of node Ids that have their tracked computed styles updated.	-

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	"type": ARRAY "items": { "$ref": RuleUsage }	-	-
timestamp	"type": NUMBER	Monotonically increasing time, in seconds.	-

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	"type": ARRAY "items": { "$ref": CSSComputedStyleProperty }	-	-

trackComputedStyleUpdatesForNode

Starts tracking the given node for the computed style updates and whenever the computed style is updated for node, it queues a `computedStyleUpdated` event with throttling. There can only be 1 node tracked for computed style updates so passing a new node id removes tracking from the previous node. Pass `undefined` to disable tracking.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
nodeId	"$ref": DOM.NodeId	-	[OPTIONAL]

EVENTS

Name

Description

Flags

computedStyleUpdated

-

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
nodeId	"$ref": DOM.NodeId	The node id that has updated computed styles.	-

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]

-

Dependencies: Storage

TYPES

Type ID

Type

Description

Flags

Cache

OBJECT

Cache identifier.

-

PROPERTIES:

Name	Type	Description	Flags
cacheId	"$ref": CacheId	An opaque unique id of the cache.	-
securityOrigin	"type": STRING	Security origin of the cache.	-
storageKey	"type": STRING	Storage key of the cache.	-
storageBucket	"$ref": Storage.StorageBucket	Storage bucket of the cache.	[OPTIONAL]
cacheName	"type": STRING	The name of the cache.	-

CacheId

STRING

Unique identifier of the Cache object.

-

CachedResponse

OBJECT

Cached response

-

PROPERTIES:

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

CachedResponseType

type of HTTP response cached

-

DataEntry

OBJECT

Data entry.

-

PROPERTIES:

Name	Type	Description	Flags
requestURL	"type": STRING	Request URL.	-
requestMethod	"type": STRING	Request method.	-
requestHeaders	"type": ARRAY "items": { "$ref": Header }	Request headers	-
responseTime	"type": NUMBER	Number of seconds since epoch.	-
responseStatus	"type": INTEGER	HTTP response status code.	-
responseStatusText	"type": STRING	HTTP response status text.	-
responseType	"$ref": CachedResponseType	HTTP response type	-
responseHeaders	"type": ARRAY "items": { "$ref": Header }	Response headers	-

PROPERTIES:

Name	Type	Description	Flags
name	"type": STRING	-	-
value	"type": STRING	-	-

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	"type": STRING	URL spec of the request.	-

requestCacheNames

Requests cache names.

-

PARAMETERS:

Name	Type	Description	Flags
securityOrigin	"type": STRING	At least and at most one of securityOrigin, storageKey, storageBucket must be specified. Security origin.	[OPTIONAL]
storageKey	"type": STRING	Storage key.	[OPTIONAL]
storageBucket	"$ref": Storage.StorageBucket	Storage bucket. If not specified, it uses the default bucket.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
caches	"type": ARRAY "items": { "$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	"type": STRING	URL spec of the request.	-
requestHeaders	"type": ARRAY "items": { "$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	"type": INTEGER	Number of records to skip.	[OPTIONAL]
pageSize	"type": INTEGER	Number of records to fetch.	[OPTIONAL]
pathFilter	"type": STRING	If present, only return the entries containing this substring in the path	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
cacheDataEntries	"type": ARRAY "items": { "$ref": DataEntry }	Array of object store data entries.	-
returnCount	"type": 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.

COMMANDS

Name

Description

Flags

disable

Stops observing for sinks and issues.

-

enable

-

PARAMETERS:

Name	Type	Description	Flags
presentationUrl	"type": STRING	-	[OPTIONAL]

setSinkToUse

Sets a sink to be used when the web page requests the browser to choose a sink via Presentation API, Remote Playback API, or Cast SDK.

-

PARAMETERS:

Name	Type	Description	Flags
sinkName	"type": STRING	-	-

startDesktopMirroring

Starts mirroring the desktop to the sink.

-

PARAMETERS:

Name	Type	Description	Flags
sinkName	"type": STRING	-	-

startTabMirroring

Starts mirroring the tab to the sink.

-

PARAMETERS:

Name	Type	Description	Flags
sinkName	"type": STRING	-	-

stopCasting

Stops the active Cast session on the sink.

-

PARAMETERS:

Name	Type	Description	Flags
sinkName	"type": STRING	-	-

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

BackendNode

OBJECT

Backend node with a friendly name.

-

PROPERTIES:

Name	Type	Description	Flags
nodeType	"type": INTEGER	`Node`'s nodeType.	-
nodeName	"type": STRING	`Node`'s nodeName.	-
backendNodeId	"$ref": BackendNodeId	-	-

BackendNodeId

INTEGER

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

-

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	"type": INTEGER	Node width	-
height	"type": INTEGER	Node height	-
shapeOutside	"$ref": ShapeOutsideInfo	Shape outside coordinates	[OPTIONAL]

CSSComputedStyleProperty

OBJECT

-

PROPERTIES:

Name	Type	Description	Flags
name	"type": STRING	Computed style property name.	-
value	"type": STRING	Computed style property value.	-

CompatibilityMode

Document compatibility mode.

-

DetachedElementInfo

OBJECT

A structure to hold the top-level node of a detached tree and an array of its retained descendants.

-

PROPERTIES:

Name	Type	Description	Flags
treeNode	"$ref": Node	-	-
retainedNodeIds	"type": ARRAY "items": { "$ref": NodeId }	-	-

LogicalAxes

ContainerSelector logical axes

-

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	"type": INTEGER	`Node`'s nodeType.	-
nodeName	"type": STRING	`Node`'s nodeName.	-
localName	"type": STRING	`Node`'s localName.	-
nodeValue	"type": STRING	`Node`'s nodeValue.	-
childNodeCount	"type": INTEGER	Child count for `Container` nodes.	[OPTIONAL]
children	"type": ARRAY "items": { "$ref": Node }	Child nodes of this node when requested with children.	[OPTIONAL]
attributes	"type": ARRAY "items": { "type": STRING }	Attributes of the `Element` node in the form of flat array `[name1, value1, name2, value2]`.	[OPTIONAL]
documentURL	"type": STRING	Document URL that `Document` or `FrameOwner` node points to.	[OPTIONAL]
baseURL	"type": STRING	Base URL that `Document` or `FrameOwner` node uses for URL completion.	[OPTIONAL]
publicId	"type": STRING	`DocumentType`'s publicId.	[OPTIONAL]
systemId	"type": STRING	`DocumentType`'s systemId.	[OPTIONAL]
internalSubset	"type": STRING	`DocumentType`'s internalSubset.	[OPTIONAL]
xmlVersion	"type": STRING	`Document`'s XML version in case of XML documents.	[OPTIONAL]
name	"type": STRING	`Attr`'s name.	[OPTIONAL]
value	"type": STRING	`Attr`'s value.	[OPTIONAL]
pseudoType	"$ref": PseudoType	Pseudo element type for this node.	[OPTIONAL]
pseudoIdentifier	"type": STRING	Pseudo element identifier for this node. Only present if there is a valid pseudoType.	[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	"type": ARRAY "items": { "$ref": Node }	Shadow root list for given element host.	[OPTIONAL]
templateContent	"$ref": Node	Content document fragment for template elements.	[OPTIONAL]
pseudoElements	"type": ARRAY "items": { "$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	"type": ARRAY "items": { "$ref": BackendNode }	Distributed nodes for given insertion point.	[OPTIONAL]
isSVG	"type": BOOLEAN	Whether the node is SVG.	[OPTIONAL]
compatibilityMode	"$ref": CompatibilityMode	-	[OPTIONAL]
assignedSlot	"$ref": BackendNode	-	[OPTIONAL]
isScrollable	"type": BOOLEAN	-	[OPTIONAL] [EXPERIMENTAL]

NodeId

INTEGER

Unique DOM node identifier.

-

PhysicalAxes

ContainerSelector physical axes

-

PseudoType

Pseudo element type.

-

Quad

"type": "array"
"items":
{ NUMBER }

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

-

RGBA

OBJECT

A structure holding an RGBA color.

-

PROPERTIES:

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

Rect

OBJECT

Rectangle.

-

PROPERTIES:

Name	Type	Description	Flags
x	"type": NUMBER	X coordinate	-
y	"type": NUMBER	Y coordinate	-
width	"type": NUMBER	Rectangle width	-
height	"type": NUMBER	Rectangle height	-

ScrollOrientation

Physical scroll orientation

-

ShadowRootType

Shadow root type.

-

ShapeOutsideInfo

OBJECT

CSS Shape Outside details.

-

PROPERTIES:

Name	Type	Description	Flags
bounds	"$ref": Quad	Shape bounds	-
shape	"type": ARRAY "items": { "type": ANY }	Shape coordinate details	-
marginShape	"type": ARRAY "items": { "type": ANY }	Margin shape bounds	-

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	"type": ARRAY "items": { "type": 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	"type": 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	"type": 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.	-

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	"type": STRING	Unique search session identifier.	-

enable

Enables DOM agent for the given page.

-

PARAMETERS:

Name	Type	Description	Flags
includeWhitespace	"all", "none"String [Hover] Enum "type": STRING	Whether to include whitespaces in the children array of returned Nodes.	[OPTIONAL] [EXPERIMENTAL]

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]

forceShowPopover

When enabling, this API force-opens the popover identified by nodeId and keeps it open until disabled.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
nodeId	"$ref": NodeId	Id of the popover HTMLElement	-
enable	"type": BOOLEAN	If true, opens the popover and keeps it open. If false, closes the popover if it was previously force-opened.	-

RETURNS:

Name	Type	Description	Flags
nodeIds	"type": ARRAY "items": { "$ref": NodeId }	List of popovers that were closed in order to respect popover stacking order.	-

getAnchorElement

Returns the target anchor element of the given anchor query according to https://www.w3.org/TR/css-anchor-position-1/#target.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
nodeId	"$ref": NodeId	Id of the positioned element from which to find the anchor.	-
anchorSpecifier	"type": STRING	An optional anchor specifier, as defined in https://www.w3.org/TR/css-anchor-position-1/#anchor-specifier. If not provided, it will return the implicit anchor element for the given positioned element.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
nodeId	"$ref": NodeId	The anchor element of the given anchor query.	-

getAttributes

Returns attributes for the specified node.

-

PARAMETERS:

Name	Type	Description	Flags
nodeId	"$ref": NodeId	Id of the node to retrieve attributes for.	-

RETURNS:

Name	Type	Description	Flags
attributes	"type": ARRAY "items": { "type": 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.	-

getContainerForNode

Returns the query container of the given node based on container query conditions: containerName, physical and logical axes, and whether it queries scroll-state or anchored elements. If no axes are provided and queriesScrollState is false, the style container is returned, which is the direct parent or the closest element with a matching container-name.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
nodeId	"$ref": NodeId	-	-
containerName	"type": STRING	-	[OPTIONAL]
physicalAxes	"$ref": PhysicalAxes	-	[OPTIONAL]
logicalAxes	"$ref": LogicalAxes	-	[OPTIONAL]
queriesScrollState	"type": BOOLEAN	-	[OPTIONAL]
queriesAnchored	"type": BOOLEAN	-	[OPTIONAL]

RETURNS:

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

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	"type": ARRAY "items": { "$ref": Quad }	Quads that describe node layout relative to viewport.	-

getDetachedDomNodes

Returns list of detached nodes

[EXPERIMENTAL]

RETURNS:

Name	Type	Description	Flags
detachedNodes	"type": ARRAY "items": { "$ref": DetachedElementInfo }	The list of detached nodes	-

getDocument

Returns the root DOM node (and optionally the subtree) to the caller. Implicitly enables the DOM domain events for the current target.

-

PARAMETERS:

Name	Type	Description	Flags
depth	"type": 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	"type": 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.	-

getElementByRelation

Returns the NodeId of the matched element according to certain relations.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
nodeId	"$ref": NodeId	Id of the node from which to query the relation.	-
relation	"CommandFor", "InterestTarget", "PopoverTarget"String [Hover] Enum "type": STRING	Type of relation to get.	-

RETURNS:

Name	Type	Description	Flags
nodeId	"$ref": NodeId	NodeId of the element matching the queried relation.	-

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	"type": STRING	-	-

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	"type": 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	"type": 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	"type": ARRAY "items": { "$ref": Node }	Resulting node.	-

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]

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	"type": INTEGER	X coordinate.	-
y	"type": INTEGER	Y coordinate.	-
includeUserAgentShadowDOM	"type": BOOLEAN	False to skip to the nearest non-UA shadow root ancestor (default: false).	[OPTIONAL]
ignorePointerEventsNone	"type": 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]

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]

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	"type": ARRAY "items": { "$ref": CSSComputedStyleProperty }	The style to filter nodes by (includes nodes if any of properties matches).	-
pierce	"type": 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	"type": ARRAY "items": { "$ref": NodeId }	Resulting nodes.	-

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]
includeShadowDOM	"type": BOOLEAN	Include all shadow roots. Equals to false if not specified.	[OPTIONAL] [EXPERIMENTAL]

RETURNS:

Name	Type	Description	Flags
outerHTML	"type": STRING	Outer HTML markup.	-

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	"type": ARRAY "items": { "$ref": NodeId }	Descendant nodes with container queries against the given container.	-

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	"type": STRING	Unique search session identifier.	-
fromIndex	"type": INTEGER	Start index of the search result to be returned.	-
toIndex	"type": INTEGER	End index of the search result to be returned.	-

RETURNS:

Name	Type	Description	Flags
nodeIds	"type": ARRAY "items": { "$ref": NodeId }	Ids of the search result nodes.	-

getTopLayerElements

Returns NodeIds of current top layer elements. Top layer is rendered closest to the user within a viewport, therefore its elements always appear on top of all other content.

[EXPERIMENTAL]

RETURNS:

Name	Type	Description	Flags
nodeIds	"type": ARRAY "items": { "$ref": NodeId }	NodeIds of top layer elements	-

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	"type": STRING	Plain text or query selector or XPath search query.	-
includeUserAgentShadowDOM	"type": BOOLEAN	True to search in user agent shadow DOM.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
searchId	"type": STRING	Unique search session identifier.	-
resultCount	"type": 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	"type": 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	"type": ARRAY "items": { "$ref": BackendNodeId }	The array of backend node ids.	-

RETURNS:

Name	Type	Description	Flags
nodeIds	"type": ARRAY "items": { "$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	"type": 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	"type": STRING	Selector string.	-

RETURNS:

Name	Type	Description	Flags
nodeIds	"type": ARRAY "items": { "$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	"type": 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	"type": 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	"type": 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	"type": 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.	-

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.

-

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]

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	"type": STRING	Attribute name.	-
value	"type": 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	"type": STRING	Text with a number of attributes. Will parse this text using HTML parser.	-
name	"type": 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	"type": ARRAY "items": { "type": 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]

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	"type": STRING	New node's name.	-

RETURNS:

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

setNodeStackTracesEnabled

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

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
enable	"type": BOOLEAN	Enable or disable.	-

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	"type": 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	"type": STRING	Outer HTML markup to set.	-

undo

Undoes the last performed action.

[EXPERIMENTAL]

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	"type": STRING	Attribute name.	-
value	"type": 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	"type": STRING	A ttribute name.	-

characterDataModified

Mirrors `DOMCharacterDataModified` event.

-

PARAMETERS:

Name	Type	Description	Flags
nodeId	"$ref": NodeId	Id of the node that has changed.	-
characterData	"type": 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	"type": 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	Id of the previous sibling.	-
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	"type": ARRAY "items": { "$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	"type": ARRAY "items": { "$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.	-

scrollableFlagUpdated

Fired when a node's scrollability state changes.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
nodeId	"$ref": DOM.NodeId	The id of the node.	-
isScrollable	"type": BOOLEAN	If the node is scrollable.	-

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	"type": ARRAY "items": { "$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.	-

topLayerElementsUpdated

Called when top layer elements are changed.

[EXPERIMENTAL]

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, RunTime

TYPES

Type ID

Type

Description

Flags

CSPViolationType

CSP Violation type.

[EXPERIMENTAL]

DOMBreakpointType

DOM breakpoint type.

-

EventListener

OBJECT

Object event listener.

-

PROPERTIES:

Name	Type	Description	Flags
type	"type": STRING	`EventListener`'s type.	-
useCapture	"type": BOOLEAN	`EventListener`'s useCapture.	-
passive	"type": BOOLEAN	`EventListener`'s passive flag.	-
once	"type": BOOLEAN	`EventListener`'s once flag.	-
scriptId	"$ref": RunTime.ScriptId	Script id of the handler code.	-
lineNumber	"type": INTEGER	Line number in the script (0-based).	-
columnNumber	"type": 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	"type": 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	"type": 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	"type": ARRAY "items": { "$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	"type": STRING	Event name.	-
targetName	"type": STRING	EventTarget interface name.	[OPTIONAL] [EXPERIMENTAL]

removeInstrumentationBreakpoint
REDIRECT: EventBreakpoints

Removes breakpoint on particular native event.

[EXPERIMENTAL]
[DEPRECATED]

PARAMETERS:

Name	Type	Description	Flags
eventName	"type": STRING	Instrumentation name to stop on.	-

removeXHRBreakpoint

Removes breakpoint from XMLHttpRequest.

-

PARAMETERS:

Name	Type	Description	Flags
url	"type": STRING	Resource URL substring.	-

setBreakOnCSPViolation

Sets breakpoint on particular CSP violations.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
violationTypes	"type": ARRAY "items": { "$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	"type": STRING	DOM Event name to stop on (any DOM event will do).	-
targetName	"type": STRING	EventTarget interface name to stop on. If equal to `"*"` or not provided, will stop on any EventTarget.	[OPTIONAL] [EXPERIMENTAL]

setInstrumentationBreakpoint
REDIRECT: EventBreakpoints

Sets breakpoint on particular native event.

[EXPERIMENTAL]
[DEPRECATED]

PARAMETERS:

Name	Type	Description	Flags
eventName	"type": STRING	Instrumentation name to stop on.	-

setXHRBreakpoint

Sets breakpoint on XMLHttpRequest.

-

PARAMETERS:

Name	Type	Description	Flags
url	"type": 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

ArrayOfStrings

ARRAY

Index of the string in the strings table.

-

ComputedStyle

OBJECT

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

-

PROPERTIES:

Name	Type	Description	Flags
properties	"type": ARRAY "items": { "$ref": NameValue }	Name/value pairs of computed style properties.	-

DOMNode

OBJECT

A Node in the DOM tree.

-

PROPERTIES:

Name	Type	Description	Flags
nodeType	"type": INTEGER	`Node`'s nodeType.	-
nodeName	"type": STRING	`Node`'s nodeName.	-
nodeValue	"type": STRING	`Node`'s nodeValue.	-
textValue	"type": STRING	Only set for textarea elements, contains the text value.	[OPTIONAL]
inputValue	"type": STRING	Only set for input elements, contains the input's associated text value.	[OPTIONAL]
inputChecked	"type": BOOLEAN	Only set for radio and checkbox input elements, indicates if the element has been checked	[OPTIONAL]
optionSelected	"type": 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	"type": ARRAY "items": { "type": INTEGER }	The indexes of the node's child nodes in the `domNodes` array returned by `getSnapshot`, if any.	[OPTIONAL]
attributes	"type": ARRAY "items": { "$ref": NameValue }	Attributes of an `Element` node.	[OPTIONAL]
pseudoElementIndexes	"type": ARRAY "items": { "type": INTEGER }	Indexes of pseudo elements associated with this node in the `domNodes` array returned by `getSnapshot`, if any.	[OPTIONAL]
layoutNodeIndex	"type": INTEGER	The index of the node's related layout tree node in the `layoutTreeNodes` array returned by `getSnapshot`, if any.	[OPTIONAL]
documentURL	"type": STRING	Document URL that `Document` or `FrameOwner` node points to.	[OPTIONAL]
baseURL	"type": STRING	Base URL that `Document` or `FrameOwner` node uses for URL completion.	[OPTIONAL]
contentLanguage	"type": STRING	Only set for documents, contains the document's content language.	[OPTIONAL]
documentEncoding	"type": STRING	Only set for documents, contains the document's character set encoding.	[OPTIONAL]
publicId	"type": STRING	`DocumentType` node's publicId.	[OPTIONAL]
systemId	"type": STRING	`DocumentType` node's systemId.	[OPTIONAL]
frameId	"$ref": Page.FrameId	Frame ID for frame owner elements and also for the document node.	[OPTIONAL]
contentDocumentIndex	"type": 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	"type": 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	"type": ARRAY "items": { "$ref": DOMDebugger.EventListener }	Details of the node's event listeners, if any.	[OPTIONAL]
currentSourceURL	"type": STRING	The selected url for nodes with a srcset attribute.	[OPTIONAL]
originURL	"type": STRING	The url of the script (if any) that generates this node.	[OPTIONAL]
scrollOffsetX	"type": NUMBER	Scroll offsets, set when this node is a Document.	[OPTIONAL]
scrollOffsetY	"type": NUMBER	-	[OPTIONAL]

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	"type": NUMBER	Horizontal scroll offset.	[OPTIONAL]
scrollOffsetY	"type": NUMBER	Vertical scroll offset.	[OPTIONAL]
contentWidth	"type": NUMBER	Document content width.	[OPTIONAL]
contentHeight	"type": NUMBER	Document content height.	[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	"type": 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	"type": 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	"type": 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	"type": STRING	Contents of the LayoutText, if any.	[OPTIONAL]
inlineTextNodes	"type": ARRAY "items": { "$ref": InlineTextBox }	The post-layout inline text nodes, if any.	[OPTIONAL]
styleIndex	"type": INTEGER	Index into the `computedStyles` array returned by `getSnapshot`.	[OPTIONAL]
paintOrder	"type": 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	"type": BOOLEAN	Set to true to indicate the element begins a new stacking context.	[OPTIONAL]

LayoutTreeSnapshot

OBJECT

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

-

PROPERTIES:

Name	Type	Description	Flags
nodeIndex	"type": ARRAY "items": { "type": INTEGER }	Index of the corresponding node in the `NodeTreeSnapshot` array returned by `captureSnapshot`.	-
styles	"type": ARRAY "items": { "$ref": ArrayOfStrings }	Array of indexes specifying computed style strings, filtered according to the `computedStyles` parameter passed to `captureSnapshot`.	-
bounds	"type": ARRAY "items": { "$ref": Rectangle }	The absolute position bounding box.	-
text	"type": ARRAY "items": { "$ref": StringIndex }	Contents of the LayoutText, if any.	-
stackingContexts	"$ref": RareBooleanData	Stacking context information.	-
paintOrders	"type": ARRAY "items": { "type": 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	"type": ARRAY "items": { "$ref": Rectangle }	The offset rect of nodes. Only available when includeDOMRects is set to true	[OPTIONAL]
scrollRects	"type": ARRAY "items": { "$ref": Rectangle }	The scroll rect of nodes. Only available when includeDOMRects is set to true	[OPTIONAL]
clientRects	"type": ARRAY "items": { "$ref": Rectangle }	The client rect of nodes. Only available when includeDOMRects is set to true	[OPTIONAL]
blendedBackgroundColors	"type": ARRAY "items": { "$ref": StringIndex }	The list of background colors that are blended with colors of overlapping elements.	[OPTIONAL] [EXPERIMENTAL]
textColorOpacities	"type": ARRAY "items": { "type": NUMBER }	The list of computed text opacities.	[OPTIONAL] [EXPERIMENTAL]

NameValue

OBJECT

A name/value pair.

-

PROPERTIES:

Name	Type	Description	Flags
name	"type": STRING	Attribute/property name.	-
value	"type": STRING	Attribute/property value.	-

NodeTreeSnapshot

OBJECT

Table containing nodes.

-

PROPERTIES:

Name	Type	Description	Flags
parentIndex	"type": ARRAY "items": { "type": INTEGER }	Parent node index.	[OPTIONAL]
nodeType	"type": ARRAY "items": { "type": 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	"type": ARRAY "items": { "$ref": StringIndex }	`Node`'s nodeName.	[OPTIONAL]
nodeValue	"type": ARRAY "items": { "$ref": StringIndex }	`Node`'s nodeValue.	[OPTIONAL]
backendNodeId	"type": ARRAY "items": { "$ref": DOM.BackendNodeId }	`Node`'s id, corresponds to DOM.Node.backendNodeId.	[OPTIONAL]
attributes	"type": ARRAY "items": { "$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]
pseudoIdentifier	"$ref": RareStringData	Pseudo element identifier for this node. Only present if there is a valid pseudoType.	[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]

RareBooleanData

OBJECT

-

PROPERTIES:

Name	Type	Description	Flags
index	"type": ARRAY "items": { "type": INTEGER }	-	-

RareIntegerData

OBJECT

-

PROPERTIES:

Name	Type	Description	Flags
index	"type": ARRAY "items": { "type": INTEGER }	-	-
value	"type": ARRAY "items": { "type": INTEGER }	-	-

RareStringData

OBJECT

Data that is only present on rare nodes.

-

PROPERTIES:

Name	Type	Description	Flags
index	"type": ARRAY "items": { "type": INTEGER }	-	-
value	"type": ARRAY "items": { "$ref": StringIndex }	-	-

Rectangle

"type": "array"
"items":
{ NUMBER }

-

StringIndex

INTEGER

Index of the string in the strings table.

-

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	"type": ARRAY "items": { "type": INTEGER }	Index of the layout tree node that owns this box collection.	-
bounds	"type": ARRAY "items": { "$ref": Rectangle }	The absolute position bounding box.	-
start	"type": ARRAY "items": { "type": 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	"type": ARRAY "items": { "type": 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

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	"type": ARRAY "items": { "type": STRING }	Whitelist of computed styles to return.	-
includePaintOrder	"type": BOOLEAN	Whether to include layout object paint orders into the snapshot.	[OPTIONAL]
includeDOMRects	"type": BOOLEAN	Whether to include DOM rectangles (offsetRects, clientRects, scrollRects) into the snapshot	[OPTIONAL]
includeBlendedBackgroundColors	"type": 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	"type": 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	"type": ARRAY "items": { "$ref": DocumentSnapshot }	The nodes in the DOM tree. The DOMNode at index 0 corresponds to the root document.	-
strings	"type": ARRAY "items": { "type": STRING }	Shared string table that all string properties refer to with indexes.	-

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	"type": ARRAY "items": { "type": STRING }	Whitelist of computed styles to return.	-
includeEventListeners	"type": BOOLEAN	Whether or not to retrieve details of DOM listeners (default false).	[OPTIONAL]
includePaintOrder	"type": BOOLEAN	Whether to determine and include the paint order index of LayoutTreeNodes (default false).	[OPTIONAL]
includeUserAgentShadowTree	"type": BOOLEAN	Whether to include UA shadow tree in the snapshot (default false).	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
domNodes	"type": ARRAY "items": { "$ref": DOMNode }	The nodes in the DOM tree. The DOMNode at index 0 corresponds to the root document.	-
layoutTreeNodes	"type": ARRAY "items": { "$ref": LayoutTreeNode }	The nodes in the layout tree.	-
computedStyles	"type": ARRAY "items": { "$ref": ComputedStyle }	Whitelisted ComputedStyle properties for each node in the layout tree.	-

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	"type": ARRAY "items": { "$ref": Item }	-	-

removeDOMStorageItem

-

PARAMETERS:

Name	Type	Description	Flags
storageId	"$ref": StorageId	-	-
key	"type": STRING	-	-

setDOMStorageItem

-

PARAMETERS:

Name	Type	Description	Flags
storageId	"$ref": StorageId	-	-
key	"type": STRING	-	-
value	"type": STRING	-	-

EVENTS

Name

Description

Flags

domStorageItemAdded

-

PARAMETERS:

Name	Type	Description	Flags
storageId	"$ref": StorageId	-	-
key	"type": STRING	-	-
newValue	"type": STRING	-	-

domStorageItemRemoved

-

PARAMETERS:

Name	Type	Description	Flags
storageId	"$ref": StorageId	-	-
key	"type": STRING	-	-

domStorageItemUpdated

-

PARAMETERS:

Name	Type	Description	Flags
storageId	"$ref": StorageId	-	-
key	"type": STRING	-	-
oldValue	"type": STRING	-	-
newValue	"type": STRING	-	-

domStorageItemsCleared

-

PARAMETERS:

Name	Type	Description	Flags
storageId	"$ref": StorageId	-	-

DeviceAccess

[Experimental]

-

DeviceOrientation

[Experimental]

-

Emulation

This domain emulates different environments for the page.

Dependencies: DOM, Page, RunTime

TYPES

Type ID

Type

Description

Flags

DevicePosture

OBJECT

-

PROPERTIES:

Name	Type	Description	Flags
type	"continuous", "folded"String [Hover] Enum "type": STRING	Current posture of the device	-

DisabledImageType

Enum of image types that can be disabled.

[EXPERIMENTAL]

DisplayFeature

OBJECT

-

PROPERTIES:

Name	Type	Description	Flags
orientation	"horizontal", "vertical"String [Hover] Enum "type": STRING	Orientation of a display feature in relation to screen	-
offset	"type": INTEGER	The offset from the screen origin in either the x (for vertical orientation) or y (for horizontal orientation) direction.	-
maskLength	"type": 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	"type": STRING	-	-
value	"type": STRING	-	-

PressureMetadata

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
available	"type": BOOLEAN	-	[OPTIONAL]

PressureSource

-

[EXPERIMENTAL]

PressureState

-

[EXPERIMENTAL]

SafeAreaInsets

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
top	"type": INTEGER	Overrides safe-area-inset-top.	[OPTIONAL]
topMax	"type": INTEGER	Overrides safe-area-max-inset-top.	[OPTIONAL]
left	"type": INTEGER	Overrides safe-area-inset-left.	[OPTIONAL]
leftMax	"type": INTEGER	Overrides safe-area-max-inset-left.	[OPTIONAL]
bottom	"type": INTEGER	Overrides safe-area-inset-bottom.	[OPTIONAL]
bottomMax	"type": INTEGER	Overrides safe-area-max-inset-bottom.	[OPTIONAL]
right	"type": INTEGER	Overrides safe-area-inset-right.	[OPTIONAL]
rightMax	"type": INTEGER	Overrides safe-area-max-inset-right.	[OPTIONAL]

ScreenOrientation

OBJECT

Screen orientation.

-

PROPERTIES:

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

SensorMetadata

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
available	"type": BOOLEAN	-	[OPTIONAL]
minimumFrequency	"type": NUMBER	-	[OPTIONAL]
maximumFrequency	"type": NUMBER	-	[OPTIONAL]

SensorReading

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
single	"$ref": SensorReadingSingle	-	[OPTIONAL]
xyz	"$ref": SensorReadingXYZ	-	[OPTIONAL]
quaternion	"$ref": SensorReadingQuaternion	-	[OPTIONAL]

SensorReadingQuaternion

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
x	"type": NUMBER	-	-
y	"type": NUMBER	-	-
z	"type": NUMBER	-	-
w	"type": NUMBER	-	-

SensorReadingSingle

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
value	"type": NUMBER	-	-

SensorReadingXYZ

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
x	"type": NUMBER	-	-
y	"type": NUMBER	-	-
z	"type": NUMBER	-	-

SensorType

Used to specify sensor types to emulate. See https://w3c.github.io/sensors/#automation for more information.

[EXPERIMENTAL]

UserAgentBrandVersion

OBJECT

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

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
brand	"type": STRING	-	-
version	"type": STRING	-	-

UserAgentMetadata

OBJECT

Used to specify User Agent Client 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	"type": ARRAY "items": { "$ref": UserAgentBrandVersion }	Brands appearing in Sec-CH-UA.	[OPTIONAL]
fullVersionList	"type": ARRAY "items": { "$ref": UserAgentBrandVersion }	Brands appearing in Sec-CH-UA-Full-Version-List.	[OPTIONAL]
fullVersion	"type": STRING	-	[OPTIONAL] [DEPRECATED]
platform	"type": STRING	-	-
platformVersion	"type": STRING	-	-
architecture	"type": STRING	-	-
model	"type": STRING	-	-
mobile	"type": BOOLEAN	-	-
bitness	"type": STRING	-	[OPTIONAL]
wow64	"type": BOOLEAN	-	[OPTIONAL]
formFactors	"type": ARRAY "items": { "type": STRING }	Used to specify User Agent form-factor values. See https://wicg.github.io/ua-client-hints/#sec-ch-ua-form-factors	[OPTIONAL]

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]

COMMANDS

Name

Description

Flags

canEmulate

Tells whether emulation is supported.

[DEPRECATED]

RETURNS:

Name	Type	Description	Flags
result	"type": BOOLEAN	True if emulation is supported.	-

clearDeviceMetricsOverride

Clears the overridden device metrics.

-

clearDevicePostureOverride

Clears a device posture override set with either setDeviceMetricsOverride() or setDevicePostureOverride() and starts using posture information from the platform again. Does nothing if no override is set.

[EXPERIMENTAL]

clearDisplayFeaturesOverride

Clears the display features override set with either setDeviceMetricsOverride() or setDisplayFeaturesOverride() and starts using display features from the platform again. Does nothing if no override is set.

[EXPERIMENTAL]

clearGeolocationOverride

Clears the overridden Geolocation Position and Error.

-

clearIdleOverride

Clears Idle state overrides.

-

getOverriddenSensorInformation

-

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
type	"$ref": SensorType	-	-

RETURNS:

Name	Type	Description	Flags
requestedSamplingFrequency	"type": NUMBER	-	-

resetPageScaleFactor

Requests that page scale factor is reset to initial values.

[EXPERIMENTAL]

setAutoDarkModeOverride

Automatically render all web contents using a dark theme.

[EXPERIMENTAL]

PARAMETERS:

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

setAutomationOverride

Allows overriding the automation flag.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
enabled	"type": BOOLEAN	Whether the override should be enabled.	-

setCPUThrottlingRate

Enables CPU throttling to emulate slow CPUs.

-

PARAMETERS:

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

setDataSaverOverride

Override the value of navigator.connection.saveData

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
dataSaverEnabled	"type": BOOLEAN	Override value. Omitting the parameter disables the override.	[OPTIONAL]

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	"type": INTEGER	Overriding width value in pixels (minimum 0, maximum 10000000). 0 disables the override.	-
height	"type": INTEGER	Overriding height value in pixels (minimum 0, maximum 10000000). 0 disables the override.	-
deviceScaleFactor	"type": NUMBER	Overriding device scale factor value. 0 disables the override.	-
mobile	"type": BOOLEAN	Whether to emulate mobile device. This includes viewport meta tag, overlay scrollbars, text autosizing and more.	-
scale	"type": NUMBER	Scale to apply to resulting view image.	[OPTIONAL] [EXPERIMENTAL]
screenWidth	"type": INTEGER	Overriding screen width value in pixels (minimum 0, maximum 10000000).	[OPTIONAL] [EXPERIMENTAL]
screenHeight	"type": INTEGER	Overriding screen height value in pixels (minimum 0, maximum 10000000).	[OPTIONAL] [EXPERIMENTAL]
positionX	"type": INTEGER	Overriding view X position on screen in pixels (minimum 0, maximum 10000000).	[OPTIONAL] [EXPERIMENTAL]
positionY	"type": INTEGER	Overriding view Y position on screen in pixels (minimum 0, maximum 10000000).	[OPTIONAL] [EXPERIMENTAL]
dontSetVisibleSize	"type": 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. Deprecated, use Emulation.setDisplayFeaturesOverride.	[OPTIONAL] [EXPERIMENTAL] [DEPRECATED]
devicePosture	"$ref": DevicePosture	If set, the posture of a foldable device. If not set the posture is set to continuous. Deprecated, use Emulation.setDevicePostureOverride.	[OPTIONAL] [EXPERIMENTAL] [DEPRECATED]

setDevicePostureOverride

Start reporting the given posture value to the Device Posture API. This override can also be set in setDeviceMetricsOverride().

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
posture	"$ref": DevicePosture	-	-

setDisabledImageTypes

-

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
imageTypes	"type": ARRAY "items": { "$ref": DisabledImageType }	Image types to disable.	-

setDisplayFeaturesOverride

Start using the given display features to pupulate the Viewport Segments API. This override can also be set in setDeviceMetricsOverride().

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
features	"type": ARRAY "items": { "$ref": DisplayFeature }	-	-

setDocumentCookieDisabled

-

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
disabled	"type": BOOLEAN	Whether document.coookie API should be disabled.	-

setEmitTouchEventsForMouse

-

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
enabled	"type": BOOLEAN	Whether touch emulation based on mouse input should be enabled.	-
configuration	"desktop", "mobile"String [Hover] Enum "type": STRING	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	"type": STRING	Media type to emulate. Empty string disables the override.	[OPTIONAL]
features	"type": ARRAY "items": { "$ref": MediaFeature }	Media features to emulate.	[OPTIONAL]

setEmulatedOSTextScale

Emulates the given OS text scale.

-

PARAMETERS:

Name	Type	Description	Flags
scale	"type": NUMBER	-	[OPTIONAL]

setEmulatedVisionDeficiency

Emulates the given vision deficiency.

-

PARAMETERS:

Name	Type	Description	Flags
type	"achromatopsia", "blurredVision", "deuteranopia", "none", "protanopia", "reducedContrast", "tritanopia"String [Hover] Enum "type": STRING	Vision deficiency to emulate. Order: best-effort emulations come first, followed by any physiologically accurate emulations for medically recognized color vision deficiencies.	-

setFocusEmulationEnabled

Enables or disables simulating a focused and active page.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
enabled	"type": BOOLEAN	Whether to enable to disable focus emulation.	-

setGeolocationOverride

Overrides the Geolocation Position or Error. Omitting latitude, longitude or accuracy emulates position unavailable.

-

PARAMETERS:

Name	Type	Description	Flags
latitude	"type": NUMBER	Mock latitude	[OPTIONAL]
longitude	"type": NUMBER	Mock longitude	[OPTIONAL]
accuracy	"type": NUMBER	Mock accuracy	[OPTIONAL]
altitude	"type": NUMBER	Mock altitude	[OPTIONAL]
altitudeAccuracy	"type": NUMBER	Mock altitudeAccuracy	[OPTIONAL]
heading	"type": NUMBER	Mock heading	[OPTIONAL]
speed	"type": NUMBER	Mock speed	[OPTIONAL]

setHardwareConcurrencyOverride

-

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
hardwareConcurrency	"type": INTEGER	Hardware concurrency to report	-

setIdleOverride

Overrides the Idle state.

-

PARAMETERS:

Name	Type	Description	Flags
isUserActive	"type": BOOLEAN	Mock isUserActive	-
isScreenUnlocked	"type": BOOLEAN	Mock isScreenUnlocked	-

setLocaleOverride

Overrides default host system locale with the specified one.

[EXPERIMENTAL]

PARAMETERS:

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

setNavigatorOverrides

Overrides value returned by the javascript navigator object.

[EXPERIMENTAL]
[DEPRECATED]

PARAMETERS:

Name	Type	Description	Flags
platform	"type": STRING	The platform navigator.platform should return.	-

setPageScaleFactor

Sets a specified page scale factor.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
pageScaleFactor	"type": NUMBER	Page scale factor.	-

setPressureDataOverride

Provides a given pressure data set that will be processed and eventually be delivered to PressureObserver users. |source| must have been previously overridden by setPressureSourceOverrideEnabled.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
source	"$ref": PressureSource	-	-
state	"$ref": PressureState	-	-
ownContributionEstimate	"type": NUMBER	-	[OPTIONAL]

setPressureSourceOverrideEnabled

Overrides a pressure source of a given type, as used by the Compute Pressure API, so that updates to PressureObserver.observe() are provided via setPressureStateOverride instead of being retrieved from platform-provided telemetry data.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
enabled	"type": BOOLEAN	-	-
source	"$ref": PressureSource	-	-
metadata	"$ref": PressureMetadata	-	[OPTIONAL]

setPressureStateOverride

TODO: OBSOLETE: To remove when setPressureDataOverride is merged. Provides a given pressure state that will be processed and eventually be delivered to PressureObserver users. |source| must have been previously overridden by setPressureSourceOverrideEnabled.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
source	"$ref": PressureSource	-	-
state	"$ref": PressureState	-	-

setSafeAreaInsetsOverride

Overrides the values for env(safe-area-inset-*) and env(safe-area-max-inset-*). Unset values will cause the respective variables to be undefined, even if previously overridden.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
insets	"$ref": SafeAreaInsets	-	-

setScriptExecutionDisabled

Switches script execution in the page.

-

PARAMETERS:

Name	Type	Description	Flags
value	"type": BOOLEAN	Whether script execution should be disabled in the page.	-

setScrollbarsHidden

-

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
hidden	"type": BOOLEAN	Whether scrollbars should be always hidden.	-

setSensorOverrideEnabled

Overrides a platform sensor of a given type. If |enabled| is true, calls to Sensor.start() will use a virtual sensor as backend rather than fetching data from a real hardware sensor. Otherwise, existing virtual sensor-backend Sensor objects will fire an error event and new calls to Sensor.start() will attempt to use a real sensor instead.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
enabled	"type": BOOLEAN	-	-
type	"$ref": SensorType	-	-
metadata	"$ref": SensorMetadata	-	[OPTIONAL]

setSensorOverrideReadings

Updates the sensor readings reported by a sensor type previously overridden by setSensorOverrideEnabled.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
type	"$ref": SensorType	-	-
reading	"$ref": SensorReading	-	-

setSmallViewportHeightDifferenceOverride

Allows overriding the difference between the small and large viewport sizes, which determine the value of the `svh` and `lvh` unit, respectively. Only supported for top-level frames.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
difference	"type": INTEGER	This will cause an element of size 100svh to be `difference` pixels smaller than an element of size 100lvh.	-

setTimezoneOverride

Overrides default host system timezone with the specified one.

-

PARAMETERS:

Name	Type	Description	Flags
timezoneId	"type": STRING	The timezone identifier. List of supported timezones: https://source.chromium.org/chromium/chromium/deps/icu.git/+/faee8bc70570192d82d2978a71e2a615788597d1:source/data/misc/metaZones.txt If empty, disables the override and restores default host system timezone.	-

setTouchEmulationEnabled

Enables touch on platforms which do not support them.

-

PARAMETERS:

Name	Type	Description	Flags
enabled	"type": BOOLEAN	Whether the touch event emulation should be enabled.	-
maxTouchPoints	"type": INTEGER	Maximum touch points supported. Defaults to one.	[OPTIONAL]

setUserAgentOverride

Allows overriding user agent with the given string. `userAgentMetadata` must be set for Client Hint headers to be sent.

-

PARAMETERS:

Name	Type	Description	Flags
userAgent	"type": STRING	User agent to use.	-
acceptLanguage	"type": STRING	Browser language to emulate.	[OPTIONAL]
platform	"type": 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]

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	"type": NUMBER	If set, after this many virtual milliseconds have elapsed virtual time will be paused and a virtualTimeBudgetExpired event is sent.	[OPTIONAL]
maxVirtualTimeTaskStarvationCount	"type": INTEGER	If set this specifies the maximum number of tasks that can be run before virtual is forced forwards to prevent deadlock.	[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	"type": NUMBER	Absolute timestamp at which virtual time was first enabled (up time in milliseconds).	-

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	"type": INTEGER	Frame width (DIP).	-
height	"type": INTEGER	Frame height (DIP).	-

EventBreakpoints

[Experimental]

EventBreakpoints permits setting JavaScript breakpoints on operations and events occurring in native code invoked from JavaScript. Once breakpoint is hit, it is reported through Debugger domain, similarly to regular breakpoints being hit.

Extensions

[Experimental]

Defines commands and events for browser extensions.

COMMANDS

Name

Description

Flags

clearStorageItems

Clears extension storage in the given `storageArea`.

-

PARAMETERS:

Name	Type	Description	Flags
id	"type": STRING	ID of extension.	-
storageArea	"$ref": StorageArea	StorageArea to remove data from.	-

getStorageItems

Gets data from extension storage in the given `storageArea`. If `keys` is specified, these are used to filter the result.

-

PARAMETERS:

Name	Type	Description	Flags
id	"type": STRING	ID of extension.	-
storageArea	"$ref": StorageArea	StorageArea to retrieve data from.	-
keys	"type": ARRAY "items": { "type": STRING }	Keys to retrieve.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
data	"type": OBJECT	-	-

loadUnpacked

Installs an unpacked extension from the filesystem similar to --load-extension CLI flags. Returns extension ID once the extension has been installed. Available if the client is connected using the --remote-debugging-pipe flag and the --enable-unsafe-extension-debugging flag is set.

-

PARAMETERS:

Name	Type	Description	Flags
path	"type": STRING	Absolute file path.	-

RETURNS:

Name	Type	Description	Flags
id	"type": STRING	Extension id.	-

removeStorageItems

Removes `keys` from extension storage in the given `storageArea`.

-

PARAMETERS:

Name	Type	Description	Flags
id	"type": STRING	ID of extension.	-
storageArea	"$ref": StorageArea	StorageArea to remove data from.	-
keys	"type": ARRAY "items": { "type": STRING }	Keys to remove.	-

setStorageItems

Sets `values` in extension storage in the given `storageArea`. The provided `values` will be merged with existing values in the storage area.

-

PARAMETERS:

Name	Type	Description	Flags
id	"type": STRING	ID of extension.	-
storageArea	"$ref": StorageArea	StorageArea to set data in.	-
values	"type": OBJECT	Values to set.	-

uninstall

Uninstalls an unpacked extension (others not supported) from the profile. Available if the client is connected using the --remote-debugging-pipe flag and the --enable-unsafe-extension-debugging.

-

PARAMETERS:

Name	Type	Description	Flags
id	"type": STRING	Extension id.	-

FedCm

[Experimental]

This domain allows interacting with the FedCM dialog.

TYPES

Type ID

Type

Description

Flags

Account

OBJECT

Corresponds to IdentityRequestAccount

-

PROPERTIES:

Name	Type	Description	Flags
accountId	"type": STRING	-	-
email	"type": STRING	-	-
name	"type": STRING	-	-
givenName	"type": STRING	-	-
pictureUrl	"type": STRING	-	-
idpConfigUrl	"type": STRING	-	-
idpLoginUrl	"type": STRING	-	-
loginState	"$ref": LoginState	-	-
termsOfServiceUrl	"type": STRING	These two are only set if the loginState is signUp	[OPTIONAL]
privacyPolicyUrl	"type": STRING	-	[OPTIONAL]

AccountUrlType

The URLs that each account has

-

DialogButton

The buttons on the FedCM dialog.

-

DialogType

The types of FedCM dialogs.

-

LoginState

Whether this is a sign-up or sign-in action for this account, i.e. whether this account has ever been used to sign in to this RP before.

-

COMMANDS

Name

Description

Flags

clickDialogButton

-

PARAMETERS:

Name	Type	Description	Flags
dialogId	"type": STRING	-	-
dialogButton	"$ref": DialogButton	-	-

disable

-

dismissDialog

-

PARAMETERS:

Name	Type	Description	Flags
dialogId	"type": STRING	-	-
triggerCooldown	"type": BOOLEAN	-	[OPTIONAL]

enable

-

PARAMETERS:

Name	Type	Description	Flags
disableRejectionDelay	"type": BOOLEAN	Allows callers to disable the promise rejection delay that would normally happen, if this is unimportant to what's being tested. (step 4 of https://fedidcg.github.io/FedCM/#browser-api-rp-sign-in)	[OPTIONAL]

openUrl

-

PARAMETERS:

Name	Type	Description	Flags
dialogId	"type": STRING	-	-
accountIndex	"type": INTEGER	-	-
accountUrlType	"$ref": AccountUrlType	-	-

resetCooldown

Resets the cooldown time, if any, to allow the next FedCM call to show a dialog even if one was recently dismissed by the user.

-

selectAccount

-

PARAMETERS:

Name	Type	Description	Flags
dialogId	"type": STRING	-	-
accountIndex	"type": INTEGER	-	-

Fetch

A domain for letting clients substitute browser's network layer with client code.

Dependencies: IO, Network, Page

TYPES

Type ID

Type

Description

Flags

AuthChallenge

OBJECT

Authorization challenge for HTTP status code 401 or 407.

-

PROPERTIES:

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

AuthChallengeResponse

OBJECT

Response to an AuthChallenge.

-

PROPERTIES:

Name	Type	Description	Flags
response	"CancelAuth", "Default", "ProvideCredentials"String [Hover] Enum "type": STRING	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	"type": STRING	The username to provide, possibly empty. Should only be set if response is ProvideCredentials.	[OPTIONAL]
password	"type": STRING	The password to provide, possibly empty. Should only be set if response is ProvideCredentials.	[OPTIONAL]

HeaderEntry

OBJECT

Response HTTP header entry

-

PROPERTIES:

Name	Type	Description	Flags
name	"type": STRING	-	-
value	"type": STRING	-	-

RequestId

STRING

Unique request identifier. Note that this does not identify individual HTTP requests that are part of a network request.

-

RequestPattern

OBJECT

-

PROPERTIES:

Name	Type	Description	Flags
urlPattern	"type": 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]

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

-

COMMANDS

Name

Description

Flags

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	"type": STRING	If set, the request url will be modified in a way that's not observable by page.	[OPTIONAL]
method	"type": STRING	If set, the request method is overridden.	[OPTIONAL]
postData	"type": STRING	If set, overrides the post data in the request. (Encoded as a base64 string when passed over JSON)	[OPTIONAL]
headers	"type": ARRAY "items": { "$ref": HeaderEntry }	If set, overrides the request headers. Note that the overrides do not extend to subsequent redirect hops, if a redirect happens. Another override may be applied to a different request produced by a redirect.	[OPTIONAL]
interceptResponse	"type": BOOLEAN	If set, overrides response interception behavior for this request.	[OPTIONAL] [EXPERIMENTAL]

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	"type": INTEGER	An HTTP response code. If absent, original response code will be used.	[OPTIONAL]
responsePhrase	"type": STRING	A textual representation of responseCode. If absent, a standard phrase matching responseCode is used.	[OPTIONAL]
responseHeaders	"type": ARRAY "items": { "$ref": HeaderEntry }	Response headers. If absent, original response headers will be used.	[OPTIONAL]
binaryResponseHeaders	"type": 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]

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

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	"type": ARRAY "items": { "$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	"type": 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	"type": INTEGER	An HTTP response code.	-
responseHeaders	"type": ARRAY "items": { "$ref": HeaderEntry }	Response headers.	[OPTIONAL]
binaryResponseHeaders	"type": 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	"type": 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	"type": STRING	A textual representation of responseCode. If absent, a standard phrase matching responseCode is used.	[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. Note that the response body is not available for redirects. Requests paused in the _redirect received_ state may be differentiated by `responseCode` and presence of `location` response header, see comments to `requestPaused` for details.

-

PARAMETERS:

Name	Type	Description	Flags
requestId	"$ref": RequestId	Identifier for the intercepted request to get body for.	-

RETURNS:

Name	Type	Description	Flags
body	"type": STRING	Response body.	-
base64Encoded	"type": 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

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

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. Redirect responses and subsequent requests are reported similarly to regular responses and requests. Redirect responses may be distinguished by the value of `responseStatusCode` (which is one of 301, 302, 303, 307, 308) along with presence of the `location` header. Requests resulting from a redirect will have `redirectedRequestId` field set.

-

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	"type": INTEGER	Response code if intercepted at response stage.	[OPTIONAL]
responseStatusText	"type": STRING	Response status text if intercepted at response stage.	[OPTIONAL]
responseHeaders	"type": ARRAY "items": { "$ref": HeaderEntry }	Response headers if intercepted at the response stage.	[OPTIONAL]
networkId	"$ref": Network.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]
redirectedRequestId	"$ref": RequestId	If the request is due to a redirect response from the server, the id of the request that has caused the redirect.	[OPTIONAL] [EXPERIMENTAL]

FileSystem

[Experimental]

-

Dependencies: Network, Storage

TYPES

Type ID

Type

Description

Flags

BucketFileSystemLocator

OBJECT

-

PROPERTIES:

Name	Type	Description	Flags
storageKey	"$ref": Storage.SerializedStorageKey	Storage key	-
bucketName	"type": STRING	Bucket name. Not passing a `bucketName` will retrieve the default Bucket. (https://developer.mozilla.org/en-US/docs/Web/API/Storage_API#storage_buckets)	[OPTIONAL]
pathComponents	"type": ARRAY "items": { "type": STRING }	Path to the directory using each path component as an array item.	-

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.gle/chrome-headless-rendering for more background.

-

PARAMETERS:

Name	Type	Description	Flags
frameTimeTicks	"type": NUMBER	Timestamp of this BeginFrame in Renderer TimeTicks (milliseconds of uptime). If not set, the current time will be used.	[OPTIONAL]
interval	"type": 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	"type": 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	"type": 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	"type": 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.

[DEPRECATED]

enable

Enables headless events for the target.

[DEPRECATED]

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	"type": INTEGER	Seek to the specified offset before reading (if not specified, proceed with offset following the last read). Some types of streams may only support sequential reads.	[OPTIONAL]
size	"type": INTEGER	Maximum number of bytes to read (left upon the agent discretion if not specified).	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
base64Encoded	"type": BOOLEAN	Set if the data is base64-encoded	[OPTIONAL]
data	"type": STRING	Data that were read.	-
eof	"type": 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	"type": STRING	UUID of the specified Blob.	-

IndexedDB

[Experimental]

-

Dependencies: RunTime, Storage

TYPES

Type ID

Type

Description

Flags

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

DatabaseWithObjectStores

OBJECT

Database with an array of object stores.

-

PROPERTIES:

Name	Type	Description	Flags
name	"type": STRING	Database name.	-
version	"type": NUMBER	Database version (type is not 'integer', as the standard requires the version number to be 'unsigned long long')	-
objectStores	"type": ARRAY "items": { "$ref": ObjectStore }	Object stores in this database.	-

Key

OBJECT

Key.

-

PROPERTIES:

Name	Type	Description	Flags
type	"array", "date", "number", "string"String [Hover] Enum "type": STRING	Key type.	-
number	"type": NUMBER	Number value.	[OPTIONAL]
string	"type": STRING	String value.	[OPTIONAL]
date	"type": NUMBER	Date value.	[OPTIONAL]
array	"type": ARRAY "items": { "$ref": Key }	Array value.	[OPTIONAL]

KeyPath

OBJECT

Key path.

-

PROPERTIES:

Name	Type	Description	Flags
type	"array", "null", "string"String [Hover] Enum "type": STRING	Key path type.	-
string	"type": STRING	String value.	[OPTIONAL]
array	"type": ARRAY "items": { "type": STRING }	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	"type": BOOLEAN	If true lower bound is open.	-
upperOpen	"type": BOOLEAN	If true upper bound is open.	-

ObjectStore

OBJECT

Object store.

-

PROPERTIES:

Name	Type	Description	Flags
name	"type": STRING	Object store name.	-
keyPath	"$ref": KeyPath	Object store key path.	-
autoIncrement	"type": BOOLEAN	If true, object store has auto increment flag set.	-
indexes	"type": ARRAY "items": { "$ref": ObjectStoreIndex }	Indexes in this object store.	-

ObjectStoreIndex

OBJECT

Object store index.

-

PROPERTIES:

Name	Type	Description	Flags
name	"type": STRING	Index name.	-
keyPath	"$ref": KeyPath	Index key path.	-
unique	"type": BOOLEAN	If true, index is unique.	-
multiEntry	"type": BOOLEAN	If true, index allows multiple entries for a key.	-

COMMANDS

Name

Description

Flags

clearObjectStore

Clears all entries from an object store.

-

PARAMETERS:

Name	Type	Description	Flags
securityOrigin	"type": STRING	At least and at most one of securityOrigin, storageKey, or storageBucket must be specified. Security origin.	[OPTIONAL]
storageKey	"type": STRING	Storage key.	[OPTIONAL]
storageBucket	"$ref": Storage.StorageBucket	Storage bucket. If not specified, it uses the default bucket.	[OPTIONAL]
databaseName	"type": STRING	Database name.	-
objectStoreName	"type": STRING	Object store name.	-

deleteDatabase

Deletes a database.

-

PARAMETERS:

Name	Type	Description	Flags
securityOrigin	"type": STRING	At least and at most one of securityOrigin, storageKey, or storageBucket must be specified. Security origin.	[OPTIONAL]
storageKey	"type": STRING	Storage key.	[OPTIONAL]
storageBucket	"$ref": Storage.StorageBucket	Storage bucket. If not specified, it uses the default bucket.	[OPTIONAL]
databaseName	"type": STRING	Database name.	-

deleteObjectStoreEntries

Delete a range of entries from an object store

-

PARAMETERS:

Name	Type	Description	Flags
securityOrigin	"type": STRING	At least and at most one of securityOrigin, storageKey, or storageBucket must be specified. Security origin.	[OPTIONAL]
storageKey	"type": STRING	Storage key.	[OPTIONAL]
storageBucket	"$ref": Storage.StorageBucket	Storage bucket. If not specified, it uses the default bucket.	[OPTIONAL]
databaseName	"type": STRING	-	-
objectStoreName	"type": STRING	-	-
keyRange	"$ref": KeyRange	Range of entry keys to delete	-

disable

Disables events from backend.

-

enable

Enables events from backend.

-

getMetadata

Gets metadata of an object store.

-

PARAMETERS:

Name	Type	Description	Flags
securityOrigin	"type": STRING	At least and at most one of securityOrigin, storageKey, or storageBucket must be specified. Security origin.	[OPTIONAL]
storageKey	"type": STRING	Storage key.	[OPTIONAL]
storageBucket	"$ref": Storage.StorageBucket	Storage bucket. If not specified, it uses the default bucket.	[OPTIONAL]
databaseName	"type": STRING	Database name.	-
objectStoreName	"type": STRING	Object store name.	-

RETURNS:

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

requestData

Requests data from object store or index.

-

PARAMETERS:

Name	Type	Description	Flags
securityOrigin	"type": STRING	At least and at most one of securityOrigin, storageKey, or storageBucket must be specified. Security origin.	[OPTIONAL]
storageKey	"type": STRING	Storage key.	[OPTIONAL]
storageBucket	"$ref": Storage.StorageBucket	Storage bucket. If not specified, it uses the default bucket.	[OPTIONAL]
databaseName	"type": STRING	Database name.	-
objectStoreName	"type": STRING	Object store name.	-
indexName	"type": STRING	Index name, empty string for object store data requests.	-
skipCount	"type": INTEGER	Number of records to skip.	-
pageSize	"type": INTEGER	Number of records to fetch.	-
keyRange	"$ref": KeyRange	Key range.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
objectStoreDataEntries	"type": ARRAY "items": { "$ref": DataEntry }	Array of object store data entries.	-
hasMore	"type": BOOLEAN	If true, there are more entries to fetch in the given range.	-

requestDatabase

Requests database with given name in given frame.

-

PARAMETERS:

Name	Type	Description	Flags
securityOrigin	"type": STRING	At least and at most one of securityOrigin, storageKey, or storageBucket must be specified. Security origin.	[OPTIONAL]
storageKey	"type": STRING	Storage key.	[OPTIONAL]
storageBucket	"$ref": Storage.StorageBucket	Storage bucket. If not specified, it uses the default bucket.	[OPTIONAL]
databaseName	"type": 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	"type": STRING	At least and at most one of securityOrigin, storageKey, or storageBucket must be specified. Security origin.	[OPTIONAL]
storageKey	"type": STRING	Storage key.	[OPTIONAL]
storageBucket	"$ref": Storage.StorageBucket	Storage bucket. If not specified, it uses the default bucket.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
databaseNames	"type": ARRAY "items": { "type": STRING }	Database names for origin.	-

Input

-

TYPES

Type ID

Type

Description

Flags

DragData

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
items	"type": ARRAY "items": { "$ref": DragDataItem }	-	-
files	"type": ARRAY "items": { "type": STRING }	List of filenames that should be included when dropping	[OPTIONAL]
dragOperationsMask	"type": INTEGER	Bit field representing allowed drag operations. Copy = 1, Link = 2, Move = 16	-

DragDataItem

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

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

GestureSourceType

-

[EXPERIMENTAL]

MouseButton

-

TimeSinceEpoch

NUMBER

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

-

TouchPoint

OBJECT

-

PROPERTIES:

Name	Type	Description	Flags
x	"type": NUMBER	X coordinate of the event relative to the main frame's viewport in CSS pixels.	-
y	"type": 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	"type": NUMBER	X radius of the touch area (default: 1.0).	[OPTIONAL]
radiusY	"type": NUMBER	Y radius of the touch area (default: 1.0).	[OPTIONAL]
rotationAngle	"type": NUMBER	Rotation angle (default: 0.0).	[OPTIONAL]
force	"type": NUMBER	Force (default: 1.0).	[OPTIONAL]
tangentialPressure	"type": NUMBER	The normalized tangential pressure, which has a range of [-1,1] (default: 0).	[OPTIONAL] [EXPERIMENTAL]
tiltX	"type": NUMBER	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]
tiltY	"type": NUMBER	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]
twist	"type": 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	"type": NUMBER	Identifier used to track touch sources between events, must be unique within an event.	[OPTIONAL]

COMMANDS

Name

Description

Flags

cancelDragging

Cancels any active dragging in the page.

-

dispatchDragEvent

Dispatches a drag event into the page.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
type	"dragCancel", "dragEnter", "dragOver", "drop"String [Hover] Enum "type": STRING	Type of the drag event.	-
x	"type": NUMBER	X coordinate of the event relative to the main frame's viewport in CSS pixels.	-
y	"type": 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	"type": 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	"char", "keyDown", "keyUp", "rawKeyDown"String [Hover] Enum "type": STRING	Type of the key event.	-
modifiers	"type": 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	"type": 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	"type": 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	"type": STRING	Unique key identifier (e.g., 'U+0041') (default: "").	[OPTIONAL]
code	"type": STRING	Unique DOM defined string value for each physical key (e.g., 'KeyA') (default: "").	[OPTIONAL]
key	"type": 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	"type": INTEGER	Windows virtual key code (default: 0).	[OPTIONAL]
nativeVirtualKeyCode	"type": INTEGER	Native virtual key code (default: 0).	[OPTIONAL]
autoRepeat	"type": BOOLEAN	Whether the event was generated from auto repeat (default: false).	[OPTIONAL]
isKeypad	"type": BOOLEAN	Whether the event was generated from the keypad (default: false).	[OPTIONAL]
isSystemKey	"type": BOOLEAN	Whether the event was a system key event (default: false).	[OPTIONAL]
location	"type": INTEGER	Whether the event was from the left or right side of the keyboard. 1=Left, 2=Right (default: 0).	[OPTIONAL]
commands	"type": ARRAY "items": { "type": 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/+/main:third_party/blink/renderer/core/editing/commands/editor_command_names.h for valid command names.	[OPTIONAL] [EXPERIMENTAL]

dispatchMouseEvent

Dispatches a mouse event to the page.

-

PARAMETERS:

Name	Type	Description	Flags
type	"mouseMoved", "mousePressed", "mouseReleased", "mouseWheel"String [Hover] Enum "type": STRING	Type of the mouse event.	-
x	"type": NUMBER	X coordinate of the event relative to the main frame's viewport in CSS pixels.	-
y	"type": 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	"type": 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	"type": 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	"type": INTEGER	Number of times the mouse button was clicked (default: 0).	[OPTIONAL]
force	"type": NUMBER	The normalized pressure, which has a range of [0,1] (default: 0).	[OPTIONAL] [EXPERIMENTAL]
tangentialPressure	"type": NUMBER	The normalized tangential pressure, which has a range of [-1,1] (default: 0).	[OPTIONAL] [EXPERIMENTAL]
tiltX	"type": NUMBER	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]
tiltY	"type": NUMBER	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]
twist	"type": 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	"type": NUMBER	X delta in CSS pixels for mouse wheel event (default: 0).	[OPTIONAL]
deltaY	"type": NUMBER	Y delta in CSS pixels for mouse wheel event (default: 0).	[OPTIONAL]
pointerType	"mouse", "pen"String [Hover] Enum "type": STRING	Pointer type (default: "mouse").	[OPTIONAL]

dispatchTouchEvent

Dispatches a touch event to the page.

-

PARAMETERS:

Name	Type	Description	Flags
type	"touchCancel", "touchEnd", "touchMove", "touchStart"String [Hover] Enum "type": STRING	Type of the touch event. TouchEnd and TouchCancel must not contain any touch points, while TouchStart and TouchMove must contains at least one.	-
touchPoints	"type": ARRAY "items": { "$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	"type": 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	"mouseMoved", "mousePressed", "mouseReleased", "mouseWheel"String [Hover] Enum "type": STRING	Type of the mouse event.	-
x	"type": INTEGER	X coordinate of the mouse pointer in DIP.	-
y	"type": 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	"type": NUMBER	X delta in DIP for mouse wheel event (default: 0).	[OPTIONAL]
deltaY	"type": NUMBER	Y delta in DIP for mouse wheel event (default: 0).	[OPTIONAL]
modifiers	"type": INTEGER	Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8 (default: 0).	[OPTIONAL]
clickCount	"type": INTEGER	Number of times the mouse button was clicked (default: 0).	[OPTIONAL]

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	"type": STRING	The text to insert	-
selectionStart	"type": INTEGER	selection start	-
selectionEnd	"type": INTEGER	selection end	-
replacementStart	"type": INTEGER	replacement start	[OPTIONAL]
replacementEnd	"type": INTEGER	replacement end	[OPTIONAL]

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	"type": STRING	The text to insert.	-

setIgnoreInputEvents

Ignores input events (useful while auditing page).

-

PARAMETERS:

Name	Type	Description	Flags
ignore	"type": 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	"type": BOOLEAN	-	-

synthesizePinchGesture

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

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
x	"type": NUMBER	X coordinate of the start of the gesture in CSS pixels.	-
y	"type": NUMBER	Y coordinate of the start of the gesture in CSS pixels.	-
scaleFactor	"type": NUMBER	Relative scale factor after zooming (>1.0 zooms in, <1.0 zooms out).	-
relativeSpeed	"type": 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	"type": NUMBER	X coordinate of the start of the gesture in CSS pixels.	-
y	"type": NUMBER	Y coordinate of the start of the gesture in CSS pixels.	-
xDistance	"type": NUMBER	The distance to scroll along the X axis (positive to scroll left).	[OPTIONAL]
yDistance	"type": NUMBER	The distance to scroll along the Y axis (positive to scroll up).	[OPTIONAL]
xOverscroll	"type": NUMBER	The number of additional pixels to scroll back along the X axis, in addition to the given distance.	[OPTIONAL]
yOverscroll	"type": NUMBER	The number of additional pixels to scroll back along the Y axis, in addition to the given distance.	[OPTIONAL]
preventFling	"type": BOOLEAN	Prevent fling (default: true).	[OPTIONAL]
speed	"type": 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	"type": INTEGER	The number of times to repeat the gesture (default: 0).	[OPTIONAL]
repeatDelayMs	"type": INTEGER	The number of milliseconds delay between each repeat. (default: 250).	[OPTIONAL]
interactionMarkerName	"type": 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	"type": NUMBER	X coordinate of the start of the gesture in CSS pixels.	-
y	"type": NUMBER	Y coordinate of the start of the gesture in CSS pixels.	-
duration	"type": INTEGER	Duration between touchdown and touchup events in ms (default: 50).	[OPTIONAL]
tapCount	"type": 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

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	"type": NUMBER	Offset from parent layer, X coordinate.	-
offsetY	"type": NUMBER	Offset from parent layer, Y coordinate.	-
width	"type": NUMBER	Layer width.	-
height	"type": NUMBER	Layer height.	-
transform	"type": ARRAY "items": { "type": NUMBER }	Transformation matrix for layer, default is identity matrix	[OPTIONAL]
anchorX	"type": NUMBER	Transform anchor point X, absent if no transform specified	[OPTIONAL]
anchorY	"type": NUMBER	Transform anchor point Y, absent if no transform specified	[OPTIONAL]
anchorZ	"type": NUMBER	Transform anchor point Z, absent if no transform specified	[OPTIONAL]
paintCount	"type": INTEGER	Indicates how many time this layer has painted.	-
drawsContent	"type": BOOLEAN	Indicates whether this layer hosts any content, rather than being used for transform/scrolling purposes only.	-
invisible	"type": BOOLEAN	Set if layer is not visible.	[OPTIONAL]
scrollRects	"type": ARRAY "items": { "$ref": ScrollRect }	Rectangles scrolling on main thread only.	[OPTIONAL]
stickyPositionConstraint	"$ref": StickyPositionConstraint	Sticky position constraint information	[OPTIONAL]

LayerId

STRING

Unique Layer identifier.

-

PaintProfile

"type": "array"
"items":
{ NUMBER }

Array of timings, one per paint step.

-

PictureTile

OBJECT

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

-

PROPERTIES:

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

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 "type": STRING	Reason for rectangle to force scrolling on the main thread	-

SnapshotId

STRING

Unique snapshot identifier.

-

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]

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	"type": ARRAY "items": { "type": STRING }	A list of strings specifying reasons for the given layer to become composited.	-
compositingReasonIds	"type": ARRAY "items": { "type": 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	"type": ARRAY "items": { "$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	"type": INTEGER	The maximum number of times to replay the snapshot (1, if not specified).	[OPTIONAL]
minDuration	"type": 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	"type": ARRAY "items": { "$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	"type": INTEGER	The first step to replay from (replay from the very start if not specified).	[OPTIONAL]
toStep	"type": INTEGER	The last step to replay to (replay till the end if not specified).	[OPTIONAL]
scale	"type": NUMBER	The scale to apply while replaying (defaults to 1).	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
dataURL	"type": 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	"type": ARRAY "items": { "type": OBJECT }	The array of canvas function calls.	-

Log

Provides access to log entries.

Dependencies: Network, RunTime

TYPES

Type ID

Type

Description

Flags

LogEntry

OBJECT

Log entry.

-

PROPERTIES:

Name	Type	Description	Flags
source	"appcache", "deprecation", "intervention", "javascript", "network", "other", "recommendation", "rendering", "security", "storage", "violation", "worker", "xml"String [Hover] Enum "type": STRING	Log entry source.	-
level	"error", "info", "verbose", "warning"String [Hover] Enum "type": STRING	Log entry severity.	-
text	"type": STRING	Logged text.	-
category	"cors"String [Hover] Enum "type": STRING	-	[OPTIONAL]
timestamp	"$ref": RunTime.Timestamp	Timestamp when this entry was added.	-
url	"type": STRING	URL of the resource if known.	[OPTIONAL]
lineNumber	"type": 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	"type": STRING	Identifier of the worker associated with this entry.	[OPTIONAL]
args	"type": ARRAY "items": { "$ref": RunTime.RemoteObject }	Call arguments.	[OPTIONAL]

ViolationSetting

OBJECT

Violation configuration setting.

-

PROPERTIES:

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

Media

[Experimental]

This domain allows detailed inspection of media elements

TYPES

Type ID

Type

Description

Flags

PlayerError

OBJECT

Corresponds to kMediaError

-

PROPERTIES:

Name	Type	Description	Flags
errorType	"type": STRING	-	-
code	"type": INTEGER	Code is the numeric enum entry for a specific set of error codes, such as PipelineStatusCodes in media/base/pipeline_status.h	-
stack	"type": ARRAY "items": { "$ref": PlayerErrorSourceLocation }	A trace of where this error was caused / where it passed through.	-
cause	"type": ARRAY "items": { "$ref": PlayerError }	Errors potentially have a root cause error, ie, a DecoderError might be caused by an WindowsError	-
data	"type": OBJECT	Extra data attached to an error, such as an HRESULT, Video Codec, etc.	-

PlayerErrorSourceLocation

OBJECT

Represents logged source line numbers reported in an error. NOTE: file and line are from chromium c++ implementation code, not js.

-

PROPERTIES:

Name	Type	Description	Flags
file	"type": STRING	-	-
line	"type": INTEGER	-	-

PlayerEvent

OBJECT

Corresponds to kMediaEventTriggered

-

PROPERTIES:

Name	Type	Description	Flags
timestamp	"$ref": Timestamp	-	-
value	"type": STRING	-	-

PlayerId

STRING

Players will get an ID that is unique within the agent context.

-

PlayerMessage

OBJECT

Have one type per entry in MediaLogRecord::Type Corresponds to kMessage

-

PROPERTIES:

Name	Type	Description	Flags
level	"debug", "error", "info", "warning"String [Hover] Enum "type": STRING	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	"type": STRING	-	-

PlayerProperty

OBJECT

Corresponds to kMediaPropertyChange

-

PROPERTIES:

Name	Type	Description	Flags
name	"type": STRING	-	-
value	"type": STRING	-	-

Timestamp

NUMBER

-

EVENTS

Name

Description

Flags

playerErrorsRaised

Send a list of any errors that need to be delivered.

-

PARAMETERS:

Name	Type	Description	Flags
playerId	"$ref": PlayerId	-	-
errors	"type": ARRAY "items": { "$ref": PlayerError }	-	-

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	"type": ARRAY "items": { "$ref": PlayerEvent }	-	-

playerMessagesLogged

Send a list of any messages that need to be delivered.

-

PARAMETERS:

Name	Type	Description	Flags
playerId	"$ref": PlayerId	-	-
messages	"type": ARRAY "items": { "$ref": PlayerMessage }	-	-

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	"type": ARRAY "items": { "$ref": PlayerProperty }	-	-

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	"type": ARRAY "items": { "$ref": PlayerId }	-	-

Memory

[Experimental]

-

TYPES

Type ID

Type

Description

Flags

DOMCounter

OBJECT

DOM object counter data.

-

PROPERTIES:

Name	Type	Description	Flags
name	"type": STRING	Object name. Note: object names should be presumed volatile and clients should not expect the returned names to be consistent across runs.	-
count	"type": INTEGER	Object count.	-

Module

OBJECT

Executable module information

-

PROPERTIES:

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

PressureLevel

Memory pressure level.

-

SamplingProfile

OBJECT

Array of heap profile samples.

-

PROPERTIES:

Name	Type	Description	Flags
samples	"type": ARRAY "items": { "$ref": SamplingProfileNode }	-	-
modules	"type": ARRAY "items": { "$ref": Module }	-	-

SamplingProfileNode

OBJECT

Heap profile sample.

-

PROPERTIES:

Name	Type	Description	Flags
size	"type": NUMBER	Size of the sampled allocation.	-
total	"type": NUMBER	Total bytes attributed to this sample.	-
stack	"type": ARRAY "items": { "type": STRING }	Execution stack at the point of allocation.	-

COMMANDS

Name

Description

Flags

forciblyPurgeJavaScriptMemory

Simulate OomIntervention by purging V8 memory.

-

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

getDOMCounters

Retruns current DOM object counters.

-

RETURNS:

Name	Type	Description	Flags
documents	"type": INTEGER	-	-
nodes	"type": INTEGER	-	-
jsEventListeners	"type": INTEGER	-	-

getDOMCountersForLeakDetection

Retruns DOM object counters after preparing renderer for leak detection.

-

RETURNS:

Name	Type	Description	Flags
counters	"type": ARRAY "items": { "$ref": DOMCounter }	DOM object counters.	-

getSamplingProfile

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

-

RETURNS:

Name	Type	Description	Flags
profile	"$ref": SamplingProfile	-	-

prepareForLeakDetection

Prepares for leak detection by terminating workers, stopping spellcheckers, dropping non-essential internal caches, running garbage collections, etc.

-

setPressureNotificationsSuppressed

Enable/disable suppressing memory pressure notifications in all processes.

-

PARAMETERS:

Name	Type	Description	Flags
suppressed	"type": 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	"type": INTEGER	Average number of bytes between samples.	[OPTIONAL]
suppressRandomness	"type": BOOLEAN	Do not randomize intervals between samples.	[OPTIONAL]

stopSampling

Stop collecting native memory profile.

-

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

AlternateProtocolUsage

The reason why Chrome uses a specific transport protocol for HTTP semantics.

[EXPERIMENTAL]

AssociatedCookie

OBJECT

A cookie associated with the request which may or may not be sent with it. Includes the cookies itself and reasons for blocking or exemption.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
cookie	"$ref": Cookie	The cookie object representing the cookie which was not sent.	-
blockedReasons	"type": ARRAY "items": { "$ref": CookieBlockedReason }	The reason(s) the cookie was blocked. If empty means the cookie is included.	-
exemptionReason	"$ref": CookieExemptionReason	The reason the cookie should have been blocked by 3PCD but is exempted. A cookie could only have at most one exemption reason.	[OPTIONAL]

AuthChallenge

OBJECT

Authorization challenge for HTTP status code 401 or 407.

[EXPERIMENTAL]

PROPERTIES:

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

AuthChallengeResponse

OBJECT

Response to an AuthChallenge.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
response	"CancelAuth", "Default", "ProvideCredentials"String [Hover] Enum "type": STRING	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	"type": STRING	The username to provide, possibly empty. Should only be set if response is ProvideCredentials.	[OPTIONAL]
password	"type": STRING	The password to provide, possibly empty. Should only be set if response is ProvideCredentials.	[OPTIONAL]

BlockedReason

The reason why request was blocked.

-

BlockedSetCookieWithReason

OBJECT

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

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
blockedReasons	"type": ARRAY "items": { "$ref": SetCookieBlockedReason }	The reason(s) this cookie was blocked.	-
cookieLine	"type": 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]

CachedResource

OBJECT

Information about the cached resource.

-

PROPERTIES:

Name	Type	Description	Flags
url	"type": 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	"type": NUMBER	Cached response body size.	-

CertificateTransparencyCompliance

Whether the request complied with Certificate Transparency policy.

-

ClientSecurityState

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
initiatorIsSecureContext	"type": BOOLEAN	-	-
initiatorIPAddressSpace	"$ref": IPAddressSpace	-	-
privateNetworkRequestPolicy	"$ref": PrivateNetworkRequestPolicy	-	-

ConnectTiming

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
requestTime	"type": 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).	-

ConnectionType

The underlying connection technology that the browser is supposedly using.

-

ContentEncoding

List of content encodings supported by the backend.

[EXPERIMENTAL]

ContentSecurityPolicySource

-

[EXPERIMENTAL]

ContentSecurityPolicyStatus

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
effectiveDirectives	"type": STRING	-	-
isEnforced	"type": BOOLEAN	-	-
source	"$ref": ContentSecurityPolicySource	-	-

PROPERTIES:

Name	Type	Description	Flags
name	"type": STRING	Cookie name.	-
value	"type": STRING	Cookie value.	-
domain	"type": STRING	Cookie domain.	-
path	"type": STRING	Cookie path.	-
expires	"type": NUMBER	Cookie expiration date as the number of seconds since the UNIX epoch.	-
size	"type": INTEGER	Cookie size.	-
httpOnly	"type": BOOLEAN	True if cookie is http-only.	-
secure	"type": BOOLEAN	True if cookie is secure.	-
session	"type": BOOLEAN	True in case of session cookie.	-
sameSite	"$ref": CookieSameSite	Cookie SameSite type.	[OPTIONAL]
priority	"$ref": CookiePriority	Cookie Priority	[EXPERIMENTAL]
sameParty	"type": BOOLEAN	True if cookie is SameParty.	[EXPERIMENTAL] [DEPRECATED]
sourceScheme	"$ref": CookieSourceScheme	Cookie source scheme type.	[EXPERIMENTAL]
sourcePort	"type": 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]
partitionKey	"$ref": CookiePartitionKey	Cookie partition key.	[OPTIONAL] [EXPERIMENTAL]
partitionKeyOpaque	"type": BOOLEAN	True if cookie partition key is opaque.	[OPTIONAL] [EXPERIMENTAL]

CookieBlockedReason

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

[EXPERIMENTAL]

CookieExemptionReason

Types of reasons why a cookie should have been blocked by 3PCD but is exempted for the request.

[EXPERIMENTAL]

CookieParam

OBJECT

Cookie parameter object

-

PROPERTIES:

Name	Type	Description	Flags
name	"type": STRING	Cookie name.	-
value	"type": STRING	Cookie value.	-
url	"type": 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	"type": STRING	Cookie domain.	[OPTIONAL]
path	"type": STRING	Cookie path.	[OPTIONAL]
secure	"type": BOOLEAN	True if cookie is secure.	[OPTIONAL]
httpOnly	"type": 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	"type": BOOLEAN	True if cookie is SameParty.	[OPTIONAL] [EXPERIMENTAL]
sourceScheme	"$ref": CookieSourceScheme	Cookie source scheme type.	[OPTIONAL] [EXPERIMENTAL]
sourcePort	"type": 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]
partitionKey	"$ref": CookiePartitionKey	Cookie partition key. If not set, the cookie will be set as not partitioned.	[OPTIONAL] [EXPERIMENTAL]

CookiePartitionKey

OBJECT

cookiePartitionKey object The representation of the components of the key that are created by the cookiePartitionKey class contained in net/cookies/cookie_partition_key.h.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
topLevelSite	"type": STRING	The site of the top-level URL the browser was visiting at the start of the request to the endpoint that set the cookie.	-
hasCrossSiteAncestor	"type": BOOLEAN	Indicates if the cookie has any ancestors that are cross-site to the topLevelSite.	-

CookiePriority

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

[EXPERIMENTAL]

CookieSameSite

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

-

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]

CorsError

The reason why request was blocked.

-

CorsErrorStatus

OBJECT

-

PROPERTIES:

Name	Type	Description	Flags
corsError	"$ref": CorsError	-	-
failedParameter	"type": STRING	-	-

CrossOriginEmbedderPolicyStatus

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
value	"$ref": CrossOriginEmbedderPolicyValue	-	-
reportOnlyValue	"$ref": CrossOriginEmbedderPolicyValue	-	-
reportingEndpoint	"type": STRING	-	[OPTIONAL]
reportOnlyReportingEndpoint	"type": STRING	-	[OPTIONAL]

CrossOriginEmbedderPolicyValue

-

[EXPERIMENTAL]

CrossOriginOpenerPolicyStatus

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
value	"$ref": CrossOriginOpenerPolicyValue	-	-
reportOnlyValue	"$ref": CrossOriginOpenerPolicyValue	-	-
reportingEndpoint	"type": STRING	-	[OPTIONAL]
reportOnlyReportingEndpoint	"type": STRING	-	[OPTIONAL]

CrossOriginOpenerPolicyValue

-

[EXPERIMENTAL]

DirectSocketDnsQueryType

-

[EXPERIMENTAL]

DirectTCPSocketOptions

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
noDelay	"type": BOOLEAN	TCP_NODELAY option	-
keepAliveDelay	"type": NUMBER	Expected to be unsigned integer.	[OPTIONAL]
sendBufferSize	"type": NUMBER	Expected to be unsigned integer.	[OPTIONAL]
receiveBufferSize	"type": NUMBER	Expected to be unsigned integer.	[OPTIONAL]
dnsQueryType	"$ref": DirectSocketDnsQueryType	-	[OPTIONAL]

DirectUDPMessage

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
data	"type": STRING	-	-
remoteAddr	"type": STRING	Null for connected mode.	[OPTIONAL]
remotePort	"type": INTEGER	Null for connected mode. Expected to be unsigned integer.	[OPTIONAL]

DirectUDPSocketOptions

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
remoteAddr	"type": STRING	-	[OPTIONAL]
remotePort	"type": INTEGER	Unsigned int 16.	[OPTIONAL]
localAddr	"type": STRING	-	[OPTIONAL]
localPort	"type": INTEGER	Unsigned int 16.	[OPTIONAL]
dnsQueryType	"$ref": DirectSocketDnsQueryType	-	[OPTIONAL]
sendBufferSize	"type": NUMBER	Expected to be unsigned integer.	[OPTIONAL]
receiveBufferSize	"type": NUMBER	Expected to be unsigned integer.	[OPTIONAL]

ErrorReason

Network level fetch failure reason.

-

ExemptedSetCookieWithReason

OBJECT

A cookie should have been blocked by 3PCD but is exempted and stored from a response with the corresponding reason. A cookie could only have at most one exemption reason.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
exemptionReason	"$ref": CookieExemptionReason	The reason the cookie was exempted.	-
cookieLine	"type": STRING	The string representing this individual cookie as it would appear in the header.	-
cookie	"$ref": Cookie	The cookie object representing the cookie.	-

Headers

OBJECT
as JsonValue

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

-

IPAddressSpace

-

[EXPERIMENTAL]

Initiator

OBJECT

Information about the request initiator.

-

PROPERTIES:

Name	Type	Description	Flags
type	"SignedExchange", "other", "parser", "preflight", "preload", "script"String [Hover] Enum "type": STRING	Type of this initiator.	-
stack	"$ref": RunTime.StackTrace	Initiator JavaScript stack trace, set for Script only. Requires the Debugger domain to be enabled.	[OPTIONAL]
url	"type": STRING	Initiator URL, set for Parser type or for Script type (when script is importing module) or for SignedExchange type.	[OPTIONAL]
lineNumber	"type": NUMBER	Initiator line number, set for Parser type or for Script type (when script is importing module) (0-based).	[OPTIONAL]
columnNumber	"type": 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]

InterceptionId

STRING

Unique intercepted request identifier.

-

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]

LoadNetworkResourceOptions

OBJECT

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

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
disableCache	"type": BOOLEAN	-	-
includeCredentials	"type": BOOLEAN	-	-

LoadNetworkResourcePageResult

OBJECT

An object providing the result of a network resource load.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
success	"type": BOOLEAN	-	-
netError	"type": NUMBER	Optional values used for error reporting.	[OPTIONAL]
netErrorName	"type": STRING	-	[OPTIONAL]
httpStatusCode	"type": 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]

LoaderId

STRING

Unique loader identifier.

-

MonotonicTime

NUMBER

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

-

PostDataEntry

OBJECT

Post data entry for HTTP request

-

PROPERTIES:

Name	Type	Description	Flags
bytes	"type": STRING	-	[OPTIONAL]

PrivateNetworkRequestPolicy

-

[EXPERIMENTAL]

ReportId

STRING

-

[EXPERIMENTAL]

ReportStatus

The status of a Reporting API report.

[EXPERIMENTAL]

ReportingApiEndpoint

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
url	"type": STRING	The URL of the endpoint to which reports may be delivered.	-
groupName	"type": STRING	Name of the endpoint group.	-

ReportingApiReport

OBJECT

An object representing a report generated by the Reporting API.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
id	"$ref": ReportId	-	-
initiatorUrl	"type": STRING	The URL of the document that triggered the report.	-
destination	"type": STRING	The name of the endpoint group that should be used to deliver the report.	-
type	"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	"type": INTEGER	How many uploads deep the related request was.	-
completedAttempts	"type": INTEGER	The number of delivery attempts made so far, not including an active attempt.	-
body	"type": OBJECT	-	-
status	"$ref": ReportStatus	-	-

Request

OBJECT

HTTP request data.

-

PROPERTIES:

Name	Type	Description	Flags
url	"type": STRING	Request URL (without fragment).	-
urlFragment	"type": STRING	Fragment of the requested URL starting with hash, if present.	[OPTIONAL]
method	"type": STRING	HTTP request method.	-
headers	"$ref": Headers	HTTP request headers.	-
postData	"type": STRING	HTTP POST request data. Use postDataEntries instead.	[OPTIONAL] [DEPRECATED]
hasPostData	"type": 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	"type": ARRAY "items": { "$ref": PostDataEntry }	Request body elements (post data broken into individual entries).	[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	"no-referrer", "no-referrer-when-downgrade", "origin", "origin-when-cross-origin", "same-origin", "strict-origin", "strict-origin-when-cross-origin", "unsafe-url"String [Hover] Enum "type": STRING	The referrer policy of the request, as defined in https://www.w3.org/TR/referrer-policy/	-
isLinkPreload	"type": 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	"type": BOOLEAN	True if this resource request is considered to be the 'same site' as the request corresponding to the main frame.	[OPTIONAL] [EXPERIMENTAL]

RequestId

STRING

Unique network request identifier. Note that this does not identify individual HTTP requests that are part of a network request.

-

RequestPattern

OBJECT

Request pattern for interception.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
urlPattern	"type": 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]

ResourcePriority

Loading priority of a resource request.

-

ResourceTiming

OBJECT

Timing information for the request.

-

PROPERTIES:

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

ResourceType

Resource type as it was perceived by the rendering engine.

-

Response

OBJECT

HTTP response data.

-

PROPERTIES:

Name	Type	Description	Flags
url	"type": STRING	Response URL. This URL can be different from CachedResource.url in case of redirect.	-
status	"type": INTEGER	HTTP response status code.	-
statusText	"type": STRING	HTTP response status text.	-
headers	"$ref": Headers	HTTP response headers.	-
headersText	"type": STRING	HTTP response headers text. This has been replaced by the headers in Network.responseReceivedExtraInfo.	[OPTIONAL] [DEPRECATED]
mimeType	"type": STRING	Resource mimeType as determined by the browser.	-
charset	"type": STRING	Resource charset as determined by the browser (if applicable).	-
requestHeaders	"$ref": Headers	Refined HTTP request headers that were actually transmitted over the network.	[OPTIONAL]
requestHeadersText	"type": STRING	HTTP request headers text. This has been replaced by the headers in Network.requestWillBeSentExtraInfo.	[OPTIONAL] [DEPRECATED]
connectionReused	"type": BOOLEAN	Specifies whether physical connection was actually reused for this request.	-
connectionId	"type": NUMBER	Physical connection id that was actually used for this request.	-
remoteIPAddress	"type": STRING	Remote IP address.	[OPTIONAL]
remotePort	"type": INTEGER	Remote port.	[OPTIONAL]
fromDiskCache	"type": BOOLEAN	Specifies that the request was served from the disk cache.	[OPTIONAL]
fromServiceWorker	"type": BOOLEAN	Specifies that the request was served from the ServiceWorker.	[OPTIONAL]
fromPrefetchCache	"type": BOOLEAN	Specifies that the request was served from the prefetch cache.	[OPTIONAL]
fromEarlyHints	"type": BOOLEAN	Specifies that the request was served from the prefetch cache.	[OPTIONAL]
serviceWorkerRouterInfo	"$ref": ServiceWorkerRouterInfo	Information about how ServiceWorker Static Router API was used. If this field is set with `matchedSourceType` field, a matching rule is found. If this field is set without `matchedSource`, no matching rule is found. Otherwise, the API is not used.	[OPTIONAL] [EXPERIMENTAL]
encodedDataLength	"type": 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	"type": STRING	Cache Storage Cache Name.	[OPTIONAL]
protocol	"type": STRING	Protocol used to fetch this request.	[OPTIONAL]
alternateProtocolUsage	"$ref": AlternateProtocolUsage	The reason why Chrome uses a specific transport protocol for HTTP semantics.	[OPTIONAL] [EXPERIMENTAL]
securityState	"$ref": Security.SecurityState	Security state of the request resource.	-
securityDetails	"$ref": SecurityDetails	Security details for the request.	[OPTIONAL]
isIpProtectionUsed	"type": BOOLEAN	Indicates whether the request was sent through IP Protection proxies. If set to true, the request used the IP Protection privacy feature.	[OPTIONAL] [EXPERIMENTAL]

SecurityDetails

OBJECT

Security details about a request.

-

PROPERTIES:

Name	Type	Description	Flags
protocol	"type": STRING	Protocol name (e.g. "TLS 1.2" or "QUIC").	-
keyExchange	"type": STRING	Key Exchange used by the connection, or the empty string if not applicable.	-
keyExchangeGroup	"type": STRING	(EC)DH group used by the connection, if applicable.	[OPTIONAL]
cipher	"type": STRING	Cipher name.	-
mac	"type": STRING	TLS MAC. Note that AEAD ciphers do not have separate MACs.	[OPTIONAL]
certificateId	"$ref": Security.CertificateId	Certificate ID value.	-
subjectName	"type": STRING	Certificate subject name.	-
sanList	"type": ARRAY "items": { "type": STRING }	Subject Alternative Name (SAN) DNS names and IP addresses.	-
issuer	"type": STRING	Name of the issuing CA.	-
validFrom	"$ref": TimeSinceEpoch	Certificate valid from date.	-
validTo	"$ref": TimeSinceEpoch	Certificate valid to (expiration) date	-
signedCertificateTimestampList	"type": ARRAY "items": { "$ref": SignedCertificateTimestamp }	List of signed certificate timestamps (SCTs).	-
certificateTransparencyCompliance	"$ref": CertificateTransparencyCompliance	Whether the request complied with Certificate Transparency policy	-
serverSignatureAlgorithm	"type": INTEGER	The signature algorithm used by the server in the TLS server signature, represented as a TLS SignatureScheme code point. Omitted if not applicable or not known.	[OPTIONAL]
encryptedClientHello	"type": BOOLEAN	Whether the connection used Encrypted ClientHello	-

SecurityIsolationStatus

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
coop	"$ref": CrossOriginOpenerPolicyStatus	-	[OPTIONAL]
coep	"$ref": CrossOriginEmbedderPolicyStatus	-	[OPTIONAL]
csp	"type": ARRAY "items": { "$ref": ContentSecurityPolicyStatus }	-	[OPTIONAL]

ServiceWorkerResponseSource

Source of serviceworker response.

-

ServiceWorkerRouterInfo

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
ruleIdMatched	"type": INTEGER	ID of the rule matched. If there is a matched rule, this field will be set, otherwiser no value will be set.	[OPTIONAL]
matchedSourceType	"$ref": ServiceWorkerRouterSource	The router source of the matched rule. If there is a matched rule, this field will be set, otherwise no value will be set.	[OPTIONAL]
actualSourceType	"$ref": ServiceWorkerRouterSource	The actual router source used.	[OPTIONAL]

ServiceWorkerRouterSource

Source of service worker router.

-

SetCookieBlockedReason

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

[EXPERIMENTAL]

SignedCertificateTimestamp

OBJECT

Details of a signed certificate timestamp (SCT).

-

PROPERTIES:

Name	Type	Description	Flags
status	"type": STRING	Validation status.	-
origin	"type": STRING	Origin.	-
logDescription	"type": STRING	Log name / description.	-
logId	"type": STRING	Log ID.	-
timestamp	"type": NUMBER	Issuance date. Unlike TimeSinceEpoch, this contains the number of milliseconds since January 1, 1970, UTC, not the number of seconds.	-
hashAlgorithm	"type": STRING	Hash algorithm.	-
signatureAlgorithm	"type": STRING	Signature algorithm.	-
signatureData	"type": STRING	Signature data.	-

SignedExchangeError

OBJECT

Information about a signed exchange response.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
message	"type": STRING	Error message.	-
signatureIndex	"type": INTEGER	The index of the signature which caused the error.	[OPTIONAL]
errorField	"$ref": SignedExchangeErrorField	The field which caused the error.	[OPTIONAL]

SignedExchangeErrorField

Field type for a signed exchange related error.

[EXPERIMENTAL]

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	"type": STRING	Signed exchange request URL.	-
responseCode	"type": INTEGER	Signed exchange response code.	-
responseHeaders	"$ref": Headers	Signed exchange response headers.	-
signatures	"type": ARRAY "items": { "$ref": SignedExchangeSignature }	Signed exchange response signature.	-
headerIntegrity	"type": STRING	Signed exchange header integrity hash in the form of `sha256-<base64-hash-value>`.	-

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.	-
hasExtraInfo	"type": BOOLEAN	Whether network response for the signed exchange was accompanied by extra headers.	-
header	"$ref": SignedExchangeHeader	Information about the signed exchange header.	[OPTIONAL]
securityDetails	"$ref": SecurityDetails	Security details for the signed exchange header.	[OPTIONAL]
errors	"type": ARRAY "items": { "$ref": SignedExchangeError }	Errors occurred while handling the signed exchange.	[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	"type": STRING	Signed exchange signature label.	-
signature	"type": STRING	The hex string of signed exchange signature.	-
integrity	"type": STRING	Signed exchange signature integrity.	-
certUrl	"type": STRING	Signed exchange signature cert Url.	[OPTIONAL]
certSha256	"type": STRING	The hex string of signed exchange signature cert sha256.	[OPTIONAL]
validityUrl	"type": STRING	Signed exchange signature validity Url.	-
date	"type": INTEGER	Signed exchange signature date.	-
expires	"type": INTEGER	Signed exchange signature expires.	-
certificates	"type": ARRAY "items": { "type": STRING }	The encoded certificates.	[OPTIONAL]

TimeSinceEpoch

NUMBER

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

-

TrustTokenOperationType

-

[EXPERIMENTAL]

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
operation	"$ref": TrustTokenOperationType	-	-
refreshPolicy	"Refresh", "UseCached"String [Hover] Enum "type": STRING	Only set for "token-redemption" operation and determine whether to request a fresh SRR or use a still valid cached SRR.	-
issuers	"type": ARRAY "items": { "type": STRING }	Origins of issuers from whom to request tokens or redemption records.	[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	"type": NUMBER	WebSocket message opcode.	-
mask	"type": BOOLEAN	WebSocket message mask.	-
payloadData	"type": 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.	-

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	"type": INTEGER	HTTP response status code.	-
statusText	"type": STRING	HTTP response status text.	-
headers	"$ref": Headers	HTTP response headers.	-
headersText	"type": STRING	HTTP response headers text.	[OPTIONAL]
requestHeaders	"$ref": Headers	HTTP request headers.	[OPTIONAL]
requestHeadersText	"type": STRING	HTTP request headers text.	[OPTIONAL]

COMMANDS

Name

Description

Flags

canClearBrowserCache

Tells whether clearing browser cache is supported.

[DEPRECATED]

RETURNS:

Name	Type	Description	Flags
result	"type": BOOLEAN	True if browser cache can be cleared.	-

canClearBrowserCookies

Tells whether clearing browser cookies is supported.

[DEPRECATED]

RETURNS:

Name	Type	Description	Flags
result	"type": BOOLEAN	True if browser cookies can be cleared.	-

canEmulateNetworkConditions

Tells whether emulation of network conditions is supported.

[DEPRECATED]

RETURNS:

Name	Type	Description	Flags
result	"type": BOOLEAN	True if emulation of network conditions is supported.	-

clearAcceptedEncodingsOverride

Clears accepted encodings set by setAcceptedEncodings

[EXPERIMENTAL]

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	"type": 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	"type": 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	"type": STRING	If set this allows the request method to be overridden. Must not be set in response to an authChallenge.	[OPTIONAL]
postData	"type": 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/partitionKey pair.

-

PARAMETERS:

Name	Type	Description	Flags
name	"type": STRING	Name of the cookies to remove.	-
url	"type": STRING	If specified, deletes all the cookies with the given name where domain and path match provided URL.	[OPTIONAL]
domain	"type": STRING	If specified, deletes only cookies with the exact domain.	[OPTIONAL]
path	"type": STRING	If specified, deletes only cookies with the exact path.	[OPTIONAL]
partitionKey	"$ref": CookiePartitionKey	If specified, deletes only cookies with the the given name and partitionKey where all partition key attributes match the cookie partition key attribute.	[OPTIONAL] [EXPERIMENTAL]

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	"type": BOOLEAN	True to emulate internet disconnection.	-
latency	"type": NUMBER	Minimum latency from request sent to response headers received (ms).	-
downloadThroughput	"type": NUMBER	Maximal aggregated download throughput (bytes/sec). -1 disables download throttling.	-
uploadThroughput	"type": NUMBER	Maximal aggregated upload throughput (bytes/sec). -1 disables upload throttling.	-
connectionType	"$ref": ConnectionType	Connection type if known.	[OPTIONAL]
packetLoss	"type": NUMBER	WebRTC packet loss (percent, 0-100). 0 disables packet loss emulation, 100 drops all the packets.	[OPTIONAL] [EXPERIMENTAL]
packetQueueLength	"type": INTEGER	WebRTC packet queue length (packet). 0 removes any queue length limitations.	[OPTIONAL] [EXPERIMENTAL]
packetReordering	"type": BOOLEAN	WebRTC packetReordering feature.	[OPTIONAL] [EXPERIMENTAL]

enable

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

-

PARAMETERS:

Name	Type	Description	Flags
maxTotalBufferSize	"type": INTEGER	Buffer size in bytes to use when preserving network payloads (XHRs, etc).	[OPTIONAL] [EXPERIMENTAL]
maxResourceBufferSize	"type": INTEGER	Per-resource buffer size in bytes to use when preserving network payloads (XHRs, etc).	[OPTIONAL] [EXPERIMENTAL]
maxPostDataSize	"type": INTEGER	Longest post body size (in bytes) that would be included in requestWillBeSent notification	[OPTIONAL]
reportDirectSocketTraffic	"type": BOOLEAN	Whether DirectSocket chunk send/receive events should be reported.	[OPTIONAL] [EXPERIMENTAL]

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	"type": BOOLEAN	Whether to enable or disable events for the Reporting API	-

getAllCookies

Returns all browser cookies. Depending on the backend support, will return detailed cookie information in the `cookies` field. Deprecated. Use Storage.getCookies instead.

[DEPRECATED]

RETURNS:

Name	Type	Description	Flags
cookies	"type": ARRAY "items": { "$ref": Cookie }	Array of cookie objects.	-

getCertificate

Returns the DER-encoded certificate.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
origin	"type": STRING	Origin to get certificate for.	-

RETURNS:

Name	Type	Description	Flags
tableNames	"type": ARRAY "items": { "type": 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	"type": ARRAY "items": { "type": 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	"type": ARRAY "items": { "$ref": Cookie }	Array of cookie objects.	-

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	"type": STRING	Request body string, omitting files from multipart requests	-

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	"type": STRING	Response body.	-
base64Encoded	"type": BOOLEAN	True, if content was sent as base64.	-

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	"type": STRING	Response body.	-
base64Encoded	"type": BOOLEAN	True, if content was sent as base64.	-

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

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	"type": STRING	URL of the resource to get content for.	-
options	"$ref": LoadNetworkResourceOptions	Options for the request.	-

RETURNS:

Name	Type	Description	Flags
resource	"$ref": LoadNetworkResourcePageResult	-	-

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	"type": STRING	String to search for.	-
caseSensitive	"type": BOOLEAN	If true, search is case sensitive.	[OPTIONAL]
isRegex	"type": BOOLEAN	If true, treats string parameter as regex.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
result	"type": ARRAY "items": { "$ref": Debugger.SearchMatch }	List of search matches.	-

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	"type": ARRAY "items": { "$ref": ContentEncoding }	List of accepted content encodings.	-

setAttachDebugStack

Specifies whether to attach a page script stack id in requests

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
enabled	"type": BOOLEAN	Whether to attach a page script stack for debugging purpose.	-

setBlockedURLs

Blocks URLs from loading.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
urls	"type": ARRAY "items": { "type": STRING }	URL patterns to block. Wildcards ('*') are allowed.	-

setBypassServiceWorker

Toggles ignoring of service worker for each request.

-

PARAMETERS:

Name	Type	Description	Flags
bypass	"type": 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	"type": 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	"type": STRING	Cookie name.	-
value	"type": STRING	Cookie value.	-
url	"type": 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	"type": STRING	Cookie domain.	[OPTIONAL]
path	"type": STRING	Cookie path.	[OPTIONAL]
secure	"type": BOOLEAN	True if cookie is secure.	[OPTIONAL]
httpOnly	"type": 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	"type": BOOLEAN	True if cookie is SameParty.	[OPTIONAL] [EXPERIMENTAL]
sourceScheme	"$ref": CookieSourceScheme	Cookie source scheme type.	[OPTIONAL] [EXPERIMENTAL]
sourcePort	"type": 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]
partitionKey	"$ref": CookiePartitionKey	Cookie partition key. If not set, the cookie will be set as not partitioned.	[OPTIONAL] [EXPERIMENTAL]

RETURNS:

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

setCookieControls

Sets Controls for third-party cookie access Page reload is required before the new cookie behavior will be observed

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
enableThirdPartyCookieRestriction	"type": BOOLEAN	Whether 3pc restriction is enabled.	-
disableThirdPartyCookieMetadata	"type": BOOLEAN	Whether 3pc grace period exception should be enabled; false by default.	-
disableThirdPartyCookieHeuristics	"type": BOOLEAN	Whether 3pc heuristics exceptions should be enabled; false by default.	-

setCookies

Sets given cookies.

-

PARAMETERS:

Name	Type	Description	Flags
cookies	"type": ARRAY "items": { "$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.	-

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	"type": ARRAY "items": { "$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	"type": STRING	User agent to use.	-
acceptLanguage	"type": STRING	Browser language to emulate.	[OPTIONAL]
platform	"type": 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]

streamResourceContent

Enables streaming of the response for the given requestId. If enabled, the dataReceived event contains the data that was received during streaming.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
requestId	"$ref": RequestId	Identifier of the request to stream.	-

RETURNS:

Name	Type	Description	Flags
bufferedData	"type": STRING	Data that has been buffered until streaming is enabled. (Encoded as a base64 string when passed over JSON)	-

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

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	"type": INTEGER	Data chunk length.	-
encodedDataLength	"type": INTEGER	Actual bytes received (might be less than dataLength for compressed encodings).	-
data	"type": STRING	Data that was received. (Encoded as a base64 string when passed over JSON)	[OPTIONAL] [EXPERIMENTAL]

directTCPSocketAborted

Fired when direct_socket.TCPSocket is aborted.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
identifier	"$ref": RequestId	-	-
errorMessage	"type": STRING	-	-
timestamp	"$ref": MonotonicTime	-	-

directTCPSocketChunkReceived

Fired when data is received from tcp direct socket stream.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
identifier	"$ref": RequestId	-	-
data	"type": STRING	-	-
timestamp	"$ref": MonotonicTime	-	-

directTCPSocketChunkSent

Fired when data is sent to tcp direct socket stream.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
identifier	"$ref": RequestId	-	-
data	"type": STRING	-	-
timestamp	"$ref": MonotonicTime	-	-

directTCPSocketClosed

Fired when direct_socket.TCPSocket is closed.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
identifier	"$ref": RequestId	-	-
timestamp	"$ref": MonotonicTime	-	-

directTCPSocketCreated

Fired upon direct_socket.TCPSocket creation.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
identifier	"$ref": RequestId	-	-
remoteAddr	"type": STRING	-	-
remotePort	"type": INTEGER	Unsigned int 16.	-
options	"$ref": DirectTCPSocketOptions	-	-
timestamp	"$ref": MonotonicTime	-	-
initiator	"$ref": Initiator	-	[OPTIONAL]

directTCPSocketOpened

Fired when direct_socket.TCPSocket connection is opened.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
identifier	"$ref": RequestId	-	-
remoteAddr	"type": STRING	-	-
remotePort	"type": INTEGER	Expected to be unsigned integer.	-
timestamp	"$ref": MonotonicTime	-	-
localAddr	"type": STRING	-	[OPTIONAL]
localPort	"type": INTEGER	Expected to be unsigned integer.	[OPTIONAL]

directUDPSocketAborted

Fired when direct_socket.UDPSocket is aborted.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
identifier	"$ref": RequestId	-	-
errorMessage	"type": STRING	-	-
timestamp	"$ref": MonotonicTime	-	-

directUDPSocketChunkReceived

Fired when message is received from udp direct socket stream.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
identifier	"$ref": RequestId	-	-
message	"$ref": DirectUDPMessage	-	-
timestamp	"$ref": MonotonicTime	-	-

directUDPSocketChunkSent

Fired when message is sent to udp direct socket stream.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
identifier	"$ref": RequestId	-	-
message	"$ref": DirectUDPMessage	-	-
timestamp	"$ref": MonotonicTime	-	-

directUDPSocketClosed

Fired when direct_socket.UDPSocket is closed.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
identifier	"$ref": RequestId	-	-
timestamp	"$ref": MonotonicTime	-	-

directUDPSocketCreated

Fired upon direct_socket.UDPSocket creation.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
identifier	"$ref": RequestId	-	-
options	"$ref": DirectUDPSocketOptions	-	-
timestamp	"$ref": MonotonicTime	-	-
initiator	"$ref": Initiator	-	[OPTIONAL]

directUDPSocketOpened

Fired when direct_socket.UDPSocket connection is opened.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
identifier	"$ref": RequestId	-	-
localAddr	"type": STRING	-	-
localPort	"type": INTEGER	Expected to be unsigned integer.	-
timestamp	"$ref": MonotonicTime	-	-
remoteAddr	"type": STRING	-	[OPTIONAL]
remotePort	"type": INTEGER	Expected to be unsigned integer.	[OPTIONAL]

eventSourceMessageReceived

Fired when EventSource message is received.

-

PARAMETERS:

Name	Type	Description	Flags
requestId	"$ref": RequestId	Request identifier.	-
timestamp	"$ref": MonotonicTime	Timestamp.	-
eventName	"type": STRING	Message type.	-
eventId	"type": STRING	Message identifier.	-
data	"type": 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	"type": STRING	Error message. List of network errors: https://cs.chromium.org/chromium/src/net/base/net_error_list.h	-
canceled	"type": 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	"type": NUMBER	Total number of bytes received for this request.	-

policyUpdated

Fired once security policy has been updated.

[EXPERIMENTAL]

reportingApiEndpointsChangedForOrigin

-

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
origin	"type": STRING	Origin of the document(s) which configured the endpoints.	-
endpoints	"type": ARRAY "items": { "$ref": ReportingApiEndpoint }	-	-

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

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	"type": BOOLEAN	Whether this is a navigation request, which can abort the navigation completely.	-
isDownload	"type": 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	"type": 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	"type": 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	"type": 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	"type": 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	"type": BOOLEAN	Whether the request is initiated by a user gesture. Defaults to false.	[OPTIONAL]

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	"type": ARRAY "items": { "$ref": AssociatedCookie }	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 blockedReasons 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]
siteHasCookieInOtherPartition	"type": BOOLEAN	Whether the site has partitioned cookies stored in a partition different than the current one.	[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.	-

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	"type": BOOLEAN	Indicates whether requestWillBeSentExtraInfo and responseReceivedExtraInfo events will be or were emitted for this request.	[EXPERIMENTAL]
frameId	"$ref": Page.FrameId	Frame identifier.	[OPTIONAL]

responseReceivedEarlyHints

Fired when 103 Early Hints headers is received in addition to the common response. Not every responseReceived event will have an responseReceivedEarlyHints fired. Only one responseReceivedEarlyHints may be fired for eached responseReceived event.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
requestId	"$ref": RequestId	Request identifier. Used to match this information to another responseReceived event.	-
headers	"$ref": Headers	Raw response headers as they were received over the wire. Duplicate headers in the response are represented as a single key with their values concatentated using `\n` as the separator. See also `headersText` that contains verbatim text for HTTP/1.*.	-

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	"type": ARRAY "items": { "$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. Duplicate headers in the response are represented as a single key with their values concatentated using `\n` as the separator. See also `headersText` that contains verbatim text for HTTP/1.*.	-
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	"type": 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	"type": 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]
cookiePartitionKey	"$ref": CookiePartitionKey	The cookie partition key that will be used to store partitioned cookies set in this response. Only sent when partitioned cookies are enabled.	[OPTIONAL] [EXPERIMENTAL]
cookiePartitionKeyOpaque	"type": BOOLEAN	True if partitioned cookies are enabled, but the partition key is not serializable to string.	[OPTIONAL]
exemptedCookies	"type": ARRAY "items": { "$ref": ExemptedSetCookieWithReason }	A list of cookies which should have been blocked by 3PCD but are exempted and stored from the response with the corresponding reason.	[OPTIONAL]

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

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	"type": STRING	URL of the subresource resource.	-
errorMessage	"type": 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]

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	"type": 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]

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	"type": STRING	Error message	-

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	"type": ARRAY "items": { "type": STRING }	A list of URLs of resources in the subresource Web Bundle.	-

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	"AlreadyExists", "BadResponse", "FailedPrecondition", "FulfilledLocally", "InternalError", "InvalidArgument", "MissingIssuerKeys", "Ok", "ResourceExhausted", "ResourceLimited", "SiteIssuerLimit", "Unauthorized", "UnknownError"String [Hover] Enum "type": STRING	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	"type": STRING	Top level origin. The context in which the operation was attempted.	[OPTIONAL]
issuerOrigin	"type": STRING	Origin of the issuer in case of a "Issuance" or "Redemption" operation.	[OPTIONAL]
issuedTokenCount	"type": INTEGER	The number of obtained Trust Tokens on a successful "Issuance" operation.	[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	"type": 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	"type": 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.	-

webTransportClosed

Fired when WebTransport is disposed.

-

PARAMETERS:

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

webTransportConnectionEstablished

Fired when WebTransport handshake is finished.

-

PARAMETERS:

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

webTransportCreated

Fired upon WebTransport creation.

-

PARAMETERS:

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

Overlay

[Experimental]

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

Dependencies: DOM, Page, RunTime

PWA

[Experimental]

This domain allows interacting with the browser to control PWAs.

COMMANDS

Name

Description

Flags

changeAppUserSettings

Changes user settings of the web app identified by its manifestId. If the app was not installed, this command returns an error. Unset parameters will be ignored; unrecognized values will cause an error. Unlike the ones defined in the manifest files of the web apps, these settings are provided by the browser and controlled by the users, they impact the way the browser handling the web apps. See the comment of each parameter.

-

PARAMETERS:

Name	Type	Description	Flags
manifestId	"type": STRING	-	-
linkCapturing	"type": BOOLEAN	If user allows the links clicked on by the user in the app's scope, or extended scope if the manifest has scope extensions and the flags `DesktopPWAsLinkCapturingWithScopeExtensions` and `WebAppEnableScopeExtensions` are enabled. Note, the API does not support resetting the linkCapturing to the initial value, uninstalling and installing the web app again will reset it. TODO(crbug.com/339453269): Setting this value on ChromeOS is not supported yet.	[OPTIONAL]
displayMode	"$ref": DisplayMode	-	[OPTIONAL]

getOsAppState

Returns the following OS state for the given manifest id.

-

PARAMETERS:

Name	Type	Description	Flags
manifestId	"type": STRING	The id from the webapp's manifest file, commonly it's the url of the site installing the webapp. See https://web.dev/learn/pwa/web-app-manifest.	-

RETURNS:

Name	Type	Description	Flags
badgeCount	"type": INTEGER	-	-
fileHandlers	"type": ARRAY "items": { "$ref": FileHandler }	-	-

install

Installs the given manifest identity, optionally using the given installUrlOrBundleUrl IWA-specific install description: manifestId corresponds to isolated-app:// + web_package::SignedWebBundleId File installation mode: The installUrlOrBundleUrl can be either file:// or http(s):// pointing to a signed web bundle (.swbn). In this case SignedWebBundleId must correspond to The .swbn file's signing key. Dev proxy installation mode: installUrlOrBundleUrl must be http(s):// that serves dev mode IWA. web_package::SignedWebBundleId must be of type dev proxy. The advantage of dev proxy mode is that all changes to IWA automatically will be reflected in the running app without reinstallation. To generate bundle id for proxy mode: 1. Generate 32 random bytes. 2. Add a specific suffix 0x00 at the end. 3. Encode the entire sequence using Base32 without padding. If Chrome is not in IWA dev mode, the installation will fail, regardless of the state of the allowlist.

-

PARAMETERS:

Name	Type	Description	Flags
manifestId	"type": STRING	-	-
installUrlOrBundleUrl	"type": STRING	The location of the app or bundle overriding the one derived from the manifestId.	[OPTIONAL]

launch

Launches the installed web app, or an url in the same web app instead of the default start url if it is provided. Returns a page Target.TargetID which can be used to attach to via Target.attachToTarget or similar APIs.

-

PARAMETERS:

Name	Type	Description	Flags
manifestId	"type": STRING	-	-
url	"type": STRING	-	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
targetId	"$ref": Target.TargetID	ID of the tab target created as a result.	-

launchFilesInApp

Opens one or more local files from an installed web app identified by its manifestId. The web app needs to have file handlers registered to process the files. The API returns one or more page Target.TargetIDs which can be used to attach to via Target.attachToTarget or similar APIs. If some files in the parameters cannot be handled by the web app, they will be ignored. If none of the files can be handled, this API returns an error. If no files are provided as the parameter, this API also returns an error. According to the definition of the file handlers in the manifest file, one Target.TargetID may represent a page handling one or more files. The order of the returned Target.TargetIDs is not guaranteed. TODO(crbug.com/339454034): Check the existences of the input files.

-

PARAMETERS:

Name	Type	Description	Flags
manifestId	"type": STRING	-	-
files	"type": ARRAY "items": { "type": STRING }	-	-

RETURNS:

Name	Type	Description	Flags
targetIds	"type": ARRAY "items": { "$ref": Target.TargetID }	IDs of the tab targets created as the result.	-

openCurrentPageInApp

Opens the current page in its web app identified by the manifest id, needs to be called on a page target. This function returns immediately without waiting for the app to finish loading.

-

PARAMETERS:

Name	Type	Description	Flags
manifestId	"type": STRING	-	-

uninstall

Uninstalls the given manifest_id and closes any opened app windows.

-

PARAMETERS:

Name	Type	Description	Flags
manifestId	"type": STRING	-	-

Page

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

Dependencies: DOM, Debugger, IO, Network, RunTime

TYPES

Type ID

Type

Description

Flags

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	"type": ARRAY "items": { "$ref": AdFrameExplanation }	-	[OPTIONAL]

AdFrameType

Indicates whether a frame has been identified as an ad.

[EXPERIMENTAL]

AdScriptAncestry

OBJECT

Encapsulates the script ancestry and the root script filterlist rule that caused the frame to be labelled as an ad. Only created when `ancestryChain` is not empty.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
ancestryChain	"type": ARRAY "items": { "$ref": AdScriptId }	A chain of `AdScriptId`s representing the ancestry of an ad script that led to the creation of a frame. The chain is ordered from the script itself (lower level) up to its root ancestor that was flagged by filterlist.	-
rootScriptFilterlistRule	"type": STRING	The filterlist rule that caused the root (last) script in `ancestryChain` to be ad-tagged. Only populated if the rule is available.	[OPTIONAL]

AdScriptId

OBJECT

Identifies the script which caused a script or frame to be labelled as an ad.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
scriptId	"$ref": RunTime.ScriptId	Script Id of the script which caused a script or frame to be labelled as an ad.	-
debuggerId	"$ref": RunTime.UniqueDebuggerId	Id of scriptId's debugger.	-

AppManifestError

OBJECT

Error while paring app manifest.

-

PROPERTIES:

Name	Type	Description	Flags
message	"type": STRING	Error message.	-
critical	"type": INTEGER	If critical, this is a non-recoverable parse error.	-
line	"type": INTEGER	Error line.	-
column	"type": INTEGER	Error column.	-

AppManifestParsedProperties

OBJECT

Parsed app manifest properties.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
scope	"type": STRING	Computed scope value	-

BackForwardCacheBlockingDetails

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
url	"type": STRING	Url of the file where blockage happened. Optional because of tests.	[OPTIONAL]
function	"type": STRING	Function name where blockage happened. Optional because of anonymous functions and tests.	[OPTIONAL]
lineNumber	"type": INTEGER	Line number in the script (0-based).	-
columnNumber	"type": INTEGER	Column number in the script (0-based).	-

BackForwardCacheNotRestoredExplanation

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
type	"$ref": BackForwardCacheNotRestoredReasonType	Type of the reason	-
reason	"$ref": BackForwardCacheNotRestoredReason	Not restored reason	-
context	"type": STRING	Context associated with the reason. The meaning of this context is dependent on the reason: - EmbedderExtensionSentMessageToCachedFrame: the extension ID.	[OPTIONAL]
details	"type": ARRAY "items": { "$ref": BackForwardCacheBlockingDetails }	-	[OPTIONAL]

BackForwardCacheNotRestoredExplanationTree

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
url	"type": STRING	URL of each frame	-
explanations	"type": ARRAY "items": { "$ref": BackForwardCacheNotRestoredExplanation }	Not restored reasons of each frame	-
children	"type": ARRAY "items": { "$ref": BackForwardCacheNotRestoredExplanationTree }	Array of children frame	-

BackForwardCacheNotRestoredReason

List of not restored reasons for back-forward cache.

[EXPERIMENTAL]

BackForwardCacheNotRestoredReasonType

Types of not restored reasons for back-forward cache.

[EXPERIMENTAL]

ClientNavigationDisposition

-

[EXPERIMENTAL]

ClientNavigationReason

-

[EXPERIMENTAL]

CompilationCacheParams

OBJECT

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

[EXPERIMENTAL]

PROPERTIES:

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

CrossOriginIsolatedContextType

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

[EXPERIMENTAL]

DialogType

Javascript dialog type.

-

FileFilter

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
name	"type": STRING	-	[OPTIONAL]
accepts	"type": ARRAY "items": { "type": STRING }	-	[OPTIONAL]

FileHandler

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
action	"type": STRING	-	-
name	"type": STRING	-	-
icons	"type": ARRAY "items": { "$ref": ImageResource }	-	[OPTIONAL]
accepts	"type": ARRAY "items": { "$ref": FileFilter }	Mimic a map, name is the key, accepts is the value.	[OPTIONAL]
launchType	"type": STRING	Won't repeat the enums, using string for easy comparison. Same as the other enums below.	-

FontFamilies

OBJECT

Generic font families collection.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
standard	"type": STRING	The standard font-family.	[OPTIONAL]
fixed	"type": STRING	The fixed font-family.	[OPTIONAL]
serif	"type": STRING	The serif font-family.	[OPTIONAL]
sansSerif	"type": STRING	The sansSerif font-family.	[OPTIONAL]
cursive	"type": STRING	The cursive font-family.	[OPTIONAL]
fantasy	"type": STRING	The fantasy font-family.	[OPTIONAL]
math	"type": STRING	The math font-family.	[OPTIONAL]

FontSizes

OBJECT

Default font sizes.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
standard	"type": INTEGER	Default standard font size.	[OPTIONAL]
fixed	"type": INTEGER	Default fixed font size.	[OPTIONAL]

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	"type": STRING	Frame's name as specified in the tag.	[OPTIONAL]
url	"type": STRING	Frame document's URL without fragment.	-
urlFragment	"type": STRING	Frame document's URL fragment including the '#'.	[OPTIONAL] [EXPERIMENTAL]
domainAndRegistry	"type": 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	"type": STRING	Frame document's security origin.	-
securityOriginDetails	"$ref": SecurityOriginDetails	Additional details about the frame document's security origin.	[OPTIONAL] [EXPERIMENTAL]
mimeType	"type": STRING	Frame document's mimeType as determined by the browser.	-
unreachableUrl	"type": 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	"type": ARRAY "items": { "$ref": GatedAPIFeatures }	Indicated which gated APIs / features are available.	[EXPERIMENTAL]

FrameId

STRING

Unique frame identifier.

-

FrameResource

OBJECT

Information about the Resource on the page.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
url	"type": STRING	Resource URL.	-
type	"$ref": Network.ResourceType	Type of this resource.	-
mimeType	"type": STRING	Resource mimeType as determined by the browser.	-
lastModified	"$ref": Network.TimeSinceEpoch	last-modified timestamp as reported by server.	[OPTIONAL]
contentSize	"type": NUMBER	Resource content size.	[OPTIONAL]
failed	"type": BOOLEAN	True if the resource failed to load.	[OPTIONAL]
canceled	"type": 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	"type": ARRAY "items": { "$ref": FrameResourceTree }	Child frames.	[OPTIONAL]
resources	"type": ARRAY "items": { "$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	"type": ARRAY "items": { "$ref": FrameTree }	Child frames.	[OPTIONAL]

GatedAPIFeatures

-

[EXPERIMENTAL]

ImageResource

OBJECT

The image definition used in both icon and screenshot.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
url	"type": STRING	The src field in the definition, but changing to url in favor of consistency.	-
sizes	"type": STRING	-	[OPTIONAL]
type	"type": STRING	-	[OPTIONAL]

InstallabilityError

OBJECT

The installability error

[EXPERIMENTAL]

PROPERTIES:

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

InstallabilityErrorArgument

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

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

LaunchHandler

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
clientMode	"type": STRING	-	-

LayoutViewport

OBJECT

Layout viewport position and dimensions.

-

PROPERTIES:

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

NavigationEntry

OBJECT

Navigation history entry.

-

PROPERTIES:

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

NavigationType

The type of a frameNavigated event.

[EXPERIMENTAL]

OriginTrial

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
trialName	"type": STRING	-	-
status	"$ref": OriginTrialStatus	-	-
tokensWithStatus	"type": ARRAY "items": { "$ref": OriginTrialTokenWithStatus }	-	-

OriginTrialStatus

Status for an Origin Trial.

[EXPERIMENTAL]

OriginTrialToken

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
origin	"type": STRING	-	-
matchSubDomains	"type": BOOLEAN	-	-
trialName	"type": STRING	-	-
expiryTime	"$ref": Network.TimeSinceEpoch	-	-
isThirdParty	"type": BOOLEAN	-	-
usageRestriction	"$ref": OriginTrialUsageRestriction	-	-

OriginTrialTokenStatus

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

[EXPERIMENTAL]

OriginTrialTokenWithStatus

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

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

OriginTrialUsageRestriction

-

[EXPERIMENTAL]

PermissionsPolicyBlockLocator

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
frameId	"$ref": FrameId	-	-
blockReason	"$ref": PermissionsPolicyBlockReason	-	-

PermissionsPolicyBlockReason

Reason for a permissions policy feature to be disabled.

[EXPERIMENTAL]

PermissionsPolicyFeature

All Permissions Policy features. This enum should match the one defined in services/network/public/cpp/permissions_policy/permissions_policy_features.json5. LINT.IfChange(PermissionsPolicyFeature)

[EXPERIMENTAL]

PermissionsPolicyFeatureState

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
feature	"$ref": PermissionsPolicyFeature	-	-
allowed	"type": BOOLEAN	-	-
locator	"$ref": PermissionsPolicyBlockLocator	-	[OPTIONAL]

ProtocolHandler

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
protocol	"type": STRING	-	-
url	"type": STRING	-	-

ReferrerPolicy

The referring-policy used for the navigation.

[EXPERIMENTAL]

RelatedApplication

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
id	"type": STRING	-	[OPTIONAL]
url	"type": STRING	-	-

ScopeExtension

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
origin	"type": STRING	Instead of using tuple, this field always returns the serialized string for easy understanding and comparison.	-
hasOriginWildcard	"type": BOOLEAN	-	-

ScreencastFrameMetadata

OBJECT

Screencast frame metadata.

[EXPERIMENTAL]

PROPERTIES:

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

Screenshot

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
image	"$ref": ImageResource	-	-
formFactor	"type": STRING	-	-
label	"type": STRING	-	[OPTIONAL]

ScriptFontFamilies

OBJECT

Font families collection for a script.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
script	"type": STRING	Name of the script which these font families are defined for.	-
fontFamilies	"$ref": FontFamilies	Generic font families collection for the script.	-

ScriptIdentifier

STRING

Unique script identifier.

-

SecureContextType

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

[EXPERIMENTAL]

SecurityOriginDetails

OBJECT

Additional information about the frame document's security origin.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
isLocalhost	"type": BOOLEAN	Indicates whether the frame document's security origin is one of the local hostnames (e.g. "localhost") or IP addresses (IPv4 127.0.0.0/8 or IPv6 ::1).	-

ShareTarget

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
action	"type": STRING	-	-
method	"type": STRING	-	-
enctype	"type": STRING	-	-
title	"type": STRING	Embed the ShareTargetParams	[OPTIONAL]
text	"type": STRING	-	[OPTIONAL]
url	"type": STRING	-	[OPTIONAL]
files	"type": ARRAY "items": { "$ref": FileFilter }	-	[OPTIONAL]

Shortcut

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
name	"type": STRING	-	-
url	"type": STRING	-	-

TransitionType

Transition type.

-

Viewport

OBJECT

Viewport for capturing screenshot.

-

PROPERTIES:

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

VisualViewport

OBJECT

Visual viewport position, dimensions, and scale.

-

PROPERTIES:

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

WebAppManifest

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
backgroundColor	"type": STRING	-	[OPTIONAL]
description	"type": STRING	The extra description provided by the manifest.	[OPTIONAL]
dir	"type": STRING	-	[OPTIONAL]
display	"type": STRING	-	[OPTIONAL]
displayOverrides	"type": ARRAY "items": { "type": STRING }	The overrided display mode controlled by the user.	[OPTIONAL]
fileHandlers	"type": ARRAY "items": { "$ref": FileHandler }	The handlers to open files.	[OPTIONAL]
icons	"type": ARRAY "items": { "$ref": ImageResource }	-	[OPTIONAL]
id	"type": STRING	-	[OPTIONAL]
lang	"type": STRING	-	[OPTIONAL]
launchHandler	"$ref": LaunchHandler	TODO(crbug.com/1231886): This field is non-standard and part of a Chrome experiment. See: https://github.com/WICG/web-app-launch/blob/main/launch_handler.md	[OPTIONAL]
name	"type": STRING	-	[OPTIONAL]
orientation	"type": STRING	-	[OPTIONAL]
preferRelatedApplications	"type": BOOLEAN	-	[OPTIONAL]
protocolHandlers	"type": ARRAY "items": { "$ref": ProtocolHandler }	The handlers to open protocols.	[OPTIONAL]
relatedApplications	"type": ARRAY "items": { "$ref": RelatedApplication }	-	[OPTIONAL]
scope	"type": STRING	-	[OPTIONAL]
scopeExtensions	"type": ARRAY "items": { "$ref": ScopeExtension }	Non-standard, see https://github.com/WICG/manifest-incubations/blob/gh-pages/scope_extensions-explainer.md	[OPTIONAL]
screenshots	"type": ARRAY "items": { "$ref": Screenshot }	The screenshots used by chromium.	[OPTIONAL]
shareTarget	"$ref": ShareTarget	-	[OPTIONAL]
shortName	"type": STRING	-	[OPTIONAL]
shortcuts	"type": ARRAY "items": { "$ref": Shortcut }	-	[OPTIONAL]
startUrl	"type": STRING	-	[OPTIONAL]
themeColor	"type": STRING	-	[OPTIONAL]

COMMANDS

Name

Description

Flags

addCompilationCache

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

[EXPERIMENTAL]

PARAMETERS:

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

addScriptToEvaluateOnLoad

Deprecated, please use addScriptToEvaluateOnNewDocument instead.

[EXPERIMENTAL]
[DEPRECATED]

PARAMETERS:

Name	Type	Description	Flags
scriptSource	"type": 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	"type": STRING	-	-
worldName	"type": 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	"type": BOOLEAN	Specifies whether command line API should be available to the script, defaults to false.	[OPTIONAL] [EXPERIMENTAL]
runImmediately	"type": BOOLEAN	If true, runs the script immediately on existing execution contexts or worlds. Default: 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 "type": STRING	Image compression format (defaults to png).	[OPTIONAL]
quality	"type": INTEGER	Compression quality from range [0..100] (jpeg only).	[OPTIONAL]
clip	"$ref": Viewport	Capture the screenshot of a given region only.	[OPTIONAL]
fromSurface	"type": BOOLEAN	Capture the screenshot from the surface, rather than the view. Defaults to true.	[OPTIONAL] [EXPERIMENTAL]
captureBeyondViewport	"type": BOOLEAN	Capture the screenshot beyond the viewport. Defaults to false.	[OPTIONAL] [EXPERIMENTAL]
optimizeForSpeed	"type": BOOLEAN	Optimize image encoding for speed, not for resulting size (defaults to false)	[OPTIONAL] [EXPERIMENTAL]

RETURNS:

Name	Type	Description	Flags
data	"type": 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 "type": STRING	Format (defaults to mhtml).	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
data	"type": STRING	Serialized page data.	-

clearCompilationCache

Clears seeded compilation cache.

[EXPERIMENTAL]

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]

close

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

-

crash

Crashes renderer on the IO thread, generates minidumps.

[EXPERIMENTAL]

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	"type": STRING	An optional name which is reported in the Execution Context.	[OPTIONAL]
grantUniveralAccess	"type": 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	"type": STRING	Name of the cookie to remove.	-
url	"type": STRING	URL to match cooke domain and path.	-

disable

Disables page domain notifications.

-

enable

Enables page domain notifications.

-

PARAMETERS:

Name	Type	Description	Flags
enableFileChooserOpenedEvent	"type": BOOLEAN	If true, the `Page.fileChooserOpened` event will be emitted regardless of the state set by `Page.setInterceptFileChooserDialog` command (default: false).	[OPTIONAL] [EXPERIMENTAL]

generateTestReport

Generates a report for testing.

[EXPERIMENTAL]

PARAMETERS:

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

getAdScriptAncestry

-

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
frameId	"$ref": FrameId	-	-

RETURNS:

Name	Type	Description	Flags
adScriptAncestry	"$ref": AdScriptAncestry	The ancestry chain of ad script identifiers leading to this frame's creation, along with the root script's filterlist rule. The ancestry chain is ordered from the most immediate script (in the frame creation stack) to more distant ancestors (that created the immediately preceding script). Only sent if frame is labelled as an ad and ids are available.	[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	"type": STRING	App id, either from manifest's id attribute or computed from start_url	[OPTIONAL]
recommendedId	"type": STRING	Recommendation for manifest's id attribute to match current id computed from start_url	[OPTIONAL]

getAppManifest

Gets the processed manifest for this current document. This API always waits for the manifest to be loaded. If manifestId is provided, and it does not match the manifest of the current document, this API errors out. If there is not a loaded page, this API errors out immediately.

-

PARAMETERS:

Name	Type	Description	Flags
manifestId	"type": STRING	-	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
url	"type": STRING	Manifest location.	-
errors	"type": ARRAY "items": { "$ref": AppManifestError }	-	-
data	"type": STRING	Manifest content.	[OPTIONAL]
parsed	"$ref": AppManifestParsedProperties	Parsed manifest properties. Deprecated, use manifest instead.	[OPTIONAL] [EXPERIMENTAL] [DEPRECATED]
manifest	"$ref": WebAppManifest	-	[EXPERIMENTAL]

getFrameTree

Returns present frame tree structure.

-

RETURNS:

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

getInstallabilityErrors

-

[EXPERIMENTAL]

RETURNS:

Name	Type	Description	Flags
installabilityErrors	"type": ARRAY "items": { "$ref": InstallabilityError }	-	-

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. Is in device pixels. Use `cssLayoutViewport` instead.	[DEPRECATED]
visualViewport	"$ref": VisualViewport	Deprecated metrics relating to the visual viewport. Is in device pixels. Use `cssVisualViewport` instead.	[DEPRECATED]
contentSize	"$ref": DOM.Rect	Deprecated size of scrollable area. Is in DP. 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.	-

getManifestIcons

Deprecated because it's not guaranteed that the returned icon is in fact the one used for PWA installation.

[EXPERIMENTAL]
[DEPRECATED]

RETURNS:

Name	Type	Description	Flags
primaryIcon	"type": STRING	-	[OPTIONAL]

getNavigationHistory

Returns navigation history for the current page.

-

RETURNS:

Name	Type	Description	Flags
currentIndex	"type": INTEGER	Index of the current navigation history entry.	-
entries	"type": ARRAY "items": { "$ref": NavigationEntry }	Array of navigation history entries.	-

getOriginTrials

Get Origin Trials on given frame.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
frameId	"$ref": FrameId	-	-

RETURNS:

Name	Type	Description	Flags
originTrials	"type": ARRAY "items": { "$ref": OriginTrial }	-	-

getPermissionsPolicyState

Get Permissions Policy state on given frame.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
frameId	"$ref": FrameId	-	-

RETURNS:

Name	Type	Description	Flags
states	"type": ARRAY "items": { "$ref": PermissionsPolicyFeatureState }	-	-

getResourceContent

Returns content of the given resource.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
frameId	"$ref": FrameId	Frame id to get resource for.	-
url	"type": STRING	URL of the resource to get content for.	-

RETURNS:

Name	Type	Description	Flags
content	"type": STRING	Resource content.	-
base64Encoded	"type": 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	"type": BOOLEAN	Whether to accept or dismiss the dialog.	-
promptText	"type": 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	"type": STRING	URL to navigate the page to.	-
referrer	"type": 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. This is omitted in case of same-document navigation, as the previously committed loaderId would not change.	[OPTIONAL]
errorText	"type": STRING	User friendly error message, present if and only if navigation has failed.	[OPTIONAL]
isDownload	"type": BOOLEAN	Whether the navigation resulted in a download.	[OPTIONAL] [EXPERIMENTAL]

navigateToHistoryEntry

Navigates current page to the given history entry.

-

PARAMETERS:

Name	Type	Description	Flags
entryId	"type": INTEGER	Unique id of the entry to navigate to.	-

printToPDF

Print page as PDF.

-

PARAMETERS:

Name	Type	Description	Flags
landscape	"type": BOOLEAN	Paper orientation. Defaults to false.	[OPTIONAL]
displayHeaderFooter	"type": BOOLEAN	Display header and footer. Defaults to false.	[OPTIONAL]
printBackground	"type": BOOLEAN	Print background graphics. Defaults to false.	[OPTIONAL]
scale	"type": NUMBER	Scale of the webpage rendering. Defaults to 1.	[OPTIONAL]
paperWidth	"type": NUMBER	Paper width in inches. Defaults to 8.5 inches.	[OPTIONAL]
paperHeight	"type": NUMBER	Paper height in inches. Defaults to 11 inches.	[OPTIONAL]
marginTop	"type": NUMBER	Top margin in inches. Defaults to 1cm (~0.4 inches).	[OPTIONAL]
marginBottom	"type": NUMBER	Bottom margin in inches. Defaults to 1cm (~0.4 inches).	[OPTIONAL]
marginLeft	"type": NUMBER	Left margin in inches. Defaults to 1cm (~0.4 inches).	[OPTIONAL]
marginRight	"type": NUMBER	Right margin in inches. Defaults to 1cm (~0.4 inches).	[OPTIONAL]
pageRanges	"type": STRING	Paper ranges to print, one based, e.g., '1-5, 8, 11-13'. Pages are printed in the document order, not in the order specified, and no more than once. Defaults to empty string, which implies the entire document is printed. The page numbers are quietly capped to actual page count of the document, and ranges beyond the end of the document are ignored. If this results in no pages to print, an error is reported. It is an error to specify a range with start greater than end.	[OPTIONAL]
headerTemplate	"type": 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	"type": STRING	HTML template for the print footer. Should use the same format as the `headerTemplate`.	[OPTIONAL]
preferCSSPageSize	"type": 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 "type": STRING	return as stream	[OPTIONAL] [EXPERIMENTAL]
generateTaggedPDF	"type": BOOLEAN	Whether or not to generate tagged (accessible) PDF. Defaults to embedder choice.	[OPTIONAL] [EXPERIMENTAL]
generateDocumentOutline	"type": BOOLEAN	Whether or not to embed the document outline into the PDF.	[OPTIONAL] [EXPERIMENTAL]

RETURNS:

Name	Type	Description	Flags
data	"type": 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]

produceCompilationCache

Requests backend to produce compilation cache for the specified scripts. `scripts` are appended 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	"type": ARRAY "items": { "$ref": CompilationCacheParams }	-	-

reload

Reloads given page optionally ignoring the cache.

-

PARAMETERS:

Name	Type	Description	Flags
ignoreCache	"type": BOOLEAN	If true, browser cache is ignored (as if the user pressed Shift+refresh).	[OPTIONAL]
scriptToEvaluateOnLoad	"type": 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]
loaderId	"$ref": Network.LoaderId	If set, an error will be thrown if the target page's main frame's loader id does not match the provided id. This prevents accidentally reloading an unintended target in case there's a racing navigation.	[OPTIONAL] [EXPERIMENTAL]

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

resetNavigationHistory

Resets navigation history for the current page.

-

screencastFrameAck

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

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
sessionId	"type": 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	"type": STRING	URL of the resource to search in.	-
query	"type": STRING	String to search for.	-
caseSensitive	"type": BOOLEAN	If true, search is case sensitive.	[OPTIONAL]
isRegex	"type": BOOLEAN	If true, treats string parameter as regex.	[OPTIONAL]

RETURNS:

Name	Type	Description	Flags
result	"type": ARRAY "items": { "$ref": Debugger.SearchMatch }	List of search matches.	-

setAdBlockingEnabled

Enable Chrome's experimental ad filter on all sites.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
enabled	"type": BOOLEAN	Whether to block ads.	-

setBypassCSP

Enable page Content Security Policy by-passing.

-

PARAMETERS:

Name	Type	Description	Flags
enabled	"type": BOOLEAN	Whether to bypass page CSP.	-

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	"type": INTEGER	Overriding width value in pixels (minimum 0, maximum 10000000). 0 disables the override.	-
height	"type": INTEGER	Overriding height value in pixels (minimum 0, maximum 10000000). 0 disables the override.	-
deviceScaleFactor	"type": NUMBER	Overriding device scale factor value. 0 disables the override.	-
mobile	"type": BOOLEAN	Whether to emulate mobile device. This includes viewport meta tag, overlay scrollbars, text autosizing and more.	-
scale	"type": NUMBER	Scale to apply to resulting view image.	[OPTIONAL]
screenWidth	"type": INTEGER	Overriding screen width value in pixels (minimum 0, maximum 10000000).	[OPTIONAL]
screenHeight	"type": INTEGER	Overriding screen height value in pixels (minimum 0, maximum 10000000).	[OPTIONAL]
positionX	"type": INTEGER	Overriding view X position on screen in pixels (minimum 0, maximum 10000000).	[OPTIONAL]
positionY	"type": INTEGER	Overriding view Y position on screen in pixels (minimum 0, maximum 10000000).	[OPTIONAL]
dontSetVisibleSize	"type": 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	"type": NUMBER	Mock alpha	-
beta	"type": NUMBER	Mock beta	-
gamma	"type": NUMBER	Mock gamma	-

setDocumentContent

Sets given markup as the document's HTML.

-

PARAMETERS:

Name	Type	Description	Flags
frameId	"$ref": FrameId	Frame id to set HTML for.	-
html	"type": STRING	HTML content to set.	-

setDownloadBehavior

Set the behavior when downloading a file.

[EXPERIMENTAL]
[DEPRECATED]

PARAMETERS:

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

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.	-
forScripts	"type": ARRAY "items": { "$ref": ScriptFontFamilies }	Specifies font families to set for individual scripts.	[OPTIONAL]

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

setGeolocationOverride
REDIRECT: Emulation

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

[DEPRECATED]

PARAMETERS:

Name	Type	Description	Flags
latitude	"type": NUMBER	Mock latitude	[OPTIONAL]
longitude	"type": NUMBER	Mock longitude	[OPTIONAL]
accuracy	"type": NUMBER	Mock accuracy	[OPTIONAL]

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.

-

PARAMETERS:

Name	Type	Description	Flags
enabled	"type": BOOLEAN	-	-
cancel	"type": BOOLEAN	If true, cancels the dialog by emitting relevant events (if any) in addition to not showing it if the interception is enabled (default: false).	[OPTIONAL] [EXPERIMENTAL]

setLifecycleEventsEnabled

Controls whether page will emit lifecycle events.

-

PARAMETERS:

Name	Type	Description	Flags
enabled	"type": BOOLEAN	If true, starts emitting lifecycle events.	-

setPrerenderingAllowed

Enable/disable prerendering manually. This command is a short-term solution for https://crbug.com/1440085. See https://docs.google.com/document/d/12HVmFxYj5Jc-eJr5OmWsa2bqTJsbgGLKI6ZIyx0_wpA for more details. TODO(https://crbug.com/1440085): Remove this once Puppeteer supports tab targets.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
isAllowed	"type": BOOLEAN	-	-

setRPHRegistrationMode

Extensions for Custom Handlers API: https://html.spec.whatwg.org/multipage/system-state.html#rph-automation

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
mode	"autoAccept", "autoReject", "none"String [Hover] Enum "type": STRING	-	-

setSPCTransactionMode

Sets the Secure Payment Confirmation transaction mode. https://w3c.github.io/secure-payment-confirmation/#sctn-automation-set-spc-transaction-mode

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
mode	"autoAccept", "autoChooseToAuthAnotherWay", "autoOptOut", "autoReject", "none"String [Hover] Enum "type": STRING	-	-

setTouchEmulationEnabled
REDIRECT: Emulation

Toggles mouse event-based touch event emulation.

[EXPERIMENTAL]
[DEPRECATED]

PARAMETERS:

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

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	"active", "frozen"String [Hover] Enum "type": STRING	Target lifecycle state	-

startScreencast

Starts sending each frame using the `screencastFrame` event.

[EXPERIMENTAL]

PARAMETERS:

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

stopLoading

Force the page stop all navigations and pending resource fetches.

-

stopScreencast

Stops sending each frame in the `screencastFrame`.

[EXPERIMENTAL]

waitForDebugger

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

[EXPERIMENTAL]

EVENTS

Name

Description

Flags

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 navigation.	-
frameId	"$ref": FrameId	The frame id of the associated frame.	-
notRestoredExplanations	"type": ARRAY "items": { "$ref": BackForwardCacheNotRestoredExplanation }	Array of reasons why the page could not be cached. This must not be empty.	-
notRestoredExplanationsTree	"$ref": BackForwardCacheNotRestoredExplanationTree	Tree structure of reasons why the page could not be cached for each frame.	[OPTIONAL]

compilationCacheProduced

Issued for every compilation cache generated.

[EXPERIMENTAL]

PARAMETERS:

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

documentOpened

Fired when opening document to write to.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
frame	"$ref": Frame	Frame object.	-

domContentEventFired

-

PARAMETERS:

Name	Type	Description	Flags
timestamp	"$ref": Network.MonotonicTime	-	-

downloadProgress

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

[EXPERIMENTAL]
[DEPRECATED]

PARAMETERS:

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

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	"type": STRING	Global unique identifier of the download.	-
url	"type": STRING	URL of the resource being downloaded.	-
suggestedFilename	"type": STRING	Suggested file name of the resource (the actual name of the file saved on disk may differ).	-

fileChooserOpened

Emitted only when `page.interceptFileChooser` is enabled.

-

PARAMETERS:

Name	Type	Description	Flags
frameId	"$ref": FrameId	Id of the frame containing input node.	[EXPERIMENTAL]
mode	"selectMultiple", "selectSingle"String [Hover] Enum "type": STRING	Input mode.	-
backendNodeId	"$ref": DOM.BackendNodeId	Input node id. Only present for file choosers opened via an `<input type="file">` element.	[OPTIONAL] [EXPERIMENTAL]

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 "type": STRING	-	[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]

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	"type": STRING	The destination URL for the requested navigation.	-
disposition	"$ref": ClientNavigationDisposition	The disposition for the navigation.	-

frameResized

-

[EXPERIMENTAL]

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	"type": 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	"type": 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.	-

frameStartedNavigating

Fired when a navigation starts. This event is fired for both renderer-initiated and browser-initiated navigations. For renderer-initiated navigations, the event is fired after `frameRequestedNavigation`. Navigation may still be cancelled after the event is issued. Multiple events can be fired for a single navigation, for example, when a same-document navigation becomes a cross-document navigation (such as in the case of a frameset).

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
frameId	"$ref": FrameId	ID of the frame that is being navigated.	-
url	"type": STRING	The URL the navigation started with. The final URL can be different.	-
loaderId	"$ref": Network.LoaderId	Loader identifier. Even though it is present in case of same-document navigation, the previously committed loaderId would not change unless the navigation changes from a same-document to a cross-document navigation.	-
navigationType	"differentDocument", "historyDifferentDocument", "historySameDocument", "reload", "reloadBypassingCache", "restore", "restoreWithPost", "sameDocument"String [Hover] Enum "type": STRING	-	-

frameStoppedLoading

Fired when frame has stopped loading.

[EXPERIMENTAL]

PARAMETERS:

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

frameSubtreeWillBeDetached

Fired before frame subtree is detached. Emitted before any frame of the subtree is actually detached.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
frameId	"$ref": FrameId	Id of the frame that is the root of the subtree that will be detached.	-

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
frameId	"$ref": FrameId	Frame id.	[EXPERIMENTAL]
result	"type": BOOLEAN	Whether dialog was confirmed.	-
userInput	"type": 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	"type": STRING	Frame url.	-
frameId	"$ref": FrameId	Frame id.	[EXPERIMENTAL]
message	"type": STRING	Message that will be displayed by the dialog.	-
type	"$ref": DialogType	Dialog type.	-
hasBrowserHandler	"type": 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	"type": STRING	Default dialog prompt.	[OPTIONAL]

lifecycleEvent

Fired for lifecycle events (navigation, load, paint, etc) in the current target (including local frames).

-

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	"type": STRING	-	-
timestamp	"$ref": Network.MonotonicTime	-	-

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	"type": STRING	Frame's new url.	-
navigationType	"fragment", "historyApi", "other"String [Hover] Enum "type": STRING	Navigation type	-

screencastFrame

Compressed image data requested by the `startScreencast`.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
data	"type": STRING	Base64-encoded compressed image. (Encoded as a base64 string when passed over JSON)	-
metadata	"$ref": ScreencastFrameMetadata	Screencast frame metadata.	-
sessionId	"type": INTEGER	Frame number.	-

screencastVisibilityChanged

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

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
visible	"type": 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	"type": STRING	The URL for the new window.	-
windowName	"type": STRING	Window name.	-
windowFeatures	"type": ARRAY "items": { "type": STRING }	An array of enabled window features.	-
userGesture	"type": BOOLEAN	Whether or not it was triggered by user gesture.	-

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	"type": NUMBER	The number of pixels being painted.	-
elementId	"type": STRING	The id attribute of the element, if available.	[OPTIONAL]
url	"type": STRING	The URL of the image (may be trimmed).	[OPTIONAL]
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	"type": NUMBER	Score increment produced by this event.	-
hadRecentInput	"type": BOOLEAN	-	-
lastInputTime	"$ref": Network.TimeSinceEpoch	-	-
sources	"type": ARRAY "items": { "$ref": LayoutShiftAttribution }	-	-

LayoutShiftAttribution

OBJECT

-

PROPERTIES:

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

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	"type": STRING	The event type, as specified in https://w3c.github.io/performance-timeline/#dom-performanceentry-entrytype This determines which of the optional "details" fields is present.	-
name	"type": STRING	Name may be empty depending on the type.	-
time	"$ref": Network.TimeSinceEpoch	Time in seconds since Epoch, monotonically increasing within document lifetime.	-
duration	"type": NUMBER	Event duration, if applicable.	[OPTIONAL]
lcpDetails	"$ref": LargestContentfulPaint	-	[OPTIONAL]
layoutShiftDetails	"$ref": LayoutShift	-	[OPTIONAL]

Preload

[Experimental]

-

TYPES

Type ID

Type

Description

Flags

PrefetchStatus

TODO(https://crbug.com/1384419): revisit the list of PrefetchStatus and filter out the ones that aren't necessary to the developers.

-

PreloadPipelineId

STRING

Chrome manages different types of preloads together using a concept of preloading pipeline. For example, if a site uses a SpeculationRules for prerender, Chrome first starts a prefetch and then upgrades it to prerender. CDP events for them are emitted separately but they share `PreloadPipelineId`.

-

PreloadingAttemptKey

OBJECT

A key that identifies a preloading attempt. The url used is the url specified by the trigger (i.e. the initial URL), and not the final url that is navigated to. For example, prerendering allows same-origin main frame navigations during the attempt, but the attempt is still keyed with the initial URL.

-

PROPERTIES:

Name	Type	Description	Flags
loaderId	"$ref": Network.LoaderId	-	-
action	"$ref": SpeculationAction	-	-
url	"type": STRING	-	-
targetHint	"$ref": SpeculationTargetHint	-	[OPTIONAL]

PreloadingAttemptSource

OBJECT

Lists sources for a preloading attempt, specifically the ids of rule sets that had a speculation rule that triggered the attempt, and the BackendNodeIds of {@code <a href> or <area href>} elements that triggered the attempt (in the case of attempts triggered by a document rule). It is possible for multiple rule sets and links to trigger a single attempt.

-

PROPERTIES:

Name	Type	Description	Flags
key	"$ref": PreloadingAttemptKey	-	-
ruleSetIds	"type": ARRAY "items": { "$ref": RuleSetId }	-	-
nodeIds	"type": ARRAY "items": { "$ref": DOM.BackendNodeId }	-	-

PreloadingStatus

Preloading status values, see also PreloadingTriggeringOutcome. This status is shared by prefetchStatusUpdated and prerenderStatusUpdated.

-

PrerenderFinalStatus

List of FinalStatus reasons for Prerender2.

-

PrerenderMismatchedHeaders

OBJECT

Information of headers to be displayed when the header mismatch occurred.

-

PROPERTIES:

Name	Type	Description	Flags
headerName	"type": STRING	-	-
initialValue	"type": STRING	-	[OPTIONAL]
activationValue	"type": STRING	-	[OPTIONAL]

RuleSet

OBJECT

Corresponds to SpeculationRuleSet

-

PROPERTIES:

Name	Type	Description	Flags
id	"$ref": RuleSetId	-	-
loaderId	"$ref": Network.LoaderId	Identifies a document which the rule set is associated with.	-
sourceText	"type": STRING	Source text of JSON representing the rule set. If it comes from `{@code <script>}` tag, it is the textContent of the node. Note that it is a JSON for valid case. See also: - https://wicg.github.io/nav-speculation/speculation-rules.html - https://github.com/WICG/nav-speculation/blob/main/triggers.md	-
backendNodeId	"$ref": DOM.BackendNodeId	A speculation rule set is either added through an inline `{@code <script>}` tag or through an external resource via the 'Speculation-Rules' HTTP header. For the first case, we include the BackendNodeId of the relevant `{@code <script>}` tag. For the second case, we include the external URL where the rule set was loaded from, and also RequestId if Network domain is enabled. See also: - https://wicg.github.io/nav-speculation/speculation-rules.html#speculation-rules-script - https://wicg.github.io/nav-speculation/speculation-rules.html#speculation-rules-header	[OPTIONAL]
url	"type": STRING	-	[OPTIONAL]
requestId	"$ref": Network.RequestId	-	[OPTIONAL]
errorType	"$ref": RuleSetErrorType	Error information `errorMessage` is null iff `errorType` is null.	[OPTIONAL]
errorMessage	"type": STRING	TODO(https://crbug.com/1425354): Replace this property with structured error.	[OPTIONAL] [DEPRECATED]

RuleSetErrorType

-

RuleSetId

STRING

Unique id

-

SpeculationAction

The type of preloading attempted. It corresponds to mojom::SpeculationAction (although PrefetchWithSubresources is omitted as it isn't being used by clients).

-

SpeculationTargetHint

Corresponds to mojom::SpeculationTargetHint. See https://github.com/WICG/nav-speculation/blob/main/triggers.md#window-name-targeting-hints

-

EVENTS

Name

Description

Flags

prefetchStatusUpdated

Fired when a prefetch attempt is updated.

-

PARAMETERS:

Name	Type	Description	Flags
key	"$ref": PreloadingAttemptKey	-	-
pipelineId	"$ref": PreloadPipelineId	-	-
initiatingFrameId	"$ref": Page.FrameId	The frame id of the frame initiating prefetch.	-
prefetchUrl	"type": STRING	-	-
status	"$ref": PreloadingStatus	-	-
prefetchStatus	"$ref": PrefetchStatus	-	-
requestId	"$ref": Network.RequestId	-	-

preloadEnabledStateUpdated

Fired when a preload enabled state is updated.

-

PARAMETERS:

Name	Type	Description	Flags
disabledByPreference	"type": BOOLEAN	-	-
disabledByDataSaver	"type": BOOLEAN	-	-
disabledByBatterySaver	"type": BOOLEAN	-	-
disabledByHoldbackPrefetchSpeculationRules	"type": BOOLEAN	-	-
disabledByHoldbackPrerenderSpeculationRules	"type": BOOLEAN	-	-

preloadingAttemptSourcesUpdated

Send a list of sources for all preloading attempts in a document.

-

PARAMETERS:

Name	Type	Description	Flags
loaderId	"$ref": Network.LoaderId	-	-
preloadingAttemptSources	"type": ARRAY "items": { "$ref": PreloadingAttemptSource }	-	-

prerenderStatusUpdated

Fired when a prerender attempt is updated.

-

PARAMETERS:

Name	Type	Description	Flags
key	"$ref": PreloadingAttemptKey	-	-
pipelineId	"$ref": PreloadPipelineId	-	-
status	"$ref": PreloadingStatus	-	-
prerenderStatus	"$ref": PrerenderFinalStatus	-	[OPTIONAL]
disallowedMojoInterface	"type": STRING	This is used to give users more information about the name of Mojo interface that is incompatible with prerender and has caused the cancellation of the attempt.	[OPTIONAL]
mismatchedHeaders	"type": ARRAY "items": { "$ref": PrerenderMismatchedHeaders }	-	[OPTIONAL]

ruleSetRemoved

-

PARAMETERS:

Name	Type	Description	Flags
id	"$ref": RuleSetId	-	-

ruleSetUpdated

Upsert. Currently, it is only emitted when a rule set added.

-

PARAMETERS:

Name	Type	Description	Flags
ruleSet	"$ref": RuleSet	-	-

Security

TYPES

Type ID

Type

Description

Flags

CertificateErrorAction

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

-

CertificateId

INTEGER

An internal certificate ID value.

-

CertificateSecurityState

OBJECT

Details about the security state of the page certificate.

[EXPERIMENTAL]

PROPERTIES:

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

InsecureContentStatus

OBJECT

Information about insecure content on the page.

[DEPRECATED]

PROPERTIES:

Name	Type	Description	Flags
ranMixedContent	"type": BOOLEAN	Always false.	-
displayedMixedContent	"type": BOOLEAN	Always false.	-
containedMixedForm	"type": BOOLEAN	Always false.	-
ranContentWithCertErrors	"type": BOOLEAN	Always false.	-
displayedContentWithCertErrors	"type": BOOLEAN	Always false.	-
ranInsecureContentStyle	"$ref": SecurityState	Always set to unknown.	-
displayedInsecureContentStyle	"$ref": SecurityState	Always set to unknown.	-

MixedContentType

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

-

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	"type": STRING	The URL the safety tip suggested ("Did you mean?"). Only filled in for lookalike matches.	[OPTIONAL]

SafetyTipStatus

-

[EXPERIMENTAL]

SecurityState

The security level of a page or resource.

-

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	"type": STRING	Title describing the type of factor.	-
summary	"type": STRING	Short phrase describing the type of factor.	-
description	"type": STRING	Full text explanation of the factor.	-
mixedContentType	"$ref": MixedContentType	The type of mixed content described by the explanation.	-
certificate	"type": ARRAY "items": { "type": STRING }	Page certificate.	-
recommendations	"type": ARRAY "items": { "type": STRING }	Recommendations to fix any issues.	[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	"type": ARRAY "items": { "type": STRING }	Array of security state issues ids.	-

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	"type": INTEGER	The ID of the event.	-
errorType	"type": STRING	The type of the error.	-
requestURL	"type": STRING	The url that was requested.	-

securityStateChanged

The security state of the page changed. No longer being sent.

[DEPRECATED]

PARAMETERS:

Name	Type	Description	Flags
securityState	"$ref": SecurityState	Security state.	-
schemeIsCryptographic	"type": BOOLEAN	True if the page was loaded over cryptographic transport such as HTTPS.	[DEPRECATED]
explanations	"type": ARRAY "items": { "$ref": SecurityStateExplanation }	Previously a list of explanations for the security state. Now always empty.	[DEPRECATED]
insecureContentStatus	"$ref": InsecureContentStatus	Information about insecure content on the page.	[DEPRECATED]
summary	"type": STRING	Overrides user-visible description of the state. Always omitted.	[OPTIONAL] [DEPRECATED]

visibleSecurityStateChanged

The security state of the page changed.

[EXPERIMENTAL]

PARAMETERS:

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

ServiceWorker

[Experimental]

-

Dependencies: Target

TYPES

Type ID

Type

Description

Flags

RegistrationID

STRING

-

ServiceWorkerErrorMessage

OBJECT

ServiceWorker error message.

-

PROPERTIES:

Name	Type	Description	Flags
errorMessage	"type": STRING	-	-
registrationId	"$ref": RegistrationID	-	-
versionId	"type": STRING	-	-
sourceURL	"type": STRING	-	-
lineNumber	"type": INTEGER	-	-
columnNumber	"type": INTEGER	-	-

ServiceWorkerRegistration

OBJECT

ServiceWorker registration.

-

PROPERTIES:

Name	Type	Description	Flags
registrationId	"$ref": RegistrationID	-	-
scopeURL	"type": STRING	-	-
isDeleted	"type": BOOLEAN	-	-

ServiceWorkerVersion

OBJECT

ServiceWorker version.

-

PROPERTIES:

Name	Type	Description	Flags
versionId	"type": STRING	-	-
registrationId	"$ref": RegistrationID	-	-
scriptURL	"type": STRING	-	-
runningStatus	"$ref": ServiceWorkerVersionRunningStatus	-	-
status	"$ref": ServiceWorkerVersionStatus	-	-
scriptLastModified	"type": NUMBER	The Last-Modified header value of the main script.	[OPTIONAL]
scriptResponseTime	"type": 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	"type": ARRAY "items": { "$ref": Target.TargetID }	-	[OPTIONAL]
targetId	"$ref": Target.TargetID	-	[OPTIONAL]
routerRules	"type": STRING	-	[OPTIONAL]

ServiceWorkerVersionRunningStatus

-

ServiceWorkerVersionStatus

-

COMMANDS

Name

Description

Flags

deliverPushMessage

-

PARAMETERS:

Name	Type	Description	Flags
origin	"type": STRING	-	-
registrationId	"$ref": RegistrationID	-	-
data	"type": STRING	-	-

disable

-

dispatchPeriodicSyncEvent

-

PARAMETERS:

Name	Type	Description	Flags
origin	"type": STRING	-	-
registrationId	"$ref": RegistrationID	-	-
tag	"type": STRING	-	-

dispatchSyncEvent

-

PARAMETERS:

Name	Type	Description	Flags
origin	"type": STRING	-	-
registrationId	"$ref": RegistrationID	-	-
tag	"type": STRING	-	-
lastChance	"type": BOOLEAN	-	-

enable

-

setForceUpdateOnPageLoad

-

PARAMETERS:

Name	Type	Description	Flags
forceUpdateOnPageLoad	"type": BOOLEAN	-	-

skipWaiting

-

PARAMETERS:

Name	Type	Description	Flags
scopeURL	"type": STRING	-	-

startWorker

-

PARAMETERS:

Name	Type	Description	Flags
scopeURL	"type": STRING	-	-

stopAllWorkers

-

stopWorker

-

PARAMETERS:

Name	Type	Description	Flags
versionId	"type": STRING	-	-

unregister

-

PARAMETERS:

Name	Type	Description	Flags
scopeURL	"type": STRING	-	-

updateRegistration

-

PARAMETERS:

Name	Type	Description	Flags
scopeURL	"type": STRING	-	-

Storage

[Experimental]

-

Dependencies: Browser, Network

TYPES

Type ID

Type

Description

Flags

AttributionReportingAggregatableDebugReportingConfig

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
budget	"type": NUMBER	number instead of integer because not all uint32 can be represented by int, only present for source registrations	[OPTIONAL]
keyPiece	"$ref": UnsignedInt128AsBase16	-	-
debugData	"type": ARRAY "items": { "$ref": AttributionReportingAggregatableDebugReportingData }	-	-
aggregationCoordinatorOrigin	"type": STRING	-	[OPTIONAL]

AttributionReportingAggregatableDebugReportingData

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
keyPiece	"$ref": UnsignedInt128AsBase16	-	-
value	"type": NUMBER	number instead of integer because not all uint32 can be represented by int	-
types	"type": ARRAY "items": { "type": STRING }	-	-

AttributionReportingAggregatableDedupKey

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
dedupKey	"$ref": UnsignedInt64AsBase10	-	[OPTIONAL]
filters	"$ref": AttributionReportingFilterPair	-	-

AttributionReportingAggregatableResult

-

[EXPERIMENTAL]

AttributionReportingAggregatableTriggerData

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
keyPiece	"$ref": UnsignedInt128AsBase16	-	-
sourceKeys	"type": ARRAY "items": { "type": STRING }	-	-
filters	"$ref": AttributionReportingFilterPair	-	-

AttributionReportingAggregatableValueDictEntry

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
key	"type": STRING	-	-
value	"type": NUMBER	number instead of integer because not all uint32 can be represented by int	-
filteringId	"$ref": UnsignedInt64AsBase10	-	-

AttributionReportingAggregatableValueEntry

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
values	"type": ARRAY "items": { "$ref": AttributionReportingAggregatableValueDictEntry }	-	-
filters	"$ref": AttributionReportingFilterPair	-	-

AttributionReportingAggregationKeysEntry

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
key	"type": STRING	-	-
value	"$ref": UnsignedInt128AsBase16	-	-

AttributionReportingEventLevelResult

-

[EXPERIMENTAL]

AttributionReportingEventReportWindows

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
start	"type": INTEGER	duration in seconds	-
ends	"type": ARRAY "items": { "type": INTEGER }	duration in seconds	-

AttributionReportingEventTriggerData

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
data	"$ref": UnsignedInt64AsBase10	-	-
priority	"$ref": SignedInt64AsBase10	-	-
dedupKey	"$ref": UnsignedInt64AsBase10	-	[OPTIONAL]
filters	"$ref": AttributionReportingFilterPair	-	-

AttributionReportingFilterConfig

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
filterValues	"type": ARRAY "items": { "$ref": AttributionReportingFilterDataEntry }	-	-
lookbackWindow	"type": INTEGER	duration in seconds	[OPTIONAL]

AttributionReportingFilterDataEntry

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
key	"type": STRING	-	-
values	"type": ARRAY "items": { "type": STRING }	-	-

AttributionReportingFilterPair

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
filters	"type": ARRAY "items": { "$ref": AttributionReportingFilterConfig }	-	-
notFilters	"type": ARRAY "items": { "$ref": AttributionReportingFilterConfig }	-	-

AttributionReportingNamedBudgetCandidate

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
name	"type": STRING	-	[OPTIONAL]
filters	"$ref": AttributionReportingFilterPair	-	-

AttributionReportingNamedBudgetDef

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
name	"type": STRING	-	-
budget	"type": INTEGER	-	-

AttributionReportingReportResult

-

[EXPERIMENTAL]

AttributionReportingSourceRegistration

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
time	"$ref": Network.TimeSinceEpoch	-	-
expiry	"type": INTEGER	duration in seconds	-
triggerData	"type": ARRAY "items": { "type": NUMBER }	number instead of integer because not all uint32 can be represented by int	-
eventReportWindows	"$ref": AttributionReportingEventReportWindows	-	-
aggregatableReportWindow	"type": INTEGER	duration in seconds	-
type	"$ref": AttributionReportingSourceType	-	-
sourceOrigin	"type": STRING	-	-
reportingOrigin	"type": STRING	-	-
destinationSites	"type": ARRAY "items": { "type": STRING }	-	-
eventId	"$ref": UnsignedInt64AsBase10	-	-
priority	"$ref": SignedInt64AsBase10	-	-
filterData	"type": ARRAY "items": { "$ref": AttributionReportingFilterDataEntry }	-	-
aggregationKeys	"type": ARRAY "items": { "$ref": AttributionReportingAggregationKeysEntry }	-	-
debugKey	"$ref": UnsignedInt64AsBase10	-	[OPTIONAL]
triggerDataMatching	"$ref": AttributionReportingTriggerDataMatching	-	-
destinationLimitPriority	"$ref": SignedInt64AsBase10	-	-
aggregatableDebugReportingConfig	"$ref": AttributionReportingAggregatableDebugReportingConfig	-	-
scopesData	"$ref": AttributionScopesData	-	[OPTIONAL]
maxEventLevelReports	"type": INTEGER	-	-
namedBudgets	"type": ARRAY "items": { "$ref": AttributionReportingNamedBudgetDef }	-	-
debugReporting	"type": BOOLEAN	-	-
eventLevelEpsilon	"type": NUMBER	-	-

AttributionReportingSourceRegistrationResult

-

[EXPERIMENTAL]

AttributionReportingSourceRegistrationTimeConfig

-

[EXPERIMENTAL]

AttributionReportingSourceType

-

[EXPERIMENTAL]

AttributionReportingTriggerDataMatching

-

[EXPERIMENTAL]

AttributionReportingTriggerRegistration

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
filters	"$ref": AttributionReportingFilterPair	-	-
debugKey	"$ref": UnsignedInt64AsBase10	-	[OPTIONAL]
aggregatableDedupKeys	"type": ARRAY "items": { "$ref": AttributionReportingAggregatableDedupKey }	-	-
eventTriggerData	"type": ARRAY "items": { "$ref": AttributionReportingEventTriggerData }	-	-
aggregatableTriggerData	"type": ARRAY "items": { "$ref": AttributionReportingAggregatableTriggerData }	-	-
aggregatableValues	"type": ARRAY "items": { "$ref": AttributionReportingAggregatableValueEntry }	-	-
aggregatableFilteringIdMaxBytes	"type": INTEGER	-	-
debugReporting	"type": BOOLEAN	-	-
aggregationCoordinatorOrigin	"type": STRING	-	[OPTIONAL]
sourceRegistrationTimeConfig	"$ref": AttributionReportingSourceRegistrationTimeConfig	-	-
triggerContextId	"type": STRING	-	[OPTIONAL]
aggregatableDebugReportingConfig	"$ref": AttributionReportingAggregatableDebugReportingConfig	-	-
scopes	"type": ARRAY "items": { "type": STRING }	-	-
namedBudgets	"type": ARRAY "items": { "$ref": AttributionReportingNamedBudgetCandidate }	-	-

AttributionScopesData

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
values	"type": ARRAY "items": { "type": STRING }	-	-
limit	"type": NUMBER	number instead of integer because not all uint32 can be represented by int	-
maxEventStates	"type": NUMBER	-	-

InterestGroupAccessType

Enum of interest group access types.

-

InterestGroupAuctionEventType

Enum of auction events.

-

InterestGroupAuctionFetchType

Enum of network fetches auctions can do.

-

InterestGroupAuctionId

STRING

Protected audience interest group auction identifier.

-

RelatedWebsiteSet

OBJECT

A single Related Website Set object.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
primarySites	"type": ARRAY "items": { "type": STRING }	The primary site of this set, along with the ccTLDs if there is any.	-
associatedSites	"type": ARRAY "items": { "type": STRING }	The associated sites of this set, along with the ccTLDs if there is any.	-
serviceSites	"type": ARRAY "items": { "type": STRING }	The service sites of this set, along with the ccTLDs if there is any.	-

SerializedStorageKey

STRING

-

SharedStorageAccessMethod

Enum of shared storage access methods.

-

SharedStorageAccessParams

OBJECT

Bundles the parameters for shared storage access events whose presence/absence can vary according to SharedStorageAccessType.

-

PROPERTIES:

Name	Type	Description	Flags
scriptSourceUrl	"type": STRING	Spec of the module script URL. Present only for SharedStorageAccessMethods: addModule and createWorklet.	[OPTIONAL]
dataOrigin	"type": STRING	String denoting "context-origin", "script-origin", or a custom origin to be used as the worklet's data origin. Present only for SharedStorageAccessMethod: createWorklet.	[OPTIONAL]
operationName	"type": STRING	Name of the registered operation to be run. Present only for SharedStorageAccessMethods: run and selectURL.	[OPTIONAL]
operationId	"type": STRING	ID of the operation call. Present only for SharedStorageAccessMethods: run and selectURL.	[OPTIONAL]
keepAlive	"type": BOOLEAN	Whether or not to keep the worket alive for future run or selectURL calls. Present only for SharedStorageAccessMethods: run and selectURL.	[OPTIONAL]
privateAggregationConfig	"$ref": SharedStoragePrivateAggregationConfig	Configures the private aggregation options. Present only for SharedStorageAccessMethods: run and selectURL.	[OPTIONAL]
serializedData	"type": STRING	The operation's serialized data in bytes (converted to a string). Present only for SharedStorageAccessMethods: run and selectURL. TODO(crbug.com/401011862): Consider updating this parameter to binary.	[OPTIONAL]
urlsWithMetadata	"type": ARRAY "items": { "$ref": SharedStorageUrlWithMetadata }	Array of candidate URLs' specs, along with any associated metadata. Present only for SharedStorageAccessMethod: selectURL.	[OPTIONAL]
urnUuid	"type": STRING	Spec of the URN:UUID generated for a selectURL call. Present only for SharedStorageAccessMethod: selectURL.	[OPTIONAL]
key	"type": STRING	Key for a specific entry in an origin's shared storage. Present only for SharedStorageAccessMethods: set, append, delete, and get.	[OPTIONAL]
value	"type": STRING	Value for a specific entry in an origin's shared storage. Present only for SharedStorageAccessMethods: set and append.	[OPTIONAL]
ignoreIfPresent	"type": BOOLEAN	Whether or not to set an entry for a key if that key is already present. Present only for SharedStorageAccessMethod: set.	[OPTIONAL]
workletOrdinal	"type": INTEGER	A number denoting the (0-based) order of the worklet's creation relative to all other shared storage worklets created by documents using the current storage partition. Present only for SharedStorageAccessMethods: addModule, createWorklet.	[OPTIONAL]
workletTargetId	"$ref": Target.TargetID	Hex representation of the DevTools token used as the TargetID for the associated shared storage worklet. Present only for SharedStorageAccessMethods: addModule, createWorklet, run, selectURL, and any other SharedStorageAccessMethod when the SharedStorageAccessScope is sharedStorageWorklet.	[OPTIONAL]
withLock	"type": STRING	Name of the lock to be acquired, if present. Optionally present only for SharedStorageAccessMethods: batchUpdate, set, append, delete, and clear.	[OPTIONAL]
batchUpdateId	"type": STRING	If the method has been called as part of a batchUpdate, then this number identifies the batch to which it belongs. Optionally present only for SharedStorageAccessMethods: batchUpdate (required), set, append, delete, and clear.	[OPTIONAL]
batchSize	"type": INTEGER	Number of modifier methods sent in batch. Present only for SharedStorageAccessMethod: batchUpdate.	[OPTIONAL]

SharedStorageAccessScope

Enum of shared storage access scopes.

-

SharedStorageEntry

OBJECT

Struct for a single key-value pair in an origin's shared storage.

-

PROPERTIES:

Name	Type	Description	Flags
key	"type": STRING	-	-
value	"type": STRING	-	-

SharedStorageMetadata

OBJECT

Details for an origin's shared storage.

-

PROPERTIES:

Name	Type	Description	Flags
creationTime	"$ref": Network.TimeSinceEpoch	Time when the origin's shared storage was last created.	-
length	"type": INTEGER	Number of key-value pairs stored in origin's shared storage.	-
remainingBudget	"type": NUMBER	Current amount of bits of entropy remaining in the navigation budget.	-
bytesUsed	"type": INTEGER	Total number of bytes stored as key-value pairs in origin's shared storage.	-

SharedStoragePrivateAggregationConfig

OBJECT

Represents a dictionary object passed in as privateAggregationConfig to run or selectURL.

-

PROPERTIES:

Name	Type	Description	Flags
aggregationCoordinatorOrigin	"type": STRING	The chosen aggregation service deployment.	[OPTIONAL]
contextId	"type": STRING	The context ID provided.	[OPTIONAL]
filteringIdMaxBytes	"type": INTEGER	Configures the maximum size allowed for filtering IDs.	-
maxContributions	"type": INTEGER	The limit on the number of contributions in the final report.	[OPTIONAL]

SharedStorageReportingMetadata

OBJECT

Pair of reporting metadata details for a candidate URL for `selectURL()`.

-

PROPERTIES:

Name	Type	Description	Flags
eventType	"type": STRING	-	-
reportingUrl	"type": STRING	-	-

SharedStorageUrlWithMetadata

OBJECT

Bundles a candidate URL with its reporting metadata.

-

PROPERTIES:

Name	Type	Description	Flags
url	"type": STRING	Spec of candidate URL.	-
reportingMetadata	"type": ARRAY "items": { "$ref": SharedStorageReportingMetadata }	Any associated reporting metadata.	-

SignedInt64AsBase10

STRING

-

[EXPERIMENTAL]

StorageBucket

OBJECT

-

PROPERTIES:

Name	Type	Description	Flags
storageKey	"$ref": SerializedStorageKey	-	-
name	"type": STRING	If not specified, it is the default bucket of the storageKey.	[OPTIONAL]

StorageBucketInfo

OBJECT

-

PROPERTIES:

Name	Type	Description	Flags
bucket	"$ref": StorageBucket	-	-
id	"type": STRING	-	-
expiration	"$ref": Network.TimeSinceEpoch	-	-
quota	"type": NUMBER	Storage quota (bytes).	-
persistent	"type": BOOLEAN	-	-
durability	"$ref": StorageBucketsDurability	-	-

StorageBucketsDurability

-

StorageType

Enum of possible storage types.

-

TrustTokens

OBJECT

Pair of issuer origin and number of available (signed, but not used) Trust Tokens from that issuer.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
issuerOrigin	"type": STRING	-	-
count	"type": NUMBER	-	-

UnsignedInt128AsBase16

STRING

-

[EXPERIMENTAL]

UnsignedInt64AsBase10

STRING

-

[EXPERIMENTAL]

UsageForType

OBJECT

Usage for a storage type.

-

PROPERTIES:

Name	Type	Description	Flags
storageType	"$ref": StorageType	Name of storage type.	-
usage	"type": NUMBER	Storage usage (bytes).	-

COMMANDS

Name

Description

Flags

clearCookies

Clears cookies.

-

PARAMETERS:

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

clearDataForOrigin

Clears storage for origin.

-

PARAMETERS:

Name	Type	Description	Flags
origin	"type": STRING	Security origin.	-
storageTypes	"type": STRING	Comma separated list of StorageType to clear.	-

clearDataForStorageKey

Clears storage for storage key.

-

PARAMETERS:

Name	Type	Description	Flags
storageKey	"type": STRING	Storage key.	-
storageTypes	"type": STRING	Comma separated list of StorageType to clear.	-

clearSharedStorageEntries

Clears all entries for a given origin's shared storage.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
ownerOrigin	"type": STRING	-	-

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	"type": STRING	-	-

RETURNS:

Name	Type	Description	Flags
didDeleteTokens	"type": BOOLEAN	True if any tokens were deleted, false otherwise.	-

deleteSharedStorageEntry

Deletes entry for `key` (if it exists) for a given origin's shared storage.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
ownerOrigin	"type": STRING	-	-
key	"type": STRING	-	-

deleteStorageBucket

Deletes the Storage Bucket with the given storage key and bucket name.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
bucket	"$ref": StorageBucket	-	-

getAffectedUrlsForThirdPartyCookieMetadata

Returns the list of URLs from a page and its embedded resources that match existing grace period URL pattern rules. https://developers.google.com/privacy-sandbox/cookies/temporary-exceptions/grace-period

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
firstPartyUrl	"type": STRING	The URL of the page currently being visited.	-
thirdPartyUrls	"type": ARRAY "items": { "type": STRING }	The list of embedded resource URLs from the page.	-

RETURNS:

Name	Type	Description	Flags
matchedUrls	"type": ARRAY "items": { "type": STRING }	Array of matching URLs. If there is a primary pattern match for the first- party URL, only the first-party URL is returned in the array.	-

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	"type": ARRAY "items": { "$ref": Network.Cookie }	Array of cookie objects.	-

getInterestGroupDetails

Gets details for a named interest group.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
ownerOrigin	"type": STRING	-	-
name	"type": STRING	-	-

RETURNS:

Name	Type	Description	Flags
details	"type": OBJECT	This largely corresponds to: https://wicg.github.io/turtledove/#dictdef-generatebidinterestgroup but has absolute expirationTime instead of relative lifetimeMs and also adds joiningOrigin.	-

getRelatedWebsiteSets

Returns the effective Related Website Sets in use by this profile for the browser session. The effective Related Website Sets will not change during a browser session.

[EXPERIMENTAL]

RETURNS:

Name	Type	Description	Flags
sets	"type": ARRAY "items": { "$ref": RelatedWebsiteSet }	-	-

getSharedStorageEntries

Gets the entries in an given origin's shared storage.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
ownerOrigin	"type": STRING	-	-

RETURNS:

Name	Type	Description	Flags
entries	"type": ARRAY "items": { "$ref": SharedStorageEntry }	-	-

getSharedStorageMetadata

Gets metadata for an origin's shared storage.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
ownerOrigin	"type": STRING	-	-

RETURNS:

Name	Type	Description	Flags
metadata	"$ref": SharedStorageMetadata	-	-

getStorageKeyForFrame

Returns a storage key given a frame id.

-

PARAMETERS:

Name	Type	Description	Flags
frameId	"$ref": Page.FrameId	-	-

RETURNS:

Name	Type	Description	Flags
storageKey	"$ref": SerializedStorageKey	-	-

getTrustTokens

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

[EXPERIMENTAL]

RETURNS:

Name	Type	Description	Flags
tokens	"type": ARRAY "items": { "$ref": TrustTokens }	-	-

getUsageAndQuota

Returns usage and quota in bytes.

-

PARAMETERS:

Name	Type	Description	Flags
origin	"type": STRING	Security origin.	-

RETURNS:

Name	Type	Description	Flags
usage	"type": NUMBER	Storage usage (bytes).	-
quota	"type": NUMBER	Storage quota (bytes).	-
overrideActive	"type": BOOLEAN	Whether or not the origin has an active storage quota override	-
usageBreakdown	"type": ARRAY "items": { "$ref": UsageForType }	Storage usage per type (bytes).	-

overrideQuotaForOrigin

Override quota for the specified origin

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
origin	"type": STRING	Security origin.	-
quotaSize	"type": 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]

resetSharedStorageBudget

Resets the budget for `ownerOrigin` by clearing all budget withdrawals.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
ownerOrigin	"type": STRING	-	-

runBounceTrackingMitigations

Deletes state for sites identified as potential bounce trackers, immediately.

[EXPERIMENTAL]

RETURNS:

Name	Type	Description	Flags
deletedSites	"type": ARRAY "items": { "type": STRING }	-	-

sendPendingAttributionReports

Sends all pending Attribution Reports immediately, regardless of their scheduled report time.

[EXPERIMENTAL]

RETURNS:

Name	Type	Description	Flags
numSent	"type": INTEGER	The number of reports that were sent.	-

setAttributionReportingLocalTestingMode

https://wicg.github.io/attribution-reporting-api/

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
enabled	"type": BOOLEAN	If enabled, noise is suppressed and reports are sent immediately.	-

setAttributionReportingTracking

Enables/disables issuing of Attribution Reporting events.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
enable	"type": BOOLEAN	-	-

setCookies

Sets given cookies.

-

PARAMETERS:

Name	Type	Description	Flags
cookies	"type": ARRAY "items": { "$ref": Network.CookieParam }	Cookies to be set.	-
browserContextId	"$ref": Browser.BrowserContextID	Browser context to use when called on the browser endpoint.	[OPTIONAL]

setInterestGroupAuctionTracking

Enables/Disables issuing of interestGroupAuctionEventOccurred and interestGroupAuctionNetworkRequestCreated.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
enable	"type": BOOLEAN	-	-

setInterestGroupTracking

Enables/Disables issuing of interestGroupAccessed events.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
enable	"type": BOOLEAN	-	-

setProtectedAudienceKAnonymity

-

PARAMETERS:

Name	Type	Description	Flags
owner	"type": STRING	-	-
name	"type": STRING	-	-
hashes	"type": ARRAY "items": { "type": STRING }	-	-

setSharedStorageEntry

Sets entry with `key` and `value` for a given origin's shared storage.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
ownerOrigin	"type": STRING	-	-
key	"type": STRING	-	-
value	"type": STRING	-	-
ignoreIfPresent	"type": BOOLEAN	If `ignoreIfPresent` is included and true, then only sets the entry if `key` doesn't already exist.	[OPTIONAL]

setSharedStorageTracking

Enables/disables issuing of sharedStorageAccessed events.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
enable	"type": BOOLEAN	-	-

setStorageBucketTracking

Set tracking for a storage key's buckets.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
storageKey	"type": STRING	-	-
enable	"type": BOOLEAN	-	-

trackCacheStorageForOrigin

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

-

PARAMETERS:

Name	Type	Description	Flags
origin	"type": STRING	Security origin.	-

trackCacheStorageForStorageKey

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

-

PARAMETERS:

Name	Type	Description	Flags
storageKey	"type": STRING	Storage key.	-

trackIndexedDBForOrigin

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

-

PARAMETERS:

Name	Type	Description	Flags
origin	"type": STRING	Security origin.	-

trackIndexedDBForStorageKey

Registers storage key to be notified when an update occurs to its IndexedDB.

-

PARAMETERS:

Name	Type	Description	Flags
storageKey	"type": STRING	Storage key.	-

untrackCacheStorageForOrigin

Unregisters origin from receiving notifications for cache storage.

-

PARAMETERS:

Name	Type	Description	Flags
origin	"type": STRING	Security origin.	-

untrackCacheStorageForStorageKey

Unregisters storage key from receiving notifications for cache storage.

-

PARAMETERS:

Name	Type	Description	Flags
storageKey	"type": STRING	Storage key.	-

untrackIndexedDBForOrigin

Unregisters origin from receiving notifications for IndexedDB.

-

PARAMETERS:

Name	Type	Description	Flags
origin	"type": STRING	Security origin.	-

untrackIndexedDBForStorageKey

Unregisters storage key from receiving notifications for IndexedDB.

-

PARAMETERS:

Name	Type	Description	Flags
storageKey	"type": STRING	Storage key.	-

EVENTS

Name

Description

Flags

attributionReportingReportSent

-

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
url	"type": STRING	-	-
body	"type": OBJECT	-	-
result	"$ref": AttributionReportingReportResult	-	-
netError	"type": INTEGER	If result is `sent`, populated with net/HTTP status.	[OPTIONAL]
netErrorName	"type": STRING	-	[OPTIONAL]
httpStatusCode	"type": INTEGER	-	[OPTIONAL]

attributionReportingSourceRegistered

-

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
registration	"$ref": AttributionReportingSourceRegistration	-	-
result	"$ref": AttributionReportingSourceRegistrationResult	-	-

attributionReportingTriggerRegistered

-

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
registration	"$ref": AttributionReportingTriggerRegistration	-	-
eventLevel	"$ref": AttributionReportingEventLevelResult	-	-
aggregatable	"$ref": AttributionReportingAggregatableResult	-	-

attributionReportingVerboseDebugReportSent

-

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
url	"type": STRING	-	-
body	"type": ARRAY "items": { "type": OBJECT }	-	[OPTIONAL]
netError	"type": INTEGER	-	[OPTIONAL]
netErrorName	"type": STRING	-	[OPTIONAL]
httpStatusCode	"type": INTEGER	-	[OPTIONAL]

cacheStorageContentUpdated

A cache's contents have been modified.

-

PARAMETERS:

Name	Type	Description	Flags
origin	"type": STRING	Origin to update.	-
storageKey	"type": STRING	Storage key to update.	-
bucketId	"type": STRING	Storage bucket to update.	-
cacheName	"type": STRING	Name of cache in origin.	-

cacheStorageListUpdated

A cache has been added/deleted.

-

PARAMETERS:

Name	Type	Description	Flags
origin	"type": STRING	Origin to update.	-
storageKey	"type": STRING	Storage key to update.	-
bucketId	"type": STRING	Storage bucket to update.	-

indexedDBContentUpdated

The origin's IndexedDB object store has been modified.

-

PARAMETERS:

Name	Type	Description	Flags
origin	"type": STRING	Origin to update.	-
storageKey	"type": STRING	Storage key to update.	-
bucketId	"type": STRING	Storage bucket to update.	-
databaseName	"type": STRING	Database to update.	-
objectStoreName	"type": STRING	ObjectStore to update.	-

indexedDBListUpdated

The origin's IndexedDB database list has been modified.

-

PARAMETERS:

Name	Type	Description	Flags
origin	"type": STRING	Origin to update.	-
storageKey	"type": STRING	Storage key to update.	-
bucketId	"type": STRING	Storage bucket to update.	-

interestGroupAccessed

One of the interest groups was accessed. Note that these events are global to all targets sharing an interest group store.

-

PARAMETERS:

Name	Type	Description	Flags
accessTime	"$ref": Network.TimeSinceEpoch	-	-
type	"$ref": InterestGroupAccessType	-	-
ownerOrigin	"type": STRING	-	-
name	"type": STRING	-	-
componentSellerOrigin	"type": STRING	For topLevelBid/topLevelAdditionalBid, and when appropriate, win and additionalBidWin	[OPTIONAL]
bid	"type": NUMBER	For bid or somethingBid event, if done locally and not on a server.	[OPTIONAL]
bidCurrency	"type": STRING	-	[OPTIONAL]
uniqueAuctionId	"$ref": InterestGroupAuctionId	For non-global events --- links to interestGroupAuctionEvent	[OPTIONAL]

interestGroupAuctionEventOccurred

An auction involving interest groups is taking place. These events are target-specific.

-

PARAMETERS:

Name	Type	Description	Flags
eventTime	"$ref": Network.TimeSinceEpoch	-	-
type	"$ref": InterestGroupAuctionEventType	-	-
uniqueAuctionId	"$ref": InterestGroupAuctionId	-	-
parentAuctionId	"$ref": InterestGroupAuctionId	Set for child auctions.	[OPTIONAL]
auctionConfig	"type": OBJECT	Set for started and configResolved	[OPTIONAL]

interestGroupAuctionNetworkRequestCreated

Specifies which auctions a particular network fetch may be related to, and in what role. Note that it is not ordered with respect to Network.requestWillBeSent (but will happen before loadingFinished loadingFailed).

-

PARAMETERS:

Name	Type	Description	Flags
type	"$ref": InterestGroupAuctionFetchType	-	-
requestId	"$ref": Network.RequestId	-	-
auctions	"type": ARRAY "items": { "$ref": InterestGroupAuctionId }	This is the set of the auctions using the worklet that issued this request. In the case of trusted signals, it's possible that only some of them actually care about the keys being queried.	-

sharedStorageAccessed

Shared storage was accessed by the associated page. The following parameters are included in all events.

-

PARAMETERS:

Name	Type	Description	Flags
accessTime	"$ref": Network.TimeSinceEpoch	Time of the access.	-
scope	"$ref": SharedStorageAccessScope	Enum value indicating the access scope.	-
method	"$ref": SharedStorageAccessMethod	Enum value indicating the Shared Storage API method invoked.	-
mainFrameId	"$ref": Page.FrameId	DevTools Frame Token for the primary frame tree's root.	-
ownerOrigin	"type": STRING	Serialization of the origin owning the Shared Storage data.	-
ownerSite	"type": STRING	Serialization of the site owning the Shared Storage data.	-
params	"$ref": SharedStorageAccessParams	The sub-parameters wrapped by `params` are all optional and their presence/absence depends on `type`.	-

sharedStorageWorkletOperationExecutionFinished

A shared storage run or selectURL operation finished its execution. The following parameters are included in all events.

-

PARAMETERS:

Name	Type	Description	Flags
finishedTime	"$ref": Network.TimeSinceEpoch	Time that the operation finished.	-
executionTime	"type": INTEGER	Time, in microseconds, from start of shared storage JS API call until end of operation execution in the worklet.	-
method	"$ref": SharedStorageAccessMethod	Enum value indicating the Shared Storage API method invoked.	-
operationId	"type": STRING	ID of the operation call.	-
workletTargetId	"$ref": Target.TargetID	Hex representation of the DevTools token used as the TargetID for the associated shared storage worklet.	-
mainFrameId	"$ref": Page.FrameId	DevTools Frame Token for the primary frame tree's root.	-
ownerOrigin	"type": STRING	Serialization of the origin owning the Shared Storage data.	-

storageBucketCreatedOrUpdated

-

PARAMETERS:

Name	Type	Description	Flags
bucketInfo	"$ref": StorageBucketInfo	-	-

storageBucketDeleted

-

PARAMETERS:

Name	Type	Description	Flags
bucketId	"type": STRING	-	-

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	"type": NUMBER	PCI ID of the GPU vendor, if available; 0 otherwise.	-
deviceId	"type": NUMBER	PCI ID of the GPU device, if available; 0 otherwise.	-
subSysId	"type": NUMBER	Sub sys ID of the GPU, only available on Windows.	[OPTIONAL]
revision	"type": NUMBER	Revision of the GPU, only available on Windows.	[OPTIONAL]
vendorString	"type": STRING	String description of the GPU vendor, if the PCI ID is not available.	-
deviceString	"type": STRING	String description of the GPU device, if the PCI ID is not available.	-
driverVendor	"type": STRING	String description of the GPU driver vendor.	-
driverVersion	"type": STRING	String description of the GPU driver version.	-

GPUInfo

OBJECT

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

-

PROPERTIES:

Name	Type	Description	Flags
devices	"type": ARRAY "items": { "$ref": GPUDevice }	The graphics devices on the system. Element 0 is the primary GPU.	-
auxAttributes	"type": OBJECT	An optional dictionary of additional GPU related attributes.	[OPTIONAL]
featureStatus	"type": OBJECT	An optional dictionary of graphics features and their status.	[OPTIONAL]
driverBugWorkarounds	"type": ARRAY "items": { "type": STRING }	An optional array of GPU driver bug workarounds.	-
videoDecoding	"type": ARRAY "items": { "$ref": VideoDecodeAcceleratorCapability }	Supported accelerated video decoding capabilities.	-
videoEncoding	"type": ARRAY "items": { "$ref": VideoEncodeAcceleratorCapability }	Supported accelerated video encoding capabilities.	-
imageDecoding	"type": ARRAY "items": { "$ref": ImageDecodeAcceleratorCapability }	Supported accelerated image decoding capabilities.	-

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	"type": ARRAY "items": { "$ref": SubsamplingFormat }	Optional array of supported subsampling formats, e.g. 4:2:0, if known.	-

ImageType

Image format of a given image.

-

ProcessInfo

OBJECT

Represents process info.

-

PROPERTIES:

Name	Type	Description	Flags
type	"type": STRING	Specifies process type.	-
id	"type": INTEGER	Specifies process id.	-
cpuTime	"type": NUMBER	Specifies cumulative CPU usage in seconds across all threads of the process since the process start.	-

Size

OBJECT

Describes the width and height dimensions of an entity.

-

PROPERTIES:

Name	Type	Description	Flags
width	"type": INTEGER	Width in pixels.	-
height	"type": INTEGER	Height in pixels.	-

SubsamplingFormat

YUV subsampling type of the pixels of a given image.

-

VideoDecodeAcceleratorCapability

OBJECT

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

-

PROPERTIES:

Name	Type	Description	Flags
profile	"type": 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	"type": STRING	Video codec profile that is supported, e.g H264 Main.	-
maxResolution	"$ref": Size	Maximum video dimensions in pixels supported for this \|profile\|.	-
maxFramerateNumerator	"type": 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	"type": INTEGER	-	-

COMMANDS

Name

Description

Flags

getFeatureState

Returns information about the feature state.

-

PARAMETERS:

Name	Type	Description	Flags
featureState	"type": STRING	-	-

RETURNS:

Name	Type	Description	Flags
featureEnabled	"type": BOOLEAN	-	-

getInfo

Returns information about the system.

-

RETURNS:

Name	Type	Description	Flags
gpu	"$ref": GPUInfo	Information about the GPUs on the system.	-
modelName	"type": STRING	A platform-dependent description of the model of the machine. On Mac OS, this is, for example, 'MacBookPro'. Will be the empty string if not supported.	-
modelVersion	"type": STRING	A platform-dependent description of the version of the machine. On Mac OS, this is, for example, '10.1'. Will be the empty string if not supported.	-
commandLine	"type": STRING	The command line string used to launch the browser. Will be the empty string if not supported.	-

getProcessInfo

Returns information about all running processes.

-

RETURNS:

Name	Type	Description	Flags
processInfo	"type": ARRAY "items": { "$ref": ProcessInfo }	An array of process info blocks.	-

Target

Supports additional targets discovery and allows to attach to them.

TYPES

Type ID

Type

Description

Flags

FilterEntry

OBJECT

A filter used by target query/discovery/auto-attach operations.

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
exclude	"type": BOOLEAN	If set, causes exclusion of matching targets from the list.	[OPTIONAL]
type	"type": STRING	If not present, matches any type.	[OPTIONAL]

RemoteLocation

OBJECT

-

[EXPERIMENTAL]

PROPERTIES:

Name	Type	Description	Flags
host	"type": STRING	-	-
port	"type": INTEGER	-	-

SessionID

STRING

Unique identifier of attached debugging session.

-

TargetFilter

ARRAY

The entries in TargetFilter are matched sequentially against targets and the first entry that matches determines if the target is included or not, depending on the value of `exclude` field in the entry. If filter is not specified, the one assumed is [{type: "browser", exclude: true}, {type: "tab", exclude: true}, {}] (i.e. include everything but `browser` and `tab`).

[EXPERIMENTAL]

TargetID

STRING

-

TargetInfo

OBJECT

-

PROPERTIES:

Name	Type	Description	Flags
targetId	"$ref": TargetID	-	-
type	"type": STRING	List of types: https://source.chromium.org/chromium/chromium/src/+/main:content/browser/devtools/devtools_agent_host_impl.cc?ss=chromium&q=f:devtools%20-f:out%20%22::kTypeTab%5B%5D%22	-
title	"type": STRING	-	-
url	"type": STRING	-	-
attached	"type": BOOLEAN	Whether the target has an attached client.	-
openerId	"$ref": TargetID	Opener target Id	[OPTIONAL]
canAccessOpener	"type": 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]
subtype	"type": STRING	Provides additional details for specific target types. For example, for the type of "page", this may be set to "prerender".	[OPTIONAL] [EXPERIMENTAL]

WindowState

The state of the target window.

[EXPERIMENTAL]

COMMANDS

Name

Description

Flags

activateTarget

Activates (focuses) the target.

-

PARAMETERS:

Name	Type	Description	Flags
targetId	"$ref": TargetID	-	-

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

attachToTarget

Attaches to the target with given id.

-

PARAMETERS:

Name	Type	Description	Flags
targetId	"$ref": TargetID	-	-
flatten	"type": 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.	-

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	"type": BOOLEAN	Whether to pause new targets when attaching to them. Use `RunTime.runIfWaitingForDebugger` to run paused targets.	-
filter	"$ref": TargetFilter	Only targets matching filter will be attached.	[OPTIONAL] [EXPERIMENTAL]

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	"type": BOOLEAN	Always set to true. If an error occurs, the response indicates protocol error.	[DEPRECATED]

createBrowserContext

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

-

PARAMETERS:

Name	Type	Description	Flags
disposeOnDetach	"type": BOOLEAN	If specified, disposes this context when debugging session disconnects.	[OPTIONAL] [EXPERIMENTAL]
proxyServer	"type": STRING	Proxy server, similar to the one passed to --proxy-server	[OPTIONAL] [EXPERIMENTAL]
proxyBypassList	"type": STRING	Proxy bypass list, similar to the one passed to --proxy-bypass-list	[OPTIONAL] [EXPERIMENTAL]
originsWithUniversalNetworkAccess	"type": ARRAY "items": { "type": STRING }	An optional list of origins to grant unlimited cross-origin access to. Parts of the URL other than those constituting origin are ignored.	[OPTIONAL] [EXPERIMENTAL]

RETURNS:

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

createTarget

Creates a new page.

-

PARAMETERS:

Name	Type	Description	Flags
url	"type": STRING	The initial URL the page will be navigated to. An empty string indicates about:blank.	-
left	"type": INTEGER	Frame left origin in DIP (requires newWindow to be true or headless shell).	[OPTIONAL] [EXPERIMENTAL]
top	"type": INTEGER	Frame top origin in DIP (requires newWindow to be true or headless shell).	[OPTIONAL] [EXPERIMENTAL]
width	"type": INTEGER	Frame width in DIP (requires newWindow to be true or headless shell).	[OPTIONAL]
height	"type": INTEGER	Frame height in DIP (requires newWindow to be true or headless shell).	[OPTIONAL]
windowState	"$ref": WindowState	Frame window state (requires newWindow to be true or headless shell). Default is normal.	[OPTIONAL]
browserContextId	"$ref": Browser.BrowserContextID	The browser context to create the page in.	[OPTIONAL] [EXPERIMENTAL]
enableBeginFrameControl	"type": BOOLEAN	Whether BeginFrames for this target will be controlled via DevTools (headless shell only, not supported on MacOS yet, false by default).	[OPTIONAL] [EXPERIMENTAL]
newWindow	"type": BOOLEAN	Whether to create a new Window or Tab (false by default, not supported by headless shell).	[OPTIONAL]
background	"type": BOOLEAN	Whether to create the target in background or foreground (false by default, not supported by headless shell).	[OPTIONAL]
forTab	"type": BOOLEAN	Whether to create the target of type "tab".	[OPTIONAL] [EXPERIMENTAL]
hidden	"type": BOOLEAN	Whether to create a hidden target. The hidden target is observable via protocol, but not present in the tab UI strip. Cannot be created with `forTab: true`, `newWindow: true` or `background: false`. The life-time of the tab is limited to the life-time of the session.	[OPTIONAL] [EXPERIMENTAL]

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.

-

PARAMETERS:

Name	Type	Description	Flags
browserContextId	"$ref": Browser.BrowserContextID	-	-

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 following 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	"type": STRING	Binding name, 'cdp' if not specified.	[OPTIONAL]
inheritPermissions	"type": BOOLEAN	If true, inherits the current root session's permissions (default: false).	[OPTIONAL]

getBrowserContexts

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

-

RETURNS:

Name	Type	Description	Flags
browserContextIds	"type": ARRAY "items": { "$ref": Browser.BrowserContextID }	An array of browser context ids.	-

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.

-

PARAMETERS:

Name	Type	Description	Flags
filter	"$ref": TargetFilter	Only targets matching filter will be reported. If filter is not specified and target discovery is currently enabled, a filter used for target discovery is used for consistency.	[OPTIONAL] [EXPERIMENTAL]

RETURNS:

Name	Type	Description	Flags
targetInfos	"type": ARRAY "items": { "$ref": TargetInfo }	The list of targets.	-

openDevTools

Opens a DevTools window for the target.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
targetId	"$ref": TargetID	This can be the page or tab target ID.	-

RETURNS:

Name	Type	Description	Flags
targetId	"$ref": TargetID	The targetId of DevTools page target.	-

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	"type": 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 directly related to this one (for example, iframes or workers). 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. You might want to call this recursively for auto-attached targets to attach to all available targets.

-

PARAMETERS:

Name	Type	Description	Flags
autoAttach	"type": BOOLEAN	Whether to auto-attach to related targets.	-
waitForDebuggerOnStart	"type": BOOLEAN	Whether to pause new targets when attaching to them. Use `RunTime.runIfWaitingForDebugger` to run paused targets.	-
flatten	"type": 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] [EXPERIMENTAL]
filter	"$ref": TargetFilter	Only targets matching filter will be attached.	[OPTIONAL] [EXPERIMENTAL]

setDiscoverTargets

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

-

PARAMETERS:

Name	Type	Description	Flags
discover	"type": BOOLEAN	Whether to discover available targets.	-
filter	"$ref": TargetFilter	Only targets matching filter will be attached. If `discover` is false, `filter` must be omitted or empty.	[OPTIONAL] [EXPERIMENTAL]

setRemoteLocations

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

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
locations	"type": ARRAY "items": { "$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	"type": 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	"type": STRING	-	-
targetId	"$ref": TargetID	Deprecated.	[OPTIONAL] [DEPRECATED]

targetCrashed

Issued when a target has crashed.

-

PARAMETERS:

Name	Type	Description	Flags
targetId	"$ref": TargetID	-	-
status	"type": STRING	Termination status type.	-
errorCode	"type": INTEGER	Termination error code.	-

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

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

-

Dependencies: IO

TYPES

Type ID

Type

Description

Flags

MemoryDumpConfig

OBJECT
as JsonValue

Configuration for memory dump. Used only when "memory-infra" category is enabled.

[EXPERIMENTAL]

MemoryDumpLevelOfDetail

Details exposed when memory request explicitly declared. Keep consistent with memory_dump_request_args.h and memory_instrumentation.mojom

[EXPERIMENTAL]

StreamCompression

Compression type to use for traces returned via streams.

[EXPERIMENTAL]

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.

[EXPERIMENTAL]

TraceConfig

OBJECT

-

PROPERTIES:

Name	Type	Description	Flags
recordMode	"echoToConsole", "recordAsMuchAsPossible", "recordContinuously", "recordUntilFull"String [Hover] Enum "type": STRING	Controls how the trace buffer stores data. The default is `recordUntilFull`.	[OPTIONAL] [EXPERIMENTAL]
traceBufferSizeInKb	"type": NUMBER	Size of the trace buffer in kilobytes. If not specified or zero is passed, a default value of 200 MB would be used.	[OPTIONAL] [EXPERIMENTAL]
enableSampling	"type": BOOLEAN	Turns on JavaScript stack sampling.	[OPTIONAL] [EXPERIMENTAL]
enableSystrace	"type": BOOLEAN	Turns on system tracing.	[OPTIONAL] [EXPERIMENTAL]
enableArgumentFilter	"type": BOOLEAN	Turns on argument filter.	[OPTIONAL] [EXPERIMENTAL]
includedCategories	"type": ARRAY "items": { "type": STRING }	Included category filters.	[OPTIONAL]
excludedCategories	"type": ARRAY "items": { "type": STRING }	Excluded category filters.	[OPTIONAL]
syntheticDelays	"type": ARRAY "items": { "type": STRING }	Configuration to synthesize the delays in tracing.	[OPTIONAL] [EXPERIMENTAL]
memoryDumpConfig	"$ref": MemoryDumpConfig	Configuration for memory dump triggers. Used only when "memory-infra" category is enabled.	[OPTIONAL] [EXPERIMENTAL]

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

[EXPERIMENTAL]

COMMANDS

Name

Description

Flags

end

Stop trace events collection.

-

getCategories

Gets supported tracing categories.

[EXPERIMENTAL]

RETURNS:

Name	Type	Description	Flags
categories	"type": ARRAY "items": { "type": STRING }	A list of supported tracing categories.	-

recordClockSyncMarker

Record a clock sync marker in the trace.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
syncId	"type": STRING	The ID of this clock sync marker	-

requestMemoryDump

Request a global memory dump.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
deterministic	"type": 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	"type": STRING	GUID of the resulting global memory dump.	-
success	"type": BOOLEAN	True iff the global memory dump succeeded.	-

start

Start trace events collection.

-

PARAMETERS:

Name	Type	Description	Flags
categories	"type": STRING	Category/tag filter	[OPTIONAL] [EXPERIMENTAL] [DEPRECATED]
options	"type": STRING	Tracing options	[OPTIONAL] [EXPERIMENTAL] [DEPRECATED]
bufferUsageReportingInterval	"type": NUMBER	If set, the agent will issue bufferUsage events at this interval, specified in milliseconds	[OPTIONAL] [EXPERIMENTAL]
transferMode	"ReportEvents", "ReturnAsStream"String [Hover] Enum "type": STRING	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] [EXPERIMENTAL]
traceConfig	"$ref": TraceConfig	-	[OPTIONAL]
perfettoConfig	"type": 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] [EXPERIMENTAL]
tracingBackend	"$ref": TracingBackend	Backend type (defaults to `auto`)	[OPTIONAL] [EXPERIMENTAL]

EVENTS

Name

Description

Flags

bufferUsage

-

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
percentFull	"type": NUMBER	A number in range [0..1] that indicates the used size of event buffer as a fraction of its total size.	[OPTIONAL]
eventCount	"type": NUMBER	An approximate number of events in the trace log.	[OPTIONAL]
value	"type": 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 a bucket of collected trace events. When tracing is stopped collected events will be sent as a sequence of dataCollected events followed by tracingComplete event.

[EXPERIMENTAL]

PARAMETERS:

Name	Type	Description	Flags
value	"type": ARRAY "items": { "type": 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	"type": 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]

WebAudio

[Experimental]

This domain allows inspection of Web Audio API. https://webaudio.github.io/web-audio-api/

TYPES

Type ID

Type

Description

Flags

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	"type": NUMBER	-	-
numberOfOutputs	"type": NUMBER	-	-
channelCount	"type": 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	"type": NUMBER	-	-
minValue	"type": NUMBER	-	-
maxValue	"type": NUMBER	-	-

AutomationRate

Enum of AudioParam::AutomationRate from the spec

-

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	"type": NUMBER	Platform-dependent callback buffer size.	-
maxOutputChannelCount	"type": NUMBER	Number of output channels supported by audio hardware in use.	-
sampleRate	"type": NUMBER	Context sample rate.	-

ChannelCountMode

Enum of AudioNode::ChannelCountMode from the spec

-

ChannelInterpretation

Enum of AudioNode::ChannelInterpretation from the spec

-

ContextRealtimeData

OBJECT

Fields in AudioContext that change in real-time.

-

PROPERTIES:

Name	Type	Description	Flags
currentTime	"type": NUMBER	The current context time in second in BaseAudioContext.	-
renderCapacity	"type": 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	"type": NUMBER	A running mean of callback interval.	-
callbackIntervalVariance	"type": NUMBER	A running variance of callback interval.	-

ContextState

Enum of AudioContextState from the spec

-

ContextType

Enum of BaseAudioContext types

-

GraphObjectId

STRING

An unique ID for a graph object (AudioContext, AudioNode, AudioParam) in Web Audio API

-

NodeType

STRING

Enum of AudioNode types

-

ParamType

STRING

Enum of AudioParam types

-

EVENTS

Name

Description

Flags

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

contextChanged

Notifies that existing BaseAudioContext has changed some properties (id stays the same)..

-

PARAMETERS:

Name	Type	Description	Flags
context	"$ref": BaseAudioContext	-	-

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

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	"type": 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	"type": NUMBER	-	[OPTIONAL]

nodesConnected

Notifies that two AudioNodes are connected.

-

PARAMETERS:

Name	Type	Description	Flags
contextId	"$ref": GraphObjectId	-	-
sourceId	"$ref": GraphObjectId	-	-
destinationId	"$ref": GraphObjectId	-	-
sourceOutputIndex	"type": NUMBER	-	[OPTIONAL]
destinationInputIndex	"type": 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	"type": NUMBER	-	[OPTIONAL]
destinationInputIndex	"type": NUMBER	-	[OPTIONAL]

WebAuthn

[Experimental]

This domain allows configuring virtual authenticators to test the WebAuthn API.

TYPES

Type ID

Type

Description

Flags

AuthenticatorId

STRING

-

AuthenticatorProtocol

-

AuthenticatorTransport

-

Credential

OBJECT

-

PROPERTIES:

Name	Type	Description	Flags
credentialId	"type": STRING	-	-
isResidentCredential	"type": BOOLEAN	-	-
rpId	"type": STRING	Relying Party ID the credential is scoped to. Must be set when adding a credential.	[OPTIONAL]
privateKey	"type": STRING	The ECDSA P-256 private key in PKCS#8 format. (Encoded as a base64 string when passed over JSON)	-
userHandle	"type": 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	"type": INTEGER	Signature counter. This is incremented by one for each successful assertion. See https://w3c.github.io/webauthn/#signature-counter	-
largeBlob	"type": 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]
backupEligibility	"type": BOOLEAN	Assertions returned by this credential will have the backup eligibility (BE) flag set to this value. Defaults to the authenticator's defaultBackupEligibility value.	[OPTIONAL]
backupState	"type": BOOLEAN	Assertions returned by this credential will have the backup state (BS) flag set to this value. Defaults to the authenticator's defaultBackupState value.	[OPTIONAL]
userName	"type": STRING	The credential's user.name property. Equivalent to empty if not set. https://w3c.github.io/webauthn/#dom-publickeycredentialentity-name	[OPTIONAL]
userDisplayName	"type": STRING	The credential's user.displayName property. Equivalent to empty if not set. https://w3c.github.io/webauthn/#dom-publickeycredentialuserentity-displayname	[OPTIONAL]

Ctap2Version

-

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	"type": BOOLEAN	Defaults to false.	[OPTIONAL]
hasUserVerification	"type": BOOLEAN	Defaults to false.	[OPTIONAL]
hasLargeBlob	"type": BOOLEAN	If set to true, the authenticator will support the largeBlob extension. https://w3c.github.io/webauthn#largeBlob Defaults to false.	[OPTIONAL]
hasCredBlob	"type": 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]
hasMinPinLength	"type": BOOLEAN	If set to true, the authenticator will support the minPinLength extension. https://fidoalliance.org/specs/fido-v2.1-ps-20210615/fido-client-to-authenticator-protocol-v2.1-ps-20210615.html#sctn-minpinlength-extension Defaults to false.	[OPTIONAL]
hasPrf	"type": BOOLEAN	If set to true, the authenticator will support the prf extension. https://w3c.github.io/webauthn/#prf-extension Defaults to false.	[OPTIONAL]
automaticPresenceSimulation	"type": BOOLEAN	If set to true, tests of user presence will succeed immediately. Otherwise, they will not be resolved. Defaults to true.	[OPTIONAL]
isUserVerified	"type": BOOLEAN	Sets whether User Verification succeeds or fails for an authenticator. Defaults to false.	[OPTIONAL]
defaultBackupEligibility	"type": BOOLEAN	Credentials created by this authenticator will have the backup eligibility (BE) flag set to this value. Defaults to false. https://w3c.github.io/webauthn/#sctn-credential-backup	[OPTIONAL]
defaultBackupState	"type": BOOLEAN	Credentials created by this authenticator will have the backup state (BS) flag set to this value. Defaults to false. https://w3c.github.io/webauthn/#sctn-credential-backup	[OPTIONAL]

COMMANDS

Name

Description

Flags

addCredential

Adds the credential to the specified authenticator.

-

PARAMETERS:

Name	Type	Description	Flags
authenticatorId	"$ref": AuthenticatorId	-	-
credential	"$ref": Credential	-	-

addVirtualAuthenticator

Creates and adds a virtual authenticator.

-

PARAMETERS:

Name	Type	Description	Flags
options	"$ref": VirtualAuthenticatorOptions	-	-

RETURNS:

Name	Type	Description	Flags
authenticatorId	"$ref": AuthenticatorId	-	-

clearCredentials

Clears all the credentials from the specified device.

-

PARAMETERS:

Name	Type	Description	Flags
authenticatorId	"$ref": AuthenticatorId	-	-

disable

Disable the WebAuthn domain.

-

enable

Enable the WebAuthn domain and start intercepting credential storage and retrieval with a virtual authenticator.

-

PARAMETERS:

Name	Type	Description	Flags
enableUI	"type": BOOLEAN	Whether to enable the WebAuthn user interface. Enabling the UI is recommended for debugging and demo purposes, as it is closer to the real experience. Disabling the UI is recommended for automated testing. Supported at the embedder's discretion if UI is available. Defaults to false.	[OPTIONAL]

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	"type": 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	"type": ARRAY "items": { "$ref": Credential }	-	-

removeCredential

Removes a credential from the authenticator.

-

PARAMETERS:

Name	Type	Description	Flags
authenticatorId	"$ref": AuthenticatorId	-	-
credentialId	"type": STRING	-	-

removeVirtualAuthenticator

Removes the given authenticator.

-

PARAMETERS:

Name	Type	Description	Flags
authenticatorId	"$ref": AuthenticatorId	-	-

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	"type": BOOLEAN	-	-

setCredentialProperties

Allows setting credential properties. https://w3c.github.io/webauthn/#sctn-automation-set-credential-properties

-

PARAMETERS:

Name	Type	Description	Flags
authenticatorId	"$ref": AuthenticatorId	-	-
credentialId	"type": STRING	-	-
backupEligibility	"type": BOOLEAN	-	[OPTIONAL]
backupState	"type": BOOLEAN	-	[OPTIONAL]

setResponseOverrideBits

Resets parameters isBogusSignature, isBadUV, isBadUP to false if they are not present.

-

PARAMETERS:

Name	Type	Description	Flags
authenticatorId	"$ref": AuthenticatorId	-	-
isBogusSignature	"type": BOOLEAN	If isBogusSignature is set, overrides the signature in the authenticator response to be zero. Defaults to false.	[OPTIONAL]
isBadUV	"type": BOOLEAN	If isBadUV is set, overrides the UV bit in the flags in the authenticator response to be zero. Defaults to false.	[OPTIONAL]
isBadUP	"type": BOOLEAN	If isBadUP is set, overrides the UP bit in the flags in the authenticator response to be zero. Defaults to false.	[OPTIONAL]

setUserVerified

Sets whether User Verification succeeds or fails for an authenticator. The default is true.

-

PARAMETERS:

Name	Type	Description	Flags
authenticatorId	"$ref": AuthenticatorId	-	-
isUserVerified	"type": BOOLEAN	-	-

EVENTS

Name

Description

Flags

credentialAdded

Triggered when a credential is added to an authenticator.

-

PARAMETERS:

Name	Type	Description	Flags
authenticatorId	"$ref": AuthenticatorId	-	-
credential	"$ref": Credential	-	-

credentialAsserted

Triggered when a credential is used in a webauthn assertion.

-

PARAMETERS:

Name	Type	Description	Flags
authenticatorId	"$ref": AuthenticatorId	-	-
credential	"$ref": Credential	-	-

credentialDeleted

Triggered when a credential is deleted, e.g. through PublicKeyCredential.signalUnknownCredential().

-

PARAMETERS:

Name	Type	Description	Flags
authenticatorId	"$ref": AuthenticatorId	-	-
credentialId	"type": STRING	-	-

credentialUpdated

Triggered when a credential is updated, e.g. through PublicKeyCredential.signalCurrentUserDetails().

-

PARAMETERS:

Name	Type	Description	Flags
authenticatorId	"$ref": AuthenticatorId	-	-
credential	"$ref": Credential	-	-

Name	Description	Flags
disable	Disables inspector domain notifications.	-
enable	Enables inspector domain notifications.	-

Name	Description	Flags
disable	Disables the Media domain.	-
enable	Enables the Media domain	-

Available BrowserAPI Domains

Accessibility

TYPES

COMMANDS

EVENTS

Animation

TYPES

COMMANDS

EVENTS

Audits

TYPES

COMMANDS

EVENTS

Autofill

TYPES

COMMANDS

EVENTS

BackgroundService

TYPES

COMMANDS

EVENTS

BluetoothEmulation

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

DeviceAccess

TYPES

COMMANDS

EVENTS

DeviceOrientation

COMMANDS

Emulation

TYPES

COMMANDS

EVENTS

EventBreakpoints

COMMANDS

Extensions

TYPES

COMMANDS

FedCm

TYPES

COMMANDS

EVENTS

Fetch

TYPES

COMMANDS

EVENTS

FileSystem

TYPES

COMMANDS