cdp/dev.kdriver.cdp.domain/Browser

Browser

class Browser(cdp: CDP) : Domain

The Browser domain defines methods and events for browser managing.

Constructors

Browser

constructor(cdp: CDP)

Types

AddPrivacySandboxCoordinatorKeyConfigParameter

@Serializable

data class AddPrivacySandboxCoordinatorKeyConfigParameter(val api: Browser.PrivacySandboxAPI, val coordinatorOrigin: String, val keyConfig: String, val browserContextId: String? = null)

AddPrivacySandboxEnrollmentOverrideParameter

@Serializable

data class AddPrivacySandboxEnrollmentOverrideParameter(val url: String)

Bounds

@Serializable

data class Bounds(val left: Int? = null, val top: Int? = null, val width: Int? = null, val height: Int? = null, val windowState: Browser.WindowState? = null)

Browser window bounds information

BrowserCommandId

@Serializable

enum BrowserCommandId : Enum<Browser.BrowserCommandId>

Browser command ids used by executeBrowserCommand.

Bucket

@Serializable

data class Bucket(val low: Int, val high: Int, val count: Int)

Chrome histogram bucket.

CancelDownloadParameter

@Serializable

data class CancelDownloadParameter(val guid: String, val browserContextId: String? = null)

DownloadProgressParameter

@Serializable

data class DownloadProgressParameter(val guid: String, val totalBytes: Double, val receivedBytes: Double, val state: String, val filePath: String? = null)

Fired when download makes progress. Last call has |done| == true.

DownloadWillBeginParameter

@Serializable

data class DownloadWillBeginParameter(val frameId: String, val guid: String, val url: String, val suggestedFilename: String)

Fired when page is about to start a download.

ExecuteBrowserCommandParameter

@Serializable

data class ExecuteBrowserCommandParameter(val commandId: Browser.BrowserCommandId)

GetBrowserCommandLineReturn

@Serializable

data class GetBrowserCommandLineReturn(val arguments: List<String>)

GetHistogramParameter

@Serializable

data class GetHistogramParameter(val name: String, val delta: Boolean? = null)

GetHistogramReturn

@Serializable

data class GetHistogramReturn(val histogram: Browser.Histogram)

GetHistogramsParameter

@Serializable

data class GetHistogramsParameter(val query: String? = null, val delta: Boolean? = null)

GetHistogramsReturn

@Serializable

data class GetHistogramsReturn(val histograms: List<Browser.Histogram>)

GetVersionReturn

@Serializable

data class GetVersionReturn(val protocolVersion: String, val product: String, val revision: String, val userAgent: String, val jsVersion: String)

GetWindowBoundsParameter

@Serializable

data class GetWindowBoundsParameter(val windowId: Int)

GetWindowBoundsReturn

@Serializable

data class GetWindowBoundsReturn(val bounds: Browser.Bounds)

GetWindowForTargetParameter

@Serializable

data class GetWindowForTargetParameter(val targetId: String? = null)

GetWindowForTargetReturn

@Serializable

data class GetWindowForTargetReturn(val windowId: Int, val bounds: Browser.Bounds)

GrantPermissionsParameter

@Serializable

data class GrantPermissionsParameter(val permissions: List<Browser.PermissionType>, val origin: String? = null, val browserContextId: String? = null)

Histogram

@Serializable

data class Histogram(val name: String, val sum: Int, val count: Int, val buckets: List<Browser.Bucket>)

Chrome histogram.

PermissionDescriptor

@Serializable

data class PermissionDescriptor(val name: String, val sysex: Boolean? = null, val userVisibleOnly: Boolean? = null, val allowWithoutSanitization: Boolean? = null, val allowWithoutGesture: Boolean? = null, val panTiltZoom: Boolean? = null)

Definition of PermissionDescriptor defined in the Permissions API: https://w3c.github.io/permissions/#dom-permissiondescriptor.

PermissionSetting

@Serializable

enum PermissionSetting : Enum<Browser.PermissionSetting>

PermissionType

@Serializable

enum PermissionType : Enum<Browser.PermissionType>

PrivacySandboxAPI

@Serializable

enum PrivacySandboxAPI : Enum<Browser.PrivacySandboxAPI>

ResetPermissionsParameter

@Serializable

data class ResetPermissionsParameter(val browserContextId: String? = null)

SetDockTileParameter

@Serializable

data class SetDockTileParameter(val badgeLabel: String? = null, val image: String? = null)

SetDownloadBehaviorParameter

@Serializable

data class SetDownloadBehaviorParameter(val behavior: String, val browserContextId: String? = null, val downloadPath: String? = null, val eventsEnabled: Boolean? = null)

SetPermissionParameter

@Serializable

data class SetPermissionParameter(val permission: Browser.PermissionDescriptor, val setting: Browser.PermissionSetting, val origin: String? = null, val browserContextId: String? = null)

SetWindowBoundsParameter

@Serializable

data class SetWindowBoundsParameter(val windowId: Int, val bounds: Browser.Bounds)

WindowState

@Serializable

enum WindowState : Enum<Browser.WindowState>

The state of the browser window.

Properties

downloadProgress

val downloadProgress: Flow<Browser.DownloadProgressParameter>

