CefSharp.Core

Used internally to get the underlying instance. Unlikely you'll use this yourself.

the inner most instance

Create a new instance of

set to false if you plan to reuse the instance, otherwise true BrowserSettings

SelfHost allows your application executable to be used as the BrowserSubProcess with minimal effort. https://github.com/cefsharp/CefSharp/wiki/SelfHost-BrowserSubProcess

//WinForms Example public class Program { [STAThread] public static int Main(string[] args) { var exitCode = CefSharp.BrowserSubprocess.SelfHost.Main(args); if (exitCode >= 0) { return exitCode; } var settings = new CefSettings(); //Absolute path to your applications executable settings.BrowserSubprocessPath = System.Diagnostics.Process.GetCurrentProcess().MainModule.FileName; Cef.Initialize(settings); var browser = new BrowserForm(true); Application.Run(browser); return 0; } }

This function should be called from the application entry point function (typically Program.Main) to execute a secondary process e.g. gpu, renderer, utility This overload is specifically used for .Net Core. For hosting your own BrowserSubProcess it's preferable to use the Main method provided by this class. - Pass in command line args

command line args If called for the browser process (identified by no "type" command-line value) it will return immediately with a value of -1. If called for a recognized secondary process it will block until the process should exit and then return the process exit code.

Global CEF methods are exposed through this class. e.g. CefInitalize maps to Cef.Initialize CEF API Doc https://magpcss.org/ceforum/apidocs3/projects/(default)/(_globals).html This class cannot be inherited.

Event is raised when is called, before the shutdown logic is executed.

Will be called on the same thread as

Gets a value that indicates whether CefSharp is initialized.

true if CefSharp is initialized; otherwise, false.

Gets a value that indicates whether CefSharp was shutdown.

true if CefSharp was shutdown; otherwise, false.

Gets a value that indicates the version of CefSharp currently being used.

The CefSharp version.

Gets a value that indicates the CEF version currently being used.

The CEF Version

Gets a value that indicates the Chromium version currently being used.

The Chromium version.

Gets a value that indicates the Git Hash for CEF version currently being used.

The Git Commit Hash

Parse the specified url into its component parts. Uses a GURL to parse the Url. GURL is Google's URL parsing library.

url Returns null if the URL is empty or invalid.

Initializes CefSharp with user-provided settings. It's important to note that Initialize and Shutdown MUST be called on your main application thread (typically the UI thread). If you call them on different threads, your application will hang. See the documentation for Cef.Shutdown() for more details.

CefSharp configuration settings. true if successful; otherwise, false.

Initializes CefSharp with user-provided settings. It's important to note that Initialize/Shutdown MUST be called on your main application thread (typically the UI thread). If you call them on different threads, your application will hang. See the documentation for Cef.Shutdown() for more details.

CefSharp configuration settings. Check that all relevant dependencies available, throws exception if any are missing true if successful; otherwise, false.

CefSharp configuration settings. Check that all relevant dependencies available, throws exception if any are missing Implement this interface to provide handler implementations. Null if you don't wish to handle these events true if successful; otherwise, false.

Initializes CefSharp with user-provided settings. This method allows you to wait for to be called before continuing. It's important to note that Initialize and Shutdown MUST be called on your main application thread (typically the UI thread). If you call them on different threads, your application will hang. See the documentation for Cef.Shutdown() for more details.

CefSharp configuration settings. Check that all relevant dependencies available, throws exception if any are missing The handler for functionality specific to the browser process. Null if you don't wish to handle these events returns a Task that can be awaited. true if successful; otherwise, false. If false check the log file for possible errors If successful then the Task will be completed successfully when is called. If successful then the continuation will happen syncrionously on the CEF UI thread.

Run the CEF message loop. Use this function instead of an application- provided message loop to get the best balance between performance and CPU usage. This function should only be called on the main application thread and only if Cef.Initialize() is called with a CefSettings.MultiThreadedMessageLoop value of false. This function will block until a quit message is received by the system.

Quit the CEF message loop that was started by calling Cef.RunMessageLoop(). This function should only be called on the main application thread and only if Cef.RunMessageLoop() was used.

Perform a single iteration of CEF message loop processing.This function is provided for cases where the CEF message loop must be integrated into an existing application message loop. Use of this function is not recommended for most users; use CefSettings.MultiThreadedMessageLoop if possible (the default). When using this function care must be taken to balance performance against excessive CPU usage. It is recommended to enable the CefSettings.ExternalMessagePump option when using this function so that IBrowserProcessHandler.OnScheduleMessagePumpWork() callbacks can facilitate the scheduling process. This function should only be called on the main application thread and only if Cef.Initialize() is called with a CefSettings.MultiThreadedMessageLoop value of false. This function will not block.

This function should be called from the application entry point function to execute a secondary process. It can be used to run secondary processes from the browser client executable (default behavior) or from a separate executable specified by the CefSettings.browser_subprocess_path value. If called for the browser process (identified by no "type" command-line value) it will return immediately with a value of -1. If called for a recognized secondary process it will block until the process should exit and then return the process exit code. The |application| parameter may be empty. The |windows_sandbox_info| parameter is only used on Windows and may be NULL (see cef_sandbox_win.h for details).

Add an entry to the cross-origin whitelist.

The origin allowed to be accessed by the target protocol/domain. The target protocol allowed to access the source origin. The optional target domain allowed to access the source origin. If set to true would allow a blah.example.com if the was set to example.com Returns false if is invalid or the whitelist cannot be accessed. The same-origin policy restricts how scripts hosted from different origins (scheme + domain + port) can communicate. By default, scripts can only access resources with the same origin. Scripts hosted on the HTTP and HTTPS schemes (but no other schemes) can use the "Access-Control-Allow-Origin" header to allow cross-origin requests. For example, https://source.example.com can make XMLHttpRequest requests on http://target.example.com if the http://target.example.com request returns an "Access-Control-Allow-Origin: https://source.example.com" response header. Scripts in separate frames or iframes and hosted from the same protocol and domain suffix can execute cross-origin JavaScript if both pages set the document.domain value to the same domain suffix. For example, scheme://foo.example.com and scheme://bar.example.com can communicate using JavaScript if both domains set document.domain="example.com". This method is used to allow access to origins that would otherwise violate the same-origin policy. Scripts hosted underneath the fully qualified URL (like http://www.example.com) will be allowed access to all resources hosted on the specified and . If is non-empty and if false only exact domain matches will be allowed. If contains a top- level domain component (like "example.com") and is true sub-domain matches will be allowed. If is empty and if true all domains and IP addresses will be allowed. This method cannot be used to bypass the restrictions on local or display isolated schemes. See the comments on for more information. This function may be called on any thread. Returns false if is invalid or the whitelist cannot be accessed.

Remove entry from cross-origin whitelist

Remove all entries from the cross-origin access whitelist.

Remove all entries from the cross-origin access whitelist. Returns false if the whitelist cannot be accessed.

Returns the global cookie manager. By default data will be stored at CefSettings.CachePath if specified or in memory otherwise. Using this method is equivalent to calling Cef.GetGlobalRequestContext().GetCookieManager() The cookie managers storage is created in an async fashion, whilst this method may return a cookie manager instance, there may be a short delay before you can Get/Write cookies. To be sure the cookie manager has been initialized use one of the following - Access the ICookieManager after ICompletionCallback.OnComplete has been called - Access the ICookieManager instance in IBrowserProcessHandler.OnContextInitialized. - Use the ChromiumWebBrowser BrowserInitialized (OffScreen) or IsBrowserInitializedChanged (WinForms/WPF) events.

If non-NULL it will be executed asynchronously on the CEF UI thread after the manager's storage has been initialized. A the global cookie manager or null if the RequestContext has not yet been initialized.

Called prior to calling Cef.Shutdown, this disposes of any remaining ChromiumWebBrowser instances. In WPF this is used from Dispatcher.ShutdownStarted to release the unmanaged resources held by the ChromiumWebBrowser instances. Generally speaking you don't need to call this yourself.

Shuts down CefSharp and the underlying CEF infrastructure. This method is safe to call multiple times; it will only shut down CEF on the first call (all subsequent calls will be ignored). This method should be called on the main application thread to shut down the CEF browser process before the application exits. If you are Using CefSharp.OffScreen then you must call this explicitly before your application exits or it will hang. This method must be called on the same thread as Initialize. If you don't call Shutdown explicitly then CefSharp.Wpf and CefSharp.WinForms versions will do their best to call Shutdown for you, if your application is having trouble closing then call thus explicitly.

This method should only be used by advanced users, if you're unsure then use Cef.Shutdown(). This function should be called on the main application thread to shut down the CEF browser process before the application exits. This method simply obtains a lock and calls the native CefShutdown method, only IsInitialized is checked. All ChromiumWebBrowser instances MUST be Disposed of before calling this method. If calling this method results in a crash or hangs then you're likely hanging on to some unmanaged resources or haven't closed all of your browser instances

Clear all scheme handler factories registered with the global request context. Returns false on error. This function may be called on any thread in the browser process. Using this function is equivalent to calling Cef.GetGlobalRequestContext().ClearSchemeHandlerFactories().

Returns false on error.

Returns true if called on the specified CEF thread.

Returns true if called on the specified thread.

Gets the Global Request Context. Make sure to Dispose of this object when finished. The earlier possible place to access the IRequestContext is in IBrowserProcessHandler.OnContextInitialized. Alternative use the ChromiumWebBrowser BrowserInitialized (OffScreen) or IsBrowserInitializedChanged (WinForms/WPF) events.

Returns the global request context or null if the RequestContext has not been initialized yet.

Helper function (wrapper around the CefColorSetARGB macro) which combines the 4 color components into an uint32 for use with BackgroundColor property

Alpha Red Green Blue Returns the color.

Crash reporting is configured using an INI-style config file named crash_reporter.cfg. This file must be placed next to the main application executable. File contents are as follows: # Comments start with a hash character and must be on their own line. [Config] ProductName=<Value of the "prod" crash key; defaults to "cef"> ProductVersion=<Value of the "ver" crash key; defaults to the CEF version> AppName=<Windows only; App-specific folder name component for storing crash information; default to "CEF"> ExternalHandler=<Windows only; Name of the external handler exe to use instead of re-launching the main exe; default to empty> ServerURL=<crash server URL; default to empty> RateLimitEnabled=<True if uploads should be rate limited; default to true> MaxUploadsPerDay=<Max uploads per 24 hours, used if rate limit is enabled; default to 5> MaxDatabaseSizeInMb=<Total crash report disk usage greater than this value will cause older reports to be deleted; default to 20> MaxDatabaseAgeInDays=<Crash reports older than this value will be deleted; default to 5> [CrashKeys] my_key1=<small|medium|large> my_key2=<small|medium|large> Config section: If "ProductName" and/or "ProductVersion" are set then the specified values will be included in the crash dump metadata. If "AppName" is set on Windows then crash report information (metrics, database and dumps) will be stored locally on disk under the "C:\Users\[CurrentUser]\AppData\Local\[AppName]\User Data" folder. If "ExternalHandler" is set on Windows then the specified exe will be launched as the crashpad-handler instead of re-launching the main process exe. The value can be an absolute path or a path relative to the main exe directory. If "ServerURL" is set then crashes will be uploaded as a multi-part POST request to the specified URL. Otherwise, reports will only be stored locally on disk. If "RateLimitEnabled" is set to true then crash report uploads will be rate limited as follows: 1. If "MaxUploadsPerDay" is set to a positive value then at most the specified number of crashes will be uploaded in each 24 hour period. 2. If crash upload fails due to a network or server error then an incremental backoff delay up to a maximum of 24 hours will be applied for retries. 3. If a backoff delay is applied and "MaxUploadsPerDay" is > 1 then the "MaxUploadsPerDay" value will be reduced to 1 until the client is restarted. This helps to avoid an upload flood when the network or server error is resolved. If "MaxDatabaseSizeInMb" is set to a positive value then crash report storage on disk will be limited to that size in megabytes. For example, on Windows each dump is about 600KB so a "MaxDatabaseSizeInMb" value of 20 equates to about 34 crash reports stored on disk. If "MaxDatabaseAgeInDays" is set to a positive value then crash reports older than the specified age in days will be deleted. CrashKeys section: Any number of crash keys can be specified for use by the application. Crash key values will be truncated based on the specified size (small = 63 bytes, medium = 252 bytes, large = 1008 bytes). The value of crash keys can be set from any thread or process using the Cef.SetCrashKeyValue function. These key/value pairs will be sent to the crash server along with the crash dump file. Medium and large values will be chunked for submission. For example, if your key is named "mykey" then the value will be broken into ordered chunks and submitted using keys named "mykey-1", "mykey-2", etc.

Returns true if crash reporting is enabled.

Sets or clears a specific key-value pair from the crash metadata.

key value

Gets the current log level. When is set to then no messages will be written to the log file, but FATAL messages will still be output to stderr. When logging is disabled this method will return .

Current Log Level

Returns the mime type for the specified file extension or an empty string if unknown.

file extension Returns the mime type for the specified file extension or an empty string if unknown.

WaitForBrowsersToClose is not enabled by default, call this method before Cef.Initialize to enable. If you aren't calling Cef.Initialize explicitly then this should be called before creating your first ChromiumWebBrowser instance.

Helper method to ensure all ChromiumWebBrowser instances have been closed/disposed, should be called before Cef.Shutdown. Disposes all remaining ChromiumWebBrowser instances then waits for CEF to release its remaining CefBrowser instances. Finally a small delay of 50ms to allow for CEF to finish it's cleanup. Should only be called when MultiThreadedMessageLoop = true; (Hasn't been tested when when CEF integrates into main message loop).

The timeout in miliseconds.

Post an action for delayed execution on the specified thread.

thread id action to execute delay in ms bool

Post an action for execution on the specified thread.

thread id action to execute bool

Initialization settings. Many of these and other settings can also configured using command-line switches. WPF/WinForms/OffScreen each have their own CefSettings implementation that sets relevant settings e.g. OffScreen starts with audio muted.

Free the unmanaged CefSettingsBase instance. Under normal circumstances you shouldn't need to call this The unmanaged resource will be freed after (or one of the overloads) is called.

Gets a value indicating if the CefSettings has been disposed.

Add Customs schemes to this collection.

Add custom command line argumens to this collection, they will be added in OnBeforeCommandLineProcessing. The CefSettings.CommandLineArgsDisabled value can be used to start with an empty command-line object. Any values specified in CefSettings that equate to command-line arguments will be set before this method is called.

**Experimental** Set to true to enable use of the Chrome runtime in CEF. This feature is considered experimental and is not recommended for most users at this time. See issue https://github.com/chromiumembedded/cef/issues/2969

Set to true to disable configuration of browser process features using standard CEF and Chromium command-line arguments. Configuration can still be specified using CEF data structures or by adding to CefCommandLineArgs.

Set to true to control browser process main (UI) thread message pump scheduling via the IBrowserProcessHandler.OnScheduleMessagePumpWork callback. This option is recommended for use in combination with the Cef.DoMessageLoopWork() function in cases where the CEF message loop must be integrated into an existing application message loop (see additional comments and warnings on Cef.DoMessageLoopWork). Enabling this option is not recommended for most users; leave this option disabled and use either MultiThreadedMessageLoop (the default) if possible.

Set to true to have the browser process message loop run in a separate thread. If false then the CefDoMessageLoopWork() function must be called from your application message loop. This option is only supported on Windows. The default value is true.

The path to a separate executable that will be launched for sub-processes. By default the browser process executable is used. See the comments on Cef.ExecuteProcess() for details. If this value is non-empty then it must be an absolute path. Also configurable using the "browser-subprocess-path" command-line switch. Defaults to using the provided CefSharp.BrowserSubprocess.exe instance

The location where data for the global browser cache will be stored on disk. In this value is non-empty then it must be an absolute path that is must be either equal to or a child directory of CefSettings.RootCachePath (if RootCachePath is empty it will default to this value). If the value is empty then browsers will be created in "incognito mode" where in-memory caches are used for storage and no data is persisted to disk. HTML5 databases such as localStorage will only persist across sessions if a cache path is specified. Can be overridden for individual RequestContext instances via the RequestContextSettings.CachePath value.

The root directory that all CefSettings.CachePath and RequestContextSettings.CachePath values must have in common. If this value is empty and CefSettings.CachePath is non-empty then it will default to the CefSettings.CachePath value. If this value is non-empty then it must be an absolute path. Failure to set this value correctly may result in the sandbox blocking read/write access to the CachePath directory. NOTE: CefSharp does not implement the CHROMIUM SANDBOX. A non-empty RootCachePath can be used in conjuncation with an empty CefSettings.CachePath in instances where you would like browsers attached to the Global RequestContext (the default) created in "incognito mode" and instances created with a custom RequestContext using a disk based cache.

Set to true in order to completely ignore SSL certificate errors. This is NOT recommended.

The locale string that will be passed to WebKit. If empty the default locale of "en-US" will be used. Also configurable using the "lang" command-line switch.

The fully qualified path for the locales directory. If this value is empty the locales directory must be located in the module directory. If this value is non-empty then it must be an absolute path. Also configurable using the "locales-dir-path" command-line switch.

The fully qualified path for the resources directory. If this value is empty the cef.pak and/or devtools_resources.pak files must be located in the module directory. Also configurable using the "resources-dir-path" command-line switch.

The directory and file name to use for the debug log. If empty a default log file name and location will be used. On Windows a "debug.log" file will be written in the main executable directory. Also configurable using the"log-file" command- line switch.

The log severity. Only messages of this severity level or higher will be logged. When set to no messages will be written to the log file, but Fatal messages will still be output to stderr. Also configurable using the "log-severity" command-line switch with a value of "verbose", "info", "warning", "error", "fatal", "error-report" or "disable".

Custom flags that will be used when initializing the V8 JavaScript engine. The consequences of using custom flags may not be well tested. Also configurable using the "js-flags" command-line switch.

Set to true to disable loading of pack files for resources and locales. A resource bundle handler must be provided for the browser and render processes via CefApp.GetResourceBundleHandler() if loading of pack files is disabled. Also configurable using the "disable-pack-loading" command- line switch.

Value that will be inserted as the product portion of the default User-Agent string. If empty the Chromium product version will be used. If UserAgent is specified this value will be ignored. Also configurable using the "user-agent-product" command- line switch.

Set to a value between 1024 and 65535 to enable remote debugging on the specified port. For example, if 8080 is specified the remote debugging URL will be http://localhost:8080. CEF can be remotely debugged from any CEF or Chrome browser window. Also configurable using the "remote-debugging-port" command-line switch.

The number of stack trace frames to capture for uncaught exceptions. Specify a positive value to enable the CefRenderProcessHandler. OnUncaughtException() callback. Specify 0 (default value) and OnUncaughtException() will not be called. Also configurable using the "uncaught-exception-stack-size" command-line switch.

Value that will be returned as the User-Agent HTTP header. If empty the default User-Agent string will be used. Also configurable using the "user-agent" command-line switch.

Set to true (1) to enable windowless (off-screen) rendering support. Do not enable this value if the application does not use windowless rendering as it may reduce rendering performance on some systems.

To persist session cookies (cookies without an expiry date or validity interval) by default when using the global cookie manager set this value to true. Session cookies are generally intended to be transient and most Web browsers do not persist them. A CachePath value must also be specified to enable this feature. Also configurable using the "persist-session-cookies" command-line switch. Can be overridden for individual RequestContext instances via the RequestContextSettings.PersistSessionCookies value.

To persist user preferences as a JSON file in the cache path directory set this value to true. A CachePath value must also be specified to enable this feature. Also configurable using the "persist-user-preferences" command-line switch. Can be overridden for individual RequestContext instances via the RequestContextSettings.PersistUserPreferences value.

Comma delimited ordered list of language codes without any whitespace that will be used in the "Accept-Language" HTTP header. May be set globally using the CefSettings.AcceptLanguageList value. If both values are empty then "en-US,en" will be used.

Background color used for the browser before a document is loaded and when no document color is specified. The alpha component must be either fully opaque (0xFF) or fully transparent (0x00). If the alpha component is fully opaque then the RGB components will be used as the background color. If the alpha component is fully transparent for a WinForms browser then the default value of opaque white be used. If the alpha component is fully transparent for a windowless (WPF/OffScreen) browser then transparent painting will be enabled.

Comma delimited list of schemes supported by the associated ICookieManager. If CookieableSchemesExcludeDefaults is false the default schemes ("http", "https", "ws" and "wss") will also be supported. Specifying a CookieableSchemesList value and setting CookieableSchemesExcludeDefaults to true will disable all loading and saving of cookies for this manager. Can be overridden for individual RequestContext instances via the RequestContextSettings.CookieableSchemesList and RequestContextSettings.CookieableSchemesExcludeDefaults values.

If CookieableSchemesExcludeDefaults is false the default schemes ("http", "https", "ws" and "wss") will also be supported. Specifying a CookieableSchemesList value and setting CookieableSchemesExcludeDefaults to true will disable all loading and saving of cookies for this manager. Can be overridden for individual RequestContext instances via the RequestContextSettings.CookieableSchemesList and RequestContextSettings.CookieableSchemesExcludeDefaults values.

Registers a custom scheme using the provided settings.

The CefCustomScheme which provides the details about the scheme.

Set command line argument to disable GPU Acceleration. WebGL will use software rendering

Set command line argument to enable Print Preview See https://github.com/chromiumembedded/cef/issues/123/add-support-for-print-preview for details.

Set command line arguments for best OSR (Offscreen and WPF) Rendering performance Software Rendering will be used for WebGL, look at the source to determine which flags best suite your requirements.

Extensions for accessing DevTools through

Execute a method call over the DevTools protocol. This is a more structured version of SendDevToolsMessage. See the DevTools protocol documentation at https://chromedevtools.github.io/devtools-protocol/ for details of supported methods and the expected JSON message format. See the SendDevToolsMessage documentation for additional usage information.

browser host is an incremental number that uniquely identifies the message (pass 0 to have the next number assigned automatically based on previous values) is the method name are the method parameters represented as a , which may be empty. return the assigned message Id if called on the CEF UI thread and the message was successfully submitted for validation, otherwise 0

Execute a method call over the DevTools protocol. This is a more structured version of SendDevToolsMessage. can only be called on the CEF UI Thread, this method can be called on any thread. See the DevTools protocol documentation at https://chromedevtools.github.io/devtools-protocol/ for details of supported methods and the expected dictionary contents. See the SendDevToolsMessage documentation for additional usage information.

the browser instance is an incremental number that uniquely identifies the message (pass 0 to have the next number assigned automatically based on previous values) is the method name are the method parameters represented as a dictionary, which may be empty. return a Task that can be awaited to obtain the assigned message Id. If the message was unsuccessfully submitted for validation, this value will be 0.

the ChromiumWebBrowser instance is an incremental number that uniquely identifies the message (pass 0 to have the next number assigned automatically based on previous values) is the method name are the method parameters represented as a dictionary, which may be empty. return a Task that can be awaited to obtain the assigned message Id. If the message was unsuccessfully submitted for validation, this value will be 0.

Gets a new Instance of the DevTools client for the chromiumWebBrowser instance.

the chromiumWebBrowser instance DevToolsClient

Gets a new Instance of the DevTools client

the IBrowser instance DevToolsClient

Set the Document Content for the Main Frame using DevTools Protocol.

ChromiumWebBrowser instance html Task that can be awaited to determine if the content was successfully updated.

Set the Document Content for the Main Frame using DevTools Protocol.

the browser instance html Task that can be awaited to determine if the content was successfully updated.

DevTool Client

Generated DevToolsClient methods

Capture the current so continuation executes on the original calling thread. If is null for then the continuation will be run on the CEF UI Thread (by default this is not the same as the WPF/WinForms UI Thread).

When not null provided will be used to run the contination. Defaults to null Setting this property will change to false.

DevToolsClient

Browser associated with this DevTools client

Store a reference to the IRegistration that's returned when you register an observer.

registration

Execute a method call over the DevTools protocol. This method can be called on any thread. See the DevTools protocol documentation at https://chromedevtools.github.io/devtools-protocol/ for details of supported methods and the expected dictionary contents.

is the method name are the method parameters represented as a dictionary, which may be empty. return a Task that can be awaited to obtain the method result

The type into which the result will be deserialzed. is the method name are the method parameters represented as a dictionary, which may be empty. return a Task that can be awaited to obtain the method result

Deserialize the JSON stream into a .Net object. For .Net Core/.Net 5.0 uses System.Text.Json for .Net 4.6.2 uses System.Runtime.Serialization.Json

Object type event Name JSON stream object of type

Deserialize the JSON stream into a .Net object. For .Net Core/.Net 5.0 uses System.Text.Json for .Net 4.6.2 uses System.Runtime.Serialization.Json

Object type JSON stream object of type

Deserialize the JSON stream into a .Net object. For .Net Core/.Net 5.0 uses System.Text.Json for .Net 4.6.2 uses System.Runtime.Serialization.Json

Object type JSON stream object of type

Accessibility

Animation

Audits domain allows investigation of page violations and possible improvements.

Defines commands and events for Autofill.

Defines events for background web platform features.

The Browser domain defines methods and events for browser managing.

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.

CacheStorage

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

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.

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.

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.

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

Query and modify DOM storage.

Database

DeviceOrientation

This domain emulates different environments for the page.

This domain provides experimental commands only supported in headless mode.

Input/Output operations for streams produced by DevTools.

IndexedDB

Input

Inspector

LayerTree

Provides access to log entries.

Memory

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.

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

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

Performance

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

Security

ServiceWorker

Storage

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

Supports additional targets discovery and allows to attach to them.

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

Tracing

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

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

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

This domain allows detailed inspection of media elements

DeviceAccess

Preload

This domain allows interacting with the FedCM dialog.

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

HeapProfiler

Profiler

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.

Enum of possible property types.

boolean

tristate

booleanOrUndefined

idref

idrefList

integer

node

nodeList

number

string

computedString

token

tokenList

domRelation

role

internalRole

valueUndefined

Enum of possible property sources.

attribute

implicit

style

contents

placeholder

relatedElement

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

description

figcaption

label

labelfor

labelwrapped

legend

rubyannotation

tablecaption

title

other

A single source for a computed AX property.

What type of source this is.

The value of this property source.

The name of the relevant attribute, if any.

The value of the relevant attribute, if any.

Whether this source is superseded by a higher priority source.

The native markup source for this value, e.g. a `<label>` element.

The value, such as a node or node list, of the native source.

Whether the value for this property is invalid.

Reason for the value being invalid, if it is.

AXRelatedNode

The BackendNodeId of the related DOM node.

The IDRef value provided, if any.

The text alternative of this node in the current context.

AXProperty

The name of this property.

The value of this property.

A single computed AX property.

The type of this value.

The computed value of this property.

One or more related nodes, if applicable.

The sources which contributed to the computation of this property.

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.

busy

disabled

editable

focusable

focused

hidden

hiddenRoot

invalid

keyshortcuts

settable

roledescription

live

atomic

relevant

root

autocomplete

hasPopup

level

multiselectable

orientation

multiline

readonly

required

valuemin

valuemax

valuetext

checked

expanded

modal

pressed

selected

activedescendant

controls

describedby

details

errormessage

flowto

labelledby

owns

A node in the accessibility tree.

Unique identifier for this node.

Whether this node is ignored for accessibility

Collection of reasons why this node is hidden.

This `Node`'s role, whether explicit or implicit.

This `Node`'s Chrome raw role.

The accessible name for this `Node`.

The accessible description for this `Node`.

The value for this `Node`.

All other properties

ID for this node's parent.

IDs for each of this node's child nodes.

The backend ID for the associated DOM node, if any.

The frame ID for the frame associated with this nodes document.

The loadComplete event mirrors the load complete event sent by the browser to assistive technology when the web page has finished loading.

New document root node.

The nodesUpdated event is sent every time a previously requested node has changed the in tree.

Updated node data.

GetPartialAXTreeResponse

nodes

GetFullAXTreeResponse

nodes

GetRootAXNodeResponse

node

GetAXNodeAndAncestorsResponse

nodes

GetChildAXNodesResponse

nodes

QueryAXTreeResponse

nodes

Accessibility

DevToolsClient

The loadComplete event mirrors the load complete event sent by the browser to assistive technology when the web page has finished loading.

The nodesUpdated event is sent every time a previously requested node has changed the in tree.

Disables the accessibility domain.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

Identifier of the node to get the partial accessibility tree for. Identifier of the backend node to get the partial accessibility tree for. JavaScript object id of the node wrapper to get the partial accessibility tree for. Whether to fetch this node's ancestors, siblings and children. Defaults to true. returns System.Threading.Tasks.Task<GetPartialAXTreeResponse>

Fetches the entire accessibility tree for the root Document

The maximum depth at which descendants of the root node should be retrieved.If omitted, the full tree is returned. The frame for whose document the AX tree should be retrieved.If omitted, the root frame is used. returns System.Threading.Tasks.Task<GetFullAXTreeResponse>

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

The frame in whose document the node resides.If omitted, the root frame is used. returns System.Threading.Tasks.Task<GetRootAXNodeResponse>

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

Identifier of the node to get. Identifier of the backend node to get. JavaScript object id of the node wrapper to get. returns System.Threading.Tasks.Task<GetAXNodeAndAncestorsResponse>

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

id The frame in whose document the node resides.If omitted, the root frame is used. returns System.Threading.Tasks.Task<GetChildAXNodesResponse>

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.

Identifier of the node for the root to query. Identifier of the backend node for the root to query. JavaScript object id of the node wrapper for the root to query. Find nodes with this computed name. Find nodes with this computed role. returns System.Threading.Tasks.Task<QueryAXTreeResponse>

Animation type of `Animation`.

CSSTransition

CSSAnimation

WebAnimation

Animation instance.

`Animation`'s id.

`Animation`'s name.

`Animation`'s internal paused state.

`Animation`'s play state.

`Animation`'s playback rate.

