Package io.webfolder.cdp.command

Interface Page

public interface Page

Actions and events related to the inspected page belong to the page domain

Method Summary

Modifier and Type	Method	Description
String	addScriptToEvaluateOnLoad(String scriptSource)	Deprecated, please use addScriptToEvaluateOnNewDocument instead.
String	addScriptToEvaluateOnNewDocument(String source)	Evaluates given script in every frame upon creation (before loading frame's scripts).
void	bringToFront()	Brings page to front (activates tab).
byte[]	captureScreenshot()	Capture page screenshot.
byte[]	captureScreenshot(ImageFormat format, Integer quality, Viewport clip, Boolean fromSurface)	Capture page screenshot.
void	clearDeviceMetricsOverride()	Clears the overriden device metrics.
void	clearDeviceOrientationOverride()	Clears the overridden Device Orientation.
void	clearGeolocationOverride()	Clears the overriden Geolocation Position and Error.
Integer	createIsolatedWorld(String frameId)	Creates an isolated world for the given frame.
Integer	createIsolatedWorld(String frameId, String worldName, Boolean grantUniveralAccess)	Creates an isolated world for the given frame.
void	deleteCookie(String cookieName, String url)	Deletes browser cookie with given name, domain and path.
void	disable()	Disables page domain notifications.
void	enable()	Enables page domain notifications.
GetAppManifestResult	getAppManifest()
List<Cookie>	getCookies()	Returns all browser cookies.
FrameTree	getFrameTree()	Returns present frame tree structure.
GetLayoutMetricsResult	getLayoutMetrics()	Returns metrics relating to the layouting of the page, such as viewport bounds/scale.
GetNavigationHistoryResult	getNavigationHistory()	Returns navigation history for the current page.
GetResourceContentResult	getResourceContent(String frameId, String url)	Returns content of the given resource.
FrameResourceTree	getResourceTree()	Returns present frame / resource tree structure.
void	handleJavaScriptDialog(Boolean accept)	Accepts or dismisses a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload).
void	handleJavaScriptDialog(Boolean accept, String promptText)	Accepts or dismisses a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload).
NavigateResult	navigate(String url)	Navigates current page to the given URL.
NavigateResult	navigate(String url, String referrer, TransitionType transitionType)	Navigates current page to the given URL.
void	navigateToHistoryEntry(Integer entryId)	Navigates current page to the given history entry.
byte[]	printToPDF()	Print page as PDF.
byte[]	printToPDF(Boolean landscape, Boolean displayHeaderFooter, Boolean printBackground, Double scale, Double paperWidth, Double paperHeight, Double marginTop, Double marginBottom, Double marginLeft, Double marginRight, String pageRanges, Boolean ignoreInvalidPageRanges, String headerTemplate, String footerTemplate)	Print page as PDF.
void	reload()	Reloads given page optionally ignoring the cache.
void	reload(Boolean ignoreCache, String scriptToEvaluateOnLoad)	Reloads given page optionally ignoring the cache.
void	removeScriptToEvaluateOnLoad(String identifier)	Deprecated, please use removeScriptToEvaluateOnNewDocument instead.
void	removeScriptToEvaluateOnNewDocument(String identifier)	Removes given script from the list.
void	requestAppBanner()
void	screencastFrameAck(Integer sessionId)	Acknowledges that a screencast frame has been received by the frontend.
List<SearchMatch>	searchInResource(String frameId, String url, String query)	Searches for given string in resource content.
List<SearchMatch>	searchInResource(String frameId, String url, String query, Boolean caseSensitive, Boolean isRegex)	Searches for given string in resource content.
void	setAdBlockingEnabled(Boolean enabled)	Enable Chrome's experimental ad filter on all sites.
void	setDeviceMetricsOverride(Integer width, Integer height, Double deviceScaleFactor, Boolean mobile)	Overrides the values of device screen dimensions (window.screen.width, window.screen.height, window.innerWidth, window.innerHeight, and "device-width"/"device-height"-related CSS media query results).
void	setDeviceMetricsOverride(Integer width, Integer height, Double deviceScaleFactor, Boolean mobile, Double scale, Integer screenWidth, Integer screenHeight, Integer positionX, Integer positionY, Boolean dontSetVisibleSize, ScreenOrientation screenOrientation, Viewport viewport)	Overrides the values of device screen dimensions (window.screen.width, window.screen.height, window.innerWidth, window.innerHeight, and "device-width"/"device-height"-related CSS media query results).
void	setDeviceOrientationOverride(Double alpha, Double beta, Double gamma)	Overrides the Device Orientation.
void	setDocumentContent(String frameId, String html)	Sets given markup as the document's HTML.
void	setDownloadBehavior(DownloadBehavior behavior)	Set the behavior when downloading a file.
void	setDownloadBehavior(DownloadBehavior behavior, String downloadPath)	Set the behavior when downloading a file.
void	setGeolocationOverride()	Overrides the Geolocation Position or Error.
void	setGeolocationOverride(Double latitude, Double longitude, Double accuracy)	Overrides the Geolocation Position or Error.
void	setLifecycleEventsEnabled(Boolean enabled)	Controls whether page will emit lifecycle events.
void	setTouchEmulationEnabled(Boolean enabled)	Toggles mouse event-based touch event emulation.
void	setTouchEmulationEnabled(Boolean enabled, Platform configuration)	Toggles mouse event-based touch event emulation.
void	startScreencast()	Starts sending each frame using the screencastFrame event.
void	startScreencast(ImageFormat format, Integer quality, Integer maxWidth, Integer maxHeight, Integer everyNthFrame)	Starts sending each frame using the screencastFrame event.
void	stopLoading()	Force the page stop all navigations and pending resource fetches.
void	stopScreencast()	Stops sending each frame in the screencastFrame.

