Namespace OpenQA.Selenium.DevTools.V146.Page

Classes

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

AdScriptAncestry: Encapsulates the script ancestry and the root script filterlist rule that caused the frame to be labelled as an ad. Only created when ancestryChain is not empty.

AdScriptId: Identifies the script which caused a script or frame to be labelled as an ad.

AddCompilationCacheCommandResponse: Response for Seeds compilation cache for given url. Compilation cache does not survive cross-process navigation.

AddCompilationCacheCommandSettings: Seeds compilation cache for given url. Compilation cache does not survive cross-process navigation.

AddScriptToEvaluateOnLoadCommandResponse: Response for Deprecated, please use addScriptToEvaluateOnNewDocument instead.

AddScriptToEvaluateOnLoadCommandSettings: Deprecated, please use addScriptToEvaluateOnNewDocument instead.

AddScriptToEvaluateOnNewDocumentCommandResponse: Response for Evaluates given script in every frame upon creation (before loading frame's scripts).

AddScriptToEvaluateOnNewDocumentCommandSettings: Evaluates given script in every frame upon creation (before loading frame's scripts).

AppManifestError: Error while paring app manifest.

AppManifestParsedProperties: Parsed app manifest properties.

BackForwardCacheBlockingDetails: BackForwardCacheBlockingDetails

BackForwardCacheNotRestoredExplanation: BackForwardCacheNotRestoredExplanation

BackForwardCacheNotRestoredExplanationTree: BackForwardCacheNotRestoredExplanationTree

BackForwardCacheNotUsedEventArgs: 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.

BringToFrontCommandResponse: Response for Brings page to front (activates tab).

BringToFrontCommandSettings: Brings page to front (activates tab).

CaptureScreenshotCommandResponse: Response for Capture page screenshot.

CaptureScreenshotCommandSettings: Capture page screenshot.

CaptureSnapshotCommandResponse: Response for Returns a snapshot of the page as a string. For MHTML format, the serialization includes iframes, shadow DOM, external resources, and element-inline styles.

CaptureSnapshotCommandSettings: Returns a snapshot of the page as a string. For MHTML format, the serialization includes iframes, shadow DOM, external resources, and element-inline styles.

ClearCompilationCacheCommandResponse: Response for Clears seeded compilation cache.

ClearCompilationCacheCommandSettings: Clears seeded compilation cache.

ClearDeviceMetricsOverrideCommandResponse: Response for Clears the overridden device metrics.

ClearDeviceMetricsOverrideCommandSettings: Clears the overridden device metrics.

ClearDeviceOrientationOverrideCommandResponse: Response for Clears the overridden Device Orientation.

ClearDeviceOrientationOverrideCommandSettings: Clears the overridden Device Orientation.

ClearGeolocationOverrideCommandResponse: Response for Clears the overridden Geolocation Position and Error.

ClearGeolocationOverrideCommandSettings: Clears the overridden Geolocation Position and Error.

CloseCommandResponse: Response for Tries to close page, running its beforeunload hooks, if any.

CloseCommandSettings: Tries to close page, running its beforeunload hooks, if any.

CompilationCacheParams: Per-script compilation cache parameters for Page.produceCompilationCache

CompilationCacheProducedEventArgs: Issued for every compilation cache generated.

CrashCommandResponse: Response for Crashes renderer on the IO thread, generates minidumps.

CrashCommandSettings: Crashes renderer on the IO thread, generates minidumps.

CreateIsolatedWorldCommandResponse: Response for Creates an isolated world for the given frame.

CreateIsolatedWorldCommandSettings: Creates an isolated world for the given frame.

DeleteCookieCommandResponse: Response for Deletes browser cookie with given name, domain and path.

DeleteCookieCommandSettings: Deletes browser cookie with given name, domain and path.

DisableCommandResponse: Response for Disables page domain notifications.

DisableCommandSettings: Disables page domain notifications.

DocumentOpenedEventArgs: Fired when opening document to write to.

DomContentEventFiredEventArgs: DomContentEventFired

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

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

EnableCommandResponse: Response for Enables page domain notifications.

EnableCommandSettings: Enables page domain notifications.

FileChooserOpenedEventArgs: Emitted only when page.interceptFileChooser is enabled.

FileFilter: FileFilter

FileHandler: FileHandler

FontFamilies: Generic font families collection.

FontSizes: Default font sizes.

Frame: Information about the Frame on the page.

FrameAttachedEventArgs: Fired when frame has been attached to its parent.

FrameClearedScheduledNavigationEventArgs: Fired when frame no longer has a scheduled navigation.

FrameDetachedEventArgs: Fired when frame has been detached from its parent.

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

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

FrameResizedEventArgs: FrameResized

FrameResource: Information about the Resource on the page.

FrameResourceTree: Information about the Frame hierarchy along with their cached resources.

FrameScheduledNavigationEventArgs: Fired when frame schedules a potential navigation.

FrameStartedLoadingEventArgs: Fired when frame has started loading.

FrameStartedNavigatingEventArgs: Fired when a navigation starts. This event is fired for both renderer-initiated and browser-initiated navigations. For renderer-initiated navigations, the event is fired after frameRequestedNavigation. Navigation may still be cancelled after the event is issued. Multiple events can be fired for a single navigation, for example, when a same-document navigation becomes a cross-document navigation (such as in the case of a frameset).

FrameStoppedLoadingEventArgs: Fired when frame has stopped loading.

FrameSubtreeWillBeDetachedEventArgs: Fired before frame subtree is detached. Emitted before any frame of the subtree is actually detached.

FrameTree: Information about the Frame hierarchy.

GenerateTestReportCommandResponse: Response for Generates a report for testing.

GenerateTestReportCommandSettings: Generates a report for testing.

GetAdScriptAncestryCommandResponse: Response for GetAdScriptAncestry

GetAdScriptAncestryCommandSettings: GetAdScriptAncestry

GetAnnotatedPageContentCommandResponse: Response for Get the annotated page content for the main frame. This is an experimental command that is subject to change.

GetAnnotatedPageContentCommandSettings: Get the annotated page content for the main frame. This is an experimental command that is subject to change.

GetAppIdCommandResponse: Response for Returns the unique (PWA) app id. Only returns values if the feature flag 'WebAppEnableManifestId' is enabled

GetAppIdCommandSettings: Returns the unique (PWA) app id. Only returns values if the feature flag 'WebAppEnableManifestId' is enabled

GetAppManifestCommandResponse: Response for 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.

GetAppManifestCommandSettings: 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.

GetFrameTreeCommandResponse: Response for Returns present frame tree structure.

GetFrameTreeCommandSettings: Returns present frame tree structure.

GetInstallabilityErrorsCommandResponse: Response for GetInstallabilityErrors

GetInstallabilityErrorsCommandSettings: GetInstallabilityErrors

GetLayoutMetricsCommandResponse: Response for Returns metrics relating to the layouting of the page, such as viewport bounds/scale.

GetLayoutMetricsCommandSettings: Returns metrics relating to the layouting of the page, such as viewport bounds/scale.

GetManifestIconsCommandResponse: Response for Deprecated because it's not guaranteed that the returned icon is in fact the one used for PWA installation.

GetManifestIconsCommandSettings: Deprecated because it's not guaranteed that the returned icon is in fact the one used for PWA installation.

GetNavigationHistoryCommandResponse: Response for Returns navigation history for the current page.

GetNavigationHistoryCommandSettings: Returns navigation history for the current page.

GetOriginTrialsCommandResponse: Response for Get Origin Trials on given frame.

GetOriginTrialsCommandSettings: Get Origin Trials on given frame.

GetPermissionsPolicyStateCommandResponse: Response for Get Permissions Policy state on given frame.

GetPermissionsPolicyStateCommandSettings: Get Permissions Policy state on given frame.

GetResourceContentCommandResponse: Response for Returns content of the given resource.

GetResourceContentCommandSettings: Returns content of the given resource.

GetResourceTreeCommandResponse: Response for Returns present frame / resource tree structure.

GetResourceTreeCommandSettings: Returns present frame / resource tree structure.

HandleJavaScriptDialogCommandResponse: Response for Accepts or dismisses a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload).

HandleJavaScriptDialogCommandSettings: Accepts or dismisses a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload).

