Class: Selenium::DevTools::V138::Page

Inherits:
Object
  • Object
show all
Defined in:
lib/selenium/devtools/v138/page.rb

Constant Summary collapse

EVENTS = 
{
  dom_content_event_fired: 'domContentEventFired',
  file_chooser_opened: 'fileChooserOpened',
  frame_attached: 'frameAttached',
  frame_cleared_scheduled_navigation: 'frameClearedScheduledNavigation',
  frame_detached: 'frameDetached',
  frame_subtree_will_be_detached: 'frameSubtreeWillBeDetached',
  frame_navigated: 'frameNavigated',
  document_opened: 'documentOpened',
  frame_resized: 'frameResized',
  frame_started_navigating: 'frameStartedNavigating',
  frame_requested_navigation: 'frameRequestedNavigation',
  frame_scheduled_navigation: 'frameScheduledNavigation',
  frame_started_loading: 'frameStartedLoading',
  frame_stopped_loading: 'frameStoppedLoading',
  download_will_begin: 'downloadWillBegin',
  download_progress: 'downloadProgress',
  interstitial_hidden: 'interstitialHidden',
  interstitial_shown: 'interstitialShown',
  javascript_dialog_closed: 'javascriptDialogClosed',
  javascript_dialog_opening: 'javascriptDialogOpening',
  lifecycle_event: 'lifecycleEvent',
  back_forward_cache_not_used: 'backForwardCacheNotUsed',
  load_event_fired: 'loadEventFired',
  navigated_within_document: 'navigatedWithinDocument',
  screencast_frame: 'screencastFrame',
  screencast_visibility_changed: 'screencastVisibilityChanged',
  window_open: 'windowOpen',
  compilation_cache_produced: 'compilationCacheProduced',
}.freeze

Instance Method Summary collapse

Constructor Details

#initialize(devtools) ⇒ Page

Returns a new instance of Page.



56
57
58
 
# File 'lib/selenium/devtools/v138/page.rb', line 56

def initialize(devtools)
  @devtools = devtools
end

Instance Method Details

#add_compilation_cache(url:, data:) ⇒ Object 



370
371
372
373
374
 
# File 'lib/selenium/devtools/v138/page.rb', line 370

def add_compilation_cache(url:, data:)
  @devtools.send_cmd('Page.addCompilationCache',
                     url: url,
                     data: data)
end

#add_script_to_evaluate_on_load(script_source:) ⇒ Object 



65
66
67
68
 
# File 'lib/selenium/devtools/v138/page.rb', line 65

def add_script_to_evaluate_on_load(script_source:)
  @devtools.send_cmd('Page.addScriptToEvaluateOnLoad',
                     scriptSource: script_source)
end

#add_script_to_evaluate_on_new_document(source:, world_name: nil, include_command_line_api: nil, run_immediately: nil) ⇒ Object 



70
71
72
73
74
75
76
 
# File 'lib/selenium/devtools/v138/page.rb', line 70

def add_script_to_evaluate_on_new_document(source:, world_name: nil, include_command_line_api: nil, run_immediately: nil)
  @devtools.send_cmd('Page.addScriptToEvaluateOnNewDocument',
                     source: source,
                     worldName: world_name,
                     includeCommandLineAPI: include_command_line_api,
                     runImmediately: run_immediately)
end

#bring_to_front ⇒ Object 



78
79
80
 
# File 'lib/selenium/devtools/v138/page.rb', line 78

def bring_to_front
  @devtools.send_cmd('Page.bringToFront')
end

#capture_screenshot(format: nil, quality: nil, clip: nil, from_surface: nil, capture_beyond_viewport: nil, optimize_for_speed: nil) ⇒ Object 



82
83
84
85
86
87
88
89
90
 
# File 'lib/selenium/devtools/v138/page.rb', line 82

def capture_screenshot(format: nil, quality: nil, clip: nil, from_surface: nil, capture_beyond_viewport: nil, optimize_for_speed: nil)
  @devtools.send_cmd('Page.captureScreenshot',
                     format: format,
                     quality: quality,
                     clip: clip,
                     fromSurface: from_surface,
                     captureBeyondViewport: capture_beyond_viewport,
                     optimizeForSpeed: optimize_for_speed)
end

#capture_snapshot(format: nil) ⇒ Object 



