chrome-devtools-kotlin/org.hildan.chrome.devtools.domains.page

Package-level declarations

Types

AddCompilationCacheRequest

@Serializable

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

Request object containing input parameters for the PageDomain.addCompilationCache command.

AddCompilationCacheResponse

@Serializable

object AddCompilationCacheResponse

A dummy response object for the PageDomain.addCompilationCache command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

AddScriptToEvaluateOnLoadRequest

@Serializable

data class ~~AddScriptToEvaluateOnLoadRequest~~(val scriptSource: String)

Request object containing input parameters for the PageDomain.addScriptToEvaluateOnLoad command.

AddScriptToEvaluateOnLoadResponse

@Serializable

data class ~~AddScriptToEvaluateOnLoadResponse~~(val identifier: ScriptIdentifier)

Response type for the PageDomain.addScriptToEvaluateOnLoad command.

AddScriptToEvaluateOnNewDocumentRequest

@Serializable

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

Request object containing input parameters for the PageDomain.addScriptToEvaluateOnNewDocument command.

AddScriptToEvaluateOnNewDocumentResponse

@Serializable

data class AddScriptToEvaluateOnNewDocumentResponse(val identifier: ScriptIdentifier)

Response type for the PageDomain.addScriptToEvaluateOnNewDocument command.

AdFrameExplanation

@Serializable

enum AdFrameExplanation : Enum<AdFrameExplanation>

(undocumented in the protocol definition)

AdFrameStatus

@Serializable

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

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

AdFrameType

@Serializable

enum AdFrameType : Enum<AdFrameType>

Indicates whether a frame has been identified as an ad.

AdScriptId

@Serializable

data class AdScriptId(val scriptId: ScriptId, val debuggerId: UniqueDebuggerId)

Identifies the bottom-most script which caused the 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.

AutoResponseMode

@Serializable

enum AutoResponseMode : Enum<AutoResponseMode>

Enum of possible auto-response for permission / prompt dialogs.

BackForwardCacheBlockingDetails

@Serializable

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

(undocumented in the protocol definition)

BackForwardCacheNotRestoredExplanation

@Serializable

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

(undocumented in the protocol definition)

BackForwardCacheNotRestoredExplanationTree

@Serializable

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

(undocumented in the protocol definition)

BackForwardCacheNotRestoredReason

@Serializable

enum BackForwardCacheNotRestoredReason : Enum<BackForwardCacheNotRestoredReason>

List of not restored reasons for back-forward cache.

BackForwardCacheNotRestoredReasonType

@Serializable

enum BackForwardCacheNotRestoredReasonType : Enum<BackForwardCacheNotRestoredReasonType>

Types of not restored reasons for back-forward cache.

BringToFrontResponse

@Serializable

object BringToFrontResponse

A dummy response object for the PageDomain.bringToFront command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

CaptureScreenshotRequest

@Serializable

data class CaptureScreenshotRequest(val format: ScreenshotFormat? = null, val quality: Int? = null, val clip: Viewport? = null, val fromSurface: Boolean? = null, val captureBeyondViewport: Boolean? = null, val optimizeForSpeed: Boolean? = null)

Request object containing input parameters for the PageDomain.captureScreenshot command.

CaptureScreenshotResponse

@Serializable

data class CaptureScreenshotResponse(val data: String)

Response type for the PageDomain.captureScreenshot command.

CaptureSnapshotRequest

@Serializable

data class CaptureSnapshotRequest(val format: SnapshotFormat? = null)

Request object containing input parameters for the PageDomain.captureSnapshot command.

CaptureSnapshotResponse

@Serializable

data class CaptureSnapshotResponse(val data: String)

Response type for the PageDomain.captureSnapshot command.

ClearCompilationCacheResponse

@Serializable

object ClearCompilationCacheResponse

A dummy response object for the PageDomain.clearCompilationCache command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

ClearDeviceMetricsOverrideResponse

@Serializable

object ~~ClearDeviceMetricsOverrideResponse~~