ImageResource: The image definition used in both icon and screenshot.

InstallabilityError: The installability error

InstallabilityErrorArgument: InstallabilityErrorArgument

InterstitialHiddenEventArgs: Fired when interstitial page was hidden

InterstitialShownEventArgs: Fired when interstitial page was shown

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

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

LaunchHandler: LaunchHandler

LayoutViewport: Layout viewport position and dimensions.

LifecycleEventEventArgs: Fired for lifecycle events (navigation, load, paint, etc) in the current target (including local frames).

LoadEventFiredEventArgs: LoadEventFired

NavigateCommandResponse: Response for Navigates current page to the given URL.

NavigateCommandSettings: Navigates current page to the given URL.

NavigateToHistoryEntryCommandResponse: Response for Navigates current page to the given history entry.

NavigateToHistoryEntryCommandSettings: Navigates current page to the given history entry.

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

NavigationEntry: Navigation history entry.

OriginTrial: OriginTrial

OriginTrialToken: OriginTrialToken

OriginTrialTokenWithStatus: OriginTrialTokenWithStatus

PageAdapter: Represents an adapter for the Page domain to simplify the command interface.

PermissionsPolicyBlockLocator: PermissionsPolicyBlockLocator

PermissionsPolicyFeatureState: PermissionsPolicyFeatureState

