Module chromiumoxide::cdp::browser_protocol::page

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

Structs

• AdFrameStatus
  Indicates whether a frame has been identified as an ad and why. AdFrameStatus
• AdFrameStatusBuilder
• AdScriptId
  Identifies the bottom-most script which caused the frame to be labelled as an ad. AdScriptId
• AdScriptIdBuilder
• AddCompilationCacheParams
  Seeds compilation cache for given url. Compilation cache does not survive cross-process navigation. addCompilationCache
• AddCompilationCacheParamsBuilder
• AddCompilationCacheReturns
  Seeds compilation cache for given url. Compilation cache does not survive cross-process navigation. addCompilationCache
• AddScriptToEvaluateOnNewDocumentParams
  Evaluates given script in every frame upon creation (before loading frame’s scripts). addScriptToEvaluateOnNewDocument
• AddScriptToEvaluateOnNewDocumentParamsBuilder
• AddScriptToEvaluateOnNewDocumentReturns
  Evaluates given script in every frame upon creation (before loading frame’s scripts). addScriptToEvaluateOnNewDocument
• AddScriptToEvaluateOnNewDocumentReturnsBuilder
• AppManifestError
  Error while paring app manifest. AppManifestError
• AppManifestErrorBuilder
• AppManifestParsedProperties
  Parsed app manifest properties. AppManifestParsedProperties
• AppManifestParsedPropertiesBuilder
• BackForwardCacheNotRestoredExplanation
• BackForwardCacheNotRestoredExplanationBuilder
• BackForwardCacheNotRestoredExplanationTree
• BackForwardCacheNotRestoredExplanationTreeBuilder
• BringToFrontParams
  Brings page to front (activates tab). bringToFront
• BringToFrontReturns
  Brings page to front (activates tab). bringToFront
• CaptureScreenshotParams
  Capture page screenshot. captureScreenshot
• CaptureScreenshotParamsBuilder
• CaptureScreenshotReturns
  Capture page screenshot. captureScreenshot
• CaptureScreenshotReturnsBuilder
• CaptureSnapshotParams
  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
• CaptureSnapshotParamsBuilder
• CaptureSnapshotReturns
  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
• CaptureSnapshotReturnsBuilder
• ClearCompilationCacheParams
  Clears seeded compilation cache. clearCompilationCache
• ClearCompilationCacheReturns
  Clears seeded compilation cache. clearCompilationCache
• CloseParams
  Tries to close page, running its beforeunload hooks, if any. close
• CloseReturns
  Tries to close page, running its beforeunload hooks, if any. close
• CompilationCacheParams
  Per-script compilation cache parameters for Page.produceCompilationCache CompilationCacheParams
• CompilationCacheParamsBuilder
• CrashParams
  Crashes renderer on the IO thread, generates minidumps. crash
• CrashReturns
  Crashes renderer on the IO thread, generates minidumps. crash
• CreateIsolatedWorldParams
  Creates an isolated world for the given frame. createIsolatedWorld
• CreateIsolatedWorldParamsBuilder
• CreateIsolatedWorldReturns
  Creates an isolated world for the given frame. createIsolatedWorld
• CreateIsolatedWorldReturnsBuilder
• DisableParams
  Disables page domain notifications. disable
• DisableReturns
  Disables page domain notifications. disable
• EnableParams
  Enables page domain notifications. enable
• EnableReturns
  Enables page domain notifications. enable
• EventBackForwardCacheNotUsed
  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
• EventCompilationCacheProduced
  Issued for every compilation cache generated. Is only available if Page.setGenerateCompilationCache is enabled. compilationCacheProduced
• EventDocumentOpened
  Fired when opening document to write to. documentOpened
• EventDomContentEventFired
• EventFileChooserOpened
  Emitted only when page.interceptFileChooser is enabled. fileChooserOpened
• EventFrameAttached
  Fired when frame has been attached to its parent. frameAttached
• EventFrameDetached
  Fired when frame has been detached from its parent. frameDetached
• EventFrameNavigated
  Fired once navigation of the frame has completed. Frame is now associated with the new loader. frameNavigated
• EventFrameRequestedNavigation
  Fired when a renderer-initiated navigation is requested. Navigation may still be cancelled after the event is issued. frameRequestedNavigation
