pl.wendigo.chrome.api.page

Package pl.wendigo.chrome.api.page

Contains DevTools Protocol Page domain implementation accessible via PageOperations class.

Types

AddCompilationCacheRequest

data class AddCompilationCacheRequest

Represents request frame that can be used with Page#addCompilationCache operation call.

AddScriptToEvaluateOnLoadRequest

data class AddScriptToEvaluateOnLoadRequest

Represents request frame that can be used with Page#addScriptToEvaluateOnLoad operation call.

AddScriptToEvaluateOnLoadResponse

data class AddScriptToEvaluateOnLoadResponse

Represents response frame that is returned from Page#addScriptToEvaluateOnLoad operation call. Deprecated, please use addScriptToEvaluateOnNewDocument instead.

AddScriptToEvaluateOnNewDocumentRequest

data class AddScriptToEvaluateOnNewDocumentRequest

Represents request frame that can be used with Page#addScriptToEvaluateOnNewDocument operation call.

AddScriptToEvaluateOnNewDocumentResponse

data class AddScriptToEvaluateOnNewDocumentResponse

Represents response frame that is returned from Page#addScriptToEvaluateOnNewDocument operation call. Evaluates given script in every frame upon creation (before loading frame's scripts).

AppManifestError

data class AppManifestError

Error while paring app manifest.

AppManifestParsedProperties

data class AppManifestParsedProperties

Parsed app manifest properties.

CaptureScreenshotRequest

data class CaptureScreenshotRequest

Represents request frame that can be used with Page#captureScreenshot operation call.

CaptureScreenshotResponse

data class CaptureScreenshotResponse

Represents response frame that is returned from Page#captureScreenshot operation call. Capture page screenshot.

CaptureSnapshotRequest

data class CaptureSnapshotRequest

Represents request frame that can be used with Page#captureSnapshot operation call.

CaptureSnapshotResponse

data class CaptureSnapshotResponse

Represents response frame that is returned from Page#captureSnapshot operation call. Returns a snapshot of the page as a string. For MHTML format, the serialization includes iframes, shadow DOM, external resources, and element-inline styles.

ClientNavigationReason

enum class ClientNavigationReason

CompilationCacheProducedEvent

data class CompilationCacheProducedEvent : Event

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

CreateIsolatedWorldRequest

data class CreateIsolatedWorldRequest

Represents request frame that can be used with Page#createIsolatedWorld operation call.

CreateIsolatedWorldResponse

data class CreateIsolatedWorldResponse

Represents response frame that is returned from Page#createIsolatedWorld operation call. Creates an isolated world for the given frame.

DeleteCookieRequest

data class DeleteCookieRequest

Represents request frame that can be used with Page#deleteCookie operation call.

DialogType

enum class DialogType

Javascript dialog type.

DomContentEventFiredEvent

data class DomContentEventFiredEvent : Event

DownloadWillBeginEvent

data class DownloadWillBeginEvent : Event

Fired when page is about to start a download.

FileChooserOpenedEvent

data class FileChooserOpenedEvent : Event

Emitted only when page.interceptFileChooser is enabled.

FontFamilies

data class FontFamilies

Generic font families collection.

FontSizes

data class FontSizes

Default font sizes.

Frame

data class Frame

Information about the Frame on the page.

FrameAttachedEvent

data class FrameAttachedEvent : Event

Fired when frame has been attached to its parent.

FrameClearedScheduledNavigationEvent

data class FrameClearedScheduledNavigationEvent : Event

Fired when frame no longer has a scheduled navigation.

FrameDetachedEvent

data class FrameDetachedEvent : Event

Fired when frame has been detached from its parent.

FrameNavigatedEvent

data class FrameNavigatedEvent : Event

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

FrameRequestedNavigationEvent

data class FrameRequestedNavigationEvent : Event

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

FrameResource

data class FrameResource

Information about the Resource on the page.

