CDPotion.Domain.Emulation (cdpotion v0.1.0)

Summary

Functions

Tells whether emulation is supported.

Clears the overridden device metrics.

Clears the overridden Geolocation Position and Error.

Clears Idle state overrides.

Requests that page scale factor is reset to initial values.

Automatically render all web contents using a dark theme.

Allows overriding the automation flag.

Enables CPU throttling to emulate slow CPUs.

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

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:

  • imageTypes:array: Image types to disable.

Parameters:

  • disabled:boolean: Whether document.coookie API should be disabled.

Parameters:

  • enabled:boolean: Whether touch emulation based on mouse input should be enabled.
  • configuration:string: (Optional) Touch/gesture events configuration. Default: current platform.

Emulates the given media type or media feature for CSS media queries.

Emulates the given vision deficiency.

Enables or disables simulating a focused and active page.

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

Parameters:

  • hardwareConcurrency:integer: Hardware concurrency to report

Overrides default host system locale with the specified one.

Overrides value returned by the javascript navigator object.

Sets a specified page scale factor.

Switches script execution in the page.

Parameters:

  • hidden:boolean: Whether scrollbars should be always hidden.

Overrides default host system timezone with the specified one.

Enables touch on platforms which do not support them.

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.

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.

Functions

Tells whether emulation is supported.

Link to this function

clear_device_metrics_override()

Clears the overridden device metrics.

Link to this function

clear_geolocation_override()

Clears the overridden Geolocation Position and Error.

Link to this function

clear_idle_override()

Clears Idle state overrides.

Link to this function

reset_page_scale_factor()

Requests that page scale factor is reset to initial values.

Link to this function

set_auto_dark_mode_override(enabled \\ nil)

Automatically render all web contents using a dark theme.

Parameters:

  • enabled:boolean: (Optional) Whether to enable or disable automatic dark mode. If not specified, any existing override will be cleared.
Link to this function

set_automation_override(enabled)

Allows overriding the automation flag.

Parameters:

  • enabled:boolean: Whether the override should be enabled.
Link to this function

set_cpu_throttling_rate(rate)

Enables CPU throttling to emulate slow CPUs.

Parameters:

  • rate:number: Throttling rate as a slowdown factor (1 is no throttle, 2 is 2x slowdown, etc).
Link to this function

set_default_background_color_override(color \\ nil)

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:DOM.RGBA: (Optional) RGBA of the default background color. If not specified, any existing override will be cleared.
Link to this function

set_device_metrics_override(width, height, device_scale_factor, mobile, scale \\ nil, screen_width \\ nil, screen_height \\ nil, position_x \\ nil, position_y \\ nil, dont_set_visible_size \\ nil, screen_orientation \\ nil, viewport \\ nil, display_feature \\ nil)

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:integer: Overriding width value in pixels (minimum 0, maximum 10000000). 0 disables the override.
  • height:integer: Overriding height value in pixels (minimum 0, maximum 10000000). 0 disables the override.
  • deviceScaleFactor:number: Overriding device scale factor value. 0 disables the override.
  • mobile:boolean: Whether to emulate mobile device. This includes viewport meta tag, overlay scrollbars, text autosizing and more.
  • scale:number: (Optional) Scale to apply to resulting view image.
  • screenWidth:integer: (Optional) Overriding screen width value in pixels (minimum 0, maximum 10000000).
  • screenHeight:integer: (Optional) Overriding screen height value in pixels (minimum 0, maximum 10000000).
  • positionX:integer: (Optional) Overriding view X position on screen in pixels (minimum 0, maximum 10000000).
  • positionY:integer: (Optional) Overriding view Y position on screen in pixels (minimum 0, maximum 10000000).
  • dontSetVisibleSize:boolean: (Optional) Do not set visible view size, rely upon explicit setVisibleSize call.
  • screenOrientation:ScreenOrientation: (Optional) Screen orientation override.
  • viewport:Page.Viewport: (Optional) 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.
  • displayFeature:DisplayFeature: (Optional) If set, the display feature of a multi-segment screen. If not set, multi-segment support is turned-off.
Link to this function

set_disabled_image_types(image_types)

Parameters:

  • imageTypes:array: Image types to disable.
Link to this function

set_emit_touch_events_for_mouse(enabled, configuration \\ nil)

