← Back to Index

Chrome DevTools Protocol — Complete Reference

Every domain, command, event, and type in CDP.

57 domains · 668 commands · 237 events · 613 types

Table of Contents

Accessibility Ads Animation Audits Autofill BackgroundService BluetoothEmulation Browser CSS CacheStorage Cast Console CrashReportContext DOM DOMDebugger DOMSnapshot DOMStorage Debugger DeviceAccess DeviceOrientation Emulation EventBreakpoints Extensions FedCm Fetch FileSystem HeadlessExperimental HeapProfiler IO IndexedDB Input Inspector LayerTree Log Media Memory Network Overlay PWA Page Performance PerformanceTimeline Preload Profiler Runtime Schema Security ServiceWorker SmartCardEmulation Storage SystemInfo Target Tethering Tracing WebAudio WebAuthn WebMCP

↑Accessibility experimental

↑Commands (8)

Accessibility.disable → example
Disables the accessibility domain.
Accessibility.enable → example
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.
Accessibility.getPartialAXTree → example
Fetches the accessibility node and partial accessibility tree for this DOM node, if it exists.
Params: nodeId?: DOM.NodeId, backendNodeId?: DOM.BackendNodeId, objectId?: Runtime.RemoteObjectId, fetchRelatives?: boolean
Returns: nodes: array
Accessibility.getFullAXTree → example
Fetches the entire accessibility tree for the root Document
Params: depth?: integer, frameId?: Page.FrameId
Returns: nodes: array
Accessibility.getRootAXNode → example
Fetches the root node. Requires `enable()` to have been called previously.
Params: frameId?: Page.FrameId
Returns: node: AXNode
Accessibility.getAXNodeAndAncestors → example
Fetches a node and all ancestors up to and including the root. Requires `enable()` to have been called previously.
Params: nodeId?: DOM.NodeId, backendNodeId?: DOM.BackendNodeId, objectId?: Runtime.RemoteObjectId
Returns: nodes: array
Accessibility.getChildAXNodes → example
Fetches a particular accessibility node by AXNodeId. Requires `enable()` to have been called previously.
Params: id: AXNodeId, frameId?: Page.FrameId
Returns: nodes: array
Accessibility.queryAXTree → example
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.
Params: nodeId?: DOM.NodeId, backendNodeId?: DOM.BackendNodeId, objectId?: Runtime.RemoteObjectId, accessibleName?: string, role?: string
Returns: nodes: array

↑Events (2)

Accessibility.loadComplete
The loadComplete event mirrors the load complete event sent by the browser to assistive technology when the web page has finished loading.
Params: root: AXNode
Accessibility.nodesUpdated
The nodesUpdated event is sent every time a previously requested node has changed the in tree.
Params: nodes: array

↑Types (10)

AXNodeId (string)
Unique accessibility node identifier.
AXValueType (string)
Enum of possible property types.
AXValueSourceType (string)
Enum of possible property sources.
AXValueNativeSourceType (string)
Enum of possible native property sources (as a subtype of a particular AXValueSourceType).
AXValueSource (object)
A single source for a computed AX property.
AXRelatedNode (object)
AXProperty (object)
AXValue (object)
A single computed AX property.
AXPropertyName (string)
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 - from 'activeFullscreenElement' to 'uninteresting': reasons why this noode is hidden
AXNode (object)
A node in the accessibility tree.

↑Ads experimental

A domain for ad-related metrics and data.

↑Commands (1)

Ads.getAdMetrics → example
Retrieves ad metrics for the current page.
Returns: metrics: AdMetrics

↑Types (1)

AdMetrics (object)
Ad metrics for a page.

↑Animation experimental

↑Commands (10)

Animation.disable → example
Disables animation domain notifications.
Animation.enable → example
Enables animation domain notifications.
Animation.getCurrentTime → example
Returns the current time of the an animation.
Params: id: string
Returns: currentTime: number
Animation.getPlaybackRate → example
Gets the playback rate of the document timeline.
Returns: playbackRate: number
Animation.releaseAnimations → example
Releases a set of animations to no longer be manipulated.
Params: animations: array
Animation.resolveAnimation → example
Gets the remote object of the Animation.
Params: animationId: string
Returns: remoteObject: Runtime.RemoteObject
Animation.seekAnimations → example
Seek a set of animations to a particular time within each animation.
Params: animations: array, currentTime: number
Animation.setPaused → example
Sets the paused state of a set of animations.
Params: animations: array, paused: boolean
Animation.setPlaybackRate → example
Sets the playback rate of the document timeline.
Params: playbackRate: number
Animation.setTiming → example
Sets the timing of an animation node.
Params: animationId: string, duration: number, delay: number

↑Events (4)

Animation.animationCanceled
Event for when an animation has been cancelled.
Params: id: string
Animation.animationCreated
Event for each animation that has been created.
Params: id: string
Animation.animationStarted
Event for animation that has been started.
Params: animation: Animation
Animation.animationUpdated
Event for animation that has been updated.
Params: animation: Animation

↑Types (5)

Animation (object)
Animation instance.
ViewOrScrollTimeline (object)
Timeline instance
AnimationEffect (object)
AnimationEffect instance
KeyframesRule (object)
Keyframes Rule
KeyframeStyle (object)
Keyframe Style

↑Audits experimental

Audits domain allows investigation of page violations and possible improvements.

↑Commands (4)

Audits.getEncodedResponse → example
Returns the response body and size if it were re-encoded with the specified settings. Only applies to images.
Params: requestId: Network.RequestId, encoding: string, quality?: number, sizeOnly?: boolean
Returns: body: string, originalSize: integer, encodedSize: integer
Audits.disable → example
Disables issues domain, prevents further issues from being reported to the client.
Audits.enable → example
Enables issues domain, sends the issues collected so far to the client by means of the `issueAdded` event.
Audits.checkFormsIssues → example
Runs the form issues check for the target page. Found issues are reported using Audits.issueAdded event.
Returns: formIssues: array

↑Events (1)

Audits.issueAdded
Params: issue: InspectorIssue

↑Types (68)

AffectedCookie (object)
Information about a cookie that is affected by an inspector issue.
AffectedRequest (object)
Information about a request that is affected by an inspector issue.
AffectedFrame (object)
Information about the frame affected by an inspector issue.
CookieExclusionReason (string)
CookieWarningReason (string)
CookieOperation (string)
InsightType (string)
Represents the category of insight that a cookie issue falls under.
CookieIssueInsight (object)
Information about the suggested solution to a cookie issue.
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.
PerformanceIssueType (string)
PerformanceIssueDetails (object)
Details for a performance issue.
MixedContentResolutionStatus (string)
MixedContentResourceType (string)
MixedContentIssueDetails (object)
BlockedByResponseReason (string)
Enum indicating the reason a response has been blocked. These reasons are refinements of the net error BLOCKED_BY_RESPONSE.
BlockedByResponseIssueDetails (object)
Details for a request that has been blocked with the BLOCKED_BY_RESPONSE code. Currently only used for COEP/COOP, but may be extended to include some CSP errors in the future.
HeavyAdResolutionStatus (string)
HeavyAdReason (string)
HeavyAdIssueDetails (object)
ContentSecurityPolicyViolationType (string)
SourceCodeLocation (object)
ContentSecurityPolicyIssueDetails (object)
SharedArrayBufferIssueType (string)
SharedArrayBufferIssueDetails (object)
Details for a issue arising from an SAB being instantiated in, or transferred to a context that is not cross-origin isolated.
CorsIssueDetails (object)
Details for a CORS related issue, e.g. a warning or error related to CORS RFC1918 enforcement.
AttributionReportingIssueType (string)
SharedDictionaryError (string)
SRIMessageSignatureError (string)
UnencodedDigestError (string)
ConnectionAllowlistError (string)
AttributionReportingIssueDetails (object)
Details for issues around "Attribution Reporting API" usage. Explainer: https://github.com/WICG/attribution-reporting-api
QuirksModeIssueDetails (object)
Details for issues about documents in Quirks Mode or Limited Quirks Mode that affects page layouting.
NavigatorUserAgentIssueDetails (object)
SharedDictionaryIssueDetails (object)
SRIMessageSignatureIssueDetails (object)
UnencodedDigestIssueDetails (object)
ConnectionAllowlistIssueDetails (object)
GenericIssueErrorType (string)
GenericIssueDetails (object)
Depending on the concrete errorType, different properties are set.
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
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`.
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`.
ClientHintIssueReason (string)
FederatedAuthRequestIssueDetails (object)
FederatedAuthRequestIssueReason (string)
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)
FederatedAuthUserInfoRequestIssueReason (string)
Represents the failure reason when a getUserInfo() call fails. Should be updated alongside FederatedAuthUserInfoRequestResult in third_party/blink/public/mojom/devtools/inspector_issue.mojom.
EmailVerificationRequestIssueDetails (object)
EmailVerificationRequestIssueReason (string)
Represents the failure reason when an email verification request fails. Should be updated alongside EmailVerificationRequestResult in third_party/blink/public/mojom/devtools/inspector_issue.mojom.
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.
FailedRequestInfo (object)
PartitioningBlobURLInfo (string)
PartitioningBlobURLIssueDetails (object)
ElementAccessibilityIssueReason (string)
ElementAccessibilityIssueDetails (object)
This issue warns about errors in the select or summary element content model.
StyleSheetLoadingIssueReason (string)
StylesheetLoadingIssueDetails (object)
This issue warns when a referenced stylesheet couldn't be loaded.
PropertyRuleIssueReason (string)
PropertyRuleIssueDetails (object)
This issue warns about errors in property rules that lead to property registrations being ignored.
UserReidentificationIssueType (string)
UserReidentificationIssueDetails (object)
This issue warns about uses of APIs that may be considered misuse to re-identify users.
PermissionElementIssueType (string)
PermissionElementIssueDetails (object)
This issue warns about improper usage of the <permission> element.
SelectivePermissionsInterventionIssueDetails (object)
The issue warns about blocked calls to privacy sensitive APIs via the Selective Permissions Intervention.
InspectorIssueCode (string)
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.
IssueId (string)
A unique id for a DevTools inspector issue. Allows other entities (e.g. exceptions, CDP message, console messages, etc.) to reference an issue.
InspectorIssue (object)
An inspector issue reported from the back-end.

↑Autofill experimental

Defines commands and events for Autofill.

↑Commands (4)

Autofill.trigger → example
Trigger autofill on a form identified by the fieldId. If the field and related form cannot be autofilled, returns an error.
Params: fieldId: DOM.BackendNodeId, frameId?: Page.FrameId, card?: CreditCard, address?: Address
Autofill.setAddresses → example
Set addresses so that developers can verify their forms implementation.
Params: addresses: array
Autofill.disable → example
Disables autofill domain notifications.
Autofill.enable → example
Enables autofill domain notifications.

↑Events (1)

Autofill.addressFormFilled
Emitted when an address form is filled.
Params: filledFields: array, addressUi: AddressUI

↑Types (7)

CreditCard (object)
AddressField (object)
AddressFields (object)
A list of address fields.
Address (object)
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
FillingStrategy (string)
Specified whether a filled field was done so by using the html autocomplete attribute or autofill heuristics.
FilledField (object)

↑BackgroundService experimental

Defines events for background web platform features.

↑Commands (4)

BackgroundService.startObserving → example
Enables event updates for the service.
Params: service: ServiceName
BackgroundService.stopObserving → example
Disables event updates for the service.
Params: service: ServiceName
BackgroundService.setRecording → example
Set the recording state for the service.
Params: shouldRecord: boolean, service: ServiceName
BackgroundService.clearEvents → example
Clears all stored data for the service.
Params: service: ServiceName

↑Events (2)

BackgroundService.recordingStateChanged
Called when the recording state for the service has been updated.
Params: isRecording: boolean, service: ServiceName
BackgroundService.backgroundServiceEventReceived
Called with all existing backgroundServiceEvents when enabled, and all new events afterwards if enabled and recording.
Params: backgroundServiceEvent: BackgroundServiceEvent

↑Types (3)

ServiceName (string)
The Background Service that will be associated with the commands/events. Every Background Service operates independently, but they share the same API.
EventMetadata (object)
A key-value pair for additional event information to pass along.
BackgroundServiceEvent (object)

↑BluetoothEmulation experimental

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

↑Commands (15)

BluetoothEmulation.enable → example
Enable the BluetoothEmulation domain.
Params: state: CentralState, leSupported: boolean
BluetoothEmulation.setSimulatedCentralState → example
Set the state of the simulated central.
Params: state: CentralState
BluetoothEmulation.disable → example
Disable the BluetoothEmulation domain.
BluetoothEmulation.simulatePreconnectedPeripheral → example
Simulates a peripheral with |address|, |name| and |knownServiceUuids| that has already been connected to the system.
Params: address: string, name: string, manufacturerData: array, knownServiceUuids: array
BluetoothEmulation.simulateAdvertisement → example
Simulates an advertisement packet described in |entry| being received by the central.
Params: entry: ScanEntry
BluetoothEmulation.simulateGATTOperationResponse → example
Simulates the response code from the peripheral with |address| for a GATT operation of |type|. The |code| value follows the HCI Error Codes from Bluetooth Core Specification Vol 2 Part D 1.3 List Of Error Codes.
Params: address: string, type: GATTOperationType, code: integer
BluetoothEmulation.simulateCharacteristicOperationResponse → example
Simulates the response from the characteristic with |characteristicId| for a characteristic operation of |type|. The |code| value follows the Error Codes from Bluetooth Core Specification Vol 3 Part F 3.4.1.1 Error Response. The |data| is expected to exist when simulating a successful read operation response.
Params: characteristicId: string, type: CharacteristicOperationType, code: integer, data?: string
BluetoothEmulation.simulateDescriptorOperationResponse → example
Simulates the response from the descriptor with |descriptorId| for a descriptor operation of |type|. The |code| value follows the Error Codes from Bluetooth Core Specification Vol 3 Part F 3.4.1.1 Error Response. The |data| is expected to exist when simulating a successful read operation response.
Params: descriptorId: string, type: DescriptorOperationType, code: integer, data?: string
BluetoothEmulation.addService → example
Adds a service with |serviceUuid| to the peripheral with |address|.
Params: address: string, serviceUuid: string
Returns: serviceId: string
BluetoothEmulation.removeService → example
Removes the service respresented by |serviceId| from the simulated central.
Params: serviceId: string
BluetoothEmulation.addCharacteristic → example
Adds a characteristic with |characteristicUuid| and |properties| to the service represented by |serviceId|.
Params: serviceId: string, characteristicUuid: string, properties: CharacteristicProperties
Returns: characteristicId: string
BluetoothEmulation.removeCharacteristic → example
Removes the characteristic respresented by |characteristicId| from the simulated central.
Params: characteristicId: string
BluetoothEmulation.addDescriptor → example
Adds a descriptor with |descriptorUuid| to the characteristic respresented by |characteristicId|.
Params: characteristicId: string, descriptorUuid: string
Returns: descriptorId: string
BluetoothEmulation.removeDescriptor → example
Removes the descriptor with |descriptorId| from the simulated central.
Params: descriptorId: string
BluetoothEmulation.simulateGATTDisconnection → example
Simulates a GATT disconnection from the peripheral with |address|.
Params: address: string

↑Events (3)

BluetoothEmulation.gattOperationReceived
Event for when a GATT operation of |type| to the peripheral with |address| happened.
Params: address: string, type: GATTOperationType
BluetoothEmulation.characteristicOperationReceived
Event for when a characteristic operation of |type| to the characteristic respresented by |characteristicId| happened. |data| and |writeType| is expected to exist when |type| is write.
Params: characteristicId: string, type: CharacteristicOperationType, data?: string, writeType?: CharacteristicWriteType
BluetoothEmulation.descriptorOperationReceived
Event for when a descriptor operation of |type| to the descriptor respresented by |descriptorId| happened. |data| is expected to exist when |type| is write.
Params: descriptorId: string, type: DescriptorOperationType, data?: string

↑Types (9)

CentralState (string)
Indicates the various states of Central.
GATTOperationType (string)
Indicates the various types of GATT event.
CharacteristicWriteType (string)
Indicates the various types of characteristic write.
CharacteristicOperationType (string)
Indicates the various types of characteristic operation.
DescriptorOperationType (string)
Indicates the various types of descriptor operation.
ManufacturerData (object)
Stores the manufacturer data
ScanRecord (object)
Stores the byte data of the advertisement packet sent by a Bluetooth device.
ScanEntry (object)
Stores the advertisement packet information that is sent by a Bluetooth device.
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.

↑Browser stable

The Browser domain defines methods and events for browser managing.

↑Commands (20)

Browser.setPermission → example
Set permission settings for given embedding and embedded origins.
Params: permission: PermissionDescriptor, setting: PermissionSetting, origin?: string, embeddedOrigin?: string, browserContextId?: BrowserContextID
Browser.grantPermissions → example
Grant specific permissions to the given origin and reject all others. Deprecated. Use setPermission instead.
Params: permissions: array, origin?: string, browserContextId?: BrowserContextID
Browser.resetPermissions → example
Reset all permission management for all origins.
Params: browserContextId?: BrowserContextID
Browser.setDownloadBehavior → example
Set the behavior when downloading a file.
Params: behavior: string, browserContextId?: BrowserContextID, downloadPath?: string, eventsEnabled?: boolean
Browser.cancelDownload → example
Cancel a download if in progress
Params: guid: string, browserContextId?: BrowserContextID
Browser.close → example
Close browser gracefully.
Browser.crash → example
Crashes browser on the main thread.
Browser.crashGpuProcess → example
Crashes GPU process.
Browser.getVersion → example
Returns version information.
Returns: protocolVersion: string, product: string, revision: string, userAgent: string, jsVersion: string
Browser.getBrowserCommandLine → example
Returns the command line switches for the browser process if, and only if --enable-automation is on the commandline.
Returns: arguments: array
Browser.getHistograms → example
Get Chrome histograms.
Params: query?: string, delta?: boolean
Returns: histograms: array
Browser.getHistogram → example
Get a Chrome histogram by name.
Params: name: string, delta?: boolean
Returns: histogram: Histogram
Browser.getWindowBounds → example
Get position and size of the browser window.
Params: windowId: WindowID
Returns: bounds: Bounds
Browser.getWindowForTarget → example
Get the browser window that contains the devtools target.
Params: targetId?: Target.TargetID
Returns: windowId: WindowID, bounds: Bounds
Browser.setWindowBounds → example
Set position and/or size of the browser window.
Params: windowId: WindowID, bounds: Bounds
Browser.setContentsSize → example
Set size of the browser contents resizing browser window as necessary.
Params: windowId: WindowID, width?: integer, height?: integer
Browser.setDockTile → example
Set dock tile details, platform-specific.
Params: badgeLabel?: string, image?: string
Browser.executeBrowserCommand → example
Invoke custom browser commands used by telemetry.
Params: commandId: BrowserCommandId
Browser.addPrivacySandboxEnrollmentOverride → example
Allows a site to use privacy sandbox features that require enrollment without the site actually being enrolled. Only supported on page targets.
Params: url: string
Browser.addPrivacySandboxCoordinatorKeyConfig → example
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.
Params: api: PrivacySandboxAPI, coordinatorOrigin: string, keyConfig: string, browserContextId?: BrowserContextID

↑Events (2)

Browser.downloadWillBegin
Fired when page is about to start a download.
Params: frameId: Page.FrameId, guid: string, url: string, suggestedFilename: string
Browser.downloadProgress
Fired when download makes progress. Last call has |done| == true.
Params: guid: string, totalBytes: number, receivedBytes: number, state: string, filePath?: string

↑Types (11)

BrowserContextID (string)
WindowID (integer)
WindowState (string)
The state of the browser window.
Bounds (object)
Browser window bounds information
PermissionType (string)
PermissionSetting (string)
PermissionDescriptor (object)
Definition of PermissionDescriptor defined in the Permissions API: https://w3c.github.io/permissions/#dom-permissiondescriptor.
BrowserCommandId (string)
Browser command ids used by executeBrowserCommand.
Bucket (object)
Chrome histogram bucket.
Histogram (object)
Chrome histogram.
PrivacySandboxAPI (string)

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

↑Commands (39)