• EventFrameResized
• EventFrameStartedLoading
  Fired when frame has started loading. frameStartedLoading
• EventFrameStoppedLoading
  Fired when frame has stopped loading. frameStoppedLoading
• EventInterstitialHidden
  Fired when interstitial page was hidden interstitialHidden
• EventInterstitialShown
  Fired when interstitial page was shown interstitialShown
• EventJavascriptDialogClosed
  Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) has been closed. javascriptDialogClosed
• EventJavascriptDialogOpening
  Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) is about to open. javascriptDialogOpening
• EventLifecycleEvent
  Fired for top level page lifecycle events such as navigation, load, paint, etc. lifecycleEvent
• EventLoadEventFired
• EventNavigatedWithinDocument
  Fired when same-document navigation happens, e.g. due to history API usage or anchor navigation. navigatedWithinDocument
• EventPrerenderAttemptCompleted
  Fired when a prerender attempt is completed. prerenderAttemptCompleted
• EventScreencastFrame
  Compressed image data requested by the startScreencast. screencastFrame
• EventScreencastVisibilityChanged
  Fired when the page with currently enabled screencast was shown or hidden `. screencastVisibilityChanged
• EventWindowOpen
  Fired when a new window is going to be opened, via window.open(), link click, form submission, etc. windowOpen
• FontFamilies
  Generic font families collection. FontFamilies
• FontFamiliesBuilder
• FontSizes
  Default font sizes. FontSizes
• FontSizesBuilder
• Frame
  Information about the Frame on the page. Frame
• FrameBuilder
• FrameId
  Unique frame identifier. FrameId
• FrameResource
  Information about the Resource on the page. FrameResource
• FrameResourceBuilder
• FrameResourceTree
  Information about the Frame hierarchy along with their cached resources. FrameResourceTree
• FrameResourceTreeBuilder
• FrameTree
  Information about the Frame hierarchy. FrameTree
• FrameTreeBuilder
• GenerateTestReportParams
  Generates a report for testing. generateTestReport
• GenerateTestReportParamsBuilder
• GenerateTestReportReturns
  Generates a report for testing. generateTestReport
• GetAppIdParams
  Returns the unique (PWA) app id. Only returns values if the feature flag ‘WebAppEnableManifestId’ is enabled getAppId
• GetAppIdReturns
  Returns the unique (PWA) app id. Only returns values if the feature flag ‘WebAppEnableManifestId’ is enabled getAppId
• GetAppIdReturnsBuilder
• GetAppManifestParams
• GetAppManifestReturns
• GetAppManifestReturnsBuilder
• GetFrameTreeParams
  Returns present frame tree structure. getFrameTree
• GetFrameTreeReturns
  Returns present frame tree structure. getFrameTree
• GetFrameTreeReturnsBuilder
• GetInstallabilityErrorsParams
• GetInstallabilityErrorsReturns
• GetInstallabilityErrorsReturnsBuilder
• GetLayoutMetricsParams
  Returns metrics relating to the layouting of the page, such as viewport bounds/scale. getLayoutMetrics
• GetLayoutMetricsReturns
  Returns metrics relating to the layouting of the page, such as viewport bounds/scale. getLayoutMetrics
• GetLayoutMetricsReturnsBuilder
• GetManifestIconsParams
• GetManifestIconsReturns
• GetManifestIconsReturnsBuilder
• GetNavigationHistoryParams
  Returns navigation history for the current page. getNavigationHistory
• GetNavigationHistoryReturns
  Returns navigation history for the current page. getNavigationHistory
• GetNavigationHistoryReturnsBuilder
• GetOriginTrialsParams
  Get Origin Trials on given frame. getOriginTrials
• GetOriginTrialsParamsBuilder
• GetOriginTrialsReturns
  Get Origin Trials on given frame. getOriginTrials
• GetOriginTrialsReturnsBuilder
• GetPermissionsPolicyStateParams
  Get Permissions Policy state on given frame. getPermissionsPolicyState
• GetPermissionsPolicyStateParamsBuilder
• GetPermissionsPolicyStateReturns
  Get Permissions Policy state on given frame. getPermissionsPolicyState
• GetPermissionsPolicyStateReturnsBuilder
• GetResourceContentParams
  Returns content of the given resource. getResourceContent
• GetResourceContentParamsBuilder
• GetResourceContentReturns
  Returns content of the given resource. getResourceContent
• GetResourceContentReturnsBuilder
• GetResourceTreeParams
  Returns present frame / resource tree structure. getResourceTree
• GetResourceTreeReturns
  Returns present frame / resource tree structure. getResourceTree
• GetResourceTreeReturnsBuilder
• HandleJavaScriptDialogParams
  Accepts or dismisses a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload). handleJavaScriptDialog
• HandleJavaScriptDialogParamsBuilder
• HandleJavaScriptDialogReturns
  Accepts or dismisses a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload). handleJavaScriptDialog
• InstallabilityError
  The installability error InstallabilityError
• InstallabilityErrorArgument
• InstallabilityErrorArgumentBuilder
• InstallabilityErrorBuilder
• LayoutViewport
  Layout viewport position and dimensions. LayoutViewport
• LayoutViewportBuilder
• NavigateParams
  Navigates current page to the given URL. navigate
• NavigateParamsBuilder
• NavigateReturns
  Navigates current page to the given URL. navigate
• NavigateReturnsBuilder
• NavigateToHistoryEntryParams
  Navigates current page to the given history entry. navigateToHistoryEntry
• NavigateToHistoryEntryParamsBuilder
• NavigateToHistoryEntryReturns
  Navigates current page to the given history entry. navigateToHistoryEntry
• NavigationEntry
  Navigation history entry. NavigationEntry
• NavigationEntryBuilder
• OriginTrial
• OriginTrialBuilder
• OriginTrialToken
• OriginTrialTokenBuilder
• OriginTrialTokenWithStatus
• OriginTrialTokenWithStatusBuilder
• PermissionsPolicyBlockLocator
• PermissionsPolicyBlockLocatorBuilder
• PermissionsPolicyFeatureState
• PermissionsPolicyFeatureStateBuilder
• PrintToPdfParams
  Print page as PDF. printToPDF
• PrintToPdfParamsBuilder
• PrintToPdfReturns
  Print page as PDF. printToPDF
• PrintToPdfReturnsBuilder
• ProduceCompilationCacheParams
  Requests backend to produce compilation cache for the specified scripts. scripts are appeneded 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
• ProduceCompilationCacheParamsBuilder
• ProduceCompilationCacheReturns
  Requests backend to produce compilation cache for the specified scripts. scripts are appeneded 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
• ReloadParams
  Reloads given page optionally ignoring the cache. reload
• ReloadParamsBuilder
• ReloadReturns
  Reloads given page optionally ignoring the cache. reload
• RemoveScriptToEvaluateOnNewDocumentParams
  Removes given script from the list. removeScriptToEvaluateOnNewDocument
• RemoveScriptToEvaluateOnNewDocumentParamsBuilder
• RemoveScriptToEvaluateOnNewDocumentReturns
  Removes given script from the list. removeScriptToEvaluateOnNewDocument
• ResetNavigationHistoryParams
  Resets navigation history for the current page. resetNavigationHistory
• ResetNavigationHistoryReturns
  Resets navigation history for the current page. resetNavigationHistory
• ScreencastFrameAckParams
  Acknowledges that a screencast frame has been received by the frontend. screencastFrameAck
• ScreencastFrameAckParamsBuilder
• ScreencastFrameAckReturns
  Acknowledges that a screencast frame has been received by the frontend. screencastFrameAck
• ScreencastFrameMetadata
  Screencast frame metadata. ScreencastFrameMetadata
• ScreencastFrameMetadataBuilder
• ScriptFontFamilies
  Font families collection for a script. ScriptFontFamilies
• ScriptFontFamiliesBuilder
• ScriptIdentifier
  Unique script identifier. ScriptIdentifier
• SearchInResourceParams
  Searches for given string in resource content. searchInResource
• SearchInResourceParamsBuilder
• SearchInResourceReturns
  Searches for given string in resource content. searchInResource
• SearchInResourceReturnsBuilder
• SetAdBlockingEnabledParams
  Enable Chrome’s experimental ad filter on all sites. setAdBlockingEnabled
• SetAdBlockingEnabledParamsBuilder
• SetAdBlockingEnabledReturns
  Enable Chrome’s experimental ad filter on all sites. setAdBlockingEnabled
• SetBypassCspParams
  Enable page Content Security Policy by-passing. setBypassCSP
• SetBypassCspParamsBuilder
• SetBypassCspReturns
  Enable page Content Security Policy by-passing. setBypassCSP
• SetDocumentContentParams
  Sets given markup as the document’s HTML. setDocumentContent
• SetDocumentContentParamsBuilder
• SetDocumentContentReturns
  Sets given markup as the document’s HTML. setDocumentContent
• SetFontFamiliesParams
  Set generic font families. setFontFamilies
• SetFontFamiliesParamsBuilder
• SetFontFamiliesReturns
  Set generic font families. setFontFamilies
• SetFontSizesParams
  Set default font sizes. setFontSizes
• SetFontSizesParamsBuilder
• SetFontSizesReturns
  Set default font sizes. setFontSizes
• SetInterceptFileChooserDialogParams
  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. setInterceptFileChooserDialog
• SetInterceptFileChooserDialogParamsBuilder
• SetInterceptFileChooserDialogReturns
  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. setInterceptFileChooserDialog
• SetLifecycleEventsEnabledParams
  Controls whether page will emit lifecycle events. setLifecycleEventsEnabled
• SetLifecycleEventsEnabledParamsBuilder
• SetLifecycleEventsEnabledReturns
  Controls whether page will emit lifecycle events. setLifecycleEventsEnabled
• SetSpcTransactionModeParams
  Sets the Secure Payment Confirmation transaction mode. https://w3c.github.io/secure-payment-confirmation/#sctn-automation-set-spc-transaction-mode setSPCTransactionMode
• SetSpcTransactionModeParamsBuilder
• SetSpcTransactionModeReturns
  Sets the Secure Payment Confirmation transaction mode. https://w3c.github.io/secure-payment-confirmation/#sctn-automation-set-spc-transaction-mode setSPCTransactionMode
• SetWebLifecycleStateParams
  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
• SetWebLifecycleStateParamsBuilder
• SetWebLifecycleStateReturns
  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
• StartScreencastParams
  Starts sending each frame using the screencastFrame event. startScreencast
• StartScreencastParamsBuilder
• StartScreencastReturns
  Starts sending each frame using the screencastFrame event. startScreencast
• StopLoadingParams
  Force the page stop all navigations and pending resource fetches. stopLoading
• StopLoadingReturns
  Force the page stop all navigations and pending resource fetches. stopLoading
• StopScreencastParams
  Stops sending each frame in the screencastFrame. stopScreencast
• StopScreencastReturns
  Stops sending each frame in the screencastFrame. stopScreencast
• Viewport
  Viewport for capturing screenshot. Viewport
• ViewportBuilder
• VisualViewport
  Visual viewport position, dimensions, and scale. VisualViewport
• VisualViewportBuilder
• WaitForDebuggerParams
  Pauses page execution. Can be resumed using generic Runtime.runIfWaitingForDebugger. waitForDebugger
• WaitForDebuggerReturns
  Pauses page execution. Can be resumed using generic Runtime.runIfWaitingForDebugger. waitForDebugger

Enums

• 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.
• CaptureScreenshotFormat
  Image compression format (defaults to png).
• CaptureSnapshotFormat
  Format (defaults to mhtml).
• ClientNavigationDisposition
• ClientNavigationReason
• CrossOriginIsolatedContextType
  Indicates whether the frame is cross-origin isolated and why it is the case.
• DialogType
  Javascript dialog type.
• FileChooserOpenedMode
  Input mode.
• FrameDetachedReason
• 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
• PermissionsPolicyBlockReason
  Reason for a permissions policy feature to be disabled.
• PermissionsPolicyFeature
  All Permissions Policy features. This enum should match the one defined in third_party/blink/renderer/core/permissions_policy/permissions_policy_features.json5.
• PrerenderFinalStatus
  List of FinalStatus reasons for Prerender2.
• PrintToPdfTransferMode
  return as stream
• ReferrerPolicy
  The referring-policy used for the navigation.
• SecureContextType
  Indicates whether the frame is a secure context and why it is the case.
• SetSpcTransactionModeMode
• SetWebLifecycleStateState
  Target lifecycle state
• StartScreencastFormat
  Image compression format.
• TransitionType
  Transition type.