PageEvent

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

Types

@Serializable

data class BackForwardCacheNotUsed(val loaderId: LoaderId, val frameId: FrameId, val notRestoredExplanations: List<BackForwardCacheNotRestoredExplanation>, val notRestoredExplanationsTree: BackForwardCacheNotRestoredExplanationTree? = null) : PageEvent

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.

CompilationCacheProduced

@Serializable

data class CompilationCacheProduced(val url: String, val data: String) : PageEvent

Issued for every compilation cache generated.

DocumentOpened

@Serializable

data class DocumentOpened(val frame: Frame) : PageEvent

Fired when opening document to write to.

DomContentEventFired

@Serializable

data class DomContentEventFired(val timestamp: MonotonicTime) : PageEvent

(undocumented in the protocol definition)

DownloadProgress

@Serializable

data class ~~DownloadProgress~~(val guid: String, val totalBytes: Double, val receivedBytes: Double, val state: DownloadProgressState) : PageEvent

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

DownloadWillBegin

@Serializable

data class ~~DownloadWillBegin~~(val frameId: FrameId, val guid: String, val url: String, val suggestedFilename: String) : PageEvent

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

FileChooserOpened

@Serializable

data class FileChooserOpened(val frameId: FrameId? = null, val mode: FileChooserOpenedMode, val backendNodeId: BackendNodeId? = null) : PageEvent

Emitted only when page.interceptFileChooser is enabled.

FrameAttached

@Serializable

data class FrameAttached(val frameId: FrameId, val parentFrameId: FrameId, val stack: StackTrace? = null) : PageEvent

Fired when frame has been attached to its parent.

FrameClearedScheduledNavigation

@Serializable

data class ~~FrameClearedScheduledNavigation~~(val frameId: FrameId) : PageEvent

Fired when frame no longer has a scheduled navigation.

FrameDetached

@Serializable

data class FrameDetached(val frameId: FrameId, val reason: FrameDetachedReason? = null) : PageEvent

Fired when frame has been detached from its parent.

FrameNavigated

@Serializable

data class FrameNavigated(val frame: Frame, val type: NavigationType? = null) : PageEvent

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

FrameRequestedNavigation

@Serializable

data class FrameRequestedNavigation(val frameId: FrameId, val reason: ClientNavigationReason, val url: String, val disposition: ClientNavigationDisposition) : PageEvent

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

FrameResized

@Serializable

object FrameResized : PageEvent

(undocumented in the protocol definition)

FrameScheduledNavigation

@Serializable

data class ~~FrameScheduledNavigation~~(val frameId: FrameId, val delay: Double, val reason: ClientNavigationReason, val url: String) : PageEvent

Fired when frame schedules a potential navigation.

FrameStartedLoading

@Serializable

data class FrameStartedLoading(val frameId: FrameId) : PageEvent

Fired when frame has started loading.

FrameStartedNavigating

@Serializable

data class FrameStartedNavigating(val frameId: FrameId, val url: String, val loaderId: LoaderId, val navigationType: FrameStartedNavigatingNavigationType) : PageEvent

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

FrameStoppedLoading

@Serializable

data class FrameStoppedLoading(val frameId: FrameId) : PageEvent

Fired when frame has stopped loading.

FrameSubtreeWillBeDetached

@Serializable

data class FrameSubtreeWillBeDetached(val frameId: FrameId) : PageEvent

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

InterstitialHidden

@Serializable

object InterstitialHidden : PageEvent

Fired when interstitial page was hidden

InterstitialShown

@Serializable

object InterstitialShown : PageEvent

Fired when interstitial page was shown

JavascriptDialogClosed

@Serializable

data class JavascriptDialogClosed(val frameId: FrameId? = null, val result: Boolean, val userInput: String) : PageEvent

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

JavascriptDialogOpening

@Serializable

data class JavascriptDialogOpening(val url: String, val frameId: FrameId? = null, val message: String, val type: DialogType, val hasBrowserHandler: Boolean, val defaultPrompt: String? = null) : PageEvent

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

LifecycleEvent

@Serializable

data class LifecycleEvent(val frameId: FrameId, val loaderId: LoaderId, val name: String, val timestamp: MonotonicTime) : PageEvent

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

LoadEventFired

@Serializable

data class LoadEventFired(val timestamp: MonotonicTime) : PageEvent

(undocumented in the protocol definition)

NavigatedWithinDocument

@Serializable

data class NavigatedWithinDocument(val frameId: FrameId, val url: String, val navigationType: NavigatedWithinDocumentNavigationType) : PageEvent

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

ScreencastFrame

@Serializable

data class ScreencastFrame(val data: String, val metadata: ScreencastFrameMetadata, val sessionId: Int) : PageEvent

Compressed image data requested by the startScreencast.

ScreencastVisibilityChanged

@Serializable

data class ScreencastVisibilityChanged(val visible: Boolean) : PageEvent

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

WindowOpen

@Serializable

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

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

PageEvent

Inheritors

Types