Page

class Page(cdp: CDP) : Domain

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

Constructors

Page

constructor(cdp: CDP)

Types

AddCompilationCacheParameter

@Serializable

data class AddCompilationCacheParameter(val url: String, val data: String)

AddScriptToEvaluateOnLoadParameter

@Serializable

data class AddScriptToEvaluateOnLoadParameter(val scriptSource: String)

AddScriptToEvaluateOnLoadReturn

@Serializable

data class AddScriptToEvaluateOnLoadReturn(val identifier: String)

AddScriptToEvaluateOnNewDocumentParameter

@Serializable

data class AddScriptToEvaluateOnNewDocumentParameter(val source: String, val worldName: String? = null, val includeCommandLineAPI: Boolean? = null, val runImmediately: Boolean? = null)

AddScriptToEvaluateOnNewDocumentReturn

@Serializable

data class AddScriptToEvaluateOnNewDocumentReturn(val identifier: String)

AdFrameExplanation

@Serializable

enum AdFrameExplanation : Enum<Page.AdFrameExplanation>

AdFrameStatus

@Serializable

data class AdFrameStatus(val adFrameType: Page.AdFrameType, val explanations: List<Page.AdFrameExplanation>? = null)

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

AdFrameType

@Serializable

enum AdFrameType : Enum<Page.AdFrameType>

Indicates whether a frame has been identified as an ad.

AdScriptAncestry

@Serializable

data class AdScriptAncestry(val ancestryChain: List<Page.AdScriptId>, val rootScriptFilterlistRule: String? = null)

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

@Serializable

data class AdScriptId(val scriptId: String, val debuggerId: String)

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

AppManifestError

@Serializable

data class AppManifestError(val message: String, val critical: Int, val line: Int, val column: Int)

Error while paring app manifest.

AppManifestParsedProperties

@Serializable

data class AppManifestParsedProperties(val scope: String)

Parsed app manifest properties.

BackForwardCacheBlockingDetails

@Serializable

data class BackForwardCacheBlockingDetails(val url: String? = null, val function: String? = null, val lineNumber: Int, val columnNumber: Int)

BackForwardCacheNotRestoredExplanation

@Serializable

data class BackForwardCacheNotRestoredExplanation(val type: Page.BackForwardCacheNotRestoredReasonType, val reason: Page.BackForwardCacheNotRestoredReason, val context: String? = null, val details: List<Page.BackForwardCacheBlockingDetails>? = null)

BackForwardCacheNotRestoredExplanationTree

@Serializable

data class BackForwardCacheNotRestoredExplanationTree(val url: String, val explanations: List<Page.BackForwardCacheNotRestoredExplanation>, val children: List<Page.BackForwardCacheNotRestoredExplanationTree>)

BackForwardCacheNotRestoredReason

@Serializable

enum BackForwardCacheNotRestoredReason : Enum<Page.BackForwardCacheNotRestoredReason>

List of not restored reasons for back-forward cache.

BackForwardCacheNotRestoredReasonType

@Serializable

enum BackForwardCacheNotRestoredReasonType : Enum<Page.BackForwardCacheNotRestoredReasonType>

Types of not restored reasons for back-forward cache.

BackForwardCacheNotUsedParameter

@Serializable

data class BackForwardCacheNotUsedParameter(val loaderId: String, val frameId: String, val notRestoredExplanations: List<Page.BackForwardCacheNotRestoredExplanation>, val notRestoredExplanationsTree: Page.BackForwardCacheNotRestoredExplanationTree? = null)

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.

CaptureScreenshotParameter

@Serializable

data class CaptureScreenshotParameter(val format: String? = null, val quality: Int? = null, val clip: Page.Viewport? = null, val fromSurface: Boolean? = null, val captureBeyondViewport: Boolean? = null, val optimizeForSpeed: Boolean? = null)

CaptureScreenshotReturn

@Serializable

data class CaptureScreenshotReturn(val data: String)

CaptureSnapshotParameter

@Serializable

data class CaptureSnapshotParameter(val format: String? = null)

CaptureSnapshotReturn

@Serializable

data class CaptureSnapshotReturn(val data: String)

ClientNavigationDisposition

@Serializable

enum ClientNavigationDisposition : Enum<Page.ClientNavigationDisposition>

ClientNavigationReason

@Serializable

enum ClientNavigationReason : Enum<Page.ClientNavigationReason>

CompilationCacheParams

@Serializable

data class CompilationCacheParams(val url: String, val eager: Boolean? = null)

Per-script compilation cache parameters for Page.produceCompilationCache

CompilationCacheProducedParameter

@Serializable

data class CompilationCacheProducedParameter(val url: String, val data: String)

Issued for every compilation cache generated. Is only available if Page.setGenerateCompilationCache is enabled.

CreateIsolatedWorldParameter

@Serializable

data class CreateIsolatedWorldParameter(val frameId: String, val worldName: String? = null, val grantUniveralAccess: Boolean? = null)

CreateIsolatedWorldReturn

@Serializable

data class CreateIsolatedWorldReturn(val executionContextId: Int)

CrossOriginIsolatedContextType

@Serializable

enum CrossOriginIsolatedContextType : Enum<Page.CrossOriginIsolatedContextType>

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

DeleteCookieParameter

@Serializable

data class DeleteCookieParameter(val cookieName: String, val url: String)

DialogType

@Serializable

enum DialogType : Enum<Page.DialogType>

Javascript dialog type.

DocumentOpenedParameter

@Serializable

data class DocumentOpenedParameter(val frame: Page.Frame)

Fired when opening document to write to.