CSS.addRule → example
Inserts a new rule with the given `ruleText` in a stylesheet with given `styleSheetId`, at the position specified by `location`.
Params: styleSheetId: DOM.StyleSheetId, ruleText: string, location: SourceRange, nodeForPropertySyntaxValidation?: DOM.NodeId
Returns: rule: CSSRule
CSS.collectClassNames → example
Returns all class names from specified stylesheet.
Params: styleSheetId: DOM.StyleSheetId
Returns: classNames: array
CSS.createStyleSheet → example
Creates a new special "via-inspector" stylesheet in the frame with given `frameId`.
Params: frameId: Page.FrameId, force?: boolean
Returns: styleSheetId: DOM.StyleSheetId
CSS.disable → example
Disables the CSS agent for the given page.
CSS.enable → example
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.
CSS.forcePseudoState → example
Ensures that the given node will have specified pseudo-classes whenever its style is computed by the browser.
Params: nodeId: DOM.NodeId, forcedPseudoClasses: array
CSS.forceStartingStyle → example
Ensures that the given node is in its starting-style state.
Params: nodeId: DOM.NodeId, forced: boolean
CSS.getBackgroundColors → example
Params: nodeId: DOM.NodeId
Returns: backgroundColors: array, computedFontSize: string, computedFontWeight: string
CSS.getComputedStyleForNode → example
Returns the computed style for a DOM node identified by `nodeId`.
Params: nodeId: DOM.NodeId
Returns: computedStyle: array, extraFields: ComputedStyleExtraFields
CSS.resolveValues → example
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. Note: this function currently does not resolve CSS random() function, it returns unmodified random() function parts.`
Params: values: array, nodeId: DOM.NodeId, propertyName?: string, pseudoType?: DOM.PseudoType, pseudoIdentifier?: string
Returns: results: array
CSS.getLonghandProperties → example
Params: shorthandName: string, value: string
Returns: longhandProperties: array
CSS.getInlineStylesForNode → example
Returns the styles defined inline (explicitly in the "style" attribute and implicitly, using DOM attributes) for a DOM node identified by `nodeId`.
Params: nodeId: DOM.NodeId
Returns: inlineStyle: CSSStyle, attributesStyle: CSSStyle
CSS.getAnimatedStylesForNode → example
Returns the styles coming from animations & transitions including the animation & transition styles coming from inheritance chain.
Params: nodeId: DOM.NodeId
Returns: animationStyles: array, transitionsStyle: CSSStyle, inherited: array
CSS.getMatchedStylesForNode → example
Returns requested styles for a DOM node identified by `nodeId`.
Params: nodeId: DOM.NodeId
Returns: inlineStyle: CSSStyle, attributesStyle: CSSStyle, matchedCSSRules: array, pseudoElements: array, inherited: array, inheritedPseudoElements: array, cssKeyframesRules: array, cssPositionTryRules: array, activePositionFallbackIndex: integer, cssPropertyRules: array, cssPropertyRegistrations: array, cssAtRules: array, parentLayoutNodeId: DOM.NodeId, cssFunctionRules: array
CSS.getEnvironmentVariables → example
Returns the values of the default UA-defined environment variables used in env()
Returns: environmentVariables: object
CSS.getMediaQueries → example
Returns all media queries parsed by the rendering engine.
Returns: medias: array
CSS.getPlatformFontsForNode → example
Requests information about platform fonts which we used to render child TextNodes in the given node.
Params: nodeId: DOM.NodeId
Returns: fonts: array
CSS.getStyleSheetText → example
Returns the current textual content for a stylesheet.
Params: styleSheetId: DOM.StyleSheetId
Returns: text: string
CSS.getLayersForNode → example
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.
Params: nodeId: DOM.NodeId
Returns: rootLayer: CSSLayerData
CSS.getLocationForSelector → example
Given a CSS selector text and a style sheet ID, getLocationForSelector returns an array of locations of the CSS selector in the style sheet.
Params: styleSheetId: DOM.StyleSheetId, selectorText: string
Returns: ranges: array
CSS.trackComputedStyleUpdatesForNode → example
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.
Params: nodeId?: DOM.NodeId
CSS.trackComputedStyleUpdates → example
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.
Params: propertiesToTrack: array
CSS.takeComputedStyleUpdates → example
Polls the next batch of computed style updates.
Returns: nodeIds: array
CSS.setEffectivePropertyValueForNode → example
Find a rule with the given active property for the given node and set the new value for this property
Params: nodeId: DOM.NodeId, propertyName: string, value: string
CSS.setPropertyRulePropertyName → example
Modifies the property rule property name.
Params: styleSheetId: DOM.StyleSheetId, range: SourceRange, propertyName: string
Returns: propertyName: Value
CSS.setKeyframeKey → example
Modifies the keyframe rule key text.
Params: styleSheetId: DOM.StyleSheetId, range: SourceRange, keyText: string
Returns: keyText: Value
CSS.setMediaText → example
Modifies the rule selector.
Params: styleSheetId: DOM.StyleSheetId, range: SourceRange, text: string
Returns: media: CSSMedia
CSS.setContainerQueryText → example
Modifies the expression of a container query. Deprecated. Use setContainerQueryConditionText instead.
Params: styleSheetId: DOM.StyleSheetId, range: SourceRange, text: string
Returns: containerQuery: CSSContainerQuery
CSS.setContainerQueryConditionText → example
Params: styleSheetId: DOM.StyleSheetId, range: SourceRange, text: string
Returns: containerQuery: CSSContainerQuery
CSS.setSupportsText → example
Modifies the expression of a supports at-rule.
Params: styleSheetId: DOM.StyleSheetId, range: SourceRange, text: string
Returns: supports: CSSSupports
CSS.setNavigationText → example
Modifies the expression of a navigation at-rule.
Params: styleSheetId: DOM.StyleSheetId, range: SourceRange, text: string
Returns: navigation: CSSNavigation
CSS.setScopeText → example
Modifies the expression of a scope at-rule.
Params: styleSheetId: DOM.StyleSheetId, range: SourceRange, text: string
Returns: scope: CSSScope
CSS.setRuleSelector → example
Modifies the rule selector.
Params: styleSheetId: DOM.StyleSheetId, range: SourceRange, selector: string
Returns: selectorList: SelectorList
CSS.setStyleSheetText → example
Sets the new stylesheet text.
Params: styleSheetId: DOM.StyleSheetId, text: string
Returns: sourceMapURL: string
CSS.setStyleTexts → example
Applies specified style edits one after another in the given order.
Params: edits: array, nodeForPropertySyntaxValidation?: DOM.NodeId
Returns: styles: array
CSS.startRuleUsageTracking → example
Enables the selector recording.
CSS.stopRuleUsageTracking → example
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: ruleUsage: array
CSS.takeCoverageDelta → example
Obtain list of rules that became used since last call to this method (or since start of coverage instrumentation).
Returns: coverage: array, timestamp: number
CSS.setLocalFontsEnabled → example
Enables/disables rendering of local CSS fonts (enabled by default).
Params: enabled: boolean

↑Events (6)

CSS.fontsUpdated
Fires whenever a web font is updated. A non-empty font parameter indicates a successfully loaded web font.
Params: font?: FontFace
CSS.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.
CSS.styleSheetAdded
Fired whenever an active document stylesheet is added.
Params: header: CSSStyleSheetHeader
CSS.styleSheetChanged
Fired whenever a stylesheet is changed as a result of the client operation.
Params: styleSheetId: DOM.StyleSheetId
CSS.styleSheetRemoved
Fired whenever an active document stylesheet is removed.
Params: styleSheetId: DOM.StyleSheetId
CSS.computedStyleUpdated
Params: nodeId: DOM.NodeId

↑Types (46)

StyleSheetOrigin (string)
Stylesheet type: "injected" for stylesheets injected via extension, "user-agent" for user-agent stylesheets, "inspector" for stylesheets created by the inspector (i.e. those holding the "via inspector" rules), "regular" for regular stylesheets.
PseudoElementMatches (object)
CSS rule collection for a single pseudo style.
CSSAnimationStyle (object)
CSS style coming from animations with the name of the animation.
InheritedStyleEntry (object)
Inherited CSS rule collection from ancestor node.
InheritedAnimatedStyleEntry (object)
Inherited CSS style collection for animated styles from ancestor node.
InheritedPseudoElementMatches (object)
Inherited pseudo element matches from pseudos of an ancestor node.
RuleMatch (object)
Match data for a CSS rule.
Value (object)
Data for a simple selector (these are delimited by commas in a selector list).
SpecificityComponent (object)
Contribution of an individual simple selector to specificity.
Specificity (object)
Specificity: https://drafts.csswg.org/selectors/#specificity-rules
SelectorList (object)
Selector list data.
CSSStyleSheetHeader (object)
CSS stylesheet metainformation.
CSSRule (object)
CSS rule representation.
CSSRuleType (string)
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.
RuleUsage (object)
CSS coverage information.
SourceRange (object)
Text range within a resource. All numbers are zero-based.
ShorthandEntry (object)
CSSComputedStyleProperty (object)
ComputedStyleExtraFields (object)
CSSStyle (object)
CSS style representation.
CSSProperty (object)
CSS property declaration data.
CSSMedia (object)
CSS media rule descriptor.
MediaQuery (object)
Media query descriptor.
MediaQueryExpression (object)
Media query expression descriptor.
CSSContainerQuery (object)
CSS container query rule descriptor.
CSSSupports (object)
CSS Supports at-rule descriptor.
CSSNavigation (object)
CSS Navigation at-rule descriptor.
CSSScope (object)
CSS Scope at-rule descriptor.
CSSLayer (object)
CSS Layer at-rule descriptor.
CSSStartingStyle (object)
CSS Starting Style at-rule descriptor.
CSSLayerData (object)
CSS Layer data.
PlatformFontUsage (object)
Information about amount of glyphs that were rendered with given font.
FontVariationAxis (object)
Information about font variation axes for variable fonts
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.
CSSTryRule (object)
CSS try rule representation.
CSSPositionTryRule (object)
CSS @position-try rule representation.
CSSKeyframesRule (object)
CSS keyframes rule representation.
CSSPropertyRegistration (object)
Representation of a custom property registration through CSS.registerProperty
CSSAtRule (object)
CSS generic @rule representation.
CSSPropertyRule (object)
CSS property at-rule representation.
CSSFunctionParameter (object)
CSS function argument representation.
CSSFunctionConditionNode (object)
CSS function conditional block representation.
CSSFunctionNode (object)
Section of the body of a CSS function rule.
CSSFunctionRule (object)
CSS function at-rule representation.
CSSKeyframeRule (object)
CSS keyframe rule representation.
StyleDeclarationEdit (object)
A descriptor of operation to mutate style declaration text.

↑CacheStorage experimental

↑Commands (5)

CacheStorage.deleteCache → example
Deletes a cache.
Params: cacheId: CacheId
CacheStorage.deleteEntry → example
Deletes a cache entry.
Params: cacheId: CacheId, request: string
CacheStorage.requestCacheNames → example
Requests cache names.
Params: securityOrigin?: string, storageKey?: string, storageBucket?: Storage.StorageBucket
Returns: caches: array
CacheStorage.requestCachedResponse → example
Fetches cache entry.
Params: cacheId: CacheId, requestURL: string, requestHeaders: array
Returns: response: CachedResponse
CacheStorage.requestEntries → example
Requests data from cache.
Params: cacheId: CacheId, skipCount?: integer, pageSize?: integer, pathFilter?: string
Returns: cacheDataEntries: array, returnCount: number

↑Types (6)

CacheId (string)
Unique identifier of the Cache object.
CachedResponseType (string)
type of HTTP response cached
DataEntry (object)
Data entry.
Cache (object)
Cache identifier.
Header (object)
CachedResponse (object)
Cached response

↑Cast experimental

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

↑Commands (6)

Cast.enable → example
Starts observing for sinks that can be used for tab mirroring, and if set, sinks compatible with |presentationUrl| as well. When sinks are found, a |sinksUpdated| event is fired. Also starts observing for issue messages. When an issue is added or removed, an |issueUpdated| event is fired.
Params: presentationUrl?: string
Cast.disable → example
Stops observing for sinks and issues.
Cast.setSinkToUse → example
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.
Params: sinkName: string
Cast.startDesktopMirroring → example
Starts mirroring the desktop to the sink.
Params: sinkName: string
Cast.startTabMirroring → example
Starts mirroring the tab to the sink.
Params: sinkName: string
Cast.stopCasting → example
Stops the active Cast session on the sink.
Params: sinkName: string

↑Events (2)

Cast.sinksUpdated
This is fired whenever the list of available sinks changes. A sink is a device or a software surface that you can cast to.
Params: sinks: array
Cast.issueUpdated
This is fired whenever the outstanding issue/error message changes. |issueMessage| is empty if there is no issue.
Params: issueMessage: string

↑Types (1)

Sink (object)

↑Console deprecated

This domain is deprecated - use Runtime or Log instead.

↑Commands (3)

Console.clearMessages → example
Does nothing.
Console.disable → example
Disables console domain, prevents further console messages from being reported to the client.
Console.enable → example
Enables console domain, sends the messages collected so far to the client by means of the `messageAdded` notification.

↑Events (1)

Console.messageAdded
Issued when new console message is added.
Params: message: ConsoleMessage

↑Types (1)

ConsoleMessage (object)
Console message.

↑CrashReportContext experimental

This domain exposes the current state of the CrashReportContext API.

↑Commands (1)

CrashReportContext.getEntries → example
Returns all entries in the CrashReportContext across all frames in the page.
Returns: entries: array

↑Types (1)

CrashReportContextEntry (object)
Key-value pair in CrashReportContext.

↑DOM stable

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.

↑Commands (53)

DOM.collectClassNamesFromSubtree → example
Collects class names for the node with given id and all of it's child nodes.
Params: nodeId: NodeId
Returns: classNames: array
DOM.copyTo → example
Creates a deep copy of the specified node and places it into the target container before the given anchor.
Params: nodeId: NodeId, targetNodeId: NodeId, insertBeforeNodeId?: NodeId
Returns: nodeId: NodeId
DOM.describeNode → example
Describes node given its id, does not require domain to be enabled. Does not start tracking any objects, can be used for automation.
Params: nodeId?: NodeId, backendNodeId?: BackendNodeId, objectId?: Runtime.RemoteObjectId, depth?: integer, pierce?: boolean
Returns: node: Node
DOM.scrollIntoViewIfNeeded → example
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.
Params: nodeId?: NodeId, backendNodeId?: BackendNodeId, objectId?: Runtime.RemoteObjectId, rect?: Rect
DOM.disable → example
Disables DOM agent for the given page.
DOM.discardSearchResults → example
Discards search results from the session with the given id. `getSearchResults` should no longer be called for that search.
Params: searchId: string
DOM.enable → example
Enables DOM agent for the given page.
Params: includeWhitespace?: string
DOM.focus → example
Focuses the given element.
Params: nodeId?: NodeId, backendNodeId?: BackendNodeId, objectId?: Runtime.RemoteObjectId
DOM.getAttributes → example
Returns attributes for the specified node.
Params: nodeId: NodeId
Returns: attributes: array
DOM.getBoxModel → example
Returns boxes for the given node.
Params: nodeId?: NodeId, backendNodeId?: BackendNodeId, objectId?: Runtime.RemoteObjectId
Returns: model: BoxModel
DOM.getContentQuads → example
Returns quads that describe node position on the page. This method might return multiple quads for inline nodes.
Params: nodeId?: NodeId, backendNodeId?: BackendNodeId, objectId?: Runtime.RemoteObjectId
Returns: quads: array
DOM.getDocument → example
Returns the root DOM node (and optionally the subtree) to the caller. Implicitly enables the DOM domain events for the current target.
Params: depth?: integer, pierce?: boolean
Returns: root: Node
DOM.getFlattenedDocument → example
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.
Params: depth?: integer, pierce?: boolean
Returns: nodes: array
DOM.getNodesForSubtreeByStyle → example
Finds nodes with a given computed style in a subtree.
Params: nodeId: NodeId, computedStyles: array, pierce?: boolean
Returns: nodeIds: array
DOM.getNodeForLocation → example
Returns node id at given location. Depending on whether DOM domain is enabled, nodeId is either returned or not.
Params: x: integer, y: integer, includeUserAgentShadowDOM?: boolean, ignorePointerEventsNone?: boolean
Returns: backendNodeId: BackendNodeId, frameId: Page.FrameId, nodeId: NodeId
DOM.getOuterHTML → example
Returns node's HTML markup.
Params: nodeId?: NodeId, backendNodeId?: BackendNodeId, objectId?: Runtime.RemoteObjectId, includeShadowDOM?: boolean
Returns: outerHTML: string
DOM.getRelayoutBoundary → example
Returns the id of the nearest ancestor that is a relayout boundary.
Params: nodeId: NodeId
Returns: nodeId: NodeId
DOM.getSearchResults → example
Returns search results from given `fromIndex` to given `toIndex` from the search with the given identifier.
Params: searchId: string, fromIndex: integer, toIndex: integer
Returns: nodeIds: array
DOM.hideHighlight → example
Hides any highlight.
DOM.highlightNode → example
Highlights DOM node.
DOM.highlightRect → example
Highlights given rectangle.
DOM.markUndoableState → example
Marks last undoable state.
DOM.moveTo → example
Moves node into the new container, places it before the given anchor.
Params: nodeId: NodeId, targetNodeId: NodeId, insertBeforeNodeId?: NodeId
Returns: nodeId: NodeId
DOM.performSearch → example
Searches for a given string in the DOM tree. Use `getSearchResults` to access search results or `cancelSearch` to end this search session.
Params: query: string, includeUserAgentShadowDOM?: boolean
Returns: searchId: string, resultCount: integer
DOM.pushNodeByPathToFrontend → example
Requests that the node is sent to the caller given its path. // FIXME, use XPath
Params: path: string
Returns: nodeId: NodeId
DOM.pushNodesByBackendIdsToFrontend → example
Requests that a batch of nodes is sent to the caller given their backend node ids.
Params: backendNodeIds: array
Returns: nodeIds: array
DOM.querySelector → example
Executes `querySelector` on a given node.
Params: nodeId: NodeId, selector: string
Returns: nodeId: NodeId
DOM.querySelectorAll → example
Executes `querySelectorAll` on a given node.
Params: nodeId: NodeId, selector: string
Returns: nodeIds: array
DOM.getTopLayerElements → example
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.
Returns: nodeIds: array
DOM.getElementByRelation → example
Returns the NodeId of the matched element according to certain relations.
Params: nodeId: NodeId, relation: string
Returns: nodeId: NodeId
DOM.redo → example
Re-does the last undone action.
DOM.removeAttribute → example
Removes attribute with given name from an element with given id.
Params: nodeId: NodeId, name: string
DOM.removeNode → example
Removes node with given id.
Params: nodeId: NodeId
DOM.requestChildNodes → example
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.
Params: nodeId: NodeId, depth?: integer, pierce?: boolean
DOM.requestNode → example
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.
Params: objectId: Runtime.RemoteObjectId
Returns: nodeId: NodeId
DOM.resolveNode → example
Resolves the JavaScript node object for a given NodeId or BackendNodeId.
Params: nodeId?: NodeId, backendNodeId?: DOM.BackendNodeId, objectGroup?: string, executionContextId?: Runtime.ExecutionContextId
Returns: object: Runtime.RemoteObject
DOM.setAttributeValue → example
Sets attribute for an element with given id.
Params: nodeId: NodeId, name: string, value: string
DOM.setAttributesAsText → example
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.
Params: nodeId: NodeId, text: string, name?: string
DOM.setFileInputFiles → example
Sets files for the given file input element.
Params: files: array, nodeId?: NodeId, backendNodeId?: BackendNodeId, objectId?: Runtime.RemoteObjectId
DOM.setNodeStackTracesEnabled → example
Sets if stack traces should be captured for Nodes. See `Node.getNodeStackTraces`. Default is disabled.
Params: enable: boolean
DOM.getNodeStackTraces → example
Gets stack traces associated with a Node. As of now, only provides stack trace for Node creation.
Params: nodeId: NodeId
Returns: creation: Runtime.StackTrace
DOM.getFileInfo → example
Returns file information for the given File wrapper.
Params: objectId: Runtime.RemoteObjectId
Returns: path: string
DOM.getDetachedDomNodes → example
Returns list of detached nodes
Returns: detachedNodes: array
DOM.setInspectedNode → example
Enables console to refer to the node with given id via $x (see Command Line API for more details $x functions).
Params: nodeId: NodeId
DOM.setNodeName → example
Sets node name for a node with given id.
Params: nodeId: NodeId, name: string
Returns: nodeId: NodeId
DOM.setNodeValue → example
Sets node value for a node with given id.
Params: nodeId: NodeId, value: string
DOM.setOuterHTML → example
Sets node HTML markup, returns new node id.
Params: nodeId: NodeId, outerHTML: string
DOM.undo → example
Undoes the last performed action.
DOM.getFrameOwner → example
Returns iframe node that owns iframe with the given domain.
Params: frameId: Page.FrameId
Returns: backendNodeId: BackendNodeId, nodeId: NodeId
DOM.getContainerForNode → example
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.
Params: nodeId: NodeId, containerName?: string, physicalAxes?: PhysicalAxes, logicalAxes?: LogicalAxes, queriesScrollState?: boolean, queriesAnchored?: boolean
Returns: nodeId: NodeId
DOM.getQueryingDescendantsForContainer → example
Returns the descendants of a container query container that have container queries against this container.
Params: nodeId: NodeId
Returns: nodeIds: array
DOM.getAnchorElement → example
Returns the target anchor element of the given anchor query according to https://www.w3.org/TR/css-anchor-position-1/#target.
Params: nodeId: NodeId, anchorSpecifier?: string
Returns: nodeId: NodeId
DOM.forceShowPopover → example
When enabling, this API force-opens the popover identified by nodeId and keeps it open until disabled.
Params: nodeId: NodeId, enable: boolean, invokerNodeId?: BackendNodeId
Returns: nodeIds: array

↑Events (19)

DOM.attributeModified
Fired when `Element`'s attribute is modified.
Params: nodeId: NodeId, name: string, value: string
DOM.adoptedStyleSheetsModified
Fired when `Element`'s adoptedStyleSheets are modified.
Params: nodeId: NodeId, adoptedStyleSheets: array
DOM.attributeRemoved
Fired when `Element`'s attribute is removed.
Params: nodeId: NodeId, name: string
DOM.characterDataModified
Mirrors `DOMCharacterDataModified` event.
Params: nodeId: NodeId, characterData: string
DOM.childNodeCountUpdated
Fired when `Container`'s child node count has changed.
Params: nodeId: NodeId, childNodeCount: integer
DOM.childNodeInserted
Mirrors `DOMNodeInserted` event.
Params: parentNodeId: NodeId, previousNodeId: NodeId, node: Node
DOM.childNodeRemoved
Mirrors `DOMNodeRemoved` event.
Params: parentNodeId: NodeId, nodeId: NodeId
DOM.distributedNodesUpdated
Called when distribution is changed.
Params: insertionPointId: NodeId, distributedNodes: array
DOM.documentUpdated
Fired when `Document` has been totally updated. Node ids are no longer valid.
DOM.inlineStyleInvalidated
Fired when `Element`'s inline style is modified via a CSS property modification.
Params: nodeIds: array
DOM.pseudoElementAdded
Called when a pseudo element is added to an element.
Params: parentId: NodeId, pseudoElement: Node
DOM.topLayerElementsUpdated
Called when top layer elements are changed.
DOM.scrollableFlagUpdated
Fired when a node's scrollability state changes.
Params: nodeId: DOM.NodeId, isScrollable: boolean
DOM.adRelatedStateUpdated
Fired when a node's ad related state changes.
Params: nodeId: DOM.NodeId, adProvenance?: Network.AdProvenance
DOM.affectedByStartingStylesFlagUpdated
Fired when a node's starting styles changes.
Params: nodeId: DOM.NodeId, affectedByStartingStyles: boolean
DOM.pseudoElementRemoved
Called when a pseudo element is removed from an element.
Params: parentId: NodeId, pseudoElementId: NodeId
DOM.setChildNodes
Fired when backend wants to provide client with the missing DOM structure. This happens upon most of the calls requesting node ids.
Params: parentId: NodeId, nodes: array
DOM.shadowRootPopped
Called when shadow root is popped from the element.
Params: hostId: NodeId, rootId: NodeId
DOM.shadowRootPushed
Called when shadow root is pushed into the element.
Params: hostId: NodeId, root: Node

↑Types (18)

NodeId (integer)
Unique DOM node identifier.
BackendNodeId (integer)
Unique DOM node identifier used to reference a node that may not have been pushed to the front-end.
StyleSheetId (string)
Unique identifier for a CSS stylesheet.
BackendNode (object)
Backend node with a friendly name.
PseudoType (string)
Pseudo element type.
ShadowRootType (string)
Shadow root type.
CompatibilityMode (string)
Document compatibility mode.
PhysicalAxes (string)
ContainerSelector physical axes
LogicalAxes (string)
ContainerSelector logical axes
ScrollOrientation (string)
Physical scroll orientation
Node (object)
DOM interaction is implemented in terms of mirror objects that represent the actual DOM nodes. DOMNode is a base node mirror type.
DetachedElementInfo (object)
A structure to hold the top-level node of a detached tree and an array of its retained descendants.
RGBA (object)
A structure holding an RGBA color.
Quad (array)
An array of quad vertices, x immediately followed by y for each point, points clock-wise.
BoxModel (object)
Box model.
ShapeOutsideInfo (object)
CSS Shape Outside details.
Rect (object)
Rectangle.
CSSComputedStyleProperty (object)

↑DOMDebugger stable

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.

↑Commands (10)

DOMDebugger.getEventListeners → example
Returns event listeners of the given object.
Params: objectId: Runtime.RemoteObjectId, depth?: integer, pierce?: boolean
Returns: listeners: array
DOMDebugger.removeDOMBreakpoint → example
Removes DOM breakpoint that was set using `setDOMBreakpoint`.
Params: nodeId: DOM.NodeId, type: DOMBreakpointType
DOMDebugger.removeEventListenerBreakpoint → example
Removes breakpoint on particular DOM event.
Params: eventName: string, targetName?: string
DOMDebugger.removeInstrumentationBreakpoint → example
Removes breakpoint on particular native event.
Params: eventName: string
DOMDebugger.removeXHRBreakpoint → example
Removes breakpoint from XMLHttpRequest.
Params: url: string
DOMDebugger.setBreakOnCSPViolation → example
Sets breakpoint on particular CSP violations.
Params: violationTypes: array
DOMDebugger.setDOMBreakpoint → example
Sets breakpoint on particular operation with DOM.
Params: nodeId: DOM.NodeId, type: DOMBreakpointType
DOMDebugger.setEventListenerBreakpoint → example
Sets breakpoint on particular DOM event.
Params: eventName: string, targetName?: string
DOMDebugger.setInstrumentationBreakpoint → example
Sets breakpoint on particular native event.
Params: eventName: string
DOMDebugger.setXHRBreakpoint → example
Sets breakpoint on XMLHttpRequest.
Params: url: string

↑Types (3)

DOMBreakpointType (string)
DOM breakpoint type.
CSPViolationType (string)
CSP Violation type.
EventListener (object)
Object event listener.

↑DOMSnapshot experimental

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

↑Commands (4)

DOMSnapshot.disable → example
Disables DOM snapshot agent for the given page.
DOMSnapshot.enable → example
Enables DOM snapshot agent for the given page.
DOMSnapshot.getSnapshot → example
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.
Params: computedStyleWhitelist: array, includeEventListeners?: boolean, includePaintOrder?: boolean, includeUserAgentShadowTree?: boolean
Returns: domNodes: array, layoutTreeNodes: array, computedStyles: array
DOMSnapshot.captureSnapshot → example
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.
Params: computedStyles: array, includePaintOrder?: boolean, includeDOMRects?: boolean, includeBlendedBackgroundColors?: boolean, includeTextColorOpacities?: boolean
Returns: documents: array, strings: array

↑Types (15)

DOMNode (object)
A Node in the DOM tree.
InlineTextBox (object)
Details of post layout rendered text positions. The exact layout should not be regarded as stable and may change between versions.
LayoutTreeNode (object)
Details of an element in the DOM tree with a LayoutObject.
ComputedStyle (object)
A subset of the full ComputedStyle as defined by the request whitelist.
NameValue (object)
A name/value pair.
StringIndex (integer)
Index of the string in the strings table.
ArrayOfStrings (array)
Index of the string in the strings table.
RareStringData (object)
Data that is only present on rare nodes.
RareBooleanData (object)
RareIntegerData (object)
Rectangle (array)
DocumentSnapshot (object)
Document snapshot.
NodeTreeSnapshot (object)
Table containing nodes.
LayoutTreeSnapshot (object)
Table of details of an element in the DOM tree with a LayoutObject.
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.

↑DOMStorage experimental

Query and modify DOM storage.

↑Commands (6)

DOMStorage.clear → example
Params: storageId: StorageId
DOMStorage.disable → example
Disables storage tracking, prevents storage events from being sent to the client.
DOMStorage.enable → example
Enables storage tracking, storage events will now be delivered to the client.
DOMStorage.getDOMStorageItems → example
Params: storageId: StorageId
Returns: entries: array
DOMStorage.removeDOMStorageItem → example
Params: storageId: StorageId, key: string
DOMStorage.setDOMStorageItem → example
Params: storageId: StorageId, key: string, value: string

↑Events (4)

DOMStorage.domStorageItemAdded
Params: storageId: StorageId, key: string, newValue: string
DOMStorage.domStorageItemRemoved
Params: storageId: StorageId, key: string
DOMStorage.domStorageItemUpdated
Params: storageId: StorageId, key: string, oldValue: string, newValue: string
DOMStorage.domStorageItemsCleared
Params: storageId: StorageId

↑Types (3)

SerializedStorageKey (string)
StorageId (object)
DOM Storage identifier.
Item (array)
DOM Storage item.

↑Debugger stable

Debugger domain exposes JavaScript debugging capabilities. It allows setting and removing breakpoints, stepping through execution, exploring stack traces, etc.

↑Commands (33)

Debugger.continueToLocation → example
Continues execution until specific location is reached.
Params: location: Location, targetCallFrames?: string
Debugger.disable → example
Disables debugger for given page.
Debugger.enable → example
Enables debugger for the given page. Clients should not assume that the debugging has been enabled until the result for this command is received.
Params: maxScriptsCacheSize?: number
Returns: debuggerId: Runtime.UniqueDebuggerId
Debugger.evaluateOnCallFrame → example
Evaluates expression on a given call frame.
Params: callFrameId: CallFrameId, expression: string, objectGroup?: string, includeCommandLineAPI?: boolean, silent?: boolean, returnByValue?: boolean, generatePreview?: boolean, throwOnSideEffect?: boolean, timeout?: Runtime.TimeDelta
Returns: result: Runtime.RemoteObject, exceptionDetails: Runtime.ExceptionDetails
Debugger.getPossibleBreakpoints → example
Returns possible locations for breakpoint. scriptId in start and end range locations should be the same.
Params: start: Location, end?: Location, restrictToFunction?: boolean
Returns: locations: array
Debugger.getScriptSource → example
Returns source for the script with given id.
Params: scriptId: Runtime.ScriptId
Returns: scriptSource: string, bytecode: string
Debugger.disassembleWasmModule → example
Params: scriptId: Runtime.ScriptId
Returns: streamId: string, totalNumberOfLines: integer, functionBodyOffsets: array, chunk: WasmDisassemblyChunk
Debugger.nextWasmDisassemblyChunk → example
Disassemble the next chunk of lines for the module corresponding to the stream. If disassembly is complete, this API will invalidate the streamId and return an empty chunk. Any subsequent calls for the now invalid stream will return errors.
Params: streamId: string
Returns: chunk: WasmDisassemblyChunk
Debugger.getWasmBytecode → example
This command is deprecated. Use getScriptSource instead.
Params: scriptId: Runtime.ScriptId
Returns: bytecode: string
Debugger.getStackTrace → example
Returns stack trace with given `stackTraceId`.
Params: stackTraceId: Runtime.StackTraceId
Returns: stackTrace: Runtime.StackTrace
Debugger.pause → example
Stops on the next JavaScript statement.
Debugger.pauseOnAsyncCall → example
Params: parentStackTraceId: Runtime.StackTraceId
Debugger.removeBreakpoint → example
Removes JavaScript breakpoint.
Params: breakpointId: BreakpointId
Debugger.restartFrame → example
Restarts particular call frame from the beginning. The old, deprecated behavior of `restartFrame` is to stay paused and allow further CDP commands after a restart was scheduled. This can cause problems with restarting, so we now continue execution immediatly after it has been scheduled until we reach the beginning of the restarted frame. To stay back-wards compatible, `restartFrame` now expects a `mode` parameter to be present. If the `mode` parameter is missing, `restartFrame` errors out. The various return values are deprecated and `callFrames` is always empty. Use the call frames from the `Debugger#paused` events instead, that fires once V8 pauses at the beginning of the restarted function.
Params: callFrameId: CallFrameId, mode?: string
Returns: callFrames: array, asyncStackTrace: Runtime.StackTrace, asyncStackTraceId: Runtime.StackTraceId
Debugger.resume → example
Resumes JavaScript execution.
Params: terminateOnResume?: boolean
Debugger.searchInContent → example
Searches for given string in script content.
Params: scriptId: Runtime.ScriptId, query: string, caseSensitive?: boolean, isRegex?: boolean
Returns: result: array
Debugger.setAsyncCallStackDepth → example
Enables or disables async call stacks tracking.
Params: maxDepth: integer
Debugger.setBlackboxExecutionContexts → example
Replace previous blackbox execution contexts with passed ones. Forces backend to skip stepping/pausing in scripts in these execution contexts. VM will try to leave blackboxed script by performing 'step in' several times, finally resorting to 'step out' if unsuccessful.
Params: uniqueIds: array
Debugger.setBlackboxPatterns → example
Replace previous blackbox patterns with passed ones. Forces backend to skip stepping/pausing in scripts with url matching one of the patterns. VM will try to leave blackboxed script by performing 'step in' several times, finally resorting to 'step out' if unsuccessful.
Params: patterns: array, skipAnonymous?: boolean
Debugger.setBlackboxedRanges → example
Makes backend skip steps in the script in blackboxed ranges. VM will try leave blacklisted scripts by performing 'step in' several times, finally resorting to 'step out' if unsuccessful. Positions array contains positions where blackbox state is changed. First interval isn't blackboxed. Array should be sorted.
Params: scriptId: Runtime.ScriptId, positions: array
Debugger.setBreakpoint → example
Sets JavaScript breakpoint at a given location.
Params: location: Location, condition?: string
Returns: breakpointId: BreakpointId, actualLocation: Location
Debugger.setInstrumentationBreakpoint → example
Sets instrumentation breakpoint.
Params: instrumentation: string
Returns: breakpointId: BreakpointId
Debugger.setBreakpointByUrl → example
Sets JavaScript breakpoint at given location specified either by URL or URL regex. Once this command is issued, all existing parsed scripts will have breakpoints resolved and returned in `locations` property. Further matching script parsing will result in subsequent `breakpointResolved` events issued. This logical breakpoint will survive page reloads.
Params: lineNumber: integer, url?: string, urlRegex?: string, scriptHash?: string, columnNumber?: integer, condition?: string
Returns: breakpointId: BreakpointId, locations: array
Debugger.setBreakpointOnFunctionCall → example
Sets JavaScript breakpoint before each call to the given function. If another function was created from the same source as a given one, calling it will also trigger the breakpoint.
Params: objectId: Runtime.RemoteObjectId, condition?: string
Returns: breakpointId: BreakpointId
Debugger.setBreakpointsActive → example
Activates / deactivates all breakpoints on the page.
Params: active: boolean
Debugger.setPauseOnExceptions → example
Defines pause on exceptions state. Can be set to stop on all exceptions, uncaught exceptions, or caught exceptions, no exceptions. Initial pause on exceptions state is `none`.
Params: state: string
Debugger.setReturnValue → example
Changes return value in top frame. Available only at return break position.
Params: newValue: Runtime.CallArgument
Debugger.setScriptSource → example
Edits JavaScript source live. In general, functions that are currently on the stack can not be edited with a single exception: If the edited function is the top-most stack frame and that is the only activation of that function on the stack. In this case the live edit will be successful and a `Debugger.restartFrame` for the top-most function is automatically triggered.
Params: scriptId: Runtime.ScriptId, scriptSource: string, dryRun?: boolean, allowTopFrameEditing?: boolean
Returns: callFrames: array, stackChanged: boolean, asyncStackTrace: Runtime.StackTrace, asyncStackTraceId: Runtime.StackTraceId, status: string, exceptionDetails: Runtime.ExceptionDetails
Debugger.setSkipAllPauses → example
Makes page not interrupt on any pauses (breakpoint, exception, dom exception etc).
Params: skip: boolean
Debugger.setVariableValue → example
Changes value of variable in a callframe. Object-based scopes are not supported and must be mutated manually.
Params: scopeNumber: integer, variableName: string, newValue: Runtime.CallArgument, callFrameId: CallFrameId
Debugger.stepInto → example
Steps into the function call.
Params: breakOnAsyncCall?: boolean, skipList?: array
Debugger.stepOut → example
Steps out of the function call.
Debugger.stepOver → example
Steps over the statement.
Params: skipList?: array