Method Detail

addScriptToEvaluateOnLoad

String addScriptToEvaluateOnLoad(String scriptSource)

Deprecated, please use addScriptToEvaluateOnNewDocument instead.

Returns:

Identifier of the added script.

addScriptToEvaluateOnNewDocument

String addScriptToEvaluateOnNewDocument(String source)

Evaluates given script in every frame upon creation (before loading frame's scripts).

Returns:

Identifier of the added script.

bringToFront

void bringToFront()

Brings page to front (activates tab).

captureScreenshot

byte[] captureScreenshot(ImageFormat format,
                         Integer quality,
                         Viewport clip,
                         Boolean fromSurface)

Capture page screenshot.

Parameters:

format - Image compression format (defaults to png).

quality - Compression quality from range [0..100] (jpeg only).

clip - Capture the screenshot of a given region only.

fromSurface - Capture the screenshot from the surface, rather than the view. Defaults to true.

Returns:

Base64-encoded image data.

clearDeviceMetricsOverride

void clearDeviceMetricsOverride()

Clears the overriden device metrics.

clearDeviceOrientationOverride

void clearDeviceOrientationOverride()

Clears the overridden Device Orientation.

clearGeolocationOverride

void clearGeolocationOverride()

Clears the overriden Geolocation Position and Error.

createIsolatedWorld

Integer createIsolatedWorld(String frameId,
                            String worldName,
                            Boolean grantUniveralAccess)

Creates an isolated world for the given frame.

Parameters:

frameId - Id of the frame in which the isolated world should be created.

worldName - An optional name which is reported in the Execution Context.

grantUniveralAccess - Whether or not universal access should be granted to the isolated world. This is a powerful option, use with caution.

Returns:

Execution context of the isolated world.

deleteCookie

void deleteCookie(String cookieName,
                  String url)

Deletes browser cookie with given name, domain and path.

Parameters:

cookieName - Name of the cookie to remove.

url - URL to match cooke domain and path.

disable

void disable()

Disables page domain notifications.

enable

void enable()

Enables page domain notifications.

getAppManifest

GetAppManifestResult getAppManifest()

Returns:

GetAppManifestResult

getCookies

List<Cookie> getCookies()

Returns all browser cookies. Depending on the backend support, will return detailed cookie information in the cookies field.

Returns:

Array of cookie objects.

getFrameTree

FrameTree getFrameTree()

Returns present frame tree structure.

Returns:

Present frame tree structure.

getLayoutMetrics

GetLayoutMetricsResult getLayoutMetrics()

Returns metrics relating to the layouting of the page, such as viewport bounds/scale.

Returns:

GetLayoutMetricsResult

getNavigationHistory

GetNavigationHistoryResult getNavigationHistory()

Returns navigation history for the current page.

Returns:

GetNavigationHistoryResult

getResourceContent

GetResourceContentResult getResourceContent(String frameId,
                                            String url)

Returns content of the given resource.

Parameters:

frameId - Frame id to get resource for.

url - URL of the resource to get content for.

Returns:

GetResourceContentResult

getResourceTree

FrameResourceTree getResourceTree()

Returns present frame / resource tree structure.

Returns:

Present frame / resource tree structure.

handleJavaScriptDialog

void handleJavaScriptDialog(Boolean accept,
                            String promptText)

Accepts or dismisses a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload).

Parameters:

accept - Whether to accept or dismiss the dialog.

promptText - The text to enter into the dialog prompt before accepting. Used only if this is a prompt dialog.

navigate

NavigateResult navigate(String url,
                        String referrer,
                        TransitionType transitionType)

Navigates current page to the given URL.

Parameters:

url - URL to navigate the page to.

referrer - Referrer URL.

