Class: Selenium::DevTools::V149::Emulation

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

Constant Summary collapse

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

Instance Method Summary collapse

Constructor Details

#initialize(devtools) ⇒ Emulation

Returns a new instance of Emulation.



31
32
33
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 31

def initialize(devtools)
  @devtools = devtools
end

Instance Method Details

#add_screen(left:, top:, width:, height:, work_area_insets: nil, device_pixel_ratio: nil, rotation: nil, color_depth: nil, label: nil, is_internal: nil) ⇒ Object 



292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 292

def add_screen(left:, top:, width:, height:, work_area_insets: nil, device_pixel_ratio: nil, rotation: nil, color_depth: nil, label: nil, is_internal: nil)
  @devtools.send_cmd('Emulation.addScreen',
                     left: left,
                     top: top,
                     width: width,
                     height: height,
                     workAreaInsets: work_area_insets,
                     devicePixelRatio: device_pixel_ratio,
                     rotation: rotation,
                     colorDepth: color_depth,
                     label: label,
                     isInternal: is_internal)
end

#can_emulate ⇒ Object 



40
41
42
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 40

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

#clear_device_metrics_override ⇒ Object 



44
45
46
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 44

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

#clear_device_posture_override ⇒ Object 



106
107
108
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 106

def clear_device_posture_override
  @devtools.send_cmd('Emulation.clearDevicePostureOverride')
end

#clear_display_features_override ⇒ Object 



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

def clear_display_features_override
  @devtools.send_cmd('Emulation.clearDisplayFeaturesOverride')
end

#clear_geolocation_override ⇒ Object 



48
49
50
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 48

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

#clear_idle_override ⇒ Object 



206
207
208
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 206

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

#get_overridden_sensor_information(type:) ⇒ Object 



162
163
164
165
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 162

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

#get_screen_infos ⇒ Object 



288
289
290
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 288

def get_screen_infos
  @devtools.send_cmd('Emulation.getScreenInfos')
end

#on(event, &block) ⇒ Object 



35
36
37
38
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 35

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

#remove_screen(screen_id:) ⇒ Object 



321
322
323
324
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 321

def remove_screen(screen_id:)
  @devtools.send_cmd('Emulation.removeScreen',
                     screenId: screen_id)
end

#reset_page_scale_factor ⇒ Object 



52
53
54
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 52

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

#set_auto_dark_mode_override(enabled: nil) ⇒ Object 



61
62
63
64
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 61

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

#set_automation_override(enabled:) ⇒ Object 



278
279
280
281
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 278

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

#set_cpu_throttling_rate(rate:) ⇒ Object 



66
67
68
69
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 66

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

#set_data_saver_override(data_saver_enabled: nil) ⇒ Object 



260
261
262
263
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 260

def set_data_saver_override(data_saver_enabled: nil)
  @devtools.send_cmd('Emulation.setDataSaverOverride',
                     dataSaverEnabled: data_saver_enabled)
end

#set_default_background_color_override(color: nil) ⇒ Object 



71
72
73
74
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 71

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, scrollbar_type: nil, screen_orientation_lock_emulation: nil) ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 81

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, scrollbar_type: nil, screen_orientation_lock_emulation: 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,
                     scrollbarType: scrollbar_type,
                     screenOrientationLockEmulation: screen_orientation_lock_emulation)
end

#set_device_posture_override(posture:) ⇒ Object 



101
102
103
104
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 101

def set_device_posture_override(posture:)
  @devtools.send_cmd('Emulation.setDevicePostureOverride',
                     posture: posture)
end

#set_disabled_image_types(image_types:) ⇒ Object 



255
256
257
258
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 255

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

#set_display_features_override(features:) ⇒ Object 



110
111
112
113
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 110

def set_display_features_override(features:)
  @devtools.send_cmd('Emulation.setDisplayFeaturesOverride',
                     features: features)
end

#set_document_cookie_disabled(disabled:) ⇒ Object 



124
125
126
127
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 124

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

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



129
130
131
132
133
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 129

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 



135
136
137
138
139
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 135

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

#set_emulated_os_text_scale(scale: nil) ⇒ Object 



146
147
148
149
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 146

def set_emulated_os_text_scale(scale: nil)
  @devtools.send_cmd('Emulation.setEmulatedOSTextScale',
                     scale: scale)
end

#set_emulated_vision_deficiency(type:) ⇒ Object 