Fired when download makes progress. Last call has |done| == true.

downloadWillBegin

val downloadWillBegin: Flow<Browser.DownloadWillBeginParameter>

Fired when page is about to start a download.

Functions

addPrivacySandboxCoordinatorKeyConfig

suspend fun addPrivacySandboxCoordinatorKeyConfig(args: Browser.AddPrivacySandboxCoordinatorKeyConfigParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun addPrivacySandboxCoordinatorKeyConfig(api: Browser.PrivacySandboxAPI, coordinatorOrigin: String, keyConfig: String, browserContextId: String? = null)

Configures encryption keys used with a given privacy sandbox API to talk to a trusted coordinator. Since this is intended for test automation only, coordinatorOrigin must be a .test domain. No existing coordinator configuration for the origin may exist.

addPrivacySandboxEnrollmentOverride

suspend fun addPrivacySandboxEnrollmentOverride(url: String)

suspend fun addPrivacySandboxEnrollmentOverride(args: Browser.AddPrivacySandboxEnrollmentOverrideParameter, mode: CommandMode = CommandMode.DEFAULT)

Allows a site to use privacy sandbox features that require enrollment without the site actually being enrolled. Only supported on page targets.

cancelDownload

suspend fun cancelDownload(args: Browser.CancelDownloadParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun cancelDownload(guid: String, browserContextId: String? = null)

Cancel a download if in progress

suspend fun close(mode: CommandMode = CommandMode.DEFAULT)

Close browser gracefully.

crash

suspend fun crash(mode: CommandMode = CommandMode.DEFAULT)

Crashes browser on the main thread.

crashGpuProcess

suspend fun crashGpuProcess(mode: CommandMode = CommandMode.DEFAULT)

Crashes GPU process.

executeBrowserCommand

suspend fun executeBrowserCommand(commandId: Browser.BrowserCommandId)

suspend fun executeBrowserCommand(args: Browser.ExecuteBrowserCommandParameter, mode: CommandMode = CommandMode.DEFAULT)

Invoke custom browser commands used by telemetry.

getBrowserCommandLine

suspend fun getBrowserCommandLine(mode: CommandMode = CommandMode.DEFAULT): Browser.GetBrowserCommandLineReturn

Returns the command line switches for the browser process if, and only if --enable-automation is on the commandline.

getHistogram

suspend fun getHistogram(args: Browser.GetHistogramParameter, mode: CommandMode = CommandMode.DEFAULT): Browser.GetHistogramReturn

suspend fun getHistogram(name: String, delta: Boolean? = null): Browser.GetHistogramReturn

Get a Chrome histogram by name.

getHistograms

suspend fun getHistograms(args: Browser.GetHistogramsParameter, mode: CommandMode = CommandMode.DEFAULT): Browser.GetHistogramsReturn

suspend fun getHistograms(query: String? = null, delta: Boolean? = null): Browser.GetHistogramsReturn

Get Chrome histograms.

getVersion

suspend fun getVersion(mode: CommandMode = CommandMode.DEFAULT): Browser.GetVersionReturn

Returns version information.

getWindowBounds

suspend fun getWindowBounds(windowId: Int): Browser.GetWindowBoundsReturn

suspend fun getWindowBounds(args: Browser.GetWindowBoundsParameter, mode: CommandMode = CommandMode.DEFAULT): Browser.GetWindowBoundsReturn

Get position and size of the browser window.

getWindowForTarget

suspend fun getWindowForTarget(targetId: String? = null): Browser.GetWindowForTargetReturn

suspend fun getWindowForTarget(args: Browser.GetWindowForTargetParameter, mode: CommandMode = CommandMode.DEFAULT): Browser.GetWindowForTargetReturn

Get the browser window that contains the devtools target.

grantPermissions

suspend fun grantPermissions(args: Browser.GrantPermissionsParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun grantPermissions(permissions: List<Browser.PermissionType>, origin: String? = null, browserContextId: String? = null)

Grant specific permissions to the given origin and reject all others.

resetPermissions

suspend fun resetPermissions(browserContextId: String? = null)

suspend fun resetPermissions(args: Browser.ResetPermissionsParameter, mode: CommandMode = CommandMode.DEFAULT)

Reset all permission management for all origins.

setDockTile

suspend fun setDockTile(args: Browser.SetDockTileParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun setDockTile(badgeLabel: String? = null, image: String? = null)

Set dock tile details, platform-specific.

setDownloadBehavior

suspend fun setDownloadBehavior(args: Browser.SetDownloadBehaviorParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun setDownloadBehavior(behavior: String, browserContextId: String? = null, downloadPath: String? = null, eventsEnabled: Boolean? = null)

Set the behavior when downloading a file.

setPermission

suspend fun setPermission(args: Browser.SetPermissionParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun setPermission(permission: Browser.PermissionDescriptor, setting: Browser.PermissionSetting, origin: String? = null, browserContextId: String? = null)

Set permission settings for given origin.

setWindowBounds

suspend fun setWindowBounds(args: Browser.SetWindowBoundsParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun setWindowBounds(windowId: Int, bounds: Browser.Bounds)

Set position and/or size of the browser window.