React Native CDP Status

Target.attachToTarget #

Attaches to the target with given id.

Parameters

targetId

flatten
Optional

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

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

boolean

Always set to true. If an error occurs, the response indicates protocol error.

Deprecated

Target.createBrowserContext #

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

Parameters

disposeOnDetach
Optional

boolean

If specified, disposes this context when debugging session disconnects.

Experimental

proxyServer
Optional

string

Proxy server, similar to the one passed to --proxy-server

Experimental

proxyBypassList
Optional

string

Proxy bypass list, similar to the one passed to --proxy-bypass-list

Experimental

originsWithUniversalNetworkAccess
Optional

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.

Experimental

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.

left
Optional

integer

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

Experimental

top
Optional

integer

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

Experimental

width
Optional

integer

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

height
Optional

integer

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

windowState
Optional

WindowState

Frame window state (requires newWindow to be true or headless shell). Default is normal.

browserContextId
Optional

Browser.BrowserContextID

The browser context to create the page in.

Experimental

enableBeginFrameControl
Optional

boolean

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

Experimental

newWindow
Optional

boolean

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

background
Optional

boolean

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

forTab
Optional

boolean

Whether to create the target of type "tab".

Experimental

hidden
Optional

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.

Experimental

Return object

targetId

The id of the page opened.

Target.detachFromTarget #

Detaches session with given id.

Parameters

sessionId
Optional

Session to detach.

targetId
Optional

Deprecated.

Deprecated

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
Optional

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.

Experimental

Return object

targetInfos

array[ TargetInfo ]

The list of targets.

Target.setAutoAttach #

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.

Parameters

autoAttach

boolean

Whether to auto-attach to related targets.

waitForDebuggerOnStart

boolean

Whether to pause new targets when attaching to them. Use Runtime.runIfWaitingForDebugger to run paused targets.

flatten
Optional

boolean

Experimental

filter
Optional

Only targets matching filter will be attached.

Experimental

Target.setDiscoverTargets #

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

Parameters

discover

boolean

Whether to discover available targets.

filter
Optional

Only targets matching filter will be attached. If discover is false, filter must be omitted or empty.

Experimental

Target.sendMessageToTarget Deprecated#

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

Parameters

message

string

sessionId
Optional

Identifier of the session.

targetId
Optional

Deprecated.

Deprecated

Target.attachToBrowserTarget Experimental#

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

Return object

sessionId

Id assigned to the session.

Target.autoAttachRelated Experimental#

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.

Parameters

targetId

waitForDebuggerOnStart

boolean

Whether to pause new targets when attaching to them. Use Runtime.runIfWaitingForDebugger to run paused targets.

filter
Optional

Only targets matching filter will be attached.

Experimental

Target.exposeDevToolsProtocol Experimental#

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

Injected object will be available as window[bindingName].

The object has the following API:

binding.send(json) - a method to send messages over the remote debugging protocol
binding.onmessage = json => handleMessage(json) - a callback that will be called for the protocol notifications and command responses.

Parameters

targetId

bindingName
Optional

string

Binding name, 'cdp' if not specified.

inheritPermissions
Optional

boolean

If true, inherits the current root session's permissions (default: false).

Target.getTargetInfo Experimental#

Returns information about a target.

Parameters

targetId
Optional

Return object

targetInfo

Target.openDevTools Experimental#

Opens a DevTools window for the target.

Parameters

targetId

This can be the page or tab target ID.

Return object

targetId

The targetId of DevTools page target.

Target.setRemoteLocations Experimental#

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

Parameters

locations

array[ RemoteLocation ]

List of remote locations.

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

string

targetId
Optional

Deprecated.

Deprecated

Target.targetCrashed #

Issued when a target has crashed.

Parameters

targetId

status

string

Termination status type.

errorCode

integer

Termination error code.

Target.targetCreated #

Issued when a possible inspection target is created.

Parameters

targetInfo

Target.targetDestroyed #

Issued when a target is destroyed.

Parameters

targetId

Target.targetInfoChanged #

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

Parameters

targetInfo

Target.attachedToTarget Experimental#

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

Parameters

sessionId

Identifier assigned to the session used to send/receive messages.

targetInfo

waitingForDebugger

boolean

Target.detachedFromTarget Experimental#

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.

Parameters

sessionId

Detached session identifier.

targetId
Optional

Deprecated.

Deprecated

Types

Target.SessionID #

Unique identifier of attached debugging session.

Type: string

Target.TargetID #

Type: string

Target.TargetInfo #

Type: object

Properties

targetId

type

string

List 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

string

url

string

attached

boolean

Whether the target has an attached client.

openerId
Optional