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

Package-level declarations

Types

class ChromeDPClient(remoteDebugUrl: String = "http://localhost:9222", overrideHostHeader: Boolean = false, httpClient: HttpClient = if (overrideHostHeader) DEFAULT_HTTP_CLIENT_WITH_HOST_OVERRIDE else DEFAULT_HTTP_CLIENT)

A client using the Chrome Devtools Protocol to communicate with a running Chrome browser via the debugger API.

ChromeDPTarget

@Serializable

data class ChromeDPTarget(val id: String, val title: String, val type: String, val description: String, val devtoolsFrontendUrl: String, val webSocketDebuggerUrl: String)

Targets are the parts of the browser that the Chrome DevTools Protocol can interact with. This includes pages, service workers, extensions, and also the browser itself.

ChromeVersion

@Serializable

data class ChromeVersion(val browser: String, val protocolVersion: String, val userAgent: String, val v8Version: String? = null, val webKitVersion: String, val webSocketDebuggerUrl: String)

Browser version information retrieved via the debugger API.

ExperimentalChromeApi

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FIELD, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.TYPEALIAS])

annotation class ExperimentalChromeApi

This annotation is used on DevTools Protocol APIs and types that are marked as experimental in the protocol itself.

RequestError

@Serializable

data class RequestError(val code: Long, val message: String, val data: JsonElement? = null)

Data about an error that occurred when processing a request.

RequestFailed

class RequestFailed(val request: RequestFrame, val error: RequestError) : Exception

An exception thrown when an error occurred during the processing of a request on Chrome side.

RequestFrame

@Serializable

data class RequestFrame(val id: Long, val method: String, val params: JsonElement? = null, val sessionId: String? = null)

A request frame which can be sent to the server, as defined in the protocol's README

RequestNotSentException

class RequestNotSentException(val request: RequestFrame, cause: Throwable?) : Exception

An exception thrown when an error prevented sending a request via the Chrome web socket.

TargetCrashedException

class TargetCrashedException(val sessionId: SessionID?, val crashEventName: String, val crashEventPayload: JsonElement) : Exception

An exception thrown when an InspectorEvent.TargetCrashed or TargetEvent.TargetCrashed is received.

Functions

chromeWebSocket

suspend fun HttpClient.chromeWebSocket(webSocketDebuggerUrl: String): BrowserSession

Connects to the Chrome debugger at the given webSocketDebuggerUrl.