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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394 | package Torello.Browser.BrowserAPI;
// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***
// Java-HTML Imports
// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***
import Torello.Browser.*;
import Torello.Browser.helper.*;
import Torello.Browser.JavaScriptAPI.*;
import Torello.JSON.*;
import Torello.Java.ReadOnly.ReadOnlyList;
import Torello.Java.ReadOnly.ReadOnlyArrayList;
import Torello.JavaDoc.Annotations.StaticFunctional;
import Torello.JavaDoc.Annotations.JDHeaderBackgroundImg;
import Torello.Browser.BrowserAPI.NestedHelpers.Commands.Target$$Commands;
// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***
// JDK Imports
// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***
import javax.json.JsonObject;
import javax.json.JsonValue;
/**
* <SPAN CLASS=COPIEDJDK><B>Supports additional targets discovery and allows to attach to them.</B></SPAN>
* <EMBED CLASS='external-html' DATA-FILE-ID=CDP.CODE_GEN_NOTE>
*/
@StaticFunctional@JDHeaderBackgroundImg(EmbedTagFileID="CDP.WOOD_PLANK_NOTE")
public class Target
{
// No Pubic Constructors
private Target() { }
// ********************************************************************************************
// ********************************************************************************************
// Eliminated Types
// ********************************************************************************************
// ********************************************************************************************
/**
* Unique identifier of attached debugging session.
* <EMBED CLASS='external-html' DATA-CTAS='String' DATA-FILE-ID=CDP.EliminatedType
* DATA-NAME=SessionID>
*/
public static final String SessionID =
"SessionID has been eliminated.\n" +
"It was replaced with the standard Java-Type: String";
/**
* The entries in TargetFilter are matched sequentially against targets and
* the first entry that matches determines if the target is included or not,
* depending on the value of <CODE>exclude</CODE> field in the entry.
* If filter is not specified, the one assumed is
* [{type: "browser", exclude: true}, {type: "tab", exclude: true}, {}]
* (i.e. include everything but <CODE>browser</CODE> and <CODE>tab</CODE>).
*
* <BR /><B CLASS=Exp-Top>EXPERIMENTAL</B>
* <EMBED CLASS='external-html' DATA-CTAS='FilterEntry[]' DATA-FILE-ID=CDP.EliminatedType
* DATA-NAME=TargetFilter>
*/
public static final String TargetFilter =
"TargetFilter has been eliminated.\n" +
"It was replaced with the standard Java-Type: FilterEntry[]";
/**
* <CODE>[No Description Provided by Google]</CODE>
* <EMBED CLASS='external-html' DATA-CTAS='String' DATA-FILE-ID=CDP.EliminatedType
* DATA-NAME=TargetID>
*/
public static final String TargetID =
"TargetID has been eliminated.\n" +
"It was replaced with the standard Java-Type: String";
// ********************************************************************************************
// ********************************************************************************************
// Enumerated String Constants Lists
// ********************************************************************************************
// ********************************************************************************************
/**
* The state of the target window.
*
* <BR /><B CLASS=Exp-Top>EXPERIMENTAL</B>
* <BR /><BR /><B CLASS=StrEnumType>String-Enumeration Type</B>
*/
public static final ReadOnlyList<String> WindowState = new ReadOnlyArrayList<>
(String.class, "fullscreen", "maximized", "minimized", "normal");
// ********************************************************************************************
// ********************************************************************************************
// Basic Types
// ********************************************************************************************
// ********************************************************************************************
/**
* A filter used by target query/discovery/auto-attach operations.
*
* <BR /><B CLASS=Exp-Top>EXPERIMENTAL</B>
* <EMBED CLASS=globalDefs DATA-DOMAIN=Target DATA-API=BrowserAPI>
*/
@JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_TYPE_JDHBI")
public static class FilterEntry
extends BaseType<FilterEntry>
implements java.io.Serializable
{
/** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
protected static final long serialVersionUID = 1;
private static final NestedHelper<Target.FilterEntry> singleton =
Torello.Browser.BrowserAPI.NestedHelpers.Types.
Target$$FilterEntry$$.singleton;
/**
* If set, causes exclusion of matching targets from the list.
* <BR /><B CLASS=Opt-Top>OPTIONAL</B>
*/
public final Boolean exclude;
/**
* If not present, matches any type.
* <BR /><B CLASS=Opt-Top>OPTIONAL</B>
*/
public final String type;
/** Constructor. Please review this class' fields for documentation. */
public FilterEntry(ReadOnlyList<Boolean> isPresent, Boolean exclude, String type)
{
super(singleton, Domains.Target, "FilterEntry", 2);
this.exclude = exclude;
this.type = type;
this.isPresent = (isPresent == null)
? singleton.generateIsPresentList(this)
: THROWS.check(isPresent, 2, "Target.FilterEntry");
}
/** Creates an instance of this class from a {@link JsonObject}.*/
public static FilterEntry fromJSON(JsonObject jo)
{ return singleton.fromJSON(jo); }
/** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
public static NestedDescriptor<FilterEntry> descriptor()
{ return singleton.descriptor(); }
}
/**
* <CODE>[No Description Provided by Google]</CODE>
*
* <BR /><B CLASS=Exp-Top>EXPERIMENTAL</B>
* <EMBED CLASS=globalDefs DATA-DOMAIN=Target DATA-API=BrowserAPI>
*/
@JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_TYPE_JDHBI")
public static class RemoteLocation
extends BaseType<RemoteLocation>
implements java.io.Serializable
{
/** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
protected static final long serialVersionUID = 1;
private static final NestedHelper<Target.RemoteLocation> singleton =
Torello.Browser.BrowserAPI.NestedHelpers.Types.
Target$$RemoteLocation$$.singleton;
/** <CODE>[No Description Provided by Google]</CODE> */
public final String host;
/** <CODE>[No Description Provided by Google]</CODE> */
public final int port;
/** Constructor. Please review this class' fields for documentation. */
public RemoteLocation(ReadOnlyList<Boolean> isPresent, String host, int port)
{
super(singleton, Domains.Target, "RemoteLocation", 2);
this.host = host;
this.port = port;
this.isPresent = (isPresent == null)
? singleton.generateIsPresentList(this)
: THROWS.check(isPresent, 2, "Target.RemoteLocation");
}
/** Creates an instance of this class from a {@link JsonObject}.*/
public static RemoteLocation fromJSON(JsonObject jo)
{ return singleton.fromJSON(jo); }
/** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
public static NestedDescriptor<RemoteLocation> descriptor()
{ return singleton.descriptor(); }
}
/**
* <CODE>[No Description Provided by Google]</CODE>
*
* <EMBED CLASS=globalDefs DATA-DOMAIN=Target DATA-API=BrowserAPI>
*/
@JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_TYPE_JDHBI")
public static class TargetInfo
extends BaseType<TargetInfo>
implements java.io.Serializable
{
/** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
protected static final long serialVersionUID = 1;
private static final NestedHelper<Target.TargetInfo> singleton =
Torello.Browser.BrowserAPI.NestedHelpers.Types.
Target$$TargetInfo$$.singleton;
/** <CODE>[No Description Provided by Google]</CODE> */
public final String targetId;
/** List of types: https://source.chromium.org/chromium/chromium/src/+/main:content/browser/devtools/devtools_agent_host_impl.cc?ss=chromium&q=f:devtools%20-f:out%20%22::kTypeTab%5B%5D%22 */
public final String type;
/** <CODE>[No Description Provided by Google]</CODE> */
public final String title;
/** <CODE>[No Description Provided by Google]</CODE> */
public final String url;
/** Whether the target has an attached client. */
public final boolean attached;
/**
* Opener target Id
* <BR /><B CLASS=Opt-Top>OPTIONAL</B>
*/
public final String openerId;
/**
* Whether the target has access to the originating window.
* <BR /><B CLASS=Exp-Top>EXPERIMENTAL</B>
*/
public final boolean canAccessOpener;
/**
* Frame id of originating window (is only set if target has an opener).
* <BR /><B CLASS=Opt-Top>OPTIONAL</B><B CLASS=Exp-Top>EXPERIMENTAL</B>
*/
public final String openerFrameId;
/**
* <CODE>[No Description Provided by Google]</CODE>
* <BR /><B CLASS=Opt-Top>OPTIONAL</B><B CLASS=Exp-Top>EXPERIMENTAL</B>
*/
public final String browserContextId;
/**
* Provides additional details for specific target types. For example, for
* the type of "page", this may be set to "prerender".
* <BR /><B CLASS=Opt-Top>OPTIONAL</B><B CLASS=Exp-Top>EXPERIMENTAL</B>
*/
public final String subtype;
/** Constructor. Please review this class' fields for documentation. */
public TargetInfo(
ReadOnlyList<Boolean> isPresent, String targetId, String type, String title,
String url, boolean attached, String openerId, boolean canAccessOpener,
String openerFrameId, String browserContextId, String subtype
)
{
super(singleton, Domains.Target, "TargetInfo", 10);
this.targetId = targetId;
this.type = type;
this.title = title;
this.url = url;
this.attached = attached;
this.openerId = openerId;
this.canAccessOpener = canAccessOpener;
this.openerFrameId = openerFrameId;
this.browserContextId = browserContextId;
this.subtype = subtype;
this.isPresent = (isPresent == null)
? singleton.generateIsPresentList(this)
: THROWS.check(isPresent, 10, "Target.TargetInfo");
}
/** Creates an instance of this class from a {@link JsonObject}.*/
public static TargetInfo fromJSON(JsonObject jo)
{ return singleton.fromJSON(jo); }
/** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
public static NestedDescriptor<TargetInfo> descriptor()
{ return singleton.descriptor(); }
}
// ********************************************************************************************
// ********************************************************************************************
// Event Types
// ********************************************************************************************
// ********************************************************************************************
/**
* Issued when attached to target because of auto-attach or <CODE>attachToTarget</CODE> command.
*
* <BR /><B CLASS=Exp-Top>EXPERIMENTAL</B>
* <EMBED CLASS=globalDefs DATA-DOMAIN=Target DATA-API=BrowserAPI>
*/
@JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_EVENT_JDHBI")
public static class attachedToTarget
extends BrowserEvent<attachedToTarget>
implements java.io.Serializable
{
/** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
protected static final long serialVersionUID = 1;
private static final NestedHelper<Target.attachedToTarget> singleton =
Torello.Browser.BrowserAPI.NestedHelpers.Events.
Target$$attachedToTarget$$.singleton;
/** Identifier assigned to the session used to send/receive messages. */
public final String sessionId;
/** <CODE>[No Description Provided by Google]</CODE> */
public final Target.TargetInfo targetInfo;
/** <CODE>[No Description Provided by Google]</CODE> */
public final boolean waitingForDebugger;
/** Constructor. Please review this class' fields for documentation. */
public attachedToTarget(
ReadOnlyList<Boolean> isPresent, String sessionId, TargetInfo targetInfo,
boolean waitingForDebugger
)
{
super(singleton, Domains.Target, "attachedToTarget", 3);
this.sessionId = sessionId;
this.targetInfo = targetInfo;
this.waitingForDebugger = waitingForDebugger;
this.isPresent = (isPresent == null)
? singleton.generateIsPresentList(this)
: THROWS.check(isPresent, 3, "Target.attachedToTarget");
}
/** Creates an instance of this class from a {@link JsonObject}.*/
public static attachedToTarget fromJSON(JsonObject jo)
{ return singleton.fromJSON(jo); }
/** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
public static NestedDescriptor<attachedToTarget> descriptor()
{ return singleton.descriptor(); }
}
/**
* Issued when detached from target for any reason (including <CODE>detachFromTarget</CODE> command). Can be
* issued multiple times per target if multiple sessions have been attached to it.
*
* <BR /><B CLASS=Exp-Top>EXPERIMENTAL</B>
* <EMBED CLASS=globalDefs DATA-DOMAIN=Target DATA-API=BrowserAPI>
*/
@JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_EVENT_JDHBI")
public static class detachedFromTarget
extends BrowserEvent<detachedFromTarget>
implements java.io.Serializable
{
/** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
protected static final long serialVersionUID = 1;
private static final NestedHelper<Target.detachedFromTarget> singleton =
Torello.Browser.BrowserAPI.NestedHelpers.Events.
Target$$detachedFromTarget$$.singleton;
/** Detached session identifier. */
public final String sessionId;
/**
* Deprecated.
* <BR /><B CLASS=Opt-Top>OPTIONAL</B><B CLASS=Dep-Top>DEPRECATED</B>
*/
public final String targetId;
/** Constructor. Please review this class' fields for documentation. */
public detachedFromTarget
(ReadOnlyList<Boolean> isPresent, String sessionId, String targetId)
{
super(singleton, Domains.Target, "detachedFromTarget", 2);
this.sessionId = sessionId;
this.targetId = targetId;
this.isPresent = (isPresent == null)
? singleton.generateIsPresentList(this)
: THROWS.check(isPresent, 2, "Target.detachedFromTarget");
}
/** Creates an instance of this class from a {@link JsonObject}.*/
public static detachedFromTarget fromJSON(JsonObject jo)
{ return singleton.fromJSON(jo); }
/** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
public static NestedDescriptor<detachedFromTarget> descriptor()
{ return singleton.descriptor(); }
}
/**
* Notifies about a new protocol message received from the session (as reported in
* <CODE>attachedToTarget</CODE> event).
*
* <EMBED CLASS=globalDefs DATA-DOMAIN=Target DATA-API=BrowserAPI>
*/
@JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_EVENT_JDHBI")
public static class receivedMessageFromTarget
extends BrowserEvent<receivedMessageFromTarget>
implements java.io.Serializable
{
/** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
protected static final long serialVersionUID = 1;
private static final NestedHelper<Target.receivedMessageFromTarget> singleton =
Torello.Browser.BrowserAPI.NestedHelpers.Events.
Target$$receivedMessageFromTarget$$.singleton;
/** Identifier of a session which sends a message. */
public final String sessionId;
/** <CODE>[No Description Provided by Google]</CODE> */
public final String message;
/**
* Deprecated.
* <BR /><B CLASS=Opt-Top>OPTIONAL</B><B CLASS=Dep-Top>DEPRECATED</B>
*/
public final String targetId;
/** Constructor. Please review this class' fields for documentation. */
public receivedMessageFromTarget
(ReadOnlyList<Boolean> isPresent, String sessionId, String message, String targetId)
{
super(singleton, Domains.Target, "receivedMessageFromTarget", 3);
this.sessionId = sessionId;
this.message = message;
this.targetId = targetId;
this.isPresent = (isPresent == null)
? singleton.generateIsPresentList(this)
: THROWS.check(isPresent, 3, "Target.receivedMessageFromTarget");
}
/** Creates an instance of this class from a {@link JsonObject}.*/
public static receivedMessageFromTarget fromJSON(JsonObject jo)
{ return singleton.fromJSON(jo); }
/** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
public static NestedDescriptor<receivedMessageFromTarget> descriptor()
{ return singleton.descriptor(); }
}
/**
* Issued when a target has crashed.
*
* <EMBED CLASS=globalDefs DATA-DOMAIN=Target DATA-API=BrowserAPI>
*/
@JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_EVENT_JDHBI")
public static class targetCrashed
extends BrowserEvent<targetCrashed>
implements java.io.Serializable
{
/** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
protected static final long serialVersionUID = 1;
private static final NestedHelper<Target.targetCrashed> singleton =
Torello.Browser.BrowserAPI.NestedHelpers.Events.
Target$$targetCrashed$$.singleton;
/** <CODE>[No Description Provided by Google]</CODE> */
public final String targetId;
/** Termination status type. */
public final String status;
/** Termination error code. */
public final int errorCode;
/** Constructor. Please review this class' fields for documentation. */
public targetCrashed
(ReadOnlyList<Boolean> isPresent, String targetId, String status, int errorCode)
{
super(singleton, Domains.Target, "targetCrashed", 3);
this.targetId = targetId;
this.status = status;
this.errorCode = errorCode;
this.isPresent = (isPresent == null)
? singleton.generateIsPresentList(this)
: THROWS.check(isPresent, 3, "Target.targetCrashed");
}
/** Creates an instance of this class from a {@link JsonObject}.*/
public static targetCrashed fromJSON(JsonObject jo)
{ return singleton.fromJSON(jo); }
/** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
public static NestedDescriptor<targetCrashed> descriptor()
{ return singleton.descriptor(); }
}
/**
* Issued when a possible inspection target is created.
*
* <EMBED CLASS=globalDefs DATA-DOMAIN=Target DATA-API=BrowserAPI>
*/
@JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_EVENT_JDHBI")
public static class targetCreated
extends BrowserEvent<targetCreated>
implements java.io.Serializable
{
/** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
protected static final long serialVersionUID = 1;
private static final NestedHelper<Target.targetCreated> singleton =
Torello.Browser.BrowserAPI.NestedHelpers.Events.
Target$$targetCreated$$.singleton;
/** <CODE>[No Description Provided by Google]</CODE> */
public final Target.TargetInfo targetInfo;
/** Constructor. Please review this class' fields for documentation. */
public targetCreated(ReadOnlyList<Boolean> isPresent, TargetInfo targetInfo)
{
super(singleton, Domains.Target, "targetCreated", 1);
this.targetInfo = targetInfo;
this.isPresent = (isPresent == null)
? singleton.generateIsPresentList(this)
: THROWS.check(isPresent, 1, "Target.targetCreated");
}
/** Creates an instance of this class from a {@link JsonObject}.*/
public static targetCreated fromJSON(JsonObject jo)
{ return singleton.fromJSON(jo); }
/** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
public static NestedDescriptor<targetCreated> descriptor()
{ return singleton.descriptor(); }
}
/**
* Issued when a target is destroyed.
*
* <EMBED CLASS=globalDefs DATA-DOMAIN=Target DATA-API=BrowserAPI>
*/
@JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_EVENT_JDHBI")
public static class targetDestroyed
extends BrowserEvent<targetDestroyed>
implements java.io.Serializable
{
/** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
protected static final long serialVersionUID = 1;
private static final NestedHelper<Target.targetDestroyed> singleton =
Torello.Browser.BrowserAPI.NestedHelpers.Events.
Target$$targetDestroyed$$.singleton;
/** <CODE>[No Description Provided by Google]</CODE> */
public final String targetId;
/** Constructor. Please review this class' fields for documentation. */
public targetDestroyed(ReadOnlyList<Boolean> isPresent, String targetId)
{
super(singleton, Domains.Target, "targetDestroyed", 1);
this.targetId = targetId;
this.isPresent = (isPresent == null)
? singleton.generateIsPresentList(this)
: THROWS.check(isPresent, 1, "Target.targetDestroyed");
}
/** Creates an instance of this class from a {@link JsonObject}.*/
public static targetDestroyed fromJSON(JsonObject jo)
{ return singleton.fromJSON(jo); }
/** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
public static NestedDescriptor<targetDestroyed> descriptor()
{ return singleton.descriptor(); }
}
/**
* Issued when some information about a target has changed. This only happens between
* <CODE>targetCreated</CODE> and <CODE>targetDestroyed</CODE>.
*
* <EMBED CLASS=globalDefs DATA-DOMAIN=Target DATA-API=BrowserAPI>
*/
@JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_EVENT_JDHBI")
public static class targetInfoChanged
extends BrowserEvent<targetInfoChanged>
implements java.io.Serializable
{
/** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
protected static final long serialVersionUID = 1;
private static final NestedHelper<Target.targetInfoChanged> singleton =
Torello.Browser.BrowserAPI.NestedHelpers.Events.
Target$$targetInfoChanged$$.singleton;
/** <CODE>[No Description Provided by Google]</CODE> */
public final Target.TargetInfo targetInfo;
/** Constructor. Please review this class' fields for documentation. */
public targetInfoChanged(ReadOnlyList<Boolean> isPresent, TargetInfo targetInfo)
{
super(singleton, Domains.Target, "targetInfoChanged", 1);
this.targetInfo = targetInfo;
this.isPresent = (isPresent == null)
? singleton.generateIsPresentList(this)
: THROWS.check(isPresent, 1, "Target.targetInfoChanged");
}
/** Creates an instance of this class from a {@link JsonObject}.*/
public static targetInfoChanged fromJSON(JsonObject jo)
{ return singleton.fromJSON(jo); }
/** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
public static NestedDescriptor<targetInfoChanged> descriptor()
{ return singleton.descriptor(); }
}
// ********************************************************************************************
// ********************************************************************************************
// Commands
// ********************************************************************************************
// ********************************************************************************************
/**
* Activates (focuses) the target.
*
* @param targetId -
*
* @return An instance of <CODE>{@link Script}<Void></CODE>
*
* <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
* browser receives the invocation-request.
*
* <BR /><BR /><DIV CLASS=JDHint>
* This Browser-Function <I>does not have</I> a return-value. You may choose to
* <B STYLE='color: red'>await</B> the {@link Promise}{@code <Void>} to ensure that
* the Browser Function has run to completion.
* </DIV>
*/
public static Script<Void> activateTarget(String targetId)
{
// Build the JSON Request-Object (as a String); only 1 Parameter is passed
final String requestJSON = WriteJSON.get
(CDPTypes.STRING, "targetId", false, "Target.activateTarget", targetId);
return Script.NO_RET(Domains.Target, "activateTarget", requestJSON);
}
/**
* Attaches to the browser target, only uses flat sessionId mode.
*
* <BR /><B CLASS=Exp-Top>EXPERIMENTAL</B>
*
* @return An instance of <CODE>{@link Script}<String></CODE>
*
* <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
* {@link Script#exec(WebSocketSender) Script.exec}, and afterwards, a {@link Promise}
* <CODE><String></CODE> will be returned
*
* <BR /><BR />Finally, the <B>{@code Promise}</B> may be <B STYLE='color: red'>awaited</B>,
* using {@link Promise#await()}, <I>and the returned result of this Browser Function may
* be retrieved.</I>
*
* <BR /><BR /><DIV CLASS=JDHint>
* This Browser Function's {@code Promise} returns:
* <CODE>String (<B>sessionId</B>)</CODE>
* <BR />
* Id assigned to the session.
* </DIV>
*/
public static Script<String> attachToBrowserTarget()
{
// Ultra-Simple Request JSON - Because this method has no parameters
final String requestJSON = "{\"method\":\"Target.attachToBrowserTarget\"}";
return new Script<>(
Domains.Target, "attachToBrowserTarget", requestJSON,
jo -> ReadJSON.getString(jo, "sessionId", true, false),
String.class
);
}
/**
* Attaches to the target with given id.
*
* @param targetId -
*
* @param flatten
* Enables "flat" access to the session via specifying sessionId attribute in the commands.
* We plan to make this the default, deprecate non-flattened mode,
* and eventually retire it. See crbug.com/991325.
* <BR /><B CLASS=Opt-Top>OPTIONAL</B>
*
* @return An instance of <CODE>{@link Script}<String></CODE>
*
* <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
* {@link Script#exec(WebSocketSender) Script.exec}, and afterwards, a {@link Promise}
* <CODE><String></CODE> will be returned
*
* <BR /><BR />Finally, the <B>{@code Promise}</B> may be <B STYLE='color: red'>awaited</B>,
* using {@link Promise#await()}, <I>and the returned result of this Browser Function may
* be retrieved.</I>
*
* <BR /><BR /><DIV CLASS=JDHint>
* This Browser Function's {@code Promise} returns:
* <CODE>String (<B>sessionId</B>)</CODE>
* <BR />
* Id assigned to the session.
* </DIV>
*/
public static Script<String> attachToTarget(String targetId, Boolean flatten)
{
// Convert all Method Parameters into a JSON Request-Object (as a String)
final String requestJSON = WriteJSON.get(
Target$$Commands.attachToTarget$$, "Target.attachToTarget",
targetId, flatten
);
return new Script<>(
Domains.Target, "attachToTarget", requestJSON,
jo -> ReadJSON.getString(jo, "sessionId", true, false),
String.class
);
}
/**
* Adds the specified target to the list of targets that will be monitored for any related target
* creation (such as child frames, child workers and new versions of service worker) and reported
* through <CODE>attachedToTarget</CODE>. The specified target is also auto-attached.
* This cancels the effect of any previous <CODE>setAutoAttach</CODE> and is also cancelled by subsequent
* <CODE>setAutoAttach</CODE>. Only available at the Browser target.
*
* <BR /><B CLASS=Exp-Top>EXPERIMENTAL</B>
*
* @param targetId -
*
* @param waitForDebuggerOnStart
* Whether to pause new targets when attaching to them. Use <CODE>RunTime.runIfWaitingForDebugger</CODE>
* to run paused targets.
*
* @param filter Only targets matching filter will be attached.
* <BR /><B CLASS=Opt-Top>OPTIONAL</B><B CLASS=Exp-Top>EXPERIMENTAL</B>
*
* @return An instance of <CODE>{@link Script}<Void></CODE>
*
* <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
* browser receives the invocation-request.
*
* <BR /><BR /><DIV CLASS=JDHint>
* This Browser-Function <I>does not have</I> a return-value. You may choose to
* <B STYLE='color: red'>await</B> the {@link Promise}{@code <Void>} to ensure that
* the Browser Function has run to completion.
* </DIV>
*/
public static Script<Void> autoAttachRelated
(String targetId, boolean waitForDebuggerOnStart, FilterEntry[] filter)
{
// Convert all Method Parameters into a JSON Request-Object (as a String)
final String requestJSON = WriteJSON.get(
Target$$Commands.autoAttachRelated$$, "Target.autoAttachRelated",
targetId, waitForDebuggerOnStart, filter
);
return Script.NO_RET(Domains.Target, "autoAttachRelated", requestJSON);
}
/**
* Closes the target. If the target is a page that gets closed too.
*
* @param targetId -
*
* @return An instance of <CODE>{@link Script}<Boolean></CODE>
*
* <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
* {@link Script#exec(WebSocketSender) Script.exec}, and afterwards, a {@link Promise}
* <CODE><Boolean></CODE> will be returned
*
* <BR /><BR />Finally, the <B>{@code Promise}</B> may be <B STYLE='color: red'>awaited</B>,
* using {@link Promise#await()}, <I>and the returned result of this Browser Function may
* be retrieved.</I>
*
* <BR /><BR /><DIV CLASS=JDHint>
* This Browser Function's {@code Promise} returns:
* <CODE>Boolean (<B>success</B>)</CODE>
* <BR />
* Always set to true. If an error occurs, the response indicates protocol error.
* </DIV>
*/
public static Script<Boolean> closeTarget(String targetId)
{
// Build the JSON Request-Object (as a String); only 1 Parameter is passed
final String requestJSON = WriteJSON.get
(CDPTypes.STRING, "targetId", false, "Target.closeTarget", targetId);
return new Script<>(
Domains.Target, "closeTarget", requestJSON,
jo -> ReadBoxedJSON.getBoolean(jo, "success", JFlag.RD_N | JFlag.RD_M, DV.NULL_BOOL),
Boolean.class
);
}
/**
* Creates a new empty BrowserContext. Similar to an incognito profile but you can have more than
* one.
*
* @param disposeOnDetach If specified, disposes this context when debugging session disconnects.
* <BR /><B CLASS=Opt-Top>OPTIONAL</B><B CLASS=Exp-Top>EXPERIMENTAL</B>
*
* @param proxyServer Proxy server, similar to the one passed to --proxy-server
* <BR /><B CLASS=Opt-Top>OPTIONAL</B><B CLASS=Exp-Top>EXPERIMENTAL</B>
*
* @param proxyBypassList Proxy bypass list, similar to the one passed to --proxy-bypass-list
* <BR /><B CLASS=Opt-Top>OPTIONAL</B><B CLASS=Exp-Top>EXPERIMENTAL</B>
*
* @param originsWithUniversalNetworkAccess
* An optional list of origins to grant unlimited cross-origin access to.
* Parts of the URL other than those constituting origin are ignored.
* <BR /><B CLASS=Opt-Top>OPTIONAL</B><B CLASS=Exp-Top>EXPERIMENTAL</B>
*
* @return An instance of <CODE>{@link Script}<String></CODE>
*
* <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
* {@link Script#exec(WebSocketSender) Script.exec}, and afterwards, a {@link Promise}
* <CODE><String></CODE> will be returned
*
* <BR /><BR />Finally, the <B>{@code Promise}</B> may be <B STYLE='color: red'>awaited</B>,
* using {@link Promise#await()}, <I>and the returned result of this Browser Function may
* be retrieved.</I>
*
* <BR /><BR /><DIV CLASS=JDHint>
* This Browser Function's {@code Promise} returns:
* <CODE>String (<B>browserContextId</B>)</CODE>
* <BR />
* The id of the context created.
* </DIV>
*/
public static Script<String> createBrowserContext(
Boolean disposeOnDetach, String proxyServer, String proxyBypassList,
String[] originsWithUniversalNetworkAccess
)
{
// Convert all Method Parameters into a JSON Request-Object (as a String)
final String requestJSON = WriteJSON.get(
Target$$Commands.createBrowserContext$$, "Target.createBrowserContext",
disposeOnDetach, proxyServer, proxyBypassList, originsWithUniversalNetworkAccess
);
return new Script<>(
Domains.Target, "createBrowserContext", requestJSON,
jo -> ReadJSON.getString(jo, "browserContextId", true, false),
String.class
);
}
/**
* Creates a new page.
*
* <BR /><BR /><DIV CLASS=JDHint>
* 👍 Because of the sheer number of input parameters to this method, there is a
* a {@link CommandBuilder} variant to this method which may be invoked instead.
*
* <BR /><BR />
* Please View: {@link #createTarget()}
* </DIV>
*
* @param url The initial URL the page will be navigated to. An empty string indicates about:blank.
*
* @param left Frame left origin in DIP (requires newWindow to be true or headless shell).
* <BR /><B CLASS=Opt-Top>OPTIONAL</B><B CLASS=Exp-Top>EXPERIMENTAL</B>
*
* @param top Frame top origin in DIP (requires newWindow to be true or headless shell).
* <BR /><B CLASS=Opt-Top>OPTIONAL</B><B CLASS=Exp-Top>EXPERIMENTAL</B>
*
* @param width Frame width in DIP (requires newWindow to be true or headless shell).
* <BR /><B CLASS=Opt-Top>OPTIONAL</B>
*
* @param height Frame height in DIP (requires newWindow to be true or headless shell).
* <BR /><B CLASS=Opt-Top>OPTIONAL</B>
*
* @param windowState
* Frame window state (requires newWindow to be true or headless shell).
* Default is normal.
* <BR /><B CLASS=Opt-Top>OPTIONAL</B>
*
* @param browserContextId The browser context to create the page in.
* <BR /><B CLASS=Opt-Top>OPTIONAL</B><B CLASS=Exp-Top>EXPERIMENTAL</B>
*
* @param enableBeginFrameControl
* Whether BeginFrames for this target will be controlled via DevTools (headless shell only,
* not supported on MacOS yet, false by default).
* <BR /><B CLASS=Opt-Top>OPTIONAL</B><B CLASS=Exp-Top>EXPERIMENTAL</B>
*
* @param newWindow Whether to create a new Window or Tab (false by default, not supported by headless shell).
* <BR /><B CLASS=Opt-Top>OPTIONAL</B>
*
* @param background
* Whether to create the target in background or foreground (false by default, not supported
* by headless shell).
* <BR /><B CLASS=Opt-Top>OPTIONAL</B>
*
* @param forTab Whether to create the target of type "tab".
* <BR /><B CLASS=Opt-Top>OPTIONAL</B><B CLASS=Exp-Top>EXPERIMENTAL</B>
*
* @param hidden
* Whether to create a hidden target. The hidden target is observable via protocol, but not
* present in the tab UI strip. Cannot be created with <CODE>forTab: true</CODE>, <CODE>newWindow: true</CODE> or
* <CODE>background: false</CODE>. The life-time of the tab is limited to the life-time of the session.
* <BR /><B CLASS=Opt-Top>OPTIONAL</B><B CLASS=Exp-Top>EXPERIMENTAL</B>
*
* @return An instance of <CODE>{@link Script}<String></CODE>
*
* <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
* {@link Script#exec(WebSocketSender) Script.exec}, and afterwards, a {@link Promise}
* <CODE><String></CODE> will be returned
*
* <BR /><BR />Finally, the <B>{@code Promise}</B> may be <B STYLE='color: red'>awaited</B>,
* using {@link Promise#await()}, <I>and the returned result of this Browser Function may
* be retrieved.</I>
*
* <BR /><BR /><DIV CLASS=JDHint>
* This Browser Function's {@code Promise} returns:
* <CODE>String (<B>targetId</B>)</CODE>
* <BR />
* The id of the page opened.
* </DIV>
*/
public static Script<String> createTarget(
String url, Integer left, Integer top, Integer width, Integer height,
String windowState, String browserContextId, Boolean enableBeginFrameControl,
Boolean newWindow, Boolean background, Boolean forTab, Boolean hidden
)
{
// Convert all Method Parameters into a JSON Request-Object (as a String)
final String requestJSON = WriteJSON.get(
Target$$Commands.createTarget$$, "Target.createTarget",
url, left, top, width, height, windowState, browserContextId, enableBeginFrameControl,
newWindow, background, forTab, hidden
);
return new Script<>(
Domains.Target, "createTarget", requestJSON,
jo -> ReadJSON.getString(jo, "targetId", true, false),
String.class
);
}
/**
* Detaches session with given id.
*
* @param sessionId Session to detach.
* <BR /><B CLASS=Opt-Top>OPTIONAL</B>
*
* @param targetId Deprecated.
* <BR /><B CLASS=Opt-Top>OPTIONAL</B><B CLASS=Dep-Top>DEPRECATED</B>
*
* @return An instance of <CODE>{@link Script}<Void></CODE>
*
* <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
* browser receives the invocation-request.
*
* <BR /><BR /><DIV CLASS=JDHint>
* This Browser-Function <I>does not have</I> a return-value. You may choose to
* <B STYLE='color: red'>await</B> the {@link Promise}{@code <Void>} to ensure that
* the Browser Function has run to completion.
* </DIV>
*/
public static Script<Void> detachFromTarget(String sessionId, String targetId)
{
// Convert all Method Parameters into a JSON Request-Object (as a String)
final String requestJSON = WriteJSON.get(
Target$$Commands.detachFromTarget$$, "Target.detachFromTarget",
sessionId, targetId
);
return Script.NO_RET(Domains.Target, "detachFromTarget", requestJSON);
}
/**
* Deletes a BrowserContext. All the belonging pages will be closed without calling their
* beforeunload hooks.
*
* @param browserContextId -
*
* @return An instance of <CODE>{@link Script}<Void></CODE>
*
* <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
* browser receives the invocation-request.
*
* <BR /><BR /><DIV CLASS=JDHint>
* This Browser-Function <I>does not have</I> a return-value. You may choose to
* <B STYLE='color: red'>await</B> the {@link Promise}{@code <Void>} to ensure that
* the Browser Function has run to completion.
* </DIV>
*/
public static Script<Void> disposeBrowserContext(String browserContextId)
{
// Build the JSON Request-Object (as a String); only 1 Parameter is passed
final String requestJSON = WriteJSON.get(
CDPTypes.STRING, "browserContextId", false, "Target.disposeBrowserContext",
browserContextId
);
return Script.NO_RET(Domains.Target, "disposeBrowserContext", requestJSON);
}
/**
* Inject object to the target's main frame that provides a communication
* channel with browser target.
*
* Injected object will be available as <CODE>window[bindingName]</CODE>.
*
* The object has the following API:
* - <CODE>binding.send(json)</CODE> - a method to send messages over the remote debugging protocol
* - <CODE>binding.onmessage = json => handleMessage(json)</CODE> - a callback that will be called for the protocol notifications and command responses.
*
* <BR /><B CLASS=Exp-Top>EXPERIMENTAL</B>
*
* @param targetId -
*
* @param bindingName Binding name, 'cdp' if not specified.
* <BR /><B CLASS=Opt-Top>OPTIONAL</B>
*
* @param inheritPermissions If true, inherits the current root session's permissions (default: false).
* <BR /><B CLASS=Opt-Top>OPTIONAL</B>
*
* @return An instance of <CODE>{@link Script}<Void></CODE>
*
* <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
* browser receives the invocation-request.
*
* <BR /><BR /><DIV CLASS=JDHint>
* This Browser-Function <I>does not have</I> a return-value. You may choose to
* <B STYLE='color: red'>await</B> the {@link Promise}{@code <Void>} to ensure that
* the Browser Function has run to completion.
* </DIV>
*/
public static Script<Void> exposeDevToolsProtocol
(String targetId, String bindingName, Boolean inheritPermissions)
{
// Convert all Method Parameters into a JSON Request-Object (as a String)
final String requestJSON = WriteJSON.get(
Target$$Commands.exposeDevToolsProtocol$$, "Target.exposeDevToolsProtocol",
targetId, bindingName, inheritPermissions
);
return Script.NO_RET(Domains.Target, "exposeDevToolsProtocol", requestJSON);
}
/**
* Returns all browser contexts created with <CODE>Target.createBrowserContext</CODE> method.
*
* @return An instance of <CODE>{@link Script}<String[]></CODE>
*
* <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
* {@link Script#exec(WebSocketSender) Script.exec}, and afterwards, a {@link Promise}
* <CODE><String[]></CODE> will be returned
*
* <BR /><BR />Finally, the <B>{@code Promise}</B> may be <B STYLE='color: red'>awaited</B>,
* using {@link Promise#await()}, <I>and the returned result of this Browser Function may
* be retrieved.</I>
*
* <BR /><BR /><DIV CLASS=JDHint>
* This Browser Function's {@code Promise} returns:
* <CODE>String[] (<B>browserContextIds</B>)</CODE>
* <BR />
* An array of browser context ids.
* </DIV>
*/
public static Script<String[]> getBrowserContexts()
{
// Ultra-Simple Request JSON - Because this method has no parameters
final String requestJSON = "{\"method\":\"Target.getBrowserContexts\"}";
return new Script<>(
Domains.Target, "getBrowserContexts", requestJSON,
Target$$Commands::getBrowserContexts,
String[].class
);
}
/**
* Returns information about a target.
*
* <BR /><B CLASS=Exp-Top>EXPERIMENTAL</B>
*
* @param targetId -
* <BR /><B CLASS=Opt-Top>OPTIONAL</B>
*
* @return An instance of <CODE>{@link Script}<{@link Target.TargetInfo}></CODE>
*
* <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
* {@link Script#exec(WebSocketSender) Script.exec}, and afterwards, a {@link Promise}
* <CODE><{@link Target.TargetInfo}></CODE> will be returned
*
* <BR /><BR />Finally, the <B>{@code Promise}</B> may be <B STYLE='color: red'>awaited</B>,
* using {@link Promise#await()}, <I>and the returned result of this Browser Function may
* be retrieved.</I>
*
* <BR /><BR /><DIV CLASS=JDHint>
* This Browser Function's {@code Promise} returns:
* <CODE>{@link Target.TargetInfo} (<B>targetInfo</B>)</CODE>
* </DIV>
*/
public static Script<Target.TargetInfo> getTargetInfo(String targetId)
{
// Build the JSON Request-Object (as a String); only 1 Parameter is passed
final String requestJSON = WriteJSON.get
(CDPTypes.STRING, "targetId", true, "Target.getTargetInfo", targetId);
return new Script<>(
Domains.Target, "getTargetInfo", requestJSON,
Target$$Commands::getTargetInfo,
Target.TargetInfo.class
);
}
/**
* Retrieves a list of available targets.
*
* @param filter
* Only targets matching filter will be reported. If filter is not specified
* and target discovery is currently enabled, a filter used for target discovery
* is used for consistency.
* <BR /><B CLASS=Opt-Top>OPTIONAL</B><B CLASS=Exp-Top>EXPERIMENTAL</B>
*
* @return An instance of <CODE>{@link Script}<{@link Target.TargetInfo}[]></CODE>
*
* <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
* {@link Script#exec(WebSocketSender) Script.exec}, and afterwards, a {@link Promise}
* <CODE><{@link Target.TargetInfo}[]></CODE> will be returned
*
* <BR /><BR />Finally, the <B>{@code Promise}</B> may be <B STYLE='color: red'>awaited</B>,
* using {@link Promise#await()}, <I>and the returned result of this Browser Function may
* be retrieved.</I>
*
* <BR /><BR /><DIV CLASS=JDHint>
* This Browser Function's {@code Promise} returns:
* <CODE>{@link Target.TargetInfo}[] (<B>targetInfos</B>)</CODE>
* <BR />
* The list of targets.
* </DIV>
*/
public static Script<Target.TargetInfo[]> getTargets(FilterEntry[] filter)
{
// Build the JSON Request-Object (as a String); only 1 Parameter is passed
final String requestJSON = WriteJSON.get
(CDPTypes.CDP_TYPE, "filter", true, "Target.getTargets", (Object) filter);
return new Script<>(
Domains.Target, "getTargets", requestJSON,
Target$$Commands::getTargets,
Target.TargetInfo[].class
);
}
/**
* Opens a DevTools window for the target.
*
* <BR /><B CLASS=Exp-Top>EXPERIMENTAL</B>
*
* @param targetId This can be the page or tab target ID.
*
* @return An instance of <CODE>{@link Script}<String></CODE>
*
* <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
* {@link Script#exec(WebSocketSender) Script.exec}, and afterwards, a {@link Promise}
* <CODE><String></CODE> will be returned
*
* <BR /><BR />Finally, the <B>{@code Promise}</B> may be <B STYLE='color: red'>awaited</B>,
* using {@link Promise#await()}, <I>and the returned result of this Browser Function may
* be retrieved.</I>
*
* <BR /><BR /><DIV CLASS=JDHint>
* This Browser Function's {@code Promise} returns:
* <CODE>String (<B>targetId</B>)</CODE>
* <BR />
* The targetId of DevTools page target.
* </DIV>
*/
public static Script<String> openDevTools(String targetId)
{
// Build the JSON Request-Object (as a String); only 1 Parameter is passed
final String requestJSON = WriteJSON.get
(CDPTypes.STRING, "targetId", false, "Target.openDevTools", targetId);
return new Script<>(
Domains.Target, "openDevTools", requestJSON,
jo -> ReadJSON.getString(jo, "targetId", true, false),
String.class
);
}
/**
* Sends protocol message over session with given id.
* Consider using flat mode instead; see commands attachToTarget, setAutoAttach,
* and crbug.com/991325.
*
* <BR /><B CLASS=Dep-Top>DEPRECATED</B>
*
* @param message -
*
* @param sessionId Identifier of the session.
* <BR /><B CLASS=Opt-Top>OPTIONAL</B>
*
* @param targetId Deprecated.
* <BR /><B CLASS=Opt-Top>OPTIONAL</B><B CLASS=Dep-Top>DEPRECATED</B>
*
* @return An instance of <CODE>{@link Script}<Void></CODE>
*
* <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
* browser receives the invocation-request.
*
* <BR /><BR /><DIV CLASS=JDHint>
* This Browser-Function <I>does not have</I> a return-value. You may choose to
* <B STYLE='color: red'>await</B> the {@link Promise}{@code <Void>} to ensure that
* the Browser Function has run to completion.
* </DIV>
*/
public static Script<Void> sendMessageToTarget
(String message, String sessionId, String targetId)
{
// Convert all Method Parameters into a JSON Request-Object (as a String)
final String requestJSON = WriteJSON.get(
Target$$Commands.sendMessageToTarget$$, "Target.sendMessageToTarget",
message, sessionId, targetId
);
return Script.NO_RET(Domains.Target, "sendMessageToTarget", requestJSON);
}
/**
* Controls whether to automatically attach to new targets which are considered
* to be directly related to this one (for example, iframes or workers).
* When turned on, attaches to all existing related targets as well. When turned off,
* automatically detaches from all currently attached targets.
* This also clears all targets added by <CODE>autoAttachRelated</CODE> from the list of targets to watch
* for creation of related targets.
* You might want to call this recursively for auto-attached targets to attach
* to all available targets.
*
* @param autoAttach Whether to auto-attach to related targets.
*
* @param waitForDebuggerOnStart
* Whether to pause new targets when attaching to them. Use <CODE>RunTime.runIfWaitingForDebugger</CODE>
* to run paused targets.
*
* @param flatten
* Enables "flat" access to the session via specifying sessionId attribute in the commands.
* We plan to make this the default, deprecate non-flattened mode,
* and eventually retire it. See crbug.com/991325.
* <BR /><B CLASS=Opt-Top>OPTIONAL</B><B CLASS=Exp-Top>EXPERIMENTAL</B>
*
* @param filter Only targets matching filter will be attached.
* <BR /><B CLASS=Opt-Top>OPTIONAL</B><B CLASS=Exp-Top>EXPERIMENTAL</B>
*
* @return An instance of <CODE>{@link Script}<Void></CODE>
*
* <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
* browser receives the invocation-request.
*
* <BR /><BR /><DIV CLASS=JDHint>
* This Browser-Function <I>does not have</I> a return-value. You may choose to
* <B STYLE='color: red'>await</B> the {@link Promise}{@code <Void>} to ensure that
* the Browser Function has run to completion.
* </DIV>
*/
public static Script<Void> setAutoAttach
(boolean autoAttach, boolean waitForDebuggerOnStart, Boolean flatten, FilterEntry[] filter)
{
// Convert all Method Parameters into a JSON Request-Object (as a String)
final String requestJSON = WriteJSON.get(
Target$$Commands.setAutoAttach$$, "Target.setAutoAttach",
autoAttach, waitForDebuggerOnStart, flatten, filter
);
return Script.NO_RET(Domains.Target, "setAutoAttach", requestJSON);
}
/**
* Controls whether to discover available targets and notify via
* <CODE>targetCreated/targetInfoChanged/targetDestroyed</CODE> events.
*
* @param discover Whether to discover available targets.
*
* @param filter
* Only targets matching filter will be attached. If <CODE>discover</CODE> is false,
* <CODE>filter</CODE> must be omitted or empty.
* <BR /><B CLASS=Opt-Top>OPTIONAL</B><B CLASS=Exp-Top>EXPERIMENTAL</B>
*
* @return An instance of <CODE>{@link Script}<Void></CODE>
*
* <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
* browser receives the invocation-request.
*
* <BR /><BR /><DIV CLASS=JDHint>
* This Browser-Function <I>does not have</I> a return-value. You may choose to
* <B STYLE='color: red'>await</B> the {@link Promise}{@code <Void>} to ensure that
* the Browser Function has run to completion.
* </DIV>
*/
public static Script<Void> setDiscoverTargets(boolean discover, FilterEntry[] filter)
{
// Convert all Method Parameters into a JSON Request-Object (as a String)
final String requestJSON = WriteJSON.get(
Target$$Commands.setDiscoverTargets$$, "Target.setDiscoverTargets",
discover, filter
);
return Script.NO_RET(Domains.Target, "setDiscoverTargets", requestJSON);
}
/**
* Enables target discovery for the specified locations, when <CODE>setDiscoverTargets</CODE> was set to
* <CODE>true</CODE>.
*
* <BR /><B CLASS=Exp-Top>EXPERIMENTAL</B>
*
* @param locations List of remote locations.
*
* @return An instance of <CODE>{@link Script}<Void></CODE>
*
* <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
* browser receives the invocation-request.
*
* <BR /><BR /><DIV CLASS=JDHint>
* This Browser-Function <I>does not have</I> a return-value. You may choose to
* <B STYLE='color: red'>await</B> the {@link Promise}{@code <Void>} to ensure that
* the Browser Function has run to completion.
* </DIV>
*/
public static Script<Void> setRemoteLocations(RemoteLocation[] locations)
{
// Build the JSON Request-Object (as a String); only 1 Parameter is passed
final String requestJSON = WriteJSON.get(
CDPTypes.CDP_TYPE_ARRAY_1D, "locations", false, "Target.setRemoteLocations",
(Object) locations
);
return Script.NO_RET(Domains.Target, "setRemoteLocations", requestJSON);
}
// ********************************************************************************************
// ********************************************************************************************
// CommandBuilder Getter-Methods
// ********************************************************************************************
// ********************************************************************************************
/**
* Creates a buider for conveniently assigning parameters to this method.
*
* <BR /><BR /><DIV CLASS=JDHint>
* Note that the original method expects 12 parameters, and can be cumbersome.
* </DIV>
*
* @return {@link CommandBuilder} instance, for assigning parameter values, one by one.
* @see #createTarget
*/
public static CommandBuilder<String> createTarget()
{ return CommandBuilder.builder(Target$$Commands.createTarget$$); }
}
|