Package io.webfolder.cdp.command

Interface Emulation

public interface Emulation

This domain emulates different environments for the page

Method Summary

Modifier and Type	Method	Description
Boolean	canEmulate()	Tells whether emulation is supported.
void	clearDeviceMetricsOverride()	Clears the overriden device metrics.
void	clearGeolocationOverride()	Clears the overriden Geolocation Position and Error.
void	resetPageScaleFactor()	Requests that page scale factor is reset to initial values.
void	setCPUThrottlingRate(Double rate)	Enables CPU throttling to emulate slow CPUs.
void	setDefaultBackgroundColorOverride()	Sets or clears an override of the default background color of the frame.
void	setDefaultBackgroundColorOverride(RGBA color)	Sets or clears an override of the default background color of the frame.
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	setDocumentCookieDisabled(Boolean disabled)
void	setEmitTouchEventsForMouse(Boolean enabled)
void	setEmitTouchEventsForMouse(Boolean enabled, Platform configuration)
void	setEmulatedMedia(String media)	Emulates the given media for CSS media queries.
void	setGeolocationOverride()	Overrides the Geolocation Position or Error.
void	setGeolocationOverride(Double latitude, Double longitude, Double accuracy)	Overrides the Geolocation Position or Error.
void	setNavigatorOverrides(String platform)	Overrides value returned by the javascript navigator object.
void	setPageScaleFactor(Double pageScaleFactor)	Sets a specified page scale factor.
void	setScriptExecutionDisabled(Boolean value)	Switches script execution in the page.
void	setScrollbarsHidden(Boolean hidden)
void	setTouchEmulationEnabled(Boolean enabled)	Enables touch on platforms which do not support them.
void	setTouchEmulationEnabled(Boolean enabled, Integer maxTouchPoints)	Enables touch on platforms which do not support them.
void	setUserAgentOverride(String userAgent)	Allows overriding user agent with the given string.
void	setUserAgentOverride(String userAgent, String acceptLanguage, String platform)	Allows overriding user agent with the given string.
Double	setVirtualTimePolicy(VirtualTimePolicy policy)	Turns on virtual time for all frames (replacing real-time with a synthetic time source) and sets the current virtual time policy.
Double	setVirtualTimePolicy(VirtualTimePolicy policy, Double budget, Integer maxVirtualTimeTaskStarvationCount, Boolean waitForNavigation, Double initialVirtualTime)	Turns on virtual time for all frames (replacing real-time with a synthetic time source) and sets the current virtual time policy.
void	setVisibleSize(Integer width, Integer height)	Resizes the frame/viewport of the page.

Method Detail

canEmulate

Boolean canEmulate()

Tells whether emulation is supported.

Returns:

True if emulation is supported.

clearDeviceMetricsOverride

void clearDeviceMetricsOverride()

Clears the overriden device metrics.

clearGeolocationOverride

void clearGeolocationOverride()

Clears the overriden Geolocation Position and Error.

resetPageScaleFactor

void resetPageScaleFactor()

Requests that page scale factor is reset to initial values.

setCPUThrottlingRate

void setCPUThrottlingRate(Double rate)

Enables CPU throttling to emulate slow CPUs.

Parameters:

rate - Throttling rate as a slowdown factor (1 is no throttle, 2 is 2x slowdown, etc).

setDefaultBackgroundColorOverride

void setDefaultBackgroundColorOverride(RGBA color)

Sets or clears an override of the default background color of the frame. This override is used if the content does not specify one.

Parameters:

color - RGBA of the default background color. If not specified, any existing override will be cleared.

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 - If set, the visible area of the page will be overridden to this viewport. This viewport change is not observed by the page, e.g. viewport-relative elements do not change positions.

setScrollbarsHidden

void setScrollbarsHidden(Boolean hidden)

setDocumentCookieDisabled

void setDocumentCookieDisabled(Boolean disabled)

setEmitTouchEventsForMouse

void setEmitTouchEventsForMouse(Boolean enabled,
                                Platform configuration)

setEmulatedMedia

void setEmulatedMedia(String media)

Emulates the given media for CSS media queries.

Parameters:

media - Media type to emulate. Empty string disables the override.

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

setNavigatorOverrides

void setNavigatorOverrides(String platform)

Overrides value returned by the javascript navigator object.

Parameters:

platform - The platform navigator.platform should return.

setPageScaleFactor

void setPageScaleFactor(Double pageScaleFactor)

Sets a specified page scale factor.

Parameters:

pageScaleFactor - Page scale factor.

setScriptExecutionDisabled

void setScriptExecutionDisabled(Boolean value)

Switches script execution in the page.

Parameters:

value - Whether script execution should be disabled in the page.

setTouchEmulationEnabled

void setTouchEmulationEnabled(Boolean enabled,
                              Integer maxTouchPoints)

Enables touch on platforms which do not support them.

Parameters:

enabled - Whether the touch event emulation should be enabled.

maxTouchPoints - Maximum touch points supported. Defaults to one.

setVirtualTimePolicy

Double setVirtualTimePolicy(VirtualTimePolicy policy,
                            Double budget,
                            Integer maxVirtualTimeTaskStarvationCount,
                            Boolean waitForNavigation,
                            Double initialVirtualTime)

Turns on virtual time for all frames (replacing real-time with a synthetic time source) and sets the current virtual time policy. Note this supersedes any previous time budget.

Parameters:

budget - If set, after this many virtual milliseconds have elapsed virtual time will be paused and a virtualTimeBudgetExpired event is sent.

maxVirtualTimeTaskStarvationCount - If set this specifies the maximum number of tasks that can be run before virtual is forced forwards to prevent deadlock.

waitForNavigation - If set the virtual time policy change should be deferred until any frame starts navigating. Note any previous deferred policy change is superseded.

initialVirtualTime - If set, base::Time::Now will be overriden to initially return this value.

Returns:

Absolute timestamp at which virtual time was first enabled (up time in milliseconds).

setVisibleSize

void setVisibleSize(Integer width,
                    Integer height)

Resizes the frame/viewport of the page. Note that this does not affect the frame's container (e.g. browser window). Can be used to produce screenshots of the specified size. Not supported on Android.

Parameters:

width - Frame width (DIP).

height - Frame height (DIP).

setUserAgentOverride

void setUserAgentOverride(String userAgent,
                          String acceptLanguage,
                          String platform)

Allows overriding user agent with the given string.

Parameters:

userAgent - User agent to use.

acceptLanguage - Browser langugage to emulate.

platform - The platform navigator.platform should return.

setDefaultBackgroundColorOverride

void setDefaultBackgroundColorOverride()

Sets or clears an override of the default background color of the frame. This override is used if the content does not specify one.

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.

setEmitTouchEventsForMouse

void setEmitTouchEventsForMouse(Boolean enabled)

setGeolocationOverride

void setGeolocationOverride()

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

setTouchEmulationEnabled

void setTouchEmulationEnabled(Boolean enabled)

Enables touch on platforms which do not support them.

Parameters:

enabled - Whether the touch event emulation should be enabled.

setVirtualTimePolicy

Double setVirtualTimePolicy(VirtualTimePolicy policy)

Turns on virtual time for all frames (replacing real-time with a synthetic time source) and sets the current virtual time policy. Note this supersedes any previous time budget.

Returns:

Absolute timestamp at which virtual time was first enabled (up time in milliseconds).

setUserAgentOverride

void setUserAgentOverride(String userAgent)

Allows overriding user agent with the given string.

Parameters:

userAgent - User agent to use.