DomContentEventFiredParameter

@Serializable

data class DomContentEventFiredParameter(val timestamp: Double)

DownloadProgressParameter

@Serializable

data class DownloadProgressParameter(val guid: String, val totalBytes: Double, val receivedBytes: Double, val state: String)

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

DownloadWillBeginParameter

@Serializable

data class DownloadWillBeginParameter(val frameId: String, val guid: String, val url: String, val suggestedFilename: String)

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

EnableParameter

@Serializable

data class EnableParameter(val enableFileChooserOpenedEvent: Boolean? = null)

FileChooserOpenedParameter

@Serializable

data class FileChooserOpenedParameter(val frameId: String, val mode: String, val backendNodeId: Int? = null)

Emitted only when page.interceptFileChooser is enabled.

FileFilter

@Serializable

data class FileFilter(val name: String? = null, val accepts: List<String>? = null)

FileHandler

@Serializable

data class FileHandler(val action: String, val name: String, val icons: List<Page.ImageResource>? = null, val accepts: List<Page.FileFilter>? = null, val launchType: String)

FontFamilies

@Serializable

data class FontFamilies(val standard: String? = null, val fixed: String? = null, val serif: String? = null, val sansSerif: String? = null, val cursive: String? = null, val fantasy: String? = null, val math: String? = null)

Generic font families collection.

FontSizes

@Serializable

data class FontSizes(val standard: Int? = null, val fixed: Int? = null)

Default font sizes.

Frame

@Serializable

data class Frame(val id: String, val parentId: String? = null, val loaderId: String, val name: String? = null, val url: String, val urlFragment: String? = null, val domainAndRegistry: String, val securityOrigin: String, val securityOriginDetails: Page.SecurityOriginDetails? = null, val mimeType: String, val unreachableUrl: String? = null, val adFrameStatus: Page.AdFrameStatus? = null, val secureContextType: Page.SecureContextType, val crossOriginIsolatedContextType: Page.CrossOriginIsolatedContextType, val gatedAPIFeatures: List<Page.GatedAPIFeatures>)

Information about the Frame on the page.

FrameAttachedParameter

@Serializable

data class FrameAttachedParameter(val frameId: String, val parentFrameId: String, val stack: Runtime.StackTrace? = null)

Fired when frame has been attached to its parent.

FrameClearedScheduledNavigationParameter

@Serializable

data class FrameClearedScheduledNavigationParameter(val frameId: String)

Fired when frame no longer has a scheduled navigation.

FrameDetachedParameter

@Serializable

data class FrameDetachedParameter(val frameId: String, val reason: String)

Fired when frame has been detached from its parent.

FrameNavigatedParameter

@Serializable

data class FrameNavigatedParameter(val frame: Page.Frame, val type: Page.NavigationType)

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

FrameRequestedNavigationParameter

@Serializable

data class FrameRequestedNavigationParameter(val frameId: String, val reason: Page.ClientNavigationReason, val url: String, val disposition: Page.ClientNavigationDisposition)

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

FrameResource

@Serializable

data class FrameResource(val url: String, val type: Network.ResourceType, val mimeType: String, val lastModified: Double? = null, val contentSize: Double? = null, val failed: Boolean? = null, val canceled: Boolean? = null)

Information about the Resource on the page.

FrameResourceTree

@Serializable

data class FrameResourceTree(val frame: Page.Frame, val childFrames: List<Page.FrameResourceTree>? = null, val resources: List<Page.FrameResource>)

Information about the Frame hierarchy along with their cached resources.

FrameScheduledNavigationParameter

@Serializable

data class FrameScheduledNavigationParameter(val frameId: String, val delay: Double, val reason: Page.ClientNavigationReason, val url: String)

Fired when frame schedules a potential navigation.

FrameStartedLoadingParameter

@Serializable

data class FrameStartedLoadingParameter(val frameId: String)

Fired when frame has started loading.

FrameStartedNavigatingParameter

@Serializable

data class FrameStartedNavigatingParameter(val frameId: String, val url: String, val loaderId: String, val navigationType: String)

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

FrameStoppedLoadingParameter

@Serializable

data class FrameStoppedLoadingParameter(val frameId: String)

Fired when frame has stopped loading.

FrameSubtreeWillBeDetachedParameter

@Serializable

data class FrameSubtreeWillBeDetachedParameter(val frameId: String)

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

FrameTree

@Serializable

data class FrameTree(val frame: Page.Frame, val childFrames: List<Page.FrameTree>? = null)

Information about the Frame hierarchy.

GatedAPIFeatures

@Serializable

enum GatedAPIFeatures : Enum<Page.GatedAPIFeatures>

GenerateTestReportParameter

@Serializable

data class GenerateTestReportParameter(val message: String, val group: String? = null)

GetAdScriptAncestryParameter

@Serializable

data class GetAdScriptAncestryParameter(val frameId: String)

GetAdScriptAncestryReturn

@Serializable

data class GetAdScriptAncestryReturn(val adScriptAncestry: Page.AdScriptAncestry?)

GetAppIdReturn

@Serializable

data class GetAppIdReturn(val appId: String?, val recommendedId: String?)

GetAppManifestParameter

@Serializable

data class GetAppManifestParameter(val manifestId: String? = null)

GetAppManifestReturn

@Serializable

data class GetAppManifestReturn(val url: String, val errors: List<Page.AppManifestError>, val data: String?, val parsed: Page.AppManifestParsedProperties?, val manifest: Page.WebAppManifest)

GetFrameTreeReturn

@Serializable

data class GetFrameTreeReturn(val frameTree: Page.FrameTree)