A dummy response object for the PageDomain.clearDeviceMetricsOverride command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

ClearDeviceOrientationOverrideResponse

@Serializable

object ~~ClearDeviceOrientationOverrideResponse~~

A dummy response object for the PageDomain.clearDeviceOrientationOverride command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

ClearGeolocationOverrideResponse

@Serializable

object ~~ClearGeolocationOverrideResponse~~

A dummy response object for the PageDomain.clearGeolocationOverride command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

ClientNavigationDisposition

@Serializable

enum ClientNavigationDisposition : Enum<ClientNavigationDisposition>

(undocumented in the protocol definition)

ClientNavigationReason

@Serializable

enum ClientNavigationReason : Enum<ClientNavigationReason>

(undocumented in the protocol definition)

CloseResponse

@Serializable

object CloseResponse

A dummy response object for the PageDomain.close command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

CompilationCacheParams

@Serializable

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

Per-script compilation cache parameters for Page.produceCompilationCache

CrashResponse

@Serializable

object CrashResponse

A dummy response object for the PageDomain.crash command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

CreateIsolatedWorldRequest

@Serializable

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

Request object containing input parameters for the PageDomain.createIsolatedWorld command.

CreateIsolatedWorldResponse

@Serializable

data class CreateIsolatedWorldResponse(val executionContextId: ExecutionContextId)

Response type for the PageDomain.createIsolatedWorld command.

CrossOriginIsolatedContextType

@Serializable

enum CrossOriginIsolatedContextType : Enum<CrossOriginIsolatedContextType>

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

DeleteCookieRequest

@Serializable

data class ~~DeleteCookieRequest~~(val cookieName: String, val url: String)

Request object containing input parameters for the PageDomain.deleteCookie command.

DeleteCookieResponse

@Serializable

object ~~DeleteCookieResponse~~

A dummy response object for the PageDomain.deleteCookie command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

DialogType

@Serializable

enum DialogType : Enum<DialogType>

Javascript dialog type.

DisableResponse

@Serializable

object DisableResponse

A dummy response object for the PageDomain.disable command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

DownloadBehavior

@Serializable

enum DownloadBehavior : Enum<DownloadBehavior>

This enum doesn't have a proper description because it was generated from an inline declaration. Its name was inferred based on the place where it is used:

DownloadProgressState

@Serializable

enum DownloadProgressState : Enum<DownloadProgressState>

This enum doesn't have a proper description because it was generated from an inline declaration. Its name was inferred based on the place where it is used:

EnableResponse

@Serializable

object EnableResponse

A dummy response object for the PageDomain.enable command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

FileChooserOpenedMode

@Serializable

enum FileChooserOpenedMode : Enum<FileChooserOpenedMode>

This enum doesn't have a proper description because it was generated from an inline declaration. Its name was inferred based on the place where it is used:

FileFilter

@Serializable

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

(undocumented in the protocol definition)

FileHandler

@Serializable

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

(undocumented in the protocol definition)

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: FrameId, val parentId: FrameId? = null, val loaderId: LoaderId, val name: String? = null, val url: String, val urlFragment: String? = null, val domainAndRegistry: String? = null, val securityOrigin: String, val mimeType: String, val unreachableUrl: String? = null, val adFrameStatus: AdFrameStatus? = null, val secureContextType: SecureContextType? = null, val crossOriginIsolatedContextType: CrossOriginIsolatedContextType? = null, val gatedAPIFeatures: List<GatedAPIFeatures>? = null)

Information about the Frame on the page.

FrameDetachedReason

@Serializable

enum FrameDetachedReason : Enum<FrameDetachedReason>

This enum doesn't have a proper description because it was generated from an inline declaration. Its name was inferred based on the place where it is used:

FrameId

typealias FrameId = String

Unique frame identifier.

FrameResource

@Serializable

data class FrameResource(val url: String, val type: ResourceType, val mimeType: String, val lastModified: TimeSinceEpoch? = 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: Frame, val childFrames: List<FrameResourceTree>? = null, val resources: List<FrameResource>)

