cad53c7da1f450a0d605b6663d1ec1b8d0903090
[WebKit-https.git] / Source / WebKit / UIProcess / Automation / Automation.json
1 {
2     "domain": "Automation",
3     "description": "Automation domain exposes commands for automating user interactions with the browser.",
4     "types": [
5         {
6             "id": "Point",
7             "type": "object",
8             "properties": [
9                 { "name": "x", "type": "number" },
10                 { "name": "y", "type": "number" }
11             ]
12         },
13         {
14             "id": "Size",
15             "type": "object",
16             "properties": [
17                 { "name": "width", "type": "number" },
18                 { "name": "height", "type": "number" }
19             ]
20         },
21         {
22             "id": "Rect",
23             "type": "object",
24             "properties": [
25                 { "name": "origin", "$ref": "Point" },
26                 { "name": "size", "$ref": "Size" }
27             ]
28         },
29         {
30             "id": "CoordinateSystem",
31             "type": "string",
32             "description": "The coordinate system in which rects, points, and sizes are to be interpreted.",
33             "enum": [
34                 "Page",
35                 "LayoutViewport"
36             ]
37         },
38         {
39             "id": "BrowsingContextHandle",
40             "type": "string",
41             "description": "An opaque identifier for a browsing context."
42         },
43         {
44             "id": "BrowsingContextPresentation",
45             "type": "string",
46             "description": "How a browsing context is presented by the user agent. A browsing context is considered a tab if it shares an OS-level window with another browsing context.",
47             "enum": [
48                 "Window",
49                 "Tab"
50             ]
51         },
52         {
53             "id": "FrameHandle",
54             "type": "string",
55             "description": "An opaque identifier for a frame in a page."
56         },
57         {
58             "id": "NodeHandle",
59             "type": "string",
60             "description": "An opaque identifier for a node in a page."
61         },
62         {
63             "id": "ErrorMessage",
64             "type": "string",
65             "description": "This enum contains predefined error messages that can be used to signal a well-defined error condition, such as a missing implementation, unknown window handle, and so forth. The backend signals one of these errors by using it as a prefix of the commands's error message (the errorString argument in generated C++ backend dispatchers). This will be reported to the frontend as a protocol error with a JSON-RPC error code of 'ServerError'. It is up to the frontend whether and how to deal with errors.",
66             "enum": [
67                 "InternalError",
68                 "Timeout",
69                 "JavaScriptError",
70                 "JavaScriptTimeout",
71                 "WindowNotFound",
72                 "FrameNotFound",
73                 "NodeNotFound",
74                 "InvalidElementState",
75                 "NoJavaScriptDialog",
76                 "NotImplemented",
77                 "MissingParameter",
78                 "InvalidParameter",
79                 "InvalidSelector",
80                 "ElementNotInteractable",
81                 "ElementNotSelectable",
82                 "ScreenshotError",
83                 "UnexpectedAlertOpen",
84                 "TargetOutOfBounds"
85             ]
86         },
87         {
88             "id": "PageLoadStrategy",
89             "type": "string",
90             "description": "Enumerates different page load strategies.",
91             "enum": [
92                 "None",
93                 "Eager",
94                 "Normal"
95             ]
96         },
97         {
98             "id": "BrowsingContext",
99             "type": "object",
100             "description": "A handle representing an open window or tab in the automation session.",
101             "properties": [
102                 { "name": "handle", "$ref": "BrowsingContextHandle", "description": "Opaque handle for a browsing context (window or tab). Used as a key for window-related commands." },
103                 { "name": "active", "type": "boolean", "description": "Whether the browsing context has focus at the time the command is handled." },
104                 { "name": "url", "type": "string", "description": "The URL loaded by the browsing context at the time the command is handled." },
105                 { "name": "windowSize", "$ref": "Size", "description": "The current size of the browsing context's window." },
106                 { "name": "windowOrigin", "$ref": "Point", "description": "The current (x, y) position of the browsing context's window relative to the top-left of the screen." }
107             ]
108         },
109         {
110             "id": "MouseInteraction",
111             "type": "string",
112             "description": "Enumerates different ways of interacting with a mouse cursor.",
113             "enum": [
114                 "Move",
115                 "Down",
116                 "Up",
117                 "SingleClick",
118                 "DoubleClick"
119             ]
120         },
121         {
122             "id": "MouseButton",
123             "type": "string",
124             "description": "Enumerates different mouse buttons that can be used.",
125             "enum": [
126                 "None",
127                 "Left",
128                 "Middle",
129                 "Right"
130             ]
131         },
132         {
133             "id": "KeyModifier",
134             "type": "string",
135             "description": "Enumerates different key modifiers that can remain pressed during other mouse/touch interactions.",
136             "enum": [
137                 "CapsLock",
138                 "Control",
139                 "Shift",
140                 "Meta",
141                 "Alt"
142             ]
143         },
144         {
145             "id": "VirtualKey",
146             "type": "string",
147             "description": "Enumerates different platform-independent virtual keys on a physical keyboard whose input via keyboard may or may not produce characters.",
148             "enum": [
149                 "Shift",
150                 "Control",
151                 "Alternate",
152                 "Meta",
153                 "Command",
154                 "Cancel",
155                 "Help",
156                 "Backspace",
157                 "Tab",
158                 "Clear",
159                 "Enter",
160                 "Pause",
161                 "Escape",
162                 "PageUp",
163                 "PageDown",
164                 "End",
165                 "Home",
166                 "LeftArrow",
167                 "UpArrow",
168                 "RightArrow",
169                 "DownArrow",
170                 "Insert",
171                 "Delete",
172                 "Space",
173                 "Semicolon",
174                 "Equals",
175                 "Return",
176                 "NumberPad0",
177                 "NumberPad1",
178                 "NumberPad2",
179                 "NumberPad3",
180                 "NumberPad4",
181                 "NumberPad5",
182                 "NumberPad6",
183                 "NumberPad7",
184                 "NumberPad8",
185                 "NumberPad9",
186                 "NumberPadMultiply",
187                 "NumberPadAdd",
188                 "NumberPadSeparator",
189                 "NumberPadSubtract",
190                 "NumberPadDecimal",
191                 "NumberPadDivide",
192                 "Function1",
193                 "Function2",
194                 "Function3",
195                 "Function4",
196                 "Function5",
197                 "Function6",
198                 "Function7",
199                 "Function8",
200                 "Function9",
201                 "Function10",
202                 "Function11",
203                 "Function12"
204             ]
205         },
206         {
207             "id": "KeyboardInteractionType",
208             "type": "string",
209             "description": "Enumerates different ways of interacting with a keyboard device. 'InsertByKey' implies that a separate KeyDown and KeyUp event are produced for each combining character sequence, regardless of the actual keystrokes required to produce the character sequence.",
210             "enum": [
211                 "KeyPress",
212                 "KeyRelease",
213                 "InsertByKey"
214             ]
215         },
216         {
217             "id": "KeyboardInteraction",
218             "type": "object",
219             "description": "A single step in a key sequence. A step can contain a key up/down of a virtual key, or a sequence of Unicode code points that are delivered to the page at grapheme cluster boundaries. Either a 'key' or 'text' property must be specified.",
220             "properties": [
221                 { "name": "type", "$ref": "KeyboardInteractionType", "description": "The type of interaction to be performed by a step." },
222                 { "name": "key", "$ref": "VirtualKey", "optional": true, "description": "A virtual key to be used to perform the specified interaction." },
223                 { "name": "text", "type": "string", "optional": true, "description": "A unicode string to be delivered to the page. The sequence of key events is determined by splitting the string at grapheme cluster boundaries." }
224             ]
225         },
226         {
227             "id": "Cookie",
228             "type": "object",
229             "properties": [
230                 { "name": "name", "type": "string", "description": "Cookie name." },
231                 { "name": "value", "type": "string", "description": "Cookie value." },
232                 { "name": "domain", "type": "string", "description": "Cookie domain. If empty, the domain is inherited from the relevant browsing context." },
233                 { "name": "path", "type": "string", "description": "Cookie path." },
234                 { "name": "expires", "type": "number", "description": "Cookie expiration in seconds since the UNIX epoch." },
235                 { "name": "size", "type": "integer", "description": "Cookie size." },
236                 { "name": "httpOnly", "type": "boolean", "description": "True if cookie is http-only." },
237                 { "name": "secure", "type": "boolean", "description": "True if cookie is secure." },
238                 { "name": "session", "type": "boolean", "description": "True in case of session cookie." }
239             ]
240         },
241         {
242             "id": "SessionPermission",
243             "type": "string",
244             "description": "Enumerates different permissions that must be obtained in order to use privileged APIs.",
245             "enum": [
246                 "GetUserMedia"
247             ]
248         },
249         {
250             "id": "SessionPermissionData",
251             "type": "object",
252             "properties": [
253                 { "name": "permission", "$ref": "SessionPermission" },
254                 { "name": "value", "type": "boolean" }
255             ]
256         },
257         {
258             "id": "InputSourceType",
259             "type": "string",
260             "description": "The type of an input source. This determines which state properties are applicable to the input source. The 'Null' input source type has no properties, only a duration. This can extend the effective wait for a tick.",
261             "enum": [
262                 "Null",
263                 "Mouse",
264                 "Keyboard",
265                 "Touch"
266             ]
267         },
268         {
269             "id": "InputSource",
270             "type": "object",
271             "properties": [
272                 { "name": "sourceId", "type": "string", "description": "A unique identifier for this input source." },
273                 { "name": "sourceType", "$ref": "InputSourceType", "description": "The type of this input source. This affects what input source state fields are valid for this input source." }
274             ]
275         },
276         {
277             "id": "InteractionStep",
278             "description": "A set of input source states to which all applicable input sources must transition before further steps may be processed. If an input source does not have a corresponding state in a step, its state assumed to be 'released' for that step.",
279             "type": "object",
280             "properties": [
281                 { "name": "states", "type": "array", "items": { "$ref": "InputSourceState" }, "optional": true, "description": "A list of new input states for input sources that must transition during this step. Source state transitions that cannot be performed concurrently (i.e., touch gestures) are performed sequentially in the order they are listed." }
282             ]
283         },
284         {
285             "id": "MouseMoveOrigin",
286             "type": "string",
287             "description": "Enumerates different origin types that can be used in mouse move interactions.",
288             "enum": [
289                 "Viewport",
290                 "Pointer",
291                 "Element"
292             ]
293         },
294         {
295             "id": "InputSourceState",
296             "type": "object",
297             "description": "A new state for a specific input source. All state-related fields are optional and must be applicable to the InputSource referenced by 'sourceId'. If no state-related fields are specified, the state is assumed to remain the same as in the previous step (i.e., 'sustained').",
298             "properties": [
299                 { "name": "sourceId", "type": "string", "description": "The input source whose state is described by this object." },
300                 { "name": "pressedCharKey", "type": "string", "optional": true, "description": "For 'keyboard' input sources, specifies a character key that has 'pressed' state. Unmentioned character keys are assumed to have a 'released' state." },
301                 { "name": "pressedVirtualKeys", "type": "array", "items": { "$ref": "VirtualKey" }, "optional": true, "description": "For 'keyboard' input sources, specifies virtual keys that have a 'pressed' state. Unmentioned virtual keys are assumed to have a 'released' state." },
302                 { "name": "pressedButton", "$ref": "MouseButton", "optional": true, "description": "For 'mouse' input sources, specifies which mouse button has a 'pressed' state. Unmentioned mouse buttons are assumed to have a 'released' state. For 'touch' input sources, passing MouseButton::Left denotes a touch-down state." },
303                 { "name": "origin", "$ref": "MouseMoveOrigin", "optional": true, "description": "For 'mouse' input sources, specifies the origin type of a mouse move transition. Defaults to 'Viewport' if omitted."},
304                 { "name": "nodeHandle", "$ref": "NodeHandle", "optional": true, "description": "The handle of the element to use as origin when origin type is 'Element'."},
305                 { "name": "location", "$ref": "Point", "optional": true, "description": "For 'mouse' or 'touch' input sources, specifies a location in view coordinates to which the input source should transition. Transitioning to this state may interpolate intemediate input source states to better simulate real user movements and gestures." },
306                 { "name": "duration", "type": "integer", "optional": true, "description": "The minimum number of milliseconds that must elapse while the relevant input source transitions to this state." }
307             ]
308         }
309     ],
310     "commands": [
311         {
312             "name": "getBrowsingContexts",
313             "description": "Fetches information about all open browsing contexts (windows and tabs) in the automation session.",
314             "returns": [
315                 { "name": "contexts", "type": "array", "items": { "$ref": "BrowsingContext" }, "description": "All known browsing contexts available to the session." }
316             ],
317             "async": true
318         },
319         {
320             "name": "getBrowsingContext",
321             "description": "Fetches information about the specified browsing context.",
322             "parameters": [
323                 { "name": "handle", "$ref": "BrowsingContextHandle", "description": "The handle for the browsing context." }
324             ],
325             "returns": [
326                 { "name": "context", "$ref": "BrowsingContext", "description": "The browsing context available to the session." }
327             ],
328             "async": true
329         },
330         {
331             "name": "createBrowsingContext",
332             "description": "Opens a new browsing context in the automation session and makes it the active browsing context for user interaction. This command creates a browsing context in a new window rather than adding a tab to an existing window.",
333             "parameters": [
334                 { "name": "presentationHint", "$ref": "BrowsingContextPresentation", "optional": true, "description": "A hint for the desired presentation of new browsing context (new tab or new window)."}
335             ],
336             "returns": [
337                 { "name": "handle", "$ref": "BrowsingContextHandle", "description": "An opaque handle for the newly created browsing context." },
338                 { "name": "presentation", "$ref": "BrowsingContextPresentation", "description": "How the browser presented the new browsing context (new tab or new window)." }
339             ],
340             "async": true
341         },
342         {
343             "name": "closeBrowsingContext",
344             "description": "Try to close the specified browsing context. This can trigger an unload prompt and thereafter succeed or fail.",
345             "parameters": [
346                 { "name": "handle", "$ref": "BrowsingContextHandle", "description": "The handle for the browsing context that should be closed." }
347             ]
348         },
349         {
350             "name": "switchToBrowsingContext",
351             "description": "Activates the specified browsing context and optional frame, which gives them focus (causing the 'focus' DOM event to fire, and 'blur' DOM event to fire for the previous browsing context and frame).",
352             "parameters": [
353                 { "name": "browsingContextHandle", "$ref": "BrowsingContextHandle", "description": "The handle for the browsing context that should be made focused." },
354                 { "name": "frameHandle", "$ref": "FrameHandle", "optional": true, "description": "The handle for the frame that should be focused. Defaults to the main frame if omitted." }
355             ],
356             "async": true
357         },
358         {
359             "name": "setWindowFrameOfBrowsingContext",
360             "description": "Moves and/or resizes the window of the specified top-level browsing context to the specified position and size. Both position and size may be omitted. This command implicitly exits fullscreen and restores the window (if previously hidden), then optionally sets the window frame.",
361             "parameters": [
362                 { "name": "handle", "$ref": "BrowsingContextHandle", "description": "The handle for the browsing context to be resized." },
363                 { "name": "origin", "$ref": "Point", "optional": true, "description": "The new origin for the browsing context's window. The position is interpreted in screen coordinate space, relative to the upper left corner of the screen." },
364                 { "name": "size", "$ref": "Size", "optional": true, "description": "The new size for the browsing context's window. The size is interpreted in screen pixels." }
365             ],
366             "async": true
367         },
368         {
369             "name": "maximizeWindowOfBrowsingContext",
370             "description": "Causes the window of the specified browsing context to be maximized. This command implicitly exits fullscreen mode.",
371             "parameters": [
372                 { "name": "handle", "$ref": "BrowsingContextHandle", "description": "The handle for the browsing context whose window should be maximized." }
373             ],
374             "async": true
375         },
376         {
377             "name": "hideWindowOfBrowsingContext",
378             "description": "Causes the window of the specified browsing context to be hidden/minimized/iconified. This command implicitly exits fullscreen mode.",
379             "parameters": [
380                 { "name": "handle", "$ref": "BrowsingContextHandle", "description": "The handle for the browsing context whose window should be hidden." }
381             ],
382             "async": true
383         },
384         {
385             "name": "navigateBrowsingContext",
386             "description": "Navigates a browsing context to a specified URL.",
387             "parameters": [
388                 { "name": "handle", "$ref": "BrowsingContextHandle", "description": "The handle for the browsing context that should be navigated." },
389                 { "name": "url", "type": "string", "description": "The URL to load in the browsing context." },
390                 { "name": "pageLoadStrategy", "$ref": "PageLoadStrategy", "optional": true, "description": "The page load strategy to use when determining when navigation is complete." },
391                 { "name": "pageLoadTimeout", "type": "integer", "optional": true, "description": "The timeout in milliseconds that the navigation is expected to be completed in, otherwise a <code>Timeout</code> error is returned." }
392             ],
393             "async": true
394         },
395         {
396             "name": "goBackInBrowsingContext",
397             "description": "Navigates a browsing context to go back one page in history.",
398             "parameters": [
399                 { "name": "handle", "$ref": "BrowsingContextHandle", "description": "The handle for the browsing context that should be navigated." },
400                 { "name": "pageLoadStrategy", "$ref": "PageLoadStrategy", "optional": true, "description": "The page load strategy to use when determining when navigation is complete." },
401                 { "name": "pageLoadTimeout", "type": "integer", "optional": true, "description": "The timeout in milliseconds that the navigation is expected to be completed in, otherwise a <code>Timeout</code> error is returned." }
402             ],
403             "async": true
404         },
405         {
406             "name": "goForwardInBrowsingContext",
407             "description": "Navigates a browsing context to got forward one page in history.",
408             "parameters": [
409                 { "name": "handle", "$ref": "BrowsingContextHandle", "description": "The handle for the browsing context that should be navigated." },
410                 { "name": "pageLoadStrategy", "$ref": "PageLoadStrategy", "optional": true, "description": "The page load strategy to use when determining when navigation is complete." },
411                 { "name": "pageLoadTimeout", "type": "integer", "optional": true, "description": "The timeout in milliseconds that the navigation is expected to be completed in, otherwise a <code>Timeout</code> error is returned." }
412             ],
413             "async": true
414         },
415         {
416             "name": "reloadBrowsingContext",
417             "description": "Reloads the current page in a browsing context.",
418             "parameters": [
419                 { "name": "handle", "$ref": "BrowsingContextHandle", "description": "The handle for the browsing context that should be reloaded." },
420                 { "name": "pageLoadStrategy", "$ref": "PageLoadStrategy", "optional": true, "description": "The page load strategy to use when determining when navigation is complete." },
421                 { "name": "pageLoadTimeout", "type": "integer", "optional": true, "description": "The timeout in milliseconds that the navigation is expected to be completed in, otherwise a <code>Timeout</code> error is returned." }
422             ],
423             "async": true
424         },
425         {
426             "name": "waitForNavigationToComplete",
427             "description": "Wait for pending navigation to complete.",
428             "parameters": [
429                 { "name": "browsingContextHandle", "$ref": "BrowsingContextHandle", "description": "The handle for the browsing context in which wait for pending navigation to complete." },
430                 { "name": "frameHandle", "$ref": "FrameHandle", "optional": true, "description": "The handle for the frame in which wait for pending navigation to complete. The main frame is used if this parameter empty string or excluded." },
431                 { "name": "pageLoadStrategy", "$ref": "PageLoadStrategy", "optional": true, "description": "The page load strategy to use when determining when navigation is complete." },
432                 { "name": "pageLoadTimeout", "type": "integer", "optional": true, "description": "The timeout in milliseconds that the navigation is expected to be completed in, otherwise a <code>Timeout</code> error is returned." }
433             ],
434             "async": true
435         },
436         {
437             "name": "inspectBrowsingContext",
438             "description": "Inspect the specified browsing context using Web Inspector.",
439             "platform": "macos",
440             "parameters": [
441                 { "name": "handle", "$ref": "BrowsingContextHandle", "description": "The handle for the browsing context that should be inspected." },
442                 { "name": "enableAutoCapturing", "type": "boolean", "optional": true, "description": "If this option is present and set to true, the Web Inspector will automatically start a timeline recording of the specified browsing context once it is attached. Note that this disables the debugger for the duration of the recording." }
443             ],
444             "async": true
445         },
446         {
447             "name": "evaluateJavaScriptFunction",
448             "description": "Evaluates a script function in a browsing context and calls it with the supplied arguments.",
449             "parameters": [
450                 { "name": "browsingContextHandle", "$ref": "BrowsingContextHandle", "description": "The handle for the browsing context the script should be evaluated." },
451                 { "name": "frameHandle", "$ref": "FrameHandle", "optional": true, "description": "The handle for the frame the script should be evaluated. The main frame is used if this parameter empty string or excluded." },
452                 { "name": "function", "type": "string", "description": "The script to evaluate in the browsing context. It must be a function result." },
453                 { "name": "arguments", "type": "array", "items": { "type": "string" }, "description": "The arguments to pass to the function when called. They will be parsed as JSON before calling the function." },
454                 { "name": "expectsImplicitCallbackArgument", "type": "boolean", "optional": true, "description": "The function expects a callback function as the last argument. It is expected to call this callback with a result." },
455                 { "name": "callbackTimeout", "type": "integer", "optional": true, "description": "The timeout in milliseconds that the implicit callback is expected to be called in, otherwise a <code>JavaScriptTimeout</code> error is returned." }
456             ],
457             "returns": [
458                 { "name": "result", "type": "string", "description": "The result returned by the called function. It is JSON encoded after the function returns or calls the callback." }
459             ],
460             "async": true
461         },
462         {
463             "name": "performMouseInteraction",
464             "description": "Simulates interaction with a mouse cursor.",
465             "parameters": [
466                 { "name": "handle", "$ref": "BrowsingContextHandle", "description": "The browsing context to be interacted with." },
467                 { "name": "position", "$ref": "Point", "description": "The requested position for the mouse cursor, specified in viewport coordinates." },
468                 { "name": "button", "$ref": "MouseButton", "description": "The button to use to perform the interaction. This parameter only has an effect for the <code>Down</code>, <code>Up</code>, <code>Click</code>, and <code>DoubleClick</code> mouse interactions." },
469                 { "name": "interaction", "$ref": "MouseInteraction", "description": "The type of interaction to be performed with the mouse cursor." },
470                 { "name": "modifiers", "type": "array", "items": { "$ref": "KeyModifier" }, "description": "Key modifiers to be active during the mouse interaction." }
471             ],
472             "returns": [
473                 { "name": "position", "$ref": "Point", "description": "The updated position of the mouse cursor, specified in viewport coordinates." }
474             ],
475             "async": true
476         },
477         {
478             "name": "performKeyboardInteractions",
479             "description": "Simulates delivering the results of pressing one or more keyboard keys together or successively.",
480             "parameters": [
481                 { "name": "handle", "$ref": "BrowsingContextHandle", "description": "The handle for the browsing context which should receive key." },
482                 { "name": "interactions", "type": "array", "items": { "$ref": "KeyboardInteraction" }, "description": "An ordered list of key sequences to be delivered using native key events." }
483             ],
484             "async": true
485         },
486         {
487             "name": "performInteractionSequence",
488             "description": "Perform multiple simulated interactions over time using a list of input sources and a list of steps, where each step specifies a state for each input source at the time that step is performed.",
489             "parameters": [
490                 { "name": "handle", "$ref": "BrowsingContextHandle", "description": "The browsing context to be interacted with." },
491                 { "name": "frameHandle", "$ref": "FrameHandle", "optional": true, "description": "The handle for the frame in which to search for the elements in case of an 'Element' type MouseMoveOrigin. The main frame is used if this parameter empty string or excluded." },
492                 { "name": "inputSources", "type": "array", "items": { "$ref": "InputSource" }, "description": "All input sources that are used to perform this interaction sequence." },
493                 { "name": "steps", "type": "array", "items": { "$ref": "InteractionStep" }, "description": "A list of steps that are executed in order." }
494             ],
495             "async": true
496         },
497         {
498             "name": "cancelInteractionSequence",
499             "description": "Cancel an active interaction sequence that is currently in progress.",
500             "parameters": [
501                 { "name": "handle", "$ref": "BrowsingContextHandle", "description": "The browsing context to be interacted with." },
502                 { "name": "frameHandle", "$ref": "FrameHandle", "optional": true, "description": "The handle for the frame passed to performInteractionSequence. The main frame is used if this parameter empty string or excluded." }
503             ],
504             "async": true
505         },
506         {
507             "name": "takeScreenshot",
508             "description": "Take a screenshot of the current page or given element in a browsing context.",
509             "parameters": [
510                 { "name": "handle", "$ref": "BrowsingContextHandle", "description": "The handle for the browsing context to take a screenshot of." },
511                 { "name": "frameHandle", "$ref": "FrameHandle", "optional": true, "description": "The handle for the frame that contains the element. The main frame is used if this parameter is empty string or excluded." },
512                 { "name": "nodeHandle", "$ref": "NodeHandle", "optional": true, "description": "The handle of the element to take a screenshot of. The browsing context document element is used if this parameter is excluded." },
513                 { "name": "scrollIntoViewIfNeeded", "type": "boolean", "optional": true, "description": "If the element should be scrolled into view before taking the screenshot." },
514                 { "name": "clipToViewport", "type": "boolean", "optional": true, "description": "Whether a screenshot of the entire page should be clipped to the visual viewport. A value of 'false' preserves behavior for legacy protocol screenshots." }
515             ],
516             "returns": [
517                 { "name": "data", "type": "string", "description": "Base64-encoded image data (PNG)." }
518             ],
519             "async": true
520         },
521         {
522             "name": "resolveChildFrameHandle",
523             "description": "Determines the <code>FrameHandle</code> based on the ordinal, name or node handle of a child frame.",
524             "parameters": [
525                 { "name": "browsingContextHandle", "$ref": "BrowsingContextHandle", "description": "The handle for the browsing context in which to search for the frame." },
526                 { "name": "frameHandle", "$ref": "FrameHandle", "optional": true, "description": "The handle for the frame in which to search for the frame. The main frame is used if this parameter empty string or excluded." },
527                 { "name": "ordinal", "type": "integer", "optional": true, "description": "The ordinal of the child frame to resolve as a <code>FrameHandle</code>. This is analogous to 'window.frames[ordinal]' in JavaScript." },
528                 { "name": "name", "type": "string", "optional": true, "description": "The name of the child frame to resolve as a <code>FrameHandle</code>. This is analogous to 'window.frames[name]' in JavaScript." },
529                 { "name": "nodeHandle", "$ref": "NodeHandle", "optional": true, "description": "The handle of the child frame owner element to resolve as a <code>FrameHandle</code>." }
530             ],
531             "returns": [
532                 { "name": "result", "$ref": "FrameHandle", "description": "The <code>FrameHandle</code> for the requested frame." }
533             ],
534             "async": true
535         },
536         {
537             "name": "resolveParentFrameHandle",
538             "description": "Determines the <code>FrameHandle</code> for the parent frame of the supplied <code>FrameHandle</code>.",
539             "parameters": [
540                 { "name": "browsingContextHandle", "$ref": "BrowsingContextHandle", "description": "The handle for the browsing context the frame is located." },
541                 { "name": "frameHandle", "$ref": "FrameHandle", "description": "The handle for the frame that should resolve its parent frame." }
542             ],
543             "returns": [
544                 { "name": "result", "$ref": "FrameHandle", "description": "The <code>FrameHandle</code> for the requested frame." }
545             ],
546             "async": true
547         },
548         {
549             "name": "computeElementLayout",
550             "description": "Computes the layout for an element.",
551             "parameters": [
552                 { "name": "browsingContextHandle", "$ref": "BrowsingContextHandle", "description": "The handle for the browsing context the frame is located." },
553                 { "name": "frameHandle", "$ref": "FrameHandle", "description": "The handle for the frame that contains the element." },
554                 { "name": "nodeHandle", "$ref": "NodeHandle", "description": "The handle of the element to use." },
555                 { "name": "scrollIntoViewIfNeeded", "optional": true, "type": "boolean", "description": "If the element should be scrolled into view before computing its layout." },
556                 { "name": "coordinateSystem", "$ref": "CoordinateSystem", "description": "The coordinate system to use for rect and point results." }
557             ],
558             "returns": [
559                 { "name": "rect", "$ref": "Rect", "description": "The layout rect for the requested element. Values are converted to the requested coordinate system." },
560                 { "name": "inViewCenterPoint", "optional": true, "$ref": "Point", "description": "The in-view center point for the requested element. Values are converted to the requested coordinate system." },
561                 { "name": "isObscured", "type": "boolean", "description": "If the in-view center point of the requested element is obscured by another element." }
562             ],
563             "async": true
564         },
565         {
566             "name": "selectOptionElement",
567             "description": "Selects the given option element. In case of container with multiple options enabled, the element selectedness is toggled.",
568             "parameters": [
569                 { "name": "browsingContextHandle", "$ref": "BrowsingContextHandle", "description": "The handle for the browsing context." },
570                 { "name": "frameHandle", "$ref": "FrameHandle", "description": "The handle for the frame that contains the element." },
571                 { "name": "nodeHandle", "$ref": "NodeHandle", "description": "The handle of the element to use." }
572             ],
573             "async": true
574         },
575         {
576             "name": "isShowingJavaScriptDialog",
577             "description": "Checks if a browsing context is showing a JavaScript alert, confirm, or prompt dialog.",
578             "parameters": [
579                 { "name": "browsingContextHandle", "$ref": "BrowsingContextHandle", "description": "The handle for the browsing context." }
580             ],
581             "returns": [
582                 { "name": "result", "type": "boolean", "description": "If the browsing context is showing a JavaScript dialog or not." }
583             ]
584         },
585         {
586             "name": "dismissCurrentJavaScriptDialog",
587             "description": "Dismisses a JavaScript alert, confirm, or prompt dialog currently showing in a browsing context. Equivalent to clicking the 'Cancel' button.",
588             "parameters": [
589                 { "name": "browsingContextHandle", "$ref": "BrowsingContextHandle", "description": "The handle for the browsing context." }
590             ]
591         },
592         {
593             "name": "acceptCurrentJavaScriptDialog",
594             "description": "Accepts a JavaScript alert, confirm, or prompt dialog currently showing in a browsing context. Equivalent to clicking the 'OK' button.",
595             "parameters": [
596                 { "name": "browsingContextHandle", "$ref": "BrowsingContextHandle", "description": "The handle for the browsing context." }
597             ]
598         },
599         {
600             "name": "messageOfCurrentJavaScriptDialog",
601             "description": "Returns the text displayed in a JavaScript alert, confirm, or prompt dialog currently showing in a browsing context.",
602             "parameters": [
603                 { "name": "browsingContextHandle", "$ref": "BrowsingContextHandle", "description": "The handle for the browsing context." }
604             ],
605             "returns": [
606                 { "name": "message", "type": "string", "description": "Text being displayed in the current JavaScript dialog." }
607             ]
608         },
609         {
610             "name": "setUserInputForCurrentJavaScriptPrompt",
611             "description": "Sets the user entered value in a JavaScript prompt dialog currently showing in a browsing context.",
612             "parameters": [
613                 { "name": "browsingContextHandle", "$ref": "BrowsingContextHandle", "description": "The handle for the browsing context." },
614                 { "name": "userInput", "type": "string", "description": "The text to enter in the prompt." }
615             ]
616         },
617         {
618             "name": "setFilesToSelectForFileUpload",
619             "description": "Sets the files to be selected when a file input type element becomes active in a browsing context.",
620             "parameters": [
621                 { "name": "browsingContextHandle", "$ref": "BrowsingContextHandle", "description": "The handle for the browsing context." },
622                 { "name": "filenames", "type": "array", "items": { "type": "string" }, "description": "Absolute paths to the files that should be selected." },
623                 { "name": "fileContents", "type": "array", "items": { "type" : "string" }, "optional": true, "description": "An array of Base64-encoded binary data for each file to be selected. If this property is provided, it is assumed that 'filenames' are not real file paths on the session host's filesystem, and this binary data will be used instead." }
624             ]
625         },
626         {
627             "name": "getAllCookies",
628             "description": "Returns all cookies visible to the specified browsing context.",
629             "parameters": [
630                 { "name": "browsingContextHandle", "$ref": "BrowsingContextHandle", "description": "The handle for the browsing context." }
631             ],
632             "returns": [
633                 { "name": "cookies", "type": "array", "items": { "$ref": "Cookie" }, "description": "Array of cookie objects." }
634             ],
635             "async": true
636         },
637         {
638             "name": "deleteSingleCookie",
639             "description": "Deletes a cookie with the given name if visible to the specified browsing context.",
640             "parameters": [
641                 { "name": "browsingContextHandle", "$ref": "BrowsingContextHandle", "description": "The handle for the browsing context." },
642                 { "name": "cookieName", "type": "string", "description": "Name of the cookie to remove." }
643             ],
644             "async": true
645         },
646         {
647             "name": "addSingleCookie",
648             "description": "Add a cookie to cookie storage for the specified browsing context.",
649             "parameters": [
650                 { "name": "browsingContextHandle", "$ref": "BrowsingContextHandle", "description": "The handle for the browsing context." },
651                 { "name": "cookie", "$ref": "Cookie", "description": "The cookie that should be added to storage." }
652             ],
653             "async": true
654         },
655         {
656             "name": "deleteAllCookies",
657             "description": "Delete all cookies that are visible to the specified browsing context.",
658             "parameters": [
659                 { "name": "browsingContextHandle", "$ref": "BrowsingContextHandle", "description": "The handle for the browsing context." }
660             ]
661         },
662         {
663             "name": "getSessionPermissions",
664             "description": "Returns the state of all session permissions, which control whether privileged Web APIs can be used. Permissions are applied to all browsing contexts associated with the automation session.",
665             "returns": [
666                 { "name": "permissions", "type": "array", "items": { "$ref": "SessionPermissionData" }, "description": "Array of available session permissions and their values." }
667             ]
668         },
669         {
670             "name": "setSessionPermissions",
671             "description": "Attempts to set the state of session permissions, which control whether privileged Web APIs can be used. Permissions that are not understood are ignored. Permissions are applied to all browsing contexts associated with the automation session.",
672             "parameters": [
673                 { "name": "permissions", "type": "array", "items": { "$ref": "SessionPermissionData" }, "description": "Array of session permissions to set, if they are available." }
674             ]
675         }
676     ],
677     "events": [
678         {
679             "name": "fileChooserDismissed",
680             "description": "Fired when a file chooser for a file input element is dismissed by selecting files or cancelling.",
681             "parameters": [
682                 { "name": "browsingContextHandle", "$ref": "BrowsingContextHandle", "description": "The handle for the browsing context." },
683                 { "name": "selectionCancelled", "type": "boolean", "description": "If true, the chooser was dismissed because file selection was cancelled." }
684             ]
685         },
686         {
687             "name": "browsingContextCleared",
688             "description": "Fired when the specified browsing context has navigated or closed. Existing element references from the browsing context are no longer valid.",
689             "parameters": [
690                 { "name": "browsingContextHandle", "$ref": "BrowsingContextHandle" }
691             ]
692         }
693     ]
694 }