`Animation`'s start time. Milliseconds for time based animations and percentage [0 - 100] for scroll driven animations (i.e. when viewOrScrollTimeline exists).

`Animation`'s current time.

Animation type of `Animation`.

`Animation`'s source animation node.

A unique ID for `Animation` representing the sources that triggered this CSS animation/transition.

View or scroll timeline

Timeline instance

Scroll container node

Represents the starting scroll position of the timeline as a length offset in pixels from scroll origin.

Represents the ending scroll position of the timeline as a length offset in pixels from scroll origin.

The element whose principal box's visibility in the scrollport defined the progress of the timeline. Does not exist for animations with ScrollTimeline

Orientation of the scroll

AnimationEffect instance

`AnimationEffect`'s delay.

`AnimationEffect`'s end delay.

`AnimationEffect`'s iteration start.

`AnimationEffect`'s iterations.

`AnimationEffect`'s iteration duration. Milliseconds for time based animations and percentage [0 - 100] for scroll driven animations (i.e. when viewOrScrollTimeline exists).

`AnimationEffect`'s playback direction.

`AnimationEffect`'s fill mode.

`AnimationEffect`'s target node.

`AnimationEffect`'s keyframes.

`AnimationEffect`'s timing function.

Keyframes Rule

CSS keyframed animation's name.

List of animation keyframes.

Keyframe Style

Keyframe's time offset.

`AnimationEffect`'s timing function.

Event for when an animation has been cancelled.

Id of the animation that was cancelled.

Event for each animation that has been created.

Id of the animation that was created.

Event for animation that has been started.

Animation that was started.

GetCurrentTimeResponse

currentTime

GetPlaybackRateResponse

playbackRate

ResolveAnimationResponse

remoteObject

Animation

DevToolsClient

Event for when an animation has been cancelled.

Event for each animation that has been created.

Event for animation that has been started.

Disables animation domain notifications.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Enables animation domain notifications.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Returns the current time of the an animation.

Id of animation. returns System.Threading.Tasks.Task<GetCurrentTimeResponse>

Gets the playback rate of the document timeline.

returns System.Threading.Tasks.Task<GetPlaybackRateResponse>

Releases a set of animations to no longer be manipulated.

List of animation ids to seek. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Gets the remote object of the Animation.

Animation id. returns System.Threading.Tasks.Task<ResolveAnimationResponse>

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

List of animation ids to seek. Set the current time of each animation. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Sets the paused state of a set of animations.

Animations to set the pause state of. Paused state to set to. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Sets the playback rate of the document timeline.

Playback rate for animations on page returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Sets the timing of an animation node.

Animation id. Duration of the animation. Delay of the animation. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

The following three properties uniquely identify a cookie

Path

Domain

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

The unique request id.

Url

Information about the frame affected by an inspector issue.

FrameId

CookieExclusionReason

ExcludeSameSiteUnspecifiedTreatedAsLax

ExcludeSameSiteNoneInsecure

ExcludeSameSiteLax

ExcludeSameSiteStrict

ExcludeInvalidSameParty

ExcludeSamePartyCrossPartyContext

ExcludeDomainNonASCII

ExcludeThirdPartyCookieBlockedInFirstPartySet

ExcludeThirdPartyPhaseout

CookieWarningReason

WarnSameSiteUnspecifiedCrossSiteContext

WarnSameSiteNoneInsecure

WarnSameSiteUnspecifiedLaxAllowUnsafe

WarnSameSiteStrictLaxDowngradeStrict

WarnSameSiteStrictCrossDowngradeStrict

WarnSameSiteStrictCrossDowngradeLax

WarnSameSiteLaxCrossDowngradeStrict

WarnSameSiteLaxCrossDowngradeLax

WarnAttributeValueExceedsMaxSize

WarnDomainNonASCII

WarnThirdPartyPhaseout

WarnCrossSiteRedirectDowngradeChangesInclusion

CookieOperation

SetCookie

ReadCookie

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.

If AffectedCookie is not set then rawCookieLine contains the raw Set-Cookie header string. This hints at a problem where the cookie line is syntactically or semantically malformed in a way that no valid cookie could be created.

RawCookieLine

CookieWarningReasons

CookieExclusionReasons

Optionally identifies the site-for-cookies and the cookie url, which may be used by the front-end as additional context.

SiteForCookies

CookieUrl

Request

MixedContentResolutionStatus

MixedContentBlocked

MixedContentAutomaticallyUpgraded

MixedContentWarning

MixedContentResourceType

AttributionSrc

Audio

Beacon

CSPReport

Download

EventSource

Favicon

Font

Form

Frame

Image

Import

JSON

Manifest

Ping

PluginData

PluginResource

Prefetch

Resource

Script

ServiceWorker

SharedWorker

SpeculationRules

Stylesheet

Track

Video

Worker

XMLHttpRequest

XSLT

MixedContentIssueDetails

The type of resource causing the mixed content issue (css, js, iframe, form,...). Marked as optional because it is mapped to from blink::mojom::RequestContextType, which will be replaced by network::mojom::RequestDestination

The way the mixed content issue is being resolved.

The unsafe http url causing the mixed content issue.

The url responsible for the call to an unsafe url.

The mixed content request. Does not always exist (e.g. for unsafe form submission urls).

Optional because not every mixed content issue is necessarily linked to a frame.

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

CoepFrameResourceNeedsCoepHeader

CoopSandboxedIFrameCannotNavigateToCoopPage

CorpNotSameOrigin

CorpNotSameOriginAfterDefaultedToSameOriginByCoep

CorpNotSameSite

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.

Request

ParentFrame

BlockedFrame

Reason

HeavyAdResolutionStatus

HeavyAdBlocked

HeavyAdWarning

HeavyAdReason

NetworkTotalLimit

CpuTotalLimit

CpuPeakLimit

HeavyAdIssueDetails

The resolution status, either blocking the content or warning.

The reason the ad was blocked, total network or cpu or peak cpu.

The frame that was blocked.

ContentSecurityPolicyViolationType

kInlineViolation

kEvalViolation

kURLViolation

kTrustedTypesSinkViolation

kTrustedTypesPolicyViolation

kWasmEvalViolation

SourceCodeLocation

ScriptId

Url

LineNumber

ColumnNumber

ContentSecurityPolicyIssueDetails

The url not included in allowed sources.

Specific directive that is violated, causing the CSP issue.

IsReportOnly

ContentSecurityPolicyViolationType

FrameAncestor

SourceCodeLocation

ViolatingNodeId

SharedArrayBufferIssueType

TransferIssue

CreationIssue

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

SourceCodeLocation

IsWarning

Type

LowTextContrastIssueDetails

ViolatingNodeId

ViolatingNodeSelector

ContrastRatio

ThresholdAA

ThresholdAAA

FontSize

FontWeight

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

CorsErrorStatus

IsWarning

Request

Location

InitiatorOrigin

ResourceIPAddressSpace

ClientSecurityState

AttributionReportingIssueType

PermissionPolicyDisabled

UntrustworthyReportingOrigin

InsecureContext

InvalidHeader

InvalidRegisterTriggerHeader

SourceAndTriggerHeaders

SourceIgnored

TriggerIgnored

OsSourceIgnored

OsTriggerIgnored

InvalidRegisterOsSourceHeader

InvalidRegisterOsTriggerHeader

WebAndOsHeaders

NoWebOrOsSupport

NavigationRegistrationWithoutTransientUserActivation

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

ViolationType

Request

ViolatingNodeId

InvalidParameter

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

If false, it means the document's mode is "quirks" instead of "limited-quirks".

DocumentNodeId

Url

FrameId

LoaderId

NavigatorUserAgentIssueDetails

Url

Location

GenericIssueErrorType

CrossOriginPortalPostMessageError

FormLabelForNameError

FormDuplicateIdForInputError

FormInputWithNoLabelError

FormAutocompleteAttributeEmptyError

FormEmptyIdAndNameAttributesForInputError

FormAriaLabelledByToNonExistingId

FormInputAssignedAutocompleteValueToIdOrNameAttributeError

FormLabelHasNeitherForNorNestedInput

FormLabelForMatchesNonExistingIdError

FormInputHasWrongButWellIntendedAutocompleteValueError

ResponseWasBlockedByORB

Depending on the concrete errorType, different properties are set.

Issues with the same errorType are aggregated in the frontend.

FrameId

ViolatingNodeId

ViolatingNodeAttribute

Request

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

AffectedFrame

SourceCodeLocation

One of the deprecation names from third_party/blink/renderer/core/frame/deprecation/deprecation.json5

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

TrackingSites

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

AllowedSites

ClientHintIssueReason

MetaTagAllowListInvalidOrigin

MetaTagModifiedHTML

FederatedAuthRequestIssueDetails

FederatedAuthRequestIssueReason

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

ShouldEmbargo

TooManyRequests

WellKnownHttpNotFound

WellKnownNoResponse

WellKnownInvalidResponse

WellKnownListEmpty

WellKnownInvalidContentType

ConfigNotInWellKnown

WellKnownTooBig

ConfigHttpNotFound

ConfigNoResponse

ConfigInvalidResponse

ConfigInvalidContentType

ClientMetadataHttpNotFound

ClientMetadataNoResponse

ClientMetadataInvalidResponse

ClientMetadataInvalidContentType

DisabledInSettings

ErrorFetchingSignin

InvalidSigninResponse

AccountsHttpNotFound

AccountsNoResponse

AccountsInvalidResponse

AccountsListEmpty

AccountsInvalidContentType

IdTokenHttpNotFound

IdTokenNoResponse

IdTokenInvalidResponse

IdTokenIdpErrorResponse

IdTokenCrossSiteIdpErrorResponse

IdTokenInvalidRequest

IdTokenInvalidContentType

ErrorIdToken

Canceled

RpPageNotVisible

SilentMediationFailure

ThirdPartyCookiesBlocked

NotSignedInWithIdp

FederatedAuthUserInfoRequestIssueDetails

FederatedAuthUserInfoRequestIssueReason

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

NotSameOrigin

NotIframe

NotPotentiallyTrustworthy

NoApiPermission

NotSignedInWithIdp

NoAccountSharingPermission

InvalidConfigOrWellKnown

InvalidAccountsResponse

NoReturningUserFromFetchedAccounts

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

SourceCodeLocation

ClientHintIssueReason

FailedRequestInfo

The URL that failed to load.

The failure message for the failed request.

RequestId

StyleSheetLoadingIssueReason

LateImportRule

RequestFailed

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

Source code position that referenced the failing stylesheet.

Reason why the stylesheet couldn't be loaded.

Contains additional info when the failure was due to a request.

PropertyRuleIssueReason

InvalidSyntax

InvalidInitialValue

InvalidInherits

InvalidName

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

Source code position of the property rule.

Reason why the property rule was discarded.

The value of the property rule property that failed to parse

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.

CookieIssue

MixedContentIssue

BlockedByResponseIssue

HeavyAdIssue

ContentSecurityPolicyIssue

SharedArrayBufferIssue

LowTextContrastIssue

CorsIssue

AttributionReportingIssue

QuirksModeIssue

NavigatorUserAgentIssue

GenericIssue

DeprecationIssue

ClientHintIssue

FederatedAuthRequestIssue

BounceTrackingIssue

CookieDeprecationMetadataIssue

StylesheetLoadingIssue

FederatedAuthUserInfoRequestIssue

PropertyRuleIssue

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.

CookieIssueDetails

MixedContentIssueDetails

BlockedByResponseIssueDetails

HeavyAdIssueDetails

ContentSecurityPolicyIssueDetails

SharedArrayBufferIssueDetails

LowTextContrastIssueDetails

CorsIssueDetails

AttributionReportingIssueDetails

QuirksModeIssueDetails

NavigatorUserAgentIssueDetails

GenericIssueDetails

DeprecationIssueDetails

ClientHintIssueDetails

FederatedAuthRequestIssueDetails

BounceTrackingIssueDetails

CookieDeprecationMetadataIssueDetails

StylesheetLoadingIssueDetails

PropertyRuleIssueDetails

FederatedAuthUserInfoRequestIssueDetails

An inspector issue reported from the back-end.

Code

Details

A unique id for this issue. May be omitted if no other entity (e.g. exception, CDP message, etc.) is referencing this issue.

issueAdded

Issue

GetEncodedResponseResponse

body

originalSize

encodedSize

CheckFormsIssuesResponse

formIssues

The encoding to use.

webp

jpeg

png

Audits domain allows investigation of page violations and possible improvements.

Audits

DevToolsClient

IssueAdded

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

Identifier of the network request to get content for. The encoding to use. The quality of the encoding (0-1). (defaults to 1) Whether to only return the size information (defaults to false). returns System.Threading.Tasks.Task<GetEncodedResponseResponse>

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

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

Whether to report WCAG AAA level issues. Default is false. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

returns System.Threading.Tasks.Task<CheckFormsIssuesResponse>

CreditCard

16-digit credit card number.

Name of the credit card owner.

2-digit expiry month.

4-digit expiry year.

3-digit card verification code.

AddressField

address field name, for example GIVEN_NAME.

address field value, for example Jon Doe.

A list of address fields.

Fields

Address

fields and values defining an address.

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

A two dimension array containing the representation of values from an address profile.

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

autocompleteAttribute

autofillInferred

FilledField

The type of the field, e.g text, password etc.

the html id

the html name

the field value

The actual field type, e.g FAMILY_NAME

The filling strategy

The frame the field belongs to

The form field's DOM node

Emitted when an address form is filled.

Information about the fields that were filled

An UI representation of the address used to fill the form. Consists of a 2D array where each child represents an address/profile line.

Defines commands and events for Autofill.

Autofill

DevToolsClient

Emitted when an address form is filled.

Trigger autofill on a form identified by the fieldId. If the field and related form cannot be autofilled, returns an error.

Identifies a field that serves as an anchor for autofill. Credit card information to fill out the form. Credit card data is not saved. Identifies the frame that field belongs to. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Set addresses so that developers can verify their forms implementation.

addresses returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Disables autofill domain notifications.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Enables autofill domain notifications.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

backgroundFetch

backgroundSync

pushMessaging

notifications

paymentHandler

periodicBackgroundSync

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

Key

Value

BackgroundServiceEvent

Timestamp of the event (in seconds).

The origin this event belongs to.

The Service Worker ID that initiated the event.

The Background Service this event belongs to.

A description of the event.

An identifier that groups related events together.

A list of event-specific information.

Storage key this event belongs to.

Called when the recording state for the service has been updated.

IsRecording

Service

Called with all existing backgroundServiceEvents when enabled, and all new events afterwards if enabled and recording.

BackgroundServiceEvent

Defines events for background web platform features.

BackgroundService

DevToolsClient

Called when the recording state for the service has been updated.

Called with all existing backgroundServiceEvents when enabled, and all new events afterwards if enabled and recording.

Enables event updates for the service.

service returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Disables event updates for the service.

service returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Set the recording state for the service.

shouldRecord service returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Clears all stored data for the service.

service returns System.Threading.Tasks.Task<DevToolsMethodResponse>

The state of the browser window.

normal

minimized

maximized

fullscreen

Browser window bounds information

The offset from the left edge of the screen to the window in pixels.

The offset from the top edge of the screen to the window in pixels.

The window width in pixels.

The window height in pixels.

The window state. Default to normal.

PermissionType

accessibilityEvents

audioCapture

backgroundSync

backgroundFetch

capturedSurfaceControl

clipboardReadWrite

clipboardSanitizedWrite

displayCapture

durableStorage

flash

geolocation

idleDetection

localFonts

midi

midiSysex

nfc

notifications

paymentHandler

periodicBackgroundSync

protectedMediaIdentifier

sensors

storageAccess

speakerSelection

topLevelStorageAccess

videoCapture

videoCapturePanTiltZoom

wakeLockScreen

wakeLockSystem

windowManagement

PermissionSetting

granted

denied

prompt

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

Name of permission. See https://cs.chromium.org/chromium/src/third_party/blink/renderer/modules/permissions/permission_descriptor.idl for valid permission names.

For "midi" permission, may also specify sysex control.

For "push" permission, may specify userVisibleOnly. Note that userVisibleOnly = true is the only currently supported type.

For "clipboard" permission, may specify allowWithoutSanitization.

For "camera" permission, may specify panTiltZoom.

Browser command ids used by executeBrowserCommand.

openTabSearch

closeTabSearch

Chrome histogram bucket.

Minimum value (inclusive).

Maximum value (exclusive).

Number of samples.

Chrome histogram.

Name.

Sum of sample values.

Total number of samples.

Buckets.

Fired when page is about to start a download.

Id of the frame that caused the download to begin.

Global unique identifier of the download.

URL of the resource being downloaded.

Suggested file name of the resource (the actual name of the file saved on disk may differ).

Download status.

inProgress

completed

canceled

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

Global unique identifier of the download.

Total expected bytes to download.

Total bytes received.

Download status.

GetVersionResponse

protocolVersion

product

revision

userAgent

jsVersion

GetBrowserCommandLineResponse

arguments

GetHistogramsResponse

histograms

GetHistogramResponse

histogram

GetWindowBoundsResponse

bounds

GetWindowForTargetResponse

windowId

bounds

Whether to allow all or deny all download requests, or use default Chrome behavior if available (otherwise deny). |allowAndName| allows download and names files according to their download guids.

deny

allow

allowAndName

default

The Browser domain defines methods and events for browser managing.

Browser

DevToolsClient

Fired when page is about to start a download.

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

Set permission settings for given origin.

Descriptor of permission to override. Setting of the permission. Origin the permission applies to, all origins if not specified. Context to override. When omitted, default browser context is used. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

permissions Origin the permission applies to, all origins if not specified. BrowserContext to override permissions. When omitted, default browser context is used. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Reset all permission management for all origins.

BrowserContext to reset permissions. When omitted, default browser context is used. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Set the behavior when downloading a file.

Whether to allow all or deny all download requests, or use default Chrome behavior ifavailable (otherwise deny). |allowAndName| allows download and names files according totheir download guids. BrowserContext to set download behavior. When omitted, default browser context is used. The default path to save downloaded files to. This is required if behavior is set to 'allow'or 'allowAndName'. Whether to emit download events (defaults to false). returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Cancel a download if in progress

Global unique identifier of the download. BrowserContext to perform the action in. When omitted, default browser context is used. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Close browser gracefully.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Crashes browser on the main thread.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Crashes GPU process.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Returns version information.

returns System.Threading.Tasks.Task<GetVersionResponse>

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

returns System.Threading.Tasks.Task<GetBrowserCommandLineResponse>

Get Chrome histograms.

Requested substring in name. Only histograms which have query as asubstring in their name are extracted. An empty or absent query returnsall histograms. If true, retrieve delta since last delta call. returns System.Threading.Tasks.Task<GetHistogramsResponse>

Get a Chrome histogram by name.

Requested histogram name. If true, retrieve delta since last delta call. returns System.Threading.Tasks.Task<GetHistogramResponse>

Get position and size of the browser window.

Browser window id. returns System.Threading.Tasks.Task<GetWindowBoundsResponse>

Get the browser window that contains the devtools target.

Devtools agent host id. If called as a part of the session, associated targetId is used. returns System.Threading.Tasks.Task<GetWindowForTargetResponse>

Set position and/or size of the browser window.

Browser window id. New window bounds. The 'minimized', 'maximized' and 'fullscreen' states cannot be combinedwith 'left', 'top', 'width' or 'height'. Leaves unspecified fields unchanged. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Set dock tile details, platform-specific.

badgeLabel Png encoded image. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Invoke custom browser commands used by telemetry.

commandId returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

url returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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.

injected

user-agent

inspector

regular

CSS rule collection for a single pseudo style.

Pseudo element type.

Pseudo element custom ident.

Matches of CSS rules applicable to the pseudo style.

Inherited CSS rule collection from ancestor node.

The ancestor node's inline style, if any, in the style inheritance chain.

Matches of CSS rules matching the ancestor node in the style inheritance chain.

Inherited pseudo element matches from pseudos of an ancestor node.

Matches of pseudo styles from the pseudos of an ancestor node.

Match data for a CSS rule.

CSS rule in the match.

Matching selector indices in the rule's selectorList selectors (0-based).

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

Value text.

Value range in the underlying resource (if available).

Specificity of the selector.

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

The a component, which represents the number of ID selectors.

The b component, which represents the number of class selectors, attributes selectors, and pseudo-classes.

The c component, which represents the number of type selectors and pseudo-elements.

Selector list data.

Selectors in the list.

Rule selector text.

CSS stylesheet metainformation.

The stylesheet identifier.

Owner frame identifier.

Stylesheet resource URL. Empty if this is a constructed stylesheet created using new CSSStyleSheet() (but non-empty if this is a constructed stylesheet imported as a CSS module script).

URL of source map associated with the stylesheet (if any).

Stylesheet origin.

Stylesheet title.

The backend id for the owner node of the stylesheet.

Denotes whether the stylesheet is disabled.

Whether the sourceURL field value comes from the sourceURL comment.

Whether this stylesheet is created for STYLE tag by parser. This flag is not set for document.written STYLE tags.

Whether this stylesheet is mutable. Inline stylesheets become mutable after they have been modified via CSSOM API. `<link>` element's stylesheets become mutable only if DevTools modifies them. Constructed stylesheets (new CSSStyleSheet()) are mutable immediately after creation.

True if this stylesheet is created through new CSSStyleSheet() or imported as a CSS module script.

Line offset of the stylesheet within the resource (zero based).

Column offset of the stylesheet within the resource (zero based).

Size of the content (in characters).

Line offset of the end of the stylesheet within the resource (zero based).

Column offset of the end of the stylesheet within the resource (zero based).

If the style sheet was loaded from a network resource, this indicates when the resource failed to load

CSS rule representation.

The css style sheet identifier (absent for user agent stylesheet and user-specified stylesheet rules) this rule came from.

Rule selector data.

Array of selectors from ancestor style rules, sorted by distance from the current rule.

Parent stylesheet's origin.

Associated style declaration.

Media list array (for rules involving media queries). The array enumerates media queries starting with the innermost one, going outwards.

Container query list array (for rules involving container queries). The array enumerates container queries starting with the innermost one, going outwards.

@supports CSS at-rule array. The array enumerates @supports at-rules starting with the innermost one, going outwards.

Cascade layer array. Contains the layer hierarchy that this rule belongs to starting with the innermost layer and going outwards.

@scope CSS at-rule array. The array enumerates @scope at-rules starting with the innermost one, going outwards.

The array keeps the types of ancestor CSSRules from the innermost going outwards.

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.

MediaRule

SupportsRule

ContainerRule

LayerRule

ScopeRule

StyleRule

CSS coverage information.

The css style sheet identifier (absent for user agent stylesheet and user-specified stylesheet rules) this rule came from.

Offset of the start of the rule (including selector) from the beginning of the stylesheet.

Offset of the end of the rule body from the beginning of the stylesheet.

Indicates whether the rule was actually used by some element in the page.

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

Start line of range.

Start column of range (inclusive).

End line of range

End column of range (exclusive).

ShorthandEntry

Shorthand name.

Shorthand value.

Whether the property has "!important" annotation (implies `false` if absent).

CSSComputedStyleProperty

Computed style property name.

Computed style property value.

CSS style representation.

The css style sheet identifier (absent for user agent stylesheet and user-specified stylesheet rules) this rule came from.

CSS properties in the style.

Computed values for all shorthands found in the style.

Style declaration text (if available).

Style declaration range in the enclosing stylesheet (if available).

CSS property declaration data.

The property name.

The property value.

Whether the property has "!important" annotation (implies `false` if absent).

Whether the property is implicit (implies `false` if absent).

The full property text as specified in the style.

Whether the property is understood by the browser (implies `true` if absent).

Whether the property is disabled by the user (present for source-based properties only).

The entire property range in the enclosing style declaration (if available).

Parsed longhand components of this property if it is a shorthand. This field will be empty if the given property is not a shorthand.

Source of the media query: "mediaRule" if specified by a @media rule, "importRule" if specified by an @import rule, "linkedSheet" if specified by a "media" attribute in a linked stylesheet's LINK tag, "inlineSheet" if specified by a "media" attribute in an inline stylesheet's STYLE tag.

mediaRule

importRule

linkedSheet

inlineSheet

CSS media rule descriptor.

Media query text.

URL of the document containing the media query description.

The associated rule (@media or @import) header range in the enclosing stylesheet (if available).

Identifier of the stylesheet containing this object (if exists).

Array of media queries.

Media query descriptor.

Array of media query expressions.

Whether the media query condition is satisfied.

Media query expression descriptor.

Media query expression value.

Media query expression units.

Media query expression feature.

The associated range of the value text in the enclosing stylesheet (if available).

Computed length of media query expression (if applicable).

CSS container query rule descriptor.

Container query text.

The associated rule header range in the enclosing stylesheet (if available).

Identifier of the stylesheet containing this object (if exists).

Optional name for the container.

Optional physical axes queried for the container.

Optional logical axes queried for the container.

CSS Supports at-rule descriptor.

Supports rule text.

Whether the supports condition is satisfied.

The associated rule header range in the enclosing stylesheet (if available).

Identifier of the stylesheet containing this object (if exists).

CSS Scope at-rule descriptor.

Scope rule text.

The associated rule header range in the enclosing stylesheet (if available).

Identifier of the stylesheet containing this object (if exists).

CSS Layer at-rule descriptor.

Layer name.

The associated rule header range in the enclosing stylesheet (if available).

Identifier of the stylesheet containing this object (if exists).

CSS Layer data.

Layer name.

Direct sub-layers

Layer order. The order determines the order of the layer in the cascade order. A higher number has higher priority in the cascade order.

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

Font's family name reported by platform.

Font's PostScript name reported by platform.

Indicates if the font was downloaded or resolved locally.

Amount of glyphs that were rendered with this font.

Information about font variation axes for variable fonts

The font-variation-setting tag (a.k.a. "axis tag").

Human-readable variation name in the default language (normally, "en").

The minimum value (inclusive) the font supports for this tag.

The maximum value (inclusive) the font supports for this tag.

The default value.

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.

The font-family.

The font-style.

The font-variant.

The font-weight.

The font-stretch.

The font-display.

The unicode-range.

The src.

The resolved platform font family

Available variation settings (a.k.a. "axes").

CSS try rule representation.

The css style sheet identifier (absent for user agent stylesheet and user-specified stylesheet rules) this rule came from.

Parent stylesheet's origin.

Associated style declaration.

CSS position-fallback rule representation.

Name

List of keyframes.

CSS keyframes rule representation.

Animation name.

List of keyframes.

Representation of a custom property registration through CSS.registerProperty

PropertyName

InitialValue

Inherits

Syntax

CSS font-palette-values rule representation.

The css style sheet identifier (absent for user agent stylesheet and user-specified stylesheet rules) this rule came from.

Parent stylesheet's origin.

Associated font palette name.

Associated style declaration.

CSS property at-rule representation.

The css style sheet identifier (absent for user agent stylesheet and user-specified stylesheet rules) this rule came from.

Parent stylesheet's origin.

Associated property name.

Associated style declaration.

CSS keyframe rule representation.

The css style sheet identifier (absent for user agent stylesheet and user-specified stylesheet rules) this rule came from.

Parent stylesheet's origin.

Associated key text.

Associated style declaration.

A descriptor of operation to mutate style declaration text.

The css style sheet identifier.

The range of the style text in the enclosing stylesheet.

New style text.

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

The web font that has loaded.

Fired whenever an active document stylesheet is added.

Added stylesheet metainfo.

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

StyleSheetId

Fired whenever an active document stylesheet is removed.

Identifier of the removed stylesheet.

AddRuleResponse

rule

CollectClassNamesResponse

classNames

CreateStyleSheetResponse

styleSheetId

GetBackgroundColorsResponse

backgroundColors

computedFontSize

computedFontWeight

GetComputedStyleForNodeResponse

computedStyle

GetInlineStylesForNodeResponse

inlineStyle

attributesStyle

GetMatchedStylesForNodeResponse

inlineStyle

attributesStyle

matchedCSSRules

pseudoElements

inherited

inheritedPseudoElements

cssKeyframesRules

cssPositionFallbackRules

cssPropertyRules

cssPropertyRegistrations

cssFontPaletteValuesRule

parentLayoutNodeId

GetMediaQueriesResponse

medias

GetPlatformFontsForNodeResponse

fonts

GetStyleSheetTextResponse

text

GetLayersForNodeResponse

rootLayer

TakeComputedStyleUpdatesResponse

nodeIds

SetPropertyRulePropertyNameResponse

propertyName

SetKeyframeKeyResponse

keyText

SetMediaTextResponse

media

SetContainerQueryTextResponse

containerQuery

SetSupportsTextResponse

supports

SetScopeTextResponse

scope

SetRuleSelectorResponse

selectorList

SetStyleSheetTextResponse

sourceMapURL

SetStyleTextsResponse

styles

StopRuleUsageTrackingResponse

ruleUsage

TakeCoverageDeltaResponse

coverage

timestamp

CSS

DevToolsClient

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

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

Fired whenever an active document stylesheet is added.

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

Fired whenever an active document stylesheet is removed.

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

The css style sheet identifier where a new rule should be inserted. The text of a new rule. Text position of a new rule in the target style sheet. NodeId for the DOM node in whose context custom property declarations for registered properties should bevalidated. If omitted, declarations in the new rule text can only be validated statically, which may produceincorrect results if the declaration contains a var() for example. returns System.Threading.Tasks.Task<AddRuleResponse>

Returns all class names from specified stylesheet.

styleSheetId returns System.Threading.Tasks.Task<CollectClassNamesResponse>

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

Identifier of the frame where "via-inspector" stylesheet should be created. returns System.Threading.Tasks.Task<CreateStyleSheetResponse>

Disables the CSS agent for the given page.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

The element id for which to force the pseudo state. Element pseudo classes to force when computing the element's style. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

GetBackgroundColors

Id of the node to get background colors for. returns System.Threading.Tasks.Task<GetBackgroundColorsResponse>

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