Information about the Frame hierarchy along with their cached resources.

FrameTree

@Serializable

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

Information about the Frame hierarchy.

GatedAPIFeatures

@Serializable

enum GatedAPIFeatures : Enum<GatedAPIFeatures>

(undocumented in the protocol definition)

GenerateTestReportRequest

@Serializable

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

Request object containing input parameters for the PageDomain.generateTestReport command.

GenerateTestReportResponse

@Serializable

object GenerateTestReportResponse

A dummy response object for the PageDomain.generateTestReport command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

GetAdScriptIdRequest

@Serializable

data class GetAdScriptIdRequest(val frameId: FrameId)

Request object containing input parameters for the PageDomain.getAdScriptId command.

GetAdScriptIdResponse

@Serializable

data class GetAdScriptIdResponse(val adScriptId: AdScriptId? = null)

Response type for the PageDomain.getAdScriptId command.

GetAppIdResponse

@Serializable

data class GetAppIdResponse(val appId: String? = null, val recommendedId: String? = null)

Response type for the PageDomain.getAppId command.

GetAppManifestRequest

@Serializable

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

Request object containing input parameters for the PageDomain.getAppManifest command.

GetAppManifestResponse

@Serializable

data class GetAppManifestResponse(val url: String, val errors: List<AppManifestError>, val data: String? = null, val parsed: AppManifestParsedProperties? = null, val manifest: WebAppManifest? = null)

Response type for the PageDomain.getAppManifest command.

GetFrameTreeResponse

@Serializable

data class GetFrameTreeResponse(val frameTree: FrameTree)

Response type for the PageDomain.getFrameTree command.

GetInstallabilityErrorsResponse

@Serializable

data class GetInstallabilityErrorsResponse(val installabilityErrors: List<InstallabilityError>)

Response type for the PageDomain.getInstallabilityErrors command.

GetLayoutMetricsResponse

@Serializable

data class GetLayoutMetricsResponse(val layoutViewport: LayoutViewport, val visualViewport: VisualViewport, val contentSize: Rect, val cssLayoutViewport: LayoutViewport, val cssVisualViewport: VisualViewport, val cssContentSize: Rect)

Response type for the PageDomain.getLayoutMetrics command.

GetManifestIconsResponse

@Serializable

data class ~~GetManifestIconsResponse~~(val primaryIcon: String? = null)

Response type for the PageDomain.getManifestIcons command.

GetNavigationHistoryResponse

@Serializable

data class GetNavigationHistoryResponse(val currentIndex: Int, val entries: List<NavigationEntry>)

Response type for the PageDomain.getNavigationHistory command.

GetOriginTrialsRequest

@Serializable

data class GetOriginTrialsRequest(val frameId: FrameId)

Request object containing input parameters for the PageDomain.getOriginTrials command.

GetOriginTrialsResponse

@Serializable

data class GetOriginTrialsResponse(val originTrials: List<OriginTrial>)

Response type for the PageDomain.getOriginTrials command.

GetPermissionsPolicyStateRequest

@Serializable

data class GetPermissionsPolicyStateRequest(val frameId: FrameId)

Request object containing input parameters for the PageDomain.getPermissionsPolicyState command.

GetPermissionsPolicyStateResponse

@Serializable

data class GetPermissionsPolicyStateResponse(val states: List<PermissionsPolicyFeatureState>)

Response type for the PageDomain.getPermissionsPolicyState command.

GetResourceContentRequest

@Serializable

data class GetResourceContentRequest(val frameId: FrameId, val url: String)

Request object containing input parameters for the PageDomain.getResourceContent command.

GetResourceContentResponse

@Serializable

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

Response type for the PageDomain.getResourceContent command.

GetResourceTreeResponse

@Serializable

data class GetResourceTreeResponse(val frameTree: FrameResourceTree)

Response type for the PageDomain.getResourceTree command.

HandleJavaScriptDialogRequest

@Serializable

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