transitionType - Intended transition type.

Returns:

NavigateResult

navigateToHistoryEntry

void navigateToHistoryEntry(Integer entryId)

Navigates current page to the given history entry.

Parameters:

entryId - Unique id of the entry to navigate to.

printToPDF

byte[] printToPDF(Boolean landscape,
                  Boolean displayHeaderFooter,
                  Boolean printBackground,
                  Double scale,
                  Double paperWidth,
                  Double paperHeight,
                  Double marginTop,
                  Double marginBottom,
                  Double marginLeft,
                  Double marginRight,
                  String pageRanges,
                  Boolean ignoreInvalidPageRanges,
                  String headerTemplate,
                  String footerTemplate)

Print page as PDF.

Parameters:

landscape - Paper orientation. Defaults to false.

displayHeaderFooter - Display header and footer. Defaults to false.

printBackground - Print background graphics. Defaults to false.

scale - Scale of the webpage rendering. Defaults to 1.

paperWidth - Paper width in inches. Defaults to 8.5 inches.

paperHeight - Paper height in inches. Defaults to 11 inches.

marginTop - Top margin in inches. Defaults to 1cm (~0.4 inches).

marginBottom - Bottom margin in inches. Defaults to 1cm (~0.4 inches).

marginLeft - Left margin in inches. Defaults to 1cm (~0.4 inches).

marginRight - Right margin in inches. Defaults to 1cm (~0.4 inches).

pageRanges - Paper ranges to print, e.g., '1-5, 8, 11-13'. Defaults to the empty string, which means print all pages.

ignoreInvalidPageRanges - Whether to silently ignore invalid but successfully parsed page ranges, such as '3-2'. Defaults to false.

headerTemplate - HTML template for the print header. Should be valid HTML markup with following classes used to inject printing values into them: - date - formatted print date - title - document title - url - document location - pageNumber - current page number - totalPages - total pages in the document For example, would generate span containing the title.

footerTemplate - HTML template for the print footer. Should use the same format as the headerTemplate.

Returns:

Base64-encoded pdf data.

reload

void reload(Boolean ignoreCache,
            String scriptToEvaluateOnLoad)

Reloads given page optionally ignoring the cache.

Parameters:

ignoreCache - If true, browser cache is ignored (as if the user pressed Shift+refresh).

scriptToEvaluateOnLoad - If set, the script will be injected into all frames of the inspected page after reload. Argument will be ignored if reloading dataURL origin.

removeScriptToEvaluateOnLoad

void removeScriptToEvaluateOnLoad(String identifier)

Deprecated, please use removeScriptToEvaluateOnNewDocument instead.

removeScriptToEvaluateOnNewDocument

void removeScriptToEvaluateOnNewDocument(String identifier)

Removes given script from the list.

requestAppBanner

void requestAppBanner()

screencastFrameAck

void screencastFrameAck(Integer sessionId)

Acknowledges that a screencast frame has been received by the frontend.

Parameters:

sessionId - Frame number.

searchInResource

List<SearchMatch> searchInResource(String frameId,
                                   String url,
                                   String query,
                                   Boolean caseSensitive,
                                   Boolean isRegex)

Searches for given string in resource content.

Parameters:

frameId - Frame id for resource to search in.

url - URL of the resource to search in.

query - String to search for.

caseSensitive - If true, search is case sensitive.

isRegex - If true, treats string parameter as regex.

Returns:

List of search matches.

setAdBlockingEnabled

void setAdBlockingEnabled(Boolean enabled)

Enable Chrome's experimental ad filter on all sites.

Parameters:

enabled - Whether to block ads.

setDeviceMetricsOverride

void setDeviceMetricsOverride(Integer width,
                              Integer height,
                              Double deviceScaleFactor,
                              Boolean mobile,
                              Double scale,
                              Integer screenWidth,
                              Integer screenHeight,
                              Integer positionX,
                              Integer positionY,
                              Boolean dontSetVisibleSize,
                              ScreenOrientation screenOrientation,
                              Viewport viewport)

Overrides the values of device screen dimensions (window.screen.width, window.screen.height, window.innerWidth, window.innerHeight, and "device-width"/"device-height"-related CSS media query results).

Parameters:

width - Overriding width value in pixels (minimum 0, maximum 10000000). 0 disables the override.

height - Overriding height value in pixels (minimum 0, maximum 10000000). 0 disables the override.

deviceScaleFactor - Overriding device scale factor value. 0 disables the override.

mobile - Whether to emulate mobile device. This includes viewport meta tag, overlay scrollbars, text autosizing and more.

scale - Scale to apply to resulting view image.

screenWidth - Overriding screen width value in pixels (minimum 0, maximum 10000000).

screenHeight - Overriding screen height value in pixels (minimum 0, maximum 10000000).

