chrome-devtools-kotlin/org.hildan.chrome.devtools.sessions

Package-level declarations

Types

AuctionWorkletSession

interface AuctionWorkletSession : ChildSession, AuctionWorkletTarget

A session created when attaching to a target of type AuctionWorklet.

interface BrowserSession : ChromeSession, BrowserTarget

A browser session. This is the root session created when initially connecting to the browser's debugger.

interface ChildSession : ChromeSession

A target session that is a child of a browser session, usually created when attaching to a target from the root browser session.

interface ChromeSession

A Chrome DevTools debugging session, created when attaching to a target.

GotoCompletionEvent

abstract class GotoCompletionEvent

An event that a goto call can await before considering the navigation complete.

GotoConfigBuilder

class GotoConfigBuilder

Defines properties that can be customized when navigating a page using goto.

NavigationFailed

class NavigationFailed(val request: NavigateRequest, val response: NavigateResponse) : Exception

Thrown to indicate that the navigation to a page has failed.

NewPageConfigBuilder

class NewPageConfigBuilder

Defines properties that can be customized when creating a new page.

interface PageSession : ChildSession, PageTarget

A session created when attaching to a target of type Page.

ServiceWorkerSession

interface ServiceWorkerSession : ChildSession, ServiceWorkerTarget

A session created when attaching to a target of type ServiceWorker.

SessionMetaData

interface SessionMetaData

Info about a session and its underlying target.

SharedStorageWorkletSession

interface SharedStorageWorkletSession : ChildSession, SharedStorageWorkletTarget

A session created when attaching to a target of type SharedStorageWorklet.

SharedWorkerSession

interface SharedWorkerSession : ChildSession, SharedWorkerTarget

A session created when attaching to a target of type SharedWorker.

WebContentsSession

interface WebContentsSession : ChildSession, WebContentsTarget

A session created when attaching to a target of type WebContents.

interface WorkerSession : ChildSession, WorkerTarget

A session created when attaching to a target of type Worker.

interface WorkletSession : ChildSession, WorkletTarget

A session created when attaching to a target of type Worklet.

Functions

asAuctionWorkletSession

fun ChildSession.asAuctionWorkletSession(): AuctionWorkletSession

Adapts this ChildSession to a AuctionWorkletSession. If the attached target is not of a compatible type, this function throws an exception.

fun ChildSession.asPageSession(): PageSession

Adapts this ChildSession to a PageSession. If the attached target is not of a compatible type, this function throws an exception.

asServiceWorkerSession

fun ChildSession.asServiceWorkerSession(): ServiceWorkerSession

Adapts this ChildSession to a ServiceWorkerSession. If the attached target is not of a compatible type, this function throws an exception.

asSharedStorageWorkletSession

fun ChildSession.asSharedStorageWorkletSession(): SharedStorageWorkletSession

Adapts this ChildSession to a SharedStorageWorkletSession. If the attached target is not of a compatible type, this function throws an exception.

asSharedWorkerSession

fun ChildSession.asSharedWorkerSession(): SharedWorkerSession

Adapts this ChildSession to a SharedWorkerSession. If the attached target is not of a compatible type, this function throws an exception.

asWebContentsSession

fun ChildSession.asWebContentsSession(): WebContentsSession

Adapts this ChildSession to a WebContentsSession. If the attached target is not of a compatible type, this function throws an exception.

asWorkerSession

fun ChildSession.asWorkerSession(): WorkerSession

Adapts this ChildSession to a WorkerSession. If the attached target is not of a compatible type, this function throws an exception.

asWorkletSession

fun ChildSession.asWorkletSession(): WorkletSession

Adapts this ChildSession to a WorkletSession. If the attached target is not of a compatible type, this function throws an exception.

suspend fun PageSession.childPages(): List<TargetInfo>

Finds page targets that were opened by this page.

suspend fun PageSession.goto(url: String, configure: GotoConfigBuilder.() -> Unit = {})

Navigates the current page to the provided url, and suspends until the configured completion events are fired. By default, this function suspends until the GotoCompletionEvent.Load event is fired.

suspend fun BrowserSession.newPage(configure: NewPageConfigBuilder.() -> Unit = {}): PageSession

Creates a new page and attaches to it, then returns the new child PageSession. The underlying web socket connection of this BrowserSession is reused for the new child PageSession.

inline suspend fun <S : ChildSession, T> S.use(block: (S) -> T): T

Performs the given operation in this ChildSession and closes this session and its children, as well as the corresponding targets.

inline suspend fun <T> BrowserSession.use(block: (BrowserSession) -> T): T

Performs the given operation in this session and closes the web socket connection.