Request object containing input parameters for the PageDomain.handleJavaScriptDialog command.

HandleJavaScriptDialogResponse

@Serializable

object HandleJavaScriptDialogResponse

A dummy response object for the PageDomain.handleJavaScriptDialog command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

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

The installability error

InstallabilityErrorArgument

@Serializable

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

(undocumented in the protocol definition)

LaunchHandler

@Serializable

data class LaunchHandler(val clientMode: String)

(undocumented in the protocol definition)

LayoutViewport

@Serializable

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

Layout viewport position and dimensions.

NavigateRequest

@Serializable

data class NavigateRequest(val url: String, val referrer: String? = null, val transitionType: TransitionType? = null, val frameId: FrameId? = null, val referrerPolicy: ReferrerPolicy? = null)

Request object containing input parameters for the PageDomain.navigate command.

NavigateResponse

@Serializable

data class NavigateResponse(val frameId: FrameId, val loaderId: LoaderId? = null, val errorText: String? = null)

Response type for the PageDomain.navigate command.

NavigateToHistoryEntryRequest

@Serializable

data class NavigateToHistoryEntryRequest(val entryId: Int)

Request object containing input parameters for the PageDomain.navigateToHistoryEntry command.

NavigateToHistoryEntryResponse

@Serializable

object NavigateToHistoryEntryResponse

A dummy response object for the PageDomain.navigateToHistoryEntry command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

NavigationEntry

@Serializable

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

Navigation history entry.

NavigationType

@Serializable

enum NavigationType : Enum<NavigationType>

The type of a frameNavigated event.

OriginTrial

@Serializable

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

(undocumented in the protocol definition)

OriginTrialStatus

@Serializable

enum OriginTrialStatus : Enum<OriginTrialStatus>

Status for an Origin Trial.

OriginTrialToken

@Serializable

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

(undocumented in the protocol definition)

OriginTrialTokenStatus

@Serializable

enum OriginTrialTokenStatus : Enum<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: OriginTrialToken? = null, val status: OriginTrialTokenStatus)

(undocumented in the protocol definition)

OriginTrialUsageRestriction

@Serializable

enum OriginTrialUsageRestriction : Enum<OriginTrialUsageRestriction>

(undocumented in the protocol definition)

PageDomain

class PageDomain

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

PermissionsPolicyBlockLocator

@Serializable

data class PermissionsPolicyBlockLocator(val frameId: FrameId, val blockReason: PermissionsPolicyBlockReason)

(undocumented in the protocol definition)

PermissionsPolicyBlockReason

@Serializable

enum PermissionsPolicyBlockReason : Enum<PermissionsPolicyBlockReason>

Reason for a permissions policy feature to be disabled.

PermissionsPolicyFeature

@Serializable

enum PermissionsPolicyFeature : Enum<PermissionsPolicyFeature>

All Permissions Policy features. This enum should match the one defined in third_party/blink/renderer/core/permissions_policy/permissions_policy_features.json5.

PermissionsPolicyFeatureState

@Serializable

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

(undocumented in the protocol definition)

PrintToPDFRequest

@Serializable

data class PrintToPDFRequest(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: TransferMode? = null, val generateTaggedPDF: Boolean? = null, val generateDocumentOutline: Boolean? = null)

Request object containing input parameters for the PageDomain.printToPDF command.

PrintToPDFResponse

@Serializable

data class PrintToPDFResponse(val data: String, val stream: StreamHandle? = null)

Response type for the PageDomain.printToPDF command.

ProduceCompilationCacheRequest

@Serializable

data class ProduceCompilationCacheRequest(val scripts: List<CompilationCacheParams>)

Request object containing input parameters for the PageDomain.produceCompilationCache command.

ProduceCompilationCacheResponse

@Serializable

object ProduceCompilationCacheResponse

A dummy response object for the PageDomain.produceCompilationCache command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

ProtocolHandler

@Serializable

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

(undocumented in the protocol definition)

ReferrerPolicy

@Serializable