nodeId returns System.Threading.Tasks.Task<GetComputedStyleForNodeResponse>

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

nodeId returns System.Threading.Tasks.Task<GetInlineStylesForNodeResponse>

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

nodeId returns System.Threading.Tasks.Task<GetMatchedStylesForNodeResponse>

Returns all media queries parsed by the rendering engine.

returns System.Threading.Tasks.Task<GetMediaQueriesResponse>

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

nodeId returns System.Threading.Tasks.Task<GetPlatformFontsForNodeResponse>

Returns the current textual content for a stylesheet.

styleSheetId returns System.Threading.Tasks.Task<GetStyleSheetTextResponse>

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.

nodeId returns System.Threading.Tasks.Task<GetLayersForNodeResponse>

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.

propertiesToTrack returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Polls the next batch of computed style updates.

returns System.Threading.Tasks.Task<TakeComputedStyleUpdatesResponse>

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

The element id for which to set property. propertyName value returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Modifies the property rule property name.

styleSheetId range propertyName returns System.Threading.Tasks.Task<SetPropertyRulePropertyNameResponse>

Modifies the keyframe rule key text.

styleSheetId range keyText returns System.Threading.Tasks.Task<SetKeyframeKeyResponse>

Modifies the rule selector.

styleSheetId range text returns System.Threading.Tasks.Task<SetMediaTextResponse>

Modifies the expression of a container query.

styleSheetId range text returns System.Threading.Tasks.Task<SetContainerQueryTextResponse>

Modifies the expression of a supports at-rule.

styleSheetId range text returns System.Threading.Tasks.Task<SetSupportsTextResponse>

Modifies the expression of a scope at-rule.

styleSheetId range text returns System.Threading.Tasks.Task<SetScopeTextResponse>

Modifies the rule selector.

styleSheetId range selector returns System.Threading.Tasks.Task<SetRuleSelectorResponse>

Sets the new stylesheet text.

styleSheetId text returns System.Threading.Tasks.Task<SetStyleSheetTextResponse>

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

edits NodeId for the DOM node in whose context custom property declarations for registered properties should bevalidated. If omitted, declarations in the new rule text can only be validated statically, which may produceincorrect results if the declaration contains a var() for example. returns System.Threading.Tasks.Task<SetStyleTextsResponse>

Enables the selector recording.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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 System.Threading.Tasks.Task<StopRuleUsageTrackingResponse>

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

returns System.Threading.Tasks.Task<TakeCoverageDeltaResponse>

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

Whether rendering of local fonts is enabled. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

type of HTTP response cached

basic

cors

default

error

opaqueResponse

opaqueRedirect

Data entry.

Request URL.

Request method.

Request headers

Number of seconds since epoch.

HTTP response status code.

HTTP response status text.

HTTP response type

Response headers

Cache identifier.

An opaque unique id of the cache.

Security origin of the cache.

Storage key of the cache.

Storage bucket of the cache.

The name of the cache.

Header

Name

Value

Cached response

Entry content, base64-encoded.

RequestCacheNamesResponse

caches

RequestCachedResponseResponse

response

RequestEntriesResponse

cacheDataEntries

returnCount

CacheStorage

DevToolsClient

Deletes a cache.

Id of cache for deletion. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Deletes a cache entry.

Id of cache where the entry will be deleted. URL spec of the request. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Requests cache names.

At least and at most one of securityOrigin, storageKey, storageBucket must be specified.Security origin. Storage key. Storage bucket. If not specified, it uses the default bucket. returns System.Threading.Tasks.Task<RequestCacheNamesResponse>

Fetches cache entry.

Id of cache that contains the entry. URL spec of the request. headers of the request. returns System.Threading.Tasks.Task<RequestCachedResponseResponse>

Requests data from cache.

ID of cache to get entries from. Number of records to skip. Number of records to fetch. If present, only return the entries containing this substring in the path returns System.Threading.Tasks.Task<RequestEntriesResponse>

Sink

Name

Text describing the current session. Present only if there is an active session on the sink.

This is fired whenever the list of available sinks changes. A sink is a device or a software surface that you can cast to.

Sinks

This is fired whenever the outstanding issue/error message changes. |issueMessage| is empty if there is no issue.

IssueMessage

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

Cast

DevToolsClient

This is fired whenever the list of available sinks changes. A sink is a device or a software surface that you can cast to.

This is fired whenever the outstanding issue/error message changes. |issueMessage| is empty if there is no issue.

presentationUrl returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Stops observing for sinks and issues.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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.

sinkName returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Starts mirroring the desktop to the sink.

sinkName returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Starts mirroring the tab to the sink.

sinkName returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Stops the active Cast session on the sink.

sinkName returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Backend node with a friendly name.

`Node`'s nodeType.

`Node`'s nodeName.

BackendNodeId

Pseudo element type.

first-line

first-letter

before

after

marker

backdrop

selection

target-text

spelling-error

grammar-error

highlight

first-line-inherited

scrollbar

scrollbar-thumb

scrollbar-button

scrollbar-track

scrollbar-track-piece

scrollbar-corner

resizer

input-list-button

view-transition

view-transition-group

view-transition-image-pair

view-transition-old

view-transition-new

Shadow root type.

user-agent

open

closed

Document compatibility mode.

QuirksMode

LimitedQuirksMode

NoQuirksMode

ContainerSelector physical axes

Horizontal

Vertical

Both

ContainerSelector logical axes

Inline

Block

Both

Physical scroll orientation

horizontal

vertical

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

Node identifier that is passed into the rest of the DOM messages as the `nodeId`. Backend will only push node with given `id` once. It is aware of all requested nodes and will only fire DOM events for nodes known to the client.

The id of the parent node if any.

The BackendNodeId for this node.

`Node`'s nodeType.

`Node`'s nodeName.

`Node`'s localName.

`Node`'s nodeValue.

Child count for `Container` nodes.

Child nodes of this node when requested with children.

Attributes of the `Element` node in the form of flat array `[name1, value1, name2, value2]`.

Document URL that `Document` or `FrameOwner` node points to.

Base URL that `Document` or `FrameOwner` node uses for URL completion.

`DocumentType`'s publicId.

`DocumentType`'s systemId.

`DocumentType`'s internalSubset.

`Document`'s XML version in case of XML documents.

`Attr`'s name.

`Attr`'s value.

Pseudo element type for this node.

Pseudo element identifier for this node. Only present if there is a valid pseudoType.

Shadow root type.

Frame ID for frame owner elements.

Content document for frame owner elements.

Shadow root list for given element host.

Content document fragment for template elements.

Pseudo elements associated with this node.

Deprecated, as the HTML Imports API has been removed (crbug.com/937746). This property used to return the imported document for the HTMLImport links. The property is always undefined now.

Distributed nodes for given insertion point.

Whether the node is SVG.

CompatibilityMode

AssignedSlot

A structure holding an RGBA color.

The red component, in the [0-255] range.

The green component, in the [0-255] range.

The blue component, in the [0-255] range.

The alpha component, in the [0-1] range (default: 1).

Box model.

Content box

Padding box

Border box

Margin box

Node width

Node height

Shape outside coordinates

CSS Shape Outside details.

Shape bounds

Shape coordinate details

Margin shape bounds

Rectangle.

X coordinate

Y coordinate

Rectangle width

Rectangle height

CSSComputedStyleProperty

Computed style property name.

Computed style property value.

Fired when `Element`'s attribute is modified.

Id of the node that has changed.

Attribute name.

Attribute value.

Fired when `Element`'s attribute is removed.

Id of the node that has changed.

A ttribute name.

Mirrors `DOMCharacterDataModified` event.

Id of the node that has changed.

New text value.

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

Id of the node that has changed.

New node count.

Mirrors `DOMNodeInserted` event.

Id of the node that has changed.

Id of the previous sibling.

Inserted node data.

Mirrors `DOMNodeRemoved` event.

Parent id.

Id of the node that has been removed.

Called when distribution is changed.

Insertion point where distributed nodes were updated.

Distributed nodes for given insertion point.

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

Ids of the nodes for which the inline styles have been invalidated.

Called when a pseudo element is added to an element.

Pseudo element's parent element id.

The added pseudo element.

Called when a pseudo element is removed from an element.

Pseudo element's parent element id.

The removed pseudo element id.

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

Parent node id to populate with children.

Child nodes array.

Called when shadow root is popped from the element.

Host element id.

Shadow root id.

Called when shadow root is pushed into the element.

Host element id.

Shadow root.

CollectClassNamesFromSubtreeResponse

classNames

CopyToResponse

nodeId

DescribeNodeResponse

node

GetAttributesResponse

attributes

GetBoxModelResponse

model

GetContentQuadsResponse

quads

GetDocumentResponse

root

GetNodesForSubtreeByStyleResponse

nodeIds

GetNodeForLocationResponse

backendNodeId

frameId

nodeId

GetOuterHTMLResponse

outerHTML

GetRelayoutBoundaryResponse

nodeId

GetSearchResultsResponse

nodeIds

MoveToResponse

nodeId

PerformSearchResponse

searchId

resultCount

PushNodeByPathToFrontendResponse

nodeId

PushNodesByBackendIdsToFrontendResponse

nodeIds

QuerySelectorResponse

nodeId

QuerySelectorAllResponse

nodeIds

GetTopLayerElementsResponse

nodeIds

RequestNodeResponse

nodeId

ResolveNodeResponse

object

GetNodeStackTracesResponse

creation

GetFileInfoResponse

path

SetNodeNameResponse

nodeId

GetFrameOwnerResponse

backendNodeId

nodeId

GetContainerForNodeResponse

nodeId

GetQueryingDescendantsForContainerResponse

nodeIds

Whether to include whitespaces in the children array of returned Nodes.

none

all

DOM

DevToolsClient

Fired when `Element`'s attribute is modified.

Fired when `Element`'s attribute is removed.

Mirrors `DOMCharacterDataModified` event.

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

Mirrors `DOMNodeInserted` event.

Mirrors `DOMNodeRemoved` event.

Called when distribution is changed.

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

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

Called when a pseudo element is added to an element.

Called when top layer elements are changed.

Called when a pseudo element is removed from an element.

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

Called when shadow root is popped from the element.

Called when shadow root is pushed into the element.

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

Id of the node to collect class names. returns System.Threading.Tasks.Task<CollectClassNamesFromSubtreeResponse>

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

Id of the node to copy. Id of the element to drop the copy into. Drop the copy before this node (if absent, the copy becomes the last child of`targetNodeId`). returns System.Threading.Tasks.Task<CopyToResponse>

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

Identifier of the node. Identifier of the backend node. JavaScript object id of the node wrapper. The maximum depth at which children should be retrieved, defaults to 1. Use -1 for theentire subtree or provide an integer larger than 0. Whether or not iframes and shadow roots should be traversed when returning the subtree(default is false). returns System.Threading.Tasks.Task<DescribeNodeResponse>

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.

Identifier of the node. Identifier of the backend node. JavaScript object id of the node wrapper. The rect to be scrolled into view, relative to the node's border box, in CSS pixels.When omitted, center of the node will be used, similar to Element.scrollIntoView. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Disables DOM agent for the given page.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

Unique search session identifier. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Enables DOM agent for the given page.

Whether to include whitespaces in the children array of returned Nodes. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Focuses the given element.

Identifier of the node. Identifier of the backend node. JavaScript object id of the node wrapper. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Returns attributes for the specified node.

Id of the node to retrieve attributes for. returns System.Threading.Tasks.Task<GetAttributesResponse>

Returns boxes for the given node.

Identifier of the node. Identifier of the backend node. JavaScript object id of the node wrapper. returns System.Threading.Tasks.Task<GetBoxModelResponse>

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

Identifier of the node. Identifier of the backend node. JavaScript object id of the node wrapper. returns System.Threading.Tasks.Task<GetContentQuadsResponse>

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

The maximum depth at which children should be retrieved, defaults to 1. Use -1 for theentire subtree or provide an integer larger than 0. Whether or not iframes and shadow roots should be traversed when returning the subtree(default is false). returns System.Threading.Tasks.Task<GetDocumentResponse>

Finds nodes with a given computed style in a subtree.

Node ID pointing to the root of a subtree. The style to filter nodes by (includes nodes if any of properties matches). Whether or not iframes and shadow roots in the same target should be traversed when returning theresults (default is false). returns System.Threading.Tasks.Task<GetNodesForSubtreeByStyleResponse>

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

X coordinate. Y coordinate. False to skip to the nearest non-UA shadow root ancestor (default: false). Whether to ignore pointer-events: none on elements and hit test them. returns System.Threading.Tasks.Task<GetNodeForLocationResponse>

Returns node's HTML markup.

Identifier of the node. Identifier of the backend node. JavaScript object id of the node wrapper. returns System.Threading.Tasks.Task<GetOuterHTMLResponse>

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

Id of the node. returns System.Threading.Tasks.Task<GetRelayoutBoundaryResponse>

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

Unique search session identifier. Start index of the search result to be returned. End index of the search result to be returned. returns System.Threading.Tasks.Task<GetSearchResultsResponse>

Hides any highlight.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Highlights DOM node.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Highlights given rectangle.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Marks last undoable state.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

Id of the node to move. Id of the element to drop the moved node into. Drop node before this one (if absent, the moved node becomes the last child of`targetNodeId`). returns System.Threading.Tasks.Task<MoveToResponse>

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

Plain text or query selector or XPath search query. True to search in user agent shadow DOM. returns System.Threading.Tasks.Task<PerformSearchResponse>

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

Path to node in the proprietary format. returns System.Threading.Tasks.Task<PushNodeByPathToFrontendResponse>

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

The array of backend node ids. returns System.Threading.Tasks.Task<PushNodesByBackendIdsToFrontendResponse>

Executes `querySelector` on a given node.

Id of the node to query upon. Selector string. returns System.Threading.Tasks.Task<QuerySelectorResponse>

Executes `querySelectorAll` on a given node.

Id of the node to query upon. Selector string. returns System.Threading.Tasks.Task<QuerySelectorAllResponse>

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 System.Threading.Tasks.Task<GetTopLayerElementsResponse>

Re-does the last undone action.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

Id of the element to remove attribute from. Name of the attribute to remove. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Removes node with given id.

Id of the node to remove. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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.

Id of the node to get children for. The maximum depth at which children should be retrieved, defaults to 1. Use -1 for theentire subtree or provide an integer larger than 0. Whether or not iframes and shadow roots should be traversed when returning the sub-tree(default is false). returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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.

JavaScript object id to convert into node. returns System.Threading.Tasks.Task<RequestNodeResponse>

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

Id of the node to resolve. Backend identifier of the node to resolve. Symbolic group name that can be used to release multiple objects. Execution context in which to resolve the node. returns System.Threading.Tasks.Task<ResolveNodeResponse>

Sets attribute for an element with given id.

Id of the element to set attribute for. Attribute name. Attribute value. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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.

Id of the element to set attributes for. Text with a number of attributes. Will parse this text using HTML parser. Attribute name to replace with new attributes derived from text in case text parsedsuccessfully. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Sets files for the given file input element.

Array of file paths to set. Identifier of the node. Identifier of the backend node. JavaScript object id of the node wrapper. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

Enable or disable. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

Id of the node to get stack traces for. returns System.Threading.Tasks.Task<GetNodeStackTracesResponse>

Returns file information for the given File wrapper.

JavaScript object id of the node wrapper. returns System.Threading.Tasks.Task<GetFileInfoResponse>

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

DOM node id to be accessible by means of $x command line API. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Sets node name for a node with given id.

Id of the node to set name for. New node's name. returns System.Threading.Tasks.Task<SetNodeNameResponse>

Sets node value for a node with given id.

Id of the node to set value for. New node's value. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Sets node HTML markup, returns new node id.

Id of the node to set markup for. Outer HTML markup to set. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Undoes the last performed action.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Returns iframe node that owns iframe with the given domain.

frameId returns System.Threading.Tasks.Task<GetFrameOwnerResponse>

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

nodeId containerName physicalAxes logicalAxes returns System.Threading.Tasks.Task<GetContainerForNodeResponse>

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

Id of the container node to find querying descendants from. returns System.Threading.Tasks.Task<GetQueryingDescendantsForContainerResponse>

DOM breakpoint type.

subtree-modified

attribute-modified

node-removed

CSP Violation type.

trustedtype-sink-violation

trustedtype-policy-violation

Object event listener.

`EventListener`'s type.

`EventListener`'s useCapture.

`EventListener`'s passive flag.

`EventListener`'s once flag.

Script id of the handler code.

Line number in the script (0-based).

Column number in the script (0-based).

Event handler function value.

Event original handler function value.

Node the listener is added to (if any).

GetEventListenersResponse

listeners

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.

DOMDebugger

DevToolsClient

Returns event listeners of the given object.

Identifier of the object to return listeners for. The maximum depth at which Node children should be retrieved, defaults to 1. Use -1 for theentire subtree or provide an integer larger than 0. Whether or not iframes and shadow roots should be traversed when returning the subtree(default is false). Reports listeners for all contexts if pierce is enabled. returns System.Threading.Tasks.Task<GetEventListenersResponse>

Removes DOM breakpoint that was set using `setDOMBreakpoint`.

Identifier of the node to remove breakpoint from. Type of the breakpoint to remove. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Removes breakpoint on particular DOM event.

Event name. EventTarget interface name. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Removes breakpoint from XMLHttpRequest.

Resource URL substring. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Sets breakpoint on particular CSP violations.

CSP Violations to stop upon. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Sets breakpoint on particular operation with DOM.

Identifier of the node to set breakpoint on. Type of the operation to stop upon. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Sets breakpoint on particular DOM event.

DOM Event name to stop on (any DOM event will do). EventTarget interface name to stop on. If equal to `"*"` or not provided, will stop on anyEventTarget. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Sets breakpoint on XMLHttpRequest.

Resource URL substring. All XHRs having this substring in the URL will get stopped upon. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

A Node in the DOM tree.

`Node`'s nodeType.

`Node`'s nodeName.

`Node`'s nodeValue.

Only set for textarea elements, contains the text value.

Only set for input elements, contains the input's associated text value.

Only set for radio and checkbox input elements, indicates if the element has been checked

Only set for option elements, indicates if the element has been selected

`Node`'s id, corresponds to DOM.Node.backendNodeId.

The indexes of the node's child nodes in the `domNodes` array returned by `getSnapshot`, if any.

Attributes of an `Element` node.

Indexes of pseudo elements associated with this node in the `domNodes` array returned by `getSnapshot`, if any.

The index of the node's related layout tree node in the `layoutTreeNodes` array returned by `getSnapshot`, if any.

Document URL that `Document` or `FrameOwner` node points to.

Base URL that `Document` or `FrameOwner` node uses for URL completion.

Only set for documents, contains the document's content language.

Only set for documents, contains the document's character set encoding.

`DocumentType` node's publicId.

`DocumentType` node's systemId.

Frame ID for frame owner elements and also for the document node.

The index of a frame owner element's content document in the `domNodes` array returned by `getSnapshot`, if any.

Type of a pseudo element node.

Shadow root type.

Whether this DOM node responds to mouse clicks. This includes nodes that have had click event listeners attached via JavaScript as well as anchor tags that naturally navigate when clicked.

Details of the node's event listeners, if any.

The selected url for nodes with a srcset attribute.

The url of the script (if any) that generates this node.

Scroll offsets, set when this node is a Document.

ScrollOffsetY

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

The bounding box in document coordinates. Note that scroll offset of the document is ignored.

The starting index in characters, for this post layout textbox substring. Characters that would be represented as a surrogate pair in UTF-16 have length 2.

The number of characters in this post layout textbox substring. Characters that would be represented as a surrogate pair in UTF-16 have length 2.

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

The index of the related DOM node in the `domNodes` array returned by `getSnapshot`.

The bounding box in document coordinates. Note that scroll offset of the document is ignored.

Contents of the LayoutText, if any.

The post-layout inline text nodes, if any.

Index into the `computedStyles` array returned by `getSnapshot`.

Global paint order index, which is determined by the stacking order of the nodes. Nodes that are painted together will have the same index. Only provided if includePaintOrder in getSnapshot was true.

Set to true to indicate the element begins a new stacking context.

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

Name/value pairs of computed style properties.

A name/value pair.

Attribute/property name.

Attribute/property value.

Data that is only present on rare nodes.

Index

Value

RareBooleanData

Index

RareIntegerData

Index

Value

Document snapshot.

Document URL that `Document` or `FrameOwner` node points to.

Document title.

Base URL that `Document` or `FrameOwner` node uses for URL completion.

Contains the document's content language.

Contains the document's character set encoding.

`DocumentType` node's publicId.

`DocumentType` node's systemId.

Frame ID for frame owner elements and also for the document node.

A table with dom nodes.

The nodes in the layout tree.

The post-layout inline text nodes.

Horizontal scroll offset.

Vertical scroll offset.

Document content width.

Document content height.

Table containing nodes.

Parent node index.

`Node`'s nodeType.

Type of the shadow root the `Node` is in. String values are equal to the `ShadowRootType` enum.

`Node`'s nodeName.

`Node`'s nodeValue.

`Node`'s id, corresponds to DOM.Node.backendNodeId.

Attributes of an `Element` node. Flatten name, value pairs.

Only set for textarea elements, contains the text value.

Only set for input elements, contains the input's associated text value.

Only set for radio and checkbox input elements, indicates if the element has been checked

Only set for option elements, indicates if the element has been selected

The index of the document in the list of the snapshot documents.

Type of a pseudo element node.

Pseudo element identifier for this node. Only present if there is a valid pseudoType.

Whether this DOM node responds to mouse clicks. This includes nodes that have had click event listeners attached via JavaScript as well as anchor tags that naturally navigate when clicked.

The selected url for nodes with a srcset attribute.

The url of the script (if any) that generates this node.

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

Index of the corresponding node in the `NodeTreeSnapshot` array returned by `captureSnapshot`.

Array of indexes specifying computed style strings, filtered according to the `computedStyles` parameter passed to `captureSnapshot`.

The absolute position bounding box.

Contents of the LayoutText, if any.

Stacking context information.

Global paint order index, which is determined by the stacking order of the nodes. Nodes that are painted together will have the same index. Only provided if includePaintOrder in captureSnapshot was true.

The offset rect of nodes. Only available when includeDOMRects is set to true

The scroll rect of nodes. Only available when includeDOMRects is set to true

The client rect of nodes. Only available when includeDOMRects is set to true

The list of background colors that are blended with colors of overlapping elements.

The list of computed text opacities.

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

Index of the layout tree node that owns this box collection.

The absolute position bounding box.

The starting index in characters, for this post layout textbox substring. Characters that would be represented as a surrogate pair in UTF-16 have length 2.

The number of characters in this post layout textbox substring. Characters that would be represented as a surrogate pair in UTF-16 have length 2.

CaptureSnapshotResponse

documents

strings

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

DOMSnapshot

DevToolsClient

Disables DOM snapshot agent for the given page.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Enables DOM snapshot agent for the given page.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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.

Whitelist of computed styles to return. Whether to include layout object paint orders into the snapshot. Whether to include DOM rectangles (offsetRects, clientRects, scrollRects) into the snapshot Whether to include blended background colors in the snapshot (default: false).Blended background color is achieved by blending background colors of all elementsthat overlap with the current element. Whether to include text color opacity in the snapshot (default: false).An element might have the opacity property set that affects the text color of the element.The final text color opacity is computed based on the opacity of all overlapping elements. returns System.Threading.Tasks.Task<CaptureSnapshotResponse>

DOM Storage identifier.

Security origin for the storage.

Represents a key by which DOM Storage keys its CachedStorageAreas

Whether the storage is local storage (not session storage).

domStorageItemAdded

StorageId

Key

NewValue

domStorageItemRemoved

StorageId

Key

domStorageItemUpdated

StorageId

Key

OldValue

NewValue

domStorageItemsCleared

StorageId

GetDOMStorageItemsResponse

entries

Query and modify DOM storage.

DOMStorage

DevToolsClient

DomStorageItemAdded

DomStorageItemRemoved

DomStorageItemUpdated

DomStorageItemsCleared

Clear

storageId returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

GetDOMStorageItems

storageId returns System.Threading.Tasks.Task<GetDOMStorageItemsResponse>

RemoveDOMStorageItem

storageId key returns System.Threading.Tasks.Task<DevToolsMethodResponse>

SetDOMStorageItem

storageId key value returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Database object.

Database ID.

Database domain.

Database name.

Database version.

Database error.

Error message.

Error code.

addDatabase

Database

ExecuteSQLResponse

columnNames

values

sqlError

GetDatabaseTableNamesResponse

tableNames

Database

DevToolsClient

AddDatabase

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

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

ExecuteSQL

databaseId query returns System.Threading.Tasks.Task<ExecuteSQLResponse>

GetDatabaseTableNames

databaseId returns System.Threading.Tasks.Task<GetDatabaseTableNamesResponse>

Orientation type.

portraitPrimary

portraitSecondary

landscapePrimary

landscapeSecondary

Screen orientation.

Orientation type.

Orientation angle.

Orientation of a display feature in relation to screen

vertical

horizontal

DisplayFeature

Orientation of a display feature in relation to screen

The offset from the screen origin in either the x (for vertical orientation) or y (for horizontal orientation) direction.

A display feature may mask content such that it is not physically displayed - this length along with the offset describes this area. A display feature that only splits content will have a 0 mask_length.

Current posture of the device

continuous

folded

DevicePosture

Current posture of the device

MediaFeature

Name

Value

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.

advance

pause

pauseIfNetworkFetchesPending

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

Brand

Version

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.

Brands appearing in Sec-CH-UA.

Brands appearing in Sec-CH-UA-Full-Version-List.

FullVersion

Platform

PlatformVersion

Architecture

Model

Mobile

Bitness

Wow64

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

absolute-orientation

accelerometer

ambient-light

gravity

gyroscope

linear-acceleration

magnetometer

proximity

relative-orientation

SensorMetadata

Available

MinimumFrequency

MaximumFrequency

SensorReadingSingle

Value

SensorReadingXYZ

SensorReadingQuaternion

SensorReading

Single

Xyz

Quaternion

Enum of image types that can be disabled.

avif

webp

CanEmulateResponse

result

GetOverriddenSensorInformationResponse

requestedSamplingFrequency

SetVirtualTimePolicyResponse

virtualTimeTicksBase

Touch/gesture events configuration. Default: current platform.

mobile

desktop

Vision deficiency to emulate. Order: best-effort emulations come first, followed by any physiologically accurate emulations for medically recognized color vision deficiencies.

none

blurredVision

reducedContrast

achromatopsia

deuteranopia

protanopia

tritanopia

This domain emulates different environments for the page.

Emulation

DevToolsClient

Notification sent after the virtual time budget for the current VirtualTimePolicy has run out.

Tells whether emulation is supported.

returns System.Threading.Tasks.Task<CanEmulateResponse>

Clears the overridden device metrics.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Clears the overridden Geolocation Position and Error.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Requests that page scale factor is reset to initial values.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Enables or disables simulating a focused and active page.

Whether to enable to disable focus emulation. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Automatically render all web contents using a dark theme.

Whether to enable or disable automatic dark mode.If not specified, any existing override will be cleared. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Enables CPU throttling to emulate slow CPUs.

Throttling rate as a slowdown factor (1 is no throttle, 2 is 2x slowdown, etc). returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

RGBA of the default background color. If not specified, any existing override will becleared. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

Overriding width value in pixels (minimum 0, maximum 10000000). 0 disables the override. Overriding height value in pixels (minimum 0, maximum 10000000). 0 disables the override. Overriding device scale factor value. 0 disables the override. Whether to emulate mobile device. This includes viewport meta tag, overlay scrollbars, textautosizing and more. Scale to apply to resulting view image. Overriding screen width value in pixels (minimum 0, maximum 10000000). Overriding screen height value in pixels (minimum 0, maximum 10000000). Overriding view X position on screen in pixels (minimum 0, maximum 10000000). Overriding view Y position on screen in pixels (minimum 0, maximum 10000000). Do not set visible view size, rely upon explicit setVisibleSize call. Screen orientation override. If set, the visible area of the page will be overridden to this viewport. This viewportchange is not observed by the page, e.g. viewport-relative elements do not change positions. If set, the display feature of a multi-segment screen. If not set, multi-segment supportis turned-off. If set, the posture of a foldable device. If not set the posture is setto continuous. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

SetScrollbarsHidden

Whether scrollbars should be always hidden. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

SetDocumentCookieDisabled

Whether document.coookie API should be disabled. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

SetEmitTouchEventsForMouse

Whether touch emulation based on mouse input should be enabled. Touch/gesture events configuration. Default: current platform. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

Media type to emulate. Empty string disables the override. Media features to emulate. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Emulates the given vision deficiency.

Vision deficiency to emulate. Order: best-effort emulations come first, followed by anyphysiologically accurate emulations for medically recognized color vision deficiencies. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

Mock latitude Mock longitude Mock accuracy returns System.Threading.Tasks.Task<DevToolsMethodResponse>

GetOverriddenSensorInformation

type returns System.Threading.Tasks.Task<GetOverriddenSensorInformationResponse>

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.

enabled type metadata returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

type reading returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Overrides the Idle state.

Mock isUserActive Mock isScreenUnlocked returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Clears Idle state overrides.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Sets a specified page scale factor.

Page scale factor. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Switches script execution in the page.

Whether script execution should be disabled in the page. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Enables touch on platforms which do not support them.

Whether the touch event emulation should be enabled. Maximum touch points supported. Defaults to one. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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.

policy If set, after this many virtual milliseconds have elapsed virtual time will be paused and avirtualTimeBudgetExpired event is sent. If set this specifies the maximum number of tasks that can be run before virtual is forcedforwards to prevent deadlock. If set, base::Time::Now will be overridden to initially return this value. returns System.Threading.Tasks.Task<SetVirtualTimePolicyResponse>

Overrides default host system locale with the specified one.