FrameResourceTree

data class FrameResourceTree

Information about the Frame hierarchy along with their cached resources.

FrameScheduledNavigationEvent

data class FrameScheduledNavigationEvent : Event

Fired when frame schedules a potential navigation.

FrameStartedLoadingEvent

data class FrameStartedLoadingEvent : Event

Fired when frame has started loading.

FrameStoppedLoadingEvent

data class FrameStoppedLoadingEvent : Event

Fired when frame has stopped loading.

FrameTree

data class FrameTree

Information about the Frame hierarchy.

GenerateTestReportRequest

data class GenerateTestReportRequest

Represents request frame that can be used with Page#generateTestReport operation call.

GetAppManifestResponse

data class GetAppManifestResponse

Represents response frame that is returned from Page#getAppManifest operation call.

GetCookiesResponse

data class GetCookiesResponse

Represents response frame that is returned from Page#getCookies operation call. Returns all browser cookies. Depending on the backend support, will return detailed cookie information in the cookies field.

GetFrameTreeResponse

data class GetFrameTreeResponse

Represents response frame that is returned from Page#getFrameTree operation call. Returns present frame tree structure.

GetInstallabilityErrorsResponse

data class GetInstallabilityErrorsResponse

Represents response frame that is returned from Page#getInstallabilityErrors operation call.

GetLayoutMetricsResponse

data class GetLayoutMetricsResponse

Represents response frame that is returned from Page#getLayoutMetrics operation call. Returns metrics relating to the layouting of the page, such as viewport bounds/scale.

GetManifestIconsResponse

data class GetManifestIconsResponse

Represents response frame that is returned from Page#getManifestIcons operation call.

GetNavigationHistoryResponse

data class GetNavigationHistoryResponse

Represents response frame that is returned from Page#getNavigationHistory operation call. Returns navigation history for the current page.

GetResourceContentRequest

data class GetResourceContentRequest

Represents request frame that can be used with Page#getResourceContent operation call.

GetResourceContentResponse

data class GetResourceContentResponse

Represents response frame that is returned from Page#getResourceContent operation call. Returns content of the given resource.

GetResourceTreeResponse

data class GetResourceTreeResponse

Represents response frame that is returned from Page#getResourceTree operation call. Returns present frame / resource tree structure.

HandleJavaScriptDialogRequest

data class HandleJavaScriptDialogRequest

Represents request frame that can be used with Page#handleJavaScriptDialog operation call.

JavascriptDialogClosedEvent

data class JavascriptDialogClosedEvent : Event

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

JavascriptDialogOpeningEvent

data class JavascriptDialogOpeningEvent : Event

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

LayoutViewport

data class LayoutViewport

Layout viewport position and dimensions.

LifecycleEventEvent

data class LifecycleEventEvent : Event

Fired for top level page lifecycle events such as navigation, load, paint, etc.

LoadEventFiredEvent

data class LoadEventFiredEvent : Event

NavigatedWithinDocumentEvent

data class NavigatedWithinDocumentEvent : Event

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

NavigateRequest

data class NavigateRequest

Represents request frame that can be used with Page#navigate operation call.

NavigateResponse

data class NavigateResponse

Represents response frame that is returned from Page#navigate operation call. Navigates current page to the given URL.

NavigateToHistoryEntryRequest

data class NavigateToHistoryEntryRequest

Represents request frame that can be used with Page#navigateToHistoryEntry operation call.

NavigationEntry

data class NavigationEntry

Navigation history entry.

PageOperations

class PageOperations

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

PrintToPDFRequest

data class PrintToPDFRequest

Represents request frame that can be used with Page#printToPDF operation call.

PrintToPDFResponse

data class PrintToPDFResponse

Represents response frame that is returned from Page#printToPDF operation call. Print page as PDF.

ReloadRequest

data class ReloadRequest

Represents request frame that can be used with Page#reload operation call.