↑Events (5)

Debugger.breakpointResolved
Fired when breakpoint is resolved to an actual script and location. Deprecated in favor of `resolvedBreakpoints` in the `scriptParsed` event.
Params: breakpointId: BreakpointId, location: Location
Debugger.paused
Fired when the virtual machine stopped on breakpoint or exception or any other stop criteria.
Params: callFrames: array, reason: string, data?: object, hitBreakpoints?: array, asyncStackTrace?: Runtime.StackTrace, asyncStackTraceId?: Runtime.StackTraceId, asyncCallStackTraceId?: Runtime.StackTraceId
Debugger.resumed
Fired when the virtual machine resumed execution.
Debugger.scriptFailedToParse
Fired when virtual machine fails to parse the script.
Params: scriptId: Runtime.ScriptId, url: string, startLine: integer, startColumn: integer, endLine: integer, endColumn: integer, executionContextId: Runtime.ExecutionContextId, hash: string, buildId: string, executionContextAuxData?: object, sourceMapURL?: string, hasSourceURL?: boolean, isModule?: boolean, length?: integer, stackTrace?: Runtime.StackTrace, codeOffset?: integer, scriptLanguage?: Debugger.ScriptLanguage, embedderName?: string
Debugger.scriptParsed
Fired when virtual machine parses script. This event is also fired for all known and uncollected scripts upon enabling debugger.
Params: scriptId: Runtime.ScriptId, url: string, startLine: integer, startColumn: integer, endLine: integer, endColumn: integer, executionContextId: Runtime.ExecutionContextId, hash: string, buildId: string, executionContextAuxData?: object, isLiveEdit?: boolean, sourceMapURL?: string, hasSourceURL?: boolean, isModule?: boolean, length?: integer, stackTrace?: Runtime.StackTrace, codeOffset?: integer, scriptLanguage?: Debugger.ScriptLanguage, debugSymbols?: array, embedderName?: string, resolvedBreakpoints?: array

↑Types (13)

BreakpointId (string)
Breakpoint identifier.
CallFrameId (string)
Call frame identifier.
Location (object)
Location in the source code.
ScriptPosition (object)
Location in the source code.
LocationRange (object)
Location range within one script.
CallFrame (object)
JavaScript call frame. Array of call frames form the call stack.
Scope (object)
Scope description.
SearchMatch (object)
Search match for resource.
BreakLocation (object)
WasmDisassemblyChunk (object)
ScriptLanguage (string)
Enum of possible script languages.
DebugSymbols (object)
Debug symbols available for a wasm script.
ResolvedBreakpoint (object)

↑DeviceAccess experimental

↑Commands (4)

DeviceAccess.enable → example
Enable events in this domain.
DeviceAccess.disable → example
Disable events in this domain.
DeviceAccess.selectPrompt → example
Select a device in response to a DeviceAccess.deviceRequestPrompted event.
Params: id: RequestId, deviceId: DeviceId
DeviceAccess.cancelPrompt → example
Cancel a prompt in response to a DeviceAccess.deviceRequestPrompted event.
Params: id: RequestId

↑Events (1)

DeviceAccess.deviceRequestPrompted
A device request opened a user prompt to select a device. Respond with the selectPrompt or cancelPrompt command.
Params: id: RequestId, devices: array

↑Types (3)

RequestId (string)
Device request id.
DeviceId (string)
A device id.
PromptDevice (object)
Device information displayed in a user prompt to select a device.

↑DeviceOrientation experimental

↑Commands (2)

DeviceOrientation.clearDeviceOrientationOverride → example
Clears the overridden Device Orientation.
DeviceOrientation.setDeviceOrientationOverride → example
Overrides the Device Orientation.
Params: alpha: number, beta: number, gamma: number

↑Emulation stable

This domain emulates different environments for the page.

↑Commands (47)

Emulation.canEmulate → example
Tells whether emulation is supported.
Returns: result: boolean
Emulation.clearDeviceMetricsOverride → example
Clears the overridden device metrics.
Emulation.clearGeolocationOverride → example
Clears the overridden Geolocation Position and Error.
Emulation.resetPageScaleFactor → example
Requests that page scale factor is reset to initial values.
Emulation.setFocusEmulationEnabled → example
Enables or disables simulating a focused and active page.
Params: enabled: boolean
Emulation.setAutoDarkModeOverride → example
Automatically render all web contents using a dark theme.
Params: enabled?: boolean
Emulation.setCPUThrottlingRate → example
Enables CPU throttling to emulate slow CPUs.
Params: rate: number
Emulation.setDefaultBackgroundColorOverride → example
Sets or clears an override of the default background color of the frame. This override is used if the content does not specify one.
Params: color?: DOM.RGBA
Emulation.setSafeAreaInsetsOverride → example
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.
Params: insets: SafeAreaInsets
Emulation.setDeviceMetricsOverride → example
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).
Params: width: integer, height: integer, deviceScaleFactor: number, mobile: boolean, scale?: number, screenWidth?: integer, screenHeight?: integer, positionX?: integer, positionY?: integer, dontSetVisibleSize?: boolean, screenOrientation?: ScreenOrientation, viewport?: Page.Viewport, displayFeature?: DisplayFeature, devicePosture?: DevicePosture, scrollbarType?: string, screenOrientationLockEmulation?: boolean
Emulation.setDevicePostureOverride → example
Start reporting the given posture value to the Device Posture API. This override can also be set in setDeviceMetricsOverride().
Params: posture: DevicePosture
Emulation.clearDevicePostureOverride → example
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.
Emulation.setDisplayFeaturesOverride → example
Start using the given display features to pupulate the Viewport Segments API. This override can also be set in setDeviceMetricsOverride().
Params: features: array
Emulation.clearDisplayFeaturesOverride → example
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.
Emulation.setScrollbarsHidden → example
Params: hidden: boolean
Emulation.setDocumentCookieDisabled → example
Params: disabled: boolean
Emulation.setEmitTouchEventsForMouse → example
Params: enabled: boolean, configuration?: string
Emulation.setEmulatedMedia → example
Emulates the given media type or media feature for CSS media queries.
Params: media?: string, features?: array
Emulation.setEmulatedVisionDeficiency → example
Emulates the given vision deficiency.
Params: type: string
Emulation.setEmulatedOSTextScale → example
Emulates the given OS text scale.
Params: scale?: number
Emulation.setGeolocationOverride → example
Overrides the Geolocation Position or Error. Omitting latitude, longitude or accuracy emulates position unavailable.
Params: latitude?: number, longitude?: number, accuracy?: number, altitude?: number, altitudeAccuracy?: number, heading?: number, speed?: number
Emulation.getOverriddenSensorInformation → example
Params: type: SensorType
Returns: requestedSamplingFrequency: number
Emulation.setSensorOverrideEnabled → example
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.
Params: enabled: boolean, type: SensorType, metadata?: SensorMetadata
Emulation.setSensorOverrideReadings → example
Updates the sensor readings reported by a sensor type previously overridden by setSensorOverrideEnabled.
Params: type: SensorType, reading: SensorReading
Emulation.setPressureSourceOverrideEnabled → example
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.
Params: enabled: boolean, source: PressureSource, metadata?: PressureMetadata
Emulation.setPressureStateOverride → example
Provides a given pressure state that will be processed and eventually be delivered to PressureObserver users. |source| must have been previously overridden by setPressureSourceOverrideEnabled.
Params: source: PressureSource, state: PressureState
Emulation.setIdleOverride → example
Overrides the Idle state.
Params: isUserActive: boolean, isScreenUnlocked: boolean
Emulation.clearIdleOverride → example
Clears Idle state overrides.
Emulation.setNavigatorOverrides → example
Overrides value returned by the javascript navigator object.
Params: platform: string
Emulation.setPageScaleFactor → example
Sets a specified page scale factor.
Params: pageScaleFactor: number
Emulation.setScriptExecutionDisabled → example
Switches script execution in the page.
Params: value: boolean
Emulation.setTouchEmulationEnabled → example
Enables touch on platforms which do not support them.
Params: enabled: boolean, maxTouchPoints?: integer
Emulation.setVirtualTimePolicy → example
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.
Params: policy: VirtualTimePolicy, budget?: number, maxVirtualTimeTaskStarvationCount?: integer, initialVirtualTime?: Network.TimeSinceEpoch
Returns: virtualTimeTicksBase: number
Emulation.setLocaleOverride → example
Overrides default host system locale with the specified one.
Params: locale?: string
Emulation.setTimezoneOverride → example
Overrides default host system timezone with the specified one.
Params: timezoneId: string
Emulation.setVisibleSize → example
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.
Params: width: integer, height: integer
Emulation.setDisabledImageTypes → example
Params: imageTypes: array
Emulation.setDataSaverOverride → example
Override the value of navigator.connection.saveData
Params: dataSaverEnabled?: boolean
Emulation.setHardwareConcurrencyOverride → example
Params: hardwareConcurrency: integer
Emulation.setUserAgentOverride → example
Allows overriding user agent with the given string. `userAgentMetadata` must be set for Client Hint headers to be sent.
Params: userAgent: string, acceptLanguage?: string, platform?: string, userAgentMetadata?: UserAgentMetadata
Emulation.setAutomationOverride → example
Allows overriding the automation flag.
Params: enabled: boolean
Emulation.setSmallViewportHeightDifferenceOverride → example
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.
Params: difference: integer
Emulation.getScreenInfos → example
Returns device's screen configuration. In headful mode, the physical screens configuration is returned, whereas in headless mode, a virtual headless screen configuration is provided instead.
Returns: screenInfos: array
Emulation.addScreen → example
Add a new screen to the device. Only supported in headless mode.
Params: left: integer, top: integer, width: integer, height: integer, workAreaInsets?: WorkAreaInsets, devicePixelRatio?: number, rotation?: integer, colorDepth?: integer, label?: string, isInternal?: boolean
Returns: screenInfo: ScreenInfo
Emulation.updateScreen → example
Updates specified screen parameters. Only supported in headless mode.
Params: screenId: ScreenId, left?: integer, top?: integer, width?: integer, height?: integer, workAreaInsets?: WorkAreaInsets, devicePixelRatio?: number, rotation?: integer, colorDepth?: integer, label?: string, isInternal?: boolean
Returns: screenInfo: ScreenInfo
Emulation.removeScreen → example
Remove screen from the device. Only supported in headless mode.
Params: screenId: ScreenId
Emulation.setPrimaryScreen → example
Set primary screen. Only supported in headless mode. Note that this changes the coordinate system origin to the top-left of the new primary screen, updating the bounds and work areas of all existing screens accordingly.
Params: screenId: ScreenId

↑Events (2)

Emulation.virtualTimeBudgetExpired
Notification sent after the virtual time budget for the current VirtualTimePolicy has run out.
Emulation.screenOrientationLockChanged
Fired when a page calls screen.orientation.lock() or screen.orientation.unlock() while device emulation is enabled. This allows the DevTools frontend to update the emulated device orientation accordingly.
Params: locked: boolean, orientation?: ScreenOrientation

↑Types (21)