ICU style C locale (e.g. "en_US"). If not specified or empty, disables the override andrestores default host system locale. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Overrides default host system timezone with the specified one.

The timezone identifier. List of supported timezones:https://source.chromium.org/chromium/chromium/deps/icu.git/+/faee8bc70570192d82d2978a71e2a615788597d1:source/data/misc/metaZones.txtIf empty, disables the override and restores default host system timezone. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

SetDisabledImageTypes

Image types to disable. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

SetHardwareConcurrencyOverride

Hardware concurrency to report returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

User agent to use. Browser language to emulate. The platform navigator.platform should return. To be sent in Sec-CH-UA-* headers and returned in navigator.userAgentData returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Allows overriding the automation flag.

Whether the override should be enabled. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Image compression format (defaults to png).

jpeg

png

webp

Encoding options for a screenshot.

Image compression format (defaults to png).

Compression quality from range [0..100] (jpeg and webp only).

Optimize image encoding for speed, not for resulting size (defaults to false)

BeginFrameResponse

hasDamage

screenshotData

This domain provides experimental commands only supported in headless mode.

HeadlessExperimental

DevToolsClient

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.

Timestamp of this BeginFrame in Renderer TimeTicks (milliseconds of uptime). If not set,the current time will be used. The interval between BeginFrames that is reported to the compositor, in milliseconds.Defaults to a 60 frames/second interval, i.e. about 16.666 milliseconds. Whether updates should not be committed and drawn onto the display. False by default. Iftrue, only side effects of the BeginFrame will be run, such as layout and animations, butany visual updates may not be visible on the display or in screenshots. If set, a screenshot of the frame will be captured and returned in the response. Otherwise,no screenshot will be captured. Note that capturing a screenshot can fail, for example,during renderer initialization. In such a case, no screenshot data will be returned. returns System.Threading.Tasks.Task<BeginFrameResponse>

Database with an array of object stores.

Database name.

Database version (type is not 'integer', as the standard requires the version number to be 'unsigned long long')

Object stores in this database.

Object store.

Object store name.

Object store key path.

If true, object store has auto increment flag set.

Indexes in this object store.

Object store index.

Index name.

Index key path.

If true, index is unique.

If true, index allows multiple entries for a key.

Key type.

number

string

date

array

Key.

Key type.

Number value.

String value.

Date value.

Array value.

Key range.

Lower bound.

Upper bound.

If true lower bound is open.

If true upper bound is open.

Data entry.

Key object.

Primary key object.

Value object.

Key path type.

null

string

array

Key path.

Key path type.

String value.

Array value.

RequestDataResponse

objectStoreDataEntries

hasMore

GetMetadataResponse

entriesCount

keyGeneratorValue

RequestDatabaseResponse

databaseWithObjectStores

RequestDatabaseNamesResponse

databaseNames

IndexedDB

DevToolsClient

Clears all entries from an object store.

Database name. Object store name. At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.Security origin. Storage key. Storage bucket. If not specified, it uses the default bucket. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Deletes a database.

Database name. At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.Security origin. Storage key. Storage bucket. If not specified, it uses the default bucket. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Delete a range of entries from an object store

databaseName objectStoreName Range of entry keys to delete At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.Security origin. Storage key. Storage bucket. If not specified, it uses the default bucket. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Disables events from backend.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Enables events from backend.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Requests data from object store or index.

Database name. Object store name. Index name, empty string for object store data requests. Number of records to skip. Number of records to fetch. At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.Security origin. Storage key. Storage bucket. If not specified, it uses the default bucket. Key range. returns System.Threading.Tasks.Task<RequestDataResponse>

Gets metadata of an object store.

Requests database with given name in given frame.

Requests database names for given security origin.

At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.Security origin. Storage key. Storage bucket. If not specified, it uses the default bucket. returns System.Threading.Tasks.Task<RequestDatabaseNamesResponse>

TouchPoint

X coordinate of the event relative to the main frame's viewport in CSS pixels.

Y coordinate of the event relative to the main frame's viewport in CSS pixels. 0 refers to the top of the viewport and Y increases as it proceeds towards the bottom of the viewport.

X radius of the touch area (default: 1.0).

Y radius of the touch area (default: 1.0).

Rotation angle (default: 0.0).

Force (default: 1.0).

The normalized tangential pressure, which has a range of [-1,1] (default: 0).

The plane angle between the Y-Z plane and the plane containing both the stylus axis and the Y axis, in degrees of the range [-90,90], a positive tiltX is to the right (default: 0)

The plane angle between the X-Z plane and the plane containing both the stylus axis and the X axis, in degrees of the range [-90,90], a positive tiltY is towards the user (default: 0).

The clockwise rotation of a pen stylus around its own major axis, in degrees in the range [0,359] (default: 0).

Identifier used to track touch sources between events, must be unique within an event.

GestureSourceType

default

touch

mouse

MouseButton

none

left

middle

right

back

forward

DragDataItem

Mime type of the dragged data.

Depending of the value of `mimeType`, it contains the dragged link, text, HTML markup or any other data.

Title associated with a link. Only valid when `mimeType` == "text/uri-list".

Stores the base URL for the contained markup. Only valid when `mimeType` == "text/html".

DragData

Items

List of filenames that should be included when dropping

Bit field representing allowed drag operations. Copy = 1, Link = 2, Move = 16

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

Data

Type of the drag event.

dragEnter

dragOver

drop

dragCancel

Type of the key event.

keyDown

keyUp

rawKeyDown

char

Type of the mouse event.

mousePressed

mouseReleased

mouseMoved

mouseWheel

Pointer type (default: "mouse").

mouse

pen

Type of the touch event. TouchEnd and TouchCancel must not contain any touch points, while TouchStart and TouchMove must contains at least one.

touchStart

touchEnd

touchMove

touchCancel

Type of the mouse event.

mousePressed

mouseReleased

mouseMoved

mouseWheel

Input

DevToolsClient

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

Dispatches a drag event into the page.

Type of the drag event. X coordinate of the event relative to the main frame's viewport in CSS pixels. Y coordinate of the event relative to the main frame's viewport in CSS pixels. 0 refers tothe top of the viewport and Y increases as it proceeds towards the bottom of the viewport. data Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8(default: 0). returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Dispatches a key event to the page.

Type of the key event. Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8(default: 0). Time at which the event occurred. Text as generated by processing a virtual key code with a keyboard layout. Not needed forfor `keyUp` and `rawKeyDown` events (default: "") Text that would have been generated by the keyboard if no modifiers were pressed (except forshift). Useful for shortcut (accelerator) key handling (default: ""). Unique key identifier (e.g., 'U+0041') (default: ""). Unique DOM defined string value for each physical key (e.g., 'KeyA') (default: ""). Unique DOM defined string value describing the meaning of the key in the context of activemodifiers, keyboard layout, etc (e.g., 'AltGr') (default: ""). Windows virtual key code (default: 0). Native virtual key code (default: 0). Whether the event was generated from auto repeat (default: false). Whether the event was generated from the keypad (default: false). Whether the event was a system key event (default: false). Whether the event was from the left or right side of the keyboard. 1=Left, 2=Right (default:0). Editing commands to send with the key event (e.g., 'selectAll') (default: []).These are related to but not equal the command names used in `document.execCommand` and NSStandardKeyBindingResponding.See https://source.chromium.org/chromium/chromium/src/+/main:third_party/blink/renderer/core/editing/commands/editor_command_names.h for valid command names. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

The text to insert. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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.

The text to insert selection start selection end replacement start replacement end returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Dispatches a mouse event to the page.

Type of the mouse event. X coordinate of the event relative to the main frame's viewport in CSS pixels. Y coordinate of the event relative to the main frame's viewport in CSS pixels. 0 refers tothe top of the viewport and Y increases as it proceeds towards the bottom of the viewport. Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8(default: 0). Time at which the event occurred. Mouse button (default: "none"). A number indicating which buttons are pressed on the mouse when a mouse event is triggered.Left=1, Right=2, Middle=4, Back=8, Forward=16, None=0. Number of times the mouse button was clicked (default: 0). The normalized pressure, which has a range of [0,1] (default: 0). The normalized tangential pressure, which has a range of [-1,1] (default: 0). The plane angle between the Y-Z plane and the plane containing both the stylus axis and the Y axis, in degrees of the range [-90,90], a positive tiltX is to the right (default: 0). The plane angle between the X-Z plane and the plane containing both the stylus axis and the X axis, in degrees of the range [-90,90], a positive tiltY is towards the user (default: 0). The clockwise rotation of a pen stylus around its own major axis, in degrees in the range [0,359] (default: 0). X delta in CSS pixels for mouse wheel event (default: 0). Y delta in CSS pixels for mouse wheel event (default: 0). Pointer type (default: "mouse"). returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Dispatches a touch event to the page.

Type of the touch event. TouchEnd and TouchCancel must not contain any touch points, whileTouchStart and TouchMove must contains at least one. Active touch points on the touch device. One event per any changed point (compared toprevious touch event in a sequence) is generated, emulating pressing/moving/releasing pointsone by one. Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8(default: 0). Time at which the event occurred. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Cancels any active dragging in the page.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Emulates touch event from the mouse event parameters.

Type of the mouse event. X coordinate of the mouse pointer in DIP. Y coordinate of the mouse pointer in DIP. Mouse button. Only "none", "left", "right" are supported. Time at which the event occurred (default: current time). X delta in DIP for mouse wheel event (default: 0). Y delta in DIP for mouse wheel event (default: 0). Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8(default: 0). Number of times the mouse button was clicked (default: 0). returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Ignores input events (useful while auditing page).

Ignores input events processing when set to true. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

enabled returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

X coordinate of the start of the gesture in CSS pixels. Y coordinate of the start of the gesture in CSS pixels. Relative scale factor after zooming (>1.0 zooms in, <1.0 zooms out). Relative pointer speed in pixels per second (default: 800). Which type of input events to be generated (default: 'default', which queries the platformfor the preferred input type). returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

X coordinate of the start of the gesture in CSS pixels. Y coordinate of the start of the gesture in CSS pixels. The distance to scroll along the X axis (positive to scroll left). The distance to scroll along the Y axis (positive to scroll up). The number of additional pixels to scroll back along the X axis, in addition to the givendistance. The number of additional pixels to scroll back along the Y axis, in addition to the givendistance. Prevent fling (default: true). Swipe speed in pixels per second (default: 800). Which type of input events to be generated (default: 'default', which queries the platformfor the preferred input type). The number of times to repeat the gesture (default: 0). The number of milliseconds delay between each repeat. (default: 250). The name of the interaction markers to generate, if not empty (default: ""). returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

X coordinate of the start of the gesture in CSS pixels. Y coordinate of the start of the gesture in CSS pixels. Duration between touchdown and touchup events in ms (default: 50). Number of times to perform the tap (e.g. 2 for double tap, default: 1). Which type of input events to be generated (default: 'default', which queries the platformfor the preferred input type). returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Fired when remote debugging connection is about to be terminated. Contains detach reason.

The reason why connection has been terminated.

Inspector

DevToolsClient

Fired when remote debugging connection is about to be terminated. Contains detach reason.

Fired when debugging target has crashed

Fired when debugging target has reloaded after crash

Disables inspector domain notifications.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Enables inspector domain notifications.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Reason for rectangle to force scrolling on the main thread

RepaintsOnScroll

TouchEventHandler

WheelEventHandler

Rectangle where scrolling happens on the main thread.

Rectangle itself.

Reason for rectangle to force scrolling on the main thread

Sticky position constraints.

Layout rectangle of the sticky element before being shifted

Layout rectangle of the containing block of the sticky element

The nearest sticky layer that shifts the sticky box

The nearest sticky layer that shifts the containing block

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

Offset from owning layer left boundary

Offset from owning layer top boundary

Base64-encoded snapshot data.

Information about a compositing layer.

The unique id for this layer.

The id of parent (not present for root).

The backend id for the node associated with this layer.

Offset from parent layer, X coordinate.

Offset from parent layer, Y coordinate.

Layer width.

Layer height.

Transformation matrix for layer, default is identity matrix

Transform anchor point X, absent if no transform specified

Transform anchor point Y, absent if no transform specified

Transform anchor point Z, absent if no transform specified

Indicates how many time this layer has painted.

Indicates whether this layer hosts any content, rather than being used for transform/scrolling purposes only.

Set if layer is not visible.

Rectangles scrolling on main thread only.

Sticky position constraint information

layerPainted

The id of the painted layer.

Clip rectangle.

layerTreeDidChange

Layer tree, absent if not in the compositing mode.

CompositingReasonsResponse

compositingReasons

compositingReasonIds

LoadSnapshotResponse

snapshotId

MakeSnapshotResponse

snapshotId

ProfileSnapshotResponse

timings

ReplaySnapshotResponse

dataURL

SnapshotCommandLogResponse

commandLog

LayerTree

DevToolsClient

LayerPainted

LayerTreeDidChange

Provides the reasons why the given layer was composited.

The id of the layer for which we want to get the reasons it was composited. returns System.Threading.Tasks.Task<CompositingReasonsResponse>

Disables compositing tree inspection.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Enables compositing tree inspection.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Returns the snapshot identifier.

An array of tiles composing the snapshot. returns System.Threading.Tasks.Task<LoadSnapshotResponse>

Returns the layer snapshot identifier.

The id of the layer. returns System.Threading.Tasks.Task<MakeSnapshotResponse>

ProfileSnapshot

The id of the layer snapshot. The maximum number of times to replay the snapshot (1, if not specified). The minimum duration (in seconds) to replay the snapshot. The clip rectangle to apply when replaying the snapshot. returns System.Threading.Tasks.Task<ProfileSnapshotResponse>

Releases layer snapshot captured by the back-end.

The id of the layer snapshot. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Replays the layer snapshot and returns the resulting bitmap.

The id of the layer snapshot. The first step to replay from (replay from the very start if not specified). The last step to replay to (replay till the end if not specified). The scale to apply while replaying (defaults to 1). returns System.Threading.Tasks.Task<ReplaySnapshotResponse>

Replays the layer snapshot and returns canvas log.

The id of the layer snapshot. returns System.Threading.Tasks.Task<SnapshotCommandLogResponse>

Log entry source.

xml

javascript

network

storage

appcache

rendering

security

deprecation

worker

violation

intervention

recommendation

other

Log entry severity.

verbose

info

warning

error

LogEntryCategory

cors

Log entry.

Log entry source.

Log entry severity.

Logged text.

Meta

ContentSecurityPolicyStatus

EffectiveDirectives

IsEnforced

Source

SecurityIsolationStatus

Coop

Coep

Csp

The status of a Reporting API report.

Queued

Pending

MarkedForRemoval

Success

An object representing a report generated by the Reporting API.

The URL of the document that triggered the report.

The name of the endpoint group that should be used to deliver the report.

The type of the report (specifies the set of data that is contained in the report body).

When the report was generated.

How many uploads deep the related request was.

The number of delivery attempts made so far, not including an active attempt.

Body

Status

ReportingApiEndpoint

The URL of the endpoint to which reports may be delivered.

Name of the endpoint group.

An object providing the result of a network resource load.

Success

Optional values used for error reporting.

NetErrorName

HttpStatusCode

If successful, one of the following two fields holds the result.

Response headers.

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

DisableCache

IncludeCredentials

Fired when data chunk was received over the network.

Request identifier.

Timestamp.

Data chunk length.

Actual bytes received (might be less than dataLength for compressed encodings).

Data that was received.

Fired when EventSource message is received.

Request identifier.

Timestamp.

Message type.

Message identifier.

Message content.

Fired when HTTP request has failed to load.

Request identifier.

Timestamp.

Resource type.

Error message. List of network errors: https://cs.chromium.org/chromium/src/net/base/net_error_list.h

True if loading was canceled.

The reason why loading was blocked, if any.

The reason why loading was blocked by CORS, if any.

Fired when HTTP request has finished loading.

Request identifier.

Timestamp.

Total number of bytes received for this request.

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

Each request the page makes will have a unique id, however if any redirects are encountered while processing that fetch, they will be reported with the same id as the original fetch. Likewise if HTTP authentication is needed then the same fetch id will be used.

Request

The id of the frame that initiated the request.

How the requested resource will be used.

Whether this is a navigation request, which can abort the navigation completely.

Set if the request is a navigation that will result in a download. Only present after response is received from the server (i.e. HeadersReceived stage).

Redirect location, only sent if a redirect was intercepted.

Details of the Authorization Challenge encountered. If this is set then continueInterceptedRequest must contain an authChallengeResponse.

Response error if intercepted at response stage or if redirect occurred while intercepting request.

Response code if intercepted at response stage or if redirect occurred while intercepting request or auth retry occurred.

Response headers if intercepted at the response stage or if redirect occurred while intercepting request or auth retry occurred.

If the intercepted request had a corresponding requestWillBeSent event fired for it, then this requestId will be the same as the requestId present in the requestWillBeSent event.

Fired if request ended up loading from cache.

Request identifier.

Fired when page is about to send HTTP request.

Request identifier.

Loader identifier. Empty string if the request is fetched from worker.

URL of the document this request is loaded for.

Request data.

Timestamp.

Request initiator.

In the case that redirectResponse is populated, this flag indicates whether requestWillBeSentExtraInfo and responseReceivedExtraInfo events will be or were emitted for the request which was just redirected.

Redirect response data.

Type of this resource.

Frame identifier.

Whether the request is initiated by a user gesture. Defaults to false.

Fired when resource loading priority is changed

Request identifier.

New priority

Timestamp.

Fired when a signed exchange was received over the network

Request identifier.

Information about the signed exchange response.

Fired when HTTP response is available.

Request identifier.

Loader identifier. Empty string if the request is fetched from worker.

Timestamp.

Resource type.

Response data.

Indicates whether requestWillBeSentExtraInfo and responseReceivedExtraInfo events will be or were emitted for this request.

Frame identifier.

Fired when WebSocket is closed.

Request identifier.

Timestamp.

Fired upon WebSocket creation.

Request identifier.

WebSocket request URL.

Request initiator.

Fired when WebSocket message error occurs.

Request identifier.

Timestamp.

WebSocket error message.

Fired when WebSocket message is received.

Request identifier.

Timestamp.

WebSocket response data.

Fired when WebSocket message is sent.

Request identifier.

Timestamp.

WebSocket response data.

Fired when WebSocket handshake response becomes available.

Request identifier.

Timestamp.

WebSocket response data.

Fired when WebSocket is about to initiate handshake.

Request identifier.

Timestamp.

UTC Timestamp.

WebSocket request data.

Fired upon WebTransport creation.

WebTransport identifier.

WebTransport request URL.

Timestamp.

Request initiator.

Fired when WebTransport handshake is finished.

WebTransport identifier.

Timestamp.

Fired when WebTransport is disposed.

WebTransport identifier.

Timestamp.

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.

Request identifier. Used to match this information to an existing requestWillBeSent event.

A list of cookies potentially associated to the requested URL. This includes both cookies sent with the request and the ones not sent; the latter are distinguished by having blockedReasons field set.

Raw request headers as they will be sent over the wire.

Connection timing information for the request.

The client security state set for the request.

Whether the site has partitioned cookies stored in a partition different than the current one.

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.

Request identifier. Used to match this information to another responseReceived event.

A list of cookies which were not stored from the response along with the corresponding reasons for blocking. The cookies here may not be valid due to syntax errors, which are represented by the invalid cookie line string instead of a proper cookie.

Raw response headers as they were received over the wire.

The IP address space of the resource. The address space can only be determined once the transport established the connection, so we can't send it in `requestWillBeSentExtraInfo`.

The status code of the response. This is useful in cases the request failed and no responseReceived event is triggered, which is the case for, e.g., CORS errors. This is also the correct status code for cached requests, where the status in responseReceived is a 200 and this will be 304.

Raw response header text as it was received over the wire. The raw text may not always be available, such as in the case of HTTP/2 or QUIC.

The cookie partition key that will be used to store partitioned cookies set in this response. Only sent when partitioned cookies are enabled.

True if partitioned cookies are enabled, but the partition key is not serializable to string.

A list of cookies which should have been blocked by 3PCD but are exempted and stored from the response with the corresponding reason.

Detailed success or error status of the operation. 'AlreadyExists' also signifies a successful operation, as the result of the operation already exists und thus, the operation was abort preemptively (e.g. a cache hit).

InvalidArgument

MissingIssuerKeys

FailedPrecondition

ResourceExhausted

AlreadyExists

Unavailable

Unauthorized

BadResponse

InternalError

UnknownError

FulfilledLocally

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.

Type

RequestId

Top level origin. The context in which the operation was attempted.

Origin of the issuer in case of a "Issuance" or "Redemption" operation.

The number of obtained Trust Tokens on a successful "Issuance" operation.

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

Request identifier. Used to match this information to another event.

A list of URLs of resources in the subresource Web Bundle.

Fired once when parsing the .wbn file has failed.

Request identifier. Used to match this information to another event.

Error message

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

Request identifier of the subresource request

URL of the subresource resource.

Bundle request identifier. Used to match this information to another event. This made be absent in case when the instrumentation was enabled only after webbundle was parsed.

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

Request identifier of the subresource request

URL of the subresource resource.

Error message

Bundle request identifier. Used to match this information to another event. This made be absent in case when the instrumentation was enabled only after webbundle was parsed.

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

Report

reportingApiReportUpdated

Report

reportingApiEndpointsChangedForOrigin

Origin of the document(s) which configured the endpoints.

Endpoints

GetCertificateResponse

tableNames

GetCookiesResponse

GetResponseBodyResponse

body

base64Encoded

GetRequestPostDataResponse

postData

GetResponseBodyForInterceptionResponse

body

base64Encoded

TakeResponseBodyForInterceptionAsStreamResponse

stream

SearchInResponseBodyResponse

result

SetCookieResponse

success

StreamResourceContentResponse

bufferedData

GetSecurityIsolationStatusResponse

status

LoadNetworkResourceResponse

resource

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.

Network

DevToolsClient

Fired when data chunk was received over the network.

Fired when EventSource message is received.

Fired when HTTP request has failed to load.

Fired when HTTP request has finished loading.

Fired if request ended up loading from cache.

Fired when page is about to send HTTP request.

Fired when resource loading priority is changed

Fired when a signed exchange was received over the network

Fired when HTTP response is available.

Fired when WebSocket is closed.

Fired upon WebSocket creation.

Fired when WebSocket message error occurs.

Fired when WebSocket message is received.

Fired when WebSocket message is sent.

Fired when WebSocket handshake response becomes available.

Fired when WebSocket is about to initiate handshake.

Fired upon WebTransport creation.

Fired when WebTransport handshake is finished.

Fired when WebTransport is disposed.

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

Fired once when parsing the .wbn file has failed.

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

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

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

ReportingApiReportUpdated

ReportingApiEndpointsChangedForOrigin

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

List of accepted content encodings. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Clears accepted encodings set by setAcceptedEncodings

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Clears browser cache.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Clears browser cookies.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

Name of the cookies to remove. If specified, deletes all the cookies with the given name where domain and path matchprovided URL. If specified, deletes only cookies with the exact domain. If specified, deletes only cookies with the exact path. If specified, deletes only cookies with the the given name and partitionKey where domainmatches provided URL. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Activates emulation of network conditions.

True to emulate internet disconnection. Minimum latency from request sent to response headers received (ms). Maximal aggregated download throughput (bytes/sec). -1 disables download throttling. Maximal aggregated upload throughput (bytes/sec). -1 disables upload throttling. Connection type if known. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

Buffer size in bytes to use when preserving network payloads (XHRs, etc). Per-resource buffer size in bytes to use when preserving network payloads (XHRs, etc). Longest post body size (in bytes) that would be included in requestWillBeSent notification returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Returns the DER-encoded certificate.

Origin to get certificate for. returns System.Threading.Tasks.Task<GetCertificateResponse>

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

The list of URLs for which applicable cookies will be fetched.If not specified, it's assumed to be set to the list containingthe URLs of the page and all of its subframes. returns System.Threading.Tasks.Task<GetCookiesResponse>

Returns content served for the given request.

Identifier of the network request to get content for. returns System.Threading.Tasks.Task<GetResponseBodyResponse>

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

Identifier of the network request to get content for. returns System.Threading.Tasks.Task<GetRequestPostDataResponse>

Returns content served for the given currently intercepted request.

Identifier for the intercepted request to get body for. returns System.Threading.Tasks.Task<GetResponseBodyForInterceptionResponse>

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.

interceptionId returns System.Threading.Tasks.Task<TakeResponseBodyForInterceptionAsStreamResponse>

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.

Identifier of XHR to replay. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Searches for given string in response content.

Identifier of the network response to search. String to search for. If true, search is case sensitive. If true, treats string parameter as regex. returns System.Threading.Tasks.Task<SearchInResponseBodyResponse>

Blocks URLs from loading.

URL patterns to block. Wildcards ('*') are allowed. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Toggles ignoring of service worker for each request.

Bypass service worker and load from network. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

Cache disabled state. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

Cookie name. Cookie value. The request-URI to associate with the setting of the cookie. This value can affect thedefault domain, path, source port, and source scheme values of the created cookie. Cookie domain. Cookie path. True if cookie is secure. True if cookie is http-only. Cookie SameSite type. Cookie expiration date, session cookie if not set Cookie Priority type. True if cookie is SameParty. Cookie source scheme type. Cookie source port. Valid values are {-1, [1, 65535]}, -1 indicates an unspecified port.An unspecified port value allows protocol clients to emulate legacy cookie scope for the port.This is a temporary ability and it will be removed in the future. Cookie partition key. The site of the top-level URL the browser was visiting at the startof the request to the endpoint that set the cookie.If not set, the cookie will be set as not partitioned. returns System.Threading.Tasks.Task<SetCookieResponse>

Sets given cookies.

Cookies to be set. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

Map with extra HTTP headers. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Specifies whether to attach a page script stack id in requests

Whether to attach a page script stack for debugging purpose. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Allows overriding user agent with the given string.

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

Identifier of the request to stream. returns System.Threading.Tasks.Task<StreamResourceContentResponse>

Returns information about the COEP/COOP isolation status.

If no frameId is provided, the status of the target is provided. returns System.Threading.Tasks.Task<GetSecurityIsolationStatusResponse>

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.

Whether to enable or disable events for the Reporting API returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Fetches the resource and returns the content.

URL of the resource to get content for. Options for the request. Frame id to get the resource for. Mandatory for frame targets, andshould be omitted for worker targets. returns System.Threading.Tasks.Task<LoadNetworkResourceResponse>

Fetches the resource and returns the content.

Frame id to get the resource for. Mandatory for frame targets, and should be omitted for worker targets. URL of the resource to get content for. Options for the request. returns System.Threading.Tasks.Task<LoadNetworkResourceResponse> This overload of LoadNetworkResourceAsync exists to avoid a breaking change as optional params are now always at the end where previously they weren't marked as optional when at the beginning.

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

CDP uses comma seperated values to store multiple header values. Use or to get a string[] for headers that have multiple values. Helper methods for dealing with comma separated header values based on https://github.com/dotnet/aspnetcore/blob/52eff90fbcfca39b7eb58baad597df6a99a542b0/src/Http/Http.Abstractions/src/Extensions/HeaderDictionaryExtensions.cs

Initializes a new instance of the Headers class.

Returns itself

Dictionary of headers

Gets an array of values for the specified key. Values are comma seperated and will be split into a string[]. Quoted values will not be split, and the quotes will be removed.

The header name. the associated values from the dictionary separated into individual values, or null if the key is not present. true if the Dictionary contains an element with the specified key; otherwise, false.

Get the associated values from the dictionary separated into individual values. Quoted values will not be split, and the quotes will be removed.

The header name. the associated values from the dictionary separated into individual values, or null if the key is not present.

Quotes any values containing commas, and then comma joins all of the values with any existing values.

The header name. The header values.

Quotes any values containing commas, and then comma joins all of the values.

The header name. The header values.

Configuration data for drawing the source order of an elements children.

the color to outline the given element in.

the color to outline the child elements in.

Configuration data for the highlighting of Grid elements.

Whether the extension lines from grid cells to the rulers should be shown (default: false).

Show Positive line number labels (default: false).

Show Negative line number labels (default: false).

Show area name labels (default: false).

Show line name labels (default: false).

Show track size labels (default: false).

The grid container border highlight color (default: transparent).

The cell border color (default: transparent). Deprecated, please use rowLineColor and columnLineColor instead.

The row line color (default: transparent).

The column line color (default: transparent).

Whether the grid border is dashed (default: false).

Whether the cell border is dashed (default: false). Deprecated, please us rowLineDash and columnLineDash instead.

Whether row lines are dashed (default: false).

Whether column lines are dashed (default: false).

The row gap highlight fill color (default: transparent).

The row gap hatching fill color (default: transparent).

The column gap highlight fill color (default: transparent).

The column gap hatching fill color (default: transparent).

The named grid areas border color (Default: transparent).

The grid container background color (Default: transparent).

Configuration data for the highlighting of Flex container elements.

The style of the container border

The style of the separator between lines

The style of the separator between items

Style of content-distribution space on the main axis (justify-content).

Style of content-distribution space on the cross axis (align-content).

Style of empty space caused by row gaps (gap/row-gap).

Style of empty space caused by columns gaps (gap/column-gap).

Style of the self-alignment line (align-items).

Configuration data for the highlighting of Flex item elements.

Style of the box representing the item's base size

Style of the border around the box representing the item's base size

Style of the arrow representing if the item grew or shrank

The line pattern (default: solid)

dashed

dotted

Style information for drawing a line.

The color of the line (default: transparent)

The line pattern (default: solid)

Style information for drawing a box.

The background color for the box (default: transparent)

The hatching color for the box (default: transparent)

ContrastAlgorithm

aaa

apca

Configuration data for the highlighting of page elements.

Whether the node info tooltip should be shown (default: false).

Whether the node styles in the tooltip (default: false).

Whether the rulers should be shown (default: false).

Whether the a11y info should be shown (default: true).