141
142
143
144
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 141

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

#set_focus_emulation_enabled(enabled:) ⇒ Object 



56
57
58
59
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 56

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

#set_geolocation_override(latitude: nil, longitude: nil, accuracy: nil, altitude: nil, altitude_accuracy: nil, heading: nil, speed: nil) ⇒ Object 



151
152
153
154
155
156
157
158
159
160
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 151

def set_geolocation_override(latitude: nil, longitude: nil, accuracy: nil, altitude: nil, altitude_accuracy: nil, heading: nil, speed: nil)
  @devtools.send_cmd('Emulation.setGeolocationOverride',
                     latitude: latitude,
                     longitude: longitude,
                     accuracy: accuracy,
                     altitude: altitude,
                     altitudeAccuracy: altitude_accuracy,
                     heading: heading,
                     speed: speed)
end

#set_hardware_concurrency_override(hardware_concurrency:) ⇒ Object 



265
266
267
268
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 265

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 



200
201
202
203
204
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 200

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 



239
240
241
242
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 239

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

#set_navigator_overrides(platform:) ⇒ Object 



210
211
212
213
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 210

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

#set_page_scale_factor(page_scale_factor:) ⇒ Object 



215
216
217
218
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 215

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

#set_pressure_data_override(source:, state:, own_contribution_estimate: nil) ⇒ Object 



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

def set_pressure_data_override(source:, state:, own_contribution_estimate: nil)
  @devtools.send_cmd('Emulation.setPressureDataOverride',
                     source: source,
                     state: state,
                     ownContributionEstimate: own_contribution_estimate)
end

#set_pressure_source_override_enabled(enabled:, source:, metadata: nil) ⇒ Object 



180
181
182
183
184
185
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 180

def set_pressure_source_override_enabled(enabled:, source:, metadata: nil)
  @devtools.send_cmd('Emulation.setPressureSourceOverrideEnabled',
                     enabled: enabled,
                     source: source,
                     metadata: metadata)
end

#set_pressure_state_override(source:, state:) ⇒ Object 



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

def set_pressure_state_override(source:, state:)
  @devtools.send_cmd('Emulation.setPressureStateOverride',
                     source: source,
                     state: state)
end

#set_primary_screen(screen_id:) ⇒ Object 



326
327
328
329
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 326

def set_primary_screen(screen_id:)
  @devtools.send_cmd('Emulation.setPrimaryScreen',
                     screenId: screen_id)
end

#set_safe_area_insets_override(insets:) ⇒ Object 



76
77
78
79
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 76

def set_safe_area_insets_override(insets:)
  @devtools.send_cmd('Emulation.setSafeAreaInsetsOverride',
                     insets: insets)
end

#set_script_execution_disabled(value:) ⇒ Object 



220
221
222
223
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 220

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

#set_scrollbars_hidden(hidden:) ⇒ Object 



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

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

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



167
168
169
170
171
172
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 167

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 



174
175
176
177
178
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 174

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

#set_small_viewport_height_difference_override(difference:) ⇒ Object 



283
284
285
286
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 283

def set_small_viewport_height_difference_override(difference:)
  @devtools.send_cmd('Emulation.setSmallViewportHeightDifferenceOverride',
                     difference: difference)
end

#set_timezone_override(timezone_id:) ⇒ Object 



244
245
246
247
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 244

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 



225
226
227
228
229
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 225

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 



270
271
272
273
274
275
276
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 270

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 



231
232
233
234
235
236
237
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 231

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 



249
250
251
252
253
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 249

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

#update_screen(screen_id:, left: nil, top: nil, width: nil, height: nil, work_area_insets: nil, device_pixel_ratio: nil, rotation: nil, color_depth: nil, label: nil, is_internal: nil) ⇒ Object 



306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/selenium/devtools/v149/emulation.rb', line 306

def update_screen(screen_id:, left: nil, top: nil, width: nil, height: nil, work_area_insets: nil, device_pixel_ratio: nil, rotation: nil, color_depth: nil, label: nil, is_internal: nil)
  @devtools.send_cmd('Emulation.updateScreen',
                     screenId: screen_id,
                     left: left,
                     top: top,
                     width: width,
                     height: height,
                     workAreaInsets: work_area_insets,
                     devicePixelRatio: device_pixel_ratio,
                     rotation: rotation,
                     colorDepth: color_depth,
                     label: label,
                     isInternal: is_internal)
end