io.webfolder.cdp.command

Interface Target

public interface Target

Supports additional targets discovery and allows to attach to them

Method Summary

Modifier and Type	Method and Description
void	activateTarget(String targetId) Activates (focuses) the target.
String	attachToBrowserTarget() Attaches to the browser target, only uses flat sessionId mode.
String	attachToTarget(String targetId) Attaches to the target with given id.
String	attachToTarget(String targetId, Boolean flatten) Attaches to the target with given id.
Boolean	closeTarget(String targetId) Closes the target.
String	createBrowserContext() Creates a new empty BrowserContext.
String	createTarget(String url) Creates a new page.
String	createTarget(String url, Integer width, Integer height, String browserContextId, Boolean enableBeginFrameControl) Creates a new page.
void	detachFromTarget() Detaches session with given id.
void	detachFromTarget(String sessionId, String targetId) Detaches session with given id.
void	disposeBrowserContext(String browserContextId) Deletes a BrowserContext.
void	exposeDevToolsProtocol(String targetId) Inject object to the target's main frame that provides a communication channel with browser target.
void	exposeDevToolsProtocol(String targetId, String bindingName) Inject object to the target's main frame that provides a communication channel with browser target.
List<String>	getBrowserContexts() Returns all browser contexts created with Target.createBrowserContext method.
TargetInfo	getTargetInfo() Returns information about a target.
TargetInfo	getTargetInfo(String targetId) Returns information about a target.
List<TargetInfo>	getTargets() Retrieves a list of available targets.
void	sendMessageToTarget(String message) Sends protocol message over session with given id.
void	sendMessageToTarget(String message, String sessionId, String targetId) Sends protocol message over session with given id.
void	setAutoAttach(Boolean autoAttach, Boolean waitForDebuggerOnStart) Controls whether to automatically attach to new targets which are considered to be related to this one.
void	setAutoAttach(Boolean autoAttach, Boolean waitForDebuggerOnStart, Boolean flatten) Controls whether to automatically attach to new targets which are considered to be related to this one.
void	setDiscoverTargets(Boolean discover) Controls whether to discover available targets and notify via targetCreated/targetInfoChanged/targetDestroyed events.
void	setRemoteLocations(List<RemoteLocation> locations) Enables target discovery for the specified locations, when setDiscoverTargets was set to true.

Method Detail

activateTarget

void activateTarget(String targetId)

Activates (focuses) the target.

attachToTarget

String attachToTarget(String targetId,
                      Boolean flatten)

Attaches to the target with given id.

Parameters:

flatten - Enables "flat" access to the session via specifying sessionId attribute in the commands.

Returns:

Id assigned to the session.

attachToBrowserTarget

String attachToBrowserTarget()

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

Returns:

Id assigned to the session.

closeTarget

Boolean closeTarget(String targetId)

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

exposeDevToolsProtocol

void exposeDevToolsProtocol(String targetId,
                            String bindingName)

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 follwing 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:

bindingName - Binding name, 'cdp' if not specified.

createBrowserContext

String createBrowserContext()

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

Returns:

The id of the context created.

getBrowserContexts

List<String> getBrowserContexts()

Returns all browser contexts created with Target.createBrowserContext method.

Returns:

An array of browser context ids.

createTarget

String createTarget(String url,
                    Integer width,
                    Integer height,
                    String browserContextId,
                    Boolean enableBeginFrameControl)

Creates a new page.

Parameters:

url - The initial URL the page will be navigated to.

width - Frame width in DIP (headless chrome only).

height - Frame height in DIP (headless chrome only).

browserContextId - The browser context to create the page in.

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

Returns:

The id of the page opened.

detachFromTarget

void detachFromTarget(String sessionId,
                      String targetId)

Detaches session with given id.

Parameters:

sessionId - Session to detach.

targetId - Deprecated.

disposeBrowserContext

void disposeBrowserContext(String browserContextId)

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

getTargetInfo

TargetInfo getTargetInfo(String targetId)

Returns information about a target.

getTargets

List<TargetInfo> getTargets()

Retrieves a list of available targets.

Returns:

The list of targets.

sendMessageToTarget

void sendMessageToTarget(String message,
                         String sessionId,
                         String targetId)

Sends protocol message over session with given id.

Parameters:

sessionId - Identifier of the session.

targetId - Deprecated.

setAutoAttach

void setAutoAttach(Boolean autoAttach,
                   Boolean waitForDebuggerOnStart,
                   Boolean flatten)

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.

Parameters:

autoAttach - Whether to auto-attach to related targets.

waitForDebuggerOnStart - Whether to pause new targets when attaching to them. UseRuntime.runIfWaitingForDebugger to run paused targets.

flatten - Enables "flat" access to the session via specifying sessionId attribute in the commands.

setDiscoverTargets

void setDiscoverTargets(Boolean discover)

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

Parameters:

discover - Whether to discover available targets.

setRemoteLocations

void setRemoteLocations(List<RemoteLocation> locations)

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

Parameters:

locations - List of remote locations.

attachToTarget

String attachToTarget(String targetId)

Attaches to the target with given id.

Returns:

Id assigned to the session.

exposeDevToolsProtocol

void exposeDevToolsProtocol(String targetId)

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 follwing 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.

createTarget

String createTarget(String url)

Creates a new page.

Parameters:

url - The initial URL the page will be navigated to.

Returns:

The id of the page opened.

detachFromTarget

void detachFromTarget()

Detaches session with given id.

getTargetInfo

TargetInfo getTargetInfo()

Returns information about a target.

sendMessageToTarget

void sendMessageToTarget(String message)

Sends protocol message over session with given id.

setAutoAttach

void setAutoAttach(Boolean autoAttach,
                   Boolean waitForDebuggerOnStart)

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.

Parameters:

autoAttach - Whether to auto-attach to related targets.

waitForDebuggerOnStart - Whether to pause new targets when attaching to them. UseRuntime.runIfWaitingForDebugger to run paused targets.