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

BrowserDomain

class BrowserDomain(source)

The Browser domain defines methods and events for browser managing.

Official doc

Functions

Link copied to clipboard
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.

Link copied to clipboard
suspend fun cancelDownload(input: CancelDownloadRequest): CancelDownloadResponse
@JvmOverloads
inline suspend fun cancelDownload(guid: String, optionalArgs: CancelDownloadRequest.Builder.() -> Unit = {}): CancelDownloadResponse

Cancel a download if in progress

Link copied to clipboard
suspend fun close(): CloseResponse

Close browser gracefully.

Link copied to clipboard
suspend fun crash(): CrashResponse

Crashes browser on the main thread.

Link copied to clipboard
suspend fun crashGpuProcess(): CrashGpuProcessResponse

Crashes GPU process.

Link copied to clipboard
Link copied to clipboard
fun downloadProgressEvents(): Flow<BrowserEvent.DownloadProgress>

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

Link copied to clipboard
Link copied to clipboard
fun downloadWillBeginEvents(): Flow<BrowserEvent.DownloadWillBegin>

Fired when page is about to start a download.

Link copied to clipboard
fun events(): Flow<BrowserEvent>

Subscribes to all events related to this domain.

Link copied to clipboard
suspend fun executeBrowserCommand(commandId: BrowserCommandId): ExecuteBrowserCommandResponse
suspend fun executeBrowserCommand(input: ExecuteBrowserCommandRequest): ExecuteBrowserCommandResponse

Invoke custom browser commands used by telemetry.

Link copied to clipboard
suspend fun getBrowserCommandLine(): GetBrowserCommandLineResponse

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

Link copied to clipboard
suspend fun getHistogram(input: GetHistogramRequest): GetHistogramResponse
@JvmOverloads
inline suspend fun getHistogram(name: String, optionalArgs: GetHistogramRequest.Builder.() -> Unit = {}): GetHistogramResponse

Get a Chrome histogram by name.

Link copied to clipboard
@JvmOverloads
inline suspend fun getHistograms(optionalArgs: GetHistogramsRequest.Builder.() -> Unit = {}): GetHistogramsResponse
suspend fun getHistograms(input: GetHistogramsRequest): GetHistogramsResponse

Get Chrome histograms.

Link copied to clipboard
suspend fun getVersion(): GetVersionResponse

Returns version information.

Link copied to clipboard
suspend fun getWindowBounds(windowId: WindowID): GetWindowBoundsResponse
suspend fun getWindowBounds(input: GetWindowBoundsRequest): GetWindowBoundsResponse

Get position and size of the browser window.

Link copied to clipboard
@JvmOverloads
inline suspend fun getWindowForTarget(optionalArgs: GetWindowForTargetRequest.Builder.() -> Unit = {}): GetWindowForTargetResponse
suspend fun getWindowForTarget(input: GetWindowForTargetRequest): GetWindowForTargetResponse

Get the browser window that contains the devtools target.

Link copied to clipboard
suspend fun grantPermissions(input: GrantPermissionsRequest): GrantPermissionsResponse
@JvmOverloads
inline suspend fun grantPermissions(permissions: List<PermissionType>, optionalArgs: GrantPermissionsRequest.Builder.() -> Unit = {}): GrantPermissionsResponse

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

Link copied to clipboard
@JvmOverloads
inline suspend fun resetPermissions(optionalArgs: ResetPermissionsRequest.Builder.() -> Unit = {}): ResetPermissionsResponse
suspend fun resetPermissions(input: ResetPermissionsRequest): ResetPermissionsResponse

Reset all permission management for all origins.

Link copied to clipboard
@JvmOverloads
inline suspend fun setDockTile(optionalArgs: SetDockTileRequest.Builder.() -> Unit = {}): SetDockTileResponse
suspend fun setDockTile(input: SetDockTileRequest): SetDockTileResponse

Set dock tile details, platform-specific.

Link copied to clipboard
suspend fun setDownloadBehavior(input: SetDownloadBehaviorRequest): SetDownloadBehaviorResponse
@JvmOverloads
inline suspend fun setDownloadBehavior(behavior: DownloadBehavior, optionalArgs: SetDownloadBehaviorRequest.Builder.() -> Unit = {}): SetDownloadBehaviorResponse

Set the behavior when downloading a file.

Link copied to clipboard
suspend fun setPermission(input: SetPermissionRequest): SetPermissionResponse
@JvmOverloads
inline suspend fun setPermission(permission: PermissionDescriptor, setting: PermissionSetting, optionalArgs: SetPermissionRequest.Builder.() -> Unit = {}): SetPermissionResponse

Set permission settings for given origin.

Link copied to clipboard
suspend fun setWindowBounds(input: SetWindowBoundsRequest): SetWindowBoundsResponse
suspend fun setWindowBounds(windowId: WindowID, bounds: Bounds): SetWindowBoundsResponse

Set position and/or size of the browser window.