GetInstallabilityErrorsReturn

@Serializable

data class GetInstallabilityErrorsReturn(val installabilityErrors: List<Page.InstallabilityError>)

GetLayoutMetricsReturn

@Serializable

data class GetLayoutMetricsReturn(val layoutViewport: Page.LayoutViewport, val visualViewport: Page.VisualViewport, val contentSize: DOM.Rect, val cssLayoutViewport: Page.LayoutViewport, val cssVisualViewport: Page.VisualViewport, val cssContentSize: DOM.Rect)

GetManifestIconsReturn

@Serializable

data class GetManifestIconsReturn(val primaryIcon: String?)

GetNavigationHistoryReturn

@Serializable

data class GetNavigationHistoryReturn(val currentIndex: Int, val entries: List<Page.NavigationEntry>)

GetOriginTrialsParameter

@Serializable

data class GetOriginTrialsParameter(val frameId: String)

GetOriginTrialsReturn

@Serializable

data class GetOriginTrialsReturn(val originTrials: List<Page.OriginTrial>)

GetPermissionsPolicyStateParameter

@Serializable

data class GetPermissionsPolicyStateParameter(val frameId: String)

GetPermissionsPolicyStateReturn

@Serializable

data class GetPermissionsPolicyStateReturn(val states: List<Page.PermissionsPolicyFeatureState>)

GetResourceContentParameter

@Serializable

data class GetResourceContentParameter(val frameId: String, val url: String)

GetResourceContentReturn

@Serializable

data class GetResourceContentReturn(val content: String, val base64Encoded: Boolean)

GetResourceTreeReturn

@Serializable

data class GetResourceTreeReturn(val frameTree: Page.FrameResourceTree)

HandleJavaScriptDialogParameter

@Serializable

data class HandleJavaScriptDialogParameter(val accept: Boolean, val promptText: String? = null)

ImageResource

@Serializable

data class ImageResource(val url: String, val sizes: String? = null, val type: String? = null)

The image definition used in both icon and screenshot.

InstallabilityError

@Serializable

data class InstallabilityError(val errorId: String, val errorArguments: List<Page.InstallabilityErrorArgument>)

The installability error

InstallabilityErrorArgument

@Serializable

data class InstallabilityErrorArgument(val name: String, val value: String)

JavascriptDialogClosedParameter

@Serializable

data class JavascriptDialogClosedParameter(val frameId: String, val result: Boolean, val userInput: String)

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

JavascriptDialogOpeningParameter

@Serializable

data class JavascriptDialogOpeningParameter(val url: String, val frameId: String, val message: String, val type: Page.DialogType, val hasBrowserHandler: Boolean, val defaultPrompt: String? = null)

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

LaunchHandler

@Serializable

data class LaunchHandler(val clientMode: String)

LayoutViewport

@Serializable

data class LayoutViewport(val pageX: Int, val pageY: Int, val clientWidth: Int, val clientHeight: Int)

Layout viewport position and dimensions.

LifecycleEventParameter

@Serializable

data class LifecycleEventParameter(val frameId: String, val loaderId: String, val name: String, val timestamp: Double)

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

LoadEventFiredParameter

@Serializable

data class LoadEventFiredParameter(val timestamp: Double)

NavigatedWithinDocumentParameter

@Serializable

data class NavigatedWithinDocumentParameter(val frameId: String, val url: String, val navigationType: String)

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

NavigateParameter

@Serializable

data class NavigateParameter(val url: String, val referrer: String? = null, val transitionType: Page.TransitionType? = null, val frameId: String? = null, val referrerPolicy: Page.ReferrerPolicy? = null)

NavigateReturn

@Serializable

data class NavigateReturn(val frameId: String, val loaderId: String?, val errorText: String?)

NavigateToHistoryEntryParameter

@Serializable

data class NavigateToHistoryEntryParameter(val entryId: Int)

NavigationEntry

@Serializable

data class NavigationEntry(val id: Int, val url: String, val userTypedURL: String, val title: String, val transitionType: Page.TransitionType)

Navigation history entry.

NavigationType

@Serializable

enum NavigationType : Enum<Page.NavigationType>

The type of a frameNavigated event.

OriginTrial

@Serializable

data class OriginTrial(val trialName: String, val status: Page.OriginTrialStatus, val tokensWithStatus: List<Page.OriginTrialTokenWithStatus>)

OriginTrialStatus

@Serializable

enum OriginTrialStatus : Enum<Page.OriginTrialStatus>

Status for an Origin Trial.

OriginTrialToken

@Serializable

data class OriginTrialToken(val origin: String, val matchSubDomains: Boolean, val trialName: String, val expiryTime: Double, val isThirdParty: Boolean, val usageRestriction: Page.OriginTrialUsageRestriction)

OriginTrialTokenStatus

@Serializable

enum OriginTrialTokenStatus : Enum<Page.OriginTrialTokenStatus>

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

OriginTrialTokenWithStatus

@Serializable

data class OriginTrialTokenWithStatus(val rawTokenText: String, val parsedToken: Page.OriginTrialToken? = null, val status: Page.OriginTrialTokenStatus)

OriginTrialUsageRestriction

@Serializable

enum OriginTrialUsageRestriction : Enum<Page.OriginTrialUsageRestriction>

PermissionsPolicyBlockLocator

@Serializable

data class PermissionsPolicyBlockLocator(val frameId: String, val blockReason: Page.PermissionsPolicyBlockReason)

PermissionsPolicyBlockReason

@Serializable