Parameters:

  • enabled:boolean: Whether touch emulation based on mouse input should be enabled.
  • configuration:string: (Optional) Touch/gesture events configuration. Default: current platform.
Link to this function

set_emulated_media(media \\ nil, features \\ nil)

Emulates the given media type or media feature for CSS media queries.

Parameters:

  • media:string: (Optional) Media type to emulate. Empty string disables the override.
  • features:array: (Optional) Media features to emulate.
Link to this function

set_emulated_vision_deficiency(type)

Emulates the given vision deficiency.

Parameters:

  • type:string: Vision deficiency to emulate. Order: best-effort emulations come first, followed by any physiologically accurate emulations for medically recognized color vision deficiencies.
Link to this function

set_focus_emulation_enabled(enabled)

Enables or disables simulating a focused and active page.

Parameters:

  • enabled:boolean: Whether to enable to disable focus emulation.
Link to this function

set_geolocation_override(latitude \\ nil, longitude \\ nil, accuracy \\ nil)

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

Parameters:

  • latitude:number: (Optional) Mock latitude
  • longitude:number: (Optional) Mock longitude
  • accuracy:number: (Optional) Mock accuracy
Link to this function

set_hardware_concurrency_override(hardware_concurrency)

Parameters:

  • hardwareConcurrency:integer: Hardware concurrency to report
Link to this function

set_idle_override(is_user_active, is_screen_unlocked)

Overrides the Idle state.

Parameters:

  • isUserActive:boolean: Mock isUserActive
  • isScreenUnlocked:boolean: Mock isScreenUnlocked
Link to this function

set_locale_override(locale \\ nil)

Overrides default host system locale with the specified one.

Parameters:

  • locale:string: (Optional) ICU style C locale (e.g. "en_US"). If not specified or empty, disables the override and restores default host system locale.
Link to this function

set_navigator_overrides(platform)

Overrides value returned by the javascript navigator object.

Parameters:

  • platform:string: The platform navigator.platform should return.
Link to this function

set_page_scale_factor(page_scale_factor)

Sets a specified page scale factor.

Parameters:

  • pageScaleFactor:number: Page scale factor.
Link to this function

set_script_execution_disabled(value)

Switches script execution in the page.

Parameters:

  • value:boolean: Whether script execution should be disabled in the page.
Link to this function

set_scrollbars_hidden(hidden)

Parameters:

  • hidden:boolean: Whether scrollbars should be always hidden.
Link to this function

set_timezone_override(timezone_id)

Overrides default host system timezone with the specified one.

Parameters:

  • timezoneId:string: The timezone identifier. If empty, disables the override and restores default host system timezone.
Link to this function

set_touch_emulation_enabled(enabled, max_touch_points \\ nil)

Enables touch on platforms which do not support them.

Parameters:

  • enabled:boolean: Whether the touch event emulation should be enabled.
  • maxTouchPoints:integer: (Optional) Maximum touch points supported. Defaults to one.
Link to this function

set_user_agent_override(user_agent, accept_language \\ nil, platform \\ nil, user_agent_metadata \\ nil)

Allows overriding user agent with the given string.

Parameters:

  • userAgent:string: User agent to use.
  • acceptLanguage:string: (Optional) Browser langugage to emulate.
  • platform:string: (Optional) The platform navigator.platform should return.
  • userAgentMetadata:UserAgentMetadata: (Optional) To be sent in Sec-CH-UA-* headers and returned in navigator.userAgentData
Link to this function

set_virtual_time_policy(policy, budget \\ nil, max_virtual_time_task_starvation_count \\ nil, initial_virtual_time \\ nil)

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:

  • policy:VirtualTimePolicy: description not provided :(
  • budget:number: (Optional) If set, after this many virtual milliseconds have elapsed virtual time will be paused and a virtualTimeBudgetExpired event is sent.
  • maxVirtualTimeTaskStarvationCount:integer: (Optional) If set this specifies the maximum number of tasks that can be run before virtual is forced forwards to prevent deadlock.
  • initialVirtualTime:Network.TimeSinceEpoch: (Optional) If set, base::Time::Now will be overridden to initially return this value.
Link to this function

set_visible_size(width, 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:integer: Frame width (DIP).
  • height:integer: Frame height (DIP).