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

Package-level declarations

Types

ActivateTargetRequest

@Serializable

data class ActivateTargetRequest(val targetId: TargetID)

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

ActivateTargetResponse

@Serializable

object ActivateTargetResponse

A dummy response object for the TargetDomain.activateTarget command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

AttachToBrowserTargetResponse

@Serializable

data class AttachToBrowserTargetResponse(val sessionId: SessionID)

Response type for the TargetDomain.attachToBrowserTarget command.

AttachToTargetRequest

@Serializable

data class AttachToTargetRequest(val targetId: TargetID, val flatten: Boolean? = null)

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

AttachToTargetResponse

@Serializable

data class AttachToTargetResponse(val sessionId: SessionID)

Response type for the TargetDomain.attachToTarget command.

AutoAttachRelatedRequest

@Serializable

data class AutoAttachRelatedRequest(val targetId: TargetID, val waitForDebuggerOnStart: Boolean, val filter: TargetFilter? = null)

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

AutoAttachRelatedResponse

@Serializable

object AutoAttachRelatedResponse

A dummy response object for the TargetDomain.autoAttachRelated command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

CloseTargetRequest

@Serializable

data class CloseTargetRequest(val targetId: TargetID)

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

CloseTargetResponse

@Serializable

data class CloseTargetResponse(val success: Boolean)

Response type for the TargetDomain.closeTarget command.

CreateBrowserContextRequest

@Serializable

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

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

CreateBrowserContextResponse

@Serializable

data class CreateBrowserContextResponse(val browserContextId: BrowserContextID)

Response type for the TargetDomain.createBrowserContext command.

CreateTargetRequest

@Serializable

data class CreateTargetRequest(val url: String, val width: Int? = null, val height: Int? = null, val browserContextId: BrowserContextID? = null, val enableBeginFrameControl: Boolean? = null, val newWindow: Boolean? = null, val background: Boolean? = null, val forTab: Boolean? = null)

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

CreateTargetResponse

@Serializable

data class CreateTargetResponse(val targetId: TargetID)

Response type for the TargetDomain.createTarget command.

DetachFromTargetRequest

@Serializable

data class DetachFromTargetRequest(val sessionId: SessionID? = null, val targetId: TargetID? = null)

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

DetachFromTargetResponse

@Serializable

object DetachFromTargetResponse

A dummy response object for the TargetDomain.detachFromTarget command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

DisposeBrowserContextRequest

@Serializable

data class DisposeBrowserContextRequest(val browserContextId: BrowserContextID)

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

DisposeBrowserContextResponse

@Serializable

object DisposeBrowserContextResponse

A dummy response object for the TargetDomain.disposeBrowserContext command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

ExposeDevToolsProtocolRequest

@Serializable

data class ExposeDevToolsProtocolRequest(val targetId: TargetID, val bindingName: String? = null)

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

ExposeDevToolsProtocolResponse

@Serializable

object ExposeDevToolsProtocolResponse

A dummy response object for the TargetDomain.exposeDevToolsProtocol command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

FilterEntry

@Serializable

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

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

GetBrowserContextsResponse

@Serializable

data class GetBrowserContextsResponse(val browserContextIds: List<BrowserContextID>)

Response type for the TargetDomain.getBrowserContexts command.

GetTargetInfoRequest

@Serializable

data class GetTargetInfoRequest(val targetId: TargetID? = null)

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

GetTargetInfoResponse

@Serializable

data class GetTargetInfoResponse(val targetInfo: TargetInfo)

Response type for the TargetDomain.getTargetInfo command.

GetTargetsRequest

@Serializable

data class GetTargetsRequest(val filter: TargetFilter? = null)

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

GetTargetsResponse

@Serializable

data class GetTargetsResponse(val targetInfos: List<TargetInfo>)

Response type for the TargetDomain.getTargets command.

RemoteLocation

@Serializable

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

Official doc

SendMessageToTargetRequest

@Serializable

data class ~~SendMessageToTargetRequest~~(val message: String, val sessionId: SessionID? = null, val targetId: TargetID? = null)

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

SendMessageToTargetResponse

@Serializable

object ~~SendMessageToTargetResponse~~

A dummy response object for the TargetDomain.sendMessageToTarget command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

SessionID

typealias SessionID = String

Unique identifier of attached debugging session.

Official doc

SetAutoAttachRequest

@Serializable

data class SetAutoAttachRequest(val autoAttach: Boolean, val waitForDebuggerOnStart: Boolean, val flatten: Boolean? = null, val filter: TargetFilter? = null)

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

SetAutoAttachResponse

@Serializable

object SetAutoAttachResponse

A dummy response object for the TargetDomain.setAutoAttach command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

SetDiscoverTargetsRequest

@Serializable

data class SetDiscoverTargetsRequest(val discover: Boolean, val filter: TargetFilter? = null)

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

SetDiscoverTargetsResponse

@Serializable

object SetDiscoverTargetsResponse

A dummy response object for the TargetDomain.setDiscoverTargets command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

SetRemoteLocationsRequest

@Serializable

data class SetRemoteLocationsRequest(val locations: List<RemoteLocation>)

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

SetRemoteLocationsResponse

@Serializable

object SetRemoteLocationsResponse

A dummy response object for the TargetDomain.setRemoteLocations command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

TargetDomain

class TargetDomain

Supports additional targets discovery and allows to attach to them.

TargetFilter

typealias TargetFilter = List<FilterEntry>

The entries in TargetFilter are matched sequentially against targets and the first entry that matches determines if the target is included or not, depending on the value of exclude field in the entry. If filter is not specified, the one assumed is {type: "browser", exclude: true}, {type: "tab", exclude: true}, {} (i.e. include everything but browser and tab).

Official doc

TargetID

typealias TargetID = String

Official doc

TargetInfo

@Serializable

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

Official doc

Functions

allTargetsFlow

suspend fun TargetDomain.allTargetsFlow(): Flow<Map<TargetID, TargetInfo>>

When collected, this flow enables target discovery and aggregates single-target events to provide updates to a complete map of targets by ID.