io.webfolder.cdp.command

Interface Browser

public interface Browser

The Browser domain defines methods and events for browser managing

Method Summary

Modifier and Type	Method and Description
void	close() Close browser gracefully.
void	crash() Crashes browser on the main thread.
List<String>	getBrowserCommandLine() Returns the command line switches for the browser process if, and only if --enable-automation is on the commandline.
Histogram	getHistogram(String name) Get a Chrome histogram by name.
Histogram	getHistogram(String name, Boolean delta) Get a Chrome histogram by name.
List<Histogram>	getHistograms() Get Chrome histograms.
List<Histogram>	getHistograms(String query, Boolean delta) Get Chrome histograms.
GetVersionResult	getVersion() Returns version information.
Bounds	getWindowBounds(Integer windowId) Get position and size of the browser window.
GetWindowForTargetResult	getWindowForTarget() Get the browser window that contains the devtools target.
GetWindowForTargetResult	getWindowForTarget(String targetId) Get the browser window that contains the devtools target.
void	grantPermissions(String origin, PermissionType permissions) Grant specific permissions to the given origin and reject all others.
void	grantPermissions(String origin, PermissionType permissions, String browserContextId) Grant specific permissions to the given origin and reject all others.
void	resetPermissions() Reset all permission management for all origins.
void	resetPermissions(String browserContextId) Reset all permission management for all origins.
void	setDockTile() Set dock tile details, platform-specific.
void	setDockTile(String badgeLabel, String image) Set dock tile details, platform-specific.
void	setWindowBounds(Integer windowId, Bounds bounds) Set position and/or size of the browser window.

Method Detail

grantPermissions

void grantPermissions(String origin,
                      PermissionType permissions,
                      String browserContextId)

Grant specific permissions to the given origin and reject all others.

Parameters:

browserContextId - BrowserContext to override permissions. When omitted, default browser context is used.

resetPermissions

void resetPermissions(String browserContextId)

Reset all permission management for all origins.

Parameters:

browserContextId - BrowserContext to reset permissions. When omitted, default browser context is used.

close

void close()

Close browser gracefully.

crash

void crash()

Crashes browser on the main thread.

getVersion

GetVersionResult getVersion()

Returns version information.

Returns:

GetVersionResult

getBrowserCommandLine

List<String> getBrowserCommandLine()

Returns the command line switches for the browser process if, and only if --enable-automation is on the commandline.

Returns:

Commandline parameters

getHistograms

List<Histogram> getHistograms(String query,
                              Boolean delta)

Get Chrome histograms.

Parameters:

query - Requested substring in name. Only histograms which have query as a substring in their name are extracted. An empty or absent query returns all histograms.

delta - If true, retrieve delta since last call.

Returns:

Histograms.

getHistogram

Histogram getHistogram(String name,
                       Boolean delta)

Get a Chrome histogram by name.

Parameters:

name - Requested histogram name.

delta - If true, retrieve delta since last call.

Returns:

Histogram.

getWindowBounds

Bounds getWindowBounds(Integer windowId)

Get position and size of the browser window.

Parameters:

windowId - Browser window id.

Returns:

Bounds information of the window. When window state is 'minimized', the restored window position and size are returned.

getWindowForTarget

GetWindowForTargetResult getWindowForTarget(String targetId)

Get the browser window that contains the devtools target.

Parameters:

targetId - Devtools agent host id. If called as a part of the session, associated targetId is used.

Returns:

GetWindowForTargetResult

setWindowBounds

void setWindowBounds(Integer windowId,
                     Bounds bounds)

Set position and/or size of the browser window.

Parameters:

windowId - Browser window id.

bounds - New window bounds. The 'minimized', 'maximized' and 'fullscreen' states cannot be combined with 'left', 'top', 'width' or 'height'. Leaves unspecified fields unchanged.

setDockTile

void setDockTile(String badgeLabel,
                 String image)

Set dock tile details, platform-specific.

Parameters:

image - Png encoded image.

grantPermissions

void grantPermissions(String origin,
                      PermissionType permissions)

Grant specific permissions to the given origin and reject all others.

resetPermissions

void resetPermissions()

Reset all permission management for all origins.

getHistograms

List<Histogram> getHistograms()

Get Chrome histograms.

Returns:

Histograms.

getHistogram

Histogram getHistogram(String name)

Get a Chrome histogram by name.

Parameters:

name - Requested histogram name.

Returns:

Histogram.

getWindowForTarget

GetWindowForTargetResult getWindowForTarget()

Get the browser window that contains the devtools target.

Returns:

GetWindowForTargetResult

setDockTile

void setDockTile()

Set dock tile details, platform-specific.