enum ReferrerPolicy : Enum<ReferrerPolicy>

The referring-policy used for the navigation.

RelatedApplication

@Serializable

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

(undocumented in the protocol definition)

ReloadRequest

@Serializable

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

Request object containing input parameters for the PageDomain.reload command.

ReloadResponse

@Serializable

object ReloadResponse

A dummy response object for the PageDomain.reload command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

RemoveScriptToEvaluateOnLoadRequest

@Serializable

data class ~~RemoveScriptToEvaluateOnLoadRequest~~(val identifier: ScriptIdentifier)

Request object containing input parameters for the PageDomain.removeScriptToEvaluateOnLoad command.

RemoveScriptToEvaluateOnLoadResponse

@Serializable

object ~~RemoveScriptToEvaluateOnLoadResponse~~

A dummy response object for the PageDomain.removeScriptToEvaluateOnLoad command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

RemoveScriptToEvaluateOnNewDocumentRequest

@Serializable

data class RemoveScriptToEvaluateOnNewDocumentRequest(val identifier: ScriptIdentifier)

Request object containing input parameters for the PageDomain.removeScriptToEvaluateOnNewDocument command.

RemoveScriptToEvaluateOnNewDocumentResponse

@Serializable

object RemoveScriptToEvaluateOnNewDocumentResponse

A dummy response object for the PageDomain.removeScriptToEvaluateOnNewDocument command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

ResetNavigationHistoryResponse

@Serializable

object ResetNavigationHistoryResponse

A dummy response object for the PageDomain.resetNavigationHistory command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

ScopeExtension

@Serializable

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

(undocumented in the protocol definition)

ScreencastFormat

@Serializable

enum ScreencastFormat : Enum<ScreencastFormat>

This enum doesn't have a proper description because it was generated from an inline declaration. Its name was inferred based on the place where it is used:

ScreencastFrameAckRequest

@Serializable

data class ScreencastFrameAckRequest(val sessionId: Int)

Request object containing input parameters for the PageDomain.screencastFrameAck command.

ScreencastFrameAckResponse

@Serializable

object ScreencastFrameAckResponse

A dummy response object for the PageDomain.screencastFrameAck command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

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: TimeSinceEpoch? = null)

Screencast frame metadata.

Screenshot

@Serializable

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

(undocumented in the protocol definition)

ScreenshotFormat

@Serializable

enum ScreenshotFormat : Enum<ScreenshotFormat>

This enum doesn't have a proper description because it was generated from an inline declaration. Its name was inferred based on the place where it is used:

ScriptFontFamilies

@Serializable

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

Font families collection for a script.

ScriptIdentifier

typealias ScriptIdentifier = String

Unique script identifier.

SearchInResourceRequest

@Serializable

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

Request object containing input parameters for the PageDomain.searchInResource command.

SearchInResourceResponse

@Serializable

data class SearchInResourceResponse(val result: List<SearchMatch>)

Response type for the PageDomain.searchInResource command.

SecureContextType

@Serializable

enum SecureContextType : Enum<SecureContextType>

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

SetAdBlockingEnabledRequest

@Serializable

data class SetAdBlockingEnabledRequest(val enabled: Boolean)

Request object containing input parameters for the PageDomain.setAdBlockingEnabled command.

SetAdBlockingEnabledResponse

@Serializable

object SetAdBlockingEnabledResponse

A dummy response object for the PageDomain.setAdBlockingEnabled command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

SetBypassCSPRequest

@Serializable

data class SetBypassCSPRequest(val enabled: Boolean)

Request object containing input parameters for the PageDomain.setBypassCSP command.

SetBypassCSPResponse

@Serializable

object SetBypassCSPResponse

A dummy response object for the PageDomain.setBypassCSP command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

SetDeviceMetricsOverrideRequest

@Serializable

data class ~~SetDeviceMetricsOverrideRequest~~(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: ScreenOrientation? = null, val viewport: Viewport? = null)

Request object containing input parameters for the PageDomain.setDeviceMetricsOverride command.