Whether the extension lines from node to the rulers should be shown (default: false).

The content box highlight fill color (default: transparent).

The padding highlight fill color (default: transparent).

The border highlight fill color (default: transparent).

The margin highlight fill color (default: transparent).

The event target element highlight fill color (default: transparent).

The shape outside fill color (default: transparent).

The shape margin fill color (default: transparent).

The grid layout color (default: transparent).

The color format used to format color styles (default: hex).

The grid layout highlight configuration (default: all transparent).

The flex container highlight configuration (default: all transparent).

The flex item highlight configuration (default: all transparent).

The contrast algorithm to use for the contrast ratio (default: aa).

The container query container highlight configuration (default: all transparent).

ColorFormat

rgb

hsl

hwb

hex

Configurations for Persistent Grid Highlight

A descriptor for the highlight appearance.

Identifier of the node to highlight.

FlexNodeHighlightConfig

A descriptor for the highlight appearance of flex containers.

Identifier of the node to highlight.

ScrollSnapContainerHighlightConfig

The style of the snapport border (default: transparent)

The style of the snap area border (default: transparent)

The margin highlight fill color (default: transparent).

The padding highlight fill color (default: transparent).

ScrollSnapHighlightConfig

A descriptor for the highlight appearance of scroll snap containers.

Identifier of the node to highlight.

Configuration for dual screen hinge

A rectangle represent hinge

The content box highlight fill color (default: a dark color).

The content box highlight outline color (default: transparent).

Configuration for Window Controls Overlay

Whether the title bar CSS should be shown when emulating the Window Controls Overlay.

Selected platforms to show the overlay.

The theme color defined in app manifest.

ContainerQueryHighlightConfig

A descriptor for the highlight appearance of container query containers.

Identifier of the container node to highlight.

ContainerQueryContainerHighlightConfig

The style of the container border.

The style of the descendants' borders.

IsolatedElementHighlightConfig

A descriptor for the highlight appearance of an element in isolation mode.

Identifier of the isolated element to highlight.

IsolationModeHighlightConfig

The fill color of the resizers (default: transparent).

The fill color for resizer handles (default: transparent).

The fill color for the mask covering non-isolated elements (default: transparent).

InspectMode

searchForNode

searchForUAShadowDOM

captureAreaScreenshot

showDistances

none

Fired when the node should be inspected. This happens after call to `setInspectMode` or when user manually inspects an element.

Id of the node to inspect.

Fired when the node should be highlighted. This happens after call to `setInspectMode`.

NodeId

Fired when user asks to capture screenshot of some area on the page.

Viewport to capture, in device independent pixels (dip).

GetHighlightObjectForTestResponse

highlight

GetGridHighlightObjectsForTestResponse

highlights

GetSourceOrderHighlightObjectForTestResponse

highlight

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

Overlay

DevToolsClient

Fired when the node should be inspected. This happens after call to `setInspectMode` or when user manually inspects an element.

Fired when the node should be highlighted. This happens after call to `setInspectMode`.

Fired when user asks to capture screenshot of some area on the page.

Fired when user cancels the inspect mode.

Disables domain notifications.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Enables domain notifications.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

For testing.

Id of the node to get highlight object for. Whether to include distance info. Whether to include style info. The color format to get config with (default: hex). Whether to show accessibility info (default: true). returns System.Threading.Tasks.Task<GetHighlightObjectForTestResponse>

For Persistent Grid testing.

Ids of the node to get highlight object for. returns System.Threading.Tasks.Task<GetGridHighlightObjectsForTestResponse>

For Source Order Viewer testing.

Id of the node to highlight. returns System.Threading.Tasks.Task<GetSourceOrderHighlightObjectForTestResponse>

Hides any highlight.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Highlights DOM node with given id or with the given JavaScript object wrapper. Either nodeId or objectId must be specified.

A descriptor for the highlight appearance. Identifier of the node to highlight. Identifier of the backend node to highlight. JavaScript object id of the node to be highlighted. Selectors to highlight relevant nodes. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Highlights given quad. Coordinates are absolute with respect to the main frame viewport.

Quad to highlight The highlight fill color (default: transparent). The highlight outline color (default: transparent). returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Highlights given rectangle. Coordinates are absolute with respect to the main frame viewport.

X coordinate Y coordinate Rectangle width Rectangle height The highlight fill color (default: transparent). The highlight outline color (default: transparent). returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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.

A descriptor for the appearance of the overlay drawing. Identifier of the node to highlight. Identifier of the backend node to highlight. JavaScript object id of the node to be highlighted. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Enters the 'inspect' mode. In this mode, elements that user is hovering over are highlighted. Backend then generates 'inspectNodeRequested' event upon element selection.

Set an inspection mode. A descriptor for the highlight appearance of hovered-over nodes. May be omitted if `enabled== false`. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Highlights owner element of all frames detected to be ads.

True for showing ad highlights returns System.Threading.Tasks.Task<DevToolsMethodResponse>

SetPausedInDebuggerMessage

The message to display, also triggers resume and step over controls. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Requests that backend shows debug borders on layers

True for showing debug borders returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Requests that backend shows the FPS counter

True for showing the FPS counter returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Highlight multiple elements with the CSS Grid overlay.

An array of node identifiers and descriptors for the highlight appearance. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

SetShowFlexOverlays

An array of node identifiers and descriptors for the highlight appearance. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

SetShowScrollSnapOverlays

An array of node identifiers and descriptors for the highlight appearance. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

SetShowContainerQueryOverlays

An array of node identifiers and descriptors for the highlight appearance. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Requests that backend shows paint rectangles

True for showing paint rectangles returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Requests that backend shows layout shift regions

True for showing layout shift regions returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Requests that backend shows scroll bottleneck rects

True for showing scroll bottleneck rects returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Request that backend shows an overlay with web vital metrics.

show returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Paints viewport size upon main frame resize.

Whether to paint size or not. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Add a dual screen device hinge

hinge data, null means hideHinge returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Show elements in isolation mode with overlays.

An array of node identifiers and descriptors for the highlight appearance. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Show Window Controls Overlay for PWA

Window Controls Overlay data, null means hide Window Controls Overlay returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Indicates whether a frame has been identified as an ad.

none

child

root

AdFrameExplanation

ParentIsAd

CreatedByAdScript

MatchedBlockingRule

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

AdFrameType

Explanations

Identifies the bottom-most script which caused the frame to be labelled as an ad.

Script Id of the bottom-most script which caused the frame to be labelled as an ad.

Id of adScriptId's debugger.

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

Secure

SecureLocalhost

InsecureScheme

InsecureAncestor

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

Isolated

NotIsolated

NotIsolatedFeatureDisabled

GatedAPIFeatures

SharedArrayBuffers

SharedArrayBuffersTransferAllowed

PerformanceMeasureMemory

PerformanceProfile

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

accelerometer

ambient-light-sensor

attribution-reporting

autoplay

bluetooth

browsing-topics

camera

captured-surface-control

ch-dpr

ch-device-memory

ch-downlink

ch-ect

ch-prefers-color-scheme

ch-prefers-reduced-motion

ch-prefers-reduced-transparency

ch-rtt

ch-save-data

ch-ua

ch-ua-arch

ch-ua-bitness

ch-ua-platform

ch-ua-model

ch-ua-mobile

ch-ua-form-factor

ch-ua-full-version

ch-ua-full-version-list

ch-ua-platform-version

ch-ua-wow64

ch-viewport-height

ch-viewport-width

ch-width

clipboard-read

clipboard-write

compute-pressure

cross-origin-isolated

direct-sockets

display-capture

document-domain

encrypted-media

execution-while-out-of-viewport

execution-while-not-rendered

focus-without-user-activation

fullscreen

frobulate

gamepad

geolocation

gyroscope

hid

identity-credentials-get

idle-detection

interest-cohort

join-ad-interest-group

keyboard-map

local-fonts

magnetometer

microphone

midi

otp-credentials

payment

picture-in-picture

private-aggregation

private-state-token-issuance

private-state-token-redemption

publickey-credentials-create

publickey-credentials-get

run-ad-auction

screen-wake-lock

serial

shared-autofill

shared-storage

shared-storage-select-url

smart-card

speaker-selection

storage-access

sub-apps

sync-xhr

unload

usb

usb-unrestricted

vertical-scroll

web-printing

web-share

window-management

window-placement

xr-spatial-tracking

Reason for a permissions policy feature to be disabled.

Header

IframeAttribute

InFencedFrameTree

InIsolatedApp

PermissionsPolicyBlockLocator

FrameId

BlockReason

PermissionsPolicyFeatureState

Feature

Allowed

Locator

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

Success

NotSupported

Insecure

Expired

WrongOrigin

InvalidSignature

Malformed

WrongVersion

FeatureDisabled

TokenDisabled

FeatureDisabledForUser

UnknownTrial

Status for an Origin Trial.

Enabled

ValidTokenNotProvided

OSNotSupported

TrialNotAllowed

OriginTrialUsageRestriction

None

Subset

OriginTrialToken

Origin

MatchSubDomains

TrialName

ExpiryTime

IsThirdParty

UsageRestriction

OriginTrialTokenWithStatus

RawTokenText

`parsedToken` is present only when the token is extractable and parsable.

Status

OriginTrial

TrialName

Status

TokensWithStatus

Information about the Frame on the page.

Frame unique identifier.

Parent frame identifier.

Identifier of the loader associated with this frame.

Frame's name as specified in the tag.

Frame document's URL without fragment.

Frame document's URL fragment including the '#'.

Frame document's registered domain, taking the public suffixes list into account. Extracted from the Frame's url. Example URLs: http://www.google.com/file.html -> "google.com" http://a.b.co.uk/file.html -> "b.co.uk"

Frame document's security origin.

Frame document's mimeType as determined by the browser.

If the frame failed to load, this contains the URL that could not be loaded. Note that unlike url above, this URL may contain a fragment.

Indicates whether this frame was tagged as an ad and why.

Indicates whether the main document is a secure context and explains why that is the case.

Indicates whether this is a cross origin isolated context.

Indicated which gated APIs / features are available.

Information about the Resource on the page.

Resource URL.

Type of this resource.

Resource mimeType as determined by the browser.

last-modified timestamp as reported by server.

Resource content size.

True if the resource failed to load.

True if the resource was canceled during loading.

Information about the Frame hierarchy along with their cached resources.

Frame information for this tree item.

Child frames.

Information about frame resources.

Information about the Frame hierarchy.

Frame information for this tree item.

Child frames.

Transition type.

link

typed

address_bar

auto_bookmark

auto_subframe

manual_subframe

generated

auto_toplevel

form_submit

reload

keyword

keyword_generated

other

Navigation history entry.

Unique id of the navigation history entry.

URL of the navigation history entry.

URL that the user typed in the url bar.

Title of the navigation history entry.

Transition type.

Screencast frame metadata.

Top offset in DIP.

Page scale factor.

Device screen width in DIP.

Device screen height in DIP.

Position of horizontal scroll in CSS pixels.

Position of vertical scroll in CSS pixels.

Frame swap timestamp.

Javascript dialog type.

alert

confirm

prompt

beforeunload

Error while paring app manifest.

Error message.

If critical, this is a non-recoverable parse error.

Error line.

Error column.

Parsed app manifest properties.

Computed scope value

Layout viewport position and dimensions.

Horizontal offset relative to the document (CSS pixels).

Vertical offset relative to the document (CSS pixels).

Width (CSS pixels), excludes scrollbar if present.

Height (CSS pixels), excludes scrollbar if present.

Visual viewport position, dimensions, and scale.

Horizontal offset relative to the layout viewport (CSS pixels).

Vertical offset relative to the layout viewport (CSS pixels).

Horizontal offset relative to the document (CSS pixels).

Vertical offset relative to the document (CSS pixels).

Width (CSS pixels), excludes scrollbar if present.

Height (CSS pixels), excludes scrollbar if present.

Scale relative to the ideal viewport (size at width=device-width).

Page zoom factor (CSS to device independent pixels ratio).

Viewport for capturing screenshot.

X offset in device independent pixels (dip).

Y offset in device independent pixels (dip).

Rectangle width in device independent pixels (dip).

Rectangle height in device independent pixels (dip).

Page scale factor.

Default Constructor

Generic font families collection.

The standard font-family.

The fixed font-family.

The serif font-family.

The sansSerif font-family.

The cursive font-family.

The fantasy font-family.

The math font-family.

Font families collection for a script.

Name of the script which these font families are defined for.

Generic font families collection for the script.

Default font sizes.

Default standard font size.

Default fixed font size.

ClientNavigationReason

formSubmissionGet

formSubmissionPost

httpHeaderRefresh

scriptInitiated

metaTagRefresh

pageBlockInterstitial

reload

anchorClick

ClientNavigationDisposition

currentTab

newTab

newWindow

download

InstallabilityErrorArgument

Argument name (e.g. name:'minimum-icon-size-in-pixels').

Argument value (e.g. value:'64').

The installability error

The error id (e.g. 'manifest-missing-suitable-icon').

The list of error arguments (e.g. {name:'minimum-icon-size-in-pixels', value:'64'}).

The referring-policy used for the navigation.

noReferrer

noReferrerWhenDowngrade

origin

originWhenCrossOrigin

sameOrigin

strictOrigin

strictOriginWhenCrossOrigin

unsafeUrl

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

The URL of the script to produce a compilation cache entry for.

A hint to the backend whether eager compilation is recommended. (the actual compilation mode used is upon backend discretion).

Enum of possible auto-response for permission / prompt dialogs.

none

autoAccept

autoReject

autoOptOut

The type of a frameNavigated event.

Navigation

BackForwardCacheRestore

List of not restored reasons for back-forward cache.

NotPrimaryMainFrame

BackForwardCacheDisabled

RelatedActiveContentsExist

HTTPStatusNotOK

SchemeNotHTTPOrHTTPS

WasGrantedMediaAccess

DisableForRenderFrameHostCalled

DomainNotAllowed

HTTPMethodNotGET

SubframeIsNavigating

Timeout

CacheLimit

JavaScriptExecution

RendererProcessKilled

RendererProcessCrashed

SchedulerTrackedFeatureUsed

ConflictingBrowsingInstance

CacheFlushed

ServiceWorkerVersionActivation

SessionRestored

ServiceWorkerPostMessage

EnteredBackForwardCacheBeforeServiceWorkerHostAdded

RenderFrameHostReused_SameSite

RenderFrameHostReused_CrossSite

ServiceWorkerClaim

IgnoreEventAndEvict

HaveInnerContents

TimeoutPuttingInCache

BackForwardCacheDisabledByLowMemory

BackForwardCacheDisabledByCommandLine

NetworkRequestDatapipeDrainedAsBytesConsumer

NetworkRequestRedirected

NetworkRequestTimeout

NetworkExceedsBufferLimit

NavigationCancelledWhileRestoring

NotMostRecentNavigationEntry

BackForwardCacheDisabledForPrerender

UserAgentOverrideDiffers

ForegroundCacheLimit

BrowsingInstanceNotSwapped

BackForwardCacheDisabledForDelegate

UnloadHandlerExistsInMainFrame

UnloadHandlerExistsInSubFrame

ServiceWorkerUnregistration

CacheControlNoStore

CacheControlNoStoreCookieModified

CacheControlNoStoreHTTPOnlyCookieModified

NoResponseHead

Unknown

ActivationNavigationsDisallowedForBug1234857

ErrorDocument

FencedFramesEmbedder

CookieDisabled

HTTPAuthRequired

CookieFlushed

WebSocket

WebTransport

WebRTC

MainResourceHasCacheControlNoStore

MainResourceHasCacheControlNoCache

SubresourceHasCacheControlNoStore

SubresourceHasCacheControlNoCache

ContainsPlugins

DocumentLoaded

OutstandingNetworkRequestOthers

RequestedMIDIPermission

RequestedAudioCapturePermission

RequestedVideoCapturePermission

RequestedBackForwardCacheBlockedSensors

RequestedBackgroundWorkPermission

BroadcastChannel

WebXR

SharedWorker

WebLocks

WebHID

WebShare

RequestedStorageAccessGrant

WebNfc

OutstandingNetworkRequestFetch

OutstandingNetworkRequestXHR

AppBanner

Printing

WebDatabase

PictureInPicture

Portal

SpeechRecognizer

IdleManager

PaymentManager

SpeechSynthesis

KeyboardLock

WebOTPService

OutstandingNetworkRequestDirectSocket

InjectedJavascript

InjectedStyleSheet

KeepaliveRequest

IndexedDBEvent

Dummy

JsNetworkRequestReceivedCacheControlNoStoreResource

WebRTCSticky

WebTransportSticky

WebSocketSticky

SmartCard

LiveMediaStreamTrack

UnloadHandler

ParserAborted

ContentSecurityHandler

ContentWebAuthenticationAPI

ContentFileChooser

ContentSerial

ContentFileSystemAccess

ContentMediaDevicesDispatcherHost

ContentWebBluetooth

ContentWebUSB

ContentMediaSessionService

ContentScreenReader

EmbedderPopupBlockerTabHelper

EmbedderSafeBrowsingTriggeredPopupBlocker

EmbedderSafeBrowsingThreatDetails

EmbedderAppBannerManager

EmbedderDomDistillerViewerSource

EmbedderDomDistillerSelfDeletingRequestDelegate

EmbedderOomInterventionTabHelper

EmbedderOfflinePage

EmbedderChromePasswordManagerClientBindCredentialManager

EmbedderPermissionRequestManager

EmbedderModalDialog

EmbedderExtensions

EmbedderExtensionMessaging

EmbedderExtensionMessagingForOpenPort

EmbedderExtensionSentMessageToCachedFrame

Types of not restored reasons for back-forward cache.

SupportPending

PageSupportNeeded

Circumstantial

BackForwardCacheBlockingDetails

Url of the file where blockage happened. Optional because of tests.

Function name where blockage happened. Optional because of anonymous functions and tests.

Line number in the script (0-based).

Column number in the script (0-based).

BackForwardCacheNotRestoredExplanation

Type of the reason

Not restored reason

Context associated with the reason. The meaning of this context is dependent on the reason: - EmbedderExtensionSentMessageToCachedFrame: the extension ID.

Details

BackForwardCacheNotRestoredExplanationTree

URL of each frame

Not restored reasons of each frame

Array of children frame

domContentEventFired

Timestamp

Input mode.

selectSingle

selectMultiple

Emitted only when `page.interceptFileChooser` is enabled.

Id of the frame containing input node.

Input mode.

Input node id. Only present for file choosers opened via an `<input type="file" >` element.

Fired when frame has been attached to its parent.

Id of the frame that has been attached.

Parent frame identifier.

JavaScript stack trace of when frame was attached, only set if frame initiated from script.

Fired when frame no longer has a scheduled navigation.

Id of the frame that has cleared its scheduled navigation.

FrameDetachedReason

remove

swap

Fired when frame has been detached from its parent.

Id of the frame that has been detached.

Reason

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

Frame object.

Type

Fired when opening document to write to.

Frame object.

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

Id of the frame that is being navigated.

The reason for the navigation.

The destination URL for the requested navigation.

The disposition for the navigation.

Fired when frame schedules a potential navigation.

Id of the frame that has scheduled a navigation.

Delay (in seconds) until the navigation is scheduled to begin. The navigation is not guaranteed to start.

The reason for the navigation.

The destination URL for the scheduled navigation.

Fired when frame has started loading.

Id of the frame that has started loading.

Fired when frame has stopped loading.

Id of the frame that has stopped loading.

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

Id of the frame that caused download to begin.

Global unique identifier of the download.

URL of the resource being downloaded.

Suggested file name of the resource (the actual name of the file saved on disk may differ).

Download status.

inProgress

completed

canceled

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

Global unique identifier of the download.

Total expected bytes to download.

Total bytes received.

Download status.

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

Whether dialog was confirmed.

User input in case of prompt.

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

Frame url.

Message that will be displayed by the dialog.

Dialog type.

True if browser is capable showing or acting on the given dialog. When browser has no dialog handler for given target, calling alert while Page domain is engaged will stall the page execution. Execution can be resumed via calling Page.handleJavaScriptDialog.

Default dialog prompt.

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

Id of the frame.

Loader identifier. Empty string if the request is fetched from worker.

Name

Timestamp

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.

The loader id for the associated navigation.

The frame id of the associated frame.

Array of reasons why the page could not be cached. This must not be empty.

Tree structure of reasons why the page could not be cached for each frame.

loadEventFired

Timestamp

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

Id of the frame.

Frame's new url.

Compressed image data requested by the `startScreencast`.

Base64-encoded compressed image.

Screencast frame metadata.

Frame number.

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

True if the page is visible.

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

The URL for the new window.

Window name.

An array of enabled window features.

Whether or not it was triggered by user gesture.

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

Url

Base64-encoded data

AddScriptToEvaluateOnNewDocumentResponse

identifier

CaptureScreenshotResponse

data

CaptureSnapshotResponse

data

CreateIsolatedWorldResponse

executionContextId

GetAppManifestResponse

url

errors

data

parsed

GetInstallabilityErrorsResponse

installabilityErrors

GetAppIdResponse

appId

recommendedId

GetAdScriptIdResponse

adScriptId

GetFrameTreeResponse

frameTree

GetLayoutMetricsResponse

layoutViewport

visualViewport

contentSize

cssLayoutViewport

cssVisualViewport

cssContentSize

GetNavigationHistoryResponse

currentIndex

entries

GetResourceContentResponse

content

base64Encoded

GetResourceTreeResponse

frameTree

NavigateResponse

frameId

loaderId

errorText

PrintToPDFResponse

data

stream

SearchInResourceResponse

result

GetPermissionsPolicyStateResponse

states

GetOriginTrialsResponse

originTrials

Image compression format (defaults to png).

jpeg

png

webp

Format (defaults to mhtml).

mhtml

return as stream

ReturnAsBase64

ReturnAsStream

Image compression format.

jpeg

png

Target lifecycle state

frozen

active

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

Page

DevToolsClient

DomContentEventFired

Emitted only when `page.interceptFileChooser` is enabled.

Fired when frame has been attached to its parent.

Fired when frame has been detached from its parent.

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

Fired when opening document to write to.

FrameResized

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

Fired when frame has started loading.

Fired when frame has stopped loading.

Fired when interstitial page was hidden

Fired when interstitial page was shown

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

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

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

LoadEventFired

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

Compressed image data requested by the `startScreencast`.

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

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

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

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

source If specified, creates an isolated world with the given name and evaluates given script in it.This world name will be used as the ExecutionContextDescription::name when the correspondingevent is emitted. Specifies whether command line API should be available to the script, defaultsto false. If true, runs the script immediately on existing execution contexts or worlds.Default: false. returns System.Threading.Tasks.Task<AddScriptToEvaluateOnNewDocumentResponse>

Brings page to front (activates tab).

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Capture page screenshot.

Image compression format (defaults to png). Compression quality from range [0..100] (jpeg only). Capture the screenshot of a given region only. Capture the screenshot from the surface, rather than the view. Defaults to true. Capture the screenshot beyond the viewport. Defaults to false. Optimize image encoding for speed, not for resulting size (defaults to false) returns System.Threading.Tasks.Task<CaptureScreenshotResponse>

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

Format (defaults to mhtml). returns System.Threading.Tasks.Task<CaptureSnapshotResponse>

Creates an isolated world for the given frame.

Id of the frame in which the isolated world should be created. An optional name which is reported in the Execution Context. Whether or not universal access should be granted to the isolated world. This is a powerfuloption, use with caution. returns System.Threading.Tasks.Task<CreateIsolatedWorldResponse>

Disables page domain notifications.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Enables page domain notifications.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

GetAppManifest

returns System.Threading.Tasks.Task<GetAppManifestResponse>

GetInstallabilityErrors

returns System.Threading.Tasks.Task<GetInstallabilityErrorsResponse>

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

returns System.Threading.Tasks.Task<GetAppIdResponse>

GetAdScriptId

frameId returns System.Threading.Tasks.Task<GetAdScriptIdResponse>

Returns present frame tree structure.

returns System.Threading.Tasks.Task<GetFrameTreeResponse>

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

returns System.Threading.Tasks.Task<GetLayoutMetricsResponse>

Returns navigation history for the current page.

returns System.Threading.Tasks.Task<GetNavigationHistoryResponse>

Resets navigation history for the current page.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Returns content of the given resource.

Frame id to get resource for. URL of the resource to get content for. returns System.Threading.Tasks.Task<GetResourceContentResponse>

Returns present frame / resource tree structure.

returns System.Threading.Tasks.Task<GetResourceTreeResponse>

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

Whether to accept or dismiss the dialog. The text to enter into the dialog prompt before accepting. Used only if this is a promptdialog. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Navigates current page to the given URL.

URL to navigate the page to. Referrer URL. Intended transition type. Frame id to navigate, if not specified navigates the top frame. Referrer-policy used for the navigation. returns System.Threading.Tasks.Task<NavigateResponse>

Navigates current page to the given history entry.

Unique id of the entry to navigate to. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Print page as PDF.

Paper orientation. Defaults to false. Display header and footer. Defaults to false. Print background graphics. Defaults to false. Scale of the webpage rendering. Defaults to 1. Paper width in inches. Defaults to 8.5 inches. Paper height in inches. Defaults to 11 inches. Top margin in inches. Defaults to 1cm (~0.4 inches). Bottom margin in inches. Defaults to 1cm (~0.4 inches). Left margin in inches. Defaults to 1cm (~0.4 inches). Right margin in inches. Defaults to 1cm (~0.4 inches). Paper ranges to print, one based, e.g., '1-5, 8, 11-13'. Pages areprinted in the document order, not in the order specified, and nomore than once.Defaults to empty string, which implies the entire document is printed.The page numbers are quietly capped to actual page count of thedocument, and ranges beyond the end of the document are ignored.If this results in no pages to print, an error is reported.It is an error to specify a range with start greater than end. HTML template for the print header. Should be valid HTML markup with followingclasses used to inject printing values into them:- `date`: formatted print date- `title`: document title- `url`: document location- `pageNumber`: current page number- `totalPages`: total pages in the documentFor example, `<span class=title> </span>` would generate span containing the title. HTML template for the print footer. Should use the same format as the `headerTemplate`. Whether or not to prefer page size as defined by css. Defaults to false,in which case the content will be scaled to fit the paper size. return as stream Whether or not to generate tagged (accessible) PDF. Defaults to embedder choice. Whether or not to embed the document outline into the PDF. returns System.Threading.Tasks.Task<PrintToPDFResponse>

Reloads given page optionally ignoring the cache.

If true, browser cache is ignored (as if the user pressed Shift+refresh). If set, the script will be injected into all frames of the inspected page after reload.Argument will be ignored if reloading dataURL origin. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Removes given script from the list.

identifier returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

Frame number. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Searches for given string in resource content.

Frame id for resource to search in. URL of the resource to search in. String to search for. If true, search is case sensitive. If true, treats string parameter as regex. returns System.Threading.Tasks.Task<SearchInResourceResponse>

Enable Chrome's experimental ad filter on all sites.

Whether to block ads. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Enable page Content Security Policy by-passing.

Whether to bypass page CSP. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Get Permissions Policy state on given frame.

frameId returns System.Threading.Tasks.Task<GetPermissionsPolicyStateResponse>

Get Origin Trials on given frame.

frameId returns System.Threading.Tasks.Task<GetOriginTrialsResponse>

Set generic font families.

Specifies font families to set. If a font family is not specified, it won't be changed. Specifies font families to set for individual scripts. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Set default font sizes.

Specifies font sizes to set. If a font size is not specified, it won't be changed. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Sets given markup as the document's HTML.

Frame id to set HTML for. HTML content to set. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Controls whether page will emit lifecycle events.

If true, starts emitting lifecycle events. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Starts sending each frame using the `screencastFrame` event.

Image compression format. Compression quality from range [0..100]. Maximum screenshot width. Maximum screenshot height. Send every n-th frame. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Force the page stop all navigations and pending resource fetches.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Crashes renderer on the IO thread, generates minidumps.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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/

Target lifecycle state returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Stops sending each frame in the `screencastFrame`.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

scripts returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

url Base64-encoded data returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Clears seeded compilation cache.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

mode returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

mode returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Generates a report for testing.

Message to be displayed in the report. Specifies the endpoint group to deliver the report to. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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.

enabled returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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.

isAllowed returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Run-time execution metric.

Metric name.

Metric value.

Current values of the metrics.

Timestamp title.

GetMetricsResponse

metrics

Time domain to use for collecting and reporting duration metrics.

timeTicks

threadTicks

Performance

DevToolsClient

Current values of the metrics.

Disable collecting and reporting metrics.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Enable collecting and reporting metrics.

Time domain to use for collecting and reporting duration metrics. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Retrieve current values of run-time metrics.

returns System.Threading.Tasks.Task<GetMetricsResponse>

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

RenderTime

LoadTime

The number of pixels being painted.

The id attribute of the element, if available.

The URL of the image (may be trimmed).

NodeId

LayoutShiftAttribution

PreviousRect

CurrentRect

NodeId

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

Score increment produced by this event.

HadRecentInput

LastInputTime

Sources

TimelineEvent

Identifies the frame that this event is related to. Empty for non-frame targets.

The event type, as specified in https://w3c.github.io/performance-timeline/#dom-performanceentry-entrytype This determines which of the optional "details" fields is present.

Name may be empty depending on the type.

Time in seconds since Epoch, monotonically increasing within document lifetime.

Event duration, if applicable.

LcpDetails

LayoutShiftDetails

Sent when a performance timeline event is added. See reportPerformanceTimeline method.

Event

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

PerformanceTimeline

DevToolsClient

Sent when a performance timeline event is added. See reportPerformanceTimeline method.

Previously buffered events would be reported before method returns. See also: timelineEventAdded

The types of event to report, as specified inhttps://w3c.github.io/performance-timeline/#dom-performanceentry-entrytypeThe specified filter overrides any previous filters, passing emptyfilter disables recording.Note that not all types exposed to the web platform are currently supported. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

