forked from chromedp/cdproto
/
runtime.go
710 lines (614 loc) · 29.3 KB
/
runtime.go
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
// Package runtime provides the Chrome Debugging Protocol
// commands, types, and events for the Runtime domain.
//
// Runtime domain exposes JavaScript runtime by means of remote evaluation
// and mirror objects. Evaluation results are returned as mirror object that
// expose object type, string representation and unique identifier that can be
// used for further object reference. Original objects are maintained in memory
// unless they are either explicitly released or are released along with the
// other objects in their object group.
//
// Generated by the chromedp-gen command.
package runtime
// Code generated by chromedp-gen. DO NOT EDIT.
import (
"context"
"github.com/jbegley1995/cdproto/cdp"
)
// AwaitPromiseParams add handler to promise with given promise object id.
type AwaitPromiseParams struct {
PromiseObjectID RemoteObjectID `json:"promiseObjectId"` // Identifier of the promise.
ReturnByValue bool `json:"returnByValue,omitempty"` // Whether the result is expected to be a JSON object that should be sent by value.
GeneratePreview bool `json:"generatePreview,omitempty"` // Whether preview should be generated for the result.
}
// AwaitPromise add handler to promise with given promise object id.
//
// parameters:
// promiseObjectID - Identifier of the promise.
func AwaitPromise(promiseObjectID RemoteObjectID) *AwaitPromiseParams {
return &AwaitPromiseParams{
PromiseObjectID: promiseObjectID,
}
}
// WithReturnByValue whether the result is expected to be a JSON object that
// should be sent by value.
func (p AwaitPromiseParams) WithReturnByValue(returnByValue bool) *AwaitPromiseParams {
p.ReturnByValue = returnByValue
return &p
}
// WithGeneratePreview whether preview should be generated for the result.
func (p AwaitPromiseParams) WithGeneratePreview(generatePreview bool) *AwaitPromiseParams {
p.GeneratePreview = generatePreview
return &p
}
// AwaitPromiseReturns return values.
type AwaitPromiseReturns struct {
Result *RemoteObject `json:"result,omitempty"` // Promise result. Will contain rejected value if promise was rejected.
ExceptionDetails *ExceptionDetails `json:"exceptionDetails,omitempty"` // Exception details if stack strace is available.
}
// Do executes Runtime.awaitPromise against the provided context.
//
// returns:
// result - Promise result. Will contain rejected value if promise was rejected.
// exceptionDetails - Exception details if stack strace is available.
func (p *AwaitPromiseParams) Do(ctxt context.Context, h cdp.Executor) (result *RemoteObject, exceptionDetails *ExceptionDetails, err error) {
// execute
var res AwaitPromiseReturns
err = h.Execute(ctxt, CommandAwaitPromise, p, &res)
if err != nil {
return nil, nil, err
}
return res.Result, res.ExceptionDetails, nil
}
// CallFunctionOnParams calls function with given declaration on the given
// object. Object group of the result is inherited from the target object.
type CallFunctionOnParams struct {
FunctionDeclaration string `json:"functionDeclaration"` // Declaration of the function to call.
ObjectID RemoteObjectID `json:"objectId,omitempty"` // Identifier of the object to call function on. Either objectId or executionContextId should be specified.
Arguments []*CallArgument `json:"arguments,omitempty"` // Call arguments. All call arguments must belong to the same JavaScript world as the target object.
Silent bool `json:"silent,omitempty"` // In silent mode exceptions thrown during evaluation are not reported and do not pause execution. Overrides setPauseOnException state.
ReturnByValue bool `json:"returnByValue,omitempty"` // Whether the result is expected to be a JSON object which should be sent by value.
GeneratePreview bool `json:"generatePreview,omitempty"` // Whether preview should be generated for the result.
UserGesture bool `json:"userGesture,omitempty"` // Whether execution should be treated as initiated by user in the UI.
AwaitPromise bool `json:"awaitPromise,omitempty"` // Whether execution should await for resulting value and return once awaited promise is resolved.
ExecutionContextID ExecutionContextID `json:"executionContextId,omitempty"` // Specifies execution context which global object will be used to call function on. Either executionContextId or objectId should be specified.
ObjectGroup string `json:"objectGroup,omitempty"` // Symbolic group name that can be used to release multiple objects. If objectGroup is not specified and objectId is, objectGroup will be inherited from object.
}
// CallFunctionOn calls function with given declaration on the given object.
// Object group of the result is inherited from the target object.
//
// parameters:
// functionDeclaration - Declaration of the function to call.
func CallFunctionOn(functionDeclaration string) *CallFunctionOnParams {
return &CallFunctionOnParams{
FunctionDeclaration: functionDeclaration,
}
}
// WithObjectID identifier of the object to call function on. Either objectId
// or executionContextId should be specified.
func (p CallFunctionOnParams) WithObjectID(objectID RemoteObjectID) *CallFunctionOnParams {
p.ObjectID = objectID
return &p
}
// WithArguments call arguments. All call arguments must belong to the same
// JavaScript world as the target object.
func (p CallFunctionOnParams) WithArguments(arguments []*CallArgument) *CallFunctionOnParams {
p.Arguments = arguments
return &p
}
// WithSilent in silent mode exceptions thrown during evaluation are not
// reported and do not pause execution. Overrides setPauseOnException state.
func (p CallFunctionOnParams) WithSilent(silent bool) *CallFunctionOnParams {
p.Silent = silent
return &p
}
// WithReturnByValue whether the result is expected to be a JSON object which
// should be sent by value.
func (p CallFunctionOnParams) WithReturnByValue(returnByValue bool) *CallFunctionOnParams {
p.ReturnByValue = returnByValue
return &p
}
// WithGeneratePreview whether preview should be generated for the result.
func (p CallFunctionOnParams) WithGeneratePreview(generatePreview bool) *CallFunctionOnParams {
p.GeneratePreview = generatePreview
return &p
}
// WithUserGesture whether execution should be treated as initiated by user
// in the UI.
func (p CallFunctionOnParams) WithUserGesture(userGesture bool) *CallFunctionOnParams {
p.UserGesture = userGesture
return &p
}
// WithAwaitPromise whether execution should await for resulting value and
// return once awaited promise is resolved.
func (p CallFunctionOnParams) WithAwaitPromise(awaitPromise bool) *CallFunctionOnParams {
p.AwaitPromise = awaitPromise
return &p
}
// WithExecutionContextID specifies execution context which global object
// will be used to call function on. Either executionContextId or objectId
// should be specified.
func (p CallFunctionOnParams) WithExecutionContextID(executionContextID ExecutionContextID) *CallFunctionOnParams {
p.ExecutionContextID = executionContextID
return &p
}
// WithObjectGroup symbolic group name that can be used to release multiple
// objects. If objectGroup is not specified and objectId is, objectGroup will be
// inherited from object.
func (p CallFunctionOnParams) WithObjectGroup(objectGroup string) *CallFunctionOnParams {
p.ObjectGroup = objectGroup
return &p
}
// CallFunctionOnReturns return values.
type CallFunctionOnReturns struct {
Result *RemoteObject `json:"result,omitempty"` // Call result.
ExceptionDetails *ExceptionDetails `json:"exceptionDetails,omitempty"` // Exception details.
}
// Do executes Runtime.callFunctionOn against the provided context.
//
// returns:
// result - Call result.
// exceptionDetails - Exception details.
func (p *CallFunctionOnParams) Do(ctxt context.Context, h cdp.Executor) (result *RemoteObject, exceptionDetails *ExceptionDetails, err error) {
// execute
var res CallFunctionOnReturns
err = h.Execute(ctxt, CommandCallFunctionOn, p, &res)
if err != nil {
return nil, nil, err
}
return res.Result, res.ExceptionDetails, nil
}
// CompileScriptParams compiles expression.
type CompileScriptParams struct {
Expression string `json:"expression"` // Expression to compile.
SourceURL string `json:"sourceURL"` // Source url to be set for the script.
PersistScript bool `json:"persistScript"` // Specifies whether the compiled script should be persisted.
ExecutionContextID ExecutionContextID `json:"executionContextId,omitempty"` // Specifies in which execution context to perform script run. If the parameter is omitted the evaluation will be performed in the context of the inspected page.
}
// CompileScript compiles expression.
//
// parameters:
// expression - Expression to compile.
// sourceURL - Source url to be set for the script.
// persistScript - Specifies whether the compiled script should be persisted.
func CompileScript(expression string, sourceURL string, persistScript bool) *CompileScriptParams {
return &CompileScriptParams{
Expression: expression,
SourceURL: sourceURL,
PersistScript: persistScript,
}
}
// WithExecutionContextID specifies in which execution context to perform
// script run. If the parameter is omitted the evaluation will be performed in
// the context of the inspected page.
func (p CompileScriptParams) WithExecutionContextID(executionContextID ExecutionContextID) *CompileScriptParams {
p.ExecutionContextID = executionContextID
return &p
}
// CompileScriptReturns return values.
type CompileScriptReturns struct {
ScriptID ScriptID `json:"scriptId,omitempty"` // Id of the script.
ExceptionDetails *ExceptionDetails `json:"exceptionDetails,omitempty"` // Exception details.
}
// Do executes Runtime.compileScript against the provided context.
//
// returns:
// scriptID - Id of the script.
// exceptionDetails - Exception details.
func (p *CompileScriptParams) Do(ctxt context.Context, h cdp.Executor) (scriptID ScriptID, exceptionDetails *ExceptionDetails, err error) {
// execute
var res CompileScriptReturns
err = h.Execute(ctxt, CommandCompileScript, p, &res)
if err != nil {
return "", nil, err
}
return res.ScriptID, res.ExceptionDetails, nil
}
// DisableParams disables reporting of execution contexts creation.
type DisableParams struct{}
// Disable disables reporting of execution contexts creation.
func Disable() *DisableParams {
return &DisableParams{}
}
// Do executes Runtime.disable against the provided context.
func (p *DisableParams) Do(ctxt context.Context, h cdp.Executor) (err error) {
return h.Execute(ctxt, CommandDisable, nil, nil)
}
// DiscardConsoleEntriesParams discards collected exceptions and console API
// calls.
type DiscardConsoleEntriesParams struct{}
// DiscardConsoleEntries discards collected exceptions and console API calls.
func DiscardConsoleEntries() *DiscardConsoleEntriesParams {
return &DiscardConsoleEntriesParams{}
}
// Do executes Runtime.discardConsoleEntries against the provided context.
func (p *DiscardConsoleEntriesParams) Do(ctxt context.Context, h cdp.Executor) (err error) {
return h.Execute(ctxt, CommandDiscardConsoleEntries, nil, nil)
}
// EnableParams enables reporting of execution contexts creation by means of
// executionContextCreated event. When the reporting gets enabled the event will
// be sent immediately for each existing execution context.
type EnableParams struct{}
// Enable enables reporting of execution contexts creation by means of
// executionContextCreated event. When the reporting gets enabled the event will
// be sent immediately for each existing execution context.
func Enable() *EnableParams {
return &EnableParams{}
}
// Do executes Runtime.enable against the provided context.
func (p *EnableParams) Do(ctxt context.Context, h cdp.Executor) (err error) {
return h.Execute(ctxt, CommandEnable, nil, nil)
}
// EvaluateParams evaluates expression on global object.
type EvaluateParams struct {
Expression string `json:"expression"` // Expression to evaluate.
ObjectGroup string `json:"objectGroup,omitempty"` // Symbolic group name that can be used to release multiple objects.
IncludeCommandLineAPI bool `json:"includeCommandLineAPI,omitempty"` // Determines whether Command Line API should be available during the evaluation.
Silent bool `json:"silent,omitempty"` // In silent mode exceptions thrown during evaluation are not reported and do not pause execution. Overrides setPauseOnException state.
ContextID ExecutionContextID `json:"contextId,omitempty"` // Specifies in which execution context to perform evaluation. If the parameter is omitted the evaluation will be performed in the context of the inspected page.
ReturnByValue bool `json:"returnByValue,omitempty"` // Whether the result is expected to be a JSON object that should be sent by value.
GeneratePreview bool `json:"generatePreview,omitempty"` // Whether preview should be generated for the result.
UserGesture bool `json:"userGesture,omitempty"` // Whether execution should be treated as initiated by user in the UI.
AwaitPromise bool `json:"awaitPromise,omitempty"` // Whether execution should await for resulting value and return once awaited promise is resolved.
}
// Evaluate evaluates expression on global object.
//
// parameters:
// expression - Expression to evaluate.
func Evaluate(expression string) *EvaluateParams {
return &EvaluateParams{
Expression: expression,
}
}
// WithObjectGroup symbolic group name that can be used to release multiple
// objects.
func (p EvaluateParams) WithObjectGroup(objectGroup string) *EvaluateParams {
p.ObjectGroup = objectGroup
return &p
}
// WithIncludeCommandLineAPI determines whether Command Line API should be
// available during the evaluation.
func (p EvaluateParams) WithIncludeCommandLineAPI(includeCommandLineAPI bool) *EvaluateParams {
p.IncludeCommandLineAPI = includeCommandLineAPI
return &p
}
// WithSilent in silent mode exceptions thrown during evaluation are not
// reported and do not pause execution. Overrides setPauseOnException state.
func (p EvaluateParams) WithSilent(silent bool) *EvaluateParams {
p.Silent = silent
return &p
}
// WithContextID specifies in which execution context to perform evaluation.
// If the parameter is omitted the evaluation will be performed in the context
// of the inspected page.
func (p EvaluateParams) WithContextID(contextID ExecutionContextID) *EvaluateParams {
p.ContextID = contextID
return &p
}
// WithReturnByValue whether the result is expected to be a JSON object that
// should be sent by value.
func (p EvaluateParams) WithReturnByValue(returnByValue bool) *EvaluateParams {
p.ReturnByValue = returnByValue
return &p
}
// WithGeneratePreview whether preview should be generated for the result.
func (p EvaluateParams) WithGeneratePreview(generatePreview bool) *EvaluateParams {
p.GeneratePreview = generatePreview
return &p
}
// WithUserGesture whether execution should be treated as initiated by user
// in the UI.
func (p EvaluateParams) WithUserGesture(userGesture bool) *EvaluateParams {
p.UserGesture = userGesture
return &p
}
// WithAwaitPromise whether execution should await for resulting value and
// return once awaited promise is resolved.
func (p EvaluateParams) WithAwaitPromise(awaitPromise bool) *EvaluateParams {
p.AwaitPromise = awaitPromise
return &p
}
// EvaluateReturns return values.
type EvaluateReturns struct {
Result *RemoteObject `json:"result,omitempty"` // Evaluation result.
ExceptionDetails *ExceptionDetails `json:"exceptionDetails,omitempty"` // Exception details.
}
// Do executes Runtime.evaluate against the provided context.
//
// returns:
// result - Evaluation result.
// exceptionDetails - Exception details.
func (p *EvaluateParams) Do(ctxt context.Context, h cdp.Executor) (result *RemoteObject, exceptionDetails *ExceptionDetails, err error) {
// execute
var res EvaluateReturns
err = h.Execute(ctxt, CommandEvaluate, p, &res)
if err != nil {
return nil, nil, err
}
return res.Result, res.ExceptionDetails, nil
}
// GetPropertiesParams returns properties of a given object. Object group of
// the result is inherited from the target object.
type GetPropertiesParams struct {
ObjectID RemoteObjectID `json:"objectId"` // Identifier of the object to return properties for.
OwnProperties bool `json:"ownProperties,omitempty"` // If true, returns properties belonging only to the element itself, not to its prototype chain.
AccessorPropertiesOnly bool `json:"accessorPropertiesOnly,omitempty"` // If true, returns accessor properties (with getter/setter) only; internal properties are not returned either.
GeneratePreview bool `json:"generatePreview,omitempty"` // Whether preview should be generated for the results.
}
// GetProperties returns properties of a given object. Object group of the
// result is inherited from the target object.
//
// parameters:
// objectID - Identifier of the object to return properties for.
func GetProperties(objectID RemoteObjectID) *GetPropertiesParams {
return &GetPropertiesParams{
ObjectID: objectID,
}
}
// WithOwnProperties if true, returns properties belonging only to the
// element itself, not to its prototype chain.
func (p GetPropertiesParams) WithOwnProperties(ownProperties bool) *GetPropertiesParams {
p.OwnProperties = ownProperties
return &p
}
// WithAccessorPropertiesOnly if true, returns accessor properties (with
// getter/setter) only; internal properties are not returned either.
func (p GetPropertiesParams) WithAccessorPropertiesOnly(accessorPropertiesOnly bool) *GetPropertiesParams {
p.AccessorPropertiesOnly = accessorPropertiesOnly
return &p
}
// WithGeneratePreview whether preview should be generated for the results.
func (p GetPropertiesParams) WithGeneratePreview(generatePreview bool) *GetPropertiesParams {
p.GeneratePreview = generatePreview
return &p
}
// GetPropertiesReturns return values.
type GetPropertiesReturns struct {
Result []*PropertyDescriptor `json:"result,omitempty"` // Object properties.
InternalProperties []*InternalPropertyDescriptor `json:"internalProperties,omitempty"` // Internal object properties (only of the element itself).
ExceptionDetails *ExceptionDetails `json:"exceptionDetails,omitempty"` // Exception details.
}
// Do executes Runtime.getProperties against the provided context.
//
// returns:
// result - Object properties.
// internalProperties - Internal object properties (only of the element itself).
// exceptionDetails - Exception details.
func (p *GetPropertiesParams) Do(ctxt context.Context, h cdp.Executor) (result []*PropertyDescriptor, internalProperties []*InternalPropertyDescriptor, exceptionDetails *ExceptionDetails, err error) {
// execute
var res GetPropertiesReturns
err = h.Execute(ctxt, CommandGetProperties, p, &res)
if err != nil {
return nil, nil, nil, err
}
return res.Result, res.InternalProperties, res.ExceptionDetails, nil
}
// GlobalLexicalScopeNamesParams returns all let, const and class variables
// from global scope.
type GlobalLexicalScopeNamesParams struct {
ExecutionContextID ExecutionContextID `json:"executionContextId,omitempty"` // Specifies in which execution context to lookup global scope variables.
}
// GlobalLexicalScopeNames returns all let, const and class variables from
// global scope.
//
// parameters:
func GlobalLexicalScopeNames() *GlobalLexicalScopeNamesParams {
return &GlobalLexicalScopeNamesParams{}
}
// WithExecutionContextID specifies in which execution context to lookup
// global scope variables.
func (p GlobalLexicalScopeNamesParams) WithExecutionContextID(executionContextID ExecutionContextID) *GlobalLexicalScopeNamesParams {
p.ExecutionContextID = executionContextID
return &p
}
// GlobalLexicalScopeNamesReturns return values.
type GlobalLexicalScopeNamesReturns struct {
Names []string `json:"names,omitempty"`
}
// Do executes Runtime.globalLexicalScopeNames against the provided context.
//
// returns:
// names
func (p *GlobalLexicalScopeNamesParams) Do(ctxt context.Context, h cdp.Executor) (names []string, err error) {
// execute
var res GlobalLexicalScopeNamesReturns
err = h.Execute(ctxt, CommandGlobalLexicalScopeNames, p, &res)
if err != nil {
return nil, err
}
return res.Names, nil
}
// QueryObjectsParams [no description].
type QueryObjectsParams struct {
PrototypeObjectID RemoteObjectID `json:"prototypeObjectId"` // Identifier of the prototype to return objects for.
}
// QueryObjects [no description].
//
// parameters:
// prototypeObjectID - Identifier of the prototype to return objects for.
func QueryObjects(prototypeObjectID RemoteObjectID) *QueryObjectsParams {
return &QueryObjectsParams{
PrototypeObjectID: prototypeObjectID,
}
}
// QueryObjectsReturns return values.
type QueryObjectsReturns struct {
Objects *RemoteObject `json:"objects,omitempty"` // Array with objects.
}
// Do executes Runtime.queryObjects against the provided context.
//
// returns:
// objects - Array with objects.
func (p *QueryObjectsParams) Do(ctxt context.Context, h cdp.Executor) (objects *RemoteObject, err error) {
// execute
var res QueryObjectsReturns
err = h.Execute(ctxt, CommandQueryObjects, p, &res)
if err != nil {
return nil, err
}
return res.Objects, nil
}
// ReleaseObjectParams releases remote object with given id.
type ReleaseObjectParams struct {
ObjectID RemoteObjectID `json:"objectId"` // Identifier of the object to release.
}
// ReleaseObject releases remote object with given id.
//
// parameters:
// objectID - Identifier of the object to release.
func ReleaseObject(objectID RemoteObjectID) *ReleaseObjectParams {
return &ReleaseObjectParams{
ObjectID: objectID,
}
}
// Do executes Runtime.releaseObject against the provided context.
func (p *ReleaseObjectParams) Do(ctxt context.Context, h cdp.Executor) (err error) {
return h.Execute(ctxt, CommandReleaseObject, p, nil)
}
// ReleaseObjectGroupParams releases all remote objects that belong to a
// given group.
type ReleaseObjectGroupParams struct {
ObjectGroup string `json:"objectGroup"` // Symbolic object group name.
}
// ReleaseObjectGroup releases all remote objects that belong to a given
// group.
//
// parameters:
// objectGroup - Symbolic object group name.
func ReleaseObjectGroup(objectGroup string) *ReleaseObjectGroupParams {
return &ReleaseObjectGroupParams{
ObjectGroup: objectGroup,
}
}
// Do executes Runtime.releaseObjectGroup against the provided context.
func (p *ReleaseObjectGroupParams) Do(ctxt context.Context, h cdp.Executor) (err error) {
return h.Execute(ctxt, CommandReleaseObjectGroup, p, nil)
}
// RunIfWaitingForDebuggerParams tells inspected instance to run if it was
// waiting for debugger to attach.
type RunIfWaitingForDebuggerParams struct{}
// RunIfWaitingForDebugger tells inspected instance to run if it was waiting
// for debugger to attach.
func RunIfWaitingForDebugger() *RunIfWaitingForDebuggerParams {
return &RunIfWaitingForDebuggerParams{}
}
// Do executes Runtime.runIfWaitingForDebugger against the provided context.
func (p *RunIfWaitingForDebuggerParams) Do(ctxt context.Context, h cdp.Executor) (err error) {
return h.Execute(ctxt, CommandRunIfWaitingForDebugger, nil, nil)
}
// RunScriptParams runs script with given id in a given context.
type RunScriptParams struct {
ScriptID ScriptID `json:"scriptId"` // Id of the script to run.
ExecutionContextID ExecutionContextID `json:"executionContextId,omitempty"` // Specifies in which execution context to perform script run. If the parameter is omitted the evaluation will be performed in the context of the inspected page.
ObjectGroup string `json:"objectGroup,omitempty"` // Symbolic group name that can be used to release multiple objects.
Silent bool `json:"silent,omitempty"` // In silent mode exceptions thrown during evaluation are not reported and do not pause execution. Overrides setPauseOnException state.
IncludeCommandLineAPI bool `json:"includeCommandLineAPI,omitempty"` // Determines whether Command Line API should be available during the evaluation.
ReturnByValue bool `json:"returnByValue,omitempty"` // Whether the result is expected to be a JSON object which should be sent by value.
GeneratePreview bool `json:"generatePreview,omitempty"` // Whether preview should be generated for the result.
AwaitPromise bool `json:"awaitPromise,omitempty"` // Whether execution should await for resulting value and return once awaited promise is resolved.
}
// RunScript runs script with given id in a given context.
//
// parameters:
// scriptID - Id of the script to run.
func RunScript(scriptID ScriptID) *RunScriptParams {
return &RunScriptParams{
ScriptID: scriptID,
}
}
// WithExecutionContextID specifies in which execution context to perform
// script run. If the parameter is omitted the evaluation will be performed in
// the context of the inspected page.
func (p RunScriptParams) WithExecutionContextID(executionContextID ExecutionContextID) *RunScriptParams {
p.ExecutionContextID = executionContextID
return &p
}
// WithObjectGroup symbolic group name that can be used to release multiple
// objects.
func (p RunScriptParams) WithObjectGroup(objectGroup string) *RunScriptParams {
p.ObjectGroup = objectGroup
return &p
}
// WithSilent in silent mode exceptions thrown during evaluation are not
// reported and do not pause execution. Overrides setPauseOnException state.
func (p RunScriptParams) WithSilent(silent bool) *RunScriptParams {
p.Silent = silent
return &p
}
// WithIncludeCommandLineAPI determines whether Command Line API should be
// available during the evaluation.
func (p RunScriptParams) WithIncludeCommandLineAPI(includeCommandLineAPI bool) *RunScriptParams {
p.IncludeCommandLineAPI = includeCommandLineAPI
return &p
}
// WithReturnByValue whether the result is expected to be a JSON object which
// should be sent by value.
func (p RunScriptParams) WithReturnByValue(returnByValue bool) *RunScriptParams {
p.ReturnByValue = returnByValue
return &p
}
// WithGeneratePreview whether preview should be generated for the result.
func (p RunScriptParams) WithGeneratePreview(generatePreview bool) *RunScriptParams {
p.GeneratePreview = generatePreview
return &p
}
// WithAwaitPromise whether execution should await for resulting value and
// return once awaited promise is resolved.
func (p RunScriptParams) WithAwaitPromise(awaitPromise bool) *RunScriptParams {
p.AwaitPromise = awaitPromise
return &p
}
// RunScriptReturns return values.
type RunScriptReturns struct {
Result *RemoteObject `json:"result,omitempty"` // Run result.
ExceptionDetails *ExceptionDetails `json:"exceptionDetails,omitempty"` // Exception details.
}
// Do executes Runtime.runScript against the provided context.
//
// returns:
// result - Run result.
// exceptionDetails - Exception details.
func (p *RunScriptParams) Do(ctxt context.Context, h cdp.Executor) (result *RemoteObject, exceptionDetails *ExceptionDetails, err error) {
// execute
var res RunScriptReturns
err = h.Execute(ctxt, CommandRunScript, p, &res)
if err != nil {
return nil, nil, err
}
return res.Result, res.ExceptionDetails, nil
}
// SetCustomObjectFormatterEnabledParams [no description].
type SetCustomObjectFormatterEnabledParams struct {
Enabled bool `json:"enabled"`
}
// SetCustomObjectFormatterEnabled [no description].
//
// parameters:
// enabled
func SetCustomObjectFormatterEnabled(enabled bool) *SetCustomObjectFormatterEnabledParams {
return &SetCustomObjectFormatterEnabledParams{
Enabled: enabled,
}
}
// Do executes Runtime.setCustomObjectFormatterEnabled against the provided context.
func (p *SetCustomObjectFormatterEnabledParams) Do(ctxt context.Context, h cdp.Executor) (err error) {
return h.Execute(ctxt, CommandSetCustomObjectFormatterEnabled, p, nil)
}
// Command names.
const (
CommandAwaitPromise = "Runtime.awaitPromise"
CommandCallFunctionOn = "Runtime.callFunctionOn"
CommandCompileScript = "Runtime.compileScript"
CommandDisable = "Runtime.disable"
CommandDiscardConsoleEntries = "Runtime.discardConsoleEntries"
CommandEnable = "Runtime.enable"
CommandEvaluate = "Runtime.evaluate"
CommandGetProperties = "Runtime.getProperties"
CommandGlobalLexicalScopeNames = "Runtime.globalLexicalScopeNames"
CommandQueryObjects = "Runtime.queryObjects"
CommandReleaseObject = "Runtime.releaseObject"
CommandReleaseObjectGroup = "Runtime.releaseObjectGroup"
CommandRunIfWaitingForDebugger = "Runtime.runIfWaitingForDebugger"
CommandRunScript = "Runtime.runScript"
CommandSetCustomObjectFormatterEnabled = "Runtime.setCustomObjectFormatterEnabled"
)