Class: Selenium::DevTools::V123::Emulation

Inherits:
Object
  • Object
show all
Defined in:
lib/selenium/devtools/v123/emulation.rb

Constant Summary collapse

EVENTS = 
{
  virtual_time_budget_expired: 'virtualTimeBudgetExpired',
}.freeze

Instance Method Summary collapse

Constructor Details

#initialize(devtools) ⇒ Emulation

Returns a new instance of Emulation.



29
30
31
 
# File 'lib/selenium/devtools/v123/emulation.rb', line 29

def initialize(devtools)
  @devtools = devtools
end

Instance Method Details

#can_emulate ⇒ Object 



38
39
40
 
# File 'lib/selenium/devtools/v123/emulation.rb', line 38

def can_emulate
  @devtools.send_cmd('Emulation.canEmulate')
end

#clear_device_metrics_override ⇒ Object 



42
43
44
 
# File 'lib/selenium/devtools/v123/emulation.rb', line 42

def clear_device_metrics_override
  @devtools.send_cmd('Emulation.clearDeviceMetricsOverride')
end

#clear_geolocation_override ⇒ Object 



46
47
48
 
# File 'lib/selenium/devtools/v123/emulation.rb', line 46

def clear_geolocation_override
  @devtools.send_cmd('Emulation.clearGeolocationOverride')
end

#clear_idle_override ⇒ Object 



150
151
152
 
# File 'lib/selenium/devtools/v123/emulation.rb', line 150

def clear_idle_override
  @devtools.send_cmd('Emulation.clearIdleOverride')
end

#get_overridden_sensor_information(type:) ⇒ Object 



126
127
128
129
 
# File 'lib/selenium/devtools/v123/emulation.rb', line 126

def get_overridden_sensor_information(type:)
  @devtools.send_cmd('Emulation.getOverriddenSensorInformation',
                     type: type)
end

#on(event, &block) ⇒ Object 



33
34
35
36
 
# File 'lib/selenium/devtools/v123/emulation.rb', line 33

def on(event, &block)
  event = EVENTS[event] if event.is_a?(Symbol)
  @devtools.callbacks["Emulation.#{event}"] << block
end

#reset_page_scale_factor ⇒ Object 



50
51
52
 
# File 'lib/selenium/devtools/v123/emulation.rb', line 50

def reset_page_scale_factor
  @devtools.send_cmd('Emulation.resetPageScaleFactor')
end

#set_auto_dark_mode_override(enabled: nil) ⇒ Object 



59
60
61
62
 
# File 'lib/selenium/devtools/v123/emulation.rb', line 59

def set_auto_dark_mode_override(enabled: nil)
  @devtools.send_cmd('Emulation.setAutoDarkModeOverride',
                     enabled: enabled)
end

#set_automation_override(enabled:) ⇒ Object 



217
218
219
220
 
# File 'lib/selenium/devtools/v123/emulation.rb', line 217

def set_automation_override(enabled:)
  @devtools.send_cmd('Emulation.setAutomationOverride',
                     enabled: enabled)
end

#set_cpu_throttling_rate(rate:) ⇒ Object 



64
65
66
67
 
# File 'lib/selenium/devtools/v123/emulation.rb', line 64

def set_cpu_throttling_rate(rate:)
  @devtools.send_cmd('Emulation.setCPUThrottlingRate',
                     rate: rate)
end

#set_default_background_color_override(color: nil) ⇒ Object 



69
70
71
72
 
# File 'lib/selenium/devtools/v123/emulation.rb', line 69

def set_default_background_color_override(color: nil)
  @devtools.send_cmd('Emulation.setDefaultBackgroundColorOverride',
                     color: color)
end

#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, device_posture: nil) ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/selenium/devtools/v123/emulation.rb', line 74

def 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, device_posture: nil)
  @devtools.send_cmd('Emulation.setDeviceMetricsOverride',
                     width: width,
                     height: height,
                     deviceScaleFactor: device_scale_factor,
                     mobile: mobile,
                     scale: scale,
                     screenWidth: screen_width,
                     screenHeight: screen_height,
                     positionX: position_x,
                     positionY: position_y,
                     dontSetVisibleSize: dont_set_visible_size,
                     screenOrientation: screen_orientation,
                     viewport: viewport,
                     displayFeature: display_feature,
                     devicePosture: device_posture)
