chrome-devtools-kotlin

8.1.0-1515189

chrome-devtools-kotlin/org.hildan.chrome.devtools.domains.browser/BrowserDomain

BrowserDomain

class BrowserDomain

The Browser domain defines methods and events for browser managing.

Functions

addPrivacySandboxCoordinatorKeyConfig

suspend fun addPrivacySandboxCoordinatorKeyConfig(input: AddPrivacySandboxCoordinatorKeyConfigRequest): AddPrivacySandboxCoordinatorKeyConfigResponse

inline suspend fun addPrivacySandboxCoordinatorKeyConfig(api: PrivacySandboxAPI, coordinatorOrigin: String, keyConfig: String, optionalArgs: AddPrivacySandboxCoordinatorKeyConfigRequest.Builder.() -> Unit = {}): AddPrivacySandboxCoordinatorKeyConfigResponse

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): AddPrivacySandboxEnrollmentOverrideResponse

suspend fun addPrivacySandboxEnrollmentOverride(input: AddPrivacySandboxEnrollmentOverrideRequest): AddPrivacySandboxEnrollmentOverrideResponse

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

suspend fun cancelDownload(input: CancelDownloadRequest): CancelDownloadResponse

inline suspend fun cancelDownload(guid: String, optionalArgs: CancelDownloadRequest.Builder.() -> Unit = {}): CancelDownloadResponse

Cancel a download if in progress

suspend fun close(): CloseResponse

Close browser gracefully.

suspend fun crash(): CrashResponse

Crashes browser on the main thread.

crashGpuProcess

suspend fun crashGpuProcess(): CrashGpuProcessResponse

Crashes GPU process.

downloadProgress

fun ~~downloadProgress~~(): Flow<BrowserEvent.DownloadProgress>

downloadProgressEvents

fun downloadProgressEvents(): Flow<BrowserEvent.DownloadProgress>

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

downloadWillBegin

fun ~~downloadWillBegin~~(): Flow<BrowserEvent.DownloadWillBegin>

downloadWillBeginEvents

fun downloadWillBeginEvents(): Flow<BrowserEvent.DownloadWillBegin>

Fired when page is about to start a download.

fun events(): Flow<BrowserEvent>

Subscribes to all events related to this domain.

executeBrowserCommand

suspend fun executeBrowserCommand(commandId: BrowserCommandId): ExecuteBrowserCommandResponse

suspend fun executeBrowserCommand(input: ExecuteBrowserCommandRequest): ExecuteBrowserCommandResponse

Invoke custom browser commands used by telemetry.

getBrowserCommandLine

suspend fun getBrowserCommandLine(): GetBrowserCommandLineResponse

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

suspend fun getHistogram(input: GetHistogramRequest): GetHistogramResponse

inline suspend fun getHistogram(name: String, optionalArgs: GetHistogramRequest.Builder.() -> Unit = {}): GetHistogramResponse

Get a Chrome histogram by name.

inline suspend fun getHistograms(optionalArgs: GetHistogramsRequest.Builder.() -> Unit = {}): GetHistogramsResponse

suspend fun getHistograms(input: GetHistogramsRequest): GetHistogramsResponse

Get Chrome histograms.

suspend fun getVersion(): GetVersionResponse

Returns version information.

getWindowBounds

suspend fun getWindowBounds(windowId: WindowID): GetWindowBoundsResponse

suspend fun getWindowBounds(input: GetWindowBoundsRequest): GetWindowBoundsResponse

Get position and size of the browser window.

getWindowForTarget

inline suspend fun getWindowForTarget(optionalArgs: GetWindowForTargetRequest.Builder.() -> Unit = {}): GetWindowForTargetResponse

suspend fun getWindowForTarget(input: GetWindowForTargetRequest): GetWindowForTargetResponse

Get the browser window that contains the devtools target.

grantPermissions

suspend fun grantPermissions(input: GrantPermissionsRequest): GrantPermissionsResponse

inline suspend fun grantPermissions(permissions: List<PermissionType>, optionalArgs: GrantPermissionsRequest.Builder.() -> Unit = {}): GrantPermissionsResponse

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

resetPermissions

inline suspend fun resetPermissions(optionalArgs: ResetPermissionsRequest.Builder.() -> Unit = {}): ResetPermissionsResponse

suspend fun resetPermissions(input: ResetPermissionsRequest): ResetPermissionsResponse

Reset all permission management for all origins.

setContentsSize

suspend fun setContentsSize(input: SetContentsSizeRequest): SetContentsSizeResponse

inline suspend fun setContentsSize(windowId: WindowID, optionalArgs: SetContentsSizeRequest.Builder.() -> Unit = {}): SetContentsSizeResponse

Set size of the browser contents resizing browser window as necessary.

inline suspend fun setDockTile(optionalArgs: SetDockTileRequest.Builder.() -> Unit = {}): SetDockTileResponse

suspend fun setDockTile(input: SetDockTileRequest): SetDockTileResponse

Set dock tile details, platform-specific.

setDownloadBehavior

suspend fun setDownloadBehavior(input: SetDownloadBehaviorRequest): SetDownloadBehaviorResponse

inline suspend fun setDownloadBehavior(behavior: DownloadBehavior, optionalArgs: SetDownloadBehaviorRequest.Builder.() -> Unit = {}): SetDownloadBehaviorResponse

Set the behavior when downloading a file.

suspend fun setPermission(input: SetPermissionRequest): SetPermissionResponse

inline suspend fun setPermission(permission: PermissionDescriptor, setting: PermissionSetting, optionalArgs: SetPermissionRequest.Builder.() -> Unit = {}): SetPermissionResponse

Set permission settings for given requesting and embedding origins.

setWindowBounds

suspend fun setWindowBounds(input: SetWindowBoundsRequest): SetWindowBoundsResponse

suspend fun setWindowBounds(windowId: WindowID, bounds: Bounds): SetWindowBoundsResponse

Set position and/or size of the browser window.