92
93
94
95
 
# File 'lib/selenium/devtools/v138/page.rb', line 92

def capture_snapshot(format: nil)
  @devtools.send_cmd('Page.captureSnapshot',
                     format: format)
end

#clear_compilation_cache ⇒ Object 



376
377
378
 
# File 'lib/selenium/devtools/v138/page.rb', line 376

def clear_compilation_cache
  @devtools.send_cmd('Page.clearCompilationCache')
end

#clear_device_metrics_override ⇒ Object 



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

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

#clear_device_orientation_override ⇒ Object 



101
102
103
 
# File 'lib/selenium/devtools/v138/page.rb', line 101

def clear_device_orientation_override
  @devtools.send_cmd('Page.clearDeviceOrientationOverride')
end

#clear_geolocation_override ⇒ Object 



105
106
107
 
# File 'lib/selenium/devtools/v138/page.rb', line 105

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

#close ⇒ Object 



352
353
354
 
# File 'lib/selenium/devtools/v138/page.rb', line 352

def close
  @devtools.send_cmd('Page.close')
end

#crash ⇒ Object 



348
349
350
 
# File 'lib/selenium/devtools/v138/page.rb', line 348

def crash
  @devtools.send_cmd('Page.crash')
end

#create_isolated_world(frame_id:, world_name: nil, grant_univeral_access: nil) ⇒ Object 



109
110
111
112
113
114
 
# File 'lib/selenium/devtools/v138/page.rb', line 109

def create_isolated_world(frame_id:, world_name: nil, grant_univeral_access: nil)
  @devtools.send_cmd('Page.createIsolatedWorld',
                     frameId: frame_id,
                     worldName: world_name,
                     grantUniveralAccess: grant_univeral_access)
end

#delete_cookie(cookie_name:, url:) ⇒ Object 



116
117
118
119
120
 
# File 'lib/selenium/devtools/v138/page.rb', line 116

def delete_cookie(cookie_name:, url:)
  @devtools.send_cmd('Page.deleteCookie',
                     cookieName: cookie_name,
                     url: url)
end

#disable ⇒ Object 



122
123
124
 
# File 'lib/selenium/devtools/v138/page.rb', line 122

def disable
  @devtools.send_cmd('Page.disable')
end

#enable(enable_file_chooser_opened_event: nil) ⇒ Object 



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

def enable(enable_file_chooser_opened_event: nil)
  @devtools.send_cmd('Page.enable',
                     enableFileChooserOpenedEvent: enable_file_chooser_opened_event)
end

#generate_test_report(message:, group: nil) ⇒ Object 



390
391
392
393
394
 
# File 'lib/selenium/devtools/v138/page.rb', line 390

def generate_test_report(message:, group: nil)
  @devtools.send_cmd('Page.generateTestReport',
                     message: message,
                     group: group)
end

#get_ad_script_ancestry_ids(frame_id:) ⇒ Object 



148
149
150
151
 
# File 'lib/selenium/devtools/v138/page.rb', line 148

def get_ad_script_ancestry_ids(frame_id:)
  @devtools.send_cmd('Page.getAdScriptAncestryIds',
                     frameId: frame_id)
end

#get_app_id ⇒ Object 



144
145
146
 
# File 'lib/selenium/devtools/v138/page.rb', line 144

def get_app_id
  @devtools.send_cmd('Page.getAppId')
end

#get_app_manifest(manifest_id: nil) ⇒ Object 



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

def get_app_manifest(manifest_id: nil)
  @devtools.send_cmd('Page.getAppManifest',
                     manifestId: manifest_id)
end

#get_frame_tree ⇒ Object 



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

def get_frame_tree
  @devtools.send_cmd('Page.getFrameTree')
end

#get_installability_errors ⇒ Object 



136
137
138
 
# File 'lib/selenium/devtools/v138/page.rb', line 136

def get_installability_errors
  @devtools.send_cmd('Page.getInstallabilityErrors')
end

#get_layout_metrics ⇒ Object 



157
158
159
 
# File 'lib/selenium/devtools/v138/page.rb', line 157

def get_layout_metrics
  @devtools.send_cmd('Page.getLayoutMetrics')
end

#get_manifest_icons ⇒ Object 



140
141
142
 
# File 'lib/selenium/devtools/v138/page.rb', line 140