end

#set_disabled_image_types(image_types:) ⇒ Object 



199
200
201
202
 
# File 'lib/selenium/devtools/v123/emulation.rb', line 199

def set_disabled_image_types(image_types:)
  @devtools.send_cmd('Emulation.setDisabledImageTypes',
                     imageTypes: image_types)
end

#set_document_cookie_disabled(disabled:) ⇒ Object 



97
98
99
100
 
# File 'lib/selenium/devtools/v123/emulation.rb', line 97

def set_document_cookie_disabled(disabled:)
  @devtools.send_cmd('Emulation.setDocumentCookieDisabled',
                     disabled: disabled)
end

#set_emit_touch_events_for_mouse(enabled:, configuration: nil) ⇒ Object 



102
103
104
105
106
 
# File 'lib/selenium/devtools/v123/emulation.rb', line 102

def set_emit_touch_events_for_mouse(enabled:, configuration: nil)
  @devtools.send_cmd('Emulation.setEmitTouchEventsForMouse',
                     enabled: enabled,
                     configuration: configuration)
end

#set_emulated_media(media: nil, features: nil) ⇒ Object 



108
109
110
111
112
 
# File 'lib/selenium/devtools/v123/emulation.rb', line 108

def set_emulated_media(media: nil, features: nil)
  @devtools.send_cmd('Emulation.setEmulatedMedia',
                     media: media,
                     features: features)
end

#set_emulated_vision_deficiency(type:) ⇒ Object 



114
115
116
117
 
# File 'lib/selenium/devtools/v123/emulation.rb', line 114

def set_emulated_vision_deficiency(type:)
  @devtools.send_cmd('Emulation.setEmulatedVisionDeficiency',
                     type: type)
end

#set_focus_emulation_enabled(enabled:) ⇒ Object 



54
55
56
57
 
# File 'lib/selenium/devtools/v123/emulation.rb', line 54

def set_focus_emulation_enabled(enabled:)
  @devtools.send_cmd('Emulation.setFocusEmulationEnabled',
                     enabled: enabled)
end

#set_geolocation_override(latitude: nil, longitude: nil, accuracy: nil) ⇒ Object 



119
120
121
122
123
124
 
# File 'lib/selenium/devtools/v123/emulation.rb', line 119

def set_geolocation_override(latitude: nil, longitude: nil, accuracy: nil)
  @devtools.send_cmd('Emulation.setGeolocationOverride',
                     latitude: latitude,
                     longitude: longitude,
                     accuracy: accuracy)
end

#set_hardware_concurrency_override(hardware_concurrency:) ⇒ Object 



204
205
206
207
 
# File 'lib/selenium/devtools/v123/emulation.rb', line 204

def set_hardware_concurrency_override(hardware_concurrency:)
  @devtools.send_cmd('Emulation.setHardwareConcurrencyOverride',
                     hardwareConcurrency: hardware_concurrency)
end

#set_idle_override(is_user_active:, is_screen_unlocked:) ⇒ Object 



144
145
146
147
148
 
# File 'lib/selenium/devtools/v123/emulation.rb', line 144

def set_idle_override(is_user_active:, is_screen_unlocked:)
  @devtools.send_cmd('Emulation.setIdleOverride',
                     isUserActive: is_user_active,
                     isScreenUnlocked: is_screen_unlocked)
end

#set_locale_override(locale: nil) ⇒ Object 



183
184
185
186
 
# File 'lib/selenium/devtools/v123/emulation.rb', line 183

def set_locale_override(locale: nil)
  @devtools.send_cmd('Emulation.setLocaleOverride',
                     locale: locale)
end

#set_navigator_overrides(platform:) ⇒ Object 



154
155
156
157
 
# File 'lib/selenium/devtools/v123/emulation.rb', line 154

def set_navigator_overrides(platform:)
  @devtools.send_cmd('Emulation.setNavigatorOverrides',
                     platform: platform)