blockable

optionally-blockable

none

The security level of a page or resource.

unknown

neutral

insecure

secure

info

insecure-broken

Details about the security state of the page certificate.

Protocol name (e.g. "TLS 1.2" or "QUIC").

Key Exchange used by the connection, or the empty string if not applicable.

(EC)DH group used by the connection, if applicable.

Cipher name.

TLS MAC. Note that AEAD ciphers do not have separate MACs.

Page certificate.

Certificate subject name.

Name of the issuing CA.

Certificate valid from date.

Certificate valid to (expiration) date

The highest priority network error code, if the certificate has an error.

True if the certificate uses a weak signature algorithm.

True if the certificate has a SHA1 signature in the chain.

True if modern SSL

True if the connection is using an obsolete SSL protocol.

True if the connection is using an obsolete SSL key exchange.

True if the connection is using an obsolete SSL cipher.

True if the connection is using an obsolete SSL signature.

SafetyTipStatus

badReputation

lookalike

SafetyTipInfo

Describes whether the page triggers any safety tips or reputation warnings. Default is unknown.

The URL the safety tip suggested ("Did you mean?"). Only filled in for lookalike matches.

Security state information about the page.

The security level of the page.

Security state details about the page certificate.

The type of Safety Tip triggered on the page. Note that this field will be set even if the Safety Tip UI was not actually shown.

Array of security state issues ids.

An explanation of an factor contributing to the security state.

Security state representing the severity of the factor being explained.

Title describing the type of factor.

Short phrase describing the type of factor.

Full text explanation of the factor.

The type of mixed content described by the explanation.

Page certificate.

Recommendations to fix any issues.

Information about insecure content on the page.

Always false.

Always set to unknown.

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

continue

cancel

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.

The ID of the event.

The type of the error.

The url that was requested.

The security state of the page changed.

Security state information about the page.

The security state of the page changed. No longer being sent.

Security state.

True if the page was loaded over cryptographic transport such as HTTPS.

Previously a list of explanations for the security state. Now always empty.

Information about insecure content on the page.

Overrides user-visible description of the state. Always omitted.

Security

DevToolsClient

The security state of the page changed.

Disables tracking security state changes.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Enables tracking security state changes.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Enable/disable whether all certificate errors should be ignored.

If true, all certificate errors will be ignored. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

ServiceWorker registration.

RegistrationId

ScopeURL

IsDeleted

ServiceWorkerVersionRunningStatus

stopped

starting

running

stopping

ServiceWorkerVersionStatus

new

installing

installed

activating

activated

redundant

ServiceWorker version.

VersionId

RegistrationId

ScriptURL

RunningStatus

Status

The Last-Modified header value of the main script.

The time at which the response headers of the main script were received from the server. For cached script it is the last time the cache entry was validated.

ControlledClients

TargetId

RouterRules

ServiceWorker error message.

ErrorMessage

RegistrationId

VersionId

SourceURL

LineNumber

ColumnNumber

workerErrorReported

ErrorMessage

workerRegistrationUpdated

Registrations

workerVersionUpdated

Versions

ServiceWorker

DevToolsClient

WorkerErrorReported

WorkerRegistrationUpdated

WorkerVersionUpdated

DeliverPushMessage

origin registrationId data returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Disable

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

DispatchSyncEvent

origin registrationId tag lastChance returns System.Threading.Tasks.Task<DevToolsMethodResponse>

DispatchPeriodicSyncEvent

origin registrationId tag returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Enable

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

InspectWorker

versionId returns System.Threading.Tasks.Task<DevToolsMethodResponse>

SetForceUpdateOnPageLoad

forceUpdateOnPageLoad returns System.Threading.Tasks.Task<DevToolsMethodResponse>

SkipWaiting

scopeURL returns System.Threading.Tasks.Task<DevToolsMethodResponse>

StartWorker

scopeURL returns System.Threading.Tasks.Task<DevToolsMethodResponse>

StopAllWorkers

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

StopWorker

versionId returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Unregister

scopeURL returns System.Threading.Tasks.Task<DevToolsMethodResponse>

UpdateRegistration

scopeURL returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Enum of possible storage types.

appcache

file_systems

indexeddb

local_storage

shader_cache

websql

service_workers

cache_storage

interest_groups

shared_storage

storage_buckets

all

other

Usage for a storage type.

Name of storage type.

Storage usage (bytes).

Pair of issuer origin and number of available (signed, but not used) Trust Tokens from that issuer.

IssuerOrigin

Count

Enum of interest group access types.

join

leave

update

loaded

bid

win

additionalBid

additionalBidWin

topLevelBid

topLevelAdditionalBid

clear

Enum of auction events.

started

configResolved

Enum of network fetches auctions can do.

bidderJs

bidderWasm

sellerJs

bidderTrustedSignals

sellerTrustedSignals

Ad advertising element inside an interest group.

RenderURL

Metadata

The full details of an interest group.

OwnerOrigin

Name

ExpirationTime

JoiningOrigin

BiddingLogicURL

BiddingWasmHelperURL

UpdateURL

TrustedBiddingSignalsURL

TrustedBiddingSignalsKeys

UserBiddingSignals

Ads

AdComponents

Enum of shared storage access types.

documentAddModule

documentSelectURL

documentRun

documentSet

documentAppend

documentDelete

documentClear

workletSet

workletAppend

workletDelete

workletClear

workletGet

workletKeys

workletEntries

workletLength

workletRemainingBudget

Struct for a single key-value pair in an origin's shared storage.

Key

Value

Details for an origin's shared storage.

Time when the origin's shared storage was last created.

Number of key-value pairs stored in origin's shared storage.

Current amount of bits of entropy remaining in the navigation budget.

Total number of bytes stored as key-value pairs in origin's shared storage.

Pair of reporting metadata details for a candidate URL for `selectURL()`.

EventType

ReportingUrl

Bundles a candidate URL with its reporting metadata.

Spec of candidate URL.

Any associated reporting metadata.

Bundles the parameters for shared storage access events whose presence/absence can vary according to SharedStorageAccessType.

Spec of the module script URL. Present only for SharedStorageAccessType.documentAddModule.

Name of the registered operation to be run. Present only for SharedStorageAccessType.documentRun and SharedStorageAccessType.documentSelectURL.

The operation's serialized data in bytes (converted to a string). Present only for SharedStorageAccessType.documentRun and SharedStorageAccessType.documentSelectURL.

Array of candidate URLs' specs, along with any associated metadata. Present only for SharedStorageAccessType.documentSelectURL.

Key for a specific entry in an origin's shared storage. Present only for SharedStorageAccessType.documentSet, SharedStorageAccessType.documentAppend, SharedStorageAccessType.documentDelete, SharedStorageAccessType.workletSet, SharedStorageAccessType.workletAppend, SharedStorageAccessType.workletDelete, and SharedStorageAccessType.workletGet.

Value for a specific entry in an origin's shared storage. Present only for SharedStorageAccessType.documentSet, SharedStorageAccessType.documentAppend, SharedStorageAccessType.workletSet, and SharedStorageAccessType.workletAppend.

Whether or not to set an entry for a key if that key is already present. Present only for SharedStorageAccessType.documentSet and SharedStorageAccessType.workletSet.

StorageBucketsDurability

relaxed

strict

StorageBucket

StorageKey

If not specified, it is the default bucket of the storageKey.

StorageBucketInfo

Bucket

Expiration

Storage quota (bytes).

Persistent

Durability

AttributionReportingSourceType

navigation

event

AttributionReportingFilterDataEntry

Key

Values

AttributionReportingFilterConfig

FilterValues

duration in seconds

AttributionReportingFilterPair

Filters

NotFilters

AttributionReportingAggregationKeysEntry

Key

Value

AttributionReportingEventReportWindows

duration in seconds

AttributionReportingTriggerSpec

number instead of integer because not all uint32 can be represented by int

EventReportWindows

AttributionReportingTriggerDataMatching

exact

modulus

AttributionReportingSourceRegistration

Time

duration in seconds

TriggerSpecs

duration in seconds

Type

SourceOrigin

ReportingOrigin

DestinationSites

EventId

Priority

FilterData

AggregationKeys

DebugKey

TriggerDataMatching

AttributionReportingSourceRegistrationResult

success

internalError

insufficientSourceCapacity

insufficientUniqueDestinationCapacity

excessiveReportingOrigins

prohibitedByBrowserPolicy

successNoised

destinationReportingLimitReached

destinationGlobalLimitReached

destinationBothLimitsReached

reportingOriginsPerSiteLimitReached

exceedsMaxChannelCapacity

AttributionReportingSourceRegistrationTimeConfig

include

exclude

AttributionReportingAggregatableValueDictEntry

Key

number instead of integer because not all uint32 can be represented by int

AttributionReportingAggregatableValueEntry

Values

Filters

AttributionReportingEventTriggerData

Data

Priority

DedupKey

Filters

AttributionReportingAggregatableTriggerData

KeyPiece

SourceKeys

Filters

AttributionReportingAggregatableDedupKey

DedupKey

Filters

AttributionReportingTriggerRegistration

Filters

DebugKey

AggregatableDedupKeys

EventTriggerData

AggregatableTriggerData

AggregatableValues

DebugReporting

AggregationCoordinatorOrigin

SourceRegistrationTimeConfig

TriggerContextId

AttributionReportingEventLevelResult

success

successDroppedLowerPriority

internalError

noCapacityForAttributionDestination

noMatchingSources

deduplicated

excessiveAttributions

priorityTooLow

neverAttributedSource

excessiveReportingOrigins

noMatchingSourceFilterData

prohibitedByBrowserPolicy

noMatchingConfigurations

excessiveReports

falselyAttributedSource

reportWindowPassed

notRegistered

reportWindowNotStarted

noMatchingTriggerData

AttributionReportingAggregatableResult

success

internalError

noCapacityForAttributionDestination

noMatchingSources

excessiveAttributions

excessiveReportingOrigins

noHistograms

insufficientBudget

noMatchingSourceFilterData

notRegistered

prohibitedByBrowserPolicy

deduplicated

reportWindowPassed

excessiveReports

A cache's contents have been modified.

Origin to update.

Storage key to update.

Storage bucket to update.

Name of cache in origin.

A cache has been added/deleted.

Origin to update.

Storage key to update.

Storage bucket to update.

The origin's IndexedDB object store has been modified.

Origin to update.

Storage key to update.

Storage bucket to update.

Database to update.

ObjectStore to update.

The origin's IndexedDB database list has been modified.

Origin to update.

Storage key to update.

Storage bucket to update.

One of the interest groups was accessed. Note that these events are global to all targets sharing an interest group store.

AccessTime

Type

OwnerOrigin

Name

For topLevelBid/topLevelAdditionalBid, and when appropriate, win and additionalBidWin

For bid or somethingBid event, if done locally and not on a server.

BidCurrency

For non-global events --- links to interestGroupAuctionEvent

An auction involving interest groups is taking place. These events are target-specific.

EventTime

Type

UniqueAuctionId

Set for child auctions.

Set for started and configResolved

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

Type

RequestId

This is the set of the auctions using the worklet that issued this request. In the case of trusted signals, it's possible that only some of them actually care about the keys being queried.

Shared storage was accessed by the associated page. The following parameters are included in all events.

Time of the access.

Enum value indicating the Shared Storage API method invoked.

DevTools Frame Token for the primary frame tree's root.

Serialized origin for the context that invoked the Shared Storage API.

The sub-parameters wrapped by `params` are all optional and their presence/absence depends on `type`.

storageBucketCreatedOrUpdated

BucketInfo

storageBucketDeleted

BucketId

attributionReportingSourceRegistered

Registration

Result

attributionReportingTriggerRegistered

Registration

EventLevel

Aggregatable

GetStorageKeyForFrameResponse

storageKey

GetCookiesResponse

GetUsageAndQuotaResponse

usage

quota

overrideActive

usageBreakdown

GetTrustTokensResponse

tokens

ClearTrustTokensResponse

didDeleteTokens

GetInterestGroupDetailsResponse

details

GetSharedStorageMetadataResponse

metadata

GetSharedStorageEntriesResponse

entries

RunBounceTrackingMitigationsResponse

deletedSites

Storage

DevToolsClient

A cache's contents have been modified.

A cache has been added/deleted.

The origin's IndexedDB object store has been modified.

The origin's IndexedDB database list has been modified.

One of the interest groups was accessed. Note that these events are global to all targets sharing an interest group store.

An auction involving interest groups is taking place. These events are target-specific.

Shared storage was accessed by the associated page. The following parameters are included in all events.

StorageBucketCreatedOrUpdated

StorageBucketDeleted

AttributionReportingSourceRegistered

AttributionReportingTriggerRegistered

Returns a storage key given a frame id.

frameId returns System.Threading.Tasks.Task<GetStorageKeyForFrameResponse>

Clears storage for origin.

Security origin. Comma separated list of StorageType to clear. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Clears storage for storage key.

Storage key. Comma separated list of StorageType to clear. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Returns all browser cookies.

Browser context to use when called on the browser endpoint. returns System.Threading.Tasks.Task<GetCookiesResponse>

Sets given cookies.

Cookies to be set. Browser context to use when called on the browser endpoint. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Clears cookies.

Browser context to use when called on the browser endpoint. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Returns usage and quota in bytes.

Security origin. returns System.Threading.Tasks.Task<GetUsageAndQuotaResponse>

Override quota for the specified origin

Security origin. The quota size (in bytes) to override the original quota with.If this is called multiple times, the overridden quota will be equal tothe quotaSize provided in the final call. If this is called withoutspecifying a quotaSize, the quota will be reset to the default value forthe specified origin. If this is called multiple times with differentorigins, the override will be maintained for each origin until it isdisabled (called without a quotaSize). returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

Security origin. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

Storage key. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

Security origin. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Registers storage key to be notified when an update occurs to its IndexedDB.

Storage key. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Unregisters origin from receiving notifications for cache storage.

Security origin. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Unregisters storage key from receiving notifications for cache storage.

Storage key. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Unregisters origin from receiving notifications for IndexedDB.

Security origin. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Unregisters storage key from receiving notifications for IndexedDB.

Storage key. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

returns System.Threading.Tasks.Task<GetTrustTokensResponse>

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

issuerOrigin returns System.Threading.Tasks.Task<ClearTrustTokensResponse>

Gets details for a named interest group.

ownerOrigin name returns System.Threading.Tasks.Task<GetInterestGroupDetailsResponse>

Enables/Disables issuing of interestGroupAccessed events.

enable returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Enables/Disables issuing of interestGroupAuctionEventOccurred and interestGroupAuctionNetworkRequestCreated.

enable returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Gets metadata for an origin's shared storage.

ownerOrigin returns System.Threading.Tasks.Task<GetSharedStorageMetadataResponse>

Gets the entries in an given origin's shared storage.

ownerOrigin returns System.Threading.Tasks.Task<GetSharedStorageEntriesResponse>

Sets entry with `key` and `value` for a given origin's shared storage.

ownerOrigin key value If `ignoreIfPresent` is included and true, then only sets the entry if`key` doesn't already exist. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Deletes entry for `key` (if it exists) for a given origin's shared storage.

ownerOrigin key returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Clears all entries for a given origin's shared storage.

ownerOrigin returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Resets the budget for `ownerOrigin` by clearing all budget withdrawals.

ownerOrigin returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Enables/disables issuing of sharedStorageAccessed events.

enable returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Set tracking for a storage key's buckets.

storageKey enable returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Deletes the Storage Bucket with the given storage key and bucket name.

bucket returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Deletes state for sites identified as potential bounce trackers, immediately.

returns System.Threading.Tasks.Task<RunBounceTrackingMitigationsResponse>

https://wicg.github.io/attribution-reporting-api/

If enabled, noise is suppressed and reports are sent immediately. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Enables/disables issuing of Attribution Reporting events.

enable returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Describes a single graphics processor (GPU).

PCI ID of the GPU vendor, if available; 0 otherwise.

PCI ID of the GPU device, if available; 0 otherwise.

Sub sys ID of the GPU, only available on Windows.

Revision of the GPU, only available on Windows.

String description of the GPU vendor, if the PCI ID is not available.

String description of the GPU device, if the PCI ID is not available.

String description of the GPU driver vendor.

String description of the GPU driver version.

Describes the width and height dimensions of an entity.

Width in pixels.

Height in pixels.

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

Video codec profile that is supported, e.g. VP9 Profile 2.

Maximum video dimensions in pixels supported for this |profile|.

Minimum video dimensions in pixels supported for this |profile|.

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

Video codec profile that is supported, e.g H264 Main.

Maximum video dimensions in pixels supported for this |profile|.

Maximum encoding framerate in frames per second supported for this |profile|, as fraction's numerator and denominator, e.g. 24/1 fps, 24000/1001 fps, etc.

MaxFramerateDenominator

YUV subsampling type of the pixels of a given image.

yuv420

yuv422

yuv444

Image format of a given image.

jpeg

webp

unknown

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

Image coded, e.g. Jpeg.

Maximum supported dimensions of the image in pixels.

Minimum supported dimensions of the image in pixels.

Optional array of supported subsampling formats, e.g. 4:2:0, if known.

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

The graphics devices on the system. Element 0 is the primary GPU.

An optional dictionary of additional GPU related attributes.

An optional dictionary of graphics features and their status.

An optional array of GPU driver bug workarounds.

Supported accelerated video decoding capabilities.

Supported accelerated video encoding capabilities.

Supported accelerated image decoding capabilities.

Represents process info.

Specifies process type.

Specifies process id.

Specifies cumulative CPU usage in seconds across all threads of the process since the process start.

GetInfoResponse

gpu

modelName

modelVersion

commandLine

GetFeatureStateResponse

featureEnabled

GetProcessInfoResponse

processInfo

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

SystemInfo

DevToolsClient

Returns information about the system.

returns System.Threading.Tasks.Task<GetInfoResponse>

Returns information about the feature state.

featureState returns System.Threading.Tasks.Task<GetFeatureStateResponse>

Returns information about all running processes.

returns System.Threading.Tasks.Task<GetProcessInfoResponse>

TargetInfo

TargetId

Type

List of types: https://source.chromium.org/chromium/chromium/src/+/main:content/browser/devtools/devtools_agent_host_impl.cc?ss=chromium&q=f:devtools%20-f:out%20%22::kTypeTab%5B%5D%22

Url

Whether the target has an attached client.

Opener target Id

Whether the target has access to the originating window.

Frame id of originating window (is only set if target has an opener).

BrowserContextId

Provides additional details for specific target types. For example, for the type of "page", this may be set to "portal" or "prerender".

A filter used by target query/discovery/auto-attach operations.

If set, causes exclusion of matching targets from the list.

If not present, matches any type.

RemoteLocation

Host

Port

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

Identifier assigned to the session used to send/receive messages.

TargetInfo

WaitingForDebugger

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.

Detached session identifier.

Deprecated.

Notifies about a new protocol message received from the session (as reported in `attachedToTarget` event).

Identifier of a session which sends a message.

Message

Deprecated.

Issued when a possible inspection target is created.

TargetInfo

Issued when a target is destroyed.

TargetId

Issued when a target has crashed.

TargetId

Termination status type.

Termination error code.

Issued when some information about a target has changed. This only happens between `targetCreated` and `targetDestroyed`.

TargetInfo

AttachToTargetResponse

sessionId

AttachToBrowserTargetResponse

sessionId

CloseTargetResponse

success

CreateBrowserContextResponse

browserContextId

GetBrowserContextsResponse

browserContextIds

CreateTargetResponse

targetId

GetTargetInfoResponse

targetInfo

GetTargetsResponse

targetInfos

Supports additional targets discovery and allows to attach to them.

Target

DevToolsClient

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

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.

Notifies about a new protocol message received from the session (as reported in `attachedToTarget` event).

Issued when a possible inspection target is created.

Issued when a target is destroyed.

Issued when a target has crashed.

Issued when some information about a target has changed. This only happens between `targetCreated` and `targetDestroyed`.

Activates (focuses) the target.

targetId returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Attaches to the target with given id.

targetId Enables "flat" access to the session via specifying sessionId attribute in the commands.We plan to make this the default, deprecate non-flattened mode,and eventually retire it. See crbug.com/991325. returns System.Threading.Tasks.Task<AttachToTargetResponse>

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

returns System.Threading.Tasks.Task<AttachToBrowserTargetResponse>

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

targetId returns System.Threading.Tasks.Task<CloseTargetResponse>

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.

targetId Binding name, 'cdp' if not specified. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

If specified, disposes this context when debugging session disconnects. Proxy server, similar to the one passed to --proxy-server Proxy bypass list, similar to the one passed to --proxy-bypass-list An optional list of origins to grant unlimited cross-origin access to.Parts of the URL other than those constituting origin are ignored. returns System.Threading.Tasks.Task<CreateBrowserContextResponse>

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

returns System.Threading.Tasks.Task<GetBrowserContextsResponse>

Creates a new page.

The initial URL the page will be navigated to. An empty string indicates about:blank. Frame width in DIP (headless chrome only). Frame height in DIP (headless chrome only). The browser context to create the page in. Whether BeginFrames for this target will be controlled via DevTools (headless chrome only,not supported on MacOS yet, false by default). Whether to create a new Window or Tab (chrome-only, false by default). Whether to create the target in background or foreground (chrome-only,false by default). Whether to create the target of type "tab". returns System.Threading.Tasks.Task<CreateTargetResponse>

Detaches session with given id.

Session to detach. Deprecated. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

browserContextId returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Returns information about a target.

targetId returns System.Threading.Tasks.Task<GetTargetInfoResponse>

Retrieves a list of available targets.

Only targets matching filter will be reported. If filter is not specifiedand target discovery is currently enabled, a filter used for target discoveryis used for consistency. returns System.Threading.Tasks.Task<GetTargetsResponse>

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

Whether to auto-attach to related targets. Whether to pause new targets when attaching to them. Use `Runtime.runIfWaitingForDebugger`to run paused targets. Enables "flat" access to the session via specifying sessionId attribute in the commands.We plan to make this the default, deprecate non-flattened mode,and eventually retire it. See crbug.com/991325. Only targets matching filter will be attached. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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.

targetId Whether to pause new targets when attaching to them. Use `Runtime.runIfWaitingForDebugger`to run paused targets. Only targets matching filter will be attached. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

Whether to discover available targets. Only targets matching filter will be attached. If `discover` is false,`filter` must be omitted or empty. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

List of remote locations. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

Type

Exclude

Informs that port was successfully bound and got a specified connection id.

Port number that was successfully bound.

Connection id to be used.

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

Tethering

DevToolsClient

Informs that port was successfully bound and got a specified connection id.

Request browser port binding.

Port number to bind. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Request browser port unbinding.

Port number to unbind. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Controls how the trace buffer stores data.

recordUntilFull

recordContinuously

recordAsMuchAsPossible

echoToConsole

TraceConfig

Controls how the trace buffer stores data.

Size of the trace buffer in kilobytes. If not specified or zero is passed, a default value of 200 MB would be used.

Turns on JavaScript stack sampling.

Turns on system tracing.

Turns on argument filter.

Included category filters.

Excluded category filters.

Configuration to synthesize the delays in tracing.

Configuration for memory dump triggers. Used only when "memory-infra" category is enabled.

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.

json

proto

Compression type to use for traces returned via streams.

none

gzip

Details exposed when memory request explicitly declared. Keep consistent with memory_dump_request_args.h and memory_instrumentation.mojom

background

light

detailed

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

auto

chrome

system

bufferUsage

A number in range [0..1] that indicates the used size of event buffer as a fraction of its total size.

An approximate number of events in the trace log.

A number in range [0..1] that indicates the used size of event buffer as a fraction of its total size.

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.

Value

Signals that tracing is stopped and there is no trace buffers pending flush, all data were delivered via dataCollected events.

Indicates whether some trace data is known to have been lost, e.g. because the trace ring buffer wrapped around.

A handle of the stream that holds resulting trace data.

Trace data format of returned stream.

Compression format of returned stream.

GetCategoriesResponse

categories

RequestMemoryDumpResponse

dumpGuid

success

Whether to report trace events as series of dataCollected events or to save trace to a stream (defaults to `ReportEvents`).

ReportEvents

ReturnAsStream

Tracing

DevToolsClient

BufferUsage

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.

Signals that tracing is stopped and there is no trace buffers pending flush, all data were delivered via dataCollected events.

Stop trace events collection.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Gets supported tracing categories.

returns System.Threading.Tasks.Task<GetCategoriesResponse>

Record a clock sync marker in the trace.

The ID of this clock sync marker returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Request a global memory dump.

Enables more deterministic results by forcing garbage collection Specifies level of details in memory dump. Defaults to "detailed". returns System.Threading.Tasks.Task<RequestMemoryDumpResponse>

Start trace events collection.

Category/tag filter Tracing options If set, the agent will issue bufferUsage events at this interval, specified in milliseconds Whether to report trace events as series of dataCollected events or to save trace to astream (defaults to `ReportEvents`). Trace data format to use. This only applies when using `ReturnAsStream`transfer mode (defaults to `json`). Compression format to use. This only applies when using `ReturnAsStream`transfer mode (defaults to `none`) traceConfig Base64-encoded serialized perfetto.protos.TraceConfig protobuf messageWhen specified, the parameters `categories`, `options`, `traceConfig`are ignored. Backend type (defaults to `auto`) returns System.Threading.Tasks.Task<DevToolsMethodResponse>

MemoryDumpConfig

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

Request

Response

RequestPattern

Wildcards (`'*'` -> zero or more, `'?'` -> exactly one) are allowed. Escape character is backslash. Omitting is equivalent to `"*"`.

If set, only requests for matching resource types will be intercepted.

Stage at which to begin intercepting requests. Default is Request.

Response HTTP header entry

Name

Value

Source of the authentication challenge.

Server

Proxy

Authorization challenge for HTTP status code 401 or 407.

Source of the authentication challenge.

Origin of the challenger.

The authentication scheme used, such as basic or digest

The realm of the challenge. May be empty.

Default

CancelAuth

ProvideCredentials

Response to an AuthChallenge.

The username to provide, possibly empty. Should only be set if response is ProvideCredentials.

The password to provide, possibly empty. Should only be set if response is ProvideCredentials.

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.

Each request the page makes will have a unique id.

The details of the request.

The id of the frame that initiated the request.

How the requested resource will be used.

Response error if intercepted at response stage.

Response code if intercepted at response stage.

Response status text if intercepted at response stage.

Response headers if intercepted at the response stage.

If the intercepted request had a corresponding Network.requestWillBeSent event fired for it, then this networkId will be the same as the requestId present in the requestWillBeSent event.

If the request is due to a redirect response from the server, the id of the request that has caused the redirect.

Issued when the domain is enabled with handleAuthRequests set to true. The request is paused until client responds with continueWithAuth.

Each request the page makes will have a unique id.

The details of the request.

The id of the frame that initiated the request.

How the requested resource will be used.

Details of the Authorization Challenge encountered. If this is set, client should respond with continueRequest that contains AuthChallengeResponse.

GetResponseBodyResponse

body

base64Encoded

TakeResponseBodyAsStreamResponse

stream

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

Fetch

DevToolsClient

Issued when the domain is enabled with handleAuthRequests set to true. The request is paused until client responds with continueWithAuth.

Disables the fetch domain.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Enables issuing of requestPaused events. A request will be paused until client calls one of failRequest, fulfillRequest or continueRequest/continueWithAuth.

If specified, only requests matching any of these patterns will producefetchRequested event and will be paused until clients response. If not set,all requests will be affected. If true, authRequired events will be issued and requests will be pausedexpecting a call to continueWithAuth. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Causes the request to fail with specified reason.

An id the client received in requestPaused event. Causes the request to fail with the given reason. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Provides response to the request.

An id the client received in requestPaused event. An HTTP response code. Response headers. Alternative way of specifying response headers as a \0-separatedseries of name: value pairs. Prefer the above method unless youneed to represent some non-UTF8 values that can't be transmittedover the protocol as text. A response body. If absent, original response body will be used ifthe request is intercepted at the response stage and empty bodywill be used if the request is intercepted at the request stage. A textual representation of responseCode.If absent, a standard phrase matching responseCode is used. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Continues the request, optionally modifying some of its parameters.

An id the client received in requestPaused event. If set, the request url will be modified in a way that's not observable by page. If set, the request method is overridden. If set, overrides the post data in the request. If set, overrides the request headers. Note that the overrides do notextend to subsequent redirect hops, if a redirect happens. Another overridemay be applied to a different request produced by a redirect. If set, overrides response interception behavior for this request. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Continues a request supplying authChallengeResponse following authRequired event.

An id the client received in authRequired event. Response to with an authChallenge. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Continues loading of the paused response, optionally modifying the response headers. If either responseCode or headers are modified, all of them must be present.

An id the client received in requestPaused event. An HTTP response code. If absent, original response code will be used. A textual representation of responseCode.If absent, a standard phrase matching responseCode is used. Response headers. If absent, original response headers will be used. Alternative way of specifying response headers as a \0-separatedseries of name: value pairs. Prefer the above method unless youneed to represent some non-UTF8 values that can't be transmittedover the protocol as text. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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.

Identifier for the intercepted request to get body for. returns System.Threading.Tasks.Task<GetResponseBodyResponse>

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.

requestId returns System.Threading.Tasks.Task<TakeResponseBodyAsStreamResponse>

Enum of BaseAudioContext types

realtime

offline

Enum of AudioContextState from the spec

suspended

running

closed

Enum of AudioNode::ChannelCountMode from the spec

clamped-max

explicit

max

Enum of AudioNode::ChannelInterpretation from the spec

discrete

speakers

Enum of AudioParam::AutomationRate from the spec

a-rate

k-rate

Fields in AudioContext that change in real-time.

The current context time in second in BaseAudioContext.

The time spent on rendering graph divided by render quantum duration, and multiplied by 100. 100 means the audio renderer reached the full capacity and glitch may occur.