positionX - Overriding view X position on screen in pixels (minimum 0, maximum 10000000).

positionY - Overriding view Y position on screen in pixels (minimum 0, maximum 10000000).

dontSetVisibleSize - Do not set visible view size, rely upon explicit setVisibleSize call.

screenOrientation - Screen orientation override.

viewport - The viewport dimensions and scale. If not set, the override is cleared.

setDeviceOrientationOverride

void setDeviceOrientationOverride(Double alpha,
                                  Double beta,
                                  Double gamma)

Overrides the Device Orientation.

Parameters:

alpha - Mock alpha

beta - Mock beta

gamma - Mock gamma

setDocumentContent

void setDocumentContent(String frameId,
                        String html)

Sets given markup as the document's HTML.

Parameters:

frameId - Frame id to set HTML for.

html - HTML content to set.

setDownloadBehavior

void setDownloadBehavior(DownloadBehavior behavior,
                         String downloadPath)

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

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

setGeolocationOverride

void setGeolocationOverride(Double latitude,
                            Double longitude,
                            Double accuracy)

Overrides the Geolocation Position or Error. Omitting any of the parameters emulates position unavailable.

Parameters:

latitude - Mock latitude

longitude - Mock longitude

accuracy - Mock accuracy

setLifecycleEventsEnabled

void setLifecycleEventsEnabled(Boolean enabled)

Controls whether page will emit lifecycle events.

Parameters:

enabled - If true, starts emitting lifecycle events.

setTouchEmulationEnabled

void setTouchEmulationEnabled(Boolean enabled,
                              Platform configuration)

Toggles mouse event-based touch event emulation.

Parameters:

enabled - Whether the touch event emulation should be enabled.

configuration - Touch/gesture events configuration. Default: current platform.

startScreencast

void startScreencast(ImageFormat format,
                     Integer quality,
                     Integer maxWidth,
                     Integer maxHeight,
                     Integer everyNthFrame)

Starts sending each frame using the screencastFrame event.

Parameters:

format - Image compression format.

quality - Compression quality from range [0..100].

maxWidth - Maximum screenshot width.

maxHeight - Maximum screenshot height.

everyNthFrame - Send every n-th frame.

stopLoading

void stopLoading()

Force the page stop all navigations and pending resource fetches.

stopScreencast

void stopScreencast()

Stops sending each frame in the screencastFrame.

captureScreenshot

byte[] captureScreenshot()

Capture page screenshot.

Returns:

Base64-encoded image data.

createIsolatedWorld

Integer createIsolatedWorld(String frameId)

Creates an isolated world for the given frame.

Parameters:

frameId - Id of the frame in which the isolated world should be created.

Returns:

Execution context of the isolated world.

handleJavaScriptDialog

void handleJavaScriptDialog(Boolean accept)

Accepts or dismisses a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload).

Parameters:

accept - Whether to accept or dismiss the dialog.

navigate

NavigateResult navigate(String url)

Navigates current page to the given URL.

Parameters:

url - URL to navigate the page to.

Returns:

NavigateResult

printToPDF

byte[] printToPDF()

Print page as PDF.

Returns:

Base64-encoded pdf data.

reload

void reload()

Reloads given page optionally ignoring the cache.

searchInResource

List<SearchMatch> searchInResource(String frameId,
                                   String url,
                                   String query)

Searches for given string in resource content.

Parameters:

frameId - Frame id for resource to search in.

url - URL of the resource to search in.

query - String to search for.

Returns:

List of search matches.

setDeviceMetricsOverride

void setDeviceMetricsOverride(Integer width,
                              Integer height,
                              Double deviceScaleFactor,
                              Boolean mobile)

Overrides the values of device screen dimensions (window.screen.width, window.screen.height, window.innerWidth, window.innerHeight, and "device-width"/"device-height"-related CSS media query results).

Parameters:

width - Overriding width value in pixels (minimum 0, maximum 10000000). 0 disables the override.

height - Overriding height value in pixels (minimum 0, maximum 10000000). 0 disables the override.

deviceScaleFactor - Overriding device scale factor value. 0 disables the override.

mobile - Whether to emulate mobile device. This includes viewport meta tag, overlay scrollbars, text autosizing and more.

setDownloadBehavior

void setDownloadBehavior(DownloadBehavior 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).

setGeolocationOverride

void setGeolocationOverride()

Overrides the Geolocation Position or Error. Omitting any of the parameters emulates position unavailable.

setTouchEmulationEnabled

void setTouchEmulationEnabled(Boolean enabled)

Toggles mouse event-based touch event emulation.

Parameters:

enabled - Whether the touch event emulation should be enabled.

startScreencast

void startScreencast()

Starts sending each frame using the screencastFrame event.