enum PermissionsPolicyBlockReason : Enum<Page.PermissionsPolicyBlockReason>

Reason for a permissions policy feature to be disabled.

PermissionsPolicyFeature

@Serializable

enum PermissionsPolicyFeature : Enum<Page.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)

PermissionsPolicyFeatureState

@Serializable

data class PermissionsPolicyFeatureState(val feature: Page.PermissionsPolicyFeature, val allowed: Boolean, val locator: Page.PermissionsPolicyBlockLocator? = null)

PrintToPDFParameter

@Serializable

data class PrintToPDFParameter(val landscape: Boolean? = null, val displayHeaderFooter: Boolean? = null, val printBackground: Boolean? = null, val scale: Double? = null, val paperWidth: Double? = null, val paperHeight: Double? = null, val marginTop: Double? = null, val marginBottom: Double? = null, val marginLeft: Double? = null, val marginRight: Double? = null, val pageRanges: String? = null, val headerTemplate: String? = null, val footerTemplate: String? = null, val preferCSSPageSize: Boolean? = null, val transferMode: String? = null, val generateTaggedPDF: Boolean? = null, val generateDocumentOutline: Boolean? = null)

PrintToPDFReturn

@Serializable

data class PrintToPDFReturn(val data: String, val stream: String?)

ProduceCompilationCacheParameter

@Serializable

data class ProduceCompilationCacheParameter(val scripts: List<Page.CompilationCacheParams>)

ProtocolHandler

@Serializable

data class ProtocolHandler(val protocol: String, val url: String)

ReferrerPolicy

@Serializable

enum ReferrerPolicy : Enum<Page.ReferrerPolicy>

The referring-policy used for the navigation.

RelatedApplication

@Serializable

data class RelatedApplication(val id: String? = null, val url: String)

ReloadParameter

@Serializable

data class ReloadParameter(val ignoreCache: Boolean? = null, val scriptToEvaluateOnLoad: String? = null, val loaderId: String? = null)

RemoveScriptToEvaluateOnLoadParameter

@Serializable

data class RemoveScriptToEvaluateOnLoadParameter(val identifier: String)

RemoveScriptToEvaluateOnNewDocumentParameter

@Serializable

data class RemoveScriptToEvaluateOnNewDocumentParameter(val identifier: String)

ScopeExtension

@Serializable

data class ScopeExtension(val origin: String, val hasOriginWildcard: Boolean)

ScreencastFrameAckParameter

@Serializable

data class ScreencastFrameAckParameter(val sessionId: Int)

ScreencastFrameMetadata

@Serializable

data class ScreencastFrameMetadata(val offsetTop: Double, val pageScaleFactor: Double, val deviceWidth: Double, val deviceHeight: Double, val scrollOffsetX: Double, val scrollOffsetY: Double, val timestamp: Double? = null)

Screencast frame metadata.

ScreencastFrameParameter

@Serializable

data class ScreencastFrameParameter(val data: String, val metadata: Page.ScreencastFrameMetadata, val sessionId: Int)

Compressed image data requested by the startScreencast.

ScreencastVisibilityChangedParameter

@Serializable

data class ScreencastVisibilityChangedParameter(val visible: Boolean)

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

Screenshot

@Serializable

data class Screenshot(val image: Page.ImageResource, val formFactor: String, val label: String? = null)

ScriptFontFamilies

@Serializable

data class ScriptFontFamilies(val script: String, val fontFamilies: Page.FontFamilies)

Font families collection for a script.

SearchInResourceParameter

@Serializable

data class SearchInResourceParameter(val frameId: String, val url: String, val query: String, val caseSensitive: Boolean? = null, val isRegex: Boolean? = null)

SearchInResourceReturn

@Serializable

data class SearchInResourceReturn(val result: List<Debugger.SearchMatch>)

SecureContextType

@Serializable

enum SecureContextType : Enum<Page.SecureContextType>

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

SecurityOriginDetails

@Serializable

data class SecurityOriginDetails(val isLocalhost: Boolean)

Additional information about the frame document's security origin.

SetAdBlockingEnabledParameter

@Serializable

data class SetAdBlockingEnabledParameter(val enabled: Boolean)

SetBypassCSPParameter

@Serializable

data class SetBypassCSPParameter(val enabled: Boolean)

SetDeviceMetricsOverrideParameter

@Serializable

data class SetDeviceMetricsOverrideParameter(val width: Int, val height: Int, val deviceScaleFactor: Double, val mobile: Boolean, val scale: Double? = null, val screenWidth: Int? = null, val screenHeight: Int? = null, val positionX: Int? = null, val positionY: Int? = null, val dontSetVisibleSize: Boolean? = null, val screenOrientation: Emulation.ScreenOrientation? = null, val viewport: Page.Viewport? = null)

SetDeviceOrientationOverrideParameter

@Serializable

data class SetDeviceOrientationOverrideParameter(val alpha: Double, val beta: Double, val gamma: Double)

SetDocumentContentParameter

@Serializable

data class SetDocumentContentParameter(val frameId: String, val html: String)

SetDownloadBehaviorParameter

@Serializable

data class SetDownloadBehaviorParameter(val behavior: String, val downloadPath: String? = null)

SetFontFamiliesParameter

@Serializable

data class SetFontFamiliesParameter(val fontFamilies: Page.FontFamilies, val forScripts: List<Page.ScriptFontFamilies>? = null)

SetFontSizesParameter

@Serializable

data class SetFontSizesParameter(val fontSizes: Page.FontSizes)

SetGeolocationOverrideParameter

@Serializable

