data class CreateBrowserContextParameter(val disposeOnDetach: Boolean? = null, val proxyServer: String? = null, val proxyBypassList: String? = null, val originsWithUniversalNetworkAccess: List<String>? = null)

CreateBrowserContextReturn

@Serializable

data class CreateBrowserContextReturn(val browserContextId: String)

CreateTargetParameter

@Serializable

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

CreateTargetReturn

@Serializable

data class CreateTargetReturn(val targetId: String)

DetachedFromTargetParameter

@Serializable

data class DetachedFromTargetParameter(val sessionId: String, val targetId: String? = null)

Issued when detached from target for any reason (including detachFromTarget command). Can be issued multiple times per target if multiple sessions have been attached to it.

DetachFromTargetParameter

@Serializable

data class DetachFromTargetParameter(val sessionId: String? = null, val targetId: String? = null)

DisposeBrowserContextParameter

@Serializable

data class DisposeBrowserContextParameter(val browserContextId: String)

ExposeDevToolsProtocolParameter

@Serializable

data class ExposeDevToolsProtocolParameter(val targetId: String, val bindingName: String? = null, val inheritPermissions: Boolean? = null)

FilterEntry

@Serializable

data class FilterEntry(val exclude: Boolean? = null, val type: String? = null)

A filter used by target query/discovery/auto-attach operations.

GetBrowserContextsReturn

@Serializable

data class GetBrowserContextsReturn(val browserContextIds: List<String>)

GetTargetInfoParameter

@Serializable

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

GetTargetInfoReturn

@Serializable

data class GetTargetInfoReturn(val targetInfo: Target.TargetInfo)

GetTargetsParameter

@Serializable

data class GetTargetsParameter(val filter: List<Double>? = null)

GetTargetsReturn

@Serializable

data class GetTargetsReturn(val targetInfos: List<Target.TargetInfo>)

ReceivedMessageFromTargetParameter

@Serializable

data class ReceivedMessageFromTargetParameter(val sessionId: String, val message: String, val targetId: String? = null)

Notifies about a new protocol message received from the session (as reported in attachedToTarget event).

RemoteLocation

@Serializable

data class RemoteLocation(val host: String, val port: Int)

SendMessageToTargetParameter

@Serializable

data class SendMessageToTargetParameter(val message: String, val sessionId: String? = null, val targetId: String? = null)

SetAutoAttachParameter

@Serializable

data class SetAutoAttachParameter(val autoAttach: Boolean, val waitForDebuggerOnStart: Boolean, val flatten: Boolean? = null, val filter: List<Double>? = null)

SetDiscoverTargetsParameter

@Serializable

data class SetDiscoverTargetsParameter(val discover: Boolean, val filter: List<Double>? = null)

SetRemoteLocationsParameter

@Serializable

data class SetRemoteLocationsParameter(val locations: List<Target.RemoteLocation>)

TargetCrashedParameter

@Serializable

data class TargetCrashedParameter(val targetId: String, val status: String, val errorCode: Int)

Issued when a target has crashed.

TargetCreatedParameter

@Serializable

data class TargetCreatedParameter(val targetInfo: Target.TargetInfo)

Issued when a possible inspection target is created.

TargetDestroyedParameter

@Serializable

data class TargetDestroyedParameter(val targetId: String)

Issued when a target is destroyed.

TargetInfo

@Serializable

data class TargetInfo(val targetId: String, val type: String, val title: String, val url: String, val attached: Boolean, val openerId: String? = null, val canAccessOpener: Boolean, val openerFrameId: String? = null, val browserContextId: String? = null, val subtype: String? = null)

TargetInfoChangedParameter

@Serializable

data class TargetInfoChangedParameter(val targetInfo: Target.TargetInfo)

Issued when some information about a target has changed. This only happens between targetCreated and targetDestroyed.

WindowState

@Serializable

enum WindowState : Enum<Target.WindowState>

The state of the target window.

Properties

attachedToTarget

val attachedToTarget: Flow<Target.AttachedToTargetParameter>

Issued when attached to target because of auto-attach or attachToTarget command.

detachedFromTarget

val detachedFromTarget: Flow<Target.DetachedFromTargetParameter>

Issued when detached from target for any reason (including detachFromTarget command). Can be issued multiple times per target if multiple sessions have been attached to it.

receivedMessageFromTarget

val receivedMessageFromTarget: Flow<Target.ReceivedMessageFromTargetParameter>

Notifies about a new protocol message received from the session (as reported in attachedToTarget event).

targetCrashed

val targetCrashed: Flow<Target.TargetCrashedParameter>

Issued when a target has crashed.

targetCreated

val targetCreated: Flow<Target.TargetCreatedParameter>

Issued when a possible inspection target is created.

targetDestroyed

val targetDestroyed: Flow<Target.TargetDestroyedParameter>

Issued when a target is destroyed.

targetInfoChanged

val targetInfoChanged: Flow<Target.TargetInfoChangedParameter>

Issued when some information about a target has changed. This only happens between targetCreated and targetDestroyed.

Functions

activateTarget

suspend fun activateTarget(targetId: String)

suspend fun activateTarget(args: Target.ActivateTargetParameter, mode: CommandMode = CommandMode.DEFAULT)

Activates (focuses) the target.

attachToBrowserTarget

suspend fun attachToBrowserTarget(mode: CommandMode = CommandMode.DEFAULT): Target.AttachToBrowserTargetReturn

