Available on crate features
Page and Debugger and DOM and IO and Network and Runtime only.Expand description
Actions and events related to the inspected page belong to the page domain.
Structs§
- AddCompilation
Cache Command experimental - Seeds compilation cache for given url. Compilation cache does not survive cross-process navigation.
- AddCompilation
Cache Return experimental - Seeds compilation cache for given url. Compilation cache does not survive cross-process navigation.
- AddScript
ToEvaluate OnLoad Command Deprecated experimental - Deprecated, please use addScriptToEvaluateOnNewDocument instead.
- AddScript
ToEvaluate OnLoad Return Deprecated experimental - Deprecated, please use addScriptToEvaluateOnNewDocument instead.
- AddScript
ToEvaluate OnNew Document Command - Evaluates given script in every frame upon creation (before loading frame’s scripts).
- AddScript
ToEvaluate OnNew Document Return - Evaluates given script in every frame upon creation (before loading frame’s scripts).
- AppManifest
Error - Error while paring app manifest.
- AppManifest
Error Builder - AppManifest
Parsed Properties experimental - Parsed app manifest properties.
- Bring
ToFront Command - Brings page to front (activates tab).
- Bring
ToFront Return - Brings page to front (activates tab).
- Capture
Screenshot Command - Capture page screenshot.
- Capture
Screenshot Command Builder - Capture
Screenshot Return - Capture page screenshot.
- Capture
Snapshot Command experimental - Returns a snapshot of the page as a string. For MHTML format, the serialization includes iframes, shadow DOM, external resources, and element-inline styles.
- Capture
Snapshot Return experimental - Returns a snapshot of the page as a string. For MHTML format, the serialization includes iframes, shadow DOM, external resources, and element-inline styles.
- Clear
Compilation Cache Command experimental - Clears seeded compilation cache.
- Clear
Compilation Cache Return experimental - Clears seeded compilation cache.
- Clear
Device Metrics Override Command Deprecated experimental - Clears the overriden device metrics.
- Clear
Device Metrics Override Return Deprecated experimental - Clears the overriden device metrics.
- Clear
Device Orientation Override Command Deprecated experimental - Clears the overridden Device Orientation.
- Clear
Device Orientation Override Return Deprecated experimental - Clears the overridden Device Orientation.
- Clear
Geolocation Override Command Deprecated - Clears the overriden Geolocation Position and Error.
- Clear
Geolocation Override Return Deprecated - Clears the overriden Geolocation Position and Error.
- Close
Command experimental - Tries to close page, running its beforeunload hooks, if any.
- Close
Return experimental - Tries to close page, running its beforeunload hooks, if any.
- Compilation
Cache Params experimental - Per-script compilation cache parameters for
Page.produceCompilationCache - Compilation
Cache Produced Event experimental - Issued for every compilation cache generated. Is only available if Page.setGenerateCompilationCache is enabled.
- Crash
Command experimental - Crashes renderer on the IO thread, generates minidumps.
- Crash
Return experimental - Crashes renderer on the IO thread, generates minidumps.
- Create
Isolated World Command - Creates an isolated world for the given frame.
- Create
Isolated World Return - Creates an isolated world for the given frame.
- Delete
Cookie Command Deprecated experimental - Deletes browser cookie with given name, domain and path.
- Delete
Cookie Return Deprecated experimental - Deletes browser cookie with given name, domain and path.
- Disable
Command - Disables page domain notifications.
- Disable
Return - Disables page domain notifications.
- Document
Opened Event experimental - Fired when opening document to write to.
- DomContent
Event Fired Event - Download
Progress Event Deprecated experimental - Fired when download makes progress. Last call has |done| == true. Deprecated. Use Browser.downloadProgress instead.
- Download
Progress Event Builder Deprecated experimental - Download
Will Begin Event Deprecated experimental - Fired when page is about to start a download. Deprecated. Use Browser.downloadWillBegin instead.
- Download
Will Begin Event Builder Deprecated experimental - Enable
Command - Enables page domain notifications.
- Enable
Return - Enables page domain notifications.
- File
Chooser Opened Event - Emitted only when
page.interceptFileChooseris enabled. - Font
Families experimental - Generic font families collection.
- Font
Families Builder experimental - Font
Sizes experimental - Default font sizes.
- Frame
- Information about the Frame on the page.
- Frame
Attached Event - Fired when frame has been attached to its parent.
- Frame
Builder - Frame
Cleared Scheduled Navigation Event Deprecated - Fired when frame no longer has a scheduled navigation.
- Frame
Detached Event - Fired when frame has been detached from its parent.
- FrameId
- Unique frame identifier.
- Frame
Navigated Event - Fired once navigation of the frame has completed. Frame is now associated with the new loader.
- Frame
Requested Navigation Event experimental - Fired when a renderer-initiated navigation is requested. Navigation may still be cancelled after the event is issued.
- Frame
Requested Navigation Event Builder experimental - Frame
Resized Event experimental - Frame
Resource experimental - Information about the Resource on the page.
- Frame
Resource Builder experimental - Frame
Resource Tree experimental - Information about the Frame hierarchy along with their cached resources.
- Frame
Scheduled Navigation Event Deprecated - Fired when frame schedules a potential navigation.
- Frame
Scheduled Navigation Event Builder Deprecated - Frame
Started Loading Event experimental - Fired when frame has started loading.
- Frame
Stopped Loading Event experimental - Fired when frame has stopped loading.
- Frame
Tree - Information about the Frame hierarchy.
- Generate
Test Report Command experimental - Generates a report for testing.
- Generate
Test Report Return experimental - Generates a report for testing.
- GetApp
Manifest Command - GetApp
Manifest Return - GetApp
Manifest Return Builder - GetCookies
Command Deprecated experimental - Returns all browser cookies. Depending on the backend support, will return detailed cookie
information in the
cookiesfield. - GetCookies
Return Deprecated experimental - Returns all browser cookies. Depending on the backend support, will return detailed cookie
information in the
cookiesfield. - GetFrame
Tree Command - Returns present frame tree structure.
- GetFrame
Tree Return - Returns present frame tree structure.
- GetInstallability
Errors Command experimental - GetInstallability
Errors Return experimental - GetLayout
Metrics Command - Returns metrics relating to the layouting of the page, such as viewport bounds/scale.
- GetLayout
Metrics Return - Returns metrics relating to the layouting of the page, such as viewport bounds/scale.
- GetLayout
Metrics Return Builder - GetManifest
Icons Command experimental - GetManifest
Icons Return experimental - GetNavigation
History Command - Returns navigation history for the current page.
- GetNavigation
History Return - Returns navigation history for the current page.
- GetPermissions
Policy State Command experimental - Get Permissions Policy state on given frame.
- GetPermissions
Policy State Return experimental - Get Permissions Policy state on given frame.
- GetResource
Content Command experimental - Returns content of the given resource.
- GetResource
Content Return experimental - Returns content of the given resource.
- GetResource
Tree Command experimental - Returns present frame / resource tree structure.
- GetResource
Tree Return experimental - Returns present frame / resource tree structure.
- Handle
Java Script Dialog Command - Accepts or dismisses a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload).
- Handle
Java Script Dialog Return - Accepts or dismisses a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload).
- Installability
Error experimental - The installability error
- Installability
Error Argument experimental - Interstitial
Hidden Event - Fired when interstitial page was hidden
- Interstitial
Shown Event - Fired when interstitial page was shown
- Javascript
Dialog Closed Event - Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) has been closed.
- Javascript
Dialog Opening Event - Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) is about to open.
- Javascript
Dialog Opening Event Builder - Layout
Viewport - Layout viewport position and dimensions.
- Layout
Viewport Builder - Lifecycle
Event Event - Fired for top level page lifecycle events such as navigation, load, paint, etc.
- Lifecycle
Event Event Builder - Load
Event Fired Event - Navigate
Command - Navigates current page to the given URL.
- Navigate
Command Builder - Navigate
Return - Navigates current page to the given URL.
- Navigate
ToHistory Entry Command - Navigates current page to the given history entry.
- Navigate
ToHistory Entry Return - Navigates current page to the given history entry.
- Navigated
Within Document Event experimental - Fired when same-document navigation happens, e.g. due to history API usage or anchor navigation.
- Navigation
Entry - Navigation history entry.
- Navigation
Entry Builder - Permissions
Policy Block Locator experimental - Permissions
Policy Feature State experimental - Print
ToPdf Command - Print page as PDF.
- Print
ToPdf Command Builder - Print
ToPdf Return - Print page as PDF.
- Produce
Compilation Cache Command experimental - Requests backend to produce compilation cache for the specified scripts.
Unlike setProduceCompilationCache, this allows client to only produce cache
for specific scripts.
scriptsare appeneded to the list of scripts for which the cache for would produced. Disabling compilation cache withsetProduceCompilationCachewould reset all pending cache requests. The list may also 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. - Produce
Compilation Cache Return experimental - Requests backend to produce compilation cache for the specified scripts.
Unlike setProduceCompilationCache, this allows client to only produce cache
for specific scripts.
scriptsare appeneded to the list of scripts for which the cache for would produced. Disabling compilation cache withsetProduceCompilationCachewould reset all pending cache requests. The list may also 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. - Reload
Command - Reloads given page optionally ignoring the cache.
- Reload
Return - Reloads given page optionally ignoring the cache.
- Remove
Script ToEvaluate OnLoad Command Deprecated experimental - Deprecated, please use removeScriptToEvaluateOnNewDocument instead.
- Remove
Script ToEvaluate OnLoad Return Deprecated experimental - Deprecated, please use removeScriptToEvaluateOnNewDocument instead.
- Remove
Script ToEvaluate OnNew Document Command - Removes given script from the list.
- Remove
Script ToEvaluate OnNew Document Return - Removes given script from the list.
- Reset
Navigation History Command - Resets navigation history for the current page.
- Reset
Navigation History Return - Resets navigation history for the current page.
- Screencast
Frame AckCommand experimental - Acknowledges that a screencast frame has been received by the frontend.
- Screencast
Frame AckReturn experimental - Acknowledges that a screencast frame has been received by the frontend.
- Screencast
Frame Event experimental - Compressed image data requested by the
startScreencast. - Screencast
Frame Metadata experimental - Screencast frame metadata.
- Screencast
Frame Metadata Builder experimental - Screencast
Visibility Changed Event experimental - Fired when the page with currently enabled screencast was shown or hidden `.
- Script
Identifier - Unique script identifier.
- Search
InResource Command experimental - Searches for given string in resource content.
- Search
InResource Command Builder experimental - Search
InResource Return experimental - Searches for given string in resource content.
- SetAd
Blocking Enabled Command experimental - Enable Chrome’s experimental ad filter on all sites.
- SetAd
Blocking Enabled Return experimental - Enable Chrome’s experimental ad filter on all sites.
- SetBypass
CspCommand experimental - Enable page Content Security Policy by-passing.
- SetBypass
CspReturn experimental - Enable page Content Security Policy by-passing.
- SetDevice
Metrics Override Command Deprecated experimental - 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).
- SetDevice
Metrics Override Command Builder Deprecated experimental - SetDevice
Metrics Override Return Deprecated experimental - 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).
- SetDevice
Orientation Override Command Deprecated experimental - Overrides the Device Orientation.
- SetDevice
Orientation Override Return Deprecated experimental - Overrides the Device Orientation.
- SetDocument
Content Command - Sets given markup as the document’s HTML.
- SetDocument
Content Return - Sets given markup as the document’s HTML.
- SetDownload
Behavior Command Deprecated experimental - Set the behavior when downloading a file.
- SetDownload
Behavior Return Deprecated experimental - Set the behavior when downloading a file.
- SetFont
Families Command experimental - Set generic font families.
- SetFont
Families Return experimental - Set generic font families.
- SetFont
Sizes Command experimental - Set default font sizes.
- SetFont
Sizes Return experimental - Set default font sizes.
- SetGeolocation
Override Command Deprecated - Overrides the Geolocation Position or Error. Omitting any of the parameters emulates position unavailable.
- SetGeolocation
Override Return Deprecated - Overrides the Geolocation Position or Error. Omitting any of the parameters emulates position unavailable.
- SetIntercept
File Chooser Dialog Command experimental - 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.fileChooserOpenedis emitted. - SetIntercept
File Chooser Dialog Return experimental - 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.fileChooserOpenedis emitted. - SetLifecycle
Events Enabled Command experimental - Controls whether page will emit lifecycle events.
- SetLifecycle
Events Enabled Return experimental - Controls whether page will emit lifecycle events.
- SetProduce
Compilation Cache Command experimental - Forces compilation cache to be generated for every subresource script.
See also:
Page.produceCompilationCache. - SetProduce
Compilation Cache Return experimental - Forces compilation cache to be generated for every subresource script.
See also:
Page.produceCompilationCache. - SetTouch
Emulation Enabled Command Deprecated experimental - Toggles mouse event-based touch event emulation.
- SetTouch
Emulation Enabled Return Deprecated experimental - Toggles mouse event-based touch event emulation.
- SetWeb
Lifecycle State Command experimental - 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/
- SetWeb
Lifecycle State Return experimental - 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/
- Start
Screencast Command experimental - Starts sending each frame using the
screencastFrameevent. - Start
Screencast Command Builder experimental - Start
Screencast Return experimental - Starts sending each frame using the
screencastFrameevent. - Stop
Loading Command - Force the page stop all navigations and pending resource fetches.
- Stop
Loading Return - Force the page stop all navigations and pending resource fetches.
- Stop
Screencast Command experimental - Stops sending each frame in the
screencastFrame. - Stop
Screencast Return experimental - Stops sending each frame in the
screencastFrame. - Viewport
- Viewport for capturing screenshot.
- Viewport
Builder - Visual
Viewport - Visual viewport position, dimensions, and scale.
- Visual
Viewport Builder - Wait
ForDebugger Command experimental - Pauses page execution. Can be resumed using generic Runtime.runIfWaitingForDebugger.
- Wait
ForDebugger Return experimental - Pauses page execution. Can be resumed using generic Runtime.runIfWaitingForDebugger.
- Window
Open Event - Fired when a new window is going to be opened, via window.open(), link click, form submission, etc.
- Window
Open Event Builder
Enums§
- AdFrame
Type experimental - Capture
Screenshot Command Format - Capture
Snapshot Command Format - Client
Navigation Disposition experimental - Client
Navigation Reason experimental - Cross
Origin Isolated Context Type experimental - Dialog
Type - Download
Progress Event State - File
Chooser Opened Event Mode - Frame
Detached Event Reason - Gated
ApiFeatures experimental - Permissions
Policy Block Reason experimental - Permissions
Policy Feature experimental - Print
ToPdf Command Transfer Mode - Referrer
Policy experimental - Secure
Context Type experimental - SetDownload
Behavior Command Behavior - SetTouch
Emulation Enabled Command Configuration - SetWeb
Lifecycle State Command State - Start
Screencast Command Format - Transition
Type