Target Domain
Supports additional targets discovery and allows to attach to them.
Methods
Events
Types
Methods
Target.attachToTarget #
Attaches to the target with given id.
parameters
- targetId
-
TargetID
- flatten
-
boolean
Enables "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
-
SessionID
Id assigned to the session.
Target.closeTarget #
Closes the target. If the target is a page that gets closed too.
parameters
- targetId
-
TargetID
Return Object
- success
-
boolean
Deprecated
Always 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
- disposeOnDetach
-
boolean
Experimental
If specified, disposes this context when debugging session disconnects.
- proxyServer
-
string
Experimental
Proxy server, similar to the one passed to --proxy-server
- proxyBypassList
-
string
Experimental
Proxy bypass list, similar to the one passed to --proxy-bypass-list
- originsWithUniversalNetworkAccess
-
array[ string ]
Experimental
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
-
Browser.BrowserContextID
The id of the context created.
Target.createTarget #
Creates a new page.
parameters
- url
-
string
The initial URL the page will be navigated to. An empty string indicates about:blank.
- width
-
integer
Frame width in DIP (headless chrome only).
- height
-
integer
Frame height in DIP (headless chrome only).
- browserContextId
-
Browser.BrowserContextID
Experimental
The browser context to create the page in.
- enableBeginFrameControl
-
boolean
Experimental
Whether BeginFrames for this target will be controlled via DevTools (headless chrome only, not supported on MacOS yet, false by default).
- newWindow
-
boolean
Whether to create a new Window or Tab (chrome-only, false by default).
- background
-
boolean
Whether to create the target in background or foreground (chrome-only, false by default).
- forTab
-
boolean
Experimental
Whether to create the target of type "tab".
Return Object
- targetId
-
TargetID
The id of the page opened.
Target.disposeBrowserContext #
Deletes a BrowserContext. All the belonging pages will be closed without calling their beforeunload hooks.
parameters
- browserContextId
-
Browser.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
- filter
-
TargetFilter
Experimental
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
-
boolean
Whether to auto-attach to related targets.
- waitForDebuggerOnStart
-
boolean
Whether to pause new targets when attaching to them. Use
Runtime.runIfWaitingForDebuggerto run paused targets. - flatten
-
boolean
Experimental
Enables "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.
- filter
-
TargetFilter
Experimental
Only targets matching filter will be attached.
Target.setDiscoverTargets #
Controls whether to discover available targets and notify via
targetCreated/targetInfoChanged/targetDestroyed events.
parameters
- discover
-
boolean
Whether to discover available targets.
- filter
-
TargetFilter
Experimental
Only targets matching filter will be attached. If
discoveris false,filtermust be omitted or empty.
Events
Target.receivedMessageFromTarget #
Notifies about a new protocol message received from the session (as reported in
attachedToTarget event).
parameters
Target.targetCrashed #
Issued when a target has crashed.
parameters
- targetId
-
TargetID
- status
-
string
Termination status type.
- errorCode
-
integer
Termination error code.
Target.targetCreated #
Issued when a possible inspection target is created.
parameters
- targetInfo
-
TargetInfo
Target.targetInfoChanged #
Issued when some information about a target has changed. This only happens between
targetCreated and targetDestroyed.
parameters
- targetInfo
-
TargetInfo
Types
Target.TargetInfo #
Type: object
properties
- targetId
-
TargetID
- type
- string
- title
-
string
- url
-
string
- attached
-
boolean
Whether the target has an attached client.
- openerId
-
TargetID
Opener target Id
- canAccessOpener
-
boolean
Experimental
Whether the target has access to the originating window.
- openerFrameId
-
Page.FrameId
Experimental
Frame id of originating window (is only set if target has an opener).
- browserContextId
-
Browser.BrowserContextID
Experimental
- subtype
-
string
Experimental
Provides additional details for specific target types. For example, for the type of "page", this may be set to "portal" or "prerender".