SafeAreaInsets (object)
ScreenOrientation (object)
Screen orientation.
DisplayFeature (object)
DevicePosture (object)
MediaFeature (object)
VirtualTimePolicy (string)
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.
UserAgentBrandVersion (object)
Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints
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.
SensorType (string)
Used to specify sensor types to emulate. See https://w3c.github.io/sensors/#automation for more information.
SensorMetadata (object)
SensorReadingSingle (object)
SensorReadingXYZ (object)
SensorReadingQuaternion (object)
SensorReading (object)
PressureSource (string)
PressureState (string)
PressureMetadata (object)
WorkAreaInsets (object)
ScreenId (string)
ScreenInfo (object)
Screen information similar to the one returned by window.getScreenDetails() method, see https://w3c.github.io/window-management/#screendetailed.
DisabledImageType (string)
Enum of image types that can be disabled.

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

↑Commands (3)

EventBreakpoints.setInstrumentationBreakpoint → example
Sets breakpoint on particular native event.
Params: eventName: string
EventBreakpoints.removeInstrumentationBreakpoint → example
Removes breakpoint on particular native event.
Params: eventName: string
EventBreakpoints.disable → example
Removes all breakpoints

↑Extensions experimental

Defines commands and events for browser extensions.

↑Commands (8)

Extensions.triggerAction → example
Runs an extension default action.
Params: id: string, targetId: string
Extensions.loadUnpacked → example
Installs an unpacked extension from the filesystem similar to --load-extension CLI flags. Returns extension ID once the extension has been installed.
Params: path: string, enableInIncognito?: boolean
Returns: id: string
Extensions.getExtensions → example
Gets a list of all unpacked extensions.
Returns: extensions: array
Extensions.uninstall → example
Uninstalls an unpacked extension (others not supported) from the profile.
Params: id: string
Extensions.getStorageItems → example
Gets data from extension storage in the given `storageArea`. If `keys` is specified, these are used to filter the result.
Params: id: string, storageArea: StorageArea, keys?: array
Returns: data: object
Extensions.removeStorageItems → example
Removes `keys` from extension storage in the given `storageArea`.
Params: id: string, storageArea: StorageArea, keys: array
Extensions.clearStorageItems → example
Clears extension storage in the given `storageArea`.
Params: id: string, storageArea: StorageArea
Extensions.setStorageItems → example
Sets `values` in extension storage in the given `storageArea`. The provided `values` will be merged with existing values in the storage area.
Params: id: string, storageArea: StorageArea, values: object

↑Types (2)

StorageArea (string)
Storage areas.
ExtensionInfo (object)
Detailed information about an extension.

↑FedCm experimental

This domain allows interacting with the FedCM dialog.

↑Commands (7)

FedCm.enable → example
Params: disableRejectionDelay?: boolean
FedCm.disable → example
FedCm.selectAccount → example
Params: dialogId: string, accountIndex: integer
FedCm.clickDialogButton → example
Params: dialogId: string, dialogButton: DialogButton
FedCm.openUrl → example
Params: dialogId: string, accountIndex: integer, accountUrlType: AccountUrlType
FedCm.dismissDialog → example
Params: dialogId: string, triggerCooldown?: boolean
FedCm.resetCooldown → example
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.

↑Events (2)

FedCm.dialogShown
Params: dialogId: string, dialogType: DialogType, accounts: array, title: string, subtitle?: string
FedCm.dialogClosed
Triggered when a dialog is closed, either by user action, JS abort, or a command below.
Params: dialogId: string

↑Types (5)

LoginState (string)
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.
DialogType (string)
The types of FedCM dialogs.
DialogButton (string)
The buttons on the FedCM dialog.
AccountUrlType (string)
The URLs that each account has
Account (object)
Corresponds to IdentityRequestAccount

↑Fetch stable

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

↑Commands (9)

Fetch.disable → example
Disables the fetch domain.
Fetch.enable → example
Enables issuing of requestPaused events. A request will be paused until client calls one of failRequest, fulfillRequest or continueRequest/continueWithAuth.
Params: patterns?: array, handleAuthRequests?: boolean
Fetch.failRequest → example
Causes the request to fail with specified reason.
Params: requestId: RequestId, errorReason: Network.ErrorReason
Fetch.fulfillRequest → example
Provides response to the request.
Params: requestId: RequestId, responseCode: integer, responseHeaders?: array, binaryResponseHeaders?: string, body?: string, responsePhrase?: string
Fetch.continueRequest → example
Continues the request, optionally modifying some of its parameters.
Params: requestId: RequestId, url?: string, method?: string, postData?: string, headers?: array, interceptResponse?: boolean
Fetch.continueWithAuth → example
Continues a request supplying authChallengeResponse following authRequired event.
Params: requestId: RequestId, authChallengeResponse: AuthChallengeResponse
Fetch.continueResponse → example
Continues loading of the paused response, optionally modifying the response headers. If either responseCode or headers are modified, all of them must be present.
Params: requestId: RequestId, responseCode?: integer, responsePhrase?: string, responseHeaders?: array, binaryResponseHeaders?: string
Fetch.getResponseBody → example
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.
Params: requestId: RequestId
Returns: body: string, base64Encoded: boolean
Fetch.takeResponseBodyAsStream → example
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.
Params: requestId: RequestId
Returns: stream: IO.StreamHandle

↑Events (2)

Fetch.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.
Params: requestId: RequestId, request: Network.Request, frameId: Page.FrameId, resourceType: Network.ResourceType, responseErrorReason?: Network.ErrorReason, responseStatusCode?: integer, responseStatusText?: string, responseHeaders?: array, networkId?: Network.RequestId, redirectedRequestId?: RequestId
Fetch.authRequired
Issued when the domain is enabled with handleAuthRequests set to true. The request is paused until client responds with continueWithAuth.
Params: requestId: RequestId, request: Network.Request, frameId: Page.FrameId, resourceType: Network.ResourceType, authChallenge: AuthChallenge

↑Types (6)

RequestId (string)
Unique request identifier. Note that this does not identify individual HTTP requests that are part of a network request.
RequestStage (string)
Stages of the request to handle. Request will intercept before the request is sent. Response will intercept after the response is received (but before response body is received).
RequestPattern (object)
HeaderEntry (object)
Response HTTP header entry
AuthChallenge (object)
Authorization challenge for HTTP status code 401 or 407.
AuthChallengeResponse (object)
Response to an AuthChallenge.

↑FileSystem experimental

↑Commands (1)

FileSystem.getDirectory → example
Params: bucketFileSystemLocator: BucketFileSystemLocator
Returns: directory: Directory

↑Types (3)

File (object)
Directory (object)
BucketFileSystemLocator (object)

↑HeadlessExperimental experimental

This domain provides experimental commands only supported in headless mode.

↑Commands (3)

HeadlessExperimental.beginFrame → example
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.
Params: frameTimeTicks?: number, interval?: number, noDisplayUpdates?: boolean, screenshot?: ScreenshotParams
Returns: hasDamage: boolean, screenshotData: string
HeadlessExperimental.disable → example
Disables headless events for the target.
HeadlessExperimental.enable → example
Enables headless events for the target.

↑Types (1)

ScreenshotParams (object)
Encoding options for a screenshot.

↑HeapProfiler experimental

↑Commands (12)

HeapProfiler.addInspectedHeapObject → example
Enables console to refer to the node with given id via $x (see Command Line API for more details $x functions).
Params: heapObjectId: HeapSnapshotObjectId
HeapProfiler.collectGarbage → example
HeapProfiler.disable → example
HeapProfiler.enable → example
HeapProfiler.getHeapObjectId → example
Params: objectId: Runtime.RemoteObjectId
Returns: heapSnapshotObjectId: HeapSnapshotObjectId
HeapProfiler.getObjectByHeapObjectId → example
Params: objectId: HeapSnapshotObjectId, objectGroup?: string
Returns: result: Runtime.RemoteObject
HeapProfiler.getSamplingProfile → example
Returns: profile: SamplingHeapProfile
HeapProfiler.startSampling → example
Params: samplingInterval?: number, stackDepth?: number, includeObjectsCollectedByMajorGC?: boolean, includeObjectsCollectedByMinorGC?: boolean
HeapProfiler.startTrackingHeapObjects → example
Params: trackAllocations?: boolean
HeapProfiler.stopSampling → example
Returns: profile: SamplingHeapProfile
HeapProfiler.stopTrackingHeapObjects → example
Params: reportProgress?: boolean, treatGlobalObjectsAsRoots?: boolean, captureNumericValue?: boolean, exposeInternals?: boolean
HeapProfiler.takeHeapSnapshot → example
Params: reportProgress?: boolean, treatGlobalObjectsAsRoots?: boolean, captureNumericValue?: boolean, exposeInternals?: boolean

↑Events (5)

HeapProfiler.addHeapSnapshotChunk
Params: chunk: string
HeapProfiler.heapStatsUpdate
If heap objects tracking has been started then backend may send update for one or more fragments
Params: statsUpdate: array
HeapProfiler.lastSeenObjectId
If heap objects tracking has been started then backend regularly sends a current value for last seen object id and corresponding timestamp. If the were changes in the heap since last event then one or more heapStatsUpdate events will be sent before a new lastSeenObjectId event.
Params: lastSeenObjectId: integer, timestamp: number
HeapProfiler.reportHeapSnapshotProgress
Params: done: integer, total: integer, finished?: boolean
HeapProfiler.resetProfiles

↑Types (4)

HeapSnapshotObjectId (string)
Heap snapshot object id.
SamplingHeapProfileNode (object)
Sampling Heap Profile node. Holds callsite information, allocation statistics and child nodes.
SamplingHeapProfileSample (object)
A single sample from a sampling profile.
SamplingHeapProfile (object)
Sampling profile.

↑IO stable

Input/Output operations for streams produced by DevTools.

↑Commands (3)

IO.close → example
Close the stream, discard any temporary backing storage.
Params: handle: StreamHandle
IO.read → example
Read a chunk of the stream
Params: handle: StreamHandle, offset?: integer, size?: integer
Returns: base64Encoded: boolean, data: string, eof: boolean
IO.resolveBlob → example
Return UUID of Blob object specified by a remote object id.
Params: objectId: Runtime.RemoteObjectId
Returns: uuid: string

↑Types (1)

StreamHandle (string)
This is either obtained from another method or specified as `blob:<uuid>` where `<uuid>` is an UUID of a Blob.

↑IndexedDB experimental

↑Commands (9)

IndexedDB.clearObjectStore → example
Clears all entries from an object store.
Params: securityOrigin?: string, storageKey?: string, storageBucket?: Storage.StorageBucket, databaseName: string, objectStoreName: string
IndexedDB.deleteDatabase → example
Deletes a database.
Params: securityOrigin?: string, storageKey?: string, storageBucket?: Storage.StorageBucket, databaseName: string
IndexedDB.deleteObjectStoreEntries → example
Delete a range of entries from an object store
Params: securityOrigin?: string, storageKey?: string, storageBucket?: Storage.StorageBucket, databaseName: string, objectStoreName: string, keyRange: KeyRange
IndexedDB.disable → example
Disables events from backend.
IndexedDB.enable → example
Enables events from backend.
IndexedDB.requestData → example
Requests data from object store or index.
Params: securityOrigin?: string, storageKey?: string, storageBucket?: Storage.StorageBucket, databaseName: string, objectStoreName: string, indexName?: string, skipCount: integer, pageSize: integer, keyRange?: KeyRange
Returns: objectStoreDataEntries: array, hasMore: boolean
IndexedDB.getMetadata → example
Gets metadata of an object store.
Params: securityOrigin?: string, storageKey?: string, storageBucket?: Storage.StorageBucket, databaseName: string, objectStoreName: string
Returns: entriesCount: number, keyGeneratorValue: number
IndexedDB.requestDatabase → example
Requests database with given name in given frame.
Params: securityOrigin?: string, storageKey?: string, storageBucket?: Storage.StorageBucket, databaseName: string
Returns: databaseWithObjectStores: DatabaseWithObjectStores
IndexedDB.requestDatabaseNames → example
Requests database names for given security origin.
Params: securityOrigin?: string, storageKey?: string, storageBucket?: Storage.StorageBucket
Returns: databaseNames: array

↑Types (7)

DatabaseWithObjectStores (object)
Database with an array of object stores.
ObjectStore (object)
Object store.
ObjectStoreIndex (object)
Object store index.
Key (object)
Key.
KeyRange (object)
Key range.
DataEntry (object)
Data entry.
KeyPath (object)
Key path.

↑Input stable

↑Commands (13)

Input.dispatchDragEvent → example
Dispatches a drag event into the page.
Params: type: string, x: number, y: number, data: DragData, modifiers?: integer
Input.dispatchKeyEvent → example
Dispatches a key event to the page.
Params: type: string, modifiers?: integer, timestamp?: TimeSinceEpoch, text?: string, unmodifiedText?: string, keyIdentifier?: string, code?: string, key?: string, windowsVirtualKeyCode?: integer, nativeVirtualKeyCode?: integer, autoRepeat?: boolean, isKeypad?: boolean, isSystemKey?: boolean, location?: integer, commands?: array
Input.insertText → example
This method emulates inserting text that doesn't come from a key press, for example an emoji keyboard or an IME.
Params: text: string
Input.imeSetComposition → example
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.
Params: text: string, selectionStart: integer, selectionEnd: integer, replacementStart?: integer, replacementEnd?: integer
Input.dispatchMouseEvent → example
Dispatches a mouse event to the page.
Params: type: string, x: number, y: number, modifiers?: integer, timestamp?: TimeSinceEpoch, button?: MouseButton, buttons?: integer, clickCount?: integer, force?: number, tangentialPressure?: number, tiltX?: number, tiltY?: number, twist?: integer, deltaX?: number, deltaY?: number, pointerType?: string
Input.dispatchTouchEvent → example
Dispatches a touch event to the page.
Params: type: string, touchPoints: array, modifiers?: integer, timestamp?: TimeSinceEpoch
Input.cancelDragging → example
Cancels any active dragging in the page.
Input.emulateTouchFromMouseEvent → example
Emulates touch event from the mouse event parameters.
Params: type: string, x: integer, y: integer, button: MouseButton, timestamp?: TimeSinceEpoch, deltaX?: number, deltaY?: number, modifiers?: integer, clickCount?: integer
Input.setIgnoreInputEvents → example
Ignores input events (useful while auditing page).
Params: ignore: boolean
Input.setInterceptDrags → example
Prevents default drag and drop behavior and instead emits `Input.dragIntercepted` events. Drag and drop behavior can be directly controlled via `Input.dispatchDragEvent`.
Params: enabled: boolean
Input.synthesizePinchGesture → example
Synthesizes a pinch gesture over a time period by issuing appropriate touch events.
Params: x: number, y: number, scaleFactor: number, relativeSpeed?: integer, gestureSourceType?: GestureSourceType
Input.synthesizeScrollGesture → example
Synthesizes a scroll gesture over a time period by issuing appropriate touch events.
Params: x: number, y: number, xDistance?: number, yDistance?: number, xOverscroll?: number, yOverscroll?: number, preventFling?: boolean, speed?: integer, gestureSourceType?: GestureSourceType, repeatCount?: integer, repeatDelayMs?: integer, interactionMarkerName?: string
Input.synthesizeTapGesture → example
Synthesizes a tap gesture over a time period by issuing appropriate touch events.
Params: x: number, y: number, duration?: integer, tapCount?: integer, gestureSourceType?: GestureSourceType

↑Events (1)

Input.dragIntercepted
Emitted only when `Input.setInterceptDrags` is enabled. Use this data with `Input.dispatchDragEvent` to restore normal drag and drop behavior.
Params: data: DragData

↑Types (6)

TouchPoint (object)
GestureSourceType (string)
MouseButton (string)
TimeSinceEpoch (number)
UTC time in seconds, counted from January 1, 1970.
DragDataItem (object)
DragData (object)

↑Inspector experimental

↑Commands (2)

Inspector.disable → example
Disables inspector domain notifications.
Inspector.enable → example
Enables inspector domain notifications.

↑Events (4)

Inspector.detached
Fired when remote debugging connection is about to be terminated. Contains detach reason.
Params: reason: string
Inspector.targetCrashed
Fired when debugging target has crashed
Inspector.targetReloadedAfterCrash
Fired when debugging target has reloaded after crash
Inspector.workerScriptLoaded
Fired on worker targets when main worker script and any imported scripts have been evaluated.

↑LayerTree experimental

↑Commands (9)

LayerTree.compositingReasons → example
Provides the reasons why the given layer was composited.
Params: layerId: LayerId
Returns: compositingReasons: array, compositingReasonIds: array
LayerTree.disable → example
Disables compositing tree inspection.
LayerTree.enable → example
Enables compositing tree inspection.
LayerTree.loadSnapshot → example
Returns the snapshot identifier.
Params: tiles: array
Returns: snapshotId: SnapshotId
LayerTree.makeSnapshot → example
Returns the layer snapshot identifier.
Params: layerId: LayerId
Returns: snapshotId: SnapshotId
LayerTree.profileSnapshot → example
Params: snapshotId: SnapshotId, minRepeatCount?: integer, minDuration?: number, clipRect?: DOM.Rect
Returns: timings: array
LayerTree.releaseSnapshot → example
Releases layer snapshot captured by the back-end.
Params: snapshotId: SnapshotId
LayerTree.replaySnapshot → example
Replays the layer snapshot and returns the resulting bitmap.
Params: snapshotId: SnapshotId, fromStep?: integer, toStep?: integer, scale?: number
Returns: dataURL: string
LayerTree.snapshotCommandLog → example
Replays the layer snapshot and returns canvas log.
Params: snapshotId: SnapshotId
Returns: commandLog: array

↑Events (2)

LayerTree.layerPainted
Params: layerId: LayerId, clip: DOM.Rect
LayerTree.layerTreeDidChange
Params: layers?: array

↑Types (7)

LayerId (string)
Unique Layer identifier.
SnapshotId (string)
Unique snapshot identifier.
ScrollRect (object)
Rectangle where scrolling happens on the main thread.
StickyPositionConstraint (object)
Sticky position constraints.
PictureTile (object)
Serialized fragment of layer picture along with its offset within the layer.
Layer (object)
Information about a compositing layer.
PaintProfile (array)
Array of timings, one per paint step.

↑Log stable

Provides access to log entries.

↑Commands (5)

Log.clear → example
Clears the log.
Log.disable → example
Disables log domain, prevents further log entries from being reported to the client.
Log.enable → example
Enables log domain, sends the entries collected so far to the client by means of the `entryAdded` notification.
Log.startViolationsReport → example
start violation reporting.
Params: config: array
Log.stopViolationsReport → example
Stop violation reporting.

↑Events (1)

Log.entryAdded
Issued when new message was logged.
Params: entry: LogEntry

↑Types (2)

LogEntry (object)
Log entry.
ViolationSetting (object)
Violation configuration setting.

↑Media experimental

This domain allows detailed inspection of media elements.

↑Commands (2)

Media.enable → example
Enables the Media domain
Media.disable → example
Disables the Media domain.

↑Events (5)

Media.playerPropertiesChanged
This can be called multiple times, and can be used to set / override / remove player properties. A null propValue indicates removal.
Params: playerId: PlayerId, properties: array
Media.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.
Params: playerId: PlayerId, events: array
Media.playerMessagesLogged
Send a list of any messages that need to be delivered.
Params: playerId: PlayerId, messages: array
Media.playerErrorsRaised
Send a list of any errors that need to be delivered.
Params: playerId: PlayerId, errors: array
Media.playerCreated
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 one event for each active player.
Params: player: Player

↑Types (8)

PlayerId (string)
Players will get an ID that is unique within the agent context.
Timestamp (number)
PlayerMessage (object)
Have one type per entry in MediaLogRecord::Type Corresponds to kMessage
PlayerProperty (object)
Corresponds to kMediaPropertyChange
PlayerEvent (object)
Corresponds to kMediaEventTriggered
PlayerErrorSourceLocation (object)
Represents logged source line numbers reported in an error. NOTE: file and line are from chromium c++ implementation code, not js.
PlayerError (object)
Corresponds to kMediaError
Player (object)

↑Memory experimental

↑Commands (11)

Memory.getDOMCounters → example
Retruns current DOM object counters.
Returns: documents: integer, nodes: integer, jsEventListeners: integer
Memory.getDOMCountersForLeakDetection → example
Retruns DOM object counters after preparing renderer for leak detection.
Returns: counters: array
Memory.prepareForLeakDetection → example
Prepares for leak detection by terminating workers, stopping spellcheckers, dropping non-essential internal caches, running garbage collections, etc.
Memory.forciblyPurgeJavaScriptMemory → example
Simulate OomIntervention by purging V8 memory.
Memory.setPressureNotificationsSuppressed → example
Enable/disable suppressing memory pressure notifications in all processes.
Params: suppressed: boolean
Memory.simulatePressureNotification → example
Simulate a memory pressure notification in all processes.
Params: level: PressureLevel
Memory.startSampling → example
Start collecting native memory profile.
Params: samplingInterval?: integer, suppressRandomness?: boolean
Memory.stopSampling → example
Stop collecting native memory profile.
Memory.getAllTimeSamplingProfile → example
Retrieve native memory allocations profile collected since renderer process startup.
Returns: profile: SamplingProfile
Memory.getBrowserSamplingProfile → example
Retrieve native memory allocations profile collected since browser process startup.
Returns: profile: SamplingProfile
Memory.getSamplingProfile → example
Retrieve native memory allocations profile collected since last `startSampling` call.
Returns: profile: SamplingProfile

↑Types (5)

PressureLevel (string)
Memory pressure level.
SamplingProfileNode (object)
Heap profile sample.
SamplingProfile (object)
Array of heap profile samples.
Module (object)
Executable module information
DOMCounter (object)
DOM object counter data.

↑Network stable

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.

↑Commands (41)