def get_manifest_icons
  @devtools.send_cmd('Page.getManifestIcons')
end

#get_navigation_history ⇒ Object 



161
162
163
 
# File 'lib/selenium/devtools/v138/page.rb', line 161

def get_navigation_history
  @devtools.send_cmd('Page.getNavigationHistory')
end

#get_origin_trials(frame_id:) ⇒ Object 



266
267
268
269
 
# File 'lib/selenium/devtools/v138/page.rb', line 266

def get_origin_trials(frame_id:)
  @devtools.send_cmd('Page.getOriginTrials',
                     frameId: frame_id)
end

#get_permissions_policy_state(frame_id:) ⇒ Object 



261
262
263
264
 
# File 'lib/selenium/devtools/v138/page.rb', line 261

def get_permissions_policy_state(frame_id:)
  @devtools.send_cmd('Page.getPermissionsPolicyState',
                     frameId: frame_id)
end

#get_resource_content(frame_id:, url:) ⇒ Object 



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

def get_resource_content(frame_id:, url:)
  @devtools.send_cmd('Page.getResourceContent',
                     frameId: frame_id,
                     url: url)
end

#get_resource_tree ⇒ Object 



175
176
177
 
# File 'lib/selenium/devtools/v138/page.rb', line 175

def get_resource_tree
  @devtools.send_cmd('Page.getResourceTree')
end

#handle_javascript_dialog(accept:, prompt_text: nil) ⇒ Object 



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

def handle_javascript_dialog(accept:, prompt_text: nil)
  @devtools.send_cmd('Page.handleJavaScriptDialog',
                     accept: accept,
                     promptText: prompt_text)
end

#navigate(url:, referrer: nil, transition_type: nil, frame_id: nil, referrer_policy: nil) ⇒ Object 



185
186
187
188
189
190
191
192
 
# File 'lib/selenium/devtools/v138/page.rb', line 185

def navigate(url:, referrer: nil, transition_type: nil, frame_id: nil, referrer_policy: nil)
  @devtools.send_cmd('Page.navigate',
                     url: url,
                     referrer: referrer,
                     transitionType: transition_type,
                     frameId: frame_id,
                     referrerPolicy: referrer_policy)
end

#navigate_to_history_entry(entry_id:) ⇒ Object 



194
195
196
197
 
# File 'lib/selenium/devtools/v138/page.rb', line 194

def navigate_to_history_entry(entry_id:)
  @devtools.send_cmd('Page.navigateToHistoryEntry',
                     entryId: entry_id)
end

#on(event, &block) ⇒ Object 



60
61
62
63
 
# File 'lib/selenium/devtools/v138/page.rb', line 60

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

#print_to_pdf(landscape: nil, display_header_footer: nil, print_background: nil, scale: nil, paper_width: nil, paper_height: nil, margin_top: nil, margin_bottom: nil, margin_left: nil, margin_right: nil, page_ranges: nil, header_template: nil, footer_template: nil, prefer_css_page_size: nil, transfer_mode: nil, generate_tagged_pdf: nil, generate_document_outline: nil) ⇒ Object 



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/selenium/devtools/v138/page.rb', line 199

def print_to_pdf(landscape: nil, display_header_footer: nil, print_background: nil, scale: nil, paper_width: nil, paper_height: nil, margin_top: nil, margin_bottom: nil, margin_left: nil, margin_right: nil, page_ranges: nil, header_template: nil, footer_template: nil, prefer_css_page_size: nil, transfer_mode: nil, generate_tagged_pdf: nil, generate_document_outline: nil)
  @devtools.send_cmd('Page.printToPDF',
                     landscape: landscape,
                     displayHeaderFooter: display_header_footer,
                     printBackground: print_background,
                     scale: scale,
                     paperWidth: paper_width,
                     paperHeight: paper_height,
                     marginTop: margin_top,
                     marginBottom: margin_bottom,
                     marginLeft: margin_left,
                     marginRight: margin_right,
                     pageRanges: page_ranges,
                     headerTemplate: header_template,
                     footerTemplate: footer_template,
                     preferCSSPageSize: prefer_css_page_size,
                     transferMode: transfer_mode,
                     generateTaggedPDF: generate_tagged_pdf,
                     generateDocumentOutline: generate_document_outline)
