yujunjun/playwright
1
0
Fork 0
mirror of https://github.com/microsoft/playwright.git synced 2025-06-26 21:40:17 +00:00
Code Issues Packages Projects Releases Wiki Activity
playwright/src/protocol/protocol.yml

2050 lines
38 KiB
YAML
Raw Normal View History

feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
# 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.
feat(rpc): allow sending metadata with rpc calls (#3836) Currently, metadata does only contain the stack trace, and we send it from the JS client.
2020-09-10 19:25:44 -07:00
# This object can be send with any rpc call in the "metadata" field.
Metadata:
type: object
properties:
stack: string?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
SerializedValue:
type: object
# Exactly one of the properties must be present.
properties:
n: number?
b: boolean?
s: string?
v:
type: enum?
literals:
- null
- undefined
- NaN
- Infinity
- -Infinity
- "-0"
# String representation of the Date.
d: string?
# Regular expression pattern and flags.
r:
type: object?
properties:
p: string
f: string
a:
type: array?
items: SerializedValue
# Object with keys and values.
o:
type: array?
items:
type: object
properties:
k: string
v: SerializedValue
# An index in the handles array from SerializedArgument.
h: number?
# Represents a value with handle references.
SerializedArgument:
type: object
properties:
value: SerializedValue
handles:
type: array
items: Channel
AXNode:
type: object
properties:
role: string
name: string
valueString: string?
valueNumber: number?
description: string?
keyshortcuts: string?
roledescription: string?
valuetext: string?
disabled: boolean?
expanded: boolean?
focused: boolean?
modal: boolean?
multiline: boolean?
multiselectable: boolean?
readonly: boolean?
required: boolean?
selected: boolean?
checked:
type: enum?
literals:
- checked
- unchecked
- mixed
pressed:
type: enum?
literals:
- pressed
- released
- mixed
level: number?
valuemin: number?
valuemax: number?
autocomplete: string?
haspopup: string?
invalid: string?
orientation: string?
children:
type: array?
items: AXNode
SerializedError:
type: object
properties:
error:
type: object?
properties:
message: string
name: string
stack: string?
value: SerializedValue?
Playwright:
type: interface
initializer:
chromium: BrowserType
firefox: BrowserType
webkit: BrowserType
electron: Electron?
deviceDescriptors:
type: array
items:
type: object
properties:
name: string
descriptor:
type: object
properties:
userAgent: string
viewport:
type: object
properties:
width: number
height: number
deviceScaleFactor: number
isMobile: boolean
hasTouch: boolean
feat: add browser type to device descriptors (#3731)
2020-09-03 22:12:43 +02:00
defaultBrowserType:
type: enum
literals:
- chromium
- firefox
- webkit
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
selectors: Selectors
fix(connect): make selectors.register work in connected browser (#3664) This is a large rework of selectors: - Each BrowserContext now has a separate Selectors instance that has its own registrations. Most of them share a single sharedSelectors instance, but contexts created for a connected browser have their own instance. - Connected browser now gets a RemoteBrowser object that encapsulates Selectors and Browser. This Selectors object is registered with the api selectors. - Public selectors.register api iterates over all registered Selectors channels and registers in each of them. - createSelector testing method migrated to ElementHandle._createSelectorForTest.
2020-09-02 16:15:43 -07:00
RemoteBrowser:
type: interface
initializer:
browser: Browser
selectors: Selectors
feat(video): support videos in remote browser (#4042)
2020-10-02 17:27:56 -07:00
events:
# Video stream blocks owner context from closing until the stream is closed.
# Make sure to close the stream!
video:
parameters:
context: BrowserContext
stream: Stream
api(video): restore the missing video path accessor (#4132)
2020-10-13 22:15:51 -07:00
relativePath: string
feat(video): support videos in remote browser (#4042)
2020-10-02 17:27:56 -07:00
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
Selectors:
type: interface
commands:
register:
parameters:
name: string
source: string
contentScript: boolean?
BrowserType:
type: interface
initializer:
executablePath: string
name: string
commands:
launch:
parameters:
executablePath: string?
args:
type: array?
items: string
ignoreAllDefaultArgs: boolean?
ignoreDefaultArgs:
type: array?
items: string
handleSIGINT: boolean?
handleSIGTERM: boolean?
handleSIGHUP: boolean?
timeout: number?
env:
type: array?
items:
type: object
properties:
name: string
value: string
headless: boolean?
devtools: boolean?
proxy:
type: object?
properties:
server: string
bypass: string?
username: string?
password: string?
downloadsPath: string?
feat(rpc): introduce JSON type in the protocol for arbitrary blobs (#3367)
2020-08-10 11:20:32 -07:00
firefoxUserPrefs: json?
feat(rpc): support chromiumSandbox option (#3251)
2020-07-31 09:31:55 -07:00
chromiumSandbox: boolean?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
slowMo: number?
returns:
browser: Browser
launchPersistentContext:
parameters:
userDataDir: string
executablePath: string?
args:
type: array?
items: string
ignoreAllDefaultArgs: boolean?
ignoreDefaultArgs:
type: array?
items: string
handleSIGINT: boolean?
handleSIGTERM: boolean?
handleSIGHUP: boolean?
timeout: number?
env:
type: array?
items:
type: object
properties:
name: string
value: string
headless: boolean?
devtools: boolean?
proxy:
type: object?
properties:
server: string
bypass: string?
username: string?
password: string?
downloadsPath: string?
feat(rpc): support chromiumSandbox option (#3251)
2020-07-31 09:31:55 -07:00
chromiumSandbox: boolean?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
slowMo: number?
noDefaultViewport: boolean?
viewport:
type: object?
properties:
width: number
height: number
ignoreHTTPSErrors: boolean?
javaScriptEnabled: boolean?
bypassCSP: boolean?
userAgent: string?
locale: string?
timezoneId: string?
geolocation:
type: object?
properties:
longitude: number
latitude: number
accuracy: number?
permissions:
type: array?
items: string
extraHTTPHeaders:
type: array?
items:
type: object
properties:
name: string
value: string
offline: boolean?
httpCredentials:
type: object?
properties:
username: string
password: string
deviceScaleFactor: number?
isMobile: boolean?
hasTouch: boolean?
colorScheme:
type: enum?
literals:
- light
chore(rpc): more protocol nits (#3246)
2020-07-30 17:51:41 -07:00
- dark
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
- no-preference
acceptDownloads: boolean?
api: update videos api, hide tracing (#4015)
2020-10-01 11:06:19 -07:00
_traceResourcesPath: string?
_tracePath: string?
videosPath: string?
videoSize:
type: object?
properties:
width: number
height: number
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
returns:
context: BrowserContext
Browser:
type: interface
api: introduce Browser.version() (#3177)
2020-07-27 13:41:35 -07:00
initializer:
version: string
feat(rpc): simplify browser name detection on the client side (#3670)
2020-08-28 10:23:02 -07:00
name: string
api: introduce Browser.version() (#3177)
2020-07-27 13:41:35 -07:00
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
commands:
close:
newContext:
parameters:
noDefaultViewport: boolean?
viewport:
type: object?
properties:
width: number
height: number
ignoreHTTPSErrors: boolean?
javaScriptEnabled: boolean?
bypassCSP: boolean?
userAgent: string?
locale: string?
timezoneId: string?
geolocation:
type: object?
properties:
longitude: number
latitude: number
accuracy: number?
permissions:
type: array?
items: string
extraHTTPHeaders:
type: array?
items:
type: object
properties:
name: string
value: string
offline: boolean?
httpCredentials:
type: object?
properties:
username: string
password: string
deviceScaleFactor: number?
isMobile: boolean?
hasTouch: boolean?
colorScheme:
type: enum?
literals:
- dark
- light
- no-preference
acceptDownloads: boolean?
api: update videos api, hide tracing (#4015)
2020-10-01 11:06:19 -07:00
_traceResourcesPath: string?
_tracePath: string?
videosPath: string?
api(video): simplify video api (#3924) - This leaves just `recordVideos` and `videoSize` options on the context. - Videos are saved to `artifactsPath`. We also save their ids to trace. - `context.close()` waits for the processed videos.
2020-09-18 17:36:43 -07:00
videoSize:
feat(screencast): add expreimental public API on context (#3766)
2020-09-04 22:37:38 -07:00
type: object?
properties:
width: number
height: number
feat(har): allow saving har for context (#4214)
2020-10-26 14:32:07 -07:00
recordHar:
type: object?
properties:
omitContent: boolean?
path: string
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
returns:
context: BrowserContext
crNewBrowserCDPSession:
returns:
session: CDPSession
crStartTracing:
parameters:
page: Page?
path: string?
screenshots: boolean?
categories:
type: array?
items: string
crStopTracing:
returns:
binary: binary
events:
close:
BrowserContext:
type: interface
feat(rpc): simplify browser name detection on the client side (#3670)
2020-08-28 10:23:02 -07:00
initializer:
browserName: string
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
commands:
addCookies:
parameters:
cookies:
type: array
items:
type: object
properties:
name: string
value: string
url: string?
domain: string?
path: string?
expires: number?
httpOnly: boolean?
secure: boolean?
sameSite:
type: enum?
literals:
- Strict
- Lax
- None
addInitScript:
parameters:
source: string
clearCookies:
clearPermissions:
close:
cookies:
parameters:
urls:
type: array
items: string
returns:
cookies:
type: array
items:
type: object
properties:
name: string
value: string
domain: string
path: string
expires: number
httpOnly: boolean
secure: boolean
sameSite:
type: enum
literals:
- Strict
- Lax
- None
exposeBinding:
parameters:
name: string
api: allow exposeBinding to pass handles (#4030) This adds an option `{ handle: true }` to pass a single handle instead of arbitrary json values.
2020-10-01 22:47:31 -07:00
needsHandle: boolean?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
grantPermissions:
parameters:
permissions:
type: array
items: string
origin: string?
newPage:
returns:
page: Page
setDefaultNavigationTimeoutNoReply:
parameters:
timeout: number
setDefaultTimeoutNoReply:
parameters:
timeout: number
setExtraHTTPHeaders:
parameters:
headers:
type: array
items:
type: object
properties:
name: string
value: string
setGeolocation:
parameters:
geolocation:
type: object?
properties:
longitude: number
latitude: number
accuracy: number?
setHTTPCredentials:
parameters:
httpCredentials:
type: object?
properties:
username: string
password: string
setNetworkInterceptionEnabled:
parameters:
enabled: boolean
setOffline:
parameters:
offline: boolean
crNewCDPSession:
parameters:
page: Page
returns:
session: CDPSession
events:
bindingCall:
parameters:
binding: BindingCall
close:
page:
parameters:
page: Page
route:
parameters:
route: Route
request: Request
crBackgroundPage:
parameters:
page: Page
crServiceWorker:
parameters:
worker: Worker
Page:
type: interface
initializer:
mainFrame: Frame
viewportSize:
type: object?
properties:
width: number
height: number
isClosed: boolean
fix(video): make video path available in persistent profiles (#4182)
2020-10-19 14:35:18 -07:00
videoRelativePath: string?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
commands:
setDefaultNavigationTimeoutNoReply:
parameters:
timeout: number
setDefaultTimeoutNoReply:
parameters:
timeout: number
setFileChooserInterceptedNoReply:
parameters:
intercepted: boolean
addInitScript:
parameters:
source: string
close:
parameters:
runBeforeUnload: boolean?
emulateMedia:
parameters:
media:
type: enum?
literals:
- screen
- print
# Reset emulated value to the system default.
- null
colorScheme:
type: enum?
literals:
- dark
- light
- no-preference
# Reset emulated value to the system default.
- null
exposeBinding:
parameters:
name: string
api: allow exposeBinding to pass handles (#4030) This adds an option `{ handle: true }` to pass a single handle instead of arbitrary json values.
2020-10-01 22:47:31 -07:00
needsHandle: boolean?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
goBack:
parameters:
timeout: number?
waitUntil:
type: enum?
literals:
- load
- domcontentloaded
- networkidle
returns:
response: Response?
goForward:
parameters:
timeout: number?
waitUntil:
type: enum?
literals:
- load
- domcontentloaded
- networkidle
returns:
response: Response?
opener:
returns:
page: Page?
reload:
parameters:
timeout: number?
waitUntil:
type: enum?
literals:
- load
- domcontentloaded
- networkidle
returns:
response: Response?
screenshot:
parameters:
timeout: number?
type:
type: enum?
literals:
- png
- jpeg
quality: number?
omitBackground: boolean?
fullPage: boolean?
clip:
type: object?
properties:
width: number
height: number
x: number
y: number
returns:
binary: binary
setExtraHTTPHeaders:
parameters:
headers:
type: array
items:
type: object
properties:
name: string
value: string
setNetworkInterceptionEnabled:
parameters:
enabled: boolean
setViewportSize:
parameters:
viewportSize:
type: object
properties:
width: number
height: number
keyboardDown:
parameters:
key: string
keyboardUp:
parameters:
key: string
keyboardInsertText:
parameters:
text: string
keyboardType:
parameters:
text: string
delay: number?
keyboardPress:
parameters:
key: string
delay: number?
mouseMove:
parameters:
x: number
y: number
steps: number?
mouseDown:
parameters:
button:
type: enum?
literals:
- left
- right
- middle
clickCount: number?
mouseUp:
parameters:
button:
type: enum?
literals:
- left
- right
- middle
clickCount: number?
mouseClick:
parameters:
x: number
y: number
delay: number?
button:
type: enum?
literals:
- left
- right
- middle
clickCount: number?
feat: tap (#4097)
2020-10-19 10:07:33 -07:00
touchscreenTap:
parameters:
x: number
y: number
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
accessibilitySnapshot:
parameters:
interestingOnly: boolean?
root: ElementHandle?
returns:
rootAXNode: AXNode?
pdf:
parameters:
scale: number?
displayHeaderFooter: boolean?
headerTemplate: string?
footerTemplate: string?
printBackground: boolean?
landscape: boolean?
pageRanges: string?
format: string?
width: string?
height: string?
preferCSSPageSize: boolean?
margin:
type: object?
properties:
top: string?
bottom: string?
left: string?
right: string?
returns:
pdf: binary
crStartJSCoverage:
parameters:
resetOnNavigation: boolean?
reportAnonymousScripts: boolean?
crStopJSCoverage:
returns:
entries:
type: array
items:
type: object
properties:
url: string
scriptId: string
source: string?
functions:
type: array
items:
type: object
properties:
functionName: string
isBlockCoverage: boolean
ranges:
type: array
items:
type: object
properties:
startOffset: number
endOffset: number
count: number
crStartCSSCoverage:
parameters:
resetOnNavigation: boolean?
crStopCSSCoverage:
returns:
entries:
type: array
items:
type: object
properties:
url: string
text: string?
ranges:
type: array
items:
type: object
properties:
start: number
end: number
bringToFront:
events:
bindingCall:
parameters:
binding: BindingCall
close:
console:
parameters:
message: ConsoleMessage
crash:
dialog:
parameters:
dialog: Dialog
download:
parameters:
download: Download
domcontentloaded:
fileChooser:
parameters:
element: ElementHandle
isMultiple: boolean
frameAttached:
parameters:
frame: Frame
frameDetached:
parameters:
frame: Frame
load:
pageError:
parameters:
error: SerializedError
popup:
parameters:
page: Page
request:
parameters:
request: Request
requestFailed:
parameters:
request: Request
failureText: string?
feat(timing): introduce resource timing (#4204)
2020-10-21 23:25:57 -07:00
responseEndTiming: number
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
requestFinished:
parameters:
request: Request
feat(timing): introduce resource timing (#4204)
2020-10-21 23:25:57 -07:00
responseEndTiming: number
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
response:
parameters:
response: Response
route:
parameters:
route: Route
request: Request
api(video): restore the missing video path accessor (#4132)
2020-10-13 22:15:51 -07:00
video:
parameters:
relativePath: string
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
worker:
parameters:
worker: Worker
Frame:
type: interface
initializer:
url: string
name: string
parentFrame: Frame?
loadStates:
type: array
items:
type: enum
literals:
- load
- domcontentloaded
- networkidle
commands:
evalOnSelector:
parameters:
selector: string
expression: string
isFunction: boolean
arg: SerializedArgument
returns:
value: SerializedValue
evalOnSelectorAll:
parameters:
selector: string
expression: string
isFunction: boolean
arg: SerializedArgument
returns:
value: SerializedValue
addScriptTag:
parameters:
url: string?
content: string?
type: string?
returns:
element: ElementHandle
addStyleTag:
parameters:
url: string?
content: string?
returns:
element: ElementHandle
check:
parameters:
selector: string
force: boolean?
noWaitAfter: boolean?
timeout: number?
click:
parameters:
selector: string
force: boolean?
noWaitAfter: boolean?
modifiers:
type: array?
items:
type: enum
literals:
- Alt
- Control
- Meta
- Shift
position:
type: object?
properties:
x: number
y: number
delay: number?
button:
type: enum?
literals:
- left
- right
- middle
clickCount: number?
timeout: number?
content:
returns:
value: string
dblclick:
parameters:
selector: string
force: boolean?
fix(rpc): Frame.dblclick is missing notWaitAfter (#3210)
2020-07-29 11:45:19 -07:00
noWaitAfter: boolean?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
modifiers:
type: array?
items:
type: enum
literals:
- Alt
- Control
- Meta
- Shift
position:
type: object?
properties:
x: number
y: number
delay: number?
button:
type: enum?
literals:
- left
- right
- middle
timeout: number?
dispatchEvent:
parameters:
selector: string
type: string
eventInit: SerializedArgument
timeout: number?
evaluateExpression:
parameters:
expression: string
isFunction: boolean
arg: SerializedArgument
chore: introduce evaluateInUtility private api (#3907) This is an experimental client-side api. We'll experiment with it in plugins like tracing.
2020-09-16 16:07:49 -07:00
world:
type: enum?
literals:
- main
- utility
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
returns:
value: SerializedValue
evaluateExpressionHandle:
parameters:
expression: string
isFunction: boolean
arg: SerializedArgument
chore: introduce evaluateInUtility private api (#3907) This is an experimental client-side api. We'll experiment with it in plugins like tracing.
2020-09-16 16:07:49 -07:00
world:
type: enum?
literals:
- main
- utility
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
returns:
handle: JSHandle
fill:
parameters:
selector: string
value: string
timeout: number?
noWaitAfter: boolean?
focus:
parameters:
selector: string
timeout: number?
frameElement:
returns:
element: ElementHandle
getAttribute:
parameters:
selector: string
name: string
timeout: number?
returns:
value: string?
goto:
parameters:
url: string
timeout: number?
waitUntil:
type: enum?
literals:
- load
- domcontentloaded
- networkidle
referer: string?
returns:
response: Response?
hover:
parameters:
selector: string
force: boolean?
modifiers:
type: array?
items:
type: enum
literals:
- Alt
- Control
- Meta
- Shift
position:
type: object?
properties:
x: number
y: number
timeout: number?
innerHTML:
parameters:
selector: string
timeout: number?
returns:
value: string
innerText:
parameters:
selector: string
timeout: number?
returns:
value: string
press:
parameters:
selector: string
key: string
delay: number?
noWaitAfter: boolean?
timeout: number?
querySelector:
parameters:
selector: string
returns:
element: ElementHandle?
querySelectorAll:
parameters:
selector: string
returns:
elements:
type: array
items: ElementHandle
selectOption:
parameters:
selector: string
elements:
type: array?
items: ElementHandle
options:
type: array?
items:
type: object
properties:
value: string?
label: string?
index: number?
timeout: number?
noWaitAfter: boolean?
returns:
values:
type: array
items: string
setContent:
parameters:
html: string
timeout: number?
waitUntil:
type: enum?
literals:
- load
- domcontentloaded
- networkidle
setInputFiles:
parameters:
selector: string
files:
type: array
items:
type: object
properties:
name: string
mimeType: string
buffer: string
timeout: number?
noWaitAfter: boolean?
feat: tap (#4097)
2020-10-19 10:07:33 -07:00
tap:
parameters:
selector: string
force: boolean?
noWaitAfter: boolean?
modifiers:
type: array?
items:
type: enum
literals:
- Alt
- Control
- Meta
- Shift
position:
type: object?
properties:
x: number
y: number
timeout: number?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
textContent:
parameters:
selector: string
timeout: number?
returns:
value: string?
title:
returns:
value: string
type:
parameters:
selector: string
text: string
delay: number?
noWaitAfter: boolean?
timeout: number?
uncheck:
parameters:
selector: string
force: boolean?
noWaitAfter: boolean?
timeout: number?
waitForFunction:
parameters:
expression: string
isFunction: boolean
arg: SerializedArgument
timeout: number?
# When present, polls on interval. Otherwise, polls on raf.
pollingInterval: number?
returns:
handle: JSHandle
waitForSelector:
parameters:
selector: string
timeout: number?
state:
type: enum?
literals:
- attached
- detached
- visible
- hidden
returns:
element: ElementHandle?
fix(debug): do not generate source urls for anonymous scripts (#3787)
2020-09-07 15:50:25 -07:00
extendInjectedScript:
experimental: True
parameters:
source: string
arg: SerializedArgument
returns:
handle: JSHandle
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
events:
loadstate:
parameters:
add:
type: enum?
literals:
- load
- domcontentloaded
- networkidle
remove:
type: enum?
literals:
- load
- domcontentloaded
- networkidle
navigated:
parameters:
url: string
name: string
newDocument:
type: object?
properties:
request: Request?
error: string?
Worker:
type: interface
initializer:
url: string
commands:
evaluateExpression:
parameters:
expression: string
isFunction: boolean
arg: SerializedArgument
returns:
value: SerializedValue
evaluateExpressionHandle:
parameters:
expression: string
isFunction: boolean
arg: SerializedArgument
returns:
handle: JSHandle
feat(rpc): misc fixes (#3351)
2020-08-07 15:40:21 -07:00
events:
close:
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
JSHandle:
type: interface
initializer:
preview: string
commands:
dispose:
evaluateExpression:
parameters:
expression: string
isFunction: boolean
arg: SerializedArgument
returns:
value: SerializedValue
evaluateExpressionHandle:
parameters:
expression: string
isFunction: boolean
arg: SerializedArgument
returns:
handle: JSHandle
getPropertyList:
returns:
properties:
type: array
items:
type: object
properties:
name: string
value: JSHandle
getProperty:
parameters:
name: string
returns:
handle: JSHandle
jsonValue:
returns:
value: SerializedValue
events:
previewUpdated:
parameters:
preview: string
ElementHandle:
type: interface
extends: JSHandle
commands:
evalOnSelector:
parameters:
selector: string
expression: string
isFunction: boolean
arg: SerializedArgument
returns:
value: SerializedValue
evalOnSelectorAll:
parameters:
selector: string
expression: string
isFunction: boolean
arg: SerializedArgument
returns:
value: SerializedValue
boundingBox:
returns:
value:
type: object?
properties:
width: number
height: number
x: number
y: number
check:
parameters:
force: boolean?
noWaitAfter: boolean?
timeout: number?
click:
parameters:
force: boolean?
noWaitAfter: boolean?
modifiers:
type: array?
items:
type: enum
literals:
- Alt
- Control
- Meta
- Shift
position:
type: object?
properties:
x: number
y: number
delay: number?
button:
type: enum?
literals:
- left
- right
- middle
clickCount: number?
timeout: number?
contentFrame:
returns:
frame: Frame?
dblclick:
parameters:
force: boolean?
noWaitAfter: boolean?
modifiers:
type: array?
items:
type: enum
literals:
- Alt
- Control
- Meta
- Shift
position:
type: object?
properties:
x: number
y: number
delay: number?
button:
type: enum?
literals:
- left
- right
- middle
timeout: number?
dispatchEvent:
parameters:
type: string
eventInit: SerializedArgument
fill:
parameters:
value: string
timeout: number?
noWaitAfter: boolean?
focus:
getAttribute:
parameters:
name: string
returns:
value: string?
hover:
parameters:
force: boolean?
modifiers:
type: array?
items:
type: enum
literals:
- Alt
- Control
- Meta
- Shift
position:
type: object?
properties:
x: number
y: number
timeout: number?
innerHTML:
returns:
value: string
innerText:
returns:
value: string
ownerFrame:
returns:
frame: Frame?
press:
parameters:
key: string
delay: number?
timeout: number?
noWaitAfter: boolean?
querySelector:
parameters:
selector: string
returns:
element: ElementHandle?
querySelectorAll:
parameters:
selector: string
returns:
elements:
type: array
items: ElementHandle
screenshot:
parameters:
timeout: number?
type:
type: enum?
literals:
- png
- jpeg
quality: number?
omitBackground: boolean?
returns:
binary: binary
scrollIntoViewIfNeeded:
parameters:
timeout: number?
selectOption:
parameters:
elements:
type: array?
items: ElementHandle
options:
type: array?
items:
type: object
properties:
value: string?
label: string?
index: number?
timeout: number?
noWaitAfter: boolean?
returns:
values:
type: array
items: string
selectText:
parameters:
timeout: number?
setInputFiles:
parameters:
files:
type: array
items:
type: object
properties:
name: string
mimeType: string
buffer: string
timeout: number?
noWaitAfter: boolean?
feat: tap (#4097)
2020-10-19 10:07:33 -07:00
tap:
parameters:
force: boolean?
noWaitAfter: boolean?
modifiers:
type: array?
items:
type: enum
literals:
- Alt
- Control
- Meta
- Shift
position:
type: object?
properties:
x: number
y: number
timeout: number?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
textContent:
returns:
value: string?
type:
parameters:
text: string
delay: number?
noWaitAfter: boolean?
timeout: number?
uncheck:
parameters:
force: boolean?
noWaitAfter: boolean?
timeout: number?
api: ElementHandle.waitForElementState (#3501) This method waits for visible, hidden, stable or enabled state, similar to the actionability checks performed before actions. This gives a bit more control to the user. Some examples: - Allows to wait for something to be stable before taking a screenshot. - Allows to wait for the element to be hidden/detached after a specific action.
2020-08-17 16:22:34 -07:00
waitForElementState:
parameters:
state:
type: enum
literals:
- visible
- hidden
- stable
- enabled
api: add waitForElementState('disabled') (#3537) Allows waiting for the element to be disabled.
2020-08-19 17:20:10 -07:00
- disabled
api: ElementHandle.waitForElementState (#3501) This method waits for visible, hidden, stable or enabled state, similar to the actionability checks performed before actions. This gives a bit more control to the user. Some examples: - Allows to wait for something to be stable before taking a screenshot. - Allows to wait for the element to be hidden/detached after a specific action.
2020-08-17 16:22:34 -07:00
timeout: number?
api: introduce ElementHandle.waitForSelector (#3452) This is similar to Frame.waitForSelector, but relative to the handle.
2020-08-14 14:47:24 -07:00
waitForSelector:
parameters:
selector: string
timeout: number?
state:
type: enum?
literals:
- attached
- detached
- visible
- hidden
returns:
element: ElementHandle?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
fix(connect): make selectors.register work in connected browser (#3664) This is a large rework of selectors: - Each BrowserContext now has a separate Selectors instance that has its own registrations. Most of them share a single sharedSelectors instance, but contexts created for a connected browser have their own instance. - Connected browser now gets a RemoteBrowser object that encapsulates Selectors and Browser. This Selectors object is registered with the api selectors. - Public selectors.register api iterates over all registered Selectors channels and registers in each of them. - createSelector testing method migrated to ElementHandle._createSelectorForTest.
2020-09-02 16:15:43 -07:00
createSelectorForTest:
parameters:
name: string
returns:
value: string?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
Request:
type: interface
initializer:
frame: Frame
url: string
resourceType: string
method: string
postData: binary?
headers:
type: array
items:
type: object
properties:
name: string
value: string
isNavigationRequest: boolean
redirectedFrom: Request?
commands:
response:
returns:
response: Response?
Route:
type: interface
initializer:
request: Request
commands:
abort:
parameters:
chore: minor protocol fixes (#3226)
2020-07-30 11:14:41 -07:00
errorCode: string?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
continue:
parameters:
method: string?
headers:
type: array?
items:
type: object
properties:
name: string
value: string
fix(postData): allow overriding binary post data (#3120)
2020-07-24 12:16:45 -07:00
postData: binary?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
fulfill:
parameters:
fix(rpc): protocol Route.fulfill (#3200)
2020-07-30 05:42:14 +02:00
# default is 200
status: number?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
headers:
fix(rpc): protocol Route.fulfill (#3200)
2020-07-30 05:42:14 +02:00
type: array?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
items:
type: object
properties:
name: string
value: string
fix(rpc): protocol Route.fulfill (#3200)
2020-07-30 05:42:14 +02:00
body: string?
isBase64: boolean?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
feat(timing): introduce resource timing (#4204)
2020-10-21 23:25:57 -07:00
ResourceTiming:
type: object
properties:
startTime: number
domainLookupStart: number
domainLookupEnd: number
connectStart: number
secureConnectionStart: number
connectEnd: number
requestStart: number
responseStart: number
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
Response:
type: interface
initializer:
request: Request
url: string
status: number
statusText: string
fix(headers): report raw request headers on Chromium (#4207)
2020-10-22 08:49:16 -07:00
requestHeaders:
type: array
items:
type: object
properties:
name: string
value: string
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
headers:
type: array
items:
type: object
properties:
name: string
value: string
feat(timing): introduce resource timing (#4204)
2020-10-21 23:25:57 -07:00
timing: ResourceTiming
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
commands:
body:
returns:
binary: binary
finished:
returns:
error: string?
ConsoleMessage:
type: interface
initializer:
type: string
text: string
args:
type: array
items: JSHandle
location:
type: object
properties:
api(console): make ConsoleMessageLocation properties required (#3290) Everywhere in our api, possibly missing properties are nullable. However, to make things easier for everyone, we just default to an empty url instead, so that users do not have to null-check it.
2020-08-05 22:25:56 -07:00
url: string
lineNumber: number
columnNumber: number
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
BindingCall:
type: interface
initializer:
frame: Frame
name: string
args:
api: allow exposeBinding to pass handles (#4030) This adds an option `{ handle: true }` to pass a single handle instead of arbitrary json values.
2020-10-01 22:47:31 -07:00
type: array?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
items: SerializedValue
api: allow exposeBinding to pass handles (#4030) This adds an option `{ handle: true }` to pass a single handle instead of arbitrary json values.
2020-10-01 22:47:31 -07:00
handle: JSHandle?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
commands:
reject:
parameters:
error: SerializedError
resolve:
parameters:
result: SerializedArgument
Dialog:
type: interface
initializer:
type: string
message: string
defaultValue: string
commands:
accept:
parameters:
promptText: string?
dismiss:
Download:
type: interface
initializer:
url: string
suggestedFilename: string
commands:
path:
returns:
value: string?
fix(downloads): make path/saveAs work when connected remotely (#3634) - saveAs uses a stream internally and pipes it to the local file; - path throws an error when called on a remote browser.
2020-08-26 12:46:30 -07:00
# Blocks path/failure/delete/context.close until saved to the local |path|.
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
saveAs:
parameters:
path: string
fix(downloads): make path/saveAs work when connected remotely (#3634) - saveAs uses a stream internally and pipes it to the local file; - path throws an error when called on a remote browser.
2020-08-26 12:46:30 -07:00
# Blocks path/failure/delete/context.close until the stream is closed.
saveAsStream:
returns:
stream: Stream
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
failure:
returns:
error: string?
stream:
returns:
stream: Stream?
delete:
Stream:
type: interface
commands:
read:
parameters:
size: number?
returns:
binary: binary
fix(downloads): make path/saveAs work when connected remotely (#3634) - saveAs uses a stream internally and pipes it to the local file; - path throws an error when called on a remote browser.
2020-08-26 12:46:30 -07:00
close:
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
CDPSession:
type: interface
commands:
send:
parameters:
method: string
feat(rpc): introduce JSON type in the protocol for arbitrary blobs (#3367)
2020-08-10 11:20:32 -07:00
params: json?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
returns:
feat(rpc): introduce JSON type in the protocol for arbitrary blobs (#3367)
2020-08-10 11:20:32 -07:00
result: json
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
detach:
events:
event:
parameters:
method: string
feat(rpc): introduce JSON type in the protocol for arbitrary blobs (#3367)
2020-08-10 11:20:32 -07:00
params: json?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
Electron:
type: interface
commands:
launch:
parameters:
executablePath: string
args:
type: array?
items: string
cwd: string?
env:
type: array?
items:
type: object
properties:
name: string
value: string
handleSIGINT: boolean?
handleSIGTERM: boolean?
handleSIGHUP: boolean?
timeout: number?
returns:
electronApplication: ElectronApplication
ElectronApplication:
type: interface
commands:
newBrowserWindow:
parameters:
arg: SerializedArgument
returns:
page: Page
evaluateExpression:
parameters:
expression: string
isFunction: boolean
arg: SerializedArgument
returns:
value: SerializedValue
evaluateExpressionHandle:
parameters:
expression: string
isFunction: boolean
arg: SerializedArgument
returns:
handle: JSHandle
close:
events:
feat(rpc): make ElectronApplication a scope (#3159)
2020-07-24 16:22:20 -07:00
# This event happens once immediately after creation.
context:
parameters:
context: BrowserContext
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
close:
window:
parameters:
page: Page
browserWindow: JSHandle
Reference in New Issue Copy Permalink