A running mean of callback interval.

A running variance of callback interval.

Protocol object for BaseAudioContext

ContextId

ContextType

ContextState

RealtimeData

Platform-dependent callback buffer size.

Number of output channels supported by audio hardware in use.

Context sample rate.

Protocol object for AudioListener

ListenerId

ContextId

Protocol object for AudioNode

NodeId

ContextId

NodeType

NumberOfInputs

NumberOfOutputs

ChannelCount

ChannelCountMode

ChannelInterpretation

Protocol object for AudioParam

ParamId

NodeId

ContextId

ParamType

Rate

DefaultValue

MinValue

MaxValue

Notifies that a new BaseAudioContext has been created.

Context

Notifies that an existing BaseAudioContext will be destroyed.

ContextId

Notifies that existing BaseAudioContext has changed some properties (id stays the same)..

Context

Notifies that the construction of an AudioListener has finished.

Listener

Notifies that a new AudioListener has been created.

ContextId

ListenerId

Notifies that a new AudioNode has been created.

Node

Notifies that an existing AudioNode has been destroyed.

ContextId

NodeId

Notifies that a new AudioParam has been created.

Param

Notifies that an existing AudioParam has been destroyed.

ContextId

NodeId

ParamId

Notifies that two AudioNodes are connected.

ContextId

SourceId

DestinationId

SourceOutputIndex

DestinationInputIndex

Notifies that AudioNodes are disconnected. The destination can be null, and it means all the outgoing connections from the source are disconnected.

ContextId

SourceId

DestinationId

SourceOutputIndex

DestinationInputIndex

Notifies that an AudioNode is connected to an AudioParam.

ContextId

SourceId

DestinationId

SourceOutputIndex

Notifies that an AudioNode is disconnected to an AudioParam.

ContextId

SourceId

DestinationId

SourceOutputIndex

GetRealtimeDataResponse

realtimeData

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

WebAudio

DevToolsClient

Notifies that a new BaseAudioContext has been created.

Notifies that an existing BaseAudioContext will be destroyed.

Notifies that existing BaseAudioContext has changed some properties (id stays the same)..

Notifies that the construction of an AudioListener has finished.

Notifies that a new AudioListener has been created.

Notifies that a new AudioNode has been created.

Notifies that an existing AudioNode has been destroyed.

Notifies that a new AudioParam has been created.

Notifies that an existing AudioParam has been destroyed.

Notifies that two AudioNodes are connected.

Notifies that AudioNodes are disconnected. The destination can be null, and it means all the outgoing connections from the source are disconnected.

Notifies that an AudioNode is connected to an AudioParam.

Notifies that an AudioNode is disconnected to an AudioParam.

Enables the WebAudio domain and starts sending context lifetime events.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Disables the WebAudio domain.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Fetch the realtime data from the registered contexts.

contextId returns System.Threading.Tasks.Task<GetRealtimeDataResponse>

AuthenticatorProtocol

u2f

ctap2

Ctap2Version

ctap2_0

ctap2_1

AuthenticatorTransport

usb

nfc

ble

cable

internal

VirtualAuthenticatorOptions

Protocol

Defaults to ctap2_0. Ignored if |protocol| == u2f.

Transport

Defaults to false.

If set to true, the authenticator will support the largeBlob extension. https://w3c.github.io/webauthn#largeBlob Defaults to false.

If set to true, the authenticator will support the credBlob extension. https://fidoalliance.org/specs/fido-v2.1-rd-20201208/fido-client-to-authenticator-protocol-v2.1-rd-20201208.html#sctn-credBlob-extension Defaults to false.

If set to true, the authenticator will support the minPinLength extension. https://fidoalliance.org/specs/fido-v2.1-ps-20210615/fido-client-to-authenticator-protocol-v2.1-ps-20210615.html#sctn-minpinlength-extension Defaults to false.

If set to true, the authenticator will support the prf extension. https://w3c.github.io/webauthn/#prf-extension Defaults to false.

If set to true, tests of user presence will succeed immediately. Otherwise, they will not be resolved. Defaults to true.

Sets whether User Verification succeeds or fails for an authenticator. Defaults to false.

Credentials created by this authenticator will have the backup eligibility (BE) flag set to this value. Defaults to false. https://w3c.github.io/webauthn/#sctn-credential-backup

Credentials created by this authenticator will have the backup state (BS) flag set to this value. Defaults to false. https://w3c.github.io/webauthn/#sctn-credential-backup

Credential

CredentialId

IsResidentCredential

Relying Party ID the credential is scoped to. Must be set when adding a credential.

The ECDSA P-256 private key in PKCS#8 format.

An opaque byte sequence with a maximum size of 64 bytes mapping the credential to a specific user.

Signature counter. This is incremented by one for each successful assertion. See https://w3c.github.io/webauthn/#signature-counter

The large blob associated with the credential. See https://w3c.github.io/webauthn/#sctn-large-blob-extension

Assertions returned by this credential will have the backup eligibility (BE) flag set to this value. Defaults to the authenticator's defaultBackupEligibility value.

Assertions returned by this credential will have the backup state (BS) flag set to this value. Defaults to the authenticator's defaultBackupState value.

Triggered when a credential is added to an authenticator.

AuthenticatorId

Credential

Triggered when a credential is used in a webauthn assertion.

AuthenticatorId

Credential

AddVirtualAuthenticatorResponse

authenticatorId

GetCredentialResponse

credential

GetCredentialsResponse

credentials

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

WebAuthn

DevToolsClient

Triggered when a credential is added to an authenticator.

Triggered when a credential is used in a webauthn assertion.

Enable the WebAuthn domain and start intercepting credential storage and retrieval with a virtual authenticator.

Whether to enable the WebAuthn user interface. Enabling the UI isrecommended for debugging and demo purposes, as it is closer to the realexperience. Disabling the UI is recommended for automated testing.Supported at the embedder's discretion if UI is available.Defaults to false. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Disable the WebAuthn domain.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Creates and adds a virtual authenticator.

options returns System.Threading.Tasks.Task<AddVirtualAuthenticatorResponse>

Resets parameters isBogusSignature, isBadUV, isBadUP to false if they are not present.

authenticatorId If isBogusSignature is set, overrides the signature in the authenticator response to be zero.Defaults to false. If isBadUV is set, overrides the UV bit in the flags in the authenticator response tobe zero. Defaults to false. If isBadUP is set, overrides the UP bit in the flags in the authenticator response tobe zero. Defaults to false. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Removes the given authenticator.

authenticatorId returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Adds the credential to the specified authenticator.

authenticatorId credential returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Returns a single credential stored in the given virtual authenticator that matches the credential ID.

authenticatorId credentialId returns System.Threading.Tasks.Task<GetCredentialResponse>

Returns all the credentials stored in the given virtual authenticator.

authenticatorId returns System.Threading.Tasks.Task<GetCredentialsResponse>

Removes a credential from the authenticator.

authenticatorId credentialId returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Clears all the credentials from the specified device.

authenticatorId returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Sets whether User Verification succeeds or fails for an authenticator. The default is true.

authenticatorId isUserVerified returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Sets whether tests of user presence will succeed immediately (if true) or fail to resolve (if false) for an authenticator. The default is true.

authenticatorId enabled returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Allows setting credential properties. https://w3c.github.io/webauthn/#sctn-automation-set-credential-properties

authenticatorId credentialId backupEligibility backupState returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Keep in sync with MediaLogMessageLevel We are currently keeping the message level 'error' separate from the PlayerError type because right now they represent different things, this one being a DVLOG(ERROR) style log message that gets printed based on what log level is selected in the UI, and the other is a representation of a media::PipelineStatus object. Soon however we're going to be moving away from using PipelineStatus for errors and introducing a new error type which should hopefully let us integrate the error log level into the PlayerError type.

error

warning

info

debug

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

Message

Corresponds to kMediaPropertyChange

Name

Value

Corresponds to kMediaEventTriggered

Timestamp

Value

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

File

Line

Corresponds to kMediaError

ErrorType

Code is the numeric enum entry for a specific set of error codes, such as PipelineStatusCodes in media/base/pipeline_status.h

A trace of where this error was caused / where it passed through.

Errors potentially have a root cause error, ie, a DecoderError might be caused by an WindowsError

Extra data attached to an error, such as an HRESULT, Video Codec, etc.

This can be called multiple times, and can be used to set / override / remove player properties. A null propValue indicates removal.

PlayerId

Properties

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.

PlayerId

Events

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

PlayerId

Messages

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

PlayerId

Errors

Called whenever a player is created, or when a new agent joins and receives a list of active players. If an agent is restored, it will receive the full list of player ids and all events again.

Players

This domain allows detailed inspection of media elements

Media

DevToolsClient

This can be called multiple times, and can be used to set / override / remove player properties. A null propValue indicates removal.

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.

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

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

Called whenever a player is created, or when a new agent joins and receives a list of active players. If an agent is restored, it will receive the full list of player ids and all events again.

Enables the Media domain

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Disables the Media domain.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Device information displayed in a user prompt to select a device.

Display name as it appears in a device request user prompt.

A device request opened a user prompt to select a device. Respond with the selectPrompt or cancelPrompt command.

Devices

DeviceAccess

DevToolsClient

A device request opened a user prompt to select a device. Respond with the selectPrompt or cancelPrompt command.

Enable events in this domain.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Disable events in this domain.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Select a device in response to a DeviceAccess.deviceRequestPrompted event.

id deviceId returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Cancel a prompt in response to a DeviceAccess.deviceRequestPrompted event.

id returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Corresponds to SpeculationRuleSet

Identifies a document which the rule set is associated with.

Source text of JSON representing the rule set. If it comes from `<script>` tag, it is the textContent of the node. Note that it is a JSON for valid case. See also: - https://wicg.github.io/nav-speculation/speculation-rules.html - https://github.com/WICG/nav-speculation/blob/main/triggers.md

A speculation rule set is either added through an inline `<script>` tag or through an external resource via the 'Speculation-Rules' HTTP header. For the first case, we include the BackendNodeId of the relevant `<script>` tag. For the second case, we include the external URL where the rule set was loaded from, and also RequestId if Network domain is enabled. See also: - https://wicg.github.io/nav-speculation/speculation-rules.html#speculation-rules-script - https://wicg.github.io/nav-speculation/speculation-rules.html#speculation-rules-header

Url

RequestId

Error information `errorMessage` is null if `errorType` is null.