Network.setAcceptedEncodings → example
Sets a list of content encodings that will be accepted. Empty list means no encoding is accepted.
Params: encodings: array
Network.clearAcceptedEncodingsOverride → example
Clears accepted encodings set by setAcceptedEncodings
Network.canClearBrowserCache → example
Tells whether clearing browser cache is supported.
Returns: result: boolean
Network.canClearBrowserCookies → example
Tells whether clearing browser cookies is supported.
Returns: result: boolean
Network.canEmulateNetworkConditions → example
Tells whether emulation of network conditions is supported.
Returns: result: boolean
Network.clearBrowserCache → example
Clears browser cache.
Network.clearBrowserCookies → example
Clears browser cookies.
Network.continueInterceptedRequest → example
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.
Params: interceptionId: InterceptionId, errorReason?: ErrorReason, rawResponse?: string, url?: string, method?: string, postData?: string, headers?: Headers, authChallengeResponse?: AuthChallengeResponse
Network.deleteCookies → example
Deletes browser cookies with matching name and url or domain/path/partitionKey pair.
Params: name: string, url?: string, domain?: string, path?: string, partitionKey?: CookiePartitionKey
Network.disable → example
Disables network tracking, prevents network events from being sent to the client.
Network.emulateNetworkConditions → example
Activates emulation of network conditions. This command is deprecated in favor of the emulateNetworkConditionsByRule and overrideNetworkState commands, which can be used together to the same effect.
Params: offline: boolean, latency: number, downloadThroughput: number, uploadThroughput: number, connectionType?: ConnectionType, packetLoss?: number, packetQueueLength?: integer, packetReordering?: boolean
Network.emulateNetworkConditionsByRule → example
Activates emulation of network conditions for individual requests using URL match patterns. Unlike the deprecated Network.emulateNetworkConditions this method does not affect `navigator` state. Use Network.overrideNetworkState to explicitly modify `navigator` behavior.
Params: offline?: boolean, emulateOfflineServiceWorker?: boolean, matchedNetworkConditions: array
Returns: ruleIds: array
Network.overrideNetworkState → example
Override the state of navigator.onLine and navigator.connection.
Params: offline: boolean, latency: number, downloadThroughput: number, uploadThroughput: number, connectionType?: ConnectionType
Network.enable → example
Enables network tracking, network events will now be delivered to the client.
Params: maxTotalBufferSize?: integer, maxResourceBufferSize?: integer, maxPostDataSize?: integer, reportDirectSocketTraffic?: boolean, enableDurableMessages?: boolean
Network.configureDurableMessages → example
Configures storing response bodies outside of renderer, so that these survive a cross-process navigation. If maxTotalBufferSize is not set, durable messages are disabled.
Params: maxTotalBufferSize?: integer, maxResourceBufferSize?: integer
Network.getAllCookies → example
Returns all browser cookies. Depending on the backend support, will return detailed cookie information in the `cookies` field. Deprecated. Use Storage.getCookies instead.
Returns: cookies: array
Network.getCertificate → example
Returns the DER-encoded certificate.
Params: origin: string
Returns: tableNames: array
Network.getCookies → example
Returns all browser cookies for the current URL. Depending on the backend support, will return detailed cookie information in the `cookies` field.
Params: urls?: array
Returns: cookies: array
Network.getResponseBody → example
Returns content served for the given request.
Params: requestId: RequestId
Returns: body: string, base64Encoded: boolean
Network.getRequestPostData → example
Returns post data sent with the request. Returns an error when no data was sent with the request.
Params: requestId: RequestId
Returns: postData: string, base64Encoded: boolean
Network.getResponseBodyForInterception → example
Returns content served for the given currently intercepted request.
Params: interceptionId: InterceptionId
Returns: body: string, base64Encoded: boolean
Network.takeResponseBodyForInterceptionAsStream → example
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.
Params: interceptionId: InterceptionId
Returns: stream: IO.StreamHandle
Network.replayXHR → example
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.
Params: requestId: RequestId
Network.searchInResponseBody → example
Searches for given string in response content.
Params: requestId: RequestId, query: string, caseSensitive?: boolean, isRegex?: boolean
Returns: result: array
Network.setBlockedURLs → example
Blocks URLs from loading.
Params: urlPatterns?: array, urls?: array
Network.setBypassServiceWorker → example
Toggles ignoring of service worker for each request.
Params: bypass: boolean
Network.setCacheDisabled → example
Toggles ignoring cache for each request. If `true`, cache will not be used.
Params: cacheDisabled: boolean
Network.setCookie → example
Sets a cookie with the given cookie data; may overwrite equivalent cookies if they exist.
Params: name: string, value: string, url?: string, domain?: string, path?: string, secure?: boolean, httpOnly?: boolean, sameSite?: CookieSameSite, expires?: TimeSinceEpoch, priority?: CookiePriority, sourceScheme?: CookieSourceScheme, sourcePort?: integer, partitionKey?: CookiePartitionKey
Returns: success: boolean
Network.setCookies → example
Sets given cookies.
Params: cookies: array
Network.setExtraHTTPHeaders → example
Specifies whether to always send extra HTTP headers with the requests from this page.
Params: headers: Headers
Network.setAttachDebugStack → example
Specifies whether to attach a page script stack id in requests
Params: enabled: boolean
Network.setRequestInterception → example
Sets the requests to intercept that match the provided patterns and optionally resource types. Deprecated, please use Fetch.enable instead.
Params: patterns: array
Network.setUserAgentOverride → example
Allows overriding user agent with the given string.
Params: userAgent: string, acceptLanguage?: string, platform?: string, userAgentMetadata?: Emulation.UserAgentMetadata
Network.streamResourceContent → example
Enables streaming of the response for the given requestId. If enabled, the dataReceived event contains the data that was received during streaming.
Params: requestId: RequestId
Returns: bufferedData: string
Network.getSecurityIsolationStatus → example
Returns information about the COEP/COOP isolation status.
Params: frameId?: Page.FrameId
Returns: status: SecurityIsolationStatus
Network.enableReportingApi → example
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.
Params: enable: boolean
Network.enableDeviceBoundSessions → example
Sets up tracking device bound sessions and fetching of initial set of sessions.
Params: enable: boolean
Network.deleteDeviceBoundSession → example
Deletes a device bound session.
Params: key: DeviceBoundSessionKey
Network.fetchSchemefulSite → example
Fetches the schemeful site for a specific origin.
Params: origin: string
Returns: schemefulSite: string
Network.loadNetworkResource → example
Fetches the resource and returns the content.
Params: frameId?: Page.FrameId, url: string, options: LoadNetworkResourceOptions
Returns: resource: LoadNetworkResourcePageResult
Network.setCookieControls → example
Sets Controls for third-party cookie access Page reload is required before the new cookie behavior will be observed
Params: enableThirdPartyCookieRestriction: boolean

↑Events (44)

Network.dataReceived
Fired when data chunk was received over the network.
Params: requestId: RequestId, timestamp: MonotonicTime, dataLength: integer, encodedDataLength: integer, data?: string
Network.eventSourceMessageReceived
Fired when EventSource message is received.
Params: requestId: RequestId, timestamp: MonotonicTime, eventName: string, eventId: string, data: string
Network.loadingFailed
Fired when HTTP request has failed to load.
Params: requestId: RequestId, timestamp: MonotonicTime, type: ResourceType, errorText: string, canceled?: boolean, blockedReason?: BlockedReason, corsErrorStatus?: CorsErrorStatus
Network.loadingFinished
Fired when HTTP request has finished loading.
Params: requestId: RequestId, timestamp: MonotonicTime, encodedDataLength: number
Network.requestIntercepted
Details of an intercepted HTTP request, which must be either allowed, blocked, modified or mocked. Deprecated, use Fetch.requestPaused instead.
Params: interceptionId: InterceptionId, request: Request, frameId: Page.FrameId, resourceType: ResourceType, isNavigationRequest: boolean, isDownload?: boolean, redirectUrl?: string, authChallenge?: AuthChallenge, responseErrorReason?: ErrorReason, responseStatusCode?: integer, responseHeaders?: Headers, requestId?: RequestId
Network.requestServedFromCache
Fired if request ended up loading from cache.
Params: requestId: RequestId
Network.requestWillBeSent
Fired when page is about to send HTTP request.
Params: requestId: RequestId, loaderId: LoaderId, documentURL: string, request: Request, timestamp: MonotonicTime, wallTime: TimeSinceEpoch, initiator: Initiator, redirectHasExtraInfo: boolean, redirectResponse?: Response, type?: ResourceType, frameId?: Page.FrameId, hasUserGesture?: boolean, renderBlockingBehavior?: RenderBlockingBehavior
Network.resourceChangedPriority
Fired when resource loading priority is changed
Params: requestId: RequestId, newPriority: ResourcePriority, timestamp: MonotonicTime
Network.signedExchangeReceived
Fired when a signed exchange was received over the network
Params: requestId: RequestId, info: SignedExchangeInfo
Network.responseReceived
Fired when HTTP response is available.
Params: requestId: RequestId, loaderId: LoaderId, timestamp: MonotonicTime, type: ResourceType, response: Response, hasExtraInfo: boolean, frameId?: Page.FrameId
Network.webSocketClosed
Fired when WebSocket is closed.
Params: requestId: RequestId, timestamp: MonotonicTime
Network.webSocketCreated
Fired upon WebSocket creation.
Params: requestId: RequestId, url: string, initiator?: Initiator
Network.webSocketFrameError
Fired when WebSocket message error occurs.
Params: requestId: RequestId, timestamp: MonotonicTime, errorMessage: string
Network.webSocketFrameReceived
Fired when WebSocket message is received.
Params: requestId: RequestId, timestamp: MonotonicTime, response: WebSocketFrame
Network.webSocketFrameSent
Fired when WebSocket message is sent.
Params: requestId: RequestId, timestamp: MonotonicTime, response: WebSocketFrame
Network.webSocketHandshakeResponseReceived
Fired when WebSocket handshake response becomes available.
Params: requestId: RequestId, timestamp: MonotonicTime, response: WebSocketResponse
Network.webSocketWillSendHandshakeRequest
Fired when WebSocket is about to initiate handshake.
Params: requestId: RequestId, timestamp: MonotonicTime, wallTime: TimeSinceEpoch, request: WebSocketRequest
Network.webTransportCreated
Fired upon WebTransport creation.
Params: transportId: RequestId, url: string, timestamp: MonotonicTime, initiator?: Initiator
Network.webTransportConnectionEstablished
Fired when WebTransport handshake is finished.
Params: transportId: RequestId, timestamp: MonotonicTime
Network.webTransportClosed
Fired when WebTransport is disposed.
Params: transportId: RequestId, timestamp: MonotonicTime
Network.directTCPSocketCreated
Fired upon direct_socket.TCPSocket creation.
Params: identifier: RequestId, remoteAddr: string, remotePort: integer, options: DirectTCPSocketOptions, timestamp: MonotonicTime, initiator?: Initiator
Network.directTCPSocketOpened
Fired when direct_socket.TCPSocket connection is opened.
Params: identifier: RequestId, remoteAddr: string, remotePort: integer, timestamp: MonotonicTime, localAddr?: string, localPort?: integer
Network.directTCPSocketAborted
Fired when direct_socket.TCPSocket is aborted.
Params: identifier: RequestId, errorMessage: string, timestamp: MonotonicTime
Network.directTCPSocketClosed
Fired when direct_socket.TCPSocket is closed.
Params: identifier: RequestId, timestamp: MonotonicTime
Network.directTCPSocketChunkSent
Fired when data is sent to tcp direct socket stream.
Params: identifier: RequestId, data: string, timestamp: MonotonicTime
Network.directTCPSocketChunkReceived
Fired when data is received from tcp direct socket stream.
Params: identifier: RequestId, data: string, timestamp: MonotonicTime
Network.directUDPSocketJoinedMulticastGroup
Params: identifier: RequestId, IPAddress: string
Network.directUDPSocketLeftMulticastGroup
Params: identifier: RequestId, IPAddress: string
Network.directUDPSocketCreated
Fired upon direct_socket.UDPSocket creation.
Params: identifier: RequestId, options: DirectUDPSocketOptions, timestamp: MonotonicTime, initiator?: Initiator
Network.directUDPSocketOpened
Fired when direct_socket.UDPSocket connection is opened.
Params: identifier: RequestId, localAddr: string, localPort: integer, timestamp: MonotonicTime, remoteAddr?: string, remotePort?: integer
Network.directUDPSocketAborted
Fired when direct_socket.UDPSocket is aborted.
Params: identifier: RequestId, errorMessage: string, timestamp: MonotonicTime
Network.directUDPSocketClosed
Fired when direct_socket.UDPSocket is closed.
Params: identifier: RequestId, timestamp: MonotonicTime
Network.directUDPSocketChunkSent
Fired when message is sent to udp direct socket stream.
Params: identifier: RequestId, message: DirectUDPMessage, timestamp: MonotonicTime
Network.directUDPSocketChunkReceived
Fired when message is received from udp direct socket stream.
Params: identifier: RequestId, message: DirectUDPMessage, timestamp: MonotonicTime
Network.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.
Params: requestId: RequestId, associatedCookies: array, headers: Headers, connectTiming: ConnectTiming, deviceBoundSessionUsages?: array, clientSecurityState?: ClientSecurityState, siteHasCookieInOtherPartition?: boolean, appliedNetworkConditionsId?: string
Network.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.
Params: requestId: RequestId, blockedCookies: array, headers: Headers, resourceIPAddressSpace: IPAddressSpace, statusCode: integer, headersText?: string, cookiePartitionKey?: CookiePartitionKey, cookiePartitionKeyOpaque?: boolean, exemptedCookies?: array
Network.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.
Params: requestId: RequestId, headers: Headers
Network.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.
Params: status: string, type: TrustTokenOperationType, requestId: RequestId, topLevelOrigin?: string, issuerOrigin?: string, issuedTokenCount?: integer
Network.policyUpdated
Fired once security policy has been updated.
Network.reportingApiReportAdded
Is sent whenever a new report is added. And after 'enableReportingApi' for all existing reports.
Params: report: ReportingApiReport
Network.reportingApiReportUpdated
Params: report: ReportingApiReport
Network.reportingApiEndpointsChangedForOrigin
Params: origin: string, endpoints: array
Network.deviceBoundSessionsAdded
Triggered when the initial set of device bound sessions is added.
Params: sessions: array
Network.deviceBoundSessionEventOccurred
Triggered when a device bound session event occurs.
Params: eventId: DeviceBoundSessionEventId, site: string, succeeded: boolean, sessionId?: string, creationEventDetails?: CreationEventDetails, refreshEventDetails?: RefreshEventDetails, terminationEventDetails?: TerminationEventDetails, challengeEventDetails?: ChallengeEventDetails

↑Types (93)

ResourceType (string)
Resource type as it was perceived by the rendering engine.
LoaderId (string)
Unique loader identifier.
RequestId (string)
Unique network request identifier. Note that this does not identify individual HTTP requests that are part of a network request.
InterceptionId (string)
Unique intercepted request identifier.
ErrorReason (string)
Network level fetch failure reason.
TimeSinceEpoch (number)
UTC time in seconds, counted from January 1, 1970.
MonotonicTime (number)
Monotonically increasing time in seconds since an arbitrary point in the past.
Headers (object)
Request / response headers as keys / values of JSON object.
ConnectionType (string)
The underlying connection technology that the browser is supposedly using.
CookieSameSite (string)
Represents the cookie's 'SameSite' status: https://tools.ietf.org/html/draft-west-first-party-cookies
CookiePriority (string)
Represents the cookie's 'Priority' status: https://tools.ietf.org/html/draft-west-cookie-priority-00
CookieSourceScheme (string)
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.
ResourceTiming (object)
Timing information for the request.
ResourcePriority (string)
Loading priority of a resource request.
RenderBlockingBehavior (string)
The render-blocking behavior of a resource request.
PostDataEntry (object)
Post data entry for HTTP request
Request (object)
HTTP request data.
SignedCertificateTimestamp (object)
Details of a signed certificate timestamp (SCT).
SecurityDetails (object)
Security details about a request.
CertificateTransparencyCompliance (string)
Whether the request complied with Certificate Transparency policy.
BlockedReason (string)
The reason why request was blocked.
CorsError (string)
The reason why request was blocked.
CorsErrorStatus (object)
ServiceWorkerResponseSource (string)
Source of serviceworker response.
TrustTokenParams (object)
Determines what type of Trust Token operation is executed and depending on the type, some additional parameters. The values are specified in third_party/blink/renderer/core/fetch/trust_token.idl.
TrustTokenOperationType (string)
AlternateProtocolUsage (string)
The reason why Chrome uses a specific transport protocol for HTTP semantics.
ServiceWorkerRouterSource (string)
Source of service worker router.
ServiceWorkerRouterInfo (object)
Response (object)
HTTP response data.
WebSocketRequest (object)
WebSocket request data.
WebSocketResponse (object)
WebSocket response data.
WebSocketFrame (object)
WebSocket message data. This represents an entire WebSocket message, not just a fragmented frame as the name suggests.
CachedResource (object)
Information about the cached resource.
Initiator (object)
Information about the request initiator.
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.
Cookie (object)
Cookie object
SetCookieBlockedReason (string)
Types of reasons why a cookie may not be stored from a response.
CookieBlockedReason (string)
Types of reasons why a cookie may not be sent with a request.
CookieExemptionReason (string)
Types of reasons why a cookie should have been blocked by 3PCD but is exempted for the request.
BlockedSetCookieWithReason (object)
A cookie which was not stored from a response with the corresponding 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.
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.
CookieParam (object)
Cookie parameter object
AuthChallenge (object)
Authorization challenge for HTTP status code 401 or 407.
AuthChallengeResponse (object)
Response to an AuthChallenge.
InterceptionStage (string)
Stages of the interception to begin intercepting. Request will intercept before the request is sent. Response will intercept after the response is received.
RequestPattern (object)
Request pattern for interception.
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
SignedExchangeHeader (object)
Information about a signed exchange header. https://wicg.github.io/webpackage/draft-yasskin-httpbis-origin-signed-exchanges-impl.html#cbor-representation
SignedExchangeErrorField (string)
Field type for a signed exchange related error.
SignedExchangeError (object)
Information about a signed exchange response.
SignedExchangeInfo (object)
Information about a signed exchange response.
ContentEncoding (string)
List of content encodings supported by the backend.
NetworkConditions (object)
BlockPattern (object)
DirectSocketDnsQueryType (string)
DirectTCPSocketOptions (object)
DirectUDPSocketOptions (object)
DirectUDPMessage (object)
LocalNetworkAccessRequestPolicy (string)
IPAddressSpace (string)
ConnectTiming (object)
ClientSecurityState (object)
AdScriptIdentifier (object)
Identifies the script on the stack that caused a resource or element to be labeled as an ad. For resources, this indicates the context that triggered the fetch. For elements, this indicates the context that caused the element to be appended to the DOM.
AdAncestry (object)
Encapsulates the script ancestry and the root script filter list rule that caused the resource or element to be labeled as an ad.
AdProvenance (object)
Represents the provenance of an ad resource or element. Only one of `filterlistRule` or `adScriptAncestry` can be set. If `filterlistRule` is provided, the resource URL directly matches a filter list rule. If `adScriptAncestry` is provided, an ad script initiated the resource fetch or appended the element to the DOM. If neither is provided, the entity is known to be an ad, but provenance tracking information is unavailable.
CrossOriginOpenerPolicyValue (string)
CrossOriginOpenerPolicyStatus (object)
CrossOriginEmbedderPolicyValue (string)
CrossOriginEmbedderPolicyStatus (object)
ContentSecurityPolicySource (string)
ContentSecurityPolicyStatus (object)
SecurityIsolationStatus (object)
ReportStatus (string)
The status of a Reporting API report.
ReportId (string)
ReportingApiReport (object)
An object representing a report generated by the Reporting API.
ReportingApiEndpoint (object)
DeviceBoundSessionKey (object)
Unique identifier for a device bound session.
DeviceBoundSessionWithUsage (object)
How a device bound session was used during a request.
DeviceBoundSessionCookieCraving (object)
A device bound session's cookie craving.
DeviceBoundSessionUrlRule (object)
A device bound session's inclusion URL rule.
DeviceBoundSessionInclusionRules (object)
A device bound session's inclusion rules.
DeviceBoundSession (object)
A device bound session.
DeviceBoundSessionEventId (string)
A unique identifier for a device bound session event.
DeviceBoundSessionFetchResult (string)
A fetch result for a device bound session creation or refresh.
DeviceBoundSessionFailedRequest (object)
Details about a failed device bound session network request.
CreationEventDetails (object)
Session event details specific to creation.
RefreshEventDetails (object)
Session event details specific to refresh.
TerminationEventDetails (object)
Session event details specific to termination.
ChallengeEventDetails (object)
Session event details specific to challenges.
LoadNetworkResourcePageResult (object)
An object providing the result of a network resource load.
LoadNetworkResourceOptions (object)
An options object that may be extended later to better support CORS, CORB and streaming.

↑Overlay experimental

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

↑Commands (30)

Overlay.disable → example
Disables domain notifications.
Overlay.enable → example
Enables domain notifications.
Overlay.getHighlightObjectForTest → example
For testing.
Params: nodeId: DOM.NodeId, includeDistance?: boolean, includeStyle?: boolean, colorFormat?: ColorFormat, showAccessibilityInfo?: boolean
Returns: highlight: object
Overlay.getGridHighlightObjectsForTest → example
For Persistent Grid testing.
Params: nodeIds: array
Returns: highlights: object
Overlay.getSourceOrderHighlightObjectForTest → example
For Source Order Viewer testing.
Params: nodeId: DOM.NodeId
Returns: highlight: object
Overlay.hideHighlight → example
Hides any highlight.
Overlay.highlightFrame → example
Highlights owner element of the frame with given id. Deprecated: Doesn't work reliably and cannot be fixed due to process separation (the owner node might be in a different process). Determine the owner node in the client and use highlightNode.
Params: frameId: Page.FrameId, contentColor?: DOM.RGBA, contentOutlineColor?: DOM.RGBA
Overlay.highlightNode → example
Highlights DOM node with given id or with the given JavaScript object wrapper. Either nodeId or objectId must be specified.
Params: highlightConfig: HighlightConfig, nodeId?: DOM.NodeId, backendNodeId?: DOM.BackendNodeId, objectId?: Runtime.RemoteObjectId, selector?: string
Overlay.highlightQuad → example
Highlights given quad. Coordinates are absolute with respect to the main frame viewport.
Params: quad: DOM.Quad, color?: DOM.RGBA, outlineColor?: DOM.RGBA
Overlay.highlightRect → example
Highlights given rectangle. Coordinates are absolute with respect to the main frame viewport. Issue: the method does not handle device pixel ratio (DPR) correctly. The coordinates currently have to be adjusted by the client if DPR is not 1 (see crbug.com/437807128).
Params: x: integer, y: integer, width: integer, height: integer, color?: DOM.RGBA, outlineColor?: DOM.RGBA
Overlay.highlightSourceOrder → example
Highlights the source order of the children of the DOM node with given id or with the given JavaScript object wrapper. Either nodeId or objectId must be specified.
Params: sourceOrderConfig: SourceOrderConfig, nodeId?: DOM.NodeId, backendNodeId?: DOM.BackendNodeId, objectId?: Runtime.RemoteObjectId
Overlay.setInspectMode → example
Enters the 'inspect' mode. In this mode, elements that user is hovering over are highlighted. Backend then generates 'inspectNodeRequested' event upon element selection.
Params: mode: InspectMode, highlightConfig?: HighlightConfig
Overlay.setShowAdHighlights → example
Highlights owner element of all frames detected to be ads.
Params: show: boolean
Overlay.setPausedInDebuggerMessage → example
Params: message?: string
Overlay.setShowDebugBorders → example
Requests that backend shows debug borders on layers
Params: show: boolean
Overlay.setShowFPSCounter → example
Requests that backend shows the FPS counter
Params: show: boolean
Overlay.setShowGridOverlays → example
Highlight multiple elements with the CSS Grid overlay.
Params: gridNodeHighlightConfigs: array
Overlay.setShowFlexOverlays → example
Params: flexNodeHighlightConfigs: array
Overlay.setShowScrollSnapOverlays → example
Params: scrollSnapHighlightConfigs: array
Overlay.setShowContainerQueryOverlays → example
Params: containerQueryHighlightConfigs: array
Overlay.setShowInspectedElementAnchor → example
Params: inspectedElementAnchorConfig: InspectedElementAnchorConfig
Overlay.setShowPaintRects → example
Requests that backend shows paint rectangles
Params: result: boolean
Overlay.setShowLayoutShiftRegions → example
Requests that backend shows layout shift regions
Params: result: boolean
Overlay.setShowScrollBottleneckRects → example
Requests that backend shows scroll bottleneck rects
Params: show: boolean
Overlay.setShowHitTestBorders → example
Deprecated, no longer has any effect.
Params: show: boolean
Overlay.setShowWebVitals → example
Deprecated, no longer has any effect.
Params: show: boolean
Overlay.setShowViewportSizeOnResize → example
Paints viewport size upon main frame resize.
Params: show: boolean
Overlay.setShowHinge → example
Add a dual screen device hinge
Params: hingeConfig?: HingeConfig
Overlay.setShowIsolatedElements → example
Show elements in isolation mode with overlays.
Params: isolatedElementHighlightConfigs: array
Overlay.setShowWindowControlsOverlay → example
Show Window Controls Overlay for PWA
Params: windowControlsOverlayConfig?: WindowControlsOverlayConfig