RemoveScriptToEvaluateOnLoadRequest

data class RemoveScriptToEvaluateOnLoadRequest

Represents request frame that can be used with Page#removeScriptToEvaluateOnLoad operation call.

RemoveScriptToEvaluateOnNewDocumentRequest

data class RemoveScriptToEvaluateOnNewDocumentRequest

Represents request frame that can be used with Page#removeScriptToEvaluateOnNewDocument operation call.

ScreencastFrameAckRequest

data class ScreencastFrameAckRequest

Represents request frame that can be used with Page#screencastFrameAck operation call.

ScreencastFrameEvent

data class ScreencastFrameEvent : Event

Compressed image data requested by the startScreencast.

ScreencastFrameMetadata

data class ScreencastFrameMetadata

Screencast frame metadata.

ScreencastVisibilityChangedEvent

data class ScreencastVisibilityChangedEvent : Event

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

SearchInResourceRequest

data class SearchInResourceRequest

Represents request frame that can be used with Page#searchInResource operation call.

SearchInResourceResponse

data class SearchInResourceResponse

Represents response frame that is returned from Page#searchInResource operation call. Searches for given string in resource content.

SetAdBlockingEnabledRequest

data class SetAdBlockingEnabledRequest

Represents request frame that can be used with Page#setAdBlockingEnabled operation call.

SetBypassCSPRequest

data class SetBypassCSPRequest

Represents request frame that can be used with Page#setBypassCSP operation call.

SetDeviceMetricsOverrideRequest

data class SetDeviceMetricsOverrideRequest

Represents request frame that can be used with Page#setDeviceMetricsOverride operation call.

SetDeviceOrientationOverrideRequest

data class SetDeviceOrientationOverrideRequest

Represents request frame that can be used with Page#setDeviceOrientationOverride operation call.

SetDocumentContentRequest

data class SetDocumentContentRequest

Represents request frame that can be used with Page#setDocumentContent operation call.

SetDownloadBehaviorRequest

data class SetDownloadBehaviorRequest

Represents request frame that can be used with Page#setDownloadBehavior operation call.

SetFontFamiliesRequest

data class SetFontFamiliesRequest

Represents request frame that can be used with Page#setFontFamilies operation call.

SetFontSizesRequest

data class SetFontSizesRequest

Represents request frame that can be used with Page#setFontSizes operation call.

SetGeolocationOverrideRequest

data class SetGeolocationOverrideRequest

Represents request frame that can be used with Page#setGeolocationOverride operation call.

SetInterceptFileChooserDialogRequest

data class SetInterceptFileChooserDialogRequest

Represents request frame that can be used with Page#setInterceptFileChooserDialog operation call.

SetLifecycleEventsEnabledRequest

data class SetLifecycleEventsEnabledRequest

Represents request frame that can be used with Page#setLifecycleEventsEnabled operation call.

SetProduceCompilationCacheRequest

data class SetProduceCompilationCacheRequest

Represents request frame that can be used with Page#setProduceCompilationCache operation call.

SetTouchEmulationEnabledRequest

data class SetTouchEmulationEnabledRequest

Represents request frame that can be used with Page#setTouchEmulationEnabled operation call.

SetWebLifecycleStateRequest

data class SetWebLifecycleStateRequest

Represents request frame that can be used with Page#setWebLifecycleState operation call.

StartScreencastRequest

data class StartScreencastRequest

Represents request frame that can be used with Page#startScreencast operation call.

TransitionType

enum class TransitionType

Transition type.

Viewport

data class Viewport

Viewport for capturing screenshot.

VisualViewport

data class VisualViewport

Visual viewport position, dimensions, and scale.

WindowOpenEvent

data class WindowOpenEvent : Event

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

Type Aliases

FrameId

typealias FrameId = String

Unique frame identifier.

ScriptIdentifier

typealias ScriptIdentifier = String

Unique script identifier.