Target Domain
Supports additional targets discovery and allows to attach to them.
Methods
- Target.activateTarget
- Target.attachToTarget
- Target.closeTarget
- Target.createBrowserContext
- Target.createTarget
- Target.detachFromTarget
- Target.disposeBrowserContext
- Target.getBrowserContexts
- Target.getTargets
- Target.setAutoAttach
- Target.setDiscoverTargets
Events
- Target.receivedMessageFromTarget
- Target.targetCrashed
- Target.targetCreated
- Target.targetDestroyed
- Target.targetInfoChanged
Types
Methods
Target.attachToTarget #
Attaches to the target with given id.
Parameters
targetId flattenOptional
booleanEnables "flat" access to the session via specifying sessionId attribute in the commands. We plan to make this the default, deprecate non-flattened mode, and eventually retire it. See crbug.com/991325.
Return object
sessionId Id assigned to the session.
Target.closeTarget #
Closes the target. If the target is a page that gets closed too.
Parameters
targetId Return object
success booleanAlways set to true. If an error occurs, the response indicates protocol error.
Target.createBrowserContext #
Creates a new empty BrowserContext. Similar to an incognito profile but you can have more than one.
Parameters
disposeOnDetachOptional
booleanIf specified, disposes this context when debugging session disconnects.
proxyServerOptional
stringProxy server, similar to the one passed to --proxy-server
proxyBypassListOptional
stringProxy bypass list, similar to the one passed to --proxy-bypass-list
originsWithUniversalNetworkAccessOptional
array[ string ]An optional list of origins to grant unlimited cross-origin access to. Parts of the URL other than those constituting origin are ignored.
Return object
browserContextId The id of the context created.
Target.createTarget #
Creates a new page.
Parameters
url stringThe initial URL the page will be navigated to. An empty string indicates about:blank.
widthOptional
integerFrame width in DIP (headless chrome only).
heightOptional
integerFrame height in DIP (headless chrome only).
browserContextIdOptional
enableBeginFrameControlOptional
booleanWhether BeginFrames for this target will be controlled via DevTools (headless chrome only, not supported on MacOS yet, false by default).
newWindowOptional
booleanWhether to create a new Window or Tab (chrome-only, false by default).
backgroundOptional
booleanWhether to create the target in background or foreground (chrome-only, false by default).
forTabOptional
booleanWhether to create the target of type "tab".
Return object
targetId The id of the page opened.
Target.detachFromTarget #
Detaches session with given id.
Parameters
sessionIdOptional
Session to detach.
targetIdOptional
Target.disposeBrowserContext #
Deletes a BrowserContext. All the belonging pages will be closed without calling their beforeunload hooks.
Parameters
browserContextId Target.getBrowserContexts #
Returns all browser contexts created with Target.createBrowserContext method.
Return object
browserContextIds array[ Browser.BrowserContextID ]An array of browser context ids.
Target.getTargets #
Retrieves a list of available targets.
Parameters
filterOptional
Only targets matching filter will be reported. If filter is not specified and target discovery is currently enabled, a filter used for target discovery is used for consistency.
Return object
targetInfos array[ TargetInfo ]The list of targets.
Target.setAutoAttach #
Controls whether to automatically attach to new targets which are considered to be related to
this one. 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.
Parameters
autoAttach booleanWhether to auto-attach to related targets.
waitForDebuggerOnStart booleanWhether to pause new targets when attaching to them. Use Runtime.runIfWaitingForDebugger
to run paused targets.
flattenOptional
booleanEnables "flat" access to the session via specifying sessionId attribute in the commands. We plan to make this the default, deprecate non-flattened mode, and eventually retire it. See crbug.com/991325.
filterOptional
Target.setDiscoverTargets #
Controls whether to discover available targets and notify via
targetCreated/targetInfoChanged/targetDestroyed events.
Parameters
discover booleanWhether to discover available targets.
filterOptional
Only targets matching filter will be attached. If discover is false,
filter must be omitted or empty.
Events
Target.receivedMessageFromTarget #
Notifies about a new protocol message received from the session (as reported in
attachedToTarget event).
Parameters
sessionId Identifier of a session which sends a message.
message stringtargetIdOptional
Target.targetCrashed #
Issued when a target has crashed.
Parameters
targetId status stringTermination status type.
errorCode integerTermination error code.
Target.targetInfoChanged #
Issued when some information about a target has changed. This only happens between
targetCreated and targetDestroyed.
Parameters
targetInfo Types
Target.TargetInfo #
Type: object
Properties
targetId type stringList of types: https://source.chromium.org/chromium/chromium/src/+/main:content/browser/devtools/devtools_agent_host_impl.cc?ss=chromium&q=f:devtools%20-f:out%20%22::kTypeTab%5B%5D%22
title stringurl stringattached booleanWhether the target has an attached client.
openerIdOptional
Opener target Id
canAccessOpener booleanWhether the target has access to the originating window.
openerFrameIdOptional
browserContextIdOptional
subtypeOptional
stringProvides additional details for specific target types. For example, for the type of "page", this may be set to "portal" or "prerender".