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
# Copyright (c) Microsoft Corporation.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
Browser:
type: interface
initializer:
version: string
name: string
browserName:
type: enum
literals:
- chromium
- firefox
- webkit
commands:
startServer:
title: Start server
parameters:
title: string
workspaceDir: string?
metadata: json?
host: string?
port: int?
returns:
endpoint: string
stopServer:
title: Stop server
close:
title: Close browser
parameters:
reason: string?
flags:
pause: true
killForTests:
internal: true
defaultUserAgentForTest:
internal: true
returns:
userAgent: string
newContext:
title: Create context
parameters:
$mixin: ContextOptions
proxy:
type: object?
properties:
server: string
bypass: string?
username: string?
password: string?
storageState:
type: object?
properties:
cookies:
type: array?
items: SetNetworkCookie
origins:
type: array?
items: SetOriginStorage
credentials:
type: array?
items: VirtualCredential
returns:
context: BrowserContext
newContextForReuse:
internal: true
parameters:
$mixin: ContextOptions
proxy:
type: object?
properties:
server: string
bypass: string?
username: string?
password: string?
storageState:
type: object?
properties:
cookies:
type: array?
items: SetNetworkCookie
origins:
type: array?
items: SetOriginStorage
credentials:
type: array?
items: VirtualCredential
returns:
context: BrowserContext
disconnectFromReusedContext:
internal: true
parameters:
reason: string
newBrowserCDPSession:
title: Create CDP session
group: configuration
returns:
session: CDPSession
startTracing:
title: Start browser tracing
group: configuration
parameters:
page: Page?
screenshots: boolean?
categories:
type: array?
items: string
stopTracing:
title: Stop browser tracing
group: configuration
returns:
artifact: Artifact
events:
context:
parameters:
context: BrowserContext
close: