WebDroid/dev.webdroid

Package-level declarations

Types

class BrowserConfig(val enableProtocolBackend: Boolean = false, val timeouts: Timeouts = Timeouts(), val maxSessions: Int = 1, val allowPrivateAddresses: Boolean = false, val userAgent: String? = null)

How a browser instance behaves. Every default is the conservative choice: one session, no protocol backend, no private addresses.

BrowserException

class BrowserException : Exception

The only exception this library throws.

Capabilities

class Capabilities

What a device can actually do.

ConsoleLevel

enum ConsoleLevel : Enum<ConsoleLevel>

The console method the page called: console.debug/log/warn/error.

ConsoleMessage

class ConsoleMessage

A console message emitted by page script.

class Cookie(val name: String, val value: String, val domain: String, val path: String = "/", val expiresAtMillis: Long? = null, val secure: Boolean = false, val httpOnly: Boolean = false)

A cookie, as the platform stores it. Cookie storage is process-global.

Dialog

interface Dialog

A JavaScript dialog the page opened. Unanswered dialogs block the page.

DialogType

enum DialogType : Enum<DialogType>

Which native dialog a page opened.

Element

class Element

A matched element, read at the moment of the query.

ErrorCode

enum ErrorCode : Enum<ErrorCode>

Everything that can go wrong, as a closed set.

Frame

interface Frame

A frame within the page. The main frame is always present.

HeadlessBrowser

interface HeadlessBrowser

A browser running inside this app: no server, no cable, no visible UI.

ImageFormat

enum ImageFormat : Enum<ImageFormat>

Encoding for Page.screenshot.

NavigationResult

class NavigationResult

The outcome of a navigation.

Page

interface Page

One page, driven programmatically.

Request

class Request

A request the page is about to make.

ResourceType

enum ResourceType : Enum<ResourceType>

What a request is for, so rules can be written against categories rather than extensions.

Response

class Response

A response the page received. Bodies are not captured in v1.

Route

class Route

A request paused by a matching route rule. Exactly one of the two calls must be made, or the page waits until its navigation ceiling.

SessionMetrics

data class SessionMetrics(val sessionDurationMs: Long, val totalNavigations: Int, val totalJsEvaluations: Int, val totalJsExecutionTimeMs: Long, val blockedBytes: Long, val memoryPressureEvents: Int, val rendererCrashes: Int, val droppedCdpEvents: Long = 0)

Diagnostic metrics captured for a dev.webdroid.core.PageSession. All values are collected strictly locally and never transmitted externally.

Timeouts

class Timeouts(val navigationMillis: Long, val settleMillis: Long, val scriptMillis: Long, val totalMillis: Long)

Ceilings, in milliseconds. Each stage is bounded separately, and total bounds the whole task even when no single stage exceeds its own limit.

Viewport

class Viewport(val width: Int, val height: Int, val deviceScaleFactor: Float = 1.0f)

The size a session renders at.

WaitUntil

sealed interface WaitUntil

When a navigation or wait is considered finished.