Expand description
Actions and events related to the inspected page belong to the page domain.
Structs§
- AdFrame
Status - Indicates whether a frame has been identified as an ad and why. AdFrameStatus
- AdFrame
Status Builder - AdScript
Id - Identifies the bottom-most script which caused the frame to be labelled as an ad. AdScriptId
- AdScript
IdBuilder - AddCompilation
Cache Params - Seeds compilation cache for given url. Compilation cache does not survive cross-process navigation. addCompilationCache
- AddCompilation
Cache Params Builder - AddCompilation
Cache Returns - Seeds compilation cache for given url. Compilation cache does not survive cross-process navigation. addCompilationCache
- AddScript
ToEvaluate OnNew Document Params - Evaluates given script in every frame upon creation (before loading frame’s scripts). addScriptToEvaluateOnNewDocument
- AddScript
ToEvaluate OnNew Document Params Builder - AddScript
ToEvaluate OnNew Document Returns - Evaluates given script in every frame upon creation (before loading frame’s scripts). addScriptToEvaluateOnNewDocument
- AddScript
ToEvaluate OnNew Document Returns Builder - AppManifest
Error - Error while paring app manifest. AppManifestError
- AppManifest
Error Builder - AppManifest
Parsed Properties - Parsed app manifest properties. AppManifestParsedProperties
- AppManifest
Parsed Properties Builder - Back
Forward Cache Blocking Details - Back
Forward Cache Blocking Details Builder - Back
Forward Cache NotRestored Explanation - Back
Forward Cache NotRestored Explanation Builder - Back
Forward Cache NotRestored Explanation Tree - Back
Forward Cache NotRestored Explanation Tree Builder - Bring
ToFront Params - Brings page to front (activates tab). bringToFront
- Bring
ToFront Returns - Brings page to front (activates tab). bringToFront
- Capture
Screenshot Params - Capture page screenshot. captureScreenshot
- Capture
Screenshot Params Builder - Capture
Screenshot Returns - Capture page screenshot. captureScreenshot
- Capture
Screenshot Returns Builder - Capture
Snapshot Params - Returns a snapshot of the page as a string. For MHTML format, the serialization includes iframes, shadow DOM, external resources, and element-inline styles. captureSnapshot
- Capture
Snapshot Params Builder - Capture
Snapshot Returns - Returns a snapshot of the page as a string. For MHTML format, the serialization includes iframes, shadow DOM, external resources, and element-inline styles. captureSnapshot
- Capture
Snapshot Returns Builder - Clear
Compilation Cache Params - Clears seeded compilation cache. clearCompilationCache
- Clear
Compilation Cache Returns - Clears seeded compilation cache. clearCompilationCache
- Close
Params - Tries to close page, running its beforeunload hooks, if any. close
- Close
Returns - Tries to close page, running its beforeunload hooks, if any. close
- Compilation
Cache Params - Per-script compilation cache parameters for
Page.produceCompilationCacheCompilationCacheParams - Compilation
Cache Params Builder - Crash
Params - Crashes renderer on the IO thread, generates minidumps. crash
- Crash
Returns - Crashes renderer on the IO thread, generates minidumps. crash
- Create
Isolated World Params - Creates an isolated world for the given frame. createIsolatedWorld
- Create
Isolated World Params Builder - Create
Isolated World Returns - Creates an isolated world for the given frame. createIsolatedWorld
- Create
Isolated World Returns Builder - Disable
Params - Disables page domain notifications. disable
- Disable
Returns - Disables page domain notifications. disable
- Enable
Params - Enables page domain notifications. enable
- Enable
Returns - Enables page domain notifications. enable
- Event
Back Forward Cache NotUsed - 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. backForwardCacheNotUsed
- Event
Compilation Cache Produced - Issued for every compilation cache generated. Is only available if Page.setGenerateCompilationCache is enabled. compilationCacheProduced
- Event
Document Opened - Fired when opening document to write to. documentOpened
- Event
DomContent Event Fired - Event
File Chooser Opened - Emitted only when
page.interceptFileChooseris enabled. fileChooserOpened - Event
Frame Attached - Fired when frame has been attached to its parent. frameAttached
- Event
Frame Detached - Fired when frame has been detached from its parent. frameDetached
- Event
Frame Navigated - Fired once navigation of the frame has completed. Frame is now associated with the new loader. frameNavigated
- Event
Frame Requested Navigation - Fired when a renderer-initiated navigation is requested. Navigation may still be cancelled after the event is issued. frameRequestedNavigation
- Event
Frame Resized - Event
Frame Started Loading - Fired when frame has started loading. frameStartedLoading
- Event
Frame Stopped Loading - Fired when frame has stopped loading. frameStoppedLoading
- Event
Frame Subtree Will BeDetached - Fired before frame subtree is detached. Emitted before any frame of the subtree is actually detached. frameSubtreeWillBeDetached
- Event
Interstitial Hidden - Fired when interstitial page was hidden interstitialHidden
- Event
Interstitial Shown - Fired when interstitial page was shown interstitialShown
- Event
Javascript Dialog Closed - Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) has been closed. javascriptDialogClosed
- Event
Javascript Dialog Opening - Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) is about to open. javascriptDialogOpening
- Event
Lifecycle Event - Fired for top level page lifecycle events such as navigation, load, paint, etc. lifecycleEvent
- Event
Load Event Fired - Event
Navigated Within Document - Fired when same-document navigation happens, e.g. due to history API usage or anchor navigation. navigatedWithinDocument
- Event
Screencast Frame - Compressed image data requested by the
startScreencast. screencastFrame - Event
Screencast Visibility Changed - Fired when the page with currently enabled screencast was shown or hidden `. screencastVisibilityChanged
- Event
Window Open - Fired when a new window is going to be opened, via window.open(), link click, form submission, etc. windowOpen
- File
Filter - The manifest of a webapp, see https://www.w3.org/TR/appmanifest/#dfn-manifest. Some fields do not appear in the standard since the API is designed to expose more browser internal states. FileFilter
- File
Filter Builder - File
Handler - File
Handler Builder - Font
Families - Generic font families collection. FontFamilies
- Font
Families Builder - Font
Sizes - Default font sizes. FontSizes
- Font
Sizes Builder - Frame
- Information about the Frame on the page. Frame
- Frame
Builder - FrameId
- Unique frame identifier. FrameId
- Frame
Resource - Information about the Resource on the page. FrameResource
- Frame
Resource Builder - Frame
Resource Tree - Information about the Frame hierarchy along with their cached resources. FrameResourceTree
- Frame
Resource Tree Builder - Frame
Tree - Information about the Frame hierarchy. FrameTree
- Frame
Tree Builder - Generate
Test Report Params - Generates a report for testing. generateTestReport
- Generate
Test Report Params Builder - Generate
Test Report Returns - Generates a report for testing. generateTestReport
- GetAd
Script IdParams - GetAd
Script IdParams Builder - GetAd
Script IdReturns - GetAd
Script IdReturns Builder - GetApp
IdParams - Returns the unique (PWA) app id. Only returns values if the feature flag ‘WebAppEnableManifestId’ is enabled getAppId
- GetApp
IdReturns - Returns the unique (PWA) app id. Only returns values if the feature flag ‘WebAppEnableManifestId’ is enabled getAppId
- GetApp
IdReturns Builder - GetApp
Manifest Params - Gets the processed manifest for this current document. This API always waits for the manifest to be loaded. If manifestId is provided, and it does not match the manifest of the current document, this API errors out. If there is not a loaded page, this API errors out immediately. getAppManifest
- GetApp
Manifest Params Builder - GetApp
Manifest Returns - Gets the processed manifest for this current document. This API always waits for the manifest to be loaded. If manifestId is provided, and it does not match the manifest of the current document, this API errors out. If there is not a loaded page, this API errors out immediately. getAppManifest
- GetApp
Manifest Returns Builder - GetFrame
Tree Params - Returns present frame tree structure. getFrameTree
- GetFrame
Tree Returns - Returns present frame tree structure. getFrameTree
- GetFrame
Tree Returns Builder - GetInstallability
Errors Params - GetInstallability
Errors Returns - GetInstallability
Errors Returns Builder - GetLayout
Metrics Params - Returns metrics relating to the layouting of the page, such as viewport bounds/scale. getLayoutMetrics
- GetLayout
Metrics Returns - Returns metrics relating to the layouting of the page, such as viewport bounds/scale. getLayoutMetrics
- GetLayout
Metrics Returns Builder - GetNavigation
History Params - Returns navigation history for the current page. getNavigationHistory
- GetNavigation
History Returns - Returns navigation history for the current page. getNavigationHistory
- GetNavigation
History Returns Builder - GetOrigin
Trials Params - Get Origin Trials on given frame. getOriginTrials
- GetOrigin
Trials Params Builder - GetOrigin
Trials Returns - Get Origin Trials on given frame. getOriginTrials
- GetOrigin
Trials Returns Builder - GetPermissions
Policy State Params - Get Permissions Policy state on given frame. getPermissionsPolicyState
- GetPermissions
Policy State Params Builder - GetPermissions
Policy State Returns - Get Permissions Policy state on given frame. getPermissionsPolicyState
- GetPermissions
Policy State Returns Builder - GetResource
Content Params - Returns content of the given resource. getResourceContent
- GetResource
Content Params Builder - GetResource
Content Returns - Returns content of the given resource. getResourceContent
- GetResource
Content Returns Builder - GetResource
Tree Params - Returns present frame / resource tree structure. getResourceTree
- GetResource
Tree Returns - Returns present frame / resource tree structure. getResourceTree
- GetResource
Tree Returns Builder - Handle
Java Script Dialog Params - Accepts or dismisses a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload). handleJavaScriptDialog
- Handle
Java Script Dialog Params Builder - Handle
Java Script Dialog Returns - Accepts or dismisses a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload). handleJavaScriptDialog
- Image
Resource - The image definition used in both icon and screenshot. ImageResource
- Image
Resource Builder - Installability
Error - The installability error InstallabilityError
- Installability
Error Argument - Installability
Error Argument Builder - Installability
Error Builder - Launch
Handler - Launch
Handler Builder - Layout
Viewport - Layout viewport position and dimensions. LayoutViewport
- Layout
Viewport Builder - Navigate
Params - Navigates current page to the given URL. navigate
- Navigate
Params Builder - Navigate
Returns - Navigates current page to the given URL. navigate
- Navigate
Returns Builder - Navigate
ToHistory Entry Params - Navigates current page to the given history entry. navigateToHistoryEntry
- Navigate
ToHistory Entry Params Builder - Navigate
ToHistory Entry Returns - Navigates current page to the given history entry. navigateToHistoryEntry
- Navigation
Entry - Navigation history entry. NavigationEntry
- Navigation
Entry Builder - Origin
Trial - Origin
Trial Builder - Origin
Trial Token - Origin
Trial Token Builder - Origin
Trial Token With Status - Origin
Trial Token With Status Builder - Permissions
Policy Block Locator - Permissions
Policy Block Locator Builder - Permissions
Policy Feature State - Permissions
Policy Feature State Builder - Print
ToPdf Params - Print page as PDF. printToPDF
- Print
ToPdf Params Builder - Print
ToPdf Returns - Print page as PDF. printToPDF
- Print
ToPdf Returns Builder - Produce
Compilation Cache Params - Requests backend to produce compilation cache for the specified scripts.
scriptsare 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. produceCompilationCache - Produce
Compilation Cache Params Builder - Produce
Compilation Cache Returns - Requests backend to produce compilation cache for the specified scripts.
scriptsare 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. produceCompilationCache - Protocol
Handler - Protocol
Handler Builder - Related
Application - Related
Application Builder - Reload
Params - Reloads given page optionally ignoring the cache. reload
- Reload
Params Builder - Reload
Returns - Reloads given page optionally ignoring the cache. reload
- Remove
Script ToEvaluate OnNew Document Params - Removes given script from the list. removeScriptToEvaluateOnNewDocument
- Remove
Script ToEvaluate OnNew Document Params Builder - Remove
Script ToEvaluate OnNew Document Returns - Removes given script from the list. removeScriptToEvaluateOnNewDocument
- Reset
Navigation History Params - Resets navigation history for the current page. resetNavigationHistory
- Reset
Navigation History Returns - Resets navigation history for the current page. resetNavigationHistory
- Scope
Extension - Scope
Extension Builder - Screencast
Frame AckParams - Acknowledges that a screencast frame has been received by the frontend. screencastFrameAck
- Screencast
Frame AckParams Builder - Screencast
Frame AckReturns - Acknowledges that a screencast frame has been received by the frontend. screencastFrameAck
- Screencast
Frame Metadata - Screencast frame metadata. ScreencastFrameMetadata
- Screencast
Frame Metadata Builder - Screenshot
- Screenshot
Builder - Script
Font Families - Font families collection for a script. ScriptFontFamilies
- Script
Font Families Builder - Script
Identifier - Unique script identifier. ScriptIdentifier
- Search
InResource Params - Searches for given string in resource content. searchInResource
- Search
InResource Params Builder - Search
InResource Returns - Searches for given string in resource content. searchInResource
- Search
InResource Returns Builder - SetAd
Blocking Enabled Params - Enable Chrome’s experimental ad filter on all sites. setAdBlockingEnabled
- SetAd
Blocking Enabled Params Builder - SetAd
Blocking Enabled Returns - Enable Chrome’s experimental ad filter on all sites. setAdBlockingEnabled
- SetBypass
CspParams - Enable page Content Security Policy by-passing. setBypassCSP
- SetBypass
CspParams Builder - SetBypass
CspReturns - Enable page Content Security Policy by-passing. setBypassCSP
- SetDocument
Content Params - Sets given markup as the document’s HTML. setDocumentContent
- SetDocument
Content Params Builder - SetDocument
Content Returns - Sets given markup as the document’s HTML. setDocumentContent
- SetFont
Families Params - Set generic font families. setFontFamilies
- SetFont
Families Params Builder - SetFont
Families Returns - Set generic font families. setFontFamilies
- SetFont
Sizes Params - Set default font sizes. setFontSizes
- SetFont
Sizes Params Builder - SetFont
Sizes Returns - Set default font sizes. setFontSizes
- SetIntercept
File Chooser Dialog Params - 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. setInterceptFileChooserDialog - SetIntercept
File Chooser Dialog Params Builder - SetIntercept
File Chooser Dialog Returns - 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. setInterceptFileChooserDialog - SetLifecycle
Events Enabled Params - Controls whether page will emit lifecycle events. setLifecycleEventsEnabled
- SetLifecycle
Events Enabled Params Builder - SetLifecycle
Events Enabled Returns - Controls whether page will emit lifecycle events. setLifecycleEventsEnabled
- SetPrerendering
Allowed Params - Enable/disable prerendering manually.
- SetPrerendering
Allowed Params Builder - SetPrerendering
Allowed Returns - Enable/disable prerendering manually.
- SetRph
Registration Mode Params - Extensions for Custom Handlers API: https://html.spec.whatwg.org/multipage/system-state.html#rph-automation setRPHRegistrationMode
- SetRph
Registration Mode Params Builder - SetRph
Registration Mode Returns - Extensions for Custom Handlers API: https://html.spec.whatwg.org/multipage/system-state.html#rph-automation setRPHRegistrationMode
- SetSpc
Transaction Mode Params - Sets the Secure Payment Confirmation transaction mode. https://w3c.github.io/secure-payment-confirmation/#sctn-automation-set-spc-transaction-mode setSPCTransactionMode
- SetSpc
Transaction Mode Params Builder - SetSpc
Transaction Mode Returns - Sets the Secure Payment Confirmation transaction mode. https://w3c.github.io/secure-payment-confirmation/#sctn-automation-set-spc-transaction-mode setSPCTransactionMode
- SetWeb
Lifecycle State Params - 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/ setWebLifecycleState
- SetWeb
Lifecycle State Params Builder - SetWeb
Lifecycle State Returns - 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/ setWebLifecycleState
- Share
Target - Share
Target Builder - Shortcut
- Shortcut
Builder - Start
Screencast Params - Starts sending each frame using the
screencastFrameevent. startScreencast - Start
Screencast Params Builder - Start
Screencast Returns - Starts sending each frame using the
screencastFrameevent. startScreencast - Stop
Loading Params - Force the page stop all navigations and pending resource fetches. stopLoading
- Stop
Loading Returns - Force the page stop all navigations and pending resource fetches. stopLoading
- Stop
Screencast Params - Stops sending each frame in the
screencastFrame. stopScreencast - Stop
Screencast Returns - Stops sending each frame in the
screencastFrame. stopScreencast - Viewport
- Viewport for capturing screenshot. Viewport
- Viewport
Builder - Visual
Viewport - Visual viewport position, dimensions, and scale. VisualViewport
- Visual
Viewport Builder - Wait
ForDebugger Params - Pauses page execution. Can be resumed using generic Runtime.runIfWaitingForDebugger. waitForDebugger
- Wait
ForDebugger Returns - Pauses page execution. Can be resumed using generic Runtime.runIfWaitingForDebugger. waitForDebugger
- WebApp
Manifest - WebApp
Manifest Builder
Enums§
- AdFrame
Explanation - AdFrame
Type - Indicates whether a frame has been identified as an ad.
- Auto
Response Mode - Enum of possible auto-response for permission / prompt dialogs.
- Back
Forward Cache NotRestored Reason - List of not restored reasons for back-forward cache.
- Back
Forward Cache NotRestored Reason Type - Types of not restored reasons for back-forward cache.
- Capture
Screenshot Format - Image compression format (defaults to png).
- Capture
Snapshot Format - Format (defaults to mhtml).
- Client
Navigation Disposition - Client
Navigation Reason - Cross
Origin Isolated Context Type - Indicates whether the frame is cross-origin isolated and why it is the case.
- Dialog
Type - Javascript dialog type.
- File
Chooser Opened Mode - Input mode.
- Frame
Detached Reason - Gated
ApiFeatures - Navigated
Within Document Navigation Type - Navigation type
- Navigation
Type - The type of a frameNavigated event.
- Origin
Trial Status - Status for an Origin Trial.
- Origin
Trial Token Status - Origin Trial(https://www.chromium.org/blink/origin-trials) support. Status for an Origin Trial token.
- Origin
Trial Usage Restriction - Permissions
Policy Block Reason - Reason for a permissions policy feature to be disabled.
- Permissions
Policy Feature - All Permissions Policy features. This enum should match the one defined in third_party/blink/renderer/core/permissions_policy/permissions_policy_features.json5.
- Print
ToPdf Transfer Mode - return as stream
- Referrer
Policy - The referring-policy used for the navigation.
- Secure
Context Type - Indicates whether the frame is a secure context and why it is the case.
- SetWeb
Lifecycle State State - Target lifecycle state
- Start
Screencast Format - Image compression format.
- Transition
Type - Transition type.