end

#produce_compilation_cache(scripts:) ⇒ Object 



365
366
367
368
 
# File 'lib/selenium/devtools/v138/page.rb', line 365

def produce_compilation_cache(scripts:)
  @devtools.send_cmd('Page.produceCompilationCache',
                     scripts: scripts)
end

#reload(ignore_cache: nil, script_to_evaluate_on_load: nil, loader_id: nil) ⇒ Object 



220
221
222
223
224
225
 
# File 'lib/selenium/devtools/v138/page.rb', line 220

def reload(ignore_cache: nil, script_to_evaluate_on_load: nil, loader_id: nil)
  @devtools.send_cmd('Page.reload',
                     ignoreCache: ignore_cache,
                     scriptToEvaluateOnLoad: script_to_evaluate_on_load,
                     loaderId: loader_id)
end

#remove_script_to_evaluate_on_load(identifier:) ⇒ Object 



227
228
229
230
 
# File 'lib/selenium/devtools/v138/page.rb', line 227

def remove_script_to_evaluate_on_load(identifier:)
  @devtools.send_cmd('Page.removeScriptToEvaluateOnLoad',
                     identifier: identifier)
end

#remove_script_to_evaluate_on_new_document(identifier:) ⇒ Object 



232
233
234
235
 
# File 'lib/selenium/devtools/v138/page.rb', line 232

def remove_script_to_evaluate_on_new_document(identifier:)
  @devtools.send_cmd('Page.removeScriptToEvaluateOnNewDocument',
                     identifier: identifier)
end

#reset_navigation_history ⇒ Object 



165
166
167
 
# File 'lib/selenium/devtools/v138/page.rb', line 165

def reset_navigation_history
  @devtools.send_cmd('Page.resetNavigationHistory')
end

#screencast_frame_ack(session_id:) ⇒ Object 



237
238
239
240
 
# File 'lib/selenium/devtools/v138/page.rb', line 237

def screencast_frame_ack(session_id:)
  @devtools.send_cmd('Page.screencastFrameAck',
                     sessionId: session_id)
end

#search_in_resource(frame_id:, url:, query:, case_sensitive: nil, is_regex: nil) ⇒ Object 



242
243
244
245
246
247
248
249
 
# File 'lib/selenium/devtools/v138/page.rb', line 242

def search_in_resource(frame_id:, url:, query:, case_sensitive: nil, is_regex: nil)
  @devtools.send_cmd('Page.searchInResource',
                     frameId: frame_id,
                     url: url,
                     query: query,
                     caseSensitive: case_sensitive,
                     isRegex: is_regex)
end

#set_ad_blocking_enabled(enabled:) ⇒ Object 



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

def set_ad_blocking_enabled(enabled:)
  @devtools.send_cmd('Page.setAdBlockingEnabled',
                     enabled: enabled)
end

#set_bypass_csp(enabled:) ⇒ Object 



256
257
258
259
 
# File 'lib/selenium/devtools/v138/page.rb', line 256