TODO(https://crbug.com/1425354): Replace this property with structured error.

RuleSetErrorType

SourceIsNotJsonObject

InvalidRulesSkipped

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

Prefetch

Prerender

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

Blank

Self

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.

LoaderId

Action

Url

TargetHint

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.

Key

RuleSetIds

NodeIds

List of FinalStatus reasons for Prerender2.

Activated

Destroyed

LowEndDevice

InvalidSchemeRedirect

InvalidSchemeNavigation

NavigationRequestBlockedByCsp

MainFrameNavigation

MojoBinderPolicy

RendererProcessCrashed

RendererProcessKilled

Download

TriggerDestroyed

NavigationNotCommitted

NavigationBadHttpStatus

ClientCertRequested

NavigationRequestNetworkError

CancelAllHostsForTesting

DidFailLoad

Stop

SslCertificateError

LoginAuthRequested

UaChangeRequiresReload

BlockedByClient

AudioOutputDeviceRequested

MixedContent

TriggerBackgrounded

MemoryLimitExceeded

DataSaverEnabled

TriggerUrlHasEffectiveUrl

ActivatedBeforeStarted

InactivePageRestriction

StartFailed

TimeoutBackgrounded

CrossSiteRedirectInInitialNavigation

CrossSiteNavigationInInitialNavigation

SameSiteCrossOriginRedirectNotOptInInInitialNavigation

SameSiteCrossOriginNavigationNotOptInInInitialNavigation

ActivationNavigationParameterMismatch

ActivatedInBackground

EmbedderHostDisallowed

ActivationNavigationDestroyedBeforeSuccess

TabClosedByUserGesture

TabClosedWithoutUserGesture

PrimaryMainFrameRendererProcessCrashed

PrimaryMainFrameRendererProcessKilled

ActivationFramePolicyNotCompatible

PreloadingDisabled

BatterySaverEnabled

ActivatedDuringMainFrameNavigation

PreloadingUnsupportedByWebContents

CrossSiteRedirectInMainFrameNavigation

CrossSiteNavigationInMainFrameNavigation

SameSiteCrossOriginRedirectNotOptInInMainFrameNavigation

SameSiteCrossOriginNavigationNotOptInInMainFrameNavigation

MemoryPressureOnTrigger

MemoryPressureAfterTriggered

PrerenderingDisabledByDevTools

SpeculationRuleRemoved

ActivatedWithAuxiliaryBrowsingContexts

MaxNumOfRunningEagerPrerendersExceeded

MaxNumOfRunningNonEagerPrerendersExceeded

MaxNumOfRunningEmbedderPrerendersExceeded

PrerenderingUrlHasEffectiveUrl

RedirectedPrerenderingUrlHasEffectiveUrl

ActivationUrlHasEffectiveUrl

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

Pending

Running

Ready

Success

Failure

NotSupported

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

PrefetchAllowed

PrefetchFailedIneligibleRedirect

PrefetchFailedInvalidRedirect

PrefetchFailedMIMENotSupported

PrefetchFailedNetError

PrefetchFailedNon2XX

PrefetchFailedPerPageLimitExceeded

PrefetchEvictedAfterCandidateRemoved

PrefetchEvictedForNewerPrefetch

PrefetchHeldback

PrefetchIneligibleRetryAfter

PrefetchIsPrivacyDecoy

PrefetchIsStale

PrefetchNotEligibleBrowserContextOffTheRecord

PrefetchNotEligibleDataSaverEnabled

PrefetchNotEligibleExistingProxy

PrefetchNotEligibleHostIsNonUnique

PrefetchNotEligibleNonDefaultStoragePartition

PrefetchNotEligibleSameSiteCrossOriginPrefetchRequiredProxy

PrefetchNotEligibleSchemeIsNotHttps

PrefetchNotEligibleUserHasCookies

PrefetchNotEligibleUserHasServiceWorker

PrefetchNotEligibleBatterySaverEnabled

PrefetchNotEligiblePreloadingDisabled

PrefetchNotFinishedInTime

PrefetchNotStarted

PrefetchNotUsedCookiesChanged

PrefetchProxyNotAvailable

PrefetchResponseUsed

PrefetchSuccessfulButNotUsed

PrefetchNotUsedProbeFailed

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

HeaderName

InitialValue

ActivationValue

Upsert. Currently, it is only emitted when a rule set added.

RuleSet

ruleSetRemoved

Fired when a preload enabled state is updated.

DisabledByPreference

DisabledByDataSaver

DisabledByBatterySaver

DisabledByHoldbackPrefetchSpeculationRules

DisabledByHoldbackPrerenderSpeculationRules

Fired when a prefetch attempt is updated.

Key

The frame id of the frame initiating prefetch.

PrefetchUrl

Status

PrefetchStatus

RequestId

Fired when a prerender attempt is updated.

Key

Status

PrerenderStatus

This is used to give users more information about the name of Mojo interface that is incompatible with prerender and has caused the cancellation of the attempt.

MismatchedHeaders

Send a list of sources for all preloading attempts in a document.

LoaderId

PreloadingAttemptSources

Preload

DevToolsClient

Upsert. Currently, it is only emitted when a rule set added.

RuleSetRemoved

Fired when a preload enabled state is updated.

Fired when a prefetch attempt is updated.

Fired when a prerender attempt is updated.

Send a list of sources for all preloading attempts in a document.

Enable

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Disable

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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.

SignIn

SignUp

The types of FedCM dialogs.

AccountChooser

AutoReauthn

ConfirmIdpLogin

Error

The buttons on the FedCM dialog.

ConfirmIdpLoginContinue

ErrorGotIt

ErrorMoreDetails

The URLs that each account has

TermsOfService

PrivacyPolicy

Corresponds to IdentityRequestAccount

AccountId

Name

GivenName

PictureUrl

IdpConfigUrl

IdpLoginUrl

LoginState

These two are only set if the loginState is signUp

PrivacyPolicyUrl

dialogShown

DialogId

DialogType

Accounts

These exist primarily so that the caller can verify the RP context was used appropriately.

Subtitle

Triggered when a dialog is closed, either by user action, JS abort, or a command below.

DialogId

This domain allows interacting with the FedCM dialog.

FedCm

DevToolsClient

DialogShown

Triggered when a dialog is closed, either by user action, JS abort, or a command below.

Enable

Allows callers to disable the promise rejection delay that wouldnormally happen, if this is unimportant to what's being tested.(step 4 of https://fedidcg.github.io/FedCM/#browser-api-rp-sign-in) returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Disable

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

SelectAccount

dialogId accountIndex returns System.Threading.Tasks.Task<DevToolsMethodResponse>

ClickDialogButton

dialogId dialogButton returns System.Threading.Tasks.Task<DevToolsMethodResponse>

OpenUrl

dialogId accountIndex accountUrlType returns System.Threading.Tasks.Task<DevToolsMethodResponse>

DismissDialog

dialogId triggerCooldown returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Location in the source code.

Script identifier as reported in the `Debugger.scriptParsed`.

Line number in the script (0-based).

Column number in the script (0-based).

Location in the source code.

LineNumber

ColumnNumber

Location range within one script.

ScriptId

Start

End

JavaScript call frame. Array of call frames form the call stack.

Call frame identifier. This identifier is only valid while the virtual machine is paused.

Name of the JavaScript function called on this call frame.

Location in the source code.

JavaScript script name or url. Deprecated in favor of using the `location.scriptId` to resolve the URL via a previously sent `Debugger.scriptParsed` event.

Scope chain for this call frame.

`this` object for this call frame.

The value being returned, if the function is at return point.

Valid only while the VM is paused and indicates whether this frame can be restarted or not. Note that a `true` value here does not guarantee that Debugger#restartFrame with this CallFrameId will be successful, but it is very likely.

Scope type.

global

local

with

closure

catch

block

script

eval

module

wasm-expression-stack

Scope description.

Scope type.

Object representing the scope. For `global` and `with` scopes it represents the actual object; for the rest of the scopes, it is artificial transient object enumerating scope variables as its properties.

Name

Location in the source code where scope starts

Location in the source code where scope ends

Search match for resource.

Line number in resource content.

Line with match content.

BreakLocationType

debuggerStatement

call

return

BreakLocation

Script identifier as reported in the `Debugger.scriptParsed`.

Line number in the script (0-based).

Column number in the script (0-based).

Type

WasmDisassemblyChunk

The next chunk of disassembled lines.

The bytecode offsets describing the start of each line.

Enum of possible script languages.

JavaScript

WebAssembly

Type of the debug symbols.

None

SourceMap

EmbeddedDWARF

ExternalDWARF

Debug symbols available for a wasm script.

Type of the debug symbols.

URL of the external symbol source.

Fired when breakpoint is resolved to an actual script and location.

Breakpoint unique identifier.

Actual breakpoint location.

Pause reason.

ambiguous

assert

CSPViolation

debugCommand

DOM

EventListener

exception

instrumentation

OOM

other

promiseRejection

XHR

step

Fired when the virtual machine stopped on breakpoint or exception or any other stop criteria.

Call stack the virtual machine stopped on.

Pause reason.

Object containing break-specific auxiliary properties.

Hit breakpoints IDs

Async stack trace, if any.

Never present, will be removed.

Fired when virtual machine fails to parse the script.

Identifier of the script parsed.

URL or name of the script parsed (if any).

Line offset of the script within the resource with given URL (for script tags).

Column offset of the script within the resource with given URL.

Last line of the script.

Length of the last line of the script.

Specifies script creation context.

Content hash of the script, SHA-256.

Embedder-specific auxiliary data likely matching {isDefault: boolean, type: 'default'|'isolated'|'worker', frameId: string}

URL of source map associated with script (if any).

True, if this script has sourceURL.

True, if this script is ES6 module.

This script length.

JavaScript top stack frame of where the script parsed event was triggered if available.

If the scriptLanguage is WebAssembly, the code section offset in the module.

The language of the script.

The name the embedder supplied for this script.

Fired when virtual machine parses script. This event is also fired for all known and uncollected scripts upon enabling debugger.

Identifier of the script parsed.

URL or name of the script parsed (if any).

Line offset of the script within the resource with given URL (for script tags).

Column offset of the script within the resource with given URL.

Last line of the script.

Length of the last line of the script.

Specifies script creation context.

Content hash of the script, SHA-256.

Embedder-specific auxiliary data likely matching {isDefault: boolean, type: 'default'|'isolated'|'worker', frameId: string}

True, if this script is generated as a result of the live edit operation.

URL of source map associated with script (if any).

True, if this script has sourceURL.

True, if this script is ES6 module.

This script length.

JavaScript top stack frame of where the script parsed event was triggered if available.

If the scriptLanguage is WebAssembly, the code section offset in the module.

The language of the script.

If the scriptLanguage is WebASsembly, the source of debug symbols for the module.

The name the embedder supplied for this script.

EnableResponse

debuggerId

EvaluateOnCallFrameResponse

result

exceptionDetails

GetPossibleBreakpointsResponse

locations

GetScriptSourceResponse

scriptSource

bytecode

DisassembleWasmModuleResponse

streamId

totalNumberOfLines

functionBodyOffsets

chunk

NextWasmDisassemblyChunkResponse

chunk

GetStackTraceResponse

stackTrace

RestartFrameResponse

callFrames

asyncStackTrace

asyncStackTraceId

SearchInContentResponse

result

SetBreakpointResponse

breakpointId

actualLocation

SetInstrumentationBreakpointResponse

breakpointId

SetBreakpointByUrlResponse

breakpointId

locations

SetBreakpointOnFunctionCallResponse

breakpointId

SetScriptSourceResponse

callFrames

stackChanged

asyncStackTrace

asyncStackTraceId

status

exceptionDetails

ContinueToLocationTargetCallFrames

any

current

The `mode` parameter must be present and set to 'StepInto', otherwise `restartFrame` will error out.

StepInto

Instrumentation name.

beforeScriptExecution

beforeScriptWithSourceMapExecution

Pause on exceptions mode.

none

caught

uncaught

all

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

Debugger

DevToolsClient

Fired when breakpoint is resolved to an actual script and location.

Fired when the virtual machine stopped on breakpoint or exception or any other stop criteria.

Fired when the virtual machine resumed execution.

Fired when virtual machine fails to parse the script.

Fired when virtual machine parses script. This event is also fired for all known and uncollected scripts upon enabling debugger.

Continues execution until specific location is reached.

Location to continue to. targetCallFrames returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Disables debugger for given page.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Enables debugger for the given page. Clients should not assume that the debugging has been enabled until the result for this command is received.

The maximum size in bytes of collected scripts (not referenced by other heap objects)the debugger can hold. Puts no limit if parameter is omitted. returns System.Threading.Tasks.Task<EnableResponse>

Evaluates expression on a given call frame.

Call frame identifier to evaluate on. Expression to evaluate. String object group name to put result into (allows rapid releasing resulting object handlesusing `releaseObjectGroup`). Specifies whether command line API should be available to the evaluated expression, defaultsto false. In silent mode exceptions thrown during evaluation are not reported and do not pauseexecution. Overrides `setPauseOnException` state. Whether the result is expected to be a JSON object that should be sent by value. Whether preview should be generated for the result. Whether to throw an exception if side effect cannot be ruled out during evaluation. Terminate execution after timing out (number of milliseconds). returns System.Threading.Tasks.Task<EvaluateOnCallFrameResponse>

Returns possible locations for breakpoint. scriptId in start and end range locations should be the same.

Start of range to search possible breakpoint locations in. End of range to search possible breakpoint locations in (excluding). When not specified, endof scripts is used as end of range. Only consider locations which are in the same (non-nested) function as start. returns System.Threading.Tasks.Task<GetPossibleBreakpointsResponse>

Returns source for the script with given id.

Id of the script to get source for. returns System.Threading.Tasks.Task<GetScriptSourceResponse>

DisassembleWasmModule

Id of the script to disassemble returns System.Threading.Tasks.Task<DisassembleWasmModuleResponse>

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.

streamId returns System.Threading.Tasks.Task<NextWasmDisassemblyChunkResponse>

Returns stack trace with given `stackTraceId`.

stackTraceId returns System.Threading.Tasks.Task<GetStackTraceResponse>

Stops on the next JavaScript statement.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Removes JavaScript breakpoint.

breakpointId returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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.

Call frame identifier to evaluate on. The `mode` parameter must be present and set to 'StepInto', otherwise`restartFrame` will error out. returns System.Threading.Tasks.Task<RestartFrameResponse>

Resumes JavaScript execution.

Set to true to terminate execution upon resuming execution. In contrastto Runtime.terminateExecution, this will allows to execute furtherJavaScript (i.e. via evaluation) until execution of the paused codeis actually resumed, at which point termination is triggered.If execution is currently not paused, this parameter has no effect. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Searches for given string in script content.

Id of the script to search in. String to search for. If true, search is case sensitive. If true, treats string parameter as regex. returns System.Threading.Tasks.Task<SearchInContentResponse>

Enables or disables async call stacks tracking.

Maximum depth of async call stacks. Setting to `0` will effectively disable collecting asynccall stacks (default). returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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.

Array of regexps that will be used to check script url for blackbox state. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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.

Id of the script. positions returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Sets JavaScript breakpoint at a given location.

Location to set breakpoint in. Expression to use as a breakpoint condition. When specified, debugger will only stop on thebreakpoint if this expression evaluates to true. returns System.Threading.Tasks.Task<SetBreakpointResponse>

Sets instrumentation breakpoint.

Instrumentation name. returns System.Threading.Tasks.Task<SetInstrumentationBreakpointResponse>

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.

Line number to set breakpoint at. URL of the resources to set breakpoint on. Regex pattern for the URLs of the resources to set breakpoints on. Either `url` or`urlRegex` must be specified. Script hash of the resources to set breakpoint on. Offset in the line to set breakpoint at. Expression to use as a breakpoint condition. When specified, debugger will only stop on thebreakpoint if this expression evaluates to true. returns System.Threading.Tasks.Task<SetBreakpointByUrlResponse>

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.

Function object id. Expression to use as a breakpoint condition. When specified, debugger willstop on the breakpoint if this expression evaluates to true. returns System.Threading.Tasks.Task<SetBreakpointOnFunctionCallResponse>

Activates / deactivates all breakpoints on the page.

New value for breakpoints active state. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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

Pause on exceptions mode. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Changes return value in top frame. Available only at return break position.

New return value. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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.

Id of the script to edit. New content of the script. If true the change will not actually be applied. Dry run may be used to get resultdescription without actually modifying the code. If true, then `scriptSource` is allowed to change the function on top of the stackas long as the top-most stack frame is the only activation of that function. returns System.Threading.Tasks.Task<SetScriptSourceResponse>

Makes page not interrupt on any pauses (breakpoint, exception, dom exception etc).

New value for skip pauses state. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Changes value of variable in a callframe. Object-based scopes are not supported and must be mutated manually.

0-based number of scope as was listed in scope chain. Only 'local', 'closure' and 'catch'scope types are allowed. Other scopes could be manipulated manually. Variable name. New variable value. Id of callframe that holds variable. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Steps into the function call.

Debugger will pause on the execution of the first async task which was scheduledbefore next pause. The skipList specifies location ranges that should be skipped on step into. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Steps out of the function call.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Steps over the statement.

The skipList specifies location ranges that should be skipped on step over. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Sampling Heap Profile node. Holds callsite information, allocation statistics and child nodes.

Function location.

Allocations size in bytes for the node excluding children.

Node id. Ids are unique across all profiles collected between startSampling and stopSampling.

Child nodes.

A single sample from a sampling profile.

Allocation size in bytes attributed to the sample.

Id of the corresponding profile tree node.

Time-ordered sample ordinal number. It is unique across all profiles retrieved between startSampling and stopSampling.

Sampling profile.

Head

Samples

addHeapSnapshotChunk

Chunk

If heap objects tracking has been started then backend may send update for one or more fragments

An array of triplets. Each triplet describes a fragment. The first integer is the fragment index, the second integer is a total count of objects for the fragment, the third integer is a total size of the objects for the fragment.

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.

LastSeenObjectId

Timestamp

reportHeapSnapshotProgress

Done

Total

Finished

GetHeapObjectIdResponse

heapSnapshotObjectId

GetObjectByHeapObjectIdResponse

result

GetSamplingProfileResponse

profile

StopSamplingResponse

profile

HeapProfiler

DevToolsClient

AddHeapSnapshotChunk

If heap objects tracking has been started then backend may send update for one or more fragments

ReportHeapSnapshotProgress

ResetProfiles

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

Heap snapshot object id to be accessible by means of $x command line API. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

CollectGarbage

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Disable

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Enable

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

GetHeapObjectId

Identifier of the object to get heap object id for. returns System.Threading.Tasks.Task<GetHeapObjectIdResponse>

GetObjectByHeapObjectId

objectId Symbolic group name that can be used to release multiple objects. returns System.Threading.Tasks.Task<GetObjectByHeapObjectIdResponse>

GetSamplingProfile

returns System.Threading.Tasks.Task<GetSamplingProfileResponse>

StartSampling

Average sample interval in bytes. Poisson distribution is used for the intervals. Thedefault value is 32768 bytes. By default, the sampling heap profiler reports only objects which arestill alive when the profile is returned via getSamplingProfile orstopSampling, which is useful for determining what functions contributethe most to steady-state memory usage. This flag instructs the samplingheap profiler to also include information about objects discarded bymajor GC, which will show which functions cause large temporary memoryusage or long GC pauses. By default, the sampling heap profiler reports only objects which arestill alive when the profile is returned via getSamplingProfile orstopSampling, which is useful for determining what functions contributethe most to steady-state memory usage. This flag instructs the samplingheap profiler to also include information about objects discarded byminor GC, which is useful when tuning a latency-sensitive applicationfor minimal GC activity. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

StartTrackingHeapObjects

trackAllocations returns System.Threading.Tasks.Task<DevToolsMethodResponse>

StopSampling

returns System.Threading.Tasks.Task<StopSamplingResponse>

StopTrackingHeapObjects

If true 'reportHeapSnapshotProgress' events will be generated while snapshot is being takenwhen the tracking is stopped. Deprecated in favor of `exposeInternals`. If true, numerical values are included in the snapshot If true, exposes internals of the snapshot. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

TakeHeapSnapshot

If true 'reportHeapSnapshotProgress' events will be generated while snapshot is being taken. If true, a raw snapshot without artificial roots will be generated.Deprecated in favor of `exposeInternals`. If true, numerical values are included in the snapshot If true, exposes internals of the snapshot. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Profile node. Holds callsite information, execution statistics and child nodes.

Unique id of the node.

Function location.

Number of samples where this node was on top of the call stack.

Child node ids.

The reason of being not optimized. The function may be deoptimized or marked as don't optimize.

An array of source position ticks.

Profile.

The list of profile nodes. First item is the root node.

Profiling start timestamp in microseconds.

Profiling end timestamp in microseconds.

Ids of samples top nodes.

Time intervals between adjacent samples in microseconds. The first delta is relative to the profile startTime.

Specifies a number of samples attributed to a certain source position.

Source line number (1-based).

Number of samples attributed to the source line.

Coverage data for a source range.

JavaScript script source offset for the range start.

JavaScript script source offset for the range end.

Collected execution count of the source range.

Coverage data for a JavaScript function.

JavaScript function name.

Source ranges inside the function with coverage data.

Whether coverage data for this function has block granularity.

Coverage data for a JavaScript script.

JavaScript script id.

JavaScript script name or url.

Functions contained in the script that has coverage data.

consoleProfileFinished

Location of console.profileEnd().

Profile

Profile title passed as an argument to console.profile().

Sent when new profile recording is started using console.profile() call.

Location of console.profile().

Profile title passed as an argument to console.profile().

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.

Monotonically increasing time (in seconds) when the coverage update was taken in the backend.

Identifier for distinguishing coverage events.

Coverage data for the current isolate.

GetBestEffortCoverageResponse

result

StartPreciseCoverageResponse

timestamp

StopResponse

profile

TakePreciseCoverageResponse

result

timestamp

Profiler

DevToolsClient

ConsoleProfileFinished

Sent when new profile recording is started using console.profile() call.

Disable

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Enable

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Collect coverage data for the current isolate. The coverage data may be incomplete due to garbage collection.

returns System.Threading.Tasks.Task<GetBestEffortCoverageResponse>

Changes CPU profiler sampling interval. Must be called before CPU profiles recording started.

New sampling interval in microseconds. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Start

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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.

Collect accurate call counts beyond simple 'covered' or 'not covered'. Collect block-based coverage. Allow the backend to send updates on its own initiative returns System.Threading.Tasks.Task<StartPreciseCoverageResponse>

Stop

returns System.Threading.Tasks.Task<StopResponse>

Disable precise code coverage. Disabling releases unnecessary execution count records and allows executing optimized code.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Collect coverage data for the current isolate, and resets execution counters. Precise code coverage needs to have started.

returns System.Threading.Tasks.Task<TakePreciseCoverageResponse>

SerializationOptionsSerialization

deep

json

idOnly

Represents options for serialization. Overrides `generatePreview` and `returnByValue`.

Serialization

Deep serialization depth. Default is full depth. Respected only in `deep` serialization mode.

Embedder-specific parameters. For example if connected to V8 in Chrome these control DOM serialization via `maxNodeDepth: integer` and `includeShadowTree: "none" | "open" | "all"`. Values can be only of type string or integer.

DeepSerializedValueType

undefined

null

string

number

boolean

bigint

regexp

date

symbol

array

object

function

map

set

weakmap

weakset

error

proxy

promise

typedarray

arraybuffer

node

window

generator

Represents deep serialized value.

Type

Value

ObjectId

Set if value reference met more then once during serialization. In such case, value is provided only to one of the serialized values. Unique per value in the scope of one CDP call.

Object type.

object

function

undefined

string

number

boolean

symbol

bigint

Object subtype hint. Specified for `object` type values only. NOTE: If you change anything here, make sure to also update `subtype` in `ObjectPreview` and `PropertyPreview` below.

array

null

node

regexp

date

map

set

weakmap

weakset

iterator

generator

error

proxy

promise

typedarray

arraybuffer

dataview

webassemblymemory

wasmvalue

Mirror object referencing original JavaScript object.

Object type.

Object subtype hint. Specified for `object` type values only. NOTE: If you change anything here, make sure to also update `subtype` in `ObjectPreview` and `PropertyPreview` below.

Object class (constructor) name. Specified for `object` type values only.

Remote object value in case of primitive values or JSON values (if it was requested).

Primitive value which can not be JSON-stringified does not have `value`, but gets this property.

String representation of the object.

Deep serialized value.

Unique object identifier (for non-primitive values).

Preview containing abbreviated property values. Specified for `object` type values only.

CustomPreview

The JSON-stringified result of formatter.header(object, config) call. It contains json ML array that represents RemoteObject.

If formatter returns true as a result of formatter.hasBody call then bodyGetterId will contain RemoteObjectId for the function that returns result of formatter.body(object, config) call. The result value is json ML array.

Object type.

object

function

undefined

string

number

boolean

symbol

bigint

Object subtype hint. Specified for `object` type values only.

array

null

node

regexp

date

map

set

weakmap

weakset

iterator

generator

error

proxy

promise

typedarray

arraybuffer

dataview

webassemblymemory

wasmvalue

Object containing abbreviated remote object value.

Object type.

Object subtype hint. Specified for `object` type values only.

String representation of the object.

True iff some of the properties or entries of the original object did not fit.

List of the properties.

List of the entries. Specified for `map` and `set` subtype values only.

Object type. Accessor means that the property itself is an accessor property.

object

function

undefined

string

number

boolean

symbol

accessor

bigint

Object subtype hint. Specified for `object` type values only.

array

null

node

regexp

date

map

set

weakmap

weakset

iterator

generator

error

proxy

promise

typedarray

arraybuffer

dataview

webassemblymemory

wasmvalue

PropertyPreview

Property name.

Object type. Accessor means that the property itself is an accessor property.

User-friendly property value string.

Nested value preview.

Object subtype hint. Specified for `object` type values only.

EntryPreview

Preview of the key. Specified for map-like collection entries.

Preview of the value.

Object property descriptor.

Property name or symbol description.

The value associated with the property.

True if the value associated with the property may be changed (data descriptors only).

A function which serves as a getter for the property, or `undefined` if there is no getter (accessor descriptors only).

A function which serves as a setter for the property, or `undefined` if there is no setter (accessor descriptors only).

True if the type of this property descriptor may be changed and if the property may be deleted from the corresponding object.

True if this property shows up during enumeration of the properties on the corresponding object.

True if the result was thrown during the evaluation.

True if the property is owned for the object.

Property symbol object, if the property is of the `symbol` type.

Object internal property descriptor. This property isn't normally visible in JavaScript code.

Conventional property name.

The value associated with the property.

Object private field descriptor.

Private property name.

The value associated with the private property.

A function which serves as a getter for the private property, or `undefined` if there is no getter (accessor descriptors only).

A function which serves as a setter for the private property, or `undefined` if there is no setter (accessor descriptors only).

Represents function call argument. Either remote object id `objectId`, primitive `value`, unserializable primitive value or neither of (for undefined) them should be specified.

Primitive value or serializable javascript object.

Primitive value which can not be JSON-stringified.

Remote object handle.

Description of an isolated world.

Unique id of the execution context. It can be used to specify in which execution context script evaluation should be performed.

Execution context origin.

Human readable name describing given context.

A system-unique execution context identifier. Unlike the id, this is unique across multiple processes, so can be reliably used to identify specific context while backend performs a cross-process navigation.

Embedder-specific auxiliary data likely matching {isDefault: boolean, type: 'default'|'isolated'|'worker', frameId: string}

Detailed information about exception (or error) that was thrown during script compilation or execution.

Exception id.

Exception text, which should be used together with exception object when available.

Line number of the exception location (0-based).

Column number of the exception location (0-based).

Script ID of the exception location.

URL of the exception location, to be used when the script was not reported.

JavaScript stack trace if available.

Exception object if available.

Identifier of the context where exception happened.

Dictionary with entries of meta data that the client associated with this exception, such as information about associated network requests, etc.

Stack entry for runtime errors and assertions.

JavaScript function name.

JavaScript script id.

JavaScript script name or url.

JavaScript script line number (0-based).

JavaScript script column number (0-based).

Call frames for assertions or error messages.

String label of this stack trace. For async traces this may be a name of the function that initiated the async call.

JavaScript function name.

Asynchronous JavaScript stack trace that preceded this stack, if available.

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.

DebuggerId

Notification is issued every time when binding is called.

Name

Payload

Identifier of the context where the call was made.

Type of the call.

log

debug

info

error

warning

dir

dirxml

table

trace

clear

startGroup

startGroupCollapsed

endGroup

assert

profile

profileEnd

count

timeEnd

Issued when console API was called.

Type of the call.

Call arguments.

Identifier of the context where the call was made.

Call timestamp.

Stack trace captured when the call was made. The async stack chain is automatically reported for the following call types: `assert`, `error`, `trace`, `warning`. For other types the async call chain can be retrieved using `Debugger.getStackTrace` and `stackTrace.parentId` field.

Console context descriptor for calls on non-default console context (not console.*): 'anonymous#unique-logger-id' for call on unnamed context, 'name#unique-logger-id' for call on named context.

Issued when unhandled exception was revoked.

Reason describing why exception was revoked.

The id of revoked exception, as reported in `exceptionThrown`.

Issued when exception was thrown and unhandled.

Timestamp of the exception.

ExceptionDetails

Issued when new execution context is created.

A newly created execution context.

Issued when execution context is destroyed.

Id of the destroyed context

Unique Id of the destroyed context

Issued when object should be inspected (for example, as a result of inspect() command line API call).

Object

Hints

Identifier of the context where the call was made.

AwaitPromiseResponse

result

exceptionDetails

CallFunctionOnResponse

result

exceptionDetails

CompileScriptResponse

scriptId

exceptionDetails

EvaluateResponse

result

exceptionDetails

GetIsolateIdResponse

GetHeapUsageResponse

usedSize

totalSize

GetPropertiesResponse

result

internalProperties

privateProperties

exceptionDetails

GlobalLexicalScopeNamesResponse

names

QueryObjectsResponse

objects

RunScriptResponse

result

exceptionDetails

GetExceptionDetailsResponse

exceptionDetails

Runtime

DevToolsClient

Notification is issued every time when binding is called.

Issued when console API was called.

Issued when unhandled exception was revoked.

Issued when exception was thrown and unhandled.

Issued when new execution context is created.

Issued when execution context is destroyed.

Issued when all executionContexts were cleared in browser

Issued when object should be inspected (for example, as a result of inspect() command line API call).

Add handler to promise with given promise object id.

Identifier of the promise. Whether the result is expected to be a JSON object that should be sent by value. Whether preview should be generated for the result. returns System.Threading.Tasks.Task<AwaitPromiseResponse>

Calls function with given declaration on the given object. Object group of the result is inherited from the target object.

Declaration of the function to call. Identifier of the object to call function on. Either objectId or executionContextId shouldbe specified. Call arguments. All call arguments must belong to the same JavaScript world as the targetobject. In silent mode exceptions thrown during evaluation are not reported and do not pauseexecution. Overrides `setPauseOnException` state. Whether the result is expected to be a JSON object which should be sent by value.Can be overriden by `serializationOptions`. Whether preview should be generated for the result. Whether execution should be treated as initiated by user in the UI. Whether execution should `await` for resulting value and return once awaited promise isresolved. Specifies execution context which global object will be used to call function on. EitherexecutionContextId or objectId should be specified. Symbolic group name that can be used to release multiple objects. If objectGroup is notspecified and objectId is, objectGroup will be inherited from object. Whether to throw an exception if side effect cannot be ruled out during evaluation. An alternative way to specify the execution context to call function on.Compared to contextId that may be reused across processes, this is guaranteed to besystem-unique, so it can be used to prevent accidental function callin context different than intended (e.g. as a result of navigation across processboundaries).This is mutually exclusive with `executionContextId`. Specifies the result serialization. If provided, overrides`generatePreview` and `returnByValue`. returns System.Threading.Tasks.Task<CallFunctionOnResponse>

Compiles expression.

Expression to compile. Source url to be set for the script. Specifies whether the compiled script should be persisted. Specifies in which execution context to perform script run. If the parameter is omitted theevaluation will be performed in the context of the inspected page. returns System.Threading.Tasks.Task<CompileScriptResponse>

Disables reporting of execution contexts creation.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Discards collected exceptions and console API calls.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Evaluates expression on global object.

Expression to evaluate. Symbolic group name that can be used to release multiple objects. Determines whether Command Line API should be available during the evaluation. In silent mode exceptions thrown during evaluation are not reported and do not pauseexecution. Overrides `setPauseOnException` state. Specifies in which execution context to perform evaluation. If the parameter is omitted theevaluation will be performed in the context of the inspected page.This is mutually exclusive with `uniqueContextId`, which offers analternative way to identify the execution context that is more reliablein a multi-process environment. Whether the result is expected to be a JSON object that should be sent by value. Whether preview should be generated for the result. Whether execution should be treated as initiated by user in the UI. Whether execution should `await` for resulting value and return once awaited promise isresolved. Whether to throw an exception if side effect cannot be ruled out during evaluation.This implies `disableBreaks` below. Terminate execution after timing out (number of milliseconds). Disable breakpoints during execution. Setting this flag to true enables `let` re-declaration and top-level `await`.Note that `let` variables can only be re-declared if they originate from`replMode` themselves. The Content Security Policy (CSP) for the target might block 'unsafe-eval'which includes eval(), Function(), setTimeout() and setInterval()when called with non-callable arguments. This flag bypasses CSP for thisevaluation and allows unsafe-eval. Defaults to true. An alternative way to specify the execution context to evaluate in.Compared to contextId that may be reused across processes, this is guaranteed to besystem-unique, so it can be used to prevent accidental evaluation of the expressionin context different than intended (e.g. as a result of navigation across processboundaries).This is mutually exclusive with `contextId`. Specifies the result serialization. If provided, overrides`generatePreview` and `returnByValue`. returns System.Threading.Tasks.Task<EvaluateResponse>

Returns the isolate id.

returns System.Threading.Tasks.Task<GetIsolateIdResponse>

Returns the JavaScript heap usage. It is the total usage of the corresponding isolate not scoped to a particular Runtime.

returns System.Threading.Tasks.Task<GetHeapUsageResponse>

Returns properties of a given object. Object group of the result is inherited from the target object.

Identifier of the object to return properties for. If true, returns properties belonging only to the element itself, not to its prototypechain. If true, returns accessor properties (with getter/setter) only; internal properties are notreturned either. Whether preview should be generated for the results. If true, returns non-indexed properties only. returns System.Threading.Tasks.Task<GetPropertiesResponse>

Returns all let, const and class variables from global scope.

Specifies in which execution context to lookup global scope variables. returns System.Threading.Tasks.Task<GlobalLexicalScopeNamesResponse>

QueryObjects

Identifier of the prototype to return objects for. Symbolic group name that can be used to release the results. returns System.Threading.Tasks.Task<QueryObjectsResponse>

Releases remote object with given id.

Identifier of the object to release. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Releases all remote objects that belong to a given group.

Symbolic object group name. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Tells inspected instance to run if it was waiting for debugger to attach.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Runs script with given id in a given context.

Id of the script to run. Specifies in which execution context to perform script run. If the parameter is omitted theevaluation will be performed in the context of the inspected page. Symbolic group name that can be used to release multiple objects. In silent mode exceptions thrown during evaluation are not reported and do not pauseexecution. Overrides `setPauseOnException` state. Determines whether Command Line API should be available during the evaluation. Whether the result is expected to be a JSON object which should be sent by value. Whether preview should be generated for the result. Whether execution should `await` for resulting value and return once awaited promise isresolved. returns System.Threading.Tasks.Task<RunScriptResponse>

Enables or disables async call stacks tracking.

Maximum depth of async call stacks. Setting to `0` will effectively disable collecting asynccall stacks (default). returns System.Threading.Tasks.Task<DevToolsMethodResponse>

SetCustomObjectFormatterEnabled

enabled returns System.Threading.Tasks.Task<DevToolsMethodResponse>

SetMaxCallStackSizeToCapture

size returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Terminate current or next JavaScript execution. Will cancel the termination when the outer-most script execution ends.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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.

name If specified, the binding would only be exposed to the specifiedexecution context. If omitted and `executionContextName` is not set,the binding is exposed to all execution contexts of the target.This parameter is mutually exclusive with `executionContextName`.Deprecated in favor of `executionContextName` due to an unclear use caseand bugs in implementation (crbug.com/1169639). `executionContextId` will beremoved in the future. If specified, the binding is exposed to the executionContext withmatching name, even for contexts created after the binding is added.See also `ExecutionContext.name` and `worldName` parameter to`Page.addScriptToEvaluateOnNewDocument`.This parameter is mutually exclusive with `executionContextId`. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

This method does not remove binding function from global object but unsubscribes current runtime agent from Runtime.bindingCalled notifications.

name returns System.Threading.Tasks.Task<DevToolsMethodResponse>

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.

The error object for which to resolve the exception details. returns System.Threading.Tasks.Task<GetExceptionDetailsResponse>

EventBreakpoints

DevToolsClient

Sets breakpoint on particular native event.

Instrumentation name to stop on. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Removes breakpoint on particular native event.

Instrumentation name to stop on. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Removes all breakpoints

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

DeviceOrientation

DevToolsClient

Clears the overridden Device Orientation.

returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Overrides the Device Orientation.

Mock alpha Mock beta Mock gamma returns System.Threading.Tasks.Task<DevToolsMethodResponse>

ReadResponse

base64Encoded

data

eof

ResolveBlobResponse

uuid

Input/Output operations for streams produced by DevTools.

DevToolsClient

Close the stream, discard any temporary backing storage.

Handle of the stream to close. returns System.Threading.Tasks.Task<DevToolsMethodResponse>

Read a chunk of the stream

Handle of the stream to read. Seek to the specified offset before reading (if not specified, proceed with offsetfollowing the last read). Some types of streams may only support sequential reads. Maximum number of bytes to read (left upon the agent discretion if not specified). returns System.Threading.Tasks.Task<ReadResponse>

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

Object id of a Blob object wrapper. returns System.Threading.Tasks.Task<ResolveBlobResponse>

The exception that is thrown when there's a problem executing a DevTools protocol method.

Get the Error Response

Initializes a new instance of the class with its message string set to a default message.

Initializes a new instance of the class with a specified error message.

message

Initializes a new instance of the class with a specified error message.

message error response

Initializes a new instance of the class with a specified error message and an inner exception.

message inner exception

DevTools Domain base class Provides some basic helper methods

Common Base class for DevTools Domain Model classes

Error Message parsed from JSON e.g. {"code":-32601,"message":"'Browser.getWindowForTarget' wasn't found"}

Message Id

Error Code

Error Message

DevToolsDomainEventArgsBase

DevToolsDomainResponseBase

Convert from string to base64 byte array

string data byte array

DevToolsErrorEventArgs - Raised when an exception occurs when attempting to raise

Event Name

Json

Exception

DevToolsErrorEventArgs

Event Name json Exception

DevTools Event EventAargs

Event Name

Event paramaters as Json string

DevTools Method Response

MessageId

Success

Method Response as Json string

Generic Typed Event Proxy

Event Args Type

Constructor

Delegate used to convert from the Stream to event args

Add the event handler

event handler to add

Remove the event handler

event handler to remove returns true if the last event handler for this proxy was removed.

DevTools Client

Will be called on receipt of a DevTools protocol event. Events by default are disabled and need to be enabled on a per domain basis, e.g. Sending Network.enable (or calling ) to enable network related events.

Will be called when an error occurs when attempting to raise

Add event handler for a DevTools protocol event. Events by default are disabled and need to be enabled on a per domain basis, e.g. Sending Network.enable (or calling ) to enable network related events.

The event args type to which the event will be deserialized to. is the event name to listen to event handler to call when the event occurs

Remove event handler for a DevTools protocol event.

The event args type to which the event will be deserialized to. is the event name to listen to event handler to call when the event occurs Returns false if all handlers for the have been removed, otherwise returns true if there are still handlers registered.

The type to which the method result will be deserialzed to. is the method name are the method parameters represented as a dictionary, which may be empty. return a Task that can be awaited to obtain the method result

Event Proxy

Raise Event

sender event name Stream containing JSON SynchronizationContext

Used to represent Drag Data.

Create a new instance of

DragData

Called before a download begins in response to a user-initiated action (e.g. alt + link click or link click that returns a `Content-Disposition: attachment` response from the server).

the ChromiumWebBrowser control The browser instance is the target download URL is the target method (GET, POST, etc) Return true to proceed with the download or false to cancel the download.

Called before a download begins.

the ChromiumWebBrowser control The browser instance Represents the file being downloaded. Callback interface used to asynchronously continue a download.

Called when a download's status or progress information has been updated. This may be called multiple times before and after .

the ChromiumWebBrowser control The browser instance Represents the file being downloaded. The callback used to Cancel/Pause/Resume the process

A implementation used by to provide a fluent means of creating a .

Create a new DownloadHandler Builder

Fluent DownloadHandler Builder

Creates a new instances where all downloads are automatically downloaded to the specified folder. No dialog is dispolayed to the user.

folder where files are download. optional delegate for download updates, track progress, completion etc. instance.

Creates a new instances where a default "Save As" dialog is displayed to the user.

optional delegate for download updates, track progress, completion etc. instance.

Use to create a new instance of the fluent builder

Fluent DownloadHandler Builder

See for details.

Action to be executed when is called Fluent Builder, call to create a new instance

See for details.

Action to be executed when is called Fluent Builder, call to create a new instance

See for details.

Action to be executed when is called Fluent Builder, call to create a new instance

Create a instance

a instance

Called on the CEF IO thread when the browser needs credentials from the user. This method will only be called for requests initiated from the browser process.

indicates whether the host is a proxy server. the hostname. the port number. realm scheme is a callback for authentication information Return true to continue the request and call when the authentication information is available. If the request has an associated browser/frame then returning false will result in a call to on the associated with that browser, if any. Otherwise, returning false will cancel the request immediately.

Called when some part of the response is read. This method will not be called if the flag is set on the request.

request A stream containing the bytes received since the last call. Cannot be used outside the scope of this method.

Notifies the client of download progress.

request denotes the number of bytes received up to the call is the expected total size of the response (or -1 if not determined).

Notifies the client that the request has completed. Use the property to determine if the request was successful or not.

request

Notifies the client of upload progress. This method will only be called if the UR_FLAG_REPORT_UPLOAD_PROGRESS flag is set on the request.

request denotes the number of bytes sent so far. is the total size of uploading data (or -1 if chunked upload is enabled).

Fluent UrlRequestClient

Create a new UrlRequestClient Builder

Fluent UrlRequestClient Builder

Use to create a new instance of the fluent builder

Fluent UrlRequestClient Builder

See for details

function to be executed when is called Fluent Builder, call to create a new instance

See for details.

Action to be executed when is called Fluent Builder, call to create a new instance

See for details.

Action to be executed when is called Fluent Builder, call to create a new instance

See for details.

Action to be executed when is called Fluent Builder, call to create a new instance

See for details.

Action to be executed when is called Fluent Builder, call to create a new instance

Create a instance

a instance

Create instance via This is the primary object for bridging the ChromiumWebBrowser implementation and VC++

Create a new instance which is the main method of interaction between the unmanged CEF implementation and our ChromiumWebBrowser instances.

reference to the ChromiumWebBrowser instance true for WPF/OffScreen, false for WinForms and other Hwnd based implementations instance of

Native static methods for low level operations, memory copy Avoids having to P/Invoke as we can call the C++ API directly.

Create instances of Public Api classes, , etc.

Create a new instance of

Dispose of browser setings after it has been used to create a browser returns new instance of

Create a new instance of

returns new instance of

Create a new instance of

returns new instance of

Create a new instance of

returns new instance of

Create a new instance of

returns new instance of

Create a new instance of

request url request client returns new instance of

Create a new instance of

request url request client request context returns new instance of

Create a new instance of

returns new instance of

Create a new which can be used to create a new in a fluent flashion. Call to create the actual instance

RequestContextBuilder

Used internally to get the underlying instance. Unlikely you'll use this yourself.

the inner most instance

Create a new instance of

PostData

Class used to represent a single element in the request post data. The methods of this class may be called on any thread.

Used internally to get the underlying instance. Unlikely you'll use this yourself.

the inner most instance

Create a new instance of

PostDataElement

Used internally to get the underlying instance. Unlikely you'll use this yourself.

the inner most instance

Create a new instance

Request

Creates a new RequestContextBuilder which can be used to fluently set preferences

Returns a new RequestContextBuilder

Used internally to get the underlying instance. Unlikely you'll use this yourself.

the inner most instance

Fluent style builder for creating IRequestContext instances.

Create the actual RequestContext instance

Returns a new RequestContext instance.

Action is called in IRequestContextHandler.OnRequestContextInitialized

called when the context has been initialized. Returns RequestContextBuilder instance

Sets the Cache Path

The location where cache data for this request context will be stored on disk. If this value is non-empty then it must be an absolute path that is either equal to or a child directory of CefSettings.RootCachePath. If the value is empty then browsers will be created in "incognito mode" where in-memory caches are used for storage and no data is persisted to disk. HTML5 databases such as localStorage will only persist across sessions if a cache path is specified. To share the global browser cache and related configuration set this value to match the CefSettings.CachePath value. Returns RequestContextBuilder instance

Invoke this method tp persist user preferences as a JSON file in the cache path directory. Can be set globally using the CefSettings.PersistUserPreferences value. This value will be ignored if CachePath is empty or if it matches the CefSettings.CachePath value.

Returns RequestContextBuilder instance

Set the value associated with preference name when the RequestContext is initialzied. If value is null the preference will be restored to its default value. If setting the preference fails no error is throw, you must check the CEF Log file. Preferences set via the command-line usually cannot be modified.

preference key preference value Returns RequestContextBuilder instance

Set the Proxy server when the RequestContext is initialzied. If value is null the preference will be restored to its default value. If setting the preference fails no error is throw, you must check the CEF Log file. Proxy set via the command-line cannot be modified.

proxy host Returns RequestContextBuilder instance

proxy host proxy port (optional) Returns RequestContextBuilder instance

proxy scheme proxy host proxy port (optional) Returns RequestContextBuilder instance

Shares storage with other RequestContext

shares storage with this RequestContext Returns RequestContextBuilder instance

RequestContext Settings

To persist session cookies (cookies without an expiry date or validity interval) by default when using the global cookie manager set this value to true. Session cookies are generally intended to be transient and most Web browsers do not persist them. Can be set globally using the CefSettings.PersistSessionCookies value. This value will be ignored if CachePath is empty or if it matches the CefSettings.CachePath value.

To persist user preferences as a JSON file in the cache path directory set this value to true. Can be set globally using the CefSettings.PersistUserPreferences value. This value will be ignored if CachePath is empty or if it matches the CefSettings.CachePath value.

Comma delimited ordered list of language codes without any whitespace that will be used in the "Accept-Language" HTTP header. Can be set globally using the CefSettings.accept_language_list value or overridden on a per- browser basis using the BrowserSettings.AcceptLanguageList value. If all values are empty then "en-US,en" will be used. This value will be ignored if CachePath matches the CefSettings.CachePath value.

Create a new URL request that is not associated with a specific browser or frame. Use instead if you want the request to have this association, in which case it may be handled differently. For requests originating from the browser process: It may be intercepted by the client via or . POST data may only contain only a single element of type PDE_TYPE_FILE or PDE_TYPE_BYTES. Uses the Global RequestContext

request url request client

request url request client request context associated with this requets.

request url request client

request url request client request context associated with this requets.

Extended WebBrowserExtensions

Retrieve the current . Contains information like and

The ChromiumWebBrowser instance this method extends. that when executed returns the current or null

Downloads the specified and calls when the download is complete. Makes a GET Request.

valid frame url to download Action to be executed when the download is complete.

Downloads the specified as a . Makes a GET Request.

valid frame url to download control caching policy A task that can be awaited to get the representing the Url

Toggles audio mute for the current browser. If the is null or has been disposed then this command will be a no-op.

The ChromiumWebBrowser instance this method extends.

Evaluate javascript code in the context of the . The script will be executed asynchronously and the method returns a Task that can be awaited to obtain the result.

Type Thrown when one or more arguments are outside the required range. Thrown if a Javascript error occurs. The IFrame instance this method extends. The Javascript code that should be executed. (Optional) The timeout after which the Javascript code execution should be aborted. that can be awaited to obtain the result of the script execution. The is used to convert the result to the desired type. Property names are converted from camelCase. If the script execution returns an error then an exception is thrown.

Evaluate some Javascript code in the context of the MainFrame of the ChromiumWebBrowser. The script will be executed asynchronously and the method returns a Task encapsulating the response from the Javascript

Type Thrown when one or more arguments are outside the required range. The IBrowser instance this method extends. The JavaScript code that should be executed. (Optional) The timeout after which the JavaScript code execution should be aborted. that can be awaited to obtain the result of the JavaScript execution.

Evaluate Javascript in the context of this Browsers Main Frame. The script will be executed asynchronously and the method returns a Task encapsulating the response from the Javascript

Thrown when one or more arguments are outside the required range. Type The ChromiumWebBrowser instance this method extends. The Javascript code that should be executed. (Optional) The timeout after which the Javascript code execution should be aborted. that can be awaited to obtain the result of the script execution.

Create a new instance

WindowInfo