SetDeviceMetricsOverrideResponse

@Serializable

object ~~SetDeviceMetricsOverrideResponse~~

A dummy response object for the PageDomain.setDeviceMetricsOverride command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

SetDeviceOrientationOverrideRequest

@Serializable

data class ~~SetDeviceOrientationOverrideRequest~~(val alpha: Double, val beta: Double, val gamma: Double)

Request object containing input parameters for the PageDomain.setDeviceOrientationOverride command.

SetDeviceOrientationOverrideResponse

@Serializable

object ~~SetDeviceOrientationOverrideResponse~~

A dummy response object for the PageDomain.setDeviceOrientationOverride command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

SetDocumentContentRequest

@Serializable

data class SetDocumentContentRequest(val frameId: FrameId, val html: String)

Request object containing input parameters for the PageDomain.setDocumentContent command.

SetDocumentContentResponse

@Serializable

object SetDocumentContentResponse

A dummy response object for the PageDomain.setDocumentContent command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

SetDownloadBehaviorRequest

@Serializable

data class ~~SetDownloadBehaviorRequest~~(val behavior: DownloadBehavior, val downloadPath: String? = null)

Request object containing input parameters for the PageDomain.setDownloadBehavior command.

SetDownloadBehaviorResponse

@Serializable

object ~~SetDownloadBehaviorResponse~~

A dummy response object for the PageDomain.setDownloadBehavior command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

SetFontFamiliesRequest

@Serializable

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

Request object containing input parameters for the PageDomain.setFontFamilies command.

SetFontFamiliesResponse

@Serializable

object SetFontFamiliesResponse

A dummy response object for the PageDomain.setFontFamilies command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

SetFontSizesRequest

@Serializable

data class SetFontSizesRequest(val fontSizes: FontSizes)

Request object containing input parameters for the PageDomain.setFontSizes command.

SetFontSizesResponse

@Serializable

object SetFontSizesResponse

A dummy response object for the PageDomain.setFontSizes command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

SetGeolocationOverrideRequest

@Serializable

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

Request object containing input parameters for the PageDomain.setGeolocationOverride command.

SetGeolocationOverrideResponse

@Serializable

object ~~SetGeolocationOverrideResponse~~

A dummy response object for the PageDomain.setGeolocationOverride command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

SetInterceptFileChooserDialogRequest

@Serializable

data class SetInterceptFileChooserDialogRequest(val enabled: Boolean)

Request object containing input parameters for the PageDomain.setInterceptFileChooserDialog command.

SetInterceptFileChooserDialogResponse

@Serializable

object SetInterceptFileChooserDialogResponse

A dummy response object for the PageDomain.setInterceptFileChooserDialog command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

SetLifecycleEventsEnabledRequest

@Serializable

data class SetLifecycleEventsEnabledRequest(val enabled: Boolean)

Request object containing input parameters for the PageDomain.setLifecycleEventsEnabled command.

SetLifecycleEventsEnabledResponse

@Serializable

object SetLifecycleEventsEnabledResponse

A dummy response object for the PageDomain.setLifecycleEventsEnabled command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

SetPrerenderingAllowedRequest

@Serializable

data class SetPrerenderingAllowedRequest(val isAllowed: Boolean)

Request object containing input parameters for the PageDomain.setPrerenderingAllowed command.

SetPrerenderingAllowedResponse

@Serializable

object SetPrerenderingAllowedResponse

A dummy response object for the PageDomain.setPrerenderingAllowed command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

SetRPHRegistrationModeRequest

@Serializable

data class SetRPHRegistrationModeRequest(val mode: AutoResponseMode)

Request object containing input parameters for the PageDomain.setRPHRegistrationMode command.

SetRPHRegistrationModeResponse

@Serializable

object SetRPHRegistrationModeResponse

A dummy response object for the PageDomain.setRPHRegistrationMode command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

SetSPCTransactionModeRequest

@Serializable

