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

2479 lines
44 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?
chore: expose adb devices and actions (#4647)
2020-12-09 15:06:57 -08:00
Point:
type: object
properties:
x: number
y: number
Rect:
type: object
properties:
x: number
y: number
width: number
height: number
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
feat(state): allow getting / setting context state (#4412)
2020-11-13 14:24:53 -08:00
SetNetworkCookie:
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
NetworkCookie:
type: object
properties:
name: string
value: string
domain: string
path: string
expires: number
httpOnly: boolean
secure: boolean
sameSite:
type: enum
literals:
- Strict
- Lax
- None
NameValue:
type: object
properties:
name: string
value: string
OriginStorage:
type: object
properties:
origin: string
localStorage:
type: array
items: NameValue
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
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
chore: expose adb devices and actions (#4647)
2020-12-09 15:06:57 -08:00
android: Android
electron: Electron
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
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?
feat(state): allow getting / setting context state (#4412)
2020-11-13 14:24:53 -08:00
items: NameValue
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
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?
feat(state): allow getting / setting context state (#4412)
2020-11-13 14:24:53 -08:00
items: NameValue
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
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?
feat(state): allow getting / setting context state (#4412)
2020-11-13 14:24:53 -08:00
items: NameValue
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
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?
chore: allow opening empty trace viewer (#5080)
2021-01-20 19:16:23 -08:00
_traceDir: string?
feat(trace viewer): Adds _debugName BrowserContextOption to let users define a name for their contexts (#5205) This change is adding a new property on the BrowserContextOptions class called `_debugName`. This property allows defining a user-friendly name for the browser context, and currently it is being used in one place, the Trace Viewer. When user provides the new value in the following way: ```typescript const { chromium } = require('playwright'); (async () => { const browser = await chromium.launch(); const context = await browser.newContext({ _traceDir: __dirname, _debugName: 'My custom testcase name' }); await context.close(); await browser.close(); })(); ``` The `_debugName` will be saved in the `*.trace` file for this browser context, on the `context-created` event, under the key `debugName`. Later, when such a trace is displayed using Trace Viewer, the `debugName` will be displayed in the dropdown in the top right part of the app instead of the actual trace filename. Fixes #5157.
2021-01-28 19:50:57 +01:00
_debugName: string?
api(videos): introduce a single recordVideo option bag (#4309) api(videos): introduce a single recordVideo option bag Currently contains `dir` and `size`, previously known as `videosPath` and `videoSize`.
2020-11-02 19:42:05 -08:00
recordVideo:
api: update videos api, hide tracing (#4015)
2020-10-01 11:06:19 -07:00
type: object?
properties:
api(videos): introduce a single recordVideo option bag (#4309) api(videos): introduce a single recordVideo option bag Currently contains `dir` and `size`, previously known as `videosPath` and `videoSize`.
2020-11-02 19:42:05 -08:00
dir: string
size:
type: object?
properties:
width: number
height: number
fix(har): support har in persistent context (#4322)
2020-11-03 11:30:59 -08: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
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?
feat(state): allow getting / setting context state (#4412)
2020-11-13 14:24:53 -08:00
items: NameValue
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
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?
chore: allow opening empty trace viewer (#5080)
2021-01-20 19:16:23 -08:00
_traceDir: string?
feat(trace viewer): Adds _debugName BrowserContextOption to let users define a name for their contexts (#5205) This change is adding a new property on the BrowserContextOptions class called `_debugName`. This property allows defining a user-friendly name for the browser context, and currently it is being used in one place, the Trace Viewer. When user provides the new value in the following way: ```typescript const { chromium } = require('playwright'); (async () => { const browser = await chromium.launch(); const context = await browser.newContext({ _traceDir: __dirname, _debugName: 'My custom testcase name' }); await context.close(); await browser.close(); })(); ``` The `_debugName` will be saved in the `*.trace` file for this browser context, on the `context-created` event, under the key `debugName`. Later, when such a trace is displayed using Trace Viewer, the `debugName` will be displayed in the dropdown in the top right part of the app instead of the actual trace filename. Fixes #5157.
2021-01-28 19:50:57 +01:00
_debugName: string?
api(videos): introduce a single recordVideo option bag (#4309) api(videos): introduce a single recordVideo option bag Currently contains `dir` and `size`, previously known as `videosPath` and `videoSize`.
2020-11-02 19:42:05 -08:00
recordVideo:
feat(screencast): add expreimental public API on context (#3766)
2020-09-04 22:37:38 -07:00
type: object?
properties:
api(videos): introduce a single recordVideo option bag (#4309) api(videos): introduce a single recordVideo option bag Currently contains `dir` and `size`, previously known as `videosPath` and `videoSize`.
2020-11-02 19:42:05 -08:00
dir: string
size:
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(proxy): enable per-context http proxy (#4280)
2020-10-29 16:12:30 -07:00
proxy:
type: object?
properties:
server: string
bypass: string?
username: string?
password: string?
feat(state): allow getting / setting context state (#4412)
2020-11-13 14:24:53 -08:00
storageState:
type: object?
properties:
cookies:
type: array?
items: SetNetworkCookie
origins:
type: array?
items: OriginStorage
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:
fix(electron): return a ChromiumBrowserContext for electron (#4913)
2021-01-13 12:08:14 -08:00
isChromium: boolean
feat(rpc): simplify browser name detection on the client side (#3670)
2020-08-28 10:23:02 -07:00
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
commands:
addCookies:
parameters:
cookies:
type: array
feat(state): allow getting / setting context state (#4412)
2020-11-13 14:24:53 -08:00
items: SetNetworkCookie
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
addInitScript:
parameters:
source: string
clearCookies:
clearPermissions:
close:
cookies:
parameters:
urls:
type: array
items: string
returns:
cookies:
type: array
feat(state): allow getting / setting context state (#4412)
2020-11-13 14:24:53 -08:00
items: NetworkCookie
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
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
feat(state): allow getting / setting context state (#4412)
2020-11-13 14:24:53 -08:00
items: NameValue
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
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
feat(state): allow getting / setting context state (#4412)
2020-11-13 14:24:53 -08:00
storageState:
returns:
cookies:
type: array
items: NetworkCookie
origins:
type: array
items: OriginStorage
chore: introduce debug toolbar (#5145)
2021-01-25 14:49:26 -08:00
pause:
experimental: True
chore: make recorder a supplement (#5131)
2021-01-24 19:21:19 -08:00
recorderSupplementEnable:
feat(cli): share console api between cli and debug mode (#4807)
2020-12-23 14:15:16 -08:00
experimental: True
chore: make recorder a supplement (#5131)
2021-01-24 19:21:19 -08:00
parameters:
language: string
feat(pause): make page.pause public (#5288)
2021-02-03 16:01:51 -08:00
startRecording: boolean?
chore: introduce debug toolbar (#5145)
2021-01-25 14:49:26 -08:00
launchOptions: json?
contextOptions: json?
chore: make recorder a supplement (#5131)
2021-01-24 19:21:19 -08:00
device: string?
saveStorage: string?
chore: introduce debug toolbar (#5145)
2021-01-25 14:49:26 -08:00
terminal: boolean?
outputFile: string?
feat(cli): share console api between cli and debug mode (#4807)
2020-12-23 14:15:16 -08:00
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
crNewCDPSession:
parameters:
page: Page
returns:
session: CDPSession
fix: update terminal size dynamically (#5250)
2021-02-02 14:25:51 -08:00
setTerminalSizeNoReply:
parameters:
rows: number?
columns: number?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
events:
bindingCall:
parameters:
binding: BindingCall
close:
page:
parameters:
page: Page
route:
parameters:
route: Route
request: Request
chore: introduce debug toolbar (#5145)
2021-01-25 14:49:26 -08:00
stdout:
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
parameters:
chore: introduce debug toolbar (#5145)
2021-01-25 14:49:26 -08:00
data: binary
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
chore: introduce debug toolbar (#5145)
2021-01-25 14:49:26 -08:00
stderr:
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
parameters:
chore: introduce debug toolbar (#5145)
2021-01-25 14:49:26 -08:00
data: binary
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
chore: introduce debug toolbar (#5145)
2021-01-25 14:49:26 -08:00
crBackgroundPage:
chore: make recorder a supplement (#5131)
2021-01-24 19:21:19 -08:00
parameters:
chore: introduce debug toolbar (#5145)
2021-01-25 14:49:26 -08:00
page: Page
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
chore: introduce debug toolbar (#5145)
2021-01-25 14:49:26 -08:00
crServiceWorker:
chore: make recorder a supplement (#5131)
2021-01-24 19:21:19 -08:00
parameters:
chore: introduce debug toolbar (#5145)
2021-01-25 14:49:26 -08:00
worker: Worker
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
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?
chore: expose adb devices and actions (#4647)
2020-12-09 15:06:57 -08:00
clip: Rect?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
returns:
binary: binary
setExtraHTTPHeaders:
parameters:
headers:
type: array
feat(state): allow getting / setting context state (#4412)
2020-11-13 14:24:53 -08:00
items: NameValue
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
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(websocket): implement Web Sockets for Chromium & WebKit (#4234)
2020-10-26 22:20:43 -07:00
webSocket:
parameters:
webSocket: WebSocket
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
feat: auto-detect expression/function in js server (#5284)
2021-02-03 13:49:25 -08:00
isFunction: boolean?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
arg: SerializedArgument
returns:
value: SerializedValue
evalOnSelectorAll:
parameters:
selector: string
expression: string
feat: auto-detect expression/function in js server (#5284)
2021-02-03 13:49:25 -08:00
isFunction: boolean?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
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
chore: expose adb devices and actions (#4647)
2020-12-09 15:06:57 -08:00
position: Point?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
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
chore: expose adb devices and actions (#4647)
2020-12-09 15:06:57 -08:00
position: Point?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
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
feat: auto-detect expression/function in js server (#5284)
2021-02-03 13:49:25 -08:00
isFunction: boolean?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
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
feat: auto-detect expression/function in js server (#5284)
2021-02-03 13:49:25 -08:00
isFunction: boolean?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
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
chore: expose adb devices and actions (#4647)
2020-12-09 15:06:57 -08:00
position: Point?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
timeout: number?
innerHTML:
parameters:
selector: string
timeout: number?
returns:
value: string
innerText:
parameters:
selector: string
timeout: number?
returns:
value: string
api: add isChecked method (#4953) This adds `{Page,Frame}.isChecked(selector)` and `ElementHandle.isChecked()` methods. Useful to do assertions in tests: ```js await page.click('text="Add TODO"'); expect(await page.isChecked('.item-done')).toBe(false); ```
2021-01-08 17:36:17 -08:00
isChecked:
parameters:
selector: string
timeout: number?
returns:
value: boolean
api: add isVisible, isHidden, isEnabled, isDisabled and isEditable (#4915) These methods are useful for verification in tests, e.g. ```js expect(await page.isEnabled(':text("Remove All")')).toBe(false); await page.click(':text("Add Item")'); expect(await page.isVisible('.item:text("new item")')).toBe(true); expect(await page.isEnabled(':text("Remove All")')).toBe(true); ```
2021-01-08 12:27:54 -08:00
isDisabled:
parameters:
selector: string
timeout: number?
returns:
value: boolean
isEnabled:
parameters:
selector: string
timeout: number?
returns:
value: boolean
isHidden:
parameters:
selector: string
timeout: number?
returns:
value: boolean
isVisible:
parameters:
selector: string
timeout: number?
returns:
value: boolean
isEditable:
parameters:
selector: string
timeout: number?
returns:
value: boolean
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
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
fix(protocol): annotate file buffer as binary (#4272)
2020-10-28 10:55:20 -07:00
buffer: binary
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
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
chore: expose adb devices and actions (#4647)
2020-12-09 15:06:57 -08:00
position: Point?
feat: tap (#4097)
2020-10-19 10:07:33 -07:00
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
feat: auto-detect expression/function in js server (#5284)
2021-02-03 13:49:25 -08:00
isFunction: boolean?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
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?
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
feat: auto-detect expression/function in js server (#5284)
2021-02-03 13:49:25 -08:00
isFunction: boolean?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
arg: SerializedArgument
returns:
value: SerializedValue
evaluateExpressionHandle:
parameters:
expression: string
feat: auto-detect expression/function in js server (#5284)
2021-02-03 13:49:25 -08:00
isFunction: boolean?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
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
feat: auto-detect expression/function in js server (#5284)
2021-02-03 13:49:25 -08:00
isFunction: boolean?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
arg: SerializedArgument
returns:
value: SerializedValue
evaluateExpressionHandle:
parameters:
expression: string
feat: auto-detect expression/function in js server (#5284)
2021-02-03 13:49:25 -08:00
isFunction: boolean?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
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
feat: auto-detect expression/function in js server (#5284)
2021-02-03 13:49:25 -08:00
isFunction: boolean?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
arg: SerializedArgument
returns:
value: SerializedValue
evalOnSelectorAll:
parameters:
selector: string
expression: string
feat: auto-detect expression/function in js server (#5284)
2021-02-03 13:49:25 -08:00
isFunction: boolean?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
arg: SerializedArgument
returns:
value: SerializedValue
boundingBox:
returns:
chore: expose adb devices and actions (#4647)
2020-12-09 15:06:57 -08:00
value: Rect?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
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
chore: expose adb devices and actions (#4647)
2020-12-09 15:06:57 -08:00
position: Point?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
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
chore: expose adb devices and actions (#4647)
2020-12-09 15:06:57 -08:00
position: Point?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
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
chore: expose adb devices and actions (#4647)
2020-12-09 15:06:57 -08:00
position: Point?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
timeout: number?
innerHTML:
returns:
value: string
innerText:
returns:
value: string
api: add isChecked method (#4953) This adds `{Page,Frame}.isChecked(selector)` and `ElementHandle.isChecked()` methods. Useful to do assertions in tests: ```js await page.click('text="Add TODO"'); expect(await page.isChecked('.item-done')).toBe(false); ```
2021-01-08 17:36:17 -08:00
isChecked:
returns:
value: boolean
api: add isVisible, isHidden, isEnabled, isDisabled and isEditable (#4915) These methods are useful for verification in tests, e.g. ```js expect(await page.isEnabled(':text("Remove All")')).toBe(false); await page.click(':text("Add Item")'); expect(await page.isVisible('.item:text("new item")')).toBe(true); expect(await page.isEnabled(':text("Remove All")')).toBe(true); ```
2021-01-08 12:27:54 -08:00
isDisabled:
returns:
value: boolean
isEditable:
returns:
value: boolean
isEnabled:
returns:
value: boolean
isHidden:
returns:
value: boolean
isVisible:
returns:
value: boolean
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
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
fix(protocol): annotate file buffer as binary (#4272)
2020-10-28 10:55:20 -07:00
buffer: binary
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
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
chore: expose adb devices and actions (#4647)
2020-12-09 15:06:57 -08:00
position: Point?
feat: tap (#4097)
2020-10-19 10:07:33 -07:00
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: add isVisible, isHidden, isEnabled, isDisabled and isEditable (#4915) These methods are useful for verification in tests, e.g. ```js expect(await page.isEnabled(':text("Remove All")')).toBe(false); await page.click(':text("Add Item")'); expect(await page.isVisible('.item:text("new item")')).toBe(true); expect(await page.isEnabled(':text("Remove All")')).toBe(true); ```
2021-01-08 12:27:54 -08:00
- editable
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
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:
feat(route): support URL overrides in continue (#4438)
2020-11-16 09:59:00 -08:00
url: string?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
method: string?
headers:
type: array?
feat(state): allow getting / setting context state (#4412)
2020-11-13 14:24:53 -08:00
items: NameValue
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(state): allow getting / setting context state (#4412)
2020-11-13 14:24:53 -08:00
items: NameValue
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?
feat(websocket): implement Web Sockets for Chromium & WebKit (#4234)
2020-10-26 22:20:43 -07:00
WebSocket:
type: interface
initializer:
url: string
events:
open:
frameSent:
parameters:
opcode: number
data: string
frameReceived:
parameters:
opcode: number
data: string
fix(protocol): rename websocket error event to socketerror (#4495) This is to avoid special handling of error events in node.
2020-11-19 12:09:42 -08:00
socketError:
feat(websocket): implement Web Sockets for Chromium & WebKit (#4234)
2020-10-26 22:20:43 -07:00
parameters:
error: string
close:
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
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:
docs: document electron api (#5229)
2021-02-01 11:43:26 -08:00
executablePath: string?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
args:
type: array?
items: string
cwd: string?
env:
type: array?
feat(state): allow getting / setting context state (#4412)
2020-11-13 14:24:53 -08:00
items: NameValue
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
timeout: number?
returns:
electronApplication: ElectronApplication
ElectronApplication:
type: interface
commands:
evaluateExpression:
parameters:
expression: string
feat: auto-detect expression/function in js server (#5284)
2021-02-03 13:49:25 -08:00
isFunction: boolean?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
arg: SerializedArgument
returns:
value: SerializedValue
evaluateExpressionHandle:
parameters:
expression: string
feat: auto-detect expression/function in js server (#5284)
2021-02-03 13:49:25 -08:00
isFunction: boolean?
feat(rpc): convert protocol to yaml (#3102)
2020-07-22 19:38:19 -07:00
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
chore: expose adb devices and actions (#4647)
2020-12-09 15:06:57 -08:00
Android:
type: interface
commands:
devices:
returns:
devices:
type: array
items: AndroidDevice
feat(adb): support webviews (#4657)
2020-12-09 17:15:24 -08:00
setDefaultTimeoutNoReply:
parameters:
timeout: number
chore: expose adb devices and actions (#4647)
2020-12-09 15:06:57 -08:00
feat(android): expose installAPK(path) and ADB socket (#4689)
2020-12-12 18:36:38 +01:00
AndroidSocket:
type: interface
commands:
write:
parameters:
data: binary
close:
events:
data:
parameters:
data: binary
fix(android): leaking adb socket connections (#4730)
2020-12-16 05:15:25 +01:00
close:
chore: expose adb devices and actions (#4647)
2020-12-09 15:06:57 -08:00
AndroidDevice:
type: interface
initializer:
model: string
serial: string
commands:
wait:
parameters:
selector: AndroidSelector
state:
type: enum?
literals:
- gone
timeout: number?
fill:
parameters:
selector: AndroidSelector
text: string
timeout: number?
tap:
parameters:
selector: AndroidSelector
duration: number?
timeout: number?
drag:
parameters:
selector: AndroidSelector
dest: Point
speed: number?
timeout: number?
feat(android): expose installAPK(path) and ADB socket (#4689)
2020-12-12 18:36:38 +01:00
chore: expose adb devices and actions (#4647)
2020-12-09 15:06:57 -08:00
fling:
parameters:
selector: AndroidSelector
direction:
type: enum
literals:
- up
- down
- left
- right
speed: number?
timeout: number?
feat(android): expose installAPK(path) and ADB socket (#4689)
2020-12-12 18:36:38 +01:00
chore: expose adb devices and actions (#4647)
2020-12-09 15:06:57 -08:00
longTap:
parameters:
selector: AndroidSelector
timeout: number?
feat(android): expose installAPK(path) and ADB socket (#4689)
2020-12-12 18:36:38 +01:00
chore: expose adb devices and actions (#4647)
2020-12-09 15:06:57 -08:00
pinchClose:
parameters:
selector: AndroidSelector
percent: number
speed: number?
timeout: number?
pinchOpen:
parameters:
selector: AndroidSelector
percent: number
speed: number?
timeout: number?
scroll:
parameters:
selector: AndroidSelector
direction:
type: enum
literals:
- up
- down
- left
- right
percent: number
speed: number?
timeout: number?
swipe:
parameters:
selector: AndroidSelector
direction:
type: enum
literals:
- up
- down
- left
- right
percent: number
speed: number?
timeout: number?
info:
parameters:
selector: AndroidSelector
returns:
info: AndroidElementInfo
feat(adb): expose a11y tree (#4694)
2020-12-13 08:14:32 -08:00
tree:
returns:
tree: AndroidElementInfo
feat(adb): add screenshot (#4701)
2020-12-13 23:20:13 -08:00
screenshot:
returns:
binary: binary
chore: expose adb devices and actions (#4647)
2020-12-09 15:06:57 -08:00
inputType:
parameters:
text: string
inputPress:
parameters:
key: string
inputTap:
parameters:
point: Point
inputSwipe:
parameters:
segments:
type: array
items: Point
steps: number
inputDrag:
parameters:
from: Point
to: Point
steps: number
launchBrowser:
parameters:
fix(adb): force page scale factor update on connection (#4755)
2020-12-17 18:28:49 -08:00
pkg: string?
chore: expose adb devices and actions (#4647)
2020-12-09 15:06:57 -08:00
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: NameValue
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?
chore: allow opening empty trace viewer (#5080)
2021-01-20 19:16:23 -08:00
_traceDir: string?
feat(trace viewer): Adds _debugName BrowserContextOption to let users define a name for their contexts (#5205) This change is adding a new property on the BrowserContextOptions class called `_debugName`. This property allows defining a user-friendly name for the browser context, and currently it is being used in one place, the Trace Viewer. When user provides the new value in the following way: ```typescript const { chromium } = require('playwright'); (async () => { const browser = await chromium.launch(); const context = await browser.newContext({ _traceDir: __dirname, _debugName: 'My custom testcase name' }); await context.close(); await browser.close(); })(); ``` The `_debugName` will be saved in the `*.trace` file for this browser context, on the `context-created` event, under the key `debugName`. Later, when such a trace is displayed using Trace Viewer, the `debugName` will be displayed in the dropdown in the top right part of the app instead of the actual trace filename. Fixes #5157.
2021-01-28 19:50:57 +01:00
_debugName: string?
chore: expose adb devices and actions (#4647)
2020-12-09 15:06:57 -08:00
recordVideo:
type: object?
properties:
dir: string
size:
type: object?
properties:
width: number
height: number
recordHar:
type: object?
properties:
omitContent: boolean?
path: string
proxy:
type: object?
properties:
server: string
bypass: string?
username: string?
password: string?
returns:
context: BrowserContext
feat(android): expose installAPK(path) and ADB socket (#4689)
2020-12-12 18:36:38 +01:00
open:
parameters:
command: string
returns:
socket: AndroidSocket
chore: expose adb devices and actions (#4647)
2020-12-09 15:06:57 -08:00
shell:
parameters:
command: string
returns:
feat(adb): make shell return binary (#4695)
2020-12-13 08:33:35 -08:00
result: binary
chore: expose adb devices and actions (#4647)
2020-12-09 15:06:57 -08:00
feat(android): expose installAPK(path) and ADB socket (#4689)
2020-12-12 18:36:38 +01:00
installApk:
parameters:
file: binary
args:
type: array?
items: string
feat(adb): implement push (#4697)
2020-12-13 22:00:37 -08:00
push:
parameters:
file: binary
path: string
mode: number?
feat(adb): support webviews (#4657)
2020-12-09 17:15:24 -08:00
setDefaultTimeoutNoReply:
parameters:
timeout: number
connectToWebView:
parameters:
pid: number
returns:
context: BrowserContext
chore: expose adb devices and actions (#4647)
2020-12-09 15:06:57 -08:00
close:
feat(adb): support webviews (#4657)
2020-12-09 17:15:24 -08:00
events:
webViewAdded:
parameters:
webView: AndroidWebView
webViewRemoved:
parameters:
pid: number
AndroidWebView:
type: object
properties:
pid: number
pkg: string
AndroidSelector:
type: object
properties:
checkable: boolean?
checked: boolean?
clazz: string?
clickable: boolean?
depth: number?
desc: string?
enabled: boolean?
focusable: boolean?
focused: boolean?
hasChild:
type: object?
properties:
selector: AndroidSelector
hasDescendant:
type: object?
properties:
selector: AndroidSelector
maxDepth: number?
longClickable: boolean?
pkg: string?
res: string?
scrollable: boolean?
selected: boolean?
text: string?
AndroidElementInfo:
type: object
properties:
feat(adb): expose a11y tree (#4694)
2020-12-13 08:14:32 -08:00
children:
type: array?
items: AndroidElementInfo
feat(adb): support webviews (#4657)
2020-12-09 17:15:24 -08:00
clazz: string
desc: string
res: string
pkg: string
text: string
bounds: Rect
checkable: boolean
checked: boolean
clickable: boolean
enabled: boolean
focusable: boolean
focused: boolean
longClickable: boolean
scrollable: boolean
selected: boolean
Reference in New Issue Copy Permalink