Class: Selenium::DevTools::V138::Emulation

Inherits:
Object
  • Object
show all
Defined in:
lib/selenium/devtools/v138/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/v138/emulation.rb', line 29

def initialize(devtools)
  @devtools = devtools
end

Instance Method Details

#can_emulate ⇒ Object 



38
39
40
 
# File 'lib/selenium/devtools/v138/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/v138/emulation.rb', line 42

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

#clear_device_posture_override ⇒ Object 



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

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

#clear_display_features_override ⇒ Object 



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

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

#clear_geolocation_override ⇒ Object 



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

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

#clear_idle_override ⇒ Object 



197
198
199
 
# File 'lib/selenium/devtools/v138/emulation.rb', line 197

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

#get_overridden_sensor_information(type:) ⇒ Object 



153
154
155
156
 
# File 'lib/selenium/devtools/v138/emulation.rb', line 153

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/v138/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/v138/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/v138/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 



264
265
266
267
 
# File 'lib/selenium/devtools/v138/emulation.rb', line 264

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/v138/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/v138/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 



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/selenium/devtools/v138/emulation.rb', line 79

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_device_posture_override(posture:) ⇒ Object 



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

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

#set_disabled_image_types(image_types:) ⇒ Object 



246
247
248
249
 
# File 'lib/selenium/devtools/v138/emulation.rb', line 246

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

#set_display_features_override(features:) ⇒ Object 



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

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

#set_document_cookie_disabled(disabled:) ⇒ Object 



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

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

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



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

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 



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

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

#set_emulated_vision_deficiency(type:) ⇒ Object 



137
138
139
140
 
# File 'lib/selenium/devtools/v138/emulation.rb', line 137

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/v138/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, altitude: nil, altitude_accuracy: nil, heading: nil, speed: nil) ⇒ Object 



142
143
144
145
146
147
148
149
150
151
 
# File 'lib/selenium/devtools/v138/emulation.rb', line 142

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 



251
252
253
254
 
# File 'lib/selenium/devtools/v138/emulation.rb', line 251

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 



191
192
193
194
195
 
# File 'lib/selenium/devtools/v138/emulation.rb', line 191

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 



230
231
232
233
 
# File 'lib/selenium/devtools/v138/emulation.rb', line 230

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

#set_navigator_overrides(platform:) ⇒ Object 



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

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

#set_page_scale_factor(page_scale_factor:) ⇒ Object 



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

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 



184
185
186
187
188
189
 
# File 'lib/selenium/devtools/v138/emulation.rb', line 184

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 



171
172
173
174
175
176
 
# File 'lib/selenium/devtools/v138/emulation.rb', line 171

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 



178
179
180
181
182
 
# File 'lib/selenium/devtools/v138/emulation.rb', line 178

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

#set_safe_area_insets_override(insets:) ⇒ Object 



74
75
76
77
 
# File 'lib/selenium/devtools/v138/emulation.rb', line 74

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

#set_script_execution_disabled(value:) ⇒ Object 



211
212
213
214
 
# File 'lib/selenium/devtools/v138/emulation.rb', line 211

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

#set_scrollbars_hidden(hidden:) ⇒ Object 



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

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

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



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

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 



165
166
167
168
169
 
# File 'lib/selenium/devtools/v138/emulation.rb', line 165

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 



269
270
271
272
 
# File 'lib/selenium/devtools/v138/emulation.rb', line 269

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

#set_timezone_override(timezone_id:) ⇒ Object 



235
236
237
238
 
# File 'lib/selenium/devtools/v138/emulation.rb', line 235

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 



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

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 



256
257
258
259
260
261
262
 
# File 'lib/selenium/devtools/v138/emulation.rb', line 256

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 



222
223
224
225
226
227
228
 
# File 'lib/selenium/devtools/v138/emulation.rb', line 222

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 



240
241
242
243
244
 
# File 'lib/selenium/devtools/v138/emulation.rb', line 240

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