↑Events (6)

Overlay.inspectNodeRequested
Fired when the node should be inspected. This happens after call to `setInspectMode` or when user manually inspects an element.
Params: backendNodeId: DOM.BackendNodeId
Overlay.nodeHighlightRequested
Fired when the node should be highlighted. This happens after call to `setInspectMode`.
Params: nodeId: DOM.NodeId
Overlay.screenshotRequested
Fired when user asks to capture screenshot of some area on the page.
Params: viewport: Page.Viewport
Overlay.inspectPanelShowRequested
Fired when user asks to show the Inspect panel.
Params: backendNodeId: DOM.BackendNodeId
Overlay.inspectedElementWindowRestored
Fired when user asks to restore the Inspected Element floating window.
Params: backendNodeId: DOM.BackendNodeId
Overlay.inspectModeCanceled
Fired when user cancels the inspect mode.

↑Types (21)

SourceOrderConfig (object)
Configuration data for drawing the source order of an elements children.
GridHighlightConfig (object)
Configuration data for the highlighting of Grid elements.
FlexContainerHighlightConfig (object)
Configuration data for the highlighting of Flex container elements.
FlexItemHighlightConfig (object)
Configuration data for the highlighting of Flex item elements.
LineStyle (object)
Style information for drawing a line.
BoxStyle (object)
Style information for drawing a box.
ContrastAlgorithm (string)
HighlightConfig (object)
Configuration data for the highlighting of page elements.
ColorFormat (string)
GridNodeHighlightConfig (object)
Configurations for Persistent Grid Highlight
FlexNodeHighlightConfig (object)
ScrollSnapContainerHighlightConfig (object)
ScrollSnapHighlightConfig (object)
HingeConfig (object)
Configuration for dual screen hinge
WindowControlsOverlayConfig (object)
Configuration for Window Controls Overlay
ContainerQueryHighlightConfig (object)
ContainerQueryContainerHighlightConfig (object)
IsolatedElementHighlightConfig (object)
IsolationModeHighlightConfig (object)
InspectMode (string)
InspectedElementAnchorConfig (object)

↑PWA experimental

This domain allows interacting with the browser to control PWAs.

↑Commands (7)

PWA.getOsAppState → example
Returns the following OS state for the given manifest id.
Params: manifestId: string
Returns: badgeCount: integer, fileHandlers: array
PWA.install → example
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 at the end following the documentation https://github.com/WICG/isolated-web-apps/blob/main/Scheme.md#suffix 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.
Params: manifestId: string, installUrlOrBundleUrl?: string
PWA.uninstall → example
Uninstalls the given manifest_id and closes any opened app windows.
Params: manifestId: string
PWA.launch → example
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.
Params: manifestId: string, url?: string
Returns: targetId: Target.TargetID
PWA.launchFilesInApp → example
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.
Params: manifestId: string, files: array
Returns: targetIds: array
PWA.openCurrentPageInApp → example
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.
Params: manifestId: string
PWA.changeAppUserSettings → example
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.
Params: manifestId: string, linkCapturing?: boolean, displayMode?: DisplayMode

↑Types (3)

FileHandlerAccept (object)
The following types are the replica of https://crsrc.org/c/chrome/browser/web_applications/proto/web_app_os_integration_state.proto;drc=9910d3be894c8f142c977ba1023f30a656bc13fc;l=67
FileHandler (object)
DisplayMode (string)
If user prefers opening the app in browser or an app window.

↑Page stable

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

↑Commands (61)

Page.addScriptToEvaluateOnLoad → example
Deprecated, please use addScriptToEvaluateOnNewDocument instead.
Params: scriptSource: string
Returns: identifier: ScriptIdentifier
Page.addScriptToEvaluateOnNewDocument → example
Evaluates given script in every frame upon creation (before loading frame's scripts).
Params: source: string, worldName?: string, includeCommandLineAPI?: boolean, runImmediately?: boolean
Returns: identifier: ScriptIdentifier
Page.bringToFront → example
Brings page to front (activates tab).
Page.captureScreenshot → example
Capture page screenshot.
Params: format?: string, quality?: integer, clip?: Viewport, fromSurface?: boolean, captureBeyondViewport?: boolean, optimizeForSpeed?: boolean
Returns: data: string
Page.captureSnapshot → example
Returns a snapshot of the page as a string. For MHTML format, the serialization includes iframes, shadow DOM, external resources, and element-inline styles.
Params: format?: string
Returns: data: string
Page.clearDeviceMetricsOverride → example
Clears the overridden device metrics.
Page.clearDeviceOrientationOverride → example
Clears the overridden Device Orientation.
Page.clearGeolocationOverride → example
Clears the overridden Geolocation Position and Error.
Page.createIsolatedWorld → example
Creates an isolated world for the given frame.
Params: frameId: FrameId, worldName?: string, grantUniveralAccess?: boolean
Returns: executionContextId: Runtime.ExecutionContextId
Page.deleteCookie → example
Deletes browser cookie with given name, domain and path.
Params: cookieName: string, url: string
Page.disable → example
Disables page domain notifications.
Page.enable → example
Enables page domain notifications.
Params: enableFileChooserOpenedEvent?: boolean
Page.getAppManifest → example
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.
Params: manifestId?: string
Returns: url: string, errors: array, data: string, parsed: AppManifestParsedProperties, manifest: WebAppManifest
Page.getInstallabilityErrors → example
Returns: installabilityErrors: array
Page.getManifestIcons → example
Deprecated because it's not guaranteed that the returned icon is in fact the one used for PWA installation.
Returns: primaryIcon: string
Page.getAppId → example
Returns the unique (PWA) app id. Only returns values if the feature flag 'WebAppEnableManifestId' is enabled
Returns: appId: string, recommendedId: string
Page.getAdScriptAncestry → example
Params: frameId: FrameId
Returns: adScriptAncestry: Network.AdAncestry
Page.getFrameTree → example
Returns present frame tree structure.
Returns: frameTree: FrameTree
Page.getLayoutMetrics → example
Returns metrics relating to the layouting of the page, such as viewport bounds/scale.
Returns: layoutViewport: LayoutViewport, visualViewport: VisualViewport, contentSize: DOM.Rect, cssLayoutViewport: LayoutViewport, cssVisualViewport: VisualViewport, cssContentSize: DOM.Rect
Page.getNavigationHistory → example
Returns navigation history for the current page.
Returns: currentIndex: integer, entries: array
Page.resetNavigationHistory → example
Resets navigation history for the current page.
Page.getResourceContent → example
Returns content of the given resource.
Params: frameId: FrameId, url: string
Returns: content: string, base64Encoded: boolean
Page.getResourceTree → example
Returns present frame / resource tree structure.
Returns: frameTree: FrameResourceTree
Page.handleJavaScriptDialog → example
Accepts or dismisses a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload).
Params: accept: boolean, promptText?: string
Page.navigate → example
Navigates current page to the given URL.
Params: url: string, referrer?: string, transitionType?: TransitionType, frameId?: FrameId, referrerPolicy?: ReferrerPolicy
Returns: frameId: FrameId, loaderId: Network.LoaderId, errorText: string, isDownload: boolean
Page.navigateToHistoryEntry → example
Navigates current page to the given history entry.
Params: entryId: integer
Page.printToPDF → example
Print page as PDF.
Params: landscape?: boolean, displayHeaderFooter?: boolean, printBackground?: boolean, scale?: number, paperWidth?: number, paperHeight?: number, marginTop?: number, marginBottom?: number, marginLeft?: number, marginRight?: number, pageRanges?: string, headerTemplate?: string, footerTemplate?: string, preferCSSPageSize?: boolean, transferMode?: string, generateTaggedPDF?: boolean, generateDocumentOutline?: boolean
Returns: data: string, stream: IO.StreamHandle
Page.reload → example
Reloads given page optionally ignoring the cache.
Params: ignoreCache?: boolean, scriptToEvaluateOnLoad?: string, loaderId?: Network.LoaderId
Page.removeScriptToEvaluateOnLoad → example
Deprecated, please use removeScriptToEvaluateOnNewDocument instead.
Params: identifier: ScriptIdentifier
Page.removeScriptToEvaluateOnNewDocument → example
Removes given script from the list.
Params: identifier: ScriptIdentifier
Page.screencastFrameAck → example
Acknowledges that a screencast frame has been received by the frontend.
Params: sessionId: integer
Page.searchInResource → example
Searches for given string in resource content.
Params: frameId: FrameId, url: string, query: string, caseSensitive?: boolean, isRegex?: boolean
Returns: result: array
Page.setAdBlockingEnabled → example
Enable Chrome's experimental ad filter on all sites.
Params: enabled: boolean
Page.setBypassCSP → example
Enable page Content Security Policy by-passing.
Params: enabled: boolean
Page.getPermissionsPolicyState → example
Get Permissions Policy state on given frame.
Params: frameId: FrameId
Returns: states: array
Page.getOriginTrials → example
Get Origin Trials on given frame.
Params: frameId: FrameId
Returns: originTrials: array
Page.setDeviceMetricsOverride → example
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).
Params: width: integer, height: integer, deviceScaleFactor: number, mobile: boolean, scale?: number, screenWidth?: integer, screenHeight?: integer, positionX?: integer, positionY?: integer, dontSetVisibleSize?: boolean, screenOrientation?: Emulation.ScreenOrientation, viewport?: Viewport
Page.setDeviceOrientationOverride → example
Overrides the Device Orientation.
Params: alpha: number, beta: number, gamma: number
Page.setFontFamilies → example
Set generic font families.
Params: fontFamilies: FontFamilies, forScripts?: array
Page.setFontSizes → example
Set default font sizes.
Params: fontSizes: FontSizes
Page.setDocumentContent → example
Sets given markup as the document's HTML.
Params: frameId: FrameId, html: string
Page.setDownloadBehavior → example
Set the behavior when downloading a file.
Params: behavior: string, downloadPath?: string
Page.setGeolocationOverride → example
Overrides the Geolocation Position or Error. Omitting any of the parameters emulates position unavailable.
Params: latitude?: number, longitude?: number, accuracy?: number
Page.setLifecycleEventsEnabled → example
Controls whether page will emit lifecycle events.
Params: enabled: boolean
Page.setTouchEmulationEnabled → example
Toggles mouse event-based touch event emulation.
Params: enabled: boolean, configuration?: string
Page.startScreencast → example
Starts sending each frame using the `screencastFrame` event.
Params: format?: string, quality?: integer, maxWidth?: integer, maxHeight?: integer, everyNthFrame?: integer
Page.stopLoading → example
Force the page stop all navigations and pending resource fetches.
Page.crash → example
Crashes renderer on the IO thread, generates minidumps.
Page.close → example
Tries to close page, running its beforeunload hooks, if any.
Page.setWebLifecycleState → example
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/
Params: state: string
Page.stopScreencast → example
Stops sending each frame in the `screencastFrame`.
Page.produceCompilationCache → example
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`.
Params: scripts: array
Page.addCompilationCache → example
Seeds compilation cache for given url. Compilation cache does not survive cross-process navigation.
Params: url: string, data: string
Page.clearCompilationCache → example
Clears seeded compilation cache.
Page.setSPCTransactionMode → example
Sets the Secure Payment Confirmation transaction mode. https://w3c.github.io/secure-payment-confirmation/#sctn-automation-set-spc-transaction-mode
Params: mode: string
Page.setRPHRegistrationMode → example
Extensions for Custom Handlers API: https://html.spec.whatwg.org/multipage/system-state.html#rph-automation
Params: mode: string
Page.generateTestReport → example
Generates a report for testing.
Params: message: string, group?: string
Page.waitForDebugger → example
Pauses page execution. Can be resumed using generic Runtime.runIfWaitingForDebugger.
Page.setInterceptFileChooserDialog → example
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.
Params: enabled: boolean, cancel?: boolean
Page.setPrerenderingAllowed → example
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.
Params: isAllowed: boolean
Page.getAnnotatedPageContent → example
Get the annotated page content for the main frame. This is an experimental command that is subject to change.
Params: includeActionableInformation?: boolean
Returns: content: string

↑Events (28)

Page.domContentEventFired
Params: timestamp: Network.MonotonicTime
Page.fileChooserOpened
Emitted only when `page.interceptFileChooser` is enabled.
Params: frameId: FrameId, mode: string, backendNodeId?: DOM.BackendNodeId
Page.frameAttached
Fired when frame has been attached to its parent.
Params: frameId: FrameId, parentFrameId: FrameId, stack?: Runtime.StackTrace
Page.frameClearedScheduledNavigation
Fired when frame no longer has a scheduled navigation.
Params: frameId: FrameId
Page.frameDetached
Fired when frame has been detached from its parent.
Params: frameId: FrameId, reason: string
Page.frameSubtreeWillBeDetached
Fired before frame subtree is detached. Emitted before any frame of the subtree is actually detached.
Params: frameId: FrameId
Page.frameNavigated
Fired once navigation of the frame has completed. Frame is now associated with the new loader.
Params: frame: Frame, type: NavigationType
Page.documentOpened
Fired when opening document to write to.
Params: frame: Frame
Page.frameResized
Page.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).
Params: frameId: FrameId, url: string, loaderId: Network.LoaderId, navigationType: string
Page.frameRequestedNavigation
Fired when a renderer-initiated navigation is requested. Navigation may still be cancelled after the event is issued.
Params: frameId: FrameId, reason: ClientNavigationReason, url: string, disposition: ClientNavigationDisposition
Page.frameScheduledNavigation
Fired when frame schedules a potential navigation.
Params: frameId: FrameId, delay: number, reason: ClientNavigationReason, url: string
Page.frameStartedLoading
Fired when frame has started loading.
Params: frameId: FrameId
Page.frameStoppedLoading
Fired when frame has stopped loading.
Params: frameId: FrameId
Page.downloadWillBegin
Fired when page is about to start a download. Deprecated. Use Browser.downloadWillBegin instead.
Params: frameId: FrameId, guid: string, url: string, suggestedFilename: string
Page.downloadProgress
Fired when download makes progress. Last call has |done| == true. Deprecated. Use Browser.downloadProgress instead.
Params: guid: string, totalBytes: number, receivedBytes: number, state: string
Page.interstitialHidden
Fired when interstitial page was hidden
Page.interstitialShown
Fired when interstitial page was shown
Page.javascriptDialogClosed
Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) has been closed.
Params: frameId: FrameId, result: boolean, userInput: string
Page.javascriptDialogOpening
Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) is about to open.
Params: url: string, frameId: FrameId, message: string, type: DialogType, hasBrowserHandler: boolean, defaultPrompt?: string
Page.lifecycleEvent
Fired for lifecycle events (navigation, load, paint, etc) in the current target (including local frames).
Params: frameId: FrameId, loaderId: Network.LoaderId, name: string, timestamp: Network.MonotonicTime
Page.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.
Params: loaderId: Network.LoaderId, frameId: FrameId, notRestoredExplanations: array, notRestoredExplanationsTree?: BackForwardCacheNotRestoredExplanationTree
Page.loadEventFired
Params: timestamp: Network.MonotonicTime
Page.navigatedWithinDocument
Fired when same-document navigation happens, e.g. due to history API usage or anchor navigation.
Params: frameId: FrameId, url: string, navigationType: string
Page.screencastFrame
Compressed image data requested by the `startScreencast`.
Params: data: string, metadata: ScreencastFrameMetadata, sessionId: integer
Page.screencastVisibilityChanged
Fired when the page with currently enabled screencast was shown or hidden `.
Params: visible: boolean
Page.windowOpen
Fired when a new window is going to be opened, via window.open(), link click, form submission, etc.
Params: url: string, windowName: string, windowFeatures: array, userGesture: boolean
Page.compilationCacheProduced
Issued for every compilation cache generated.
Params: url: string, data: string

↑Types (58)