data class SetSPCTransactionModeRequest(val mode: AutoResponseMode)

Request object containing input parameters for the PageDomain.setSPCTransactionMode command.

SetSPCTransactionModeResponse

@Serializable

object SetSPCTransactionModeResponse

A dummy response object for the PageDomain.setSPCTransactionMode command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

SetTouchEmulationEnabledRequest

@Serializable

data class ~~SetTouchEmulationEnabledRequest~~(val enabled: Boolean, val configuration: TouchEmulationEnabledConfiguration? = null)

Request object containing input parameters for the PageDomain.setTouchEmulationEnabled command.

SetTouchEmulationEnabledResponse

@Serializable

object ~~SetTouchEmulationEnabledResponse~~

A dummy response object for the PageDomain.setTouchEmulationEnabled command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

SetWebLifecycleStateRequest

@Serializable

data class SetWebLifecycleStateRequest(val state: WebLifecycleState)

Request object containing input parameters for the PageDomain.setWebLifecycleState command.

SetWebLifecycleStateResponse

@Serializable

object SetWebLifecycleStateResponse

A dummy response object for the PageDomain.setWebLifecycleState command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

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<FileFilter>? = null)

(undocumented in the protocol definition)

Shortcut

@Serializable

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

(undocumented in the protocol definition)

SnapshotFormat

@Serializable

enum SnapshotFormat : Enum<SnapshotFormat>

This enum doesn't have a proper description because it was generated from an inline declaration. Its name was inferred based on the place where it is used:

StartScreencastRequest

@Serializable

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

Request object containing input parameters for the PageDomain.startScreencast command.

StartScreencastResponse

@Serializable

object StartScreencastResponse

A dummy response object for the PageDomain.startScreencast command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

StopLoadingResponse

@Serializable

object StopLoadingResponse

A dummy response object for the PageDomain.stopLoading command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

StopScreencastResponse

@Serializable

object StopScreencastResponse

A dummy response object for the PageDomain.stopScreencast command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

TouchEmulationEnabledConfiguration

@Serializable

enum TouchEmulationEnabledConfiguration : Enum<TouchEmulationEnabledConfiguration>

This enum doesn't have a proper description because it was generated from an inline declaration. Its name was inferred based on the place where it is used:

TransferMode

@Serializable

enum TransferMode : Enum<TransferMode>

This enum doesn't have a proper description because it was generated from an inline declaration. Its name was inferred based on the place where it is used:

TransitionType

@Serializable

enum TransitionType : Enum<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.

WaitForDebuggerResponse

@Serializable

object WaitForDebuggerResponse

A dummy response object for the PageDomain.waitForDebugger command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

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<FileHandler>? = null, val icons: List<ImageResource>? = null, val id: String? = null, val lang: String? = null, val launchHandler: LaunchHandler? = null, val name: String? = null, val orientation: String? = null, val preferRelatedApplications: Boolean? = null, val protocolHandlers: List<ProtocolHandler>? = null, val relatedApplications: List<RelatedApplication>? = null, val scope: String? = null, val scopeExtensions: List<ScopeExtension>? = null, val screenshots: List<Screenshot>? = null, val shareTarget: ShareTarget? = null, val shortName: String? = null, val shortcuts: List<Shortcut>? = null, val startUrl: String? = null, val themeColor: String? = null)

(undocumented in the protocol definition)

WebLifecycleState

@Serializable

enum WebLifecycleState : Enum<WebLifecycleState>

This enum doesn't have a proper description because it was generated from an inline declaration. Its name was inferred based on the place where it is used:

Functions

captureScreenshotToFile

suspend fun PageDomain.captureScreenshotToFile(outputImagePath: Path, options: CaptureScreenshotRequest.Builder.() -> Unit = {})

Captures a screenshot of the current page based on the given options, and stores the resulting image into a new file at the given outputImagePath. If the file already exists, it is overwritten.

decodeData

fun CaptureScreenshotResponse.decodeData(): ByteArray

Decodes the base64 data of the screenshot into image bytes.