PrintToPDFCommandResponse: Response for Print page as PDF.

PrintToPDFCommandSettings: Print page as PDF.

ProduceCompilationCacheCommandResponse: Response for 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.

ProduceCompilationCacheCommandSettings: 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.

ProtocolHandler: ProtocolHandler

RelatedApplication: RelatedApplication

ReloadCommandResponse: Response for Reloads given page optionally ignoring the cache.

ReloadCommandSettings: Reloads given page optionally ignoring the cache.

RemoveScriptToEvaluateOnLoadCommandResponse: Response for Deprecated, please use removeScriptToEvaluateOnNewDocument instead.

RemoveScriptToEvaluateOnLoadCommandSettings: Deprecated, please use removeScriptToEvaluateOnNewDocument instead.

RemoveScriptToEvaluateOnNewDocumentCommandResponse: Response for Removes given script from the list.

RemoveScriptToEvaluateOnNewDocumentCommandSettings: Removes given script from the list.

ResetNavigationHistoryCommandResponse: Response for Resets navigation history for the current page.

ResetNavigationHistoryCommandSettings: Resets navigation history for the current page.

ScopeExtension: ScopeExtension

ScreencastFrameAckCommandResponse: Response for Acknowledges that a screencast frame has been received by the frontend.

ScreencastFrameAckCommandSettings: Acknowledges that a screencast frame has been received by the frontend.

ScreencastFrameEventArgs: Compressed image data requested by the startScreencast.

ScreencastFrameMetadata: Screencast frame metadata.

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

Screenshot: Screenshot

ScriptFontFamilies: Font families collection for a script.

SearchInResourceCommandResponse: Response for Searches for given string in resource content.

SearchInResourceCommandSettings: Searches for given string in resource content.

SecurityOriginDetails: Additional information about the frame document's security origin.

SetAdBlockingEnabledCommandResponse: Response for Enable Chrome's experimental ad filter on all sites.

SetAdBlockingEnabledCommandSettings: Enable Chrome's experimental ad filter on all sites.

SetBypassCSPCommandResponse: Response for Enable page Content Security Policy by-passing.

SetBypassCSPCommandSettings: Enable page Content Security Policy by-passing.

SetDeviceMetricsOverrideCommandResponse: Response for 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).

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

SetDeviceOrientationOverrideCommandResponse: Response for Overrides the Device Orientation.

SetDeviceOrientationOverrideCommandSettings: Overrides the Device Orientation.

SetDocumentContentCommandResponse: Response for Sets given markup as the document's HTML.

SetDocumentContentCommandSettings: Sets given markup as the document's HTML.

SetDownloadBehaviorCommandResponse: Response for Set the behavior when downloading a file.

SetDownloadBehaviorCommandSettings: Set the behavior when downloading a file.

