com.github.kklisura.cdt.protocol.commands

Interface Browser

public interface Browser

The Browser domain defines methods and events for browser managing.

Method Summary

Modifier and Type	Method and Description
void	cancelDownload(String guid) Cancel a download if in progress
void	cancelDownload(String guid, String browserContextId) Cancel a download if in progress
void	close() Close browser gracefully.
void	crash() Crashes browser on the main thread.
void	crashGpuProcess() Crashes GPU process.
void	executeBrowserCommand(BrowserCommandId commandId) Invoke custom browser commands used by telemetry.
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.
Version	getVersion() Returns version information.
Bounds	getWindowBounds(Integer windowId) Get position and size of the browser window.
WindowForTarget	getWindowForTarget() Get the browser window that contains the devtools target.
WindowForTarget	getWindowForTarget(String targetId) Get the browser window that contains the devtools target.
void	grantPermissions(List<PermissionType> permissions) Grant specific permissions to the given origin and reject all others.
void	grantPermissions(List<PermissionType> permissions, String origin, String browserContextId) Grant specific permissions to the given origin and reject all others.
EventListener	onDownloadProgress(EventHandler<DownloadProgress> eventListener) Fired when download makes progress.
EventListener	onDownloadWillBegin(EventHandler<DownloadWillBegin> eventListener) Fired when page is about to start a download.
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	setDownloadBehavior(SetDownloadBehaviorBehavior behavior) Set the behavior when downloading a file.
void	setDownloadBehavior(SetDownloadBehaviorBehavior behavior, String browserContextId, String downloadPath, Boolean eventsEnabled) Set the behavior when downloading a file.
void	setPermission(PermissionDescriptor permission, PermissionSetting setting) Set permission settings for given origin.
void	setPermission(PermissionDescriptor permission, PermissionSetting setting, String origin, String browserContextId) Set permission settings for given origin.
void	setWindowBounds(Integer windowId, Bounds bounds) Set position and/or size of the browser window.

Method Detail

setPermission

void setPermission(PermissionDescriptor permission,
                   PermissionSetting setting)

Set permission settings for given origin.

Parameters:

permission - Descriptor of permission to override.

setting - Setting of the permission.

setPermission

void setPermission(PermissionDescriptor permission,
                   PermissionSetting setting,
                   String origin,
                   String browserContextId)

Set permission settings for given origin.

Parameters:

permission - Descriptor of permission to override.

setting - Setting of the permission.

origin - Origin the permission applies to, all origins if not specified.

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

grantPermissions

void grantPermissions(List<PermissionType> permissions)

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

Parameters:

permissions -

grantPermissions

void grantPermissions(List<PermissionType> permissions,
                      String origin,
                      String browserContextId)

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

Parameters:

permissions -

origin - Origin the permission applies to, all origins if not specified.

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

resetPermissions

void resetPermissions()

Reset all permission management for all origins.

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.

setDownloadBehavior

void setDownloadBehavior(SetDownloadBehaviorBehavior behavior)

Set the behavior when downloading a file.

Parameters:

behavior - Whether to allow all or deny all download requests, or use default Chrome behavior if available (otherwise deny). |allowAndName| allows download and names files according to their dowmload guids.

setDownloadBehavior

void setDownloadBehavior(SetDownloadBehaviorBehavior behavior,
                         String browserContextId,
                         String downloadPath,
                         Boolean eventsEnabled)

Set the behavior when downloading a file.

Parameters:

behavior - Whether to allow all or deny all download requests, or use default Chrome behavior if available (otherwise deny). |allowAndName| allows download and names files according to their dowmload guids.

browserContextId - BrowserContext to set download behavior. When omitted, default browser context is used.

downloadPath - The default path to save downloaded files to. This is required if behavior is set to 'allow' or 'allowAndName'.

eventsEnabled - Whether to emit download events (defaults to false).

cancelDownload

void cancelDownload(String guid)

Cancel a download if in progress

Parameters:

guid - Global unique identifier of the download.

cancelDownload

void cancelDownload(String guid,
                    String browserContextId)

Cancel a download if in progress

Parameters:

guid - Global unique identifier of the download.

browserContextId - BrowserContext to perform the action in. When omitted, default browser context is used.

close

void close()

Close browser gracefully.

crash

void crash()

Crashes browser on the main thread.

crashGpuProcess

void crashGpuProcess()

Crashes GPU process.

getVersion

Version getVersion()

Returns version information.

getBrowserCommandLine

List<String> getBrowserCommandLine()

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

getHistograms

List<Histogram> getHistograms()

Get Chrome histograms.

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.

getHistogram

Histogram getHistogram(String name)

Get a Chrome histogram by name.

Parameters:

name - Requested histogram name.

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.

getWindowBounds

Bounds getWindowBounds(Integer windowId)

Get position and size of the browser window.

Parameters:

windowId - Browser window id.

getWindowForTarget

WindowForTarget getWindowForTarget()

Get the browser window that contains the devtools target.

getWindowForTarget

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

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()

Set dock tile details, platform-specific.

setDockTile

void setDockTile(String badgeLabel,
                 String image)

Set dock tile details, platform-specific.

Parameters:

badgeLabel -

image - Png encoded image. (Encoded as a base64 string when passed over JSON)

executeBrowserCommand

void executeBrowserCommand(BrowserCommandId commandId)

Invoke custom browser commands used by telemetry.

Parameters:

commandId -

onDownloadWillBegin

EventListener onDownloadWillBegin(EventHandler<DownloadWillBegin> eventListener)

Fired when page is about to start a download.

onDownloadProgress

EventListener onDownloadProgress(EventHandler<DownloadProgress> eventListener)

Fired when download makes progress. Last call has |done| == true.