data class SetGeolocationOverrideParameter(val latitude: Double? = null, val longitude: Double? = null, val accuracy: Double? = null)

SetInterceptFileChooserDialogParameter

@Serializable

data class SetInterceptFileChooserDialogParameter(val enabled: Boolean, val cancel: Boolean? = null)

SetLifecycleEventsEnabledParameter

@Serializable

data class SetLifecycleEventsEnabledParameter(val enabled: Boolean)

SetPrerenderingAllowedParameter

@Serializable

data class SetPrerenderingAllowedParameter(val isAllowed: Boolean)

SetRPHRegistrationModeParameter

@Serializable

data class SetRPHRegistrationModeParameter(val mode: String)

SetSPCTransactionModeParameter

@Serializable

data class SetSPCTransactionModeParameter(val mode: String)

SetTouchEmulationEnabledParameter

@Serializable

data class SetTouchEmulationEnabledParameter(val enabled: Boolean, val configuration: String? = null)

SetWebLifecycleStateParameter

@Serializable

data class SetWebLifecycleStateParameter(val state: String)

ShareTarget

@Serializable

data class ShareTarget(val action: String, val method: String, val enctype: String, val title: String? = null, val text: String? = null, val url: String? = null, val files: List<Page.FileFilter>? = null)

Shortcut

@Serializable

data class Shortcut(val name: String, val url: String)

StartScreencastParameter

@Serializable

data class StartScreencastParameter(val format: String? = null, val quality: Int? = null, val maxWidth: Int? = null, val maxHeight: Int? = null, val everyNthFrame: Int? = null)

TransitionType

@Serializable

enum TransitionType : Enum<Page.TransitionType>

Transition type.

Viewport

@Serializable

data class Viewport(val x: Double, val y: Double, val width: Double, val height: Double, val scale: Double)

Viewport for capturing screenshot.

VisualViewport

@Serializable

data class VisualViewport(val offsetX: Double, val offsetY: Double, val pageX: Double, val pageY: Double, val clientWidth: Double, val clientHeight: Double, val scale: Double, val zoom: Double? = null)

Visual viewport position, dimensions, and scale.

WebAppManifest

@Serializable

data class WebAppManifest(val backgroundColor: String? = null, val description: String? = null, val dir: String? = null, val display: String? = null, val displayOverrides: List<String>? = null, val fileHandlers: List<Page.FileHandler>? = null, val icons: List<Page.ImageResource>? = null, val id: String? = null, val lang: String? = null, val launchHandler: Page.LaunchHandler? = null, val name: String? = null, val orientation: String? = null, val preferRelatedApplications: Boolean? = null, val protocolHandlers: List<Page.ProtocolHandler>? = null, val relatedApplications: List<Page.RelatedApplication>? = null, val scope: String? = null, val scopeExtensions: List<Page.ScopeExtension>? = null, val screenshots: List<Page.Screenshot>? = null, val shareTarget: Page.ShareTarget? = null, val shortName: String? = null, val shortcuts: List<Page.Shortcut>? = null, val startUrl: String? = null, val themeColor: String? = null)

WindowOpenParameter

@Serializable

data class WindowOpenParameter(val url: String, val windowName: String, val windowFeatures: List<String>, val userGesture: Boolean)

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

Properties

backForwardCacheNotUsed

val backForwardCacheNotUsed: Flow<Page.BackForwardCacheNotUsedParameter>

compilationCacheProduced

val compilationCacheProduced: Flow<Page.CompilationCacheProducedParameter>

Issued for every compilation cache generated. Is only available if Page.setGenerateCompilationCache is enabled.

documentOpened

val documentOpened: Flow<Page.DocumentOpenedParameter>

Fired when opening document to write to.

domContentEventFired

val domContentEventFired: Flow<Page.DomContentEventFiredParameter>

downloadProgress

val downloadProgress: Flow<Page.DownloadProgressParameter>

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

downloadWillBegin

val downloadWillBegin: Flow<Page.DownloadWillBeginParameter>

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

fileChooserOpened

val fileChooserOpened: Flow<Page.FileChooserOpenedParameter>

Emitted only when page.interceptFileChooser is enabled.

frameAttached

val frameAttached: Flow<Page.FrameAttachedParameter>

Fired when frame has been attached to its parent.

frameClearedScheduledNavigation

val frameClearedScheduledNavigation: Flow<Page.FrameClearedScheduledNavigationParameter>

Fired when frame no longer has a scheduled navigation.

frameDetached

val frameDetached: Flow<Page.FrameDetachedParameter>

Fired when frame has been detached from its parent.

frameNavigated

val frameNavigated: Flow<Page.FrameNavigatedParameter>

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

frameRequestedNavigation

val frameRequestedNavigation: Flow<Page.FrameRequestedNavigationParameter>

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

frameResized

val frameResized: Flow<Unit>

frameScheduledNavigation

val frameScheduledNavigation: Flow<Page.FrameScheduledNavigationParameter>

Fired when frame schedules a potential navigation.

frameStartedLoading

val frameStartedLoading: Flow<Page.FrameStartedLoadingParameter>

Fired when frame has started loading.

frameStartedNavigating

val frameStartedNavigating: Flow<Page.FrameStartedNavigatingParameter>

frameStoppedLoading

val frameStoppedLoading: Flow<Page.FrameStoppedLoadingParameter>

Fired when frame has stopped loading.

frameSubtreeWillBeDetached

val frameSubtreeWillBeDetached: Flow<Page.FrameSubtreeWillBeDetachedParameter>

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

interstitialHidden

val interstitialHidden: Flow<Unit>

Fired when interstitial page was hidden

