chrome-devtools-kotlin/org.hildan.chrome.devtools.domains.target/CreateTargetRequest

CreateTargetRequest

@Serializable

data class CreateTargetRequest(val url: String, val left: Int? = null, val top: Int? = null, val width: Int? = null, val height: Int? = null, val windowState: WindowState? = null, val browserContextId: BrowserContextID? = null, val enableBeginFrameControl: Boolean? = null, val newWindow: Boolean? = null, val background: Boolean? = null, val forTab: Boolean? = null, val hidden: Boolean? = null, val focus: Boolean? = null)

Request object containing input parameters for the TargetDomain.createTarget command.

Constructors

CreateTargetRequest

constructor(url: String, left: Int? = null, top: Int? = null, width: Int? = null, height: Int? = null, windowState: WindowState? = null, browserContextId: BrowserContextID? = null, enableBeginFrameControl: Boolean? = null, newWindow: Boolean? = null, background: Boolean? = null, forTab: Boolean? = null, hidden: Boolean? = null, focus: Boolean? = null)

Types

Builder

class Builder(val url: String)

A builder for CreateTargetRequest, which allows setting the optional parameters of the TargetDomain.createTarget command via a lambda.

Properties

background

val background: Boolean?

Whether to create the target in background or foreground (false by default, not supported by headless shell).

browserContextId

val browserContextId: BrowserContextID?

The browser context to create the page in.

enableBeginFrameControl

val enableBeginFrameControl: Boolean?

Whether BeginFrames for this target will be controlled via DevTools (headless shell only, not supported on MacOS yet, false by default).

focus

val focus: Boolean?

If specified, the option is used to determine if the new target should be focused or not. By default, the focus behavior depends on the value of the background field. For example, background=false and focus=false will result in the target tab being opened but the browser window remain unchanged (if it was in the background, it will remain in the background) and background=false with focus=undefined will result in the window being focused. Using background: true and focus: true is not supported and will result in an error.

forTab

val forTab: Boolean?

Whether to create the target of type "tab".

height

val height: Int?

Frame height in DIP (requires newWindow to be true or headless shell).

hidden

val hidden: Boolean?

Whether to create a hidden target. The hidden target is observable via protocol, but not present in the tab UI strip. Cannot be created with forTab: true, newWindow: true or background: false. The life-time of the tab is limited to the life-time of the session.

left

val left: Int?

Frame left origin in DIP (requires newWindow to be true or headless shell).

newWindow

val newWindow: Boolean?

Whether to create a new Window or Tab (false by default, not supported by headless shell).

top

val top: Int?

Frame top origin in DIP (requires newWindow to be true or headless shell).

url

val url: String

The initial URL the page will be navigated to. An empty string indicates about:blank.