Attaches to the browser target, only uses flat sessionId mode.

attachToTarget

suspend fun attachToTarget(args: Target.AttachToTargetParameter, mode: CommandMode = CommandMode.DEFAULT): Target.AttachToTargetReturn

suspend fun attachToTarget(targetId: String, flatten: Boolean? = null): Target.AttachToTargetReturn

Attaches to the target with given id.

autoAttachRelated

suspend fun autoAttachRelated(args: Target.AutoAttachRelatedParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun autoAttachRelated(targetId: String, waitForDebuggerOnStart: Boolean, filter: List<Double>? = null)

Adds the specified target to the list of targets that will be monitored for any related target creation (such as child frames, child workers and new versions of service worker) and reported through attachedToTarget. The specified target is also auto-attached. This cancels the effect of any previous setAutoAttach and is also cancelled by subsequent setAutoAttach. Only available at the Browser target.

closeTarget

suspend fun closeTarget(targetId: String): Target.CloseTargetReturn

suspend fun closeTarget(args: Target.CloseTargetParameter, mode: CommandMode = CommandMode.DEFAULT): Target.CloseTargetReturn

Closes the target. If the target is a page that gets closed too.

createBrowserContext

suspend fun createBrowserContext(args: Target.CreateBrowserContextParameter, mode: CommandMode = CommandMode.DEFAULT): Target.CreateBrowserContextReturn

suspend fun createBrowserContext(disposeOnDetach: Boolean? = null, proxyServer: String? = null, proxyBypassList: String? = null, originsWithUniversalNetworkAccess: List<String>? = null): Target.CreateBrowserContextReturn

Creates a new empty BrowserContext. Similar to an incognito profile but you can have more than one.

createTarget

suspend fun createTarget(args: Target.CreateTargetParameter, mode: CommandMode = CommandMode.DEFAULT): Target.CreateTargetReturn

suspend fun createTarget(url: String, left: Int? = null, top: Int? = null, width: Int? = null, height: Int? = null, windowState: Target.WindowState? = null, browserContextId: String? = null, enableBeginFrameControl: Boolean? = null, newWindow: Boolean? = null, background: Boolean? = null, forTab: Boolean? = null, hidden: Boolean? = null): Target.CreateTargetReturn

Creates a new page.

detachFromTarget

suspend fun detachFromTarget(args: Target.DetachFromTargetParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun detachFromTarget(sessionId: String? = null, targetId: String? = null)

Detaches session with given id.

disposeBrowserContext

suspend fun disposeBrowserContext(browserContextId: String)

suspend fun disposeBrowserContext(args: Target.DisposeBrowserContextParameter, mode: CommandMode = CommandMode.DEFAULT)

Deletes a BrowserContext. All the belonging pages will be closed without calling their beforeunload hooks.

exposeDevToolsProtocol

suspend fun exposeDevToolsProtocol(args: Target.ExposeDevToolsProtocolParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun exposeDevToolsProtocol(targetId: String, bindingName: String? = null, inheritPermissions: Boolean? = null)

Inject object to the target's main frame that provides a communication channel with browser target.

getBrowserContexts

suspend fun getBrowserContexts(mode: CommandMode = CommandMode.DEFAULT): Target.GetBrowserContextsReturn

Returns all browser contexts created with Target.createBrowserContext method.

getTargetInfo

suspend fun getTargetInfo(targetId: String? = null): Target.GetTargetInfoReturn

suspend fun getTargetInfo(args: Target.GetTargetInfoParameter, mode: CommandMode = CommandMode.DEFAULT): Target.GetTargetInfoReturn

Returns information about a target.

getTargets

suspend fun getTargets(filter: List<Double>? = null): Target.GetTargetsReturn

suspend fun getTargets(args: Target.GetTargetsParameter, mode: CommandMode = CommandMode.DEFAULT): Target.GetTargetsReturn

Retrieves a list of available targets.

sendMessageToTarget

suspend fun ~~sendMessageToTarget~~(args: Target.SendMessageToTargetParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun ~~sendMessageToTarget~~(message: String, sessionId: String? = null, targetId: String? = null)

Sends protocol message over session with given id. Consider using flat mode instead; see commands attachToTarget, setAutoAttach, and crbug.com/991325.

setAutoAttach

suspend fun setAutoAttach(args: Target.SetAutoAttachParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun setAutoAttach(autoAttach: Boolean, waitForDebuggerOnStart: Boolean, flatten: Boolean? = null, filter: List<Double>? = null)

Controls whether to automatically attach to new targets which are considered to be directly related to this one (for example, iframes or workers). When turned on, attaches to all existing related targets as well. When turned off, automatically detaches from all currently attached targets. This also clears all targets added by autoAttachRelated from the list of targets to watch for creation of related targets. You might want to call this recursively for auto-attached targets to attach to all available targets.

setDiscoverTargets

suspend fun setDiscoverTargets(args: Target.SetDiscoverTargetsParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun setDiscoverTargets(discover: Boolean, filter: List<Double>? = null)

Controls whether to discover available targets and notify via targetCreated/targetInfoChanged/targetDestroyed events.

setRemoteLocations

suspend fun setRemoteLocations(locations: List<Target.RemoteLocation>)

suspend fun setRemoteLocations(args: Target.SetRemoteLocationsParameter, mode: CommandMode = CommandMode.DEFAULT)

Enables target discovery for the specified locations, when setDiscoverTargets was set to true.