devtools-protocol 0.0.1498010 → 0.0.1501221

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (54) hide show
  1. package/json/browser_protocol.json +17905 -17687
  2. package/package.json +1 -1
  3. package/pdl/browser_protocol.pdl +47 -13824
  4. package/pdl/domains/Accessibility.pdl +290 -0
  5. package/pdl/domains/Animation.pdl +195 -0
  6. package/pdl/domains/Audits.pdl +755 -0
  7. package/pdl/domains/Autofill.pdl +106 -0
  8. package/pdl/domains/BackgroundService.pdl +77 -0
  9. package/pdl/domains/BluetoothEmulation.pdl +227 -0
  10. package/pdl/domains/Browser.pdl +345 -0
  11. package/pdl/domains/CSS.pdl +996 -0
  12. package/pdl/domains/CacheStorage.pdl +125 -0
  13. package/pdl/domains/Cast.pdl +62 -0
  14. package/pdl/domains/DOM.pdl +932 -0
  15. package/pdl/domains/DOMDebugger.pdl +128 -0
  16. package/pdl/domains/DOMSnapshot.pdl +319 -0
  17. package/pdl/domains/DOMStorage.pdl +72 -0
  18. package/pdl/domains/DeviceAccess.pdl +43 -0
  19. package/pdl/domains/DeviceOrientation.pdl +20 -0
  20. package/pdl/domains/Emulation.pdl +608 -0
  21. package/pdl/domains/EventBreakpoints.pdl +24 -0
  22. package/pdl/domains/Extensions.pdl +72 -0
  23. package/pdl/domains/FedCm.pdl +100 -0
  24. package/pdl/domains/Fetch.pdl +251 -0
  25. package/pdl/domains/FileSystem.pdl +41 -0
  26. package/pdl/domains/HeadlessExperimental.pdl +56 -0
  27. package/pdl/domains/IO.pdl +45 -0
  28. package/pdl/domains/IndexedDB.pdl +226 -0
  29. package/pdl/domains/Input.pdl +336 -0
  30. package/pdl/domains/Inspector.pdl +25 -0
  31. package/pdl/domains/LayerTree.pdl +178 -0
  32. package/pdl/domains/Log.pdl +93 -0
  33. package/pdl/domains/Media.pdl +106 -0
  34. package/pdl/domains/Memory.pdl +112 -0
  35. package/pdl/domains/Network.pdl +2039 -0
  36. package/pdl/domains/Overlay.pdl +498 -0
  37. package/pdl/domains/PWA.pdl +142 -0
  38. package/pdl/domains/Page.pdl +1767 -0
  39. package/pdl/domains/Performance.pdl +54 -0
  40. package/pdl/domains/PerformanceTimeline.pdl +71 -0
  41. package/pdl/domains/Preload.pdl +290 -0
  42. package/pdl/domains/Security.pdl +196 -0
  43. package/pdl/domains/ServiceWorker.pdl +121 -0
  44. package/pdl/domains/Storage.pdl +913 -0
  45. package/pdl/domains/SystemInfo.pdl +145 -0
  46. package/pdl/domains/Target.pdl +325 -0
  47. package/pdl/domains/Tethering.pdl +28 -0
  48. package/pdl/domains/Tracing.pdl +157 -0
  49. package/pdl/domains/WebAudio.pdl +205 -0
  50. package/pdl/domains/WebAuthn.pdl +230 -0
  51. package/types/protocol-mapping.d.ts +659 -635
  52. package/types/protocol-proxy-api.d.ts +543 -522
  53. package/types/protocol-tests-proxy-api.d.ts +628 -607
  54. package/types/protocol.d.ts +8064 -7914