SetFontFamiliesCommandResponse: Response for Set generic font families.

SetFontFamiliesCommandSettings: Set generic font families.

SetFontSizesCommandResponse: Response for Set default font sizes.

SetFontSizesCommandSettings: Set default font sizes.

SetGeolocationOverrideCommandResponse: Response for Overrides the Geolocation Position or Error. Omitting any of the parameters emulates position unavailable.

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

SetInterceptFileChooserDialogCommandResponse: Response for 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.

SetInterceptFileChooserDialogCommandSettings: 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.

SetLifecycleEventsEnabledCommandResponse: Response for Controls whether page will emit lifecycle events.

SetLifecycleEventsEnabledCommandSettings: Controls whether page will emit lifecycle events.

SetPrerenderingAllowedCommandResponse

Response for 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.

SetPrerenderingAllowedCommandSettings

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.

SetRPHRegistrationModeCommandResponse: Response for Extensions for Custom Handlers API: https://html.spec.whatwg.org/multipage/system-state.html#rph-automation

SetRPHRegistrationModeCommandSettings: Extensions for Custom Handlers API: https://html.spec.whatwg.org/multipage/system-state.html#rph-automation

SetSPCTransactionModeCommandResponse: Response for Sets the Secure Payment Confirmation transaction mode. https://w3c.github.io/secure-payment-confirmation/#sctn-automation-set-spc-transaction-mode

SetSPCTransactionModeCommandSettings: Sets the Secure Payment Confirmation transaction mode. https://w3c.github.io/secure-payment-confirmation/#sctn-automation-set-spc-transaction-mode

SetTouchEmulationEnabledCommandResponse: Response for Toggles mouse event-based touch event emulation.

SetTouchEmulationEnabledCommandSettings: Toggles mouse event-based touch event emulation.

SetWebLifecycleStateCommandResponse: Response for 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/

SetWebLifecycleStateCommandSettings: 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/

ShareTarget: ShareTarget

Shortcut: Shortcut

StartScreencastCommandResponse: Response for Starts sending each frame using the screencastFrame event.

StartScreencastCommandSettings: Starts sending each frame using the screencastFrame event.

StopLoadingCommandResponse: Response for Force the page stop all navigations and pending resource fetches.

StopLoadingCommandSettings: Force the page stop all navigations and pending resource fetches.

StopScreencastCommandResponse: Response for Stops sending each frame in the screencastFrame.

StopScreencastCommandSettings: Stops sending each frame in the screencastFrame.

Viewport: Viewport for capturing screenshot.

VisualViewport: Visual viewport position, dimensions, and scale.

WaitForDebuggerCommandResponse: Response for Pauses page execution. Can be resumed using generic Runtime.runIfWaitingForDebugger.

WaitForDebuggerCommandSettings: Pauses page execution. Can be resumed using generic Runtime.runIfWaitingForDebugger.

WebAppManifest: WebAppManifest

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

Enums

AdFrameExplanation: AdFrameExplanation

AdFrameType: Indicates whether a frame has been identified as an ad.

BackForwardCacheNotRestoredReason: List of not restored reasons for back-forward cache.

BackForwardCacheNotRestoredReasonType: Types of not restored reasons for back-forward cache.

ClientNavigationDisposition: ClientNavigationDisposition

ClientNavigationReason: ClientNavigationReason

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

DialogType: Javascript dialog type.

GatedAPIFeatures: GatedAPIFeatures

NavigationType: The type of a frameNavigated event.

OriginTrialStatus: Status for an Origin Trial.

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

OriginTrialUsageRestriction: OriginTrialUsageRestriction

PermissionsPolicyBlockReason: Reason for a permissions policy feature to be disabled.

PermissionsPolicyFeature: All Permissions Policy features. This enum should match the one defined in services/network/public/cpp/permissions_policy/permissions_policy_features.json5. LINT.IfChange(PermissionsPolicyFeature)

ReferrerPolicy: The referring-policy used for the navigation.

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

TransitionType: Transition type.

Table of Contents

Namespace OpenQA.Selenium.DevTools.V146.Page

Classes

Enums