Page Domain
Actions and events related to the inspected page belong to the page domain.
Methods
- Page.addScriptToEvaluateOnNewDocument
- Page.bringToFront
- Page.captureScreenshot
- Page.close
- Page.createIsolatedWorld
- Page.disable
- Page.enable
- Page.getAppManifest
- Page.getFrameTree
- Page.getLayoutMetrics
- Page.getNavigationHistory
- Page.handleJavaScriptDialog
- Page.navigate
- Page.navigateToHistoryEntry
- Page.printToPDF
- Page.reload
- Page.removeScriptToEvaluateOnNewDocument
- Page.resetNavigationHistory
- Page.setBypassCSP
- Page.setDocumentContent
- Page.setInterceptFileChooserDialog
- Page.setLifecycleEventsEnabled
- Page.stopLoading
- Page.clearGeolocationOverride Deprecated
- Page.setGeolocationOverride Deprecated
- Page.addCompilationCache Experimental
- Page.captureSnapshot Experimental
- Page.clearCompilationCache Experimental
- Page.crash Experimental
- Page.generateTestReport Experimental
- Page.getAdScriptId Experimental
- Page.getAppId Experimental
- Page.getInstallabilityErrors Experimental
- Page.getOriginTrials Experimental
- Page.getPermissionsPolicyState Experimental
- Page.getResourceContent Experimental
- Page.getResourceTree Experimental
- Page.produceCompilationCache Experimental
- Page.screencastFrameAck Experimental
- Page.searchInResource Experimental
- Page.setAdBlockingEnabled Experimental
- Page.setFontFamilies Experimental
- Page.setFontSizes Experimental
- Page.setPrerenderingAllowed Experimental
- Page.setRPHRegistrationMode Experimental
- Page.setSPCTransactionMode Experimental
- Page.setWebLifecycleState Experimental
- Page.startScreencast Experimental
- Page.stopScreencast Experimental
- Page.waitForDebugger Experimental
- Page.addScriptToEvaluateOnLoad ExperimentalDeprecated
- Page.clearDeviceMetricsOverride ExperimentalDeprecated
- Page.clearDeviceOrientationOverride ExperimentalDeprecated
- Page.deleteCookie ExperimentalDeprecated
- Page.getManifestIcons ExperimentalDeprecated
- Page.removeScriptToEvaluateOnLoad ExperimentalDeprecated
- Page.setDeviceMetricsOverride ExperimentalDeprecated
- Page.setDeviceOrientationOverride ExperimentalDeprecated
- Page.setDownloadBehavior ExperimentalDeprecated
- Page.setTouchEmulationEnabled ExperimentalDeprecated
Events
- Page.domContentEventFired
- Page.fileChooserOpened
- Page.frameAttached
- Page.frameDetached
- Page.frameNavigated
- Page.interstitialHidden
- Page.interstitialShown
- Page.javascriptDialogClosed
- Page.javascriptDialogOpening
- Page.lifecycleEvent
- Page.loadEventFired
- Page.windowOpen
- Page.frameClearedScheduledNavigation Deprecated
- Page.frameScheduledNavigation Deprecated
- Page.backForwardCacheNotUsed Experimental
- Page.compilationCacheProduced Experimental
- Page.documentOpened Experimental
- Page.frameRequestedNavigation Experimental
- Page.frameResized Experimental
- Page.frameStartedLoading Experimental
- Page.frameStoppedLoading Experimental
- Page.navigatedWithinDocument Experimental
- Page.screencastFrame Experimental
- Page.screencastVisibilityChanged Experimental
- Page.downloadProgress ExperimentalDeprecated
- Page.downloadWillBegin ExperimentalDeprecated
Types
- Page.AppManifestError
- Page.DialogType
- Page.Frame
- Page.FrameId
- Page.FrameTree
- Page.LayoutViewport
- Page.NavigationEntry
- Page.ScriptIdentifier
- Page.TransitionType
- Page.Viewport
- Page.VisualViewport
- Page.AdFrameExplanation Experimental
- Page.AdFrameStatus Experimental
- Page.AdFrameType Experimental
- Page.AdScriptId Experimental
- Page.AppManifestParsedProperties Experimental
- Page.AutoResponseMode Experimental
- Page.BackForwardCacheBlockingDetails Experimental
- Page.BackForwardCacheNotRestoredExplanation Experimental
- Page.BackForwardCacheNotRestoredExplanationTree Experimental
- Page.BackForwardCacheNotRestoredReason Experimental
- Page.BackForwardCacheNotRestoredReasonType Experimental
- Page.ClientNavigationDisposition Experimental
- Page.ClientNavigationReason Experimental
- Page.CompilationCacheParams Experimental
- Page.CrossOriginIsolatedContextType Experimental
- Page.FileFilter Experimental
- Page.FileHandler Experimental
- Page.FontFamilies Experimental
- Page.FontSizes Experimental
- Page.FrameResource Experimental
- Page.FrameResourceTree Experimental
- Page.GatedAPIFeatures Experimental
- Page.ImageResource Experimental
- Page.InstallabilityError Experimental
- Page.InstallabilityErrorArgument Experimental
- Page.LaunchHandler Experimental
- Page.NavigationType Experimental
- Page.OriginTrial Experimental
- Page.OriginTrialStatus Experimental
- Page.OriginTrialToken Experimental
- Page.OriginTrialTokenStatus Experimental
- Page.OriginTrialTokenWithStatus Experimental
- Page.OriginTrialUsageRestriction Experimental
- Page.PermissionsPolicyBlockLocator Experimental
- Page.PermissionsPolicyBlockReason Experimental
- Page.PermissionsPolicyFeature Experimental
- Page.PermissionsPolicyFeatureState Experimental
- Page.ProtocolHandler Experimental
- Page.ReferrerPolicy Experimental
- Page.RelatedApplication Experimental
- Page.ScopeExtension Experimental
- Page.ScreencastFrameMetadata Experimental
- Page.Screenshot Experimental
- Page.ScriptFontFamilies Experimental
- Page.SecureContextType Experimental
- Page.ShareTarget Experimental
- Page.Shortcut Experimental
- Page.WebAppManifest Experimental
Methods
Page.addScriptToEvaluateOnNewDocument #
Evaluates given script in every frame upon creation (before loading frame's scripts).
Parameters
source
string
worldName
Optional
string
If specified, creates an isolated world with the given name and evaluates given script in it. This world name will be used as the ExecutionContextDescription::name when the corresponding event is emitted.
includeCommandLineAPI
Optional
boolean
Specifies whether command line API should be available to the script, defaults to false.
runImmediately
Optional
boolean
If true, runs the script immediately on existing execution contexts or worlds. Default: false.
Return object
identifier
Identifier of the added script.
Page.captureScreenshot #
Capture page screenshot.
Parameters
format
Optional
string
Image compression format (defaults to png).
Allowed values: jpeg
, png
, webp
quality
Optional
integer
Compression quality from range [0..100] (jpeg only).
clip
Optional
Capture the screenshot of a given region only.
fromSurface
Optional
boolean
Capture the screenshot from the surface, rather than the view. Defaults to true.
captureBeyondViewport
Optional
boolean
Capture the screenshot beyond the viewport. Defaults to false.
optimizeForSpeed
Optional
boolean
Optimize image encoding for speed, not for resulting size (defaults to false)
Return object
data
string
Base64-encoded image data. (Encoded as a base64 string when passed over JSON)
Page.createIsolatedWorld #
Creates an isolated world for the given frame.
Parameters
frameId
Id of the frame in which the isolated world should be created.
worldName
Optional
string
An optional name which is reported in the Execution Context.
grantUniveralAccess
Optional
boolean
Whether or not universal access should be granted to the isolated world. This is a powerful option, use with caution.
Return object
executionContextId
Execution context of the isolated world.
Page.getAppManifest #
Gets the processed manifest for this current document. This API always waits for the manifest to be loaded. If manifestId is provided, and it does not match the manifest of the current document, this API errors out. If there is not a loaded page, this API errors out immediately.
Parameters
manifestId
Optional
string
Return object
url
string
Manifest location.
errors
array[ AppManifestError ]
data
Optional
string
Manifest content.
parsed
Optional
Parsed manifest properties. Deprecated, use manifest instead.
manifest
Page.getFrameTree #
Returns present frame tree structure.
Return object
frameTree
Present frame tree structure.
Page.getLayoutMetrics #
Returns metrics relating to the layouting of the page, such as viewport bounds/scale.
Return object
layoutViewport
Deprecated metrics relating to the layout viewport. Is in device pixels. Use cssLayoutViewport
instead.
visualViewport
Deprecated metrics relating to the visual viewport. Is in device pixels. Use cssVisualViewport
instead.
contentSize
cssLayoutViewport
Metrics relating to the layout viewport in CSS pixels.
cssVisualViewport
Metrics relating to the visual viewport in CSS pixels.
cssContentSize
Size of scrollable area in CSS pixels.
Page.getNavigationHistory #
Returns navigation history for the current page.
Return object
currentIndex
integer
Index of the current navigation history entry.
entries
array[ NavigationEntry ]
Array of navigation history entries.
Page.handleJavaScriptDialog #
Accepts or dismisses a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload).
Parameters
accept
boolean
Whether to accept or dismiss the dialog.
promptText
Optional
string
The text to enter into the dialog prompt before accepting. Used only if this is a prompt dialog.
Page.navigate #
Navigates current page to the given URL.
Parameters
url
string
URL to navigate the page to.
referrer
Optional
string
Referrer URL.
transitionType
Optional
Intended transition type.
frameId
Optional
Frame id to navigate, if not specified navigates the top frame.
referrerPolicy
Optional
Return object
frameId
Frame id that has navigated (or failed to navigate)
loaderId
Optional
Loader identifier. This is omitted in case of same-document navigation, as the previously committed loaderId would not change.
errorText
Optional
string
User friendly error message, present if and only if navigation has failed.
Page.navigateToHistoryEntry #
Navigates current page to the given history entry.
Parameters
entryId
integer
Unique id of the entry to navigate to.
Page.printToPDF #
Print page as PDF.
Parameters
landscape
Optional
boolean
Paper orientation. Defaults to false.
displayHeaderFooter
Optional
boolean
Display header and footer. Defaults to false.
printBackground
Optional
boolean
Print background graphics. Defaults to false.
scale
Optional
number
Scale of the webpage rendering. Defaults to 1.
paperWidth
Optional
number
Paper width in inches. Defaults to 8.5 inches.
paperHeight
Optional
number
Paper height in inches. Defaults to 11 inches.
marginTop
Optional
number
Top margin in inches. Defaults to 1cm (~0.4 inches).
marginBottom
Optional
number
Bottom margin in inches. Defaults to 1cm (~0.4 inches).
marginLeft
Optional
number
Left margin in inches. Defaults to 1cm (~0.4 inches).
marginRight
Optional
number
Right margin in inches. Defaults to 1cm (~0.4 inches).
pageRanges
Optional
string
Paper ranges to print, one based, e.g., '1-5, 8, 11-13'. Pages are printed in the document order, not in the order specified, and no more than once. Defaults to empty string, which implies the entire document is printed. The page numbers are quietly capped to actual page count of the document, and ranges beyond the end of the document are ignored. If this results in no pages to print, an error is reported. It is an error to specify a range with start greater than end.
headerTemplate
Optional
string
HTML template for the print header. Should be valid HTML markup with following classes used to inject printing values into them:
date
: formatted print datetitle
: document titleurl
: document locationpageNumber
: current page numbertotalPages
: total pages in the document
For example, <span class=title></span>
would generate span containing the title.
footerTemplate
Optional
string
HTML template for the print footer. Should use the same format as the headerTemplate
.
preferCSSPageSize
Optional
boolean
Whether or not to prefer page size as defined by css. Defaults to false, in which case the content will be scaled to fit the paper size.
transferMode
Optional
string
return as stream
Allowed values: ReturnAsBase64
, ReturnAsStream
generateTaggedPDF
Optional
boolean
Whether or not to generate tagged (accessible) PDF. Defaults to embedder choice.
generateDocumentOutline
Optional
boolean
Whether or not to embed the document outline into the PDF.
Return object
data
string
Base64-encoded pdf data. Empty if |returnAsStream| is specified. (Encoded as a base64 string when passed over JSON)
stream
Optional
Page.reload #
Reloads given page optionally ignoring the cache.
It isn't clear what the ignoreCache parameter of @cdp Page.reload should mean in React Native. We parse it, but don't do anything with it yet.
TODO: Implement scriptToEvaluateOnLoad parameter of @cdp Page.reload.
Parameters
ignoreCache
Optional
boolean
If true, browser cache is ignored (as if the user pressed Shift+refresh).
scriptToEvaluateOnLoad
Optional
string
If set, the script will be injected into all frames of the inspected page after reload. Argument will be ignored if reloading dataURL origin.
loaderId
Optional
If set, an error will be thrown if the target page's main frame's loader id does not match the provided id. This prevents accidentally reloading an unintended target in case there's a racing navigation.
Page.setBypassCSP #
Enable page Content Security Policy by-passing.
Parameters
enabled
boolean
Whether to bypass page CSP.
Page.setDocumentContent #
Sets given markup as the document's HTML.
Parameters
frameId
Frame id to set HTML for.
html
string
HTML content to set.
Page.setInterceptFileChooserDialog #
Intercept file chooser requests and transfer control to protocol clients.
When file chooser interception is enabled, native file chooser dialog is not shown.
Instead, a protocol event Page.fileChooserOpened
is emitted.
Parameters
enabled
boolean
Page.setLifecycleEventsEnabled #
Controls whether page will emit lifecycle events.
Parameters
enabled
boolean
If true, starts emitting lifecycle events.
Page.setGeolocationOverride Deprecated#
Overrides the Geolocation Position or Error. Omitting any of the parameters emulates position unavailable.
Parameters
latitude
Optional
number
Mock latitude
longitude
Optional
number
Mock longitude
accuracy
Optional
number
Mock accuracy
Page.addCompilationCache Experimental#
Seeds compilation cache for given url. Compilation cache does not survive cross-process navigation.
Parameters
url
string
data
string
Base64-encoded data (Encoded as a base64 string when passed over JSON)
Page.captureSnapshot 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.
Parameters
format
Optional
string
Format (defaults to mhtml).
Allowed values: mhtml
Return object
data
string
Serialized page data.
Page.generateTestReport Experimental#
Generates a report for testing.
Parameters
message
string
Message to be displayed in the report.
group
Optional
string
Specifies the endpoint group to deliver the report to.
Page.getAdScriptId Experimental#
Parameters
frameId
Return object
adScriptId
Optional
Identifies the bottom-most script which caused the frame to be labelled as an ad. Only sent if frame is labelled as an ad and id is available.
Page.getAppId Experimental#
Returns the unique (PWA) app id. Only returns values if the feature flag 'WebAppEnableManifestId' is enabled
Return object
appId
Optional
string
App id, either from manifest's id attribute or computed from start_url
recommendedId
Optional
string
Recommendation for manifest's id attribute to match current id computed from start_url
Page.getInstallabilityErrors Experimental#
Return object
installabilityErrors
array[ InstallabilityError ]
Page.getOriginTrials Experimental#
Get Origin Trials on given frame.
Parameters
frameId
Return object
originTrials
array[ OriginTrial ]
Page.getPermissionsPolicyState Experimental#
Get Permissions Policy state on given frame.
Parameters
frameId
Return object
states
array[ PermissionsPolicyFeatureState ]
Page.getResourceContent Experimental#
Returns content of the given resource.
Parameters
frameId
Frame id to get resource for.
url
string
URL of the resource to get content for.
Return object
content
string
Resource content.
base64Encoded
boolean
True, if content was served as base64.
Page.getResourceTree Experimental#
Returns present frame / resource tree structure.
Return object
frameTree
Present frame / resource tree structure.
Page.produceCompilationCache Experimental#
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
.
Parameters
scripts
array[ CompilationCacheParams ]
Page.screencastFrameAck Experimental#
Acknowledges that a screencast frame has been received by the frontend.
Parameters
sessionId
integer
Frame number.
Page.searchInResource Experimental#
Searches for given string in resource content.
Parameters
frameId
Frame id for resource to search in.
url
string
URL of the resource to search in.
query
string
String to search for.
caseSensitive
Optional
boolean
If true, search is case sensitive.
isRegex
Optional
boolean
If true, treats string parameter as regex.
Return object
result
array[ Debugger.SearchMatch ]
List of search matches.
Page.setAdBlockingEnabled Experimental#
Enable Chrome's experimental ad filter on all sites.
Parameters
enabled
boolean
Whether to block ads.
Page.setFontFamilies Experimental#
Set generic font families.
Parameters
fontFamilies
Specifies font families to set. If a font family is not specified, it won't be changed.
forScripts
Optional
array[ ScriptFontFamilies ]
Specifies font families to set for individual scripts.
Page.setFontSizes Experimental#
Set default font sizes.
Parameters
fontSizes
Specifies font sizes to set. If a font size is not specified, it won't be changed.
Page.setPrerenderingAllowed Experimental#
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.
Parameters
isAllowed
boolean
Page.setRPHRegistrationMode Experimental#
Extensions for Custom Handlers API: https://html.spec.whatwg.org/multipage/system-state.html#rph-automation
Parameters
mode
Page.setSPCTransactionMode Experimental#
Sets the Secure Payment Confirmation transaction mode. https://w3c.github.io/secure-payment-confirmation/#sctn-automation-set-spc-transaction-mode
Parameters
mode
Page.setWebLifecycleState 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/
Parameters
state
string
Target lifecycle state
Allowed values: frozen
, active
Page.startScreencast Experimental#
Starts sending each frame using the screencastFrame
event.
Parameters
format
Optional
string
Image compression format.
Allowed values: jpeg
, png
quality
Optional
integer
Compression quality from range [0..100].
maxWidth
Optional
integer
Maximum screenshot width.
maxHeight
Optional
integer
Maximum screenshot height.
everyNthFrame
Optional
integer
Send every n-th frame.
Page.waitForDebugger Experimental#
Pauses page execution. Can be resumed using generic Runtime.runIfWaitingForDebugger.
Page.addScriptToEvaluateOnLoad ExperimentalDeprecated#
Deprecated, please use addScriptToEvaluateOnNewDocument instead.
Parameters
scriptSource
string
Return object
identifier
Identifier of the added script.
Page.clearDeviceOrientationOverride ExperimentalDeprecated#
Clears the overridden Device Orientation.
Page.deleteCookie ExperimentalDeprecated#
Deletes browser cookie with given name, domain and path.
Parameters
cookieName
string
Name of the cookie to remove.
url
string
URL to match cooke domain and path.
Page.getManifestIcons ExperimentalDeprecated#
Deprecated because it's not guaranteed that the returned icon is in fact the one used for PWA installation.
Return object
primaryIcon
Optional
string
Page.removeScriptToEvaluateOnLoad ExperimentalDeprecated#
Deprecated, please use removeScriptToEvaluateOnNewDocument instead.
Parameters
identifier
Page.setDeviceMetricsOverride ExperimentalDeprecated#
Overrides the values of device screen dimensions (window.screen.width, window.screen.height, window.innerWidth, window.innerHeight, and "device-width"/"device-height"-related CSS media query results).
Parameters
width
integer
Overriding width value in pixels (minimum 0, maximum 10000000). 0 disables the override.
height
integer
Overriding height value in pixels (minimum 0, maximum 10000000). 0 disables the override.
deviceScaleFactor
number
Overriding device scale factor value. 0 disables the override.
mobile
boolean
Whether to emulate mobile device. This includes viewport meta tag, overlay scrollbars, text autosizing and more.
scale
Optional
number
Scale to apply to resulting view image.
screenWidth
Optional
integer
Overriding screen width value in pixels (minimum 0, maximum 10000000).
screenHeight
Optional
integer
Overriding screen height value in pixels (minimum 0, maximum 10000000).
positionX
Optional
integer
Overriding view X position on screen in pixels (minimum 0, maximum 10000000).
positionY
Optional
integer
Overriding view Y position on screen in pixels (minimum 0, maximum 10000000).
dontSetVisibleSize
Optional
boolean
Do not set visible view size, rely upon explicit setVisibleSize call.
screenOrientation
Optional
Screen orientation override.
viewport
Optional
The viewport dimensions and scale. If not set, the override is cleared.
Page.setDeviceOrientationOverride ExperimentalDeprecated#
Overrides the Device Orientation.
Parameters
alpha
number
Mock alpha
beta
number
Mock beta
gamma
number
Mock gamma
Page.setDownloadBehavior ExperimentalDeprecated#
Set the behavior when downloading a file.
Parameters
behavior
string
Whether to allow all or deny all download requests, or use default Chrome behavior if available (otherwise deny).
Allowed values: deny
, allow
, default
downloadPath
Optional
string
The default path to save downloaded files to. This is required if behavior is set to 'allow'
Page.setTouchEmulationEnabled ExperimentalDeprecated#
Toggles mouse event-based touch event emulation.
Parameters
enabled
boolean
Whether the touch event emulation should be enabled.
configuration
Optional
string
Touch/gesture events configuration. Default: current platform.
Allowed values: mobile
, desktop
Events
Page.fileChooserOpened #
Emitted only when page.interceptFileChooser
is enabled.
Parameters
frameId
mode
string
Input mode.
Allowed values: selectSingle
, selectMultiple
backendNodeId
Optional
Input node id. Only present for file choosers opened via an <input type="file">
element.
Page.frameAttached #
Fired when frame has been attached to its parent.
Parameters
frameId
Id of the frame that has been attached.
parentFrameId
Parent frame identifier.
stack
Optional
JavaScript stack trace of when frame was attached, only set if frame initiated from script.
Page.frameDetached #
Fired when frame has been detached from its parent.
Parameters
frameId
Id of the frame that has been detached.
reason
string
Allowed values: remove
, swap
Page.frameNavigated #
Fired once navigation of the frame has completed. Frame is now associated with the new loader.
Parameters
frame
Frame object.
type
Page.javascriptDialogClosed #
Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) has been closed.
Parameters
result
boolean
Whether dialog was confirmed.
userInput
string
User input in case of prompt.
Page.javascriptDialogOpening #
Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) is about to open.
Parameters
url
string
Frame url.
message
string
Message that will be displayed by the dialog.
type
Dialog type.
hasBrowserHandler
boolean
True iff browser is capable showing or acting on the given dialog. When browser has no dialog handler for given target, calling alert while Page domain is engaged will stall the page execution. Execution can be resumed via calling Page.handleJavaScriptDialog.
defaultPrompt
Optional
string
Default dialog prompt.
Page.lifecycleEvent #
Fired for top level page lifecycle events such as navigation, load, paint, etc.
Parameters
frameId
Id of the frame.
loaderId
Loader identifier. Empty string if the request is fetched from worker.
name
string
timestamp
Page.windowOpen #
Fired when a new window is going to be opened, via window.open(), link click, form submission, etc.
Parameters
url
string
The URL for the new window.
windowName
string
Window name.
windowFeatures
array[ string
]
An array of enabled window features.
userGesture
boolean
Whether or not it was triggered by user gesture.
Page.frameClearedScheduledNavigation Deprecated#
Fired when frame no longer has a scheduled navigation.
Parameters
frameId
Id of the frame that has cleared its scheduled navigation.
Page.frameScheduledNavigation Deprecated#
Fired when frame schedules a potential navigation.
Parameters
frameId
Id of the frame that has scheduled a navigation.
delay
number
Delay (in seconds) until the navigation is scheduled to begin. The navigation is not guaranteed to start.
reason
The reason for the navigation.
url
string
The destination URL for the scheduled navigation.
Page.backForwardCacheNotUsed Experimental#
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.
Parameters
loaderId
The loader id for the associated navigation.
frameId
The frame id of the associated frame.
notRestoredExplanations
array[ BackForwardCacheNotRestoredExplanation ]
Array of reasons why the page could not be cached. This must not be empty.
notRestoredExplanationsTree
Optional
Tree structure of reasons why the page could not be cached for each frame.
Page.compilationCacheProduced Experimental#
Issued for every compilation cache generated. Is only available if Page.setGenerateCompilationCache is enabled.
Parameters
url
string
data
string
Base64-encoded data (Encoded as a base64 string when passed over JSON)
Page.documentOpened Experimental#
Fired when opening document to write to.
Parameters
frame
Frame object.
Page.frameRequestedNavigation Experimental#
Fired when a renderer-initiated navigation is requested. Navigation may still be cancelled after the event is issued.
Parameters
frameId
Id of the frame that is being navigated.
reason
The reason for the navigation.
url
string
The destination URL for the requested navigation.
disposition
The disposition for the navigation.
Page.frameStartedLoading Experimental#
Fired when frame has started loading.
Parameters
frameId
Id of the frame that has started loading.
Page.frameStoppedLoading Experimental#
Fired when frame has stopped loading.
Parameters
frameId
Id of the frame that has stopped loading.
Page.navigatedWithinDocument Experimental#
Fired when same-document navigation happens, e.g. due to history API usage or anchor navigation.
Parameters
frameId
Id of the frame.
url
string
Frame's new url.
Page.screencastFrame Experimental#
Compressed image data requested by the startScreencast
.
Parameters
data
string
Base64-encoded compressed image. (Encoded as a base64 string when passed over JSON)
metadata
Screencast frame metadata.
sessionId
integer
Frame number.
Page.screencastVisibilityChanged Experimental#
Fired when the page with currently enabled screencast was shown or hidden `.
Parameters
visible
boolean
True if the page is visible.
Page.downloadProgress ExperimentalDeprecated#
Fired when download makes progress. Last call has |done| == true. Deprecated. Use Browser.downloadProgress instead.
Parameters
guid
string
Global unique identifier of the download.
totalBytes
number
Total expected bytes to download.
receivedBytes
number
Total bytes received.
state
string
Download status.
Allowed values: inProgress
, completed
, canceled
Page.downloadWillBegin ExperimentalDeprecated#
Fired when page is about to start a download. Deprecated. Use Browser.downloadWillBegin instead.
Parameters
frameId
Id of the frame that caused download to begin.
guid
string
Global unique identifier of the download.
url
string
URL of the resource being downloaded.
suggestedFilename
string
Suggested file name of the resource (the actual name of the file saved on disk may differ).
Types
Page.AppManifestError #
Error while paring app manifest.
Type: object
Properties
message
string
Error message.
critical
integer
If critical, this is a non-recoverable parse error.
line
integer
Error line.
column
integer
Error column.
Page.DialogType #
Javascript dialog type.
Type: string
Allowed values: alert
, confirm
, prompt
, beforeunload
Page.Frame #
Information about the Frame on the page.
Type: object
Properties
id
Frame unique identifier.
parentId
Optional
Parent frame identifier.
loaderId
Identifier of the loader associated with this frame.
name
Optional
string
Frame's name as specified in the tag.
url
string
Frame document's URL without fragment.
urlFragment
Optional
string
Frame document's URL fragment including the '#'.
domainAndRegistry
string
Frame document's registered domain, taking the public suffixes list into account. Extracted from the Frame's url. Example URLs: http://www.google.com/file.html -> "google.com" http://a.b.co.uk/file.html -> "b.co.uk"
securityOrigin
string
Frame document's security origin.
mimeType
string
Frame document's mimeType as determined by the browser.
unreachableUrl
Optional
string
If the frame failed to load, this contains the URL that could not be loaded. Note that unlike url above, this URL may contain a fragment.
adFrameStatus
Optional
secureContextType
Indicates whether the main document is a secure context and explains why that is the case.
crossOriginIsolatedContextType
Indicates whether this is a cross origin isolated context.
gatedAPIFeatures
Page.FrameTree #
Information about the Frame hierarchy.
Type: object
Properties
frame
Frame information for this tree item.
childFrames
Optional
array[ FrameTree ]
Child frames.
Page.LayoutViewport #
Layout viewport position and dimensions.
Type: object
Properties
pageX
integer
Horizontal offset relative to the document (CSS pixels).
pageY
integer
Vertical offset relative to the document (CSS pixels).
clientWidth
integer
Width (CSS pixels), excludes scrollbar if present.
clientHeight
integer
Height (CSS pixels), excludes scrollbar if present.
Page.NavigationEntry #
Navigation history entry.
Type: object
Properties
id
integer
Unique id of the navigation history entry.
url
string
URL of the navigation history entry.
userTypedURL
string
URL that the user typed in the url bar.
title
string
Title of the navigation history entry.
transitionType
Transition type.
Page.TransitionType #
Transition type.
Type: string
Allowed values: link
, typed
, address_bar
, auto_bookmark
, auto_subframe
, manual_subframe
, generated
, auto_toplevel
, form_submit
, reload
, keyword
, keyword_generated
, other
Page.Viewport #
Viewport for capturing screenshot.
Type: object
Properties
x
number
X offset in device independent pixels (dip).
y
number
Y offset in device independent pixels (dip).
width
number
Rectangle width in device independent pixels (dip).
height
number
Rectangle height in device independent pixels (dip).
scale
number
Page scale factor.
Page.VisualViewport #
Visual viewport position, dimensions, and scale.
Type: object
Properties
offsetX
number
Horizontal offset relative to the layout viewport (CSS pixels).
offsetY
number
Vertical offset relative to the layout viewport (CSS pixels).
pageX
number
Horizontal offset relative to the document (CSS pixels).
pageY
number
Vertical offset relative to the document (CSS pixels).
clientWidth
number
Width (CSS pixels), excludes scrollbar if present.
clientHeight
number
Height (CSS pixels), excludes scrollbar if present.
scale
number
Scale relative to the ideal viewport (size at width=device-width).
zoom
Optional
number
Page zoom factor (CSS to device independent pixels ratio).
Page.AdFrameExplanation Experimental#
Type: string
Allowed values: ParentIsAd
, CreatedByAdScript
, MatchedBlockingRule
Page.AdFrameStatus Experimental#
Indicates whether a frame has been identified as an ad and why.
Type: object
Properties
adFrameType
explanations
Optional
array[ AdFrameExplanation ]
Page.AdFrameType Experimental#
Indicates whether a frame has been identified as an ad.
Type: string
Allowed values: none
, child
, root
Page.AdScriptId Experimental#
Identifies the bottom-most script which caused the frame to be labelled as an ad.
Type: object
Properties
scriptId
Script Id of the bottom-most script which caused the frame to be labelled as an ad.
debuggerId
Id of adScriptId's debugger.
Page.AppManifestParsedProperties Experimental#
Parsed app manifest properties.
Type: object
Properties
scope
string
Computed scope value
Page.AutoResponseMode Experimental#
Enum of possible auto-response for permission / prompt dialogs.
Type: string
Allowed values: none
, autoAccept
, autoReject
, autoOptOut
Page.BackForwardCacheBlockingDetails Experimental#
Type: object
Properties
url
Optional
string
Url of the file where blockage happened. Optional because of tests.
function
Optional
string
Function name where blockage happened. Optional because of anonymous functions and tests.
lineNumber
integer
Line number in the script (0-based).
columnNumber
integer
Column number in the script (0-based).
Page.BackForwardCacheNotRestoredExplanation Experimental#
Type: object
Properties
type
Type of the reason
reason
Not restored reason
context
Optional
string
Context associated with the reason. The meaning of this context is dependent on the reason:
- EmbedderExtensionSentMessageToCachedFrame: the extension ID.
details
Optional
array[ BackForwardCacheBlockingDetails ]
Page.BackForwardCacheNotRestoredExplanationTree Experimental#
Type: object
Properties
url
string
URL of each frame
explanations
array[ BackForwardCacheNotRestoredExplanation ]
Not restored reasons of each frame
children
array[ BackForwardCacheNotRestoredExplanationTree ]
Array of children frame
Page.BackForwardCacheNotRestoredReason Experimental#
List of not restored reasons for back-forward cache.
Type: string
Allowed values: NotPrimaryMainFrame
, BackForwardCacheDisabled
, RelatedActiveContentsExist
, HTTPStatusNotOK
, SchemeNotHTTPOrHTTPS
, Loading
, 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
, BroadcastChannelOnMessage
, WebViewSettingsChanged
, WebViewJavaScriptObjectChanged
, WebViewMessageListenerInjected
, WebViewSafeBrowsingAllowlistChanged
, WebViewDocumentStartJavascriptChanged
, 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
, RequestedByWebViewClient
Page.BackForwardCacheNotRestoredReasonType Experimental#
Types of not restored reasons for back-forward cache.
Type: string
Allowed values: SupportPending
, PageSupportNeeded
, Circumstantial
Page.ClientNavigationDisposition Experimental#
Type: string
Allowed values: currentTab
, newTab
, newWindow
, download
Page.ClientNavigationReason Experimental#
Type: string
Allowed values: formSubmissionGet
, formSubmissionPost
, httpHeaderRefresh
, scriptInitiated
, metaTagRefresh
, pageBlockInterstitial
, reload
, anchorClick
Page.CompilationCacheParams Experimental#
Per-script compilation cache parameters for Page.produceCompilationCache
Type: object
Properties
url
string
The URL of the script to produce a compilation cache entry for.
eager
Optional
boolean
A hint to the backend whether eager compilation is recommended. (the actual compilation mode used is upon backend discretion).
Page.CrossOriginIsolatedContextType Experimental#
Indicates whether the frame is cross-origin isolated and why it is the case.
Type: string
Allowed values: Isolated
, NotIsolated
, NotIsolatedFeatureDisabled
Page.FileFilter Experimental#
Type: object
Properties
name
Optional
string
accepts
Optional
array[ string
]
Page.FileHandler Experimental#
Type: object
Properties
action
string
name
string
icons
Optional
array[ ImageResource ]
accepts
Optional
array[ FileFilter ]
Mimic a map, name is the key, accepts is the value.
launchType
string
Won't repeat the enums, using string for easy comparison. Same as the other enums below.
Page.FontFamilies Experimental#
Generic font families collection.
Type: object
Properties
standard
Optional
string
The standard font-family.
fixed
Optional
string
The fixed font-family.
serif
Optional
string
The serif font-family.
sansSerif
Optional
string
The sansSerif font-family.
cursive
Optional
string
The cursive font-family.
fantasy
Optional
string
The fantasy font-family.
math
Optional
string
The math font-family.
Page.FontSizes Experimental#
Default font sizes.
Type: object
Properties
standard
Optional
integer
Default standard font size.
fixed
Optional
integer
Default fixed font size.
Page.FrameResource Experimental#
Information about the Resource on the page.
Type: object
Properties
url
string
Resource URL.
type
Type of this resource.
mimeType
string
Resource mimeType as determined by the browser.
lastModified
Optional
last-modified timestamp as reported by server.
contentSize
Optional
number
Resource content size.
failed
Optional
boolean
True if the resource failed to load.
canceled
Optional
boolean
True if the resource was canceled during loading.
Page.FrameResourceTree Experimental#
Information about the Frame hierarchy along with their cached resources.
Type: object
Properties
frame
Frame information for this tree item.
childFrames
Optional
array[ FrameResourceTree ]
Child frames.
resources
array[ FrameResource ]
Information about frame resources.
Page.GatedAPIFeatures Experimental#
Type: string
Allowed values: SharedArrayBuffers
, SharedArrayBuffersTransferAllowed
, PerformanceMeasureMemory
, PerformanceProfile
Page.ImageResource Experimental#
The image definition used in both icon and screenshot.
Type: object
Properties
url
string
The src field in the definition, but changing to url in favor of consistency.
sizes
Optional
string
type
Optional
string
Page.InstallabilityError Experimental#
The installability error
Type: object
Properties
errorId
string
The error id (e.g. 'manifest-missing-suitable-icon').
errorArguments
array[ InstallabilityErrorArgument ]
The list of error arguments (e.g. {name:'minimum-icon-size-in-pixels', value:'64'}).
Page.InstallabilityErrorArgument Experimental#
Type: object
Properties
name
string
Argument name (e.g. name:'minimum-icon-size-in-pixels').
value
string
Argument value (e.g. value:'64').
Page.NavigationType Experimental#
The type of a frameNavigated event.
Type: string
Allowed values: Navigation
, BackForwardCacheRestore
Page.OriginTrial Experimental#
Type: object
Properties
trialName
string
status
tokensWithStatus
array[ OriginTrialTokenWithStatus ]
Page.OriginTrialStatus Experimental#
Status for an Origin Trial.
Type: string
Allowed values: Enabled
, ValidTokenNotProvided
, OSNotSupported
, TrialNotAllowed
Page.OriginTrialToken Experimental#
Type: object
Properties
origin
string
matchSubDomains
boolean
trialName
string
expiryTime
isThirdParty
boolean
usageRestriction
Page.OriginTrialTokenStatus Experimental#
Origin Trial(https://www.chromium.org/blink/origin-trials) support. Status for an Origin Trial token.
Type: string
Allowed values: Success
, NotSupported
, Insecure
, Expired
, WrongOrigin
, InvalidSignature
, Malformed
, WrongVersion
, FeatureDisabled
, TokenDisabled
, FeatureDisabledForUser
, UnknownTrial
Page.OriginTrialTokenWithStatus Experimental#
Type: object
Properties
rawTokenText
string
parsedToken
Optional
parsedToken
is present only when the token is extractable and
parsable.
status
Page.PermissionsPolicyBlockReason Experimental#
Reason for a permissions policy feature to be disabled.
Type: string
Allowed values: Header
, IframeAttribute
, InFencedFrameTree
, InIsolatedApp
Page.PermissionsPolicyFeature Experimental#
All Permissions Policy features. This enum should match the one defined in third_party/blink/renderer/core/permissions_policy/permissions_policy_features.json5.
Type: string
Allowed values: 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-factors
, 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
, deferred-fetch
, 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
, xr-spatial-tracking
Page.PermissionsPolicyFeatureState Experimental#
Type: object
Properties
feature
allowed
boolean
locator
Optional
Page.ReferrerPolicy Experimental#
The referring-policy used for the navigation.
Type: string
Allowed values: noReferrer
, noReferrerWhenDowngrade
, origin
, originWhenCrossOrigin
, sameOrigin
, strictOrigin
, strictOriginWhenCrossOrigin
, unsafeUrl
Page.ScopeExtension Experimental#
Type: object
Properties
origin
string
Instead of using tuple, this field always returns the serialized string for easy understanding and comparison.
hasOriginWildcard
boolean
Page.ScreencastFrameMetadata Experimental#
Screencast frame metadata.
Type: object
Properties
offsetTop
number
Top offset in DIP.
pageScaleFactor
number
Page scale factor.
deviceWidth
number
Device screen width in DIP.
deviceHeight
number
Device screen height in DIP.
scrollOffsetX
number
Position of horizontal scroll in CSS pixels.
scrollOffsetY
number
Position of vertical scroll in CSS pixels.
timestamp
Optional
Frame swap timestamp.
Page.ScriptFontFamilies Experimental#
Font families collection for a script.
Type: object
Properties
script
string
Name of the script which these font families are defined for.
fontFamilies
Generic font families collection for the script.
Page.SecureContextType Experimental#
Indicates whether the frame is a secure context and why it is the case.
Type: string
Allowed values: Secure
, SecureLocalhost
, InsecureScheme
, InsecureAncestor
Page.ShareTarget Experimental#
Type: object
Properties
action
string
method
string
enctype
string
title
Optional
string
Embed the ShareTargetParams
text
Optional
string
url
Optional
string
files
Optional
array[ FileFilter ]
Page.WebAppManifest Experimental#
Type: object
Properties
backgroundColor
Optional
string
description
Optional
string
The extra description provided by the manifest.
dir
Optional
string
display
Optional
string
displayOverrides
Optional
array[ string
]
The overrided display mode controlled by the user.
fileHandlers
Optional
array[ FileHandler ]
The handlers to open files.
icons
Optional
array[ ImageResource ]
id
Optional
string
lang
Optional
string
launchHandler
Optional
TODO(crbug.com/1231886): This field is non-standard and part of a Chrome experiment. See: https://github.com/WICG/web-app-launch/blob/main/launch_handler.md
name
Optional
string
orientation
Optional
string
preferRelatedApplications
Optional
boolean
protocolHandlers
Optional
array[ ProtocolHandler ]
The handlers to open protocols.
relatedApplications
Optional
array[ RelatedApplication ]
scope
Optional
string
scopeExtensions
Optional
array[ ScopeExtension ]
Non-standard, see https://github.com/WICG/manifest-incubations/blob/gh-pages/scope_extensions-explainer.md
screenshots
Optional
array[ Screenshot ]
The screenshots used by chromium.
shareTarget
Optional
shortName
Optional
string
shortcuts
Optional
array[ Shortcut ]
startUrl
Optional
string
themeColor
Optional
string