def set_bypass_csp(enabled:)
  @devtools.send_cmd('Page.setBypassCSP',
                     enabled: enabled)
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) ⇒ Object 



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/selenium/devtools/v138/page.rb', line 271

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)
  @devtools.send_cmd('Page.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)
end

#set_device_orientation_override(alpha:, beta:, gamma:) ⇒ Object 



287
288
289
290
291
292
 
# File 'lib/selenium/devtools/v138/page.rb', line 287

def set_device_orientation_override(alpha:, beta:, gamma:)
  @devtools.send_cmd('Page.setDeviceOrientationOverride',
                     alpha: alpha,
                     beta: beta,
                     gamma: gamma)
end

#set_document_content(frame_id:, html:) ⇒ Object 



305
306
307
308
309
 
# File 'lib/selenium/devtools/v138/page.rb', line 305

def set_document_content(frame_id:, html:)
  @devtools.send_cmd('Page.setDocumentContent',
                     frameId: frame_id,
                     html: html)
end

#set_download_behavior(behavior:, download_path: nil) ⇒ Object 



311
312
313
314
315
 
# File 'lib/selenium/devtools/v138/page.rb', line 311

def set_download_behavior(behavior:, download_path: nil)
  @devtools.send_cmd('Page.setDownloadBehavior',
                     behavior: behavior,
                     downloadPath: download_path)
end

#set_font_families(font_families:, for_scripts: nil) ⇒ Object 



294
295
296
297
298
 
# File 'lib/selenium/devtools/v138/page.rb', line 294

def set_font_families(font_families:, for_scripts: nil)
  @devtools.send_cmd('Page.setFontFamilies',
                     fontFamilies: font_families,
                     forScripts: for_scripts)
end

#set_font_sizes(font_sizes:) ⇒ Object 



300
301
302
303
 
# File 'lib/selenium/devtools/v138/page.rb', line 300

def set_font_sizes(font_sizes:)
  @devtools.send_cmd('Page.setFontSizes',
                     fontSizes: font_sizes)
end

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



317
318
319
320
321
322
 
# File 'lib/selenium/devtools/v138/page.rb', line 317

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

#set_intercept_file_chooser_dialog(enabled:, cancel: nil) ⇒ Object 



400
401
402
403
404
 
# File 'lib/selenium/devtools/v138/page.rb', line 400

def set_intercept_file_chooser_dialog(enabled:, cancel: nil)
  @devtools.send_cmd('Page.setInterceptFileChooserDialog',
                     enabled: enabled,
                     cancel: cancel)
end

#set_lifecycle_events_enabled(enabled:) ⇒ Object 



324
325
326
327
 
# File 'lib/selenium/devtools/v138/page.rb', line 324

def set_lifecycle_events_enabled(enabled:)
  @devtools.send_cmd('Page.setLifecycleEventsEnabled',
                     enabled: enabled)
end

#set_prerendering_allowed(is_allowed:) ⇒ Object 



406
407
408
409
 
# File 'lib/selenium/devtools/v138/page.rb', line 406

def set_prerendering_allowed(is_allowed:)
  @devtools.send_cmd('Page.setPrerenderingAllowed',
                     isAllowed: is_allowed)
end

#set_rph_registration_mode(mode:) ⇒ Object 



385
386
387
388
 
# File 'lib/selenium/devtools/v138/page.rb', line 385

def set_rph_registration_mode(mode:)
  @devtools.send_cmd('Page.setRPHRegistrationMode',
                     mode: mode)
end

#set_spc_transaction_mode(mode:) ⇒ Object 



380
381
382
383
 
# File 'lib/selenium/devtools/v138/page.rb', line 380

def set_spc_transaction_mode(mode:)
  @devtools.send_cmd('Page.setSPCTransactionMode',
                     mode: mode)
end

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



329
330
331
332
333
 
# File 'lib/selenium/devtools/v138/page.rb', line 329

def set_touch_emulation_enabled(enabled:, configuration: nil)
  @devtools.send_cmd('Page.setTouchEmulationEnabled',
                     enabled: enabled,
                     configuration: configuration)
end

#set_web_lifecycle_state(state:) ⇒ Object 



356
357
358
359
 
# File 'lib/selenium/devtools/v138/page.rb', line 356

def set_web_lifecycle_state(state:)
  @devtools.send_cmd('Page.setWebLifecycleState',
                     state: state)
end

#start_screencast(format: nil, quality: nil, max_width: nil, max_height: nil, every_nth_frame: nil) ⇒ Object 



335
336
337
338
339
340
341
342
 
# File 'lib/selenium/devtools/v138/page.rb', line 335

def start_screencast(format: nil, quality: nil, max_width: nil, max_height: nil, every_nth_frame: nil)
  @devtools.send_cmd('Page.startScreencast',
                     format: format,
                     quality: quality,
                     maxWidth: max_width,
                     maxHeight: max_height,
                     everyNthFrame: every_nth_frame)
end

#stop_loading ⇒ Object 



344
345
346
 
# File 'lib/selenium/devtools/v138/page.rb', line 344

def stop_loading
  @devtools.send_cmd('Page.stopLoading')
end

#stop_screencast ⇒ Object 



361
362
363
 
# File 'lib/selenium/devtools/v138/page.rb', line 361

def stop_screencast
  @devtools.send_cmd('Page.stopScreencast')
end

#wait_for_debugger ⇒ Object 



396
397
398
 
# File 'lib/selenium/devtools/v138/page.rb', line 396

def wait_for_debugger
  @devtools.send_cmd('Page.waitForDebugger')
end