forked from ChromeDevTools/devtools-frontend
-
Notifications
You must be signed in to change notification settings - Fork 24
Expand file tree
/
Copy pathprotocol-proxy-api.d.ts
More file actions
4800 lines (3806 loc) · 181 KB
/
protocol-proxy-api.d.ts
File metadata and controls
4800 lines (3806 loc) · 181 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright (c) 2020 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
/**
* This file is auto-generated, do not edit manually. *
* Re-generate with: npm run generate-protocol-resources.
*/
import type * as Protocol from './protocol.js'
/**
* API generated from Protocol commands and events.
*/
declare namespace ProtocolProxyApi {
export type ProtocolDomainName = keyof ProtocolApi;
export interface ProtocolApi {
ReactNativeApplication: ReactNativeApplicationApi;
Accessibility: AccessibilityApi;
Animation: AnimationApi;
Audits: AuditsApi;
Extensions: ExtensionsApi;
Autofill: AutofillApi;
BackgroundService: BackgroundServiceApi;
Browser: BrowserApi;
CSS: CSSApi;
CacheStorage: CacheStorageApi;
Cast: CastApi;
DOM: DOMApi;
DOMDebugger: DOMDebuggerApi;
EventBreakpoints: EventBreakpointsApi;
DOMSnapshot: DOMSnapshotApi;
DOMStorage: DOMStorageApi;
DeviceOrientation: DeviceOrientationApi;
Emulation: EmulationApi;
HeadlessExperimental: HeadlessExperimentalApi;
IO: IOApi;
FileSystem: FileSystemApi;
IndexedDB: IndexedDBApi;
Input: InputApi;
Inspector: InspectorApi;
LayerTree: LayerTreeApi;
Log: LogApi;
Memory: MemoryApi;
Network: NetworkApi;
Overlay: OverlayApi;
Page: PageApi;
Performance: PerformanceApi;
PerformanceTimeline: PerformanceTimelineApi;
Security: SecurityApi;
ServiceWorker: ServiceWorkerApi;
Storage: StorageApi;
SystemInfo: SystemInfoApi;
Target: TargetApi;
Tethering: TetheringApi;
Tracing: TracingApi;
Fetch: FetchApi;
WebAudio: WebAudioApi;
WebAuthn: WebAuthnApi;
Media: MediaApi;
DeviceAccess: DeviceAccessApi;
Preload: PreloadApi;
FedCm: FedCmApi;
PWA: PWAApi;
BluetoothEmulation: BluetoothEmulationApi;
Debugger: DebuggerApi;
HeapProfiler: HeapProfilerApi;
Profiler: ProfilerApi;
Runtime: RuntimeApi;
Schema: SchemaApi;
}
export interface ProtocolDispatchers {
ReactNativeApplication: ReactNativeApplicationDispatcher;
Accessibility: AccessibilityDispatcher;
Animation: AnimationDispatcher;
Audits: AuditsDispatcher;
Extensions: ExtensionsDispatcher;
Autofill: AutofillDispatcher;
BackgroundService: BackgroundServiceDispatcher;
Browser: BrowserDispatcher;
CSS: CSSDispatcher;
CacheStorage: CacheStorageDispatcher;
Cast: CastDispatcher;
DOM: DOMDispatcher;
DOMDebugger: DOMDebuggerDispatcher;
EventBreakpoints: EventBreakpointsDispatcher;
DOMSnapshot: DOMSnapshotDispatcher;
DOMStorage: DOMStorageDispatcher;
DeviceOrientation: DeviceOrientationDispatcher;
Emulation: EmulationDispatcher;
HeadlessExperimental: HeadlessExperimentalDispatcher;
IO: IODispatcher;
FileSystem: FileSystemDispatcher;
IndexedDB: IndexedDBDispatcher;
Input: InputDispatcher;
Inspector: InspectorDispatcher;
LayerTree: LayerTreeDispatcher;
Log: LogDispatcher;
Memory: MemoryDispatcher;
Network: NetworkDispatcher;
Overlay: OverlayDispatcher;
Page: PageDispatcher;
Performance: PerformanceDispatcher;
PerformanceTimeline: PerformanceTimelineDispatcher;
Security: SecurityDispatcher;
ServiceWorker: ServiceWorkerDispatcher;
Storage: StorageDispatcher;
SystemInfo: SystemInfoDispatcher;
Target: TargetDispatcher;
Tethering: TetheringDispatcher;
Tracing: TracingDispatcher;
Fetch: FetchDispatcher;
WebAudio: WebAudioDispatcher;
WebAuthn: WebAuthnDispatcher;
Media: MediaDispatcher;
DeviceAccess: DeviceAccessDispatcher;
Preload: PreloadDispatcher;
FedCm: FedCmDispatcher;
PWA: PWADispatcher;
BluetoothEmulation: BluetoothEmulationDispatcher;
Debugger: DebuggerDispatcher;
HeapProfiler: HeapProfilerDispatcher;
Profiler: ProfilerDispatcher;
Runtime: RuntimeDispatcher;
Schema: SchemaDispatcher;
}
export interface ReactNativeApplicationApi {
/**
* Disables events from backend.
*/
invoke_disable(): Promise<Protocol.ProtocolResponseWithError>;
/**
* Enables events from backend.
*/
invoke_enable(): Promise<Protocol.ProtocolResponseWithError>;
}
export interface ReactNativeApplicationDispatcher {
/**
* Issued once after the domain is enabled. Contains metadata about the
* device, application, and debugger integration.
*/
metadataUpdated(params: Protocol.ReactNativeApplication.MetadataUpdatedEvent): void;
/**
* Fired when React Native requests Chrome DevTools to prepare for displaying the captured Trace.
*/
traceRequested(): void;
}
export interface AccessibilityApi {
/**
* Disables the accessibility domain.
*/
invoke_disable(): Promise<Protocol.ProtocolResponseWithError>;
/**
* Enables the accessibility domain which causes `AXNodeId`s to remain consistent between method calls.
* This turns on accessibility for the page, which can impact performance until accessibility is disabled.
*/
invoke_enable(): Promise<Protocol.ProtocolResponseWithError>;
/**
* Fetches the accessibility node and partial accessibility tree for this DOM node, if it exists.
*/
invoke_getPartialAXTree(params: Protocol.Accessibility.GetPartialAXTreeRequest): Promise<Protocol.Accessibility.GetPartialAXTreeResponse>;
/**
* Fetches the entire accessibility tree for the root Document
*/
invoke_getFullAXTree(params: Protocol.Accessibility.GetFullAXTreeRequest): Promise<Protocol.Accessibility.GetFullAXTreeResponse>;
/**
* Fetches the root node.
* Requires `enable()` to have been called previously.
*/
invoke_getRootAXNode(params: Protocol.Accessibility.GetRootAXNodeRequest): Promise<Protocol.Accessibility.GetRootAXNodeResponse>;
/**
* Fetches a node and all ancestors up to and including the root.
* Requires `enable()` to have been called previously.
*/
invoke_getAXNodeAndAncestors(params: Protocol.Accessibility.GetAXNodeAndAncestorsRequest): Promise<Protocol.Accessibility.GetAXNodeAndAncestorsResponse>;
/**
* Fetches a particular accessibility node by AXNodeId.
* Requires `enable()` to have been called previously.
*/
invoke_getChildAXNodes(params: Protocol.Accessibility.GetChildAXNodesRequest): Promise<Protocol.Accessibility.GetChildAXNodesResponse>;
/**
* Query a DOM node's accessibility subtree for accessible name and role.
* This command computes the name and role for all nodes in the subtree, including those that are
* ignored for accessibility, and returns those that match the specified name and role. If no DOM
* node is specified, or the DOM node does not exist, the command returns an error. If neither
* `accessibleName` or `role` is specified, it returns all the accessibility nodes in the subtree.
*/
invoke_queryAXTree(params: Protocol.Accessibility.QueryAXTreeRequest): Promise<Protocol.Accessibility.QueryAXTreeResponse>;
}
export interface AccessibilityDispatcher {
/**
* The loadComplete event mirrors the load complete event sent by the browser to assistive
* technology when the web page has finished loading.
*/
loadComplete(params: Protocol.Accessibility.LoadCompleteEvent): void;
/**
* The nodesUpdated event is sent every time a previously requested node has changed the in tree.
*/
nodesUpdated(params: Protocol.Accessibility.NodesUpdatedEvent): void;
}
export interface AnimationApi {
/**
* Disables animation domain notifications.
*/
invoke_disable(): Promise<Protocol.ProtocolResponseWithError>;
/**
* Enables animation domain notifications.
*/
invoke_enable(): Promise<Protocol.ProtocolResponseWithError>;
/**
* Returns the current time of the an animation.
*/
invoke_getCurrentTime(params: Protocol.Animation.GetCurrentTimeRequest): Promise<Protocol.Animation.GetCurrentTimeResponse>;
/**
* Gets the playback rate of the document timeline.
*/
invoke_getPlaybackRate(): Promise<Protocol.Animation.GetPlaybackRateResponse>;
/**
* Releases a set of animations to no longer be manipulated.
*/
invoke_releaseAnimations(params: Protocol.Animation.ReleaseAnimationsRequest): Promise<Protocol.ProtocolResponseWithError>;
/**
* Gets the remote object of the Animation.
*/
invoke_resolveAnimation(params: Protocol.Animation.ResolveAnimationRequest): Promise<Protocol.Animation.ResolveAnimationResponse>;
/**
* Seek a set of animations to a particular time within each animation.
*/
invoke_seekAnimations(params: Protocol.Animation.SeekAnimationsRequest): Promise<Protocol.ProtocolResponseWithError>;
/**
* Sets the paused state of a set of animations.
*/
invoke_setPaused(params: Protocol.Animation.SetPausedRequest): Promise<Protocol.ProtocolResponseWithError>;
/**
* Sets the playback rate of the document timeline.
*/
invoke_setPlaybackRate(params: Protocol.Animation.SetPlaybackRateRequest): Promise<Protocol.ProtocolResponseWithError>;
/**
* Sets the timing of an animation node.
*/
invoke_setTiming(params: Protocol.Animation.SetTimingRequest): Promise<Protocol.ProtocolResponseWithError>;
}
export interface AnimationDispatcher {
/**
* Event for when an animation has been cancelled.
*/
animationCanceled(params: Protocol.Animation.AnimationCanceledEvent): void;
/**
* Event for each animation that has been created.
*/
animationCreated(params: Protocol.Animation.AnimationCreatedEvent): void;
/**
* Event for animation that has been started.
*/
animationStarted(params: Protocol.Animation.AnimationStartedEvent): void;
/**
* Event for animation that has been updated.
*/
animationUpdated(params: Protocol.Animation.AnimationUpdatedEvent): void;
}
export interface AuditsApi {
/**
* Returns the response body and size if it were re-encoded with the specified settings. Only
* applies to images.
*/
invoke_getEncodedResponse(params: Protocol.Audits.GetEncodedResponseRequest): Promise<Protocol.Audits.GetEncodedResponseResponse>;
/**
* Disables issues domain, prevents further issues from being reported to the client.
*/
invoke_disable(): Promise<Protocol.ProtocolResponseWithError>;
/**
* Enables issues domain, sends the issues collected so far to the client by means of the
* `issueAdded` event.
*/
invoke_enable(): Promise<Protocol.ProtocolResponseWithError>;
/**
* Runs the contrast check for the target page. Found issues are reported
* using Audits.issueAdded event.
*/
invoke_checkContrast(params: Protocol.Audits.CheckContrastRequest): Promise<Protocol.ProtocolResponseWithError>;
/**
* Runs the form issues check for the target page. Found issues are reported
* using Audits.issueAdded event.
*/
invoke_checkFormsIssues(): Promise<Protocol.Audits.CheckFormsIssuesResponse>;
}
export interface AuditsDispatcher {
issueAdded(params: Protocol.Audits.IssueAddedEvent): void;
}
export interface ExtensionsApi {
/**
* Installs an unpacked extension from the filesystem similar to
* --load-extension CLI flags. Returns extension ID once the extension
* has been installed. Available if the client is connected using the
* --remote-debugging-pipe flag and the --enable-unsafe-extension-debugging
* flag is set.
*/
invoke_loadUnpacked(params: Protocol.Extensions.LoadUnpackedRequest): Promise<Protocol.Extensions.LoadUnpackedResponse>;
/**
* Uninstalls an unpacked extension (others not supported) from the profile.
* Available if the client is connected using the --remote-debugging-pipe flag
* and the --enable-unsafe-extension-debugging.
*/
invoke_uninstall(params: Protocol.Extensions.UninstallRequest): Promise<Protocol.ProtocolResponseWithError>;
/**
* Gets data from extension storage in the given `storageArea`. If `keys` is
* specified, these are used to filter the result.
*/
invoke_getStorageItems(params: Protocol.Extensions.GetStorageItemsRequest): Promise<Protocol.Extensions.GetStorageItemsResponse>;
/**
* Removes `keys` from extension storage in the given `storageArea`.
*/
invoke_removeStorageItems(params: Protocol.Extensions.RemoveStorageItemsRequest): Promise<Protocol.ProtocolResponseWithError>;
/**
* Clears extension storage in the given `storageArea`.
*/
invoke_clearStorageItems(params: Protocol.Extensions.ClearStorageItemsRequest): Promise<Protocol.ProtocolResponseWithError>;
/**
* Sets `values` in extension storage in the given `storageArea`. The provided `values`
* will be merged with existing values in the storage area.
*/
invoke_setStorageItems(params: Protocol.Extensions.SetStorageItemsRequest): Promise<Protocol.ProtocolResponseWithError>;
}
export interface ExtensionsDispatcher {
}
export interface AutofillApi {
/**
* Trigger autofill on a form identified by the fieldId.
* If the field and related form cannot be autofilled, returns an error.
*/
invoke_trigger(params: Protocol.Autofill.TriggerRequest): Promise<Protocol.ProtocolResponseWithError>;
/**
* Set addresses so that developers can verify their forms implementation.
*/
invoke_setAddresses(params: Protocol.Autofill.SetAddressesRequest): Promise<Protocol.ProtocolResponseWithError>;
/**
* Disables autofill domain notifications.
*/
invoke_disable(): Promise<Protocol.ProtocolResponseWithError>;
/**
* Enables autofill domain notifications.
*/
invoke_enable(): Promise<Protocol.ProtocolResponseWithError>;
}
export interface AutofillDispatcher {
/**
* Emitted when an address form is filled.
*/
addressFormFilled(params: Protocol.Autofill.AddressFormFilledEvent): void;
}
export interface BackgroundServiceApi {
/**
* Enables event updates for the service.
*/
invoke_startObserving(params: Protocol.BackgroundService.StartObservingRequest): Promise<Protocol.ProtocolResponseWithError>;
/**
* Disables event updates for the service.
*/
invoke_stopObserving(params: Protocol.BackgroundService.StopObservingRequest): Promise<Protocol.ProtocolResponseWithError>;
/**
* Set the recording state for the service.
*/
invoke_setRecording(params: Protocol.BackgroundService.SetRecordingRequest): Promise<Protocol.ProtocolResponseWithError>;
/**
* Clears all stored data for the service.
*/
invoke_clearEvents(params: Protocol.BackgroundService.ClearEventsRequest): Promise<Protocol.ProtocolResponseWithError>;
}
export interface BackgroundServiceDispatcher {
/**
* Called when the recording state for the service has been updated.
*/
recordingStateChanged(params: Protocol.BackgroundService.RecordingStateChangedEvent): void;
/**
* Called with all existing backgroundServiceEvents when enabled, and all new
* events afterwards if enabled and recording.
*/
backgroundServiceEventReceived(params: Protocol.BackgroundService.BackgroundServiceEventReceivedEvent): void;
}
export interface BrowserApi {
/**
* Set permission settings for given origin.
*/
invoke_setPermission(params: Protocol.Browser.SetPermissionRequest): Promise<Protocol.ProtocolResponseWithError>;
/**
* Grant specific permissions to the given origin and reject all others.
*/
invoke_grantPermissions(params: Protocol.Browser.GrantPermissionsRequest): Promise<Protocol.ProtocolResponseWithError>;
/**
* Reset all permission management for all origins.
*/
invoke_resetPermissions(params: Protocol.Browser.ResetPermissionsRequest): Promise<Protocol.ProtocolResponseWithError>;
/**
* Set the behavior when downloading a file.
*/
invoke_setDownloadBehavior(params: Protocol.Browser.SetDownloadBehaviorRequest): Promise<Protocol.ProtocolResponseWithError>;
/**
* Cancel a download if in progress
*/
invoke_cancelDownload(params: Protocol.Browser.CancelDownloadRequest): Promise<Protocol.ProtocolResponseWithError>;
/**
* Close browser gracefully.
*/
invoke_close(): Promise<Protocol.ProtocolResponseWithError>;
/**
* Crashes browser on the main thread.
*/
invoke_crash(): Promise<Protocol.ProtocolResponseWithError>;
/**
* Crashes GPU process.
*/
invoke_crashGpuProcess(): Promise<Protocol.ProtocolResponseWithError>;
/**
* Returns version information.
*/
invoke_getVersion(): Promise<Protocol.Browser.GetVersionResponse>;
/**
* Returns the command line switches for the browser process if, and only if
* --enable-automation is on the commandline.
*/
invoke_getBrowserCommandLine(): Promise<Protocol.Browser.GetBrowserCommandLineResponse>;
/**
* Get Chrome histograms.
*/
invoke_getHistograms(params: Protocol.Browser.GetHistogramsRequest): Promise<Protocol.Browser.GetHistogramsResponse>;
/**
* Get a Chrome histogram by name.
*/
invoke_getHistogram(params: Protocol.Browser.GetHistogramRequest): Promise<Protocol.Browser.GetHistogramResponse>;
/**
* Get position and size of the browser window.
*/
invoke_getWindowBounds(params: Protocol.Browser.GetWindowBoundsRequest): Promise<Protocol.Browser.GetWindowBoundsResponse>;
/**
* Get the browser window that contains the devtools target.
*/
invoke_getWindowForTarget(params: Protocol.Browser.GetWindowForTargetRequest): Promise<Protocol.Browser.GetWindowForTargetResponse>;
/**
* Set position and/or size of the browser window.
*/
invoke_setWindowBounds(params: Protocol.Browser.SetWindowBoundsRequest): Promise<Protocol.ProtocolResponseWithError>;
/**
* Set dock tile details, platform-specific.
*/
invoke_setDockTile(params: Protocol.Browser.SetDockTileRequest): Promise<Protocol.ProtocolResponseWithError>;
/**
* Invoke custom browser commands used by telemetry.
*/
invoke_executeBrowserCommand(params: Protocol.Browser.ExecuteBrowserCommandRequest): Promise<Protocol.ProtocolResponseWithError>;
/**
* Allows a site to use privacy sandbox features that require enrollment
* without the site actually being enrolled. Only supported on page targets.
*/
invoke_addPrivacySandboxEnrollmentOverride(params: Protocol.Browser.AddPrivacySandboxEnrollmentOverrideRequest): Promise<Protocol.ProtocolResponseWithError>;
/**
* Configures encryption keys used with a given privacy sandbox API to talk
* to a trusted coordinator. Since this is intended for test automation only,
* coordinatorOrigin must be a .test domain. No existing coordinator
* configuration for the origin may exist.
*/
invoke_addPrivacySandboxCoordinatorKeyConfig(params: Protocol.Browser.AddPrivacySandboxCoordinatorKeyConfigRequest): Promise<Protocol.ProtocolResponseWithError>;
}
export interface BrowserDispatcher {
/**
* Fired when page is about to start a download.
*/
downloadWillBegin(params: Protocol.Browser.DownloadWillBeginEvent): void;
/**
* Fired when download makes progress. Last call has |done| == true.
*/
downloadProgress(params: Protocol.Browser.DownloadProgressEvent): void;
}
export interface CSSApi {
/**
* Inserts a new rule with the given `ruleText` in a stylesheet with given `styleSheetId`, at the
* position specified by `location`.
*/
invoke_addRule(params: Protocol.CSS.AddRuleRequest): Promise<Protocol.CSS.AddRuleResponse>;
/**
* Returns all class names from specified stylesheet.
*/
invoke_collectClassNames(params: Protocol.CSS.CollectClassNamesRequest): Promise<Protocol.CSS.CollectClassNamesResponse>;
/**
* Creates a new special "via-inspector" stylesheet in the frame with given `frameId`.
*/
invoke_createStyleSheet(params: Protocol.CSS.CreateStyleSheetRequest): Promise<Protocol.CSS.CreateStyleSheetResponse>;
/**
* Disables the CSS agent for the given page.
*/
invoke_disable(): Promise<Protocol.ProtocolResponseWithError>;
/**
* Enables the CSS agent for the given page. Clients should not assume that the CSS agent has been
* enabled until the result of this command is received.
*/
invoke_enable(): Promise<Protocol.ProtocolResponseWithError>;
/**
* Ensures that the given node will have specified pseudo-classes whenever its style is computed by
* the browser.
*/
invoke_forcePseudoState(params: Protocol.CSS.ForcePseudoStateRequest): Promise<Protocol.ProtocolResponseWithError>;
/**
* Ensures that the given node is in its starting-style state.
*/
invoke_forceStartingStyle(params: Protocol.CSS.ForceStartingStyleRequest): Promise<Protocol.ProtocolResponseWithError>;
invoke_getBackgroundColors(params: Protocol.CSS.GetBackgroundColorsRequest): Promise<Protocol.CSS.GetBackgroundColorsResponse>;
/**
* Returns the computed style for a DOM node identified by `nodeId`.
*/
invoke_getComputedStyleForNode(params: Protocol.CSS.GetComputedStyleForNodeRequest): Promise<Protocol.CSS.GetComputedStyleForNodeResponse>;
/**
* Resolve the specified values in the context of the provided element.
* For example, a value of '1em' is evaluated according to the computed
* 'font-size' of the element and a value 'calc(1px + 2px)' will be
* resolved to '3px'.
*/
invoke_resolveValues(params: Protocol.CSS.ResolveValuesRequest): Promise<Protocol.CSS.ResolveValuesResponse>;
invoke_getLonghandProperties(params: Protocol.CSS.GetLonghandPropertiesRequest): Promise<Protocol.CSS.GetLonghandPropertiesResponse>;
/**
* Returns the styles defined inline (explicitly in the "style" attribute and implicitly, using DOM
* attributes) for a DOM node identified by `nodeId`.
*/
invoke_getInlineStylesForNode(params: Protocol.CSS.GetInlineStylesForNodeRequest): Promise<Protocol.CSS.GetInlineStylesForNodeResponse>;
/**
* Returns the styles coming from animations & transitions
* including the animation & transition styles coming from inheritance chain.
*/
invoke_getAnimatedStylesForNode(params: Protocol.CSS.GetAnimatedStylesForNodeRequest): Promise<Protocol.CSS.GetAnimatedStylesForNodeResponse>;
/**
* Returns requested styles for a DOM node identified by `nodeId`.
*/
invoke_getMatchedStylesForNode(params: Protocol.CSS.GetMatchedStylesForNodeRequest): Promise<Protocol.CSS.GetMatchedStylesForNodeResponse>;
/**
* Returns all media queries parsed by the rendering engine.
*/
invoke_getMediaQueries(): Promise<Protocol.CSS.GetMediaQueriesResponse>;
/**
* Requests information about platform fonts which we used to render child TextNodes in the given
* node.
*/
invoke_getPlatformFontsForNode(params: Protocol.CSS.GetPlatformFontsForNodeRequest): Promise<Protocol.CSS.GetPlatformFontsForNodeResponse>;
/**
* Returns the current textual content for a stylesheet.
*/
invoke_getStyleSheetText(params: Protocol.CSS.GetStyleSheetTextRequest): Promise<Protocol.CSS.GetStyleSheetTextResponse>;
/**
* Returns all layers parsed by the rendering engine for the tree scope of a node.
* Given a DOM element identified by nodeId, getLayersForNode returns the root
* layer for the nearest ancestor document or shadow root. The layer root contains
* the full layer tree for the tree scope and their ordering.
*/
invoke_getLayersForNode(params: Protocol.CSS.GetLayersForNodeRequest): Promise<Protocol.CSS.GetLayersForNodeResponse>;
/**
* Given a CSS selector text and a style sheet ID, getLocationForSelector
* returns an array of locations of the CSS selector in the style sheet.
*/
invoke_getLocationForSelector(params: Protocol.CSS.GetLocationForSelectorRequest): Promise<Protocol.CSS.GetLocationForSelectorResponse>;
/**
* Starts tracking the given node for the computed style updates
* and whenever the computed style is updated for node, it queues
* a `computedStyleUpdated` event with throttling.
* There can only be 1 node tracked for computed style updates
* so passing a new node id removes tracking from the previous node.
* Pass `undefined` to disable tracking.
*/
invoke_trackComputedStyleUpdatesForNode(params: Protocol.CSS.TrackComputedStyleUpdatesForNodeRequest): Promise<Protocol.ProtocolResponseWithError>;
/**
* Starts tracking the given computed styles for updates. The specified array of properties
* replaces the one previously specified. Pass empty array to disable tracking.
* Use takeComputedStyleUpdates to retrieve the list of nodes that had properties modified.
* The changes to computed style properties are only tracked for nodes pushed to the front-end
* by the DOM agent. If no changes to the tracked properties occur after the node has been pushed
* to the front-end, no updates will be issued for the node.
*/
invoke_trackComputedStyleUpdates(params: Protocol.CSS.TrackComputedStyleUpdatesRequest): Promise<Protocol.ProtocolResponseWithError>;
/**
* Polls the next batch of computed style updates.
*/
invoke_takeComputedStyleUpdates(): Promise<Protocol.CSS.TakeComputedStyleUpdatesResponse>;
/**
* Find a rule with the given active property for the given node and set the new value for this
* property
*/
invoke_setEffectivePropertyValueForNode(params: Protocol.CSS.SetEffectivePropertyValueForNodeRequest): Promise<Protocol.ProtocolResponseWithError>;
/**
* Modifies the property rule property name.
*/
invoke_setPropertyRulePropertyName(params: Protocol.CSS.SetPropertyRulePropertyNameRequest): Promise<Protocol.CSS.SetPropertyRulePropertyNameResponse>;
/**
* Modifies the keyframe rule key text.
*/
invoke_setKeyframeKey(params: Protocol.CSS.SetKeyframeKeyRequest): Promise<Protocol.CSS.SetKeyframeKeyResponse>;
/**
* Modifies the rule selector.
*/
invoke_setMediaText(params: Protocol.CSS.SetMediaTextRequest): Promise<Protocol.CSS.SetMediaTextResponse>;
/**
* Modifies the expression of a container query.
*/
invoke_setContainerQueryText(params: Protocol.CSS.SetContainerQueryTextRequest): Promise<Protocol.CSS.SetContainerQueryTextResponse>;
/**
* Modifies the expression of a supports at-rule.
*/
invoke_setSupportsText(params: Protocol.CSS.SetSupportsTextRequest): Promise<Protocol.CSS.SetSupportsTextResponse>;
/**
* Modifies the expression of a scope at-rule.
*/
invoke_setScopeText(params: Protocol.CSS.SetScopeTextRequest): Promise<Protocol.CSS.SetScopeTextResponse>;
/**
* Modifies the rule selector.
*/
invoke_setRuleSelector(params: Protocol.CSS.SetRuleSelectorRequest): Promise<Protocol.CSS.SetRuleSelectorResponse>;
/**
* Sets the new stylesheet text.
*/
invoke_setStyleSheetText(params: Protocol.CSS.SetStyleSheetTextRequest): Promise<Protocol.CSS.SetStyleSheetTextResponse>;
/**
* Applies specified style edits one after another in the given order.
*/
invoke_setStyleTexts(params: Protocol.CSS.SetStyleTextsRequest): Promise<Protocol.CSS.SetStyleTextsResponse>;
/**
* Enables the selector recording.
*/
invoke_startRuleUsageTracking(): Promise<Protocol.ProtocolResponseWithError>;
/**
* Stop tracking rule usage and return the list of rules that were used since last call to
* `takeCoverageDelta` (or since start of coverage instrumentation).
*/
invoke_stopRuleUsageTracking(): Promise<Protocol.CSS.StopRuleUsageTrackingResponse>;
/**
* Obtain list of rules that became used since last call to this method (or since start of coverage
* instrumentation).
*/
invoke_takeCoverageDelta(): Promise<Protocol.CSS.TakeCoverageDeltaResponse>;
/**
* Enables/disables rendering of local CSS fonts (enabled by default).
*/
invoke_setLocalFontsEnabled(params: Protocol.CSS.SetLocalFontsEnabledRequest): Promise<Protocol.ProtocolResponseWithError>;
}
export interface CSSDispatcher {
/**
* Fires whenever a web font is updated. A non-empty font parameter indicates a successfully loaded
* web font.
*/
fontsUpdated(params: Protocol.CSS.FontsUpdatedEvent): void;
/**
* Fires whenever a MediaQuery result changes (for example, after a browser window has been
* resized.) The current implementation considers only viewport-dependent media features.
*/
mediaQueryResultChanged(): void;
/**
* Fired whenever an active document stylesheet is added.
*/
styleSheetAdded(params: Protocol.CSS.StyleSheetAddedEvent): void;
/**
* Fired whenever a stylesheet is changed as a result of the client operation.
*/
styleSheetChanged(params: Protocol.CSS.StyleSheetChangedEvent): void;
/**
* Fired whenever an active document stylesheet is removed.
*/
styleSheetRemoved(params: Protocol.CSS.StyleSheetRemovedEvent): void;
computedStyleUpdated(params: Protocol.CSS.ComputedStyleUpdatedEvent): void;
}
export interface CacheStorageApi {
/**
* Deletes a cache.
*/
invoke_deleteCache(params: Protocol.CacheStorage.DeleteCacheRequest): Promise<Protocol.ProtocolResponseWithError>;
/**
* Deletes a cache entry.
*/
invoke_deleteEntry(params: Protocol.CacheStorage.DeleteEntryRequest): Promise<Protocol.ProtocolResponseWithError>;
/**
* Requests cache names.
*/
invoke_requestCacheNames(params: Protocol.CacheStorage.RequestCacheNamesRequest): Promise<Protocol.CacheStorage.RequestCacheNamesResponse>;
/**
* Fetches cache entry.
*/
invoke_requestCachedResponse(params: Protocol.CacheStorage.RequestCachedResponseRequest): Promise<Protocol.CacheStorage.RequestCachedResponseResponse>;
/**
* Requests data from cache.
*/
invoke_requestEntries(params: Protocol.CacheStorage.RequestEntriesRequest): Promise<Protocol.CacheStorage.RequestEntriesResponse>;
}
export interface CacheStorageDispatcher {
}
export interface CastApi {
/**
* Starts observing for sinks that can be used for tab mirroring, and if set,
* sinks compatible with |presentationUrl| as well. When sinks are found, a
* |sinksUpdated| event is fired.
* Also starts observing for issue messages. When an issue is added or removed,
* an |issueUpdated| event is fired.
*/
invoke_enable(params: Protocol.Cast.EnableRequest): Promise<Protocol.ProtocolResponseWithError>;
/**
* Stops observing for sinks and issues.
*/
invoke_disable(): Promise<Protocol.ProtocolResponseWithError>;
/**
* Sets a sink to be used when the web page requests the browser to choose a
* sink via Presentation API, Remote Playback API, or Cast SDK.
*/
invoke_setSinkToUse(params: Protocol.Cast.SetSinkToUseRequest): Promise<Protocol.ProtocolResponseWithError>;
/**
* Starts mirroring the desktop to the sink.
*/
invoke_startDesktopMirroring(params: Protocol.Cast.StartDesktopMirroringRequest): Promise<Protocol.ProtocolResponseWithError>;
/**
* Starts mirroring the tab to the sink.
*/
invoke_startTabMirroring(params: Protocol.Cast.StartTabMirroringRequest): Promise<Protocol.ProtocolResponseWithError>;
/**
* Stops the active Cast session on the sink.
*/
invoke_stopCasting(params: Protocol.Cast.StopCastingRequest): Promise<Protocol.ProtocolResponseWithError>;
}
export interface CastDispatcher {
/**
* This is fired whenever the list of available sinks changes. A sink is a
* device or a software surface that you can cast to.
*/
sinksUpdated(params: Protocol.Cast.SinksUpdatedEvent): void;
/**
* This is fired whenever the outstanding issue/error message changes.
* |issueMessage| is empty if there is no issue.
*/
issueUpdated(params: Protocol.Cast.IssueUpdatedEvent): void;
}
export interface DOMApi {
/**
* Collects class names for the node with given id and all of it's child nodes.
*/
invoke_collectClassNamesFromSubtree(params: Protocol.DOM.CollectClassNamesFromSubtreeRequest): Promise<Protocol.DOM.CollectClassNamesFromSubtreeResponse>;
/**
* Creates a deep copy of the specified node and places it into the target container before the
* given anchor.
*/
invoke_copyTo(params: Protocol.DOM.CopyToRequest): Promise<Protocol.DOM.CopyToResponse>;
/**
* Describes node given its id, does not require domain to be enabled. Does not start tracking any
* objects, can be used for automation.
*/
invoke_describeNode(params: Protocol.DOM.DescribeNodeRequest): Promise<Protocol.DOM.DescribeNodeResponse>;
/**
* Scrolls the specified rect of the given node into view if not already visible.