FrameId (string)
Unique frame identifier.
AdFrameType (string)
Indicates whether a frame has been identified as an ad.
AdFrameExplanation (string)
AdFrameStatus (object)
Indicates whether a frame has been identified as an ad and why.
SecureContextType (string)
Indicates whether the frame is a secure context and why it is the case.
CrossOriginIsolatedContextType (string)
Indicates whether the frame is cross-origin isolated and why it is the case.
GatedAPIFeatures (string)
PermissionsPolicyFeature (string)
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)
PermissionsPolicyBlockReason (string)
Reason for a permissions policy feature to be disabled.
PermissionsPolicyBlockLocator (object)
PermissionsPolicyFeatureState (object)
OriginTrialTokenStatus (string)
Origin Trial(https://www.chromium.org/blink/origin-trials) support. Status for an Origin Trial token.
OriginTrialStatus (string)
Status for an Origin Trial.
OriginTrialUsageRestriction (string)
OriginTrialToken (object)
OriginTrialTokenWithStatus (object)
OriginTrial (object)
SecurityOriginDetails (object)
Additional information about the frame document's security origin.
Frame (object)
Information about the Frame on the page.
FrameResource (object)
Information about the Resource on the page.
FrameResourceTree (object)
Information about the Frame hierarchy along with their cached resources.
FrameTree (object)
Information about the Frame hierarchy.
ScriptIdentifier (string)
Unique script identifier.
TransitionType (string)
Transition type.
NavigationEntry (object)
Navigation history entry.
ScreencastFrameMetadata (object)
Screencast frame metadata.
DialogType (string)
Javascript dialog type.
AppManifestError (object)
Error while paring app manifest.
AppManifestParsedProperties (object)
Parsed app manifest properties.
LayoutViewport (object)
Layout viewport position and dimensions.
VisualViewport (object)
Visual viewport position, dimensions, and scale.
Viewport (object)
Viewport for capturing screenshot.
FontFamilies (object)
Generic font families collection.
ScriptFontFamilies (object)
Font families collection for a script.
FontSizes (object)
Default font sizes.
ClientNavigationReason (string)
ClientNavigationDisposition (string)
InstallabilityErrorArgument (object)
InstallabilityError (object)
The installability error
ReferrerPolicy (string)
The referring-policy used for the navigation.
CompilationCacheParams (object)
Per-script compilation cache parameters for `Page.produceCompilationCache`
FileFilter (object)
FileHandler (object)
ImageResource (object)
The image definition used in both icon and screenshot.
LaunchHandler (object)
ProtocolHandler (object)
RelatedApplication (object)
ScopeExtension (object)
Screenshot (object)
ShareTarget (object)
Shortcut (object)
WebAppManifest (object)
NavigationType (string)
The type of a frameNavigated event.
BackForwardCacheNotRestoredReason (string)
List of not restored reasons for back-forward cache.
BackForwardCacheNotRestoredReasonType (string)
Types of not restored reasons for back-forward cache.
BackForwardCacheBlockingDetails (object)
BackForwardCacheNotRestoredExplanation (object)
BackForwardCacheNotRestoredExplanationTree (object)

↑Performance stable

↑Commands (4)

Performance.disable → example
Disable collecting and reporting metrics.
Performance.enable → example
Enable collecting and reporting metrics.
Params: timeDomain?: string
Performance.setTimeDomain → example
Sets time domain to use for collecting and reporting duration metrics. Note that this must be called before enabling metrics collection. Calling this method while metrics collection is enabled returns an error.
Params: timeDomain: string
Performance.getMetrics → example
Retrieve current values of run-time metrics.
Returns: metrics: array

↑Events (1)

Performance.metrics
Current values of the metrics.
Params: metrics: array, title: string

↑Types (1)

Metric (object)
Run-time execution metric.

↑PerformanceTimeline experimental

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

↑Commands (1)

PerformanceTimeline.enable → example
Previously buffered events would be reported before method returns. See also: timelineEventAdded
Params: eventTypes: array

↑Events (1)

PerformanceTimeline.timelineEventAdded
Sent when a performance timeline event is added. See reportPerformanceTimeline method.
Params: event: TimelineEvent

↑Types (4)

LargestContentfulPaint (object)
See https://github.com/WICG/LargestContentfulPaint and largest_contentful_paint.idl
LayoutShiftAttribution (object)
LayoutShift (object)
See https://wicg.github.io/layout-instability/#sec-layout-shift and layout_shift.idl
TimelineEvent (object)

↑Preload experimental

↑Commands (2)

Preload.enable → example
Preload.disable → example

↑Events (6)

Preload.ruleSetUpdated
Upsert. Currently, it is only emitted when a rule set added.
Params: ruleSet: RuleSet
Preload.ruleSetRemoved
Params: id: RuleSetId
Preload.preloadEnabledStateUpdated
Fired when a preload enabled state is updated.
Params: disabledByPreference: boolean, disabledByDataSaver: boolean, disabledByBatterySaver: boolean, disabledByHoldbackPrefetchSpeculationRules: boolean, disabledByHoldbackPrerenderSpeculationRules: boolean
Preload.prefetchStatusUpdated
Fired when a prefetch attempt is updated.
Params: key: PreloadingAttemptKey, pipelineId: PreloadPipelineId, initiatingFrameId: Page.FrameId, prefetchUrl: string, status: PreloadingStatus, prefetchStatus: PrefetchStatus, requestId: Network.RequestId
Preload.prerenderStatusUpdated
Fired when a prerender attempt is updated.
Params: key: PreloadingAttemptKey, pipelineId: PreloadPipelineId, status: PreloadingStatus, prerenderStatus?: PrerenderFinalStatus, disallowedMojoInterface?: string, mismatchedHeaders?: array
Preload.preloadingAttemptSourcesUpdated
Send a list of sources for all preloading attempts in a document.
Params: loaderId: Network.LoaderId, preloadingAttemptSources: array

↑Types (12)

RuleSetId (string)
Unique id
RuleSet (object)
Corresponds to SpeculationRuleSet
RuleSetErrorType (string)
SpeculationAction (string)
The type of preloading attempted. It corresponds to mojom::SpeculationAction (although PrefetchWithSubresources is omitted as it isn't being used by clients).
SpeculationTargetHint (string)
Corresponds to mojom::SpeculationTargetHint. See https://github.com/WICG/nav-speculation/blob/main/triggers.md#window-name-targeting-hints
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.
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 <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.
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`.
PrerenderFinalStatus (string)
List of FinalStatus reasons for Prerender2.
PreloadingStatus (string)
Preloading status values, see also PreloadingTriggeringOutcome. This status is shared by prefetchStatusUpdated and prerenderStatusUpdated.
PrefetchStatus (string)
TODO(https://crbug.com/1384419): revisit the list of PrefetchStatus and filter out the ones that aren't necessary to the developers.
PrerenderMismatchedHeaders (object)
Information of headers to be displayed when the header mismatch occurred.

↑Profiler stable

↑Commands (9)

Profiler.disable → example
Profiler.enable → example
Profiler.getBestEffortCoverage → example
Collect coverage data for the current isolate. The coverage data may be incomplete due to garbage collection.
Returns: result: array
Profiler.setSamplingInterval → example
Changes CPU profiler sampling interval. Must be called before CPU profiles recording started.
Params: interval: integer
Profiler.start → example
Profiler.startPreciseCoverage → example
Enable precise code coverage. Coverage data for JavaScript executed before enabling precise code coverage may be incomplete. Enabling prevents running optimized code and resets execution counters.
Params: callCount?: boolean, detailed?: boolean, allowTriggeredUpdates?: boolean
Returns: timestamp: number
Profiler.stop → example
Returns: profile: Profile
Profiler.stopPreciseCoverage → example
Disable precise code coverage. Disabling releases unnecessary execution count records and allows executing optimized code.
Profiler.takePreciseCoverage → example
Collect coverage data for the current isolate, and resets execution counters. Precise code coverage needs to have started.
Returns: result: array, timestamp: number

↑Events (3)

Profiler.consoleProfileFinished
Params: id: string, location: Debugger.Location, profile: Profile, title?: string
Profiler.consoleProfileStarted
Sent when new profile recording is started using console.profile() call.
Params: id: string, location: Debugger.Location, title?: string
Profiler.preciseCoverageDeltaUpdate
Reports coverage delta since the last poll (either from an event like this, or from `takePreciseCoverage` for the current isolate. May only be sent if precise code coverage has been started. This event can be trigged by the embedder to, for example, trigger collection of coverage data immediately at a certain point in time.
Params: timestamp: number, occasion: string, result: array

↑Types (6)

ProfileNode (object)
Profile node. Holds callsite information, execution statistics and child nodes.
Profile (object)
Profile.
PositionTickInfo (object)
Specifies a number of samples attributed to a certain source position.
CoverageRange (object)
Coverage data for a source range.
FunctionCoverage (object)
Coverage data for a JavaScript function.
ScriptCoverage (object)
Coverage data for a JavaScript script.

↑Runtime stable

Runtime domain exposes JavaScript runtime by means of remote evaluation and mirror objects. Evaluation results are returned as mirror object that expose object type, string representation and unique identifier that can be used for further object reference. Original objects are maintained in memory unless they are either explicitly released or are released along with the other objects in their object group.

↑Commands (23)

Runtime.awaitPromise → example
Add handler to promise with given promise object id.
Params: promiseObjectId: RemoteObjectId, returnByValue?: boolean, generatePreview?: boolean
Returns: result: RemoteObject, exceptionDetails: ExceptionDetails
Runtime.callFunctionOn → example
Calls function with given declaration on the given object. Object group of the result is inherited from the target object.
Params: functionDeclaration: string, objectId?: RemoteObjectId, arguments?: array, silent?: boolean, returnByValue?: boolean, generatePreview?: boolean, userGesture?: boolean, awaitPromise?: boolean, executionContextId?: ExecutionContextId, objectGroup?: string, throwOnSideEffect?: boolean, uniqueContextId?: string, serializationOptions?: SerializationOptions
Returns: result: RemoteObject, exceptionDetails: ExceptionDetails
Runtime.compileScript → example
Compiles expression.
Params: expression: string, sourceURL: string, persistScript: boolean, executionContextId?: ExecutionContextId
Returns: scriptId: ScriptId, exceptionDetails: ExceptionDetails
Runtime.disable → example
Disables reporting of execution contexts creation.
Runtime.discardConsoleEntries → example
Discards collected exceptions and console API calls.
Runtime.enable → example
Enables reporting of execution contexts creation by means of `executionContextCreated` event. When the reporting gets enabled the event will be sent immediately for each existing execution context.
Runtime.evaluate → example
Evaluates expression on global object.
Params: expression: string, objectGroup?: string, includeCommandLineAPI?: boolean, silent?: boolean, contextId?: ExecutionContextId, returnByValue?: boolean, generatePreview?: boolean, userGesture?: boolean, awaitPromise?: boolean, throwOnSideEffect?: boolean, timeout?: TimeDelta, disableBreaks?: boolean, replMode?: boolean, allowUnsafeEvalBlockedByCSP?: boolean, uniqueContextId?: string, serializationOptions?: SerializationOptions
Returns: result: RemoteObject, exceptionDetails: ExceptionDetails
Runtime.getIsolateId → example
Returns the isolate id.
Returns: id: string
Runtime.getHeapUsage → example
Returns the JavaScript heap usage. It is the total usage of the corresponding isolate not scoped to a particular Runtime.
Returns: usedSize: number, totalSize: number, embedderHeapUsedSize: number, backingStorageSize: number
Runtime.getProperties → example
Returns properties of a given object. Object group of the result is inherited from the target object.
Params: objectId: RemoteObjectId, ownProperties?: boolean, accessorPropertiesOnly?: boolean, generatePreview?: boolean, nonIndexedPropertiesOnly?: boolean
Returns: result: array, internalProperties: array, privateProperties: array, exceptionDetails: ExceptionDetails
Runtime.globalLexicalScopeNames → example
Returns all let, const and class variables from global scope.
Params: executionContextId?: ExecutionContextId
Returns: names: array
Runtime.queryObjects → example
Params: prototypeObjectId: RemoteObjectId, objectGroup?: string
Returns: objects: RemoteObject
Runtime.releaseObject → example
Releases remote object with given id.
Params: objectId: RemoteObjectId
Runtime.releaseObjectGroup → example
Releases all remote objects that belong to a given group.
Params: objectGroup: string
Runtime.runIfWaitingForDebugger → example
Tells inspected instance to run if it was waiting for debugger to attach.
Runtime.runScript → example
Runs script with given id in a given context.
Params: scriptId: ScriptId, executionContextId?: ExecutionContextId, objectGroup?: string, silent?: boolean, includeCommandLineAPI?: boolean, returnByValue?: boolean, generatePreview?: boolean, awaitPromise?: boolean
Returns: result: RemoteObject, exceptionDetails: ExceptionDetails
Runtime.setAsyncCallStackDepth → example
Enables or disables async call stacks tracking.
Params: maxDepth: integer
Runtime.setCustomObjectFormatterEnabled → example
Params: enabled: boolean
Runtime.setMaxCallStackSizeToCapture → example
Params: size: integer
Runtime.terminateExecution → example
Terminate current or next JavaScript execution. Will cancel the termination when the outer-most script execution ends.
Runtime.addBinding → example
If executionContextId is empty, adds binding with the given name on the global objects of all inspected contexts, including those created later, bindings survive reloads. Binding function takes exactly one argument, this argument should be string, in case of any other input, function throws an exception. Each binding function call produces Runtime.bindingCalled notification.
Params: name: string, executionContextId?: ExecutionContextId, executionContextName?: string
Runtime.removeBinding → example
This method does not remove binding function from global object but unsubscribes current runtime agent from Runtime.bindingCalled notifications.
Params: name: string
Runtime.getExceptionDetails → example
This method tries to lookup and populate exception details for a JavaScript Error object. Note that the stackTrace portion of the resulting exceptionDetails will only be populated if the Runtime domain was enabled at the time when the Error was thrown.
Params: errorObjectId: RemoteObjectId
Returns: exceptionDetails: ExceptionDetails

↑Events (8)

Runtime.bindingCalled
Notification is issued every time when binding is called.
Params: name: string, payload: string, executionContextId: ExecutionContextId
Runtime.consoleAPICalled
Issued when console API was called.
Params: type: string, args: array, executionContextId: ExecutionContextId, timestamp: Timestamp, stackTrace?: StackTrace, context?: string
Runtime.exceptionRevoked
Issued when unhandled exception was revoked.
Params: reason: string, exceptionId: integer
Runtime.exceptionThrown
Issued when exception was thrown and unhandled.
Params: timestamp: Timestamp, exceptionDetails: ExceptionDetails
Runtime.executionContextCreated
Issued when new execution context is created.
Params: context: ExecutionContextDescription
Runtime.executionContextDestroyed
Issued when execution context is destroyed.
Params: executionContextId: ExecutionContextId, executionContextUniqueId: string
Runtime.executionContextsCleared
Issued when all executionContexts were cleared in browser
Runtime.inspectRequested
Issued when object should be inspected (for example, as a result of inspect() command line API call).
Params: object: RemoteObject, hints: object, executionContextId?: ExecutionContextId

↑Types (23)

ScriptId (string)
Unique script identifier.
SerializationOptions (object)
Represents options for serialization. Overrides `generatePreview` and `returnByValue`.
DeepSerializedValue (object)
Represents deep serialized value.
RemoteObjectId (string)
Unique object identifier.
UnserializableValue (string)
Primitive value which cannot be JSON-stringified. Includes values `-0`, `NaN`, `Infinity`, `-Infinity`, and bigint literals.
RemoteObject (object)
Mirror object referencing original JavaScript object.
CustomPreview (object)
ObjectPreview (object)
Object containing abbreviated remote object value.
PropertyPreview (object)
EntryPreview (object)
PropertyDescriptor (object)
Object property descriptor.
InternalPropertyDescriptor (object)
Object internal property descriptor. This property isn't normally visible in JavaScript code.
PrivatePropertyDescriptor (object)
Object private field descriptor.
CallArgument (object)
Represents function call argument. Either remote object id `objectId`, primitive `value`, unserializable primitive value or neither of (for undefined) them should be specified.
ExecutionContextId (integer)
Id of an execution context.
ExecutionContextDescription (object)
Description of an isolated world.
ExceptionDetails (object)
Detailed information about exception (or error) that was thrown during script compilation or execution.
Timestamp (number)
Number of milliseconds since epoch.
TimeDelta (number)
Number of milliseconds.
CallFrame (object)
Stack entry for runtime errors and assertions.
StackTrace (object)
Call frames for assertions or error messages.
UniqueDebuggerId (string)
Unique identifier of current debugger.
StackTraceId (object)
If `debuggerId` is set stack trace comes from another debugger and can be resolved there. This allows to track cross-debugger calls. See `Runtime.StackTrace` and `Debugger.paused` for usages.

↑Schema deprecated

This domain is deprecated.

↑Commands (1)

Schema.getDomains → example
Returns supported domains.
Returns: domains: array

↑Types (1)

Domain (object)
Description of the protocol domain.

↑Security stable

↑Commands (5)

Security.disable → example
Disables tracking security state changes.
Security.enable → example
Enables tracking security state changes.
Security.setIgnoreCertificateErrors → example
Enable/disable whether all certificate errors should be ignored.
Params: ignore: boolean
Security.handleCertificateError → example
Handles a certificate error that fired a certificateError event.
Params: eventId: integer, action: CertificateErrorAction
Security.setOverrideCertificateErrors → example
Enable/disable overriding certificate errors. If enabled, all certificate error events need to be handled by the DevTools client and should be answered with `handleCertificateError` commands.
Params: override: boolean

↑Events (3)

Security.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.
Params: eventId: integer, errorType: string, requestURL: string
Security.visibleSecurityStateChanged
The security state of the page changed.
Params: visibleSecurityState: VisibleSecurityState
Security.securityStateChanged
The security state of the page changed. No longer being sent.
Params: securityState: SecurityState, schemeIsCryptographic: boolean, explanations: array, insecureContentStatus: InsecureContentStatus, summary?: string

↑Types (10)

CertificateId (integer)
An internal certificate ID value.
MixedContentType (string)
A description of mixed content (HTTP resources on HTTPS pages), as defined by https://www.w3.org/TR/mixed-content/#categories
SecurityState (string)
The security level of a page or resource.
CertificateSecurityState (object)
Details about the security state of the page certificate.
SafetyTipStatus (string)
SafetyTipInfo (object)
VisibleSecurityState (object)
Security state information about the page.
SecurityStateExplanation (object)
An explanation of an factor contributing to the security state.
InsecureContentStatus (object)
Information about insecure content on the page.
CertificateErrorAction (string)
The action to take when a certificate error occurs. continue will continue processing the request and cancel will cancel the request.

↑ServiceWorker experimental

↑Commands (12)

ServiceWorker.deliverPushMessage → example
Params: origin: string, registrationId: RegistrationID, data: string
ServiceWorker.disable → example
ServiceWorker.dispatchSyncEvent → example
Params: origin: string, registrationId: RegistrationID, tag: string, lastChance: boolean
ServiceWorker.dispatchPeriodicSyncEvent → example
Params: origin: string, registrationId: RegistrationID, tag: string
ServiceWorker.enable → example
ServiceWorker.setForceUpdateOnPageLoad → example
Params: forceUpdateOnPageLoad: boolean
ServiceWorker.skipWaiting → example
Params: scopeURL: string
ServiceWorker.startWorker → example
Params: scopeURL: string
ServiceWorker.stopAllWorkers → example
ServiceWorker.stopWorker → example
Params: versionId: string
ServiceWorker.unregister → example
Params: scopeURL: string
ServiceWorker.updateRegistration → example
Params: scopeURL: string

↑Events (3)

ServiceWorker.workerErrorReported
Params: errorMessage: ServiceWorkerErrorMessage
ServiceWorker.workerRegistrationUpdated
Params: registrations: array
ServiceWorker.workerVersionUpdated
Params: versions: array

↑Types (6)

RegistrationID (string)
ServiceWorkerRegistration (object)
ServiceWorker registration.
ServiceWorkerVersionRunningStatus (string)
ServiceWorkerVersionStatus (string)
ServiceWorkerVersion (object)
ServiceWorker version.
ServiceWorkerErrorMessage (object)
ServiceWorker error message.

↑SmartCardEmulation experimental

↑Commands (12)

SmartCardEmulation.enable → example
Enables the |SmartCardEmulation| domain.
SmartCardEmulation.disable → example
Disables the |SmartCardEmulation| domain.
SmartCardEmulation.reportEstablishContextResult → example
Reports the successful result of a |SCardEstablishContext| call. This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gaa1b8970169fd4883a6dc4a8f43f19b67 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardestablishcontext
Params: requestId: string, contextId: integer
SmartCardEmulation.reportReleaseContextResult → example
Reports the successful result of a |SCardReleaseContext| call. This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga6aabcba7744c5c9419fdd6404f73a934 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardreleasecontext
Params: requestId: string
SmartCardEmulation.reportListReadersResult → example
Reports the successful result of a |SCardListReaders| call. This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga93b07815789b3cf2629d439ecf20f0d9 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardlistreadersa
Params: requestId: string, readers: array
SmartCardEmulation.reportGetStatusChangeResult → example
Reports the successful result of a |SCardGetStatusChange| call. This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga33247d5d1257d59e55647c3bb717db24 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardgetstatuschangea
Params: requestId: string, readerStates: array
SmartCardEmulation.reportBeginTransactionResult → example
Reports the result of a |SCardBeginTransaction| call. On success, this creates a new transaction object. This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gaddb835dce01a0da1d6ca02d33ee7d861 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardbegintransaction
Params: requestId: string, handle: integer
SmartCardEmulation.reportPlainResult → example
Reports the successful result of a call that returns only a result code. Used for: |SCardCancel|, |SCardDisconnect|, |SCardSetAttrib|, |SCardEndTransaction|. This maps to: 1. SCardCancel PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gaacbbc0c6d6c0cbbeb4f4debf6fbeeee6 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardcancel 2. SCardDisconnect PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga4be198045c73ec0deb79e66c0ca1738a Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scarddisconnect 3. SCardSetAttrib PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga060f0038a4ddfd5dd2b8fadf3c3a2e4f Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardsetattrib 4. SCardEndTransaction PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gae8742473b404363e5c587f570d7e2f3b Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardendtransaction
Params: requestId: string
SmartCardEmulation.reportConnectResult → example
Reports the successful result of a |SCardConnect| call. This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga4e515829752e0a8dbc4d630696a8d6a5 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardconnecta
Params: requestId: string, handle: integer, activeProtocol?: Protocol
SmartCardEmulation.reportDataResult → example
Reports the successful result of a call that sends back data on success. Used for |SCardTransmit|, |SCardControl|, and |SCardGetAttrib|. This maps to: 1. SCardTransmit PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga9a2d77242a271310269065e64633ab99 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardtransmit 2. SCardControl PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gac3454d4657110fd7f753b2d3d8f4e32f Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardcontrol 3. SCardGetAttrib PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gaacfec51917255b7a25b94c5104961602 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardgetattrib
Params: requestId: string, data: string
SmartCardEmulation.reportStatusResult → example
Reports the successful result of a |SCardStatus| call. This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gae49c3c894ad7ac12a5b896bde70d0382 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardstatusa
Params: requestId: string, readerName: string, state: ConnectionState, atr: string, protocol?: Protocol
SmartCardEmulation.reportError → example
Reports an error result for the given request.
Params: requestId: string, resultCode: ResultCode

↑Events (14)

SmartCardEmulation.establishContextRequested
Fired when |SCardEstablishContext| is called. This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gaa1b8970169fd4883a6dc4a8f43f19b67 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardestablishcontext
Params: requestId: string
SmartCardEmulation.releaseContextRequested
Fired when |SCardReleaseContext| is called. This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga6aabcba7744c5c9419fdd6404f73a934 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardreleasecontext
Params: requestId: string, contextId: integer
SmartCardEmulation.listReadersRequested
Fired when |SCardListReaders| is called. This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga93b07815789b3cf2629d439ecf20f0d9 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardlistreadersa
Params: requestId: string, contextId: integer
SmartCardEmulation.getStatusChangeRequested
Fired when |SCardGetStatusChange| is called. Timeout is specified in milliseconds. This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga33247d5d1257d59e55647c3bb717db24 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardgetstatuschangea
Params: requestId: string, contextId: integer, readerStates: array, timeout?: integer
SmartCardEmulation.cancelRequested
Fired when |SCardCancel| is called. This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gaacbbc0c6d6c0cbbeb4f4debf6fbeeee6 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardcancel
Params: requestId: string, contextId: integer
SmartCardEmulation.connectRequested
Fired when |SCardConnect| is called. This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga4e515829752e0a8dbc4d630696a8d6a5 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardconnecta
Params: requestId: string, contextId: integer, reader: string, shareMode: ShareMode, preferredProtocols: ProtocolSet
SmartCardEmulation.disconnectRequested
Fired when |SCardDisconnect| is called. This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga4be198045c73ec0deb79e66c0ca1738a Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scarddisconnect
Params: requestId: string, handle: integer, disposition: Disposition
SmartCardEmulation.transmitRequested
Fired when |SCardTransmit| is called. This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga9a2d77242a271310269065e64633ab99 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardtransmit
Params: requestId: string, handle: integer, data: string, protocol?: Protocol
SmartCardEmulation.controlRequested
Fired when |SCardControl| is called. This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gac3454d4657110fd7f753b2d3d8f4e32f Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardcontrol
Params: requestId: string, handle: integer, controlCode: integer, data: string
SmartCardEmulation.getAttribRequested
Fired when |SCardGetAttrib| is called. This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gaacfec51917255b7a25b94c5104961602 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardgetattrib
Params: requestId: string, handle: integer, attribId: integer
SmartCardEmulation.setAttribRequested
Fired when |SCardSetAttrib| is called. This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga060f0038a4ddfd5dd2b8fadf3c3a2e4f Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardsetattrib
Params: requestId: string, handle: integer, attribId: integer, data: string
SmartCardEmulation.statusRequested
Fired when |SCardStatus| is called. This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gae49c3c894ad7ac12a5b896bde70d0382 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardstatusa
Params: requestId: string, handle: integer
SmartCardEmulation.beginTransactionRequested
Fired when |SCardBeginTransaction| is called. This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gaddb835dce01a0da1d6ca02d33ee7d861 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardbegintransaction
Params: requestId: string, handle: integer
SmartCardEmulation.endTransactionRequested
Fired when |SCardEndTransaction| is called. This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gae8742473b404363e5c587f570d7e2f3b Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardendtransaction
Params: requestId: string, handle: integer, disposition: Disposition

↑Types (9)

ResultCode (string)
Indicates the PC/SC error code. This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__ErrorCodes.html Microsoft: https://learn.microsoft.com/en-us/windows/win32/secauthn/authentication-return-values
ShareMode (string)
Maps to the |SCARD_SHARE_*| values.
Disposition (string)
Indicates what the reader should do with the card.
ConnectionState (string)
Maps to |SCARD_*| connection state values.
ReaderStateFlags (object)
Maps to the |SCARD_STATE_*| flags.
ProtocolSet (object)
Maps to the |SCARD_PROTOCOL_*| flags.
Protocol (string)
Maps to the |SCARD_PROTOCOL_*| values.
ReaderStateIn (object)
ReaderStateOut (object)

↑Storage experimental

↑Commands (34)

Storage.getStorageKeyForFrame → example
Returns a storage key given a frame id. Deprecated. Please use Storage.getStorageKey instead.
Params: frameId: Page.FrameId
Returns: storageKey: SerializedStorageKey
Storage.getStorageKey → example
Returns storage key for the given frame. If no frame ID is provided, the storage key of the target executing this command is returned.
Params: frameId?: Page.FrameId
Returns: storageKey: SerializedStorageKey
Storage.clearDataForOrigin → example
Clears storage for origin.
Params: origin: string, storageTypes: string
Storage.clearDataForStorageKey → example
Clears storage for storage key.
Params: storageKey: string, storageTypes: string
Storage.getCookies → example
Returns all browser cookies.
Params: browserContextId?: Browser.BrowserContextID
Returns: cookies: array
Storage.setCookies → example
Sets given cookies.
Params: cookies: array, browserContextId?: Browser.BrowserContextID
Storage.clearCookies → example
Clears cookies.
Params: browserContextId?: Browser.BrowserContextID
Storage.getUsageAndQuota → example
Returns usage and quota in bytes.
Params: origin: string
Returns: usage: number, quota: number, overrideActive: boolean, usageBreakdown: array
Storage.overrideQuotaForOrigin → example
Override quota for the specified origin
Params: origin: string, quotaSize?: number
Storage.trackCacheStorageForOrigin → example
Registers origin to be notified when an update occurs to its cache storage list.
Params: origin: string
Storage.trackCacheStorageForStorageKey → example
Registers storage key to be notified when an update occurs to its cache storage list.
Params: storageKey: string
Storage.trackIndexedDBForOrigin → example
Registers origin to be notified when an update occurs to its IndexedDB.
Params: origin: string
Storage.trackIndexedDBForStorageKey → example
Registers storage key to be notified when an update occurs to its IndexedDB.
Params: storageKey: string
Storage.untrackCacheStorageForOrigin → example
Unregisters origin from receiving notifications for cache storage.
Params: origin: string
Storage.untrackCacheStorageForStorageKey → example
Unregisters storage key from receiving notifications for cache storage.
Params: storageKey: string
Storage.untrackIndexedDBForOrigin → example
Unregisters origin from receiving notifications for IndexedDB.
Params: origin: string
Storage.untrackIndexedDBForStorageKey → example
Unregisters storage key from receiving notifications for IndexedDB.
Params: storageKey: string
Storage.getTrustTokens → example
Returns the number of stored Trust Tokens per issuer for the current browsing context.
Returns: tokens: array
Storage.clearTrustTokens → example
Removes all Trust Tokens issued by the provided issuerOrigin. Leaves other stored data, including the issuer's Redemption Records, intact.
Params: issuerOrigin: string
Returns: didDeleteTokens: boolean
Storage.getInterestGroupDetails → example
Gets details for a named interest group.
Params: ownerOrigin: string, name: string
Returns: details: object
Storage.setInterestGroupTracking → example
Enables/Disables issuing of interestGroupAccessed events.
Params: enable: boolean
Storage.setInterestGroupAuctionTracking → example
Enables/Disables issuing of interestGroupAuctionEventOccurred and interestGroupAuctionNetworkRequestCreated.
Params: enable: boolean
Storage.getSharedStorageMetadata → example
Gets metadata for an origin's shared storage.
Params: ownerOrigin: string
Returns: metadata: SharedStorageMetadata
Storage.getSharedStorageEntries → example
Gets the entries in an given origin's shared storage.
Params: ownerOrigin: string
Returns: entries: array
Storage.setSharedStorageEntry → example
Sets entry with `key` and `value` for a given origin's shared storage.
Params: ownerOrigin: string, key: string, value: string, ignoreIfPresent?: boolean
Storage.deleteSharedStorageEntry → example
Deletes entry for `key` (if it exists) for a given origin's shared storage.
Params: ownerOrigin: string, key: string
Storage.clearSharedStorageEntries → example
Clears all entries for a given origin's shared storage.
Params: ownerOrigin: string
Storage.resetSharedStorageBudget → example
Resets the budget for `ownerOrigin` by clearing all budget withdrawals.
Params: ownerOrigin: string
Storage.setSharedStorageTracking → example
Enables/disables issuing of sharedStorageAccessed events.
Params: enable: boolean
Storage.setStorageBucketTracking → example
Set tracking for a storage key's buckets.
Params: storageKey: string, enable: boolean
Storage.deleteStorageBucket → example
Deletes the Storage Bucket with the given storage key and bucket name.
Params: bucket: StorageBucket
Storage.runBounceTrackingMitigations → example
Deletes state for sites identified as potential bounce trackers, immediately.
Returns: deletedSites: array
Storage.getRelatedWebsiteSets → example
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.
Returns: sets: array
Storage.setProtectedAudienceKAnonymity → example
Params: owner: string, name: string, hashes: array

↑Events (11)

Storage.cacheStorageContentUpdated
A cache's contents have been modified.
Params: origin: string, storageKey: string, bucketId: string, cacheName: string
Storage.cacheStorageListUpdated
A cache has been added/deleted.
Params: origin: string, storageKey: string, bucketId: string
Storage.indexedDBContentUpdated
The origin's IndexedDB object store has been modified.
Params: origin: string, storageKey: string, bucketId: string, databaseName: string, objectStoreName: string
Storage.indexedDBListUpdated
The origin's IndexedDB database list has been modified.
Params: origin: string, storageKey: string, bucketId: string
Storage.interestGroupAccessed
One of the interest groups was accessed. Note that these events are global to all targets sharing an interest group store.
Params: accessTime: Network.TimeSinceEpoch, type: InterestGroupAccessType, ownerOrigin: string, name: string, componentSellerOrigin?: string, bid?: number, bidCurrency?: string, uniqueAuctionId?: InterestGroupAuctionId
Storage.interestGroupAuctionEventOccurred
An auction involving interest groups is taking place. These events are target-specific.
Params: eventTime: Network.TimeSinceEpoch, type: InterestGroupAuctionEventType, uniqueAuctionId: InterestGroupAuctionId, parentAuctionId?: InterestGroupAuctionId, auctionConfig?: object
Storage.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).
Params: type: InterestGroupAuctionFetchType, requestId: Network.RequestId, auctions: array
Storage.sharedStorageAccessed
Shared storage was accessed by the associated page. The following parameters are included in all events.
Params: accessTime: Network.TimeSinceEpoch, scope: SharedStorageAccessScope, method: SharedStorageAccessMethod, mainFrameId: Page.FrameId, ownerOrigin: string, ownerSite: string, params: SharedStorageAccessParams
Storage.sharedStorageWorkletOperationExecutionFinished
A shared storage run or selectURL operation finished its execution. The following parameters are included in all events.
Params: finishedTime: Network.TimeSinceEpoch, executionTime: integer, method: SharedStorageAccessMethod, operationId: string, workletTargetId: Target.TargetID, mainFrameId: Page.FrameId, ownerOrigin: string
Storage.storageBucketCreatedOrUpdated
Params: bucketInfo: StorageBucketInfo
Storage.storageBucketDeleted
Params: bucketId: string

↑Types (20)

SerializedStorageKey (string)
StorageType (string)
Enum of possible storage types.
UsageForType (object)
Usage for a storage type.
TrustTokens (object)
Pair of issuer origin and number of available (signed, but not used) Trust Tokens from that issuer.
InterestGroupAuctionId (string)
Protected audience interest group auction identifier.
InterestGroupAccessType (string)
Enum of interest group access types.
InterestGroupAuctionEventType (string)
Enum of auction events.
InterestGroupAuctionFetchType (string)
Enum of network fetches auctions can do.
SharedStorageAccessScope (string)
Enum of shared storage access scopes.
SharedStorageAccessMethod (string)
Enum of shared storage access methods.
SharedStorageEntry (object)
Struct for a single key-value pair in an origin's shared storage.
SharedStorageMetadata (object)
Details for an origin's shared storage.
SharedStoragePrivateAggregationConfig (object)
Represents a dictionary object passed in as privateAggregationConfig to run or selectURL.
SharedStorageReportingMetadata (object)
Pair of reporting metadata details for a candidate URL for `selectURL()`.
SharedStorageUrlWithMetadata (object)
Bundles a candidate URL with its reporting metadata.
SharedStorageAccessParams (object)
Bundles the parameters for shared storage access events whose presence/absence can vary according to SharedStorageAccessType.
StorageBucketsDurability (string)
StorageBucket (object)
StorageBucketInfo (object)
RelatedWebsiteSet (object)
A single Related Website Set object.

↑SystemInfo experimental

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

↑Commands (3)

SystemInfo.getInfo → example
Returns information about the system.
Returns: gpu: GPUInfo, modelName: string, modelVersion: string, commandLine: string
SystemInfo.getFeatureState → example
Returns information about the feature state.
Params: featureState: string
Returns: featureEnabled: boolean
SystemInfo.getProcessInfo → example
Returns information about all running processes.
Returns: processInfo: array

↑Types (8)

GPUDevice (object)
Describes a single graphics processor (GPU).
Size (object)
Describes the width and height dimensions of an entity.
VideoDecodeAcceleratorCapability (object)
Describes a supported video decoding profile with its associated minimum and maximum resolutions.
VideoEncodeAcceleratorCapability (object)
Describes a supported video encoding profile with its associated maximum resolution and maximum framerate.
SubsamplingFormat (string)
YUV subsampling type of the pixels of a given image.
ImageType (string)
Image format of a given image.
GPUInfo (object)
Provides information about the GPU(s) on the system.
ProcessInfo (object)
Represents process info.

↑Target stable

Supports additional targets discovery and allows to attach to them.

↑Commands (19)

Target.activateTarget → example
Activates (focuses) the target.
Params: targetId: TargetID
Target.attachToTarget → example
Attaches to the target with given id.
Params: targetId: TargetID, flatten?: boolean
Returns: sessionId: SessionID
Target.attachToBrowserTarget → example
Attaches to the browser target, only uses flat sessionId mode.
Returns: sessionId: SessionID
Target.closeTarget → example
Closes the target. If the target is a page that gets closed too.
Params: targetId: TargetID
Returns: success: boolean
Target.exposeDevToolsProtocol → example
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.
Params: targetId: TargetID, bindingName?: string, inheritPermissions?: boolean
Target.createBrowserContext → example
Creates a new empty BrowserContext. Similar to an incognito profile but you can have more than one.
Params: disposeOnDetach?: boolean, proxyServer?: string, proxyBypassList?: string, originsWithUniversalNetworkAccess?: array
Returns: browserContextId: Browser.BrowserContextID
Target.getBrowserContexts → example
Returns all browser contexts created with `Target.createBrowserContext` method.
Returns: browserContextIds: array, defaultBrowserContextId: Browser.BrowserContextID
Target.createTarget → example
Creates a new page.
Params: url: string, left?: integer, top?: integer, width?: integer, height?: integer, windowState?: WindowState, browserContextId?: Browser.BrowserContextID, enableBeginFrameControl?: boolean, newWindow?: boolean, background?: boolean, forTab?: boolean, hidden?: boolean, focus?: boolean
Returns: targetId: TargetID
Target.detachFromTarget → example
Detaches session with given id.
Params: sessionId?: SessionID, targetId?: TargetID
Target.disposeBrowserContext → example
Deletes a BrowserContext. All the belonging pages will be closed without calling their beforeunload hooks.
Params: browserContextId: Browser.BrowserContextID
Target.getTargetInfo → example
Returns information about a target.
Params: targetId?: TargetID
Returns: targetInfo: TargetInfo
Target.getTargets → example
Retrieves a list of available targets.
Params: filter?: TargetFilter
Returns: targetInfos: array
Target.sendMessageToTarget → example
Sends protocol message over session with given id. Consider using flat mode instead; see commands attachToTarget, setAutoAttach, and crbug.com/991325.
Params: message: string, sessionId?: SessionID, targetId?: TargetID
Target.setAutoAttach → example
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.
Params: autoAttach: boolean, waitForDebuggerOnStart: boolean, flatten?: boolean, filter?: TargetFilter
Target.autoAttachRelated → example
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.
Params: targetId: TargetID, waitForDebuggerOnStart: boolean, filter?: TargetFilter
Target.setDiscoverTargets → example
Controls whether to discover available targets and notify via `targetCreated/targetInfoChanged/targetDestroyed` events.
Params: discover: boolean, filter?: TargetFilter
Target.setRemoteLocations → example
Enables target discovery for the specified locations, when `setDiscoverTargets` was set to `true`.
Params: locations: array
Target.getDevToolsTarget → example
Gets the targetId of the DevTools page target opened for the given target (if any).
Params: targetId: TargetID
Returns: targetId: TargetID
Target.openDevTools → example
Opens a DevTools window for the target.
Params: targetId: TargetID, panelId?: string
Returns: targetId: TargetID

↑Events (7)

Target.attachedToTarget
Issued when attached to target because of auto-attach or `attachToTarget` command.
Params: sessionId: SessionID, targetInfo: TargetInfo, waitingForDebugger: boolean
Target.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.
Params: sessionId: SessionID, targetId?: TargetID
Target.receivedMessageFromTarget
Notifies about a new protocol message received from the session (as reported in `attachedToTarget` event).
Params: sessionId: SessionID, message: string, targetId?: TargetID
Target.targetCreated
Issued when a possible inspection target is created.
Params: targetInfo: TargetInfo
Target.targetDestroyed
Issued when a target is destroyed.
Params: targetId: TargetID
Target.targetCrashed
Issued when a target has crashed.
Params: targetId: TargetID, status: string, errorCode: integer
Target.targetInfoChanged
Issued when some information about a target has changed. This only happens between `targetCreated` and `targetDestroyed`.
Params: targetInfo: TargetInfo

↑Types (7)

TargetID (string)
SessionID (string)
Unique identifier of attached debugging session.
TargetInfo (object)
FilterEntry (object)
A filter used by target query/discovery/auto-attach operations.
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`).
RemoteLocation (object)
WindowState (string)
The state of the target window.

↑Tethering experimental

The Tethering domain defines methods and events for browser port binding.

↑Commands (2)

Tethering.bind → example
Request browser port binding.
Params: port: integer
Tethering.unbind → example
Request browser port unbinding.
Params: port: integer

↑Events (1)

Tethering.accepted
Informs that port was successfully bound and got a specified connection id.
Params: port: integer, connectionId: string

↑Tracing stable

↑Commands (6)

Tracing.end → example
Stop trace events collection.
Tracing.getCategories → example
Gets supported tracing categories.
Returns: categories: array
Tracing.getTrackEventDescriptor → example
Return a descriptor for all available tracing categories.
Returns: descriptor: string
Tracing.recordClockSyncMarker → example
Record a clock sync marker in the trace.
Params: syncId: string
Tracing.requestMemoryDump → example
Request a global memory dump.
Params: deterministic?: boolean, levelOfDetail?: MemoryDumpLevelOfDetail
Returns: dumpGuid: string, success: boolean
Tracing.start → example
Start trace events collection.
Params: categories?: string, options?: string, bufferUsageReportingInterval?: number, transferMode?: string, streamFormat?: StreamFormat, streamCompression?: StreamCompression, traceConfig?: TraceConfig, perfettoConfig?: string, tracingBackend?: TracingBackend

↑Events (3)

Tracing.bufferUsage
Params: percentFull?: number, eventCount?: number, value?: number
Tracing.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.
Params: value: array
Tracing.tracingComplete
Signals that tracing is stopped and there is no trace buffers pending flush, all data were delivered via dataCollected events.
Params: dataLossOccurred: boolean, stream?: IO.StreamHandle, traceFormat?: StreamFormat, streamCompression?: StreamCompression

↑Types (6)

MemoryDumpConfig (object)
Configuration for memory dump. Used only when "memory-infra" category is enabled.
TraceConfig (object)
StreamFormat (string)
Data format of a trace. Can be either the legacy JSON format or the protocol buffer format. Note that the JSON format will be deprecated soon.
StreamCompression (string)
Compression type to use for traces returned via streams.
MemoryDumpLevelOfDetail (string)
Details exposed when memory request explicitly declared. Keep consistent with memory_dump_request_args.h and memory_instrumentation.mojom
TracingBackend (string)
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`.

↑WebAudio experimental

This domain allows inspection of Web Audio API. https://webaudio.github.io/web-audio-api/

↑Commands (3)

WebAudio.enable → example
Enables the WebAudio domain and starts sending context lifetime events.
WebAudio.disable → example
Disables the WebAudio domain.
WebAudio.getRealtimeData → example
Fetch the realtime data from the registered contexts.
Params: contextId: GraphObjectId
Returns: realtimeData: ContextRealtimeData

↑Events (13)

WebAudio.contextCreated
Notifies that a new BaseAudioContext has been created.
Params: context: BaseAudioContext
WebAudio.contextWillBeDestroyed
Notifies that an existing BaseAudioContext will be destroyed.
Params: contextId: GraphObjectId
WebAudio.contextChanged
Notifies that existing BaseAudioContext has changed some properties (id stays the same)..
Params: context: BaseAudioContext
WebAudio.audioListenerCreated
Notifies that the construction of an AudioListener has finished.
Params: listener: AudioListener
WebAudio.audioListenerWillBeDestroyed
Notifies that a new AudioListener has been created.
Params: contextId: GraphObjectId, listenerId: GraphObjectId
WebAudio.audioNodeCreated
Notifies that a new AudioNode has been created.
Params: node: AudioNode
WebAudio.audioNodeWillBeDestroyed
Notifies that an existing AudioNode has been destroyed.
Params: contextId: GraphObjectId, nodeId: GraphObjectId
WebAudio.audioParamCreated
Notifies that a new AudioParam has been created.
Params: param: AudioParam
WebAudio.audioParamWillBeDestroyed
Notifies that an existing AudioParam has been destroyed.
Params: contextId: GraphObjectId, nodeId: GraphObjectId, paramId: GraphObjectId
WebAudio.nodesConnected
Notifies that two AudioNodes are connected.
Params: contextId: GraphObjectId, sourceId: GraphObjectId, destinationId: GraphObjectId, sourceOutputIndex?: number, destinationInputIndex?: number
WebAudio.nodesDisconnected
Notifies that AudioNodes are disconnected. The destination can be null, and it means all the outgoing connections from the source are disconnected.
Params: contextId: GraphObjectId, sourceId: GraphObjectId, destinationId: GraphObjectId, sourceOutputIndex?: number, destinationInputIndex?: number
WebAudio.nodeParamConnected
Notifies that an AudioNode is connected to an AudioParam.
Params: contextId: GraphObjectId, sourceId: GraphObjectId, destinationId: GraphObjectId, sourceOutputIndex?: number
WebAudio.nodeParamDisconnected
Notifies that an AudioNode is disconnected to an AudioParam.
Params: contextId: GraphObjectId, sourceId: GraphObjectId, destinationId: GraphObjectId, sourceOutputIndex?: number

↑Types (13)

GraphObjectId (string)
An unique ID for a graph object (AudioContext, AudioNode, AudioParam) in Web Audio API
ContextType (string)
Enum of BaseAudioContext types
ContextState (string)
Enum of AudioContextState from the spec
NodeType (string)
Enum of AudioNode types
ChannelCountMode (string)
Enum of AudioNode::ChannelCountMode from the spec
ChannelInterpretation (string)
Enum of AudioNode::ChannelInterpretation from the spec
ParamType (string)
Enum of AudioParam types
AutomationRate (string)
Enum of AudioParam::AutomationRate from the spec
ContextRealtimeData (object)
Fields in AudioContext that change in real-time.
BaseAudioContext (object)
Protocol object for BaseAudioContext
AudioListener (object)
Protocol object for AudioListener
AudioNode (object)
Protocol object for AudioNode
AudioParam (object)
Protocol object for AudioParam

↑WebAuthn experimental

This domain allows configuring virtual authenticators to test the WebAuthn API.

↑Commands (13)

WebAuthn.enable → example
Enable the WebAuthn domain and start intercepting credential storage and retrieval with a virtual authenticator.
Params: enableUI?: boolean
WebAuthn.disable → example
Disable the WebAuthn domain.
WebAuthn.addVirtualAuthenticator → example
Creates and adds a virtual authenticator.
Params: options: VirtualAuthenticatorOptions
Returns: authenticatorId: AuthenticatorId
WebAuthn.setResponseOverrideBits → example
Resets parameters isBogusSignature, isBadUV, isBadUP to false if they are not present.
Params: authenticatorId: AuthenticatorId, isBogusSignature?: boolean, isBadUV?: boolean, isBadUP?: boolean
WebAuthn.removeVirtualAuthenticator → example
Removes the given authenticator.
Params: authenticatorId: AuthenticatorId
WebAuthn.addCredential → example
Adds the credential to the specified authenticator.
Params: authenticatorId: AuthenticatorId, credential: Credential
WebAuthn.getCredential → example
Returns a single credential stored in the given virtual authenticator that matches the credential ID.
Params: authenticatorId: AuthenticatorId, credentialId: string
Returns: credential: Credential
WebAuthn.getCredentials → example
Returns all the credentials stored in the given virtual authenticator.
Params: authenticatorId: AuthenticatorId
Returns: credentials: array
WebAuthn.removeCredential → example
Removes a credential from the authenticator.
Params: authenticatorId: AuthenticatorId, credentialId: string
WebAuthn.clearCredentials → example
Clears all the credentials from the specified device.
Params: authenticatorId: AuthenticatorId
WebAuthn.setUserVerified → example
Sets whether User Verification succeeds or fails for an authenticator. The default is true.
Params: authenticatorId: AuthenticatorId, isUserVerified: boolean
WebAuthn.setAutomaticPresenceSimulation → example
Sets whether tests of user presence will succeed immediately (if true) or fail to resolve (if false) for an authenticator. The default is true.
Params: authenticatorId: AuthenticatorId, enabled: boolean
WebAuthn.setCredentialProperties → example
Allows setting credential properties. https://w3c.github.io/webauthn/#sctn-automation-set-credential-properties
Params: authenticatorId: AuthenticatorId, credentialId: string, backupEligibility?: boolean, backupState?: boolean

↑Events (4)

WebAuthn.credentialAdded
Triggered when a credential is added to an authenticator.
Params: authenticatorId: AuthenticatorId, credential: Credential
WebAuthn.credentialDeleted
Triggered when a credential is deleted, e.g. through PublicKeyCredential.signalUnknownCredential().
Params: authenticatorId: AuthenticatorId, credentialId: string
WebAuthn.credentialUpdated
Triggered when a credential is updated, e.g. through PublicKeyCredential.signalCurrentUserDetails().
Params: authenticatorId: AuthenticatorId, credential: Credential
WebAuthn.credentialAsserted
Triggered when a credential is used in a webauthn assertion.
Params: authenticatorId: AuthenticatorId, credential: Credential

↑Types (6)

AuthenticatorId (string)
AuthenticatorProtocol (string)
Ctap2Version (string)
AuthenticatorTransport (string)
VirtualAuthenticatorOptions (object)
Credential (object)

↑WebMCP experimental

↑Commands (4)

WebMCP.enable → example
Enables the WebMCP domain, allowing events to be sent. Enabling the domain will trigger a toolsAdded event for all currently registered tools.
WebMCP.disable → example
Disables the WebMCP domain.
WebMCP.invokeTool → example
Invokes a registered tool.
Params: frameId: Page.FrameId, toolName: string, input: object
Returns: invocationId: string
WebMCP.cancelInvocation → example
Cancels a pending tool invocation.
Params: invocationId: string

↑Events (4)

WebMCP.toolsAdded
Event fired when new tools are added.
Params: tools: array
WebMCP.toolsRemoved
Event fired when tools are removed.
Params: tools: array
WebMCP.toolInvoked
Event fired when a tool invocation starts.
Params: toolName: string, frameId: Page.FrameId, invocationId: string, input: string
WebMCP.toolResponded
Event fired when a tool invocation completes or fails.
Params: invocationId: string, status: InvocationStatus, output?: any, errorText?: string, exception?: Runtime.RemoteObject

↑Types (4)

Annotation (object)
Tool annotations
InvocationStatus (string)
Represents the status of a tool invocation.
Tool (object)
Definition of a tool that can be invoked.
RemovedTool (object)
Definition of a tool that was removed.
Source: Generated from the official ChromeDevTools/devtools-protocol repository JSON schema files (browser_protocol.json + js_protocol.json).