@@ -0,0 +1,1767 @@
1
+ # Copyright 2017 The Chromium Authors
2
+ # Use of this source code is governed by a BSD-style license that can be
3
+ # found in the LICENSE file.
4
+ #
5
+ # Contributing to Chrome DevTools Protocol: https://goo.gle/devtools-contribution-guide-cdp
6
+
7
+ # Actions and events related to the inspected page belong to the page domain.
8
+ domain Page
9
+ depends on Debugger
10
+ depends on DOM
11
+ depends on IO
12
+ depends on Network
13
+ depends on Runtime
14
+
15
+ # Unique frame identifier.
16
+ type FrameId extends string
17
+
18
+ # Indicates whether a frame has been identified as an ad.
19
+ experimental type AdFrameType extends string
20
+ enum
21
+ none
22
+ # This frame is a subframe of an ad frame.
23
+ child
24
+ # This frame is the root of an ad frame.
25
+ root
26
+
27
+ experimental type AdFrameExplanation extends string
28
+ enum
29
+ ParentIsAd
30
+ CreatedByAdScript
31
+ MatchedBlockingRule
32
+
33
+ # Indicates whether a frame has been identified as an ad and why.
34
+ experimental type AdFrameStatus extends object
35
+ properties
36
+ AdFrameType adFrameType
37
+ optional array of AdFrameExplanation explanations
38
+
39
+ # Identifies the script which caused a script or frame to be labelled as an
40
+ # ad.
41
+ experimental type AdScriptId extends object
42
+ properties
43
+ # Script Id of the script which caused a script or frame to be labelled as
44
+ # an ad.
45
+ Runtime.ScriptId scriptId
46
+ # Id of scriptId's debugger.
47
+ Runtime.UniqueDebuggerId debuggerId
48
+
49
+ # Encapsulates the script ancestry and the root script filterlist rule that
50
+ # caused the frame to be labelled as an ad. Only created when `ancestryChain`
51
+ # is not empty.
52
+ experimental type AdScriptAncestry extends object
53
+ properties
54
+ # A chain of `AdScriptId`s representing the ancestry of an ad script that
55
+ # led to the creation of a frame. The chain is ordered from the script
56
+ # itself (lower level) up to its root ancestor that was flagged by
57
+ # filterlist.
58
+ array of AdScriptId ancestryChain
59
+ # The filterlist rule that caused the root (last) script in
60
+ # `ancestryChain` to be ad-tagged. Only populated if the rule is
61
+ # available.
62
+ optional string rootScriptFilterlistRule
63
+
64
+ # Indicates whether the frame is a secure context and why it is the case.
65
+ experimental type SecureContextType extends string
66
+ enum
67
+ # The origin is a secure context.
68
+ Secure
69
+ # The host is localhost and hence is considered secure.
70
+ SecureLocalhost
71
+ # The origin has an insecure scheme and is not localhost.
72
+ InsecureScheme
73
+ # One of the ancestor frames is not a secure context.
74
+ InsecureAncestor
75
+
76
+ # Indicates whether the frame is cross-origin isolated and why it is the case.
77
+ experimental type CrossOriginIsolatedContextType extends string
78
+ enum
79
+ # The origin is cross-origin isolated.
80
+ Isolated
81
+ # The origin is not cross-origin isolated.
82
+ NotIsolated
83
+ # The cross-origin isolation feature is disabled.
84
+ NotIsolatedFeatureDisabled
85
+
86
+ experimental type GatedAPIFeatures extends string
87
+ enum
88
+ SharedArrayBuffers
89
+ SharedArrayBuffersTransferAllowed
90
+ PerformanceMeasureMemory
91
+ PerformanceProfile
92
+
93
+ # All Permissions Policy features. This enum should match the one defined
94
+ # in services/network/public/cpp/permissions_policy/permissions_policy_features.json5.
95
+ # LINT.IfChange(PermissionsPolicyFeature)
96
+ experimental type PermissionsPolicyFeature extends string
97
+ enum
98
+ accelerometer
99
+ all-screens-capture
100
+ ambient-light-sensor
101
+ aria-notify
102
+ attribution-reporting
103
+ autoplay
104
+ bluetooth
105
+ browsing-topics
106
+ camera
107
+ captured-surface-control
108
+ ch-dpr
109
+ ch-device-memory
110
+ ch-downlink
111
+ ch-ect
112
+ ch-prefers-color-scheme
113
+ ch-prefers-reduced-motion
114
+ ch-prefers-reduced-transparency
115
+ ch-rtt
116
+ ch-save-data
117
+ ch-ua
118
+ ch-ua-arch
119
+ ch-ua-bitness
120
+ ch-ua-high-entropy-values
121
+ ch-ua-platform
122
+ ch-ua-model
123
+ ch-ua-mobile
124
+ ch-ua-form-factors
125
+ ch-ua-full-version
126
+ ch-ua-full-version-list
127
+ ch-ua-platform-version
128
+ ch-ua-wow64
129
+ ch-viewport-height
130
+ ch-viewport-width
131
+ ch-width
132
+ clipboard-read
133
+ clipboard-write
134
+ compute-pressure
135
+ controlled-frame
136
+ cross-origin-isolated
137
+ deferred-fetch
138
+ deferred-fetch-minimal
139
+ device-attributes
140
+ digital-credentials-create
141
+ digital-credentials-get
142
+ direct-sockets
143
+ direct-sockets-private
144
+ display-capture
145
+ document-domain
146
+ encrypted-media
147
+ execution-while-out-of-viewport
148
+ execution-while-not-rendered
149
+ fenced-unpartitioned-storage-read
150
+ focus-without-user-activation
151
+ fullscreen
152
+ frobulate
153
+ gamepad
154
+ geolocation
155
+ gyroscope
156
+ hid
157
+ identity-credentials-get
158
+ idle-detection
159
+ interest-cohort
160
+ join-ad-interest-group
161
+ keyboard-map
162
+ language-detector
163
+ language-model
164
+ local-fonts
165
+ local-network-access
166
+ magnetometer
167
+ media-playback-while-not-visible
168
+ microphone
169
+ midi
170
+ on-device-speech-recognition
171
+ otp-credentials
172
+ payment
173
+ picture-in-picture
174
+ popins
175
+ private-aggregation
176
+ private-state-token-issuance
177
+ private-state-token-redemption
178
+ publickey-credentials-create
179
+ publickey-credentials-get
180
+ record-ad-auction-events
181
+ rewriter
182
+ run-ad-auction
183
+ screen-wake-lock
184
+ serial
185
+ shared-autofill
186
+ shared-storage
187
+ shared-storage-select-url
188
+ smart-card
189
+ speaker-selection
190
+ storage-access
191
+ sub-apps
192
+ summarizer
193
+ sync-xhr
194
+ translator
195
+ unload
196
+ usb
197
+ usb-unrestricted
198
+ vertical-scroll
199
+ web-app-installation
200
+ web-printing
201
+ web-share
202
+ window-management
203
+ writer
204
+ xr-spatial-tracking
205
+ # LINT.ThenChange(//services/network/public/cpp/permissions_policy/permissions_policy_features.json5:PermissionsPolicy)
206
+
207
+ # Reason for a permissions policy feature to be disabled.
208
+ experimental type PermissionsPolicyBlockReason extends string
209
+ enum
210
+ # Declaration in HTTP header.
211
+ Header
212
+ # Declaration in iframe attribute.
213
+ IframeAttribute
214
+ # Inside fenced frame.
215
+ InFencedFrameTree
216
+ # Inside an Isolated Application.
217
+ InIsolatedApp
218
+
219
+ experimental type PermissionsPolicyBlockLocator extends object
220
+ properties
221
+ FrameId frameId
222
+ PermissionsPolicyBlockReason blockReason
223
+
224
+ experimental type PermissionsPolicyFeatureState extends object
225
+ properties
226
+ PermissionsPolicyFeature feature
227
+ boolean allowed
228
+ optional PermissionsPolicyBlockLocator locator
229
+
230
+ # Origin Trial(https://www.chromium.org/blink/origin-trials) support.
231
+ # Status for an Origin Trial token.
232
+ experimental type OriginTrialTokenStatus extends string
233
+ enum
234
+ Success
235
+ NotSupported
236
+ Insecure
237
+ Expired
238
+ WrongOrigin
239
+ InvalidSignature
240
+ Malformed
241
+ WrongVersion
242
+ FeatureDisabled
243
+ TokenDisabled
244
+ FeatureDisabledForUser
245
+ UnknownTrial
246
+
247
+ # Status for an Origin Trial.
248
+ experimental type OriginTrialStatus extends string
249
+ enum
250
+ Enabled
251
+ ValidTokenNotProvided
252
+ OSNotSupported
253
+ TrialNotAllowed
254
+
255
+ experimental type OriginTrialUsageRestriction extends string
256
+ enum
257
+ None
258
+ Subset
259
+
260
+ experimental type OriginTrialToken extends object
261
+ properties
262
+ string origin
263
+ boolean matchSubDomains
264
+ string trialName
265
+ Network.TimeSinceEpoch expiryTime
266
+ boolean isThirdParty
267
+ OriginTrialUsageRestriction usageRestriction
268
+
269
+ experimental type OriginTrialTokenWithStatus extends object
270
+ properties
271
+ string rawTokenText
272
+ # `parsedToken` is present only when the token is extractable and
273
+ # parsable.
274
+ optional OriginTrialToken parsedToken
275
+ OriginTrialTokenStatus status
276
+
277
+ experimental type OriginTrial extends object
278
+ properties
279
+ string trialName
280
+ OriginTrialStatus status
281
+ array of OriginTrialTokenWithStatus tokensWithStatus
282
+
283
+ # Additional information about the frame document's security origin.
284
+ experimental type SecurityOriginDetails extends object
285
+ properties
286
+ # Indicates whether the frame document's security origin is one
287
+ # of the local hostnames (e.g. "localhost") or IP addresses (IPv4
288
+ # 127.0.0.0/8 or IPv6 ::1).
289
+ boolean isLocalhost
290
+
291
+ # Information about the Frame on the page.
292
+ type Frame extends object
293
+ properties
294
+ # Frame unique identifier.
295
+ FrameId id
296
+ # Parent frame identifier.
297
+ optional FrameId parentId
298
+ # Identifier of the loader associated with this frame.
299
+ Network.LoaderId loaderId
300
+ # Frame's name as specified in the tag.
301
+ optional string name
302
+ # Frame document's URL without fragment.
303
+ string url
304
+ # Frame document's URL fragment including the '#'.
305
+ experimental optional string urlFragment
306
+ # Frame document's registered domain, taking the public suffixes list into account.
307
+ # Extracted from the Frame's url.
308
+ # Example URLs: http://www.google.com/file.html -> "google.com"
309
+ # http://a.b.co.uk/file.html -> "b.co.uk"
310
+ experimental string domainAndRegistry
311
+ # Frame document's security origin.
312
+ string securityOrigin
313
+ # Additional details about the frame document's security origin.
314
+ experimental optional SecurityOriginDetails securityOriginDetails
315
+ # Frame document's mimeType as determined by the browser.
316
+ string mimeType
317
+ # If the frame failed to load, this contains the URL that could not be loaded. Note that unlike url above, this URL may contain a fragment.
318
+ experimental optional string unreachableUrl
319
+ # Indicates whether this frame was tagged as an ad and why.
320
+ experimental optional AdFrameStatus adFrameStatus
321
+ # Indicates whether the main document is a secure context and explains why that is the case.
322
+ experimental SecureContextType secureContextType
323
+ # Indicates whether this is a cross origin isolated context.
324
+ experimental CrossOriginIsolatedContextType crossOriginIsolatedContextType
325
+ # Indicated which gated APIs / features are available.
326
+ experimental array of GatedAPIFeatures gatedAPIFeatures
327
+
328
+ # Information about the Resource on the page.
329
+ experimental type FrameResource extends object
330
+ properties
331
+ # Resource URL.
332
+ string url
333
+ # Type of this resource.
334
+ Network.ResourceType type
335
+ # Resource mimeType as determined by the browser.
336
+ string mimeType
337
+ # last-modified timestamp as reported by server.
338
+ optional Network.TimeSinceEpoch lastModified
339
+ # Resource content size.
340
+ optional number contentSize
341
+ # True if the resource failed to load.
342
+ optional boolean failed
343
+ # True if the resource was canceled during loading.
344
+ optional boolean canceled
345
+
346
+ # Information about the Frame hierarchy along with their cached resources.
347
+ experimental type FrameResourceTree extends object
348
+ properties
349
+ # Frame information for this tree item.
350
+ Frame frame
351
+ # Child frames.
352
+ optional array of FrameResourceTree childFrames
353
+ # Information about frame resources.
354
+ array of FrameResource resources
355
+
356
+ # Information about the Frame hierarchy.
357
+ type FrameTree extends object
358
+ properties
359
+ # Frame information for this tree item.
360
+ Frame frame
361
+ # Child frames.
362
+ optional array of FrameTree childFrames
363
+
364
+ # Unique script identifier.
365
+ type ScriptIdentifier extends string
366
+
367
+ # Transition type.
368
+ type TransitionType extends string
369
+ enum
370
+ link
371
+ typed
372
+ address_bar
373
+ auto_bookmark
374
+ auto_subframe
375
+ manual_subframe
376
+ generated
377
+ auto_toplevel
378
+ form_submit
379
+ reload
380
+ keyword
381
+ keyword_generated
382
+ other
383
+
384
+ # Navigation history entry.
385
+ type NavigationEntry extends object
386
+ properties
387
+ # Unique id of the navigation history entry.
388
+ integer id
389
+ # URL of the navigation history entry.
390
+ string url
391
+ # URL that the user typed in the url bar.
392
+ string userTypedURL
393
+ # Title of the navigation history entry.
394
+ string title
395
+ # Transition type.
396
+ TransitionType transitionType
397
+
398
+ # Screencast frame metadata.
399
+ experimental type ScreencastFrameMetadata extends object
400
+ properties
401
+ # Top offset in DIP.
402
+ number offsetTop
403
+ # Page scale factor.
404
+ number pageScaleFactor
405
+ # Device screen width in DIP.
406
+ number deviceWidth
407
+ # Device screen height in DIP.
408
+ number deviceHeight
409
+ # Position of horizontal scroll in CSS pixels.
410
+ number scrollOffsetX
411
+ # Position of vertical scroll in CSS pixels.
412
+ number scrollOffsetY
413
+ # Frame swap timestamp.
414
+ optional Network.TimeSinceEpoch timestamp
415
+
416
+ # Javascript dialog type.
417
+ type DialogType extends string
418
+ enum
419
+ alert
420
+ confirm
421
+ prompt
422
+ beforeunload
423
+
424
+ # Error while paring app manifest.
425
+ type AppManifestError extends object
426
+ properties
427
+ # Error message.
428
+ string message
429
+ # If critical, this is a non-recoverable parse error.
430
+ integer critical
431
+ # Error line.
432
+ integer line
433
+ # Error column.
434
+ integer column
435
+
436
+ # Parsed app manifest properties.
437
+ experimental type AppManifestParsedProperties extends object
438
+ properties
439
+ # Computed scope value
440
+ string scope
441
+
442
+ # Layout viewport position and dimensions.
443
+ type LayoutViewport extends object
444
+ properties
445
+ # Horizontal offset relative to the document (CSS pixels).
446
+ integer pageX
447
+ # Vertical offset relative to the document (CSS pixels).
448
+ integer pageY
449
+ # Width (CSS pixels), excludes scrollbar if present.
450
+ integer clientWidth
451
+ # Height (CSS pixels), excludes scrollbar if present.
452
+ integer clientHeight
453
+
454
+ # Visual viewport position, dimensions, and scale.
455
+ type VisualViewport extends object
456
+ properties
457
+ # Horizontal offset relative to the layout viewport (CSS pixels).
458
+ number offsetX
459
+ # Vertical offset relative to the layout viewport (CSS pixels).
460
+ number offsetY
461
+ # Horizontal offset relative to the document (CSS pixels).
462
+ number pageX
463
+ # Vertical offset relative to the document (CSS pixels).
464
+ number pageY
465
+ # Width (CSS pixels), excludes scrollbar if present.
466
+ number clientWidth
467
+ # Height (CSS pixels), excludes scrollbar if present.
468
+ number clientHeight
469
+ # Scale relative to the ideal viewport (size at width=device-width).
470
+ number scale
471
+ # Page zoom factor (CSS to device independent pixels ratio).
472
+ optional number zoom
473
+
474
+ # Viewport for capturing screenshot.
475
+ type Viewport extends object
476
+ properties
477
+ # X offset in device independent pixels (dip).
478
+ number x
479
+ # Y offset in device independent pixels (dip).
480
+ number y
481
+ # Rectangle width in device independent pixels (dip).
482
+ number width
483
+ # Rectangle height in device independent pixels (dip).
484
+ number height
485
+ # Page scale factor.
486
+ number scale
487
+
488
+ # Generic font families collection.
489
+ experimental type FontFamilies extends object
490
+ properties
491
+ # The standard font-family.
492
+ optional string standard
493
+ # The fixed font-family.
494
+ optional string fixed
495
+ # The serif font-family.
496
+ optional string serif
497
+ # The sansSerif font-family.
498
+ optional string sansSerif
499
+ # The cursive font-family.
500
+ optional string cursive
501
+ # The fantasy font-family.
502
+ optional string fantasy
503
+ # The math font-family.
504
+ optional string math
505
+
506
+ # Font families collection for a script.
507
+ experimental type ScriptFontFamilies extends object
508
+ properties
509
+ # Name of the script which these font families are defined for.
510
+ string script
511
+ # Generic font families collection for the script.
512
+ FontFamilies fontFamilies
513
+
514
+ # Default font sizes.
515
+ experimental type FontSizes extends object
516
+ properties
517
+ # Default standard font size.
518
+ optional integer standard
519
+ # Default fixed font size.
520
+ optional integer fixed
521
+
522
+ experimental type ClientNavigationReason extends string
523
+ enum
524
+ anchorClick
525
+ formSubmissionGet
526
+ formSubmissionPost
527
+ httpHeaderRefresh
528
+ initialFrameNavigation
529
+ metaTagRefresh
530
+ other
531
+ pageBlockInterstitial
532
+ reload
533
+ scriptInitiated
534
+
535
+ experimental type ClientNavigationDisposition extends string
536
+ enum
537
+ currentTab
538
+ newTab
539
+ newWindow
540
+ download
541
+
542
+ experimental type InstallabilityErrorArgument extends object
543
+ properties
544
+ # Argument name (e.g. name:'minimum-icon-size-in-pixels').
545
+ string name
546
+ # Argument value (e.g. value:'64').
547
+ string value
548
+
549
+ # The installability error
550
+ experimental type InstallabilityError extends object
551
+ properties
552
+ # The error id (e.g. 'manifest-missing-suitable-icon').
553
+ string errorId
554
+ # The list of error arguments (e.g. {name:'minimum-icon-size-in-pixels', value:'64'}).
555
+ array of InstallabilityErrorArgument errorArguments
556
+
557
+ # The referring-policy used for the navigation.
558
+ experimental type ReferrerPolicy extends string
559
+ enum
560
+ noReferrer
561
+ noReferrerWhenDowngrade
562
+ origin
563
+ originWhenCrossOrigin
564
+ sameOrigin
565
+ strictOrigin
566
+ strictOriginWhenCrossOrigin
567
+ unsafeUrl
568
+
569
+ # Per-script compilation cache parameters for `Page.produceCompilationCache`
570
+ experimental type CompilationCacheParams extends object
571
+ properties
572
+ # The URL of the script to produce a compilation cache entry for.
573
+ string url
574
+ # A hint to the backend whether eager compilation is recommended.
575
+ # (the actual compilation mode used is upon backend discretion).
576
+ optional boolean eager
577
+
578
+ # Deprecated, please use addScriptToEvaluateOnNewDocument instead.
579
+ experimental deprecated command addScriptToEvaluateOnLoad
580
+ parameters
581
+ string scriptSource
582
+ returns
583
+ # Identifier of the added script.
584
+ ScriptIdentifier identifier
585
+
586
+ # Evaluates given script in every frame upon creation (before loading frame's scripts).
587
+ command addScriptToEvaluateOnNewDocument
588
+ parameters
589
+ string source
590
+ # If specified, creates an isolated world with the given name and evaluates given script in it.
591
+ # This world name will be used as the ExecutionContextDescription::name when the corresponding
592
+ # event is emitted.
593
+ experimental optional string worldName
594
+ # Specifies whether command line API should be available to the script, defaults
595
+ # to false.
596
+ experimental optional boolean includeCommandLineAPI
597
+ # If true, runs the script immediately on existing execution contexts or worlds.
598
+ # Default: false.
599
+ experimental optional boolean runImmediately
600
+ returns
601
+ # Identifier of the added script.
602
+ ScriptIdentifier identifier
603
+
604
+ # Brings page to front (activates tab).
605
+ command bringToFront
606
+
607
+ # Capture page screenshot.
608
+ command captureScreenshot
609
+ parameters
610
+ # Image compression format (defaults to png).
611
+ optional enum format
612
+ jpeg
613
+ png
614
+ webp
615
+ # Compression quality from range [0..100] (jpeg only).
616
+ optional integer quality
617
+ # Capture the screenshot of a given region only.
618
+ optional Viewport clip
619
+ # Capture the screenshot from the surface, rather than the view. Defaults to true.
620
+ experimental optional boolean fromSurface
621
+ # Capture the screenshot beyond the viewport. Defaults to false.
622
+ experimental optional boolean captureBeyondViewport
623
+ # Optimize image encoding for speed, not for resulting size (defaults to false)
624
+ experimental optional boolean optimizeForSpeed
625
+ returns
626
+ # Base64-encoded image data.
627
+ binary data
628
+
629
+ # Returns a snapshot of the page as a string. For MHTML format, the serialization includes
630
+ # iframes, shadow DOM, external resources, and element-inline styles.
631
+ experimental command captureSnapshot
632
+ parameters
633
+ # Format (defaults to mhtml).
634
+ optional enum format
635
+ mhtml
636
+ returns
637
+ # Serialized page data.
638
+ string data
639
+
640
+ # Clears the overridden device metrics.
641
+ experimental deprecated command clearDeviceMetricsOverride
642
+ # Use 'Emulation.clearDeviceMetricsOverride' instead
643
+ redirect Emulation
644
+
645
+ # Clears the overridden Device Orientation.
646
+ experimental deprecated command clearDeviceOrientationOverride
647
+ # Use 'DeviceOrientation.clearDeviceOrientationOverride' instead
648
+ redirect DeviceOrientation
649
+
650
+ # Clears the overridden Geolocation Position and Error.
651
+ deprecated command clearGeolocationOverride
652
+ # Use 'Emulation.clearGeolocationOverride' instead
653
+ redirect Emulation
654
+
655
+ # Creates an isolated world for the given frame.
656
+ command createIsolatedWorld
657
+ parameters
658
+ # Id of the frame in which the isolated world should be created.
659
+ FrameId frameId
660
+ # An optional name which is reported in the Execution Context.
661
+ optional string worldName
662
+ # Whether or not universal access should be granted to the isolated world. This is a powerful
663
+ # option, use with caution.
664
+ optional boolean grantUniveralAccess
665
+ returns
666
+ # Execution context of the isolated world.
667
+ Runtime.ExecutionContextId executionContextId
668
+
669
+ # Deletes browser cookie with given name, domain and path.
670
+ experimental deprecated command deleteCookie
671
+ # Use 'Network.deleteCookie' instead
672
+ redirect Network
673
+ parameters
674
+ # Name of the cookie to remove.
675
+ string cookieName
676
+ # URL to match cooke domain and path.
677
+ string url
678
+
679
+ # Disables page domain notifications.
680
+ command disable
681
+
682
+ # Enables page domain notifications.
683
+ command enable
684
+ parameters
685
+ # If true, the `Page.fileChooserOpened` event will be emitted regardless of the state set by
686
+ # `Page.setInterceptFileChooserDialog` command (default: false).
687
+ experimental optional boolean enableFileChooserOpenedEvent
688
+
689
+ # The manifest of a webapp, see
690
+ # https://www.w3.org/TR/appmanifest/#dfn-manifest.
691
+ # Some fields do not appear in the standard since the API is designed to
692
+ # expose more browser internal states.
693
+
694
+ experimental type FileFilter extends object
695
+ properties
696
+ optional string name
697
+ optional array of string accepts
698
+
699
+ experimental type FileHandler extends object
700
+ properties
701
+ string action
702
+ string name
703
+ optional array of ImageResource icons
704
+ # Mimic a map, name is the key, accepts is the value.
705
+ optional array of FileFilter accepts
706
+ # Won't repeat the enums, using string for easy comparison. Same as the
707
+ # other enums below.
708
+ string launchType
709
+
710
+ # The image definition used in both icon and screenshot.
711
+ experimental type ImageResource extends object
712
+ properties
713
+ # The src field in the definition, but changing to url in favor of
714
+ # consistency.
715
+ string url
716
+ optional string sizes
717
+ optional string type
718
+
719
+ experimental type LaunchHandler extends object
720
+ properties
721
+ string clientMode
722
+
723
+ experimental type ProtocolHandler extends object
724
+ properties
725
+ string protocol
726
+ string url
727
+
728
+ experimental type RelatedApplication extends object
729
+ properties
730
+ optional string id
731
+ string url
732
+
733
+ experimental type ScopeExtension extends object
734
+ properties
735
+ # Instead of using tuple, this field always returns the serialized string
736
+ # for easy understanding and comparison.
737
+ string origin
738
+ boolean hasOriginWildcard
739
+
740
+ experimental type Screenshot extends object
741
+ properties
742
+ ImageResource image
743
+ string formFactor
744
+ optional string label
745
+
746
+ experimental type ShareTarget extends object
747
+ properties
748
+ string action
749
+ string method
750
+ string enctype
751
+ # Embed the ShareTargetParams
752
+ optional string title
753
+ optional string text
754
+ optional string url
755
+ optional array of FileFilter files
756
+
757
+ experimental type Shortcut extends object
758
+ properties
759
+ string name
760
+ string url
761
+
762
+ experimental type WebAppManifest extends object
763
+ properties
764
+ optional string backgroundColor
765
+ # The extra description provided by the manifest.
766
+ optional string description
767
+ optional string dir
768
+ optional string display
769
+ # The overrided display mode controlled by the user.
770
+ optional array of string displayOverrides
771
+ # The handlers to open files.
772
+ optional array of FileHandler fileHandlers
773
+ optional array of ImageResource icons
774
+ optional string id
775
+ optional string lang
776
+ # TODO(crbug.com/1231886): This field is non-standard and part of a Chrome
777
+ # experiment. See:
778
+ # https://github.com/WICG/web-app-launch/blob/main/launch_handler.md
779
+ optional LaunchHandler launchHandler
780
+ optional string name
781
+ optional string orientation
782
+ optional boolean preferRelatedApplications
783
+ # The handlers to open protocols.
784
+ optional array of ProtocolHandler protocolHandlers
785
+ optional array of RelatedApplication relatedApplications
786
+ optional string scope
787
+ # Non-standard, see
788
+ # https://github.com/WICG/manifest-incubations/blob/gh-pages/scope_extensions-explainer.md
789
+ optional array of ScopeExtension scopeExtensions
790
+ # The screenshots used by chromium.
791
+ optional array of Screenshot screenshots
792
+ optional ShareTarget shareTarget
793
+ optional string shortName
794
+ optional array of Shortcut shortcuts
795
+ optional string startUrl
796
+ optional string themeColor
797
+
798
+ # Gets the processed manifest for this current document.
799
+ # This API always waits for the manifest to be loaded.
800
+ # If manifestId is provided, and it does not match the manifest of the
801
+ # current document, this API errors out.
802
+ # If there is not a loaded page, this API errors out immediately.
803
+ command getAppManifest
804
+ parameters
805
+ optional string manifestId
806
+ returns
807
+ # Manifest location.
808
+ string url
809
+ array of AppManifestError errors
810
+ # Manifest content.
811
+ optional string data
812
+ # Parsed manifest properties. Deprecated, use manifest instead.
813
+ experimental deprecated optional AppManifestParsedProperties parsed
814
+ experimental WebAppManifest manifest
815
+
816
+ experimental command getInstallabilityErrors
817
+ returns
818
+ array of InstallabilityError installabilityErrors
819
+
820
+ # Deprecated because it's not guaranteed that the returned icon is in fact the one used for PWA installation.
821
+ experimental deprecated command getManifestIcons
822
+ returns
823
+ optional binary primaryIcon
824
+
825
+ # Returns the unique (PWA) app id.
826
+ # Only returns values if the feature flag 'WebAppEnableManifestId' is enabled
827
+ experimental command getAppId
828
+ returns
829
+ # App id, either from manifest's id attribute or computed from start_url
830
+ optional string appId
831
+ # Recommendation for manifest's id attribute to match current id computed from start_url
832
+ optional string recommendedId
833
+
834
+ experimental command getAdScriptAncestry
835
+ parameters
836
+ FrameId frameId
837
+ returns
838
+ # The ancestry chain of ad script identifiers leading to this frame's
839
+ # creation, along with the root script's filterlist rule. The ancestry
840
+ # chain is ordered from the most immediate script (in the frame creation
841
+ # stack) to more distant ancestors (that created the immediately preceding
842
+ # script). Only sent if frame is labelled as an ad and ids are available.
843
+ optional AdScriptAncestry adScriptAncestry
844
+
845
+ # Returns present frame tree structure.
846
+ command getFrameTree
847
+ returns
848
+ # Present frame tree structure.
849
+ FrameTree frameTree
850
+
851
+ # Returns metrics relating to the layouting of the page, such as viewport bounds/scale.
852
+ command getLayoutMetrics
853
+ returns
854
+ # Deprecated metrics relating to the layout viewport. Is in device pixels. Use `cssLayoutViewport` instead.
855
+ deprecated LayoutViewport layoutViewport
856
+ # Deprecated metrics relating to the visual viewport. Is in device pixels. Use `cssVisualViewport` instead.
857
+ deprecated VisualViewport visualViewport
858
+ # Deprecated size of scrollable area. Is in DP. Use `cssContentSize` instead.
859
+ deprecated DOM.Rect contentSize
860
+ # Metrics relating to the layout viewport in CSS pixels.
861
+ LayoutViewport cssLayoutViewport
862
+ # Metrics relating to the visual viewport in CSS pixels.
863
+ VisualViewport cssVisualViewport
864
+ # Size of scrollable area in CSS pixels.
865
+ DOM.Rect cssContentSize
866
+
867
+ # Returns navigation history for the current page.
868
+ command getNavigationHistory
869
+ returns
870
+ # Index of the current navigation history entry.
871
+ integer currentIndex
872
+ # Array of navigation history entries.
873
+ array of NavigationEntry entries
874
+
875
+ # Resets navigation history for the current page.
876
+ command resetNavigationHistory
877
+
878
+ # Returns content of the given resource.
879
+ experimental command getResourceContent
880
+ parameters
881
+ # Frame id to get resource for.
882
+ FrameId frameId
883
+ # URL of the resource to get content for.
884
+ string url
885
+ returns
886
+ # Resource content.
887
+ string content
888
+ # True, if content was served as base64.
889
+ boolean base64Encoded
890
+
891
+ # Returns present frame / resource tree structure.
892
+ experimental command getResourceTree
893
+ returns
894
+ # Present frame / resource tree structure.
895
+ FrameResourceTree frameTree
896
+
897
+ # Accepts or dismisses a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload).
898
+ command handleJavaScriptDialog
899
+ parameters
900
+ # Whether to accept or dismiss the dialog.
901
+ boolean accept
902
+ # The text to enter into the dialog prompt before accepting. Used only if this is a prompt
903
+ # dialog.
904
+ optional string promptText
905
+
906
+ # Navigates current page to the given URL.
907
+ command navigate
908
+ parameters
909
+ # URL to navigate the page to.
910
+ string url
911
+ # Referrer URL.
912
+ optional string referrer
913
+ # Intended transition type.
914
+ optional TransitionType transitionType
915
+ # Frame id to navigate, if not specified navigates the top frame.
916
+ optional FrameId frameId
917
+ # Referrer-policy used for the navigation.
918
+ experimental optional ReferrerPolicy referrerPolicy
919
+ returns
920
+ # Frame id that has navigated (or failed to navigate)
921
+ FrameId frameId
922
+ # Loader identifier. This is omitted in case of same-document navigation,
923
+ # as the previously committed loaderId would not change.
924
+ optional Network.LoaderId loaderId
925
+ # User friendly error message, present if and only if navigation has failed.
926
+ optional string errorText
927
+ # Whether the navigation resulted in a download.
928
+ experimental optional boolean isDownload
929
+
930
+ # Navigates current page to the given history entry.
931
+ command navigateToHistoryEntry
932
+ parameters
933
+ # Unique id of the entry to navigate to.
934
+ integer entryId
935
+
936
+ # Print page as PDF.
937
+ command printToPDF
938
+ parameters
939
+ # Paper orientation. Defaults to false.
940
+ optional boolean landscape
941
+ # Display header and footer. Defaults to false.
942
+ optional boolean displayHeaderFooter
943
+ # Print background graphics. Defaults to false.
944
+ optional boolean printBackground
945
+ # Scale of the webpage rendering. Defaults to 1.
946
+ optional number scale
947
+ # Paper width in inches. Defaults to 8.5 inches.
948
+ optional number paperWidth
949
+ # Paper height in inches. Defaults to 11 inches.
950
+ optional number paperHeight
951
+ # Top margin in inches. Defaults to 1cm (~0.4 inches).
952
+ optional number marginTop
953
+ # Bottom margin in inches. Defaults to 1cm (~0.4 inches).
954
+ optional number marginBottom
955
+ # Left margin in inches. Defaults to 1cm (~0.4 inches).
956
+ optional number marginLeft
957
+ # Right margin in inches. Defaults to 1cm (~0.4 inches).
958
+ optional number marginRight
959
+ # Paper ranges to print, one based, e.g., '1-5, 8, 11-13'. Pages are
960
+ # printed in the document order, not in the order specified, and no
961
+ # more than once.
962
+ # Defaults to empty string, which implies the entire document is printed.
963
+ # The page numbers are quietly capped to actual page count of the
964
+ # document, and ranges beyond the end of the document are ignored.
965
+ # If this results in no pages to print, an error is reported.
966
+ # It is an error to specify a range with start greater than end.
967
+ optional string pageRanges
968
+ # HTML template for the print header. Should be valid HTML markup with following
969
+ # classes used to inject printing values into them:
970
+ # - `date`: formatted print date
971
+ # - `title`: document title
972
+ # - `url`: document location
973
+ # - `pageNumber`: current page number
974
+ # - `totalPages`: total pages in the document
975
+ #
976
+ # For example, `<span class=title></span>` would generate span containing the title.
977
+ optional string headerTemplate
978
+ # HTML template for the print footer. Should use the same format as the `headerTemplate`.
979
+ optional string footerTemplate
980
+ # Whether or not to prefer page size as defined by css. Defaults to false,
981
+ # in which case the content will be scaled to fit the paper size.
982
+ optional boolean preferCSSPageSize
983
+ # return as stream
984
+ experimental optional enum transferMode
985
+ ReturnAsBase64
986
+ ReturnAsStream
987
+ # Whether or not to generate tagged (accessible) PDF. Defaults to embedder choice.
988
+ experimental optional boolean generateTaggedPDF
989
+ # Whether or not to embed the document outline into the PDF.
990
+ experimental optional boolean generateDocumentOutline
991
+ returns
992
+ # Base64-encoded pdf data. Empty if |returnAsStream| is specified.
993
+ binary data
994
+ # A handle of the stream that holds resulting PDF data.
995
+ experimental optional IO.StreamHandle stream
996
+
997
+ # Reloads given page optionally ignoring the cache.
998
+ command reload
999
+ parameters
1000
+ # If true, browser cache is ignored (as if the user pressed Shift+refresh).
1001
+ optional boolean ignoreCache
1002
+ # If set, the script will be injected into all frames of the inspected page after reload.
1003
+ # Argument will be ignored if reloading dataURL origin.
1004
+ optional string scriptToEvaluateOnLoad
1005
+ # If set, an error will be thrown if the target page's main frame's
1006
+ # loader id does not match the provided id. This prevents accidentally
1007
+ # reloading an unintended target in case there's a racing navigation.
1008
+ experimental optional Network.LoaderId loaderId
1009
+
1010
+ # Deprecated, please use removeScriptToEvaluateOnNewDocument instead.
1011
+ experimental deprecated command removeScriptToEvaluateOnLoad
1012
+ parameters
1013
+ ScriptIdentifier identifier
1014
+
1015
+ # Removes given script from the list.
1016
+ command removeScriptToEvaluateOnNewDocument
1017
+ parameters
1018
+ ScriptIdentifier identifier
1019
+
1020
+ # Acknowledges that a screencast frame has been received by the frontend.
1021
+ experimental command screencastFrameAck
1022
+ parameters
1023
+ # Frame number.
1024
+ integer sessionId
1025
+
1026
+ # Searches for given string in resource content.
1027
+ experimental command searchInResource
1028
+ parameters
1029
+ # Frame id for resource to search in.
1030
+ FrameId frameId
1031
+ # URL of the resource to search in.
1032
+ string url
1033
+ # String to search for.
1034
+ string query
1035
+ # If true, search is case sensitive.
1036
+ optional boolean caseSensitive
1037
+ # If true, treats string parameter as regex.
1038
+ optional boolean isRegex
1039
+ returns
1040
+ # List of search matches.
1041
+ array of Debugger.SearchMatch result
1042
+
1043
+ # Enable Chrome's experimental ad filter on all sites.
1044
+ experimental command setAdBlockingEnabled
1045
+ parameters
1046
+ # Whether to block ads.
1047
+ boolean enabled
1048
+
1049
+ # Enable page Content Security Policy by-passing.
1050
+ command setBypassCSP
1051
+ parameters
1052
+ # Whether to bypass page CSP.
1053
+ boolean enabled
1054
+
1055
+ # Get Permissions Policy state on given frame.
1056
+ experimental command getPermissionsPolicyState
1057
+ parameters
1058
+ FrameId frameId
1059
+ returns
1060
+ array of PermissionsPolicyFeatureState states
1061
+
1062
+ # Get Origin Trials on given frame.
1063
+ experimental command getOriginTrials
1064
+ parameters
1065
+ FrameId frameId
1066
+ returns
1067
+ array of OriginTrial originTrials
1068
+
1069
+ # Overrides the values of device screen dimensions (window.screen.width, window.screen.height,
1070
+ # window.innerWidth, window.innerHeight, and "device-width"/"device-height"-related CSS media
1071
+ # query results).
1072
+ experimental deprecated command setDeviceMetricsOverride
1073
+ # Use 'Emulation.setDeviceMetricsOverride' instead
1074
+ redirect Emulation
1075
+ parameters
1076
+ # Overriding width value in pixels (minimum 0, maximum 10000000). 0 disables the override.
1077
+ integer width
1078
+ # Overriding height value in pixels (minimum 0, maximum 10000000). 0 disables the override.
1079
+ integer height
1080
+ # Overriding device scale factor value. 0 disables the override.
1081
+ number deviceScaleFactor
1082
+ # Whether to emulate mobile device. This includes viewport meta tag, overlay scrollbars, text
1083
+ # autosizing and more.
1084
+ boolean mobile
1085
+ # Scale to apply to resulting view image.
1086
+ optional number scale
1087
+ # Overriding screen width value in pixels (minimum 0, maximum 10000000).
1088
+ optional integer screenWidth
1089
+ # Overriding screen height value in pixels (minimum 0, maximum 10000000).
1090
+ optional integer screenHeight
1091
+ # Overriding view X position on screen in pixels (minimum 0, maximum 10000000).
1092
+ optional integer positionX
1093
+ # Overriding view Y position on screen in pixels (minimum 0, maximum 10000000).
1094
+ optional integer positionY
1095
+ # Do not set visible view size, rely upon explicit setVisibleSize call.
1096
+ optional boolean dontSetVisibleSize
1097
+ # Screen orientation override.
1098
+ optional Emulation.ScreenOrientation screenOrientation
1099
+ # The viewport dimensions and scale. If not set, the override is cleared.
1100
+ optional Viewport viewport
1101
+
1102
+ # Overrides the Device Orientation.
1103
+ experimental deprecated command setDeviceOrientationOverride
1104
+ # Use 'DeviceOrientation.setDeviceOrientationOverride' instead
1105
+ redirect DeviceOrientation
1106
+ parameters
1107
+ # Mock alpha
1108
+ number alpha
1109
+ # Mock beta
1110
+ number beta
1111
+ # Mock gamma
1112
+ number gamma
1113
+
1114
+ # Set generic font families.
1115
+ experimental command setFontFamilies
1116
+ parameters
1117
+ # Specifies font families to set. If a font family is not specified, it won't be changed.
1118
+ FontFamilies fontFamilies
1119
+ # Specifies font families to set for individual scripts.
1120
+ optional array of ScriptFontFamilies forScripts
1121
+
1122
+ # Set default font sizes.
1123
+ experimental command setFontSizes
1124
+ parameters
1125
+ # Specifies font sizes to set. If a font size is not specified, it won't be changed.
1126
+ FontSizes fontSizes
1127
+
1128
+ # Sets given markup as the document's HTML.
1129
+ command setDocumentContent
1130
+ parameters
1131
+ # Frame id to set HTML for.
1132
+ FrameId frameId
1133
+ # HTML content to set.
1134
+ string html
1135
+
1136
+ # Set the behavior when downloading a file.
1137
+ experimental deprecated command setDownloadBehavior
1138
+ parameters
1139
+ # Whether to allow all or deny all download requests, or use default Chrome behavior if
1140
+ # available (otherwise deny).
1141
+ enum behavior
1142
+ deny
1143
+ allow
1144
+ default
1145
+ # The default path to save downloaded files to. This is required if behavior is set to 'allow'
1146
+ optional string downloadPath
1147
+
1148
+ # Overrides the Geolocation Position or Error. Omitting any of the parameters emulates position
1149
+ # unavailable.
1150
+ deprecated command setGeolocationOverride
1151
+ # Use 'Emulation.setGeolocationOverride' instead
1152
+ redirect Emulation
1153
+ parameters
1154
+ # Mock latitude
1155
+ optional number latitude
1156
+ # Mock longitude
1157
+ optional number longitude
1158
+ # Mock accuracy
1159
+ optional number accuracy
1160
+
1161
+ # Controls whether page will emit lifecycle events.
1162
+ command setLifecycleEventsEnabled
1163
+ parameters
1164
+ # If true, starts emitting lifecycle events.
1165
+ boolean enabled
1166
+
1167
+ # Toggles mouse event-based touch event emulation.
1168
+ experimental deprecated command setTouchEmulationEnabled
1169
+ # Use 'Emulation.setTouchEmulationEnabled' instead
1170
+ redirect Emulation
1171
+ parameters
1172
+ # Whether the touch event emulation should be enabled.
1173
+ boolean enabled
1174
+ # Touch/gesture events configuration. Default: current platform.
1175
+ optional enum configuration
1176
+ mobile
1177
+ desktop
1178
+
1179
+ # Starts sending each frame using the `screencastFrame` event.
1180
+ experimental command startScreencast
1181
+ parameters
1182
+ # Image compression format.
1183
+ optional enum format
1184
+ jpeg
1185
+ png
1186
+ # Compression quality from range [0..100].
1187
+ optional integer quality
1188
+ # Maximum screenshot width.
1189
+ optional integer maxWidth
1190
+ # Maximum screenshot height.
1191
+ optional integer maxHeight
1192
+ # Send every n-th frame.
1193
+ optional integer everyNthFrame
1194
+
1195
+ # Force the page stop all navigations and pending resource fetches.
1196
+ command stopLoading
1197
+
1198
+ # Crashes renderer on the IO thread, generates minidumps.
1199
+ experimental command crash
1200
+
1201
+ # Tries to close page, running its beforeunload hooks, if any.
1202
+ command close
1203
+
1204
+ # Tries to update the web lifecycle state of the page.
1205
+ # It will transition the page to the given state according to:
1206
+ # https://github.com/WICG/web-lifecycle/
1207
+ experimental command setWebLifecycleState
1208
+ parameters
1209
+ # Target lifecycle state
1210
+ enum state
1211
+ frozen
1212
+ active
1213
+
1214
+ # Stops sending each frame in the `screencastFrame`.
1215
+ experimental command stopScreencast
1216
+
1217
+ # Requests backend to produce compilation cache for the specified scripts.
1218
+ # `scripts` are appended to the list of scripts for which the cache
1219
+ # would be produced. The list may be reset during page navigation.
1220
+ # When script with a matching URL is encountered, the cache is optionally
1221
+ # produced upon backend discretion, based on internal heuristics.
1222
+ # See also: `Page.compilationCacheProduced`.
1223
+ experimental command produceCompilationCache
1224
+ parameters
1225
+ array of CompilationCacheParams scripts
1226
+
1227
+ # Seeds compilation cache for given url. Compilation cache does not survive
1228
+ # cross-process navigation.
1229
+ experimental command addCompilationCache
1230
+ parameters
1231
+ string url
1232
+ # Base64-encoded data
1233
+ binary data
1234
+
1235
+ # Clears seeded compilation cache.
1236
+ experimental command clearCompilationCache
1237
+
1238
+ # Sets the Secure Payment Confirmation transaction mode.
1239
+ # https://w3c.github.io/secure-payment-confirmation/#sctn-automation-set-spc-transaction-mode
1240
+ experimental command setSPCTransactionMode
1241
+ parameters
1242
+ enum mode
1243
+ none
1244
+ autoAccept
1245
+ autoChooseToAuthAnotherWay
1246
+ autoReject
1247
+ autoOptOut
1248
+
1249
+ # Extensions for Custom Handlers API:
1250
+ # https://html.spec.whatwg.org/multipage/system-state.html#rph-automation
1251
+ experimental command setRPHRegistrationMode
1252
+ parameters
1253
+ enum mode
1254
+ none
1255
+ autoAccept
1256
+ autoReject
1257
+
1258
+ # Generates a report for testing.
1259
+ experimental command generateTestReport
1260
+ parameters
1261
+ # Message to be displayed in the report.
1262
+ string message
1263
+ # Specifies the endpoint group to deliver the report to.
1264
+ optional string group
1265
+
1266
+ # Pauses page execution. Can be resumed using generic Runtime.runIfWaitingForDebugger.
1267
+ experimental command waitForDebugger
1268
+
1269
+ # Intercept file chooser requests and transfer control to protocol clients.
1270
+ # When file chooser interception is enabled, native file chooser dialog is not shown.
1271
+ # Instead, a protocol event `Page.fileChooserOpened` is emitted.
1272
+ command setInterceptFileChooserDialog
1273
+ parameters
1274
+ boolean enabled
1275
+ # If true, cancels the dialog by emitting relevant events (if any)
1276
+ # in addition to not showing it if the interception is enabled
1277
+ # (default: false).
1278
+ experimental optional boolean cancel
1279
+
1280
+ event domContentEventFired
1281
+ parameters
1282
+ Network.MonotonicTime timestamp
1283
+
1284
+ # Emitted only when `page.interceptFileChooser` is enabled.
1285
+ event fileChooserOpened
1286
+ parameters
1287
+ # Id of the frame containing input node.
1288
+ experimental FrameId frameId
1289
+ # Input mode.
1290
+ enum mode
1291
+ selectSingle
1292
+ selectMultiple
1293
+ # Input node id. Only present for file choosers opened via an `<input type="file">` element.
1294
+ experimental optional DOM.BackendNodeId backendNodeId
1295
+
1296
+ # Fired when frame has been attached to its parent.
1297
+ event frameAttached
1298
+ parameters
1299
+ # Id of the frame that has been attached.
1300
+ FrameId frameId
1301
+ # Parent frame identifier.
1302
+ FrameId parentFrameId
1303
+ # JavaScript stack trace of when frame was attached, only set if frame initiated from script.
1304
+ optional Runtime.StackTrace stack
1305
+
1306
+ # Fired when frame no longer has a scheduled navigation.
1307
+ deprecated event frameClearedScheduledNavigation
1308
+ parameters
1309
+ # Id of the frame that has cleared its scheduled navigation.
1310
+ FrameId frameId
1311
+
1312
+ # Fired when frame has been detached from its parent.
1313
+ event frameDetached
1314
+ parameters
1315
+ # Id of the frame that has been detached.
1316
+ FrameId frameId
1317
+ experimental enum reason
1318
+ # The frame is removed from the DOM.
1319
+ remove
1320
+ # The frame is being swapped out in favor of an out-of-process iframe.
1321
+ # A new frame target will be created (see Target.attachedToTarget).
1322
+ swap
1323
+
1324
+ # Fired before frame subtree is detached. Emitted before any frame of the
1325
+ # subtree is actually detached.
1326
+ experimental event frameSubtreeWillBeDetached
1327
+ parameters
1328
+ # Id of the frame that is the root of the subtree that will be detached.
1329
+ FrameId frameId
1330
+
1331
+ # The type of a frameNavigated event.
1332
+ experimental type NavigationType extends string
1333
+ enum
1334
+ Navigation
1335
+ BackForwardCacheRestore
1336
+
1337
+ # Fired once navigation of the frame has completed. Frame is now associated with the new loader.
1338
+ event frameNavigated
1339
+ parameters
1340
+ # Frame object.
1341
+ Frame frame
1342
+ experimental NavigationType type
1343
+
1344
+ # Fired when opening document to write to.
1345
+ experimental event documentOpened
1346
+ parameters
1347
+ # Frame object.
1348
+ Frame frame
1349
+
1350
+ experimental event frameResized
1351
+
1352
+ # Fired when a navigation starts. This event is fired for both
1353
+ # renderer-initiated and browser-initiated navigations. For renderer-initiated
1354
+ # navigations, the event is fired after `frameRequestedNavigation`.
1355
+ # Navigation may still be cancelled after the event is issued. Multiple events
1356
+ # can be fired for a single navigation, for example, when a same-document
1357
+ # navigation becomes a cross-document navigation (such as in the case of a
1358
+ # frameset).
1359
+ experimental event frameStartedNavigating
1360
+ parameters
1361
+ # ID of the frame that is being navigated.
1362
+ FrameId frameId
1363
+ # The URL the navigation started with. The final URL can be different.
1364
+ string url
1365
+ # Loader identifier. Even though it is present in case of same-document
1366
+ # navigation, the previously committed loaderId would not change unless
1367
+ # the navigation changes from a same-document to a cross-document
1368
+ # navigation.
1369
+ Network.LoaderId loaderId
1370
+ enum navigationType
1371
+ reload
1372
+ reloadBypassingCache
1373
+ restore
1374
+ restoreWithPost
1375
+ historySameDocument
1376
+ historyDifferentDocument
1377
+ sameDocument
1378
+ differentDocument
1379
+
1380
+ # Fired when a renderer-initiated navigation is requested.
1381
+ # Navigation may still be cancelled after the event is issued.
1382
+ experimental event frameRequestedNavigation
1383
+ parameters
1384
+ # Id of the frame that is being navigated.
1385
+ FrameId frameId
1386
+ # The reason for the navigation.
1387
+ ClientNavigationReason reason
1388
+ # The destination URL for the requested navigation.
1389
+ string url
1390
+ # The disposition for the navigation.
1391
+ ClientNavigationDisposition disposition
1392
+
1393
+ # Fired when frame schedules a potential navigation.
1394
+ deprecated event frameScheduledNavigation
1395
+ parameters
1396
+ # Id of the frame that has scheduled a navigation.
1397
+ FrameId frameId
1398
+ # Delay (in seconds) until the navigation is scheduled to begin. The navigation is not
1399
+ # guaranteed to start.
1400
+ number delay
1401
+ # The reason for the navigation.
1402
+ ClientNavigationReason reason
1403
+ # The destination URL for the scheduled navigation.
1404
+ string url
1405
+
1406
+ # Fired when frame has started loading.
1407
+ experimental event frameStartedLoading
1408
+ parameters
1409
+ # Id of the frame that has started loading.
1410
+ FrameId frameId
1411
+
1412
+ # Fired when frame has stopped loading.
1413
+ experimental event frameStoppedLoading
1414
+ parameters
1415
+ # Id of the frame that has stopped loading.
1416
+ FrameId frameId
1417
+
1418
+ # Fired when page is about to start a download.
1419
+ # Deprecated. Use Browser.downloadWillBegin instead.
1420
+ experimental deprecated event downloadWillBegin
1421
+ parameters
1422
+ # Id of the frame that caused download to begin.
1423
+ FrameId frameId
1424
+ # Global unique identifier of the download.
1425
+ string guid
1426
+ # URL of the resource being downloaded.
1427
+ string url
1428
+ # Suggested file name of the resource (the actual name of the file saved on disk may differ).
1429
+ string suggestedFilename
1430
+
1431
+ # Fired when download makes progress. Last call has |done| == true.
1432
+ # Deprecated. Use Browser.downloadProgress instead.
1433
+ experimental deprecated event downloadProgress
1434
+ parameters
1435
+ # Global unique identifier of the download.
1436
+ string guid
1437
+ # Total expected bytes to download.
1438
+ number totalBytes
1439
+ # Total bytes received.
1440
+ number receivedBytes
1441
+ # Download status.
1442
+ enum state
1443
+ inProgress
1444
+ completed
1445
+ canceled
1446
+
1447
+ # Fired when interstitial page was hidden
1448
+ event interstitialHidden
1449
+
1450
+ # Fired when interstitial page was shown
1451
+ event interstitialShown
1452
+
1453
+ # Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) has been
1454
+ # closed.
1455
+ event javascriptDialogClosed
1456
+ parameters
1457
+ # Frame id.
1458
+ experimental FrameId frameId
1459
+ # Whether dialog was confirmed.
1460
+ boolean result
1461
+ # User input in case of prompt.
1462
+ string userInput
1463
+
1464
+ # Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) is about to
1465
+ # open.
1466
+ event javascriptDialogOpening
1467
+ parameters
1468
+ # Frame url.
1469
+ string url
1470
+ # Frame id.
1471
+ experimental FrameId frameId
1472
+ # Message that will be displayed by the dialog.
1473
+ string message
1474
+ # Dialog type.
1475
+ DialogType type
1476
+ # True iff browser is capable showing or acting on the given dialog. When browser has no
1477
+ # dialog handler for given target, calling alert while Page domain is engaged will stall
1478
+ # the page execution. Execution can be resumed via calling Page.handleJavaScriptDialog.
1479
+ boolean hasBrowserHandler
1480
+ # Default dialog prompt.
1481
+ optional string defaultPrompt
1482
+
1483
+ # Fired for lifecycle events (navigation, load, paint, etc) in the current
1484
+ # target (including local frames).
1485
+ event lifecycleEvent
1486
+ parameters
1487
+ # Id of the frame.
1488
+ FrameId frameId
1489
+ # Loader identifier. Empty string if the request is fetched from worker.
1490
+ Network.LoaderId loaderId
1491
+ string name
1492
+ Network.MonotonicTime timestamp
1493
+
1494
+ # List of not restored reasons for back-forward cache.
1495
+ experimental type BackForwardCacheNotRestoredReason extends string
1496
+ enum
1497
+ NotPrimaryMainFrame
1498
+ BackForwardCacheDisabled
1499
+ RelatedActiveContentsExist
1500
+ HTTPStatusNotOK
1501
+ SchemeNotHTTPOrHTTPS
1502
+ Loading
1503
+ WasGrantedMediaAccess
1504
+ DisableForRenderFrameHostCalled
1505
+ DomainNotAllowed
1506
+ HTTPMethodNotGET
1507
+ SubframeIsNavigating
1508
+ Timeout
1509
+ CacheLimit
1510
+ JavaScriptExecution
1511
+ RendererProcessKilled
1512
+ RendererProcessCrashed
1513
+ SchedulerTrackedFeatureUsed
1514
+ ConflictingBrowsingInstance
1515
+ CacheFlushed
1516
+ ServiceWorkerVersionActivation
1517
+ SessionRestored
1518
+ ServiceWorkerPostMessage
1519
+ EnteredBackForwardCacheBeforeServiceWorkerHostAdded
1520
+ RenderFrameHostReused_SameSite
1521
+ RenderFrameHostReused_CrossSite
1522
+ ServiceWorkerClaim
1523
+ IgnoreEventAndEvict
1524
+ HaveInnerContents
1525
+ TimeoutPuttingInCache
1526
+ BackForwardCacheDisabledByLowMemory
1527
+ BackForwardCacheDisabledByCommandLine
1528
+ NetworkRequestDatapipeDrainedAsBytesConsumer
1529
+ NetworkRequestRedirected
1530
+ NetworkRequestTimeout
1531
+ NetworkExceedsBufferLimit
1532
+ NavigationCancelledWhileRestoring
1533
+ NotMostRecentNavigationEntry
1534
+ BackForwardCacheDisabledForPrerender
1535
+ UserAgentOverrideDiffers
1536
+ ForegroundCacheLimit
1537
+ BrowsingInstanceNotSwapped
1538
+ BackForwardCacheDisabledForDelegate
1539
+ UnloadHandlerExistsInMainFrame
1540
+ UnloadHandlerExistsInSubFrame
1541
+ ServiceWorkerUnregistration
1542
+ CacheControlNoStore
1543
+ CacheControlNoStoreCookieModified
1544
+ CacheControlNoStoreHTTPOnlyCookieModified
1545
+ NoResponseHead
1546
+ Unknown
1547
+ ActivationNavigationsDisallowedForBug1234857
1548
+ ErrorDocument
1549
+ FencedFramesEmbedder
1550
+ CookieDisabled
1551
+ HTTPAuthRequired
1552
+ CookieFlushed
1553
+ BroadcastChannelOnMessage
1554
+ WebViewSettingsChanged
1555
+ WebViewJavaScriptObjectChanged
1556
+ WebViewMessageListenerInjected
1557
+ WebViewSafeBrowsingAllowlistChanged
1558
+ WebViewDocumentStartJavascriptChanged
1559
+ #Blocklisted features
1560
+ WebSocket
1561
+ WebTransport
1562
+ WebRTC
1563
+ MainResourceHasCacheControlNoStore
1564
+ MainResourceHasCacheControlNoCache
1565
+ SubresourceHasCacheControlNoStore
1566
+ SubresourceHasCacheControlNoCache
1567
+ ContainsPlugins
1568
+ DocumentLoaded
1569
+ OutstandingNetworkRequestOthers
1570
+ RequestedMIDIPermission
1571
+ RequestedAudioCapturePermission
1572
+ RequestedVideoCapturePermission
1573
+ RequestedBackForwardCacheBlockedSensors
1574
+ RequestedBackgroundWorkPermission
1575
+ BroadcastChannel
1576
+ WebXR
1577
+ SharedWorker
1578
+ SharedWorkerMessage
1579
+ WebLocks
1580
+ WebHID
1581
+ WebShare
1582
+ RequestedStorageAccessGrant
1583
+ WebNfc
1584
+ OutstandingNetworkRequestFetch
1585
+ OutstandingNetworkRequestXHR
1586
+ AppBanner
1587
+ Printing
1588
+ WebDatabase
1589
+ PictureInPicture
1590
+ SpeechRecognizer
1591
+ IdleManager
1592
+ PaymentManager
1593
+ SpeechSynthesis
1594
+ KeyboardLock
1595
+ WebOTPService
1596
+ OutstandingNetworkRequestDirectSocket
1597
+ InjectedJavascript
1598
+ InjectedStyleSheet
1599
+ KeepaliveRequest
1600
+ IndexedDBEvent
1601
+ Dummy
1602
+ JsNetworkRequestReceivedCacheControlNoStoreResource
1603
+ WebRTCSticky
1604
+ WebTransportSticky
1605
+ WebSocketSticky
1606
+ SmartCard
1607
+ LiveMediaStreamTrack
1608
+ UnloadHandler
1609
+ ParserAborted
1610
+ # Disabled for RenderFrameHost reasons
1611
+ # See content/browser/renderer_host/back_forward_cache_disable.h for explanations.
1612
+ ContentSecurityHandler
1613
+ ContentWebAuthenticationAPI
1614
+ ContentFileChooser
1615
+ ContentSerial
1616
+ ContentFileSystemAccess
1617
+ ContentMediaDevicesDispatcherHost
1618
+ ContentWebBluetooth
1619
+ ContentWebUSB
1620
+ ContentMediaSessionService
1621
+ ContentScreenReader
1622
+ ContentDiscarded
1623
+
1624
+ # See components/back_forward_cache/back_forward_cache_disable.h for explanations.
1625
+ EmbedderPopupBlockerTabHelper
1626
+ EmbedderSafeBrowsingTriggeredPopupBlocker
1627
+ EmbedderSafeBrowsingThreatDetails
1628
+ EmbedderAppBannerManager
1629
+ EmbedderDomDistillerViewerSource
1630
+ EmbedderDomDistillerSelfDeletingRequestDelegate
1631
+ EmbedderOomInterventionTabHelper
1632
+ EmbedderOfflinePage
1633
+ EmbedderChromePasswordManagerClientBindCredentialManager
1634
+ EmbedderPermissionRequestManager
1635
+ EmbedderModalDialog
1636
+ EmbedderExtensions
1637
+ EmbedderExtensionMessaging
1638
+ EmbedderExtensionMessagingForOpenPort
1639
+ EmbedderExtensionSentMessageToCachedFrame
1640
+ RequestedByWebViewClient
1641
+ PostMessageByWebViewClient
1642
+ CacheControlNoStoreDeviceBoundSessionTerminated
1643
+ CacheLimitPrunedOnModerateMemoryPressure
1644
+ CacheLimitPrunedOnCriticalMemoryPressure
1645
+
1646
+ # Types of not restored reasons for back-forward cache.
1647
+ experimental type BackForwardCacheNotRestoredReasonType extends string
1648
+ enum
1649
+ SupportPending
1650
+ PageSupportNeeded
1651
+ Circumstantial
1652
+
1653
+ experimental type BackForwardCacheBlockingDetails extends object
1654
+ properties
1655
+ # Url of the file where blockage happened. Optional because of tests.
1656
+ optional string url
1657
+ # Function name where blockage happened. Optional because of anonymous functions and tests.
1658
+ optional string function
1659
+ # Line number in the script (0-based).
1660
+ integer lineNumber
1661
+ # Column number in the script (0-based).
1662
+ integer columnNumber
1663
+
1664
+ experimental type BackForwardCacheNotRestoredExplanation extends object
1665
+ properties
1666
+ # Type of the reason
1667
+ BackForwardCacheNotRestoredReasonType type
1668
+ # Not restored reason
1669
+ BackForwardCacheNotRestoredReason reason
1670
+ # Context associated with the reason. The meaning of this context is
1671
+ # dependent on the reason:
1672
+ # - EmbedderExtensionSentMessageToCachedFrame: the extension ID.
1673
+ #
1674
+ optional string context
1675
+ optional array of BackForwardCacheBlockingDetails details
1676
+
1677
+ experimental type BackForwardCacheNotRestoredExplanationTree extends object
1678
+ properties
1679
+ # URL of each frame
1680
+ string url
1681
+ # Not restored reasons of each frame
1682
+ array of BackForwardCacheNotRestoredExplanation explanations
1683
+ # Array of children frame
1684
+ array of BackForwardCacheNotRestoredExplanationTree children
1685
+
1686
+ # Fired for failed bfcache history navigations if BackForwardCache feature is enabled. Do
1687
+ # not assume any ordering with the Page.frameNavigated event. This event is fired only for
1688
+ # main-frame history navigation where the document changes (non-same-document navigations),
1689
+ # when bfcache navigation fails.
1690
+ experimental event backForwardCacheNotUsed
1691
+ parameters
1692
+ # The loader id for the associated navigation.
1693
+ Network.LoaderId loaderId
1694
+ # The frame id of the associated frame.
1695
+ FrameId frameId
1696
+ # Array of reasons why the page could not be cached. This must not be empty.
1697
+ array of BackForwardCacheNotRestoredExplanation notRestoredExplanations
1698
+ # Tree structure of reasons why the page could not be cached for each frame.
1699
+ optional BackForwardCacheNotRestoredExplanationTree notRestoredExplanationsTree
1700
+
1701
+ event loadEventFired
1702
+ parameters
1703
+ Network.MonotonicTime timestamp
1704
+
1705
+ # Fired when same-document navigation happens, e.g. due to history API usage or anchor navigation.
1706
+ experimental event navigatedWithinDocument
1707
+ parameters
1708
+ # Id of the frame.
1709
+ FrameId frameId
1710
+ # Frame's new url.
1711
+ string url
1712
+ # Navigation type
1713
+ enum navigationType
1714
+ # Navigation due to fragment navigation.
1715
+ fragment
1716
+ # Navigation due to history API usage.
1717
+ historyApi
1718
+ # Navigation due to other reasons.
1719
+ other
1720
+
1721
+
1722
+ # Compressed image data requested by the `startScreencast`.
1723
+ experimental event screencastFrame
1724
+ parameters
1725
+ # Base64-encoded compressed image.
1726
+ binary data
1727
+ # Screencast frame metadata.
1728
+ ScreencastFrameMetadata metadata
1729
+ # Frame number.
1730
+ integer sessionId
1731
+
1732
+ # Fired when the page with currently enabled screencast was shown or hidden `.
1733
+ experimental event screencastVisibilityChanged
1734
+ parameters
1735
+ # True if the page is visible.
1736
+ boolean visible
1737
+
1738
+ # Fired when a new window is going to be opened, via window.open(), link click, form submission,
1739
+ # etc.
1740
+ event windowOpen
1741
+ parameters
1742
+ # The URL for the new window.
1743
+ string url
1744
+ # Window name.
1745
+ string windowName
1746
+ # An array of enabled window features.
1747
+ array of string windowFeatures
1748
+ # Whether or not it was triggered by user gesture.
1749
+ boolean userGesture
1750
+
1751
+ # Issued for every compilation cache generated.
1752
+ experimental event compilationCacheProduced
1753
+ parameters
1754
+ string url
1755
+ # Base64-encoded data
1756
+ binary data
1757
+
1758
+ # Enable/disable prerendering manually.
1759
+ #
1760
+ # This command is a short-term solution for https://crbug.com/1440085.
1761
+ # See https://docs.google.com/document/d/12HVmFxYj5Jc-eJr5OmWsa2bqTJsbgGLKI6ZIyx0_wpA
1762
+ # for more details.
1763
+ #
1764
+ # TODO(https://crbug.com/1440085): Remove this once Puppeteer supports tab targets.
1765
+ experimental command setPrerenderingAllowed
1766
+ parameters
1767
+ boolean isAllowed