interstitialShown

val interstitialShown: Flow<Unit>

Fired when interstitial page was shown

javascriptDialogClosed

val javascriptDialogClosed: Flow<Page.JavascriptDialogClosedParameter>

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

javascriptDialogOpening

val javascriptDialogOpening: Flow<Page.JavascriptDialogOpeningParameter>

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

lifecycleEvent

val lifecycleEvent: Flow<Page.LifecycleEventParameter>

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

loadEventFired

val loadEventFired: Flow<Page.LoadEventFiredParameter>

navigatedWithinDocument

val navigatedWithinDocument: Flow<Page.NavigatedWithinDocumentParameter>

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

screencastFrame

val screencastFrame: Flow<Page.ScreencastFrameParameter>

Compressed image data requested by the startScreencast.

screencastVisibilityChanged

val screencastVisibilityChanged: Flow<Page.ScreencastVisibilityChangedParameter>

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

windowOpen

val windowOpen: Flow<Page.WindowOpenParameter>

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

Functions

addCompilationCache

suspend fun addCompilationCache(args: Page.AddCompilationCacheParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun addCompilationCache(url: String, data: String)

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

addScriptToEvaluateOnLoad

suspend fun ~~addScriptToEvaluateOnLoad~~(scriptSource: String): Page.AddScriptToEvaluateOnLoadReturn

suspend fun ~~addScriptToEvaluateOnLoad~~(args: Page.AddScriptToEvaluateOnLoadParameter, mode: CommandMode = CommandMode.DEFAULT): Page.AddScriptToEvaluateOnLoadReturn

Deprecated, please use addScriptToEvaluateOnNewDocument instead.

addScriptToEvaluateOnNewDocument

suspend fun addScriptToEvaluateOnNewDocument(args: Page.AddScriptToEvaluateOnNewDocumentParameter, mode: CommandMode = CommandMode.DEFAULT): Page.AddScriptToEvaluateOnNewDocumentReturn

suspend fun addScriptToEvaluateOnNewDocument(source: String, worldName: String? = null, includeCommandLineAPI: Boolean? = null, runImmediately: Boolean? = null): Page.AddScriptToEvaluateOnNewDocumentReturn

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

bringToFront

suspend fun bringToFront(mode: CommandMode = CommandMode.DEFAULT)

Brings page to front (activates tab).

captureScreenshot

suspend fun captureScreenshot(args: Page.CaptureScreenshotParameter, mode: CommandMode = CommandMode.DEFAULT): Page.CaptureScreenshotReturn

suspend fun captureScreenshot(format: String? = null, quality: Int? = null, clip: Page.Viewport? = null, fromSurface: Boolean? = null, captureBeyondViewport: Boolean? = null, optimizeForSpeed: Boolean? = null): Page.CaptureScreenshotReturn

Capture page screenshot.

captureSnapshot

suspend fun captureSnapshot(format: String? = null): Page.CaptureSnapshotReturn

suspend fun captureSnapshot(args: Page.CaptureSnapshotParameter, mode: CommandMode = CommandMode.DEFAULT): Page.CaptureSnapshotReturn

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

clearCompilationCache

suspend fun clearCompilationCache(mode: CommandMode = CommandMode.DEFAULT)

Clears seeded compilation cache.

clearDeviceMetricsOverride

suspend fun ~~clearDeviceMetricsOverride~~(mode: CommandMode = CommandMode.DEFAULT)

Clears the overridden device metrics.

clearDeviceOrientationOverride

suspend fun ~~clearDeviceOrientationOverride~~(mode: CommandMode = CommandMode.DEFAULT)

Clears the overridden Device Orientation.

clearGeolocationOverride

suspend fun ~~clearGeolocationOverride~~(mode: CommandMode = CommandMode.DEFAULT)

Clears the overridden Geolocation Position and Error.

suspend fun close(mode: CommandMode = CommandMode.DEFAULT)

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

crash

suspend fun crash(mode: CommandMode = CommandMode.DEFAULT)

Crashes renderer on the IO thread, generates minidumps.

createIsolatedWorld

suspend fun createIsolatedWorld(args: Page.CreateIsolatedWorldParameter, mode: CommandMode = CommandMode.DEFAULT): Page.CreateIsolatedWorldReturn

suspend fun createIsolatedWorld(frameId: String, worldName: String? = null, grantUniveralAccess: Boolean? = null): Page.CreateIsolatedWorldReturn

Creates an isolated world for the given frame.

deleteCookie

suspend fun ~~deleteCookie~~(args: Page.DeleteCookieParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun ~~deleteCookie~~(cookieName: String, url: String)

Deletes browser cookie with given name, domain and path.

disable

suspend fun disable(mode: CommandMode = CommandMode.DEFAULT)

Disables page domain notifications.

enable

suspend fun enable(enableFileChooserOpenedEvent: Boolean? = null)

suspend fun enable(args: Page.EnableParameter, mode: CommandMode = CommandMode.DEFAULT)

Enables page domain notifications.

generateTestReport

suspend fun generateTestReport(args: Page.GenerateTestReportParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun generateTestReport(message: String, group: String? = null)

Generates a report for testing.

getAdScriptAncestry

suspend fun getAdScriptAncestry(frameId: String): Page.GetAdScriptAncestryReturn

suspend fun getAdScriptAncestry(args: Page.GetAdScriptAncestryParameter, mode: CommandMode = CommandMode.DEFAULT): Page.GetAdScriptAncestryReturn

getAppId

suspend fun getAppId(mode: CommandMode = CommandMode.DEFAULT): Page.GetAppIdReturn

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

getAppManifest

suspend fun getAppManifest(manifestId: String? = null): Page.GetAppManifestReturn

suspend fun getAppManifest(args: Page.GetAppManifestParameter, mode: CommandMode = CommandMode.DEFAULT): Page.GetAppManifestReturn

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.

getFrameTree

suspend fun getFrameTree(mode: CommandMode = CommandMode.DEFAULT): Page.GetFrameTreeReturn

Returns present frame tree structure.

getInstallabilityErrors

suspend fun getInstallabilityErrors(mode: CommandMode = CommandMode.DEFAULT): Page.GetInstallabilityErrorsReturn

getLayoutMetrics

suspend fun getLayoutMetrics(mode: CommandMode = CommandMode.DEFAULT): Page.GetLayoutMetricsReturn

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

getManifestIcons

suspend fun ~~getManifestIcons~~(mode: CommandMode = CommandMode.DEFAULT): Page.GetManifestIconsReturn

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

getNavigationHistory

suspend fun getNavigationHistory(mode: CommandMode = CommandMode.DEFAULT): Page.GetNavigationHistoryReturn

Returns navigation history for the current page.

getOriginTrials

suspend fun getOriginTrials(frameId: String): Page.GetOriginTrialsReturn

suspend fun getOriginTrials(args: Page.GetOriginTrialsParameter, mode: CommandMode = CommandMode.DEFAULT): Page.GetOriginTrialsReturn

Get Origin Trials on given frame.

getPermissionsPolicyState

suspend fun getPermissionsPolicyState(frameId: String): Page.GetPermissionsPolicyStateReturn

suspend fun getPermissionsPolicyState(args: Page.GetPermissionsPolicyStateParameter, mode: CommandMode = CommandMode.DEFAULT): Page.GetPermissionsPolicyStateReturn

Get Permissions Policy state on given frame.

getResourceContent

suspend fun getResourceContent(args: Page.GetResourceContentParameter, mode: CommandMode = CommandMode.DEFAULT): Page.GetResourceContentReturn

suspend fun getResourceContent(frameId: String, url: String): Page.GetResourceContentReturn

Returns content of the given resource.

getResourceTree

suspend fun getResourceTree(mode: CommandMode = CommandMode.DEFAULT): Page.GetResourceTreeReturn

Returns present frame / resource tree structure.

handleJavaScriptDialog

suspend fun handleJavaScriptDialog(args: Page.HandleJavaScriptDialogParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun handleJavaScriptDialog(accept: Boolean, promptText: String? = null)

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

navigate

suspend fun navigate(args: Page.NavigateParameter, mode: CommandMode = CommandMode.DEFAULT): Page.NavigateReturn

suspend fun navigate(url: String, referrer: String? = null, transitionType: Page.TransitionType? = null, frameId: String? = null, referrerPolicy: Page.ReferrerPolicy? = null): Page.NavigateReturn

Navigates current page to the given URL.

navigateToHistoryEntry

suspend fun navigateToHistoryEntry(entryId: Int)

suspend fun navigateToHistoryEntry(args: Page.NavigateToHistoryEntryParameter, mode: CommandMode = CommandMode.DEFAULT)

Navigates current page to the given history entry.

printToPDF

suspend fun printToPDF(args: Page.PrintToPDFParameter, mode: CommandMode = CommandMode.DEFAULT): Page.PrintToPDFReturn

suspend fun printToPDF(landscape: Boolean? = null, displayHeaderFooter: Boolean? = null, printBackground: Boolean? = null, scale: Double? = null, paperWidth: Double? = null, paperHeight: Double? = null, marginTop: Double? = null, marginBottom: Double? = null, marginLeft: Double? = null, marginRight: Double? = null, pageRanges: String? = null, headerTemplate: String? = null, footerTemplate: String? = null, preferCSSPageSize: Boolean? = null, transferMode: String? = null, generateTaggedPDF: Boolean? = null, generateDocumentOutline: Boolean? = null): Page.PrintToPDFReturn

Print page as PDF.

produceCompilationCache

suspend fun produceCompilationCache(scripts: List<Page.CompilationCacheParams>)

suspend fun produceCompilationCache(args: Page.ProduceCompilationCacheParameter, mode: CommandMode = CommandMode.DEFAULT)

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.

reload

suspend fun reload(args: Page.ReloadParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun reload(ignoreCache: Boolean? = null, scriptToEvaluateOnLoad: String? = null, loaderId: String? = null)

Reloads given page optionally ignoring the cache.

removeScriptToEvaluateOnLoad

suspend fun ~~removeScriptToEvaluateOnLoad~~(identifier: String)

suspend fun ~~removeScriptToEvaluateOnLoad~~(args: Page.RemoveScriptToEvaluateOnLoadParameter, mode: CommandMode = CommandMode.DEFAULT)

Deprecated, please use removeScriptToEvaluateOnNewDocument instead.

removeScriptToEvaluateOnNewDocument

suspend fun removeScriptToEvaluateOnNewDocument(identifier: String)

suspend fun removeScriptToEvaluateOnNewDocument(args: Page.RemoveScriptToEvaluateOnNewDocumentParameter, mode: CommandMode = CommandMode.DEFAULT)

Removes given script from the list.

resetNavigationHistory

suspend fun resetNavigationHistory(mode: CommandMode = CommandMode.DEFAULT)

Resets navigation history for the current page.

screencastFrameAck

suspend fun screencastFrameAck(sessionId: Int)

suspend fun screencastFrameAck(args: Page.ScreencastFrameAckParameter, mode: CommandMode = CommandMode.DEFAULT)

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

searchInResource

suspend fun searchInResource(args: Page.SearchInResourceParameter, mode: CommandMode = CommandMode.DEFAULT): Page.SearchInResourceReturn

suspend fun searchInResource(frameId: String, url: String, query: String, caseSensitive: Boolean? = null, isRegex: Boolean? = null): Page.SearchInResourceReturn

Searches for given string in resource content.

setAdBlockingEnabled

suspend fun setAdBlockingEnabled(enabled: Boolean)

suspend fun setAdBlockingEnabled(args: Page.SetAdBlockingEnabledParameter, mode: CommandMode = CommandMode.DEFAULT)

Enable Chrome's experimental ad filter on all sites.

setBypassCSP

suspend fun setBypassCSP(enabled: Boolean)

suspend fun setBypassCSP(args: Page.SetBypassCSPParameter, mode: CommandMode = CommandMode.DEFAULT)

Enable page Content Security Policy by-passing.

setDeviceMetricsOverride

suspend fun ~~setDeviceMetricsOverride~~(args: Page.SetDeviceMetricsOverrideParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun ~~setDeviceMetricsOverride~~(width: Int, height: Int, deviceScaleFactor: Double, mobile: Boolean, scale: Double? = null, screenWidth: Int? = null, screenHeight: Int? = null, positionX: Int? = null, positionY: Int? = null, dontSetVisibleSize: Boolean? = null, screenOrientation: Emulation.ScreenOrientation? = null, viewport: Page.Viewport? = null)

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

setDeviceOrientationOverride

suspend fun ~~setDeviceOrientationOverride~~(args: Page.SetDeviceOrientationOverrideParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun ~~setDeviceOrientationOverride~~(alpha: Double, beta: Double, gamma: Double)

Overrides the Device Orientation.

setDocumentContent

suspend fun setDocumentContent(args: Page.SetDocumentContentParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun setDocumentContent(frameId: String, html: String)

Sets given markup as the document's HTML.

setDownloadBehavior

suspend fun ~~setDownloadBehavior~~(args: Page.SetDownloadBehaviorParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun ~~setDownloadBehavior~~(behavior: String, downloadPath: String? = null)

Set the behavior when downloading a file.

setFontFamilies

suspend fun setFontFamilies(fontFamilies: Page.FontFamilies, forScripts: List<Page.ScriptFontFamilies>? = null)

suspend fun setFontFamilies(args: Page.SetFontFamiliesParameter, mode: CommandMode = CommandMode.DEFAULT)

Set generic font families.

setFontSizes

suspend fun setFontSizes(fontSizes: Page.FontSizes)

suspend fun setFontSizes(args: Page.SetFontSizesParameter, mode: CommandMode = CommandMode.DEFAULT)

Set default font sizes.

setGeolocationOverride

suspend fun ~~setGeolocationOverride~~(args: Page.SetGeolocationOverrideParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun ~~setGeolocationOverride~~(latitude: Double? = null, longitude: Double? = null, accuracy: Double? = null)

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

setInterceptFileChooserDialog

suspend fun setInterceptFileChooserDialog(args: Page.SetInterceptFileChooserDialogParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun setInterceptFileChooserDialog(enabled: Boolean, cancel: Boolean? = null)

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.

setLifecycleEventsEnabled

suspend fun setLifecycleEventsEnabled(enabled: Boolean)

suspend fun setLifecycleEventsEnabled(args: Page.SetLifecycleEventsEnabledParameter, mode: CommandMode = CommandMode.DEFAULT)

Controls whether page will emit lifecycle events.

setPrerenderingAllowed

suspend fun setPrerenderingAllowed(isAllowed: Boolean)

suspend fun setPrerenderingAllowed(args: Page.SetPrerenderingAllowedParameter, mode: CommandMode = CommandMode.DEFAULT)

Enable/disable prerendering manually.

setRPHRegistrationMode

suspend fun setRPHRegistrationMode(mode: String)

suspend fun setRPHRegistrationMode(args: Page.SetRPHRegistrationModeParameter, mode: CommandMode = CommandMode.DEFAULT)

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

setSPCTransactionMode

suspend fun setSPCTransactionMode(mode: String)

suspend fun setSPCTransactionMode(args: Page.SetSPCTransactionModeParameter, mode: CommandMode = CommandMode.DEFAULT)

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

setTouchEmulationEnabled

suspend fun ~~setTouchEmulationEnabled~~(args: Page.SetTouchEmulationEnabledParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun ~~setTouchEmulationEnabled~~(enabled: Boolean, configuration: String? = null)

Toggles mouse event-based touch event emulation.

setWebLifecycleState

suspend fun setWebLifecycleState(state: String)

suspend fun setWebLifecycleState(args: Page.SetWebLifecycleStateParameter, mode: CommandMode = CommandMode.DEFAULT)

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/

startScreencast

suspend fun startScreencast(args: Page.StartScreencastParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun startScreencast(format: String? = null, quality: Int? = null, maxWidth: Int? = null, maxHeight: Int? = null, everyNthFrame: Int? = null)

Starts sending each frame using the screencastFrame event.

stopLoading

suspend fun stopLoading(mode: CommandMode = CommandMode.DEFAULT)

Force the page stop all navigations and pending resource fetches.

stopScreencast

suspend fun stopScreencast(mode: CommandMode = CommandMode.DEFAULT)

Stops sending each frame in the screencastFrame.

waitForDebugger

suspend fun waitForDebugger(mode: CommandMode = CommandMode.DEFAULT)

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