end

#set_page_scale_factor(page_scale_factor:) ⇒ Object 



159
160
161
162
 
# File 'lib/selenium/devtools/v123/emulation.rb', line 159

def set_page_scale_factor(page_scale_factor:)
  @devtools.send_cmd('Emulation.setPageScaleFactor',
                     pageScaleFactor: page_scale_factor)
end

#set_script_execution_disabled(value:) ⇒ Object 



164
165
166
167
 
# File 'lib/selenium/devtools/v123/emulation.rb', line 164

def set_script_execution_disabled(value:)
  @devtools.send_cmd('Emulation.setScriptExecutionDisabled',
                     value: value)
end

#set_scrollbars_hidden(hidden:) ⇒ Object 



92
93
94
95
 
# File 'lib/selenium/devtools/v123/emulation.rb', line 92

def set_scrollbars_hidden(hidden:)
  @devtools.send_cmd('Emulation.setScrollbarsHidden',
                     hidden: hidden)
end

#set_sensor_override_enabled(enabled:, type:, metadata: nil) ⇒ Object 



131
132
133
134
135
136
 
# File 'lib/selenium/devtools/v123/emulation.rb', line 131

def set_sensor_override_enabled(enabled:, type:, metadata: nil)
  @devtools.send_cmd('Emulation.setSensorOverrideEnabled',
                     enabled: enabled,
                     type: type,
                     metadata: metadata)
end

#set_sensor_override_readings(type:, reading:) ⇒ Object 



138
139
140
141
142
 
# File 'lib/selenium/devtools/v123/emulation.rb', line 138

def set_sensor_override_readings(type:, reading:)
  @devtools.send_cmd('Emulation.setSensorOverrideReadings',
                     type: type,
                     reading: reading)
end

#set_timezone_override(timezone_id:) ⇒ Object 



188
189
190
191
 
# File 'lib/selenium/devtools/v123/emulation.rb', line 188

def set_timezone_override(timezone_id:)
  @devtools.send_cmd('Emulation.setTimezoneOverride',
                     timezoneId: timezone_id)
end

#set_touch_emulation_enabled(enabled:, max_touch_points: nil) ⇒ Object 



169
170
171
172
173
 
# File 'lib/selenium/devtools/v123/emulation.rb', line 169

def set_touch_emulation_enabled(enabled:, max_touch_points: nil)
  @devtools.send_cmd('Emulation.setTouchEmulationEnabled',
                     enabled: enabled,
                     maxTouchPoints: max_touch_points)
end

#set_user_agent_override(user_agent:, accept_language: nil, platform: nil, user_agent_metadata: nil) ⇒ Object 



209
210
211
212
213
214
215
 
# File 'lib/selenium/devtools/v123/emulation.rb', line 209

def set_user_agent_override(user_agent:, accept_language: nil, platform: nil, user_agent_metadata: nil)
  @devtools.send_cmd('Emulation.setUserAgentOverride',
                     userAgent: user_agent,
                     acceptLanguage: accept_language,
                     platform: platform,
                     userAgentMetadata: user_agent_metadata)
end

#set_virtual_time_policy(policy:, budget: nil, max_virtual_time_task_starvation_count: nil, initial_virtual_time: nil) ⇒ Object 



175
176
177
178
179
180
181
 
# File 'lib/selenium/devtools/v123/emulation.rb', line 175

def set_virtual_time_policy(policy:, budget: nil, max_virtual_time_task_starvation_count: nil, initial_virtual_time: nil)
  @devtools.send_cmd('Emulation.setVirtualTimePolicy',
                     policy: policy,
                     budget: budget,
                     maxVirtualTimeTaskStarvationCount: max_virtual_time_task_starvation_count,
                     initialVirtualTime: initial_virtual_time)
end

#set_visible_size(width:, height:) ⇒ Object 



193
194
195
196
197
 
# File 'lib/selenium/devtools/v123/emulation.rb', line 193

def set_visible_size(width:, height:)
  @devtools.send_cmd('Emulation.setVisibleSize',
                     width: width,
                     height: height)
end