Default package
Get desktop application:
View/edit binary Protocol Buffers messages
service Playwright
playwright.proto:443rpc AddCookie (, )
playwright.proto:445Cookie messages
rpc GetCookies (, )
playwright.proto:446rpc DeleteAllCookies (, )
playwright.proto:447rpc TakeScreenshot (, )
playwright.proto:449Screen shot method
message
playwright.proto:89string selector = 1
string mask = 2
string options = 3
bool strict = 4
rpc GoTo (, )
playwright.proto:451Opens the url in currently open Playwright page
rpc GoBack (, )
playwright.proto:453Navigate to the next page in history
rpc GoForward (, )
playwright.proto:455Navigate to the previous page in history.
rpc GetTitle (, )
playwright.proto:457Gets title of currently open Playwright page
rpc GetElementCount (, )
playwright.proto:459Returns the count of elements found with selector
rpc TypeText (, )
playwright.proto:461Wraps playwrights page.type to type text into input specified with selector
message
playwright.proto:223string selector = 1
string text = 2
int32 delay = 3
bool clear = 4
bool strict = 5
rpc FillText (, )
playwright.proto:463Wraps playwrights page.fill to fill text of input specified with selector
message
playwright.proto:231string selector = 1
string text = 2
bool strict = 3
bool force = 4
rpc ClearText (, )
playwright.proto:465Wraps playwrights page.fill with empty text to clear input specified with selector
message
playwright.proto:238string selector = 1
bool strict = 2
rpc GetDomProperty (, )
playwright.proto:467Gets the DOM property 'property' of selector specified element
rpc GetText (, )
playwright.proto:468Gets the XML attribute 'attribute' of selector specified element
rpc GetBoolProperty (, )
playwright.proto:472Gets the boolean DOM property 'property' of selector specified element
message
playwright.proto:385string log = 1
bool body = 2
rpc GetViewportSize (, )
playwright.proto:474Wraps playwrights page.textContent, returns textcontent of element by selector
rpc GetUrl (, )
playwright.proto:476Returns current playwright page url
rpc GetPageSource (, )
playwright.proto:478Gets pages HTML code
rpc Press (, )
playwright.proto:480Inputs a list of keypresses to element specified by selector
message
playwright.proto:243string selector = 1
bool strict = 2
repeated string key = 3
rpc GetSelectContent (, )
playwright.proto:482Gets the Select element specified by selector and returns the contents
rpc SelectOption (, )
playwright.proto:484Selects option matching matcher in Select element matching selector
message
playwright.proto:287string selector = 1
string matcherJson = 2
bool strict = 3
rpc DeselectOption (, )
playwright.proto:486Deselects options in Select element matching selector
rpc CheckCheckbox (, )
playwright.proto:488Checks checkbox specified by selector
rpc UncheckCheckbox (, )
playwright.proto:490Unchecks checkbox specified by selector
rpc Health (, )
playwright.proto:492Health check endpoint for the service
rpc GetElement (, )
playwright.proto:494Returns a reference to a Playwirght element handle.
rpc GetElements (, )
playwright.proto:496Returns references to multiple Playwirght element handles.
rpc GetByX (, )
playwright.proto:498Returns references to a Playwirght element handle.
message
playwright.proto:55string strategy = 1
string text = 2
string options = 3
bool strict = 4
bool all = 5
string frameSelector = 6
rpc GetElementStates (, )
playwright.proto:500Returns all Element states as IntFlag
rpc SetTimeout (, )
playwright.proto:502Set's playwright timeout
message
playwright.proto:255float timeout = 1
rpc AddStyleTag (, )
playwright.proto:504Adds a <style> to head of site.
message
playwright.proto:267string content = 1
Highlights elements matching selector for duration
message
playwright.proto:277string selector = 1
int32 duration = 2
string width = 3
string style = 4
string color = 5
bool strict = 6
string mode = 7
rpc Download (, )
playwright.proto:508Download url content
rpc Click (, )
playwright.proto:510Clicks element specified by selector and options
rpc Tap (, )
playwright.proto:512Taps element specified by selector and options
rpc Hover (, )
playwright.proto:514Hovers an element specified by selector and options
rpc Focus (, )
playwright.proto:516Focuses element specified by selector
Waits for element be in a specific state
rpc WaitForFunction (, )
playwright.proto:520Executes javascript on the active page and retries until the expression is true
message
playwright.proto:293string script = 1
string selector = 2
string options = 3
bool strict = 4
Evaluates javascript on the active page
message
playwright.proto:339string selector = 1
string script = 2
string arg = 3
bool allElements = 4
bool strict = 5
rpc RecordSelector (, )
playwright.proto:524message
playwright.proto:51string label = 1
rpc SetViewportSize (, )
playwright.proto:526Get Page State JSON
message
playwright.proto:304int32 width = 1
int32 height = 2
rpc GetStyle (, )
playwright.proto:528Gets an elements computed style
message
playwright.proto:347string selector = 1
string pseudo = 2
string styleKey = 3
bool strict = 4
rpc GetBoundingBox (, )
playwright.proto:530Gets elements x, y coordinates and width, height as json object
rpc HttpRequest (, )
playwright.proto:532Makes a `fetch` request in the browser
message
playwright.proto:309string url = 1
string method = 2
string body = 3
string headers = 4
rpc WaitForRequest (, )
playwright.proto:533rpc WaitForResponse (, stream )
playwright.proto:534rpc WaitForDownload (, )
playwright.proto:535message
playwright.proto:199string state = 1
int32 timeout = 2
rpc SetGeolocation (, )
playwright.proto:539Geolocation
rpc GetDevice (, )
playwright.proto:541message
playwright.proto:321string name = 1
rpc GetDevices (, )
playwright.proto:542Locator handlers
message
playwright.proto:113string selector = 1
bool noWaitAfter = 2
string times = 3
repeated handlerSpecs = 4
message
playwright.proto:126string selector = 1
rpc HandleAlert (, )
playwright.proto:548rpc WaitForAlerts (, )
playwright.proto:549message
playwright.proto:331repeated items = 1
message
playwright.proto:374repeated string items = 1
rpc MouseButton (, )
playwright.proto:551message
playwright.proto:134string action = 1
string json = 2
rpc MouseMove (, )
playwright.proto:552rpc MouseWheel (, )
playwright.proto:553message
playwright.proto:139int32 deltaX = 1
int32 deltaY = 2
rpc KeyboardKey (, )
playwright.proto:555message
playwright.proto:144string action = 1
string key = 2
rpc KeyboardInput (, )
playwright.proto:556message
playwright.proto:149string action = 1
string input = 2
int32 delay = 3
rpc GetTableRowIndex (, )
playwright.proto:558rpc UploadFile (, )
playwright.proto:561rpc UploadFileBySelector (stream , )
playwright.proto:562message
playwright.proto:104repeated string path = 1
string selector = 2
bool strict = 3
string name = 4
string mimeType = 5
string buffer = 6
rpc ScrollToElement (, )
playwright.proto:564rpc SetOffline (, )
playwright.proto:565rpc Reload (, )
playwright.proto:566rpc SwitchPage (, )
playwright.proto:569Playwright State handling keywords
message
playwright.proto:262string id = 1
float timeout = 2
rpc SwitchContext (, )
playwright.proto:570rpc SwitchBrowser (, )
playwright.proto:571rpc NewPage (, )
playwright.proto:572message
playwright.proto:427string log = 1
string body = 2
string video = 3
bool newBrowser = 4
bool newContext = 5
rpc NewContext (, )
playwright.proto:573message
playwright.proto:160string rawOptions = 1
int32 defaultTimeout = 2
string traceFile = 3
message
playwright.proto:410string id = 1
string log = 2
string contextOptions = 3
bool newBrowser = 4
rpc NewBrowser (, )
playwright.proto:574message
playwright.proto:166string browser = 1
string rawOptions = 2
int32 defaultTimeout = 3
string traceFile = 4
message
playwright.proto:417string id = 1
string log = 2
string contextOptions = 3
bool newBrowser = 4
string video = 5
string pageId = 6
string browserId = 7
rpc ConnectToBrowser (, )
playwright.proto:578rpc CloseBrowser (, )
playwright.proto:579rpc CloseAllBrowsers (, )
playwright.proto:580rpc CloseContext (, )
playwright.proto:581rpc ClosePage (, )
playwright.proto:582message
playwright.proto:20bool runBeforeUnload = 1
message
playwright.proto:435string log = 1
string errors = 2
string console = 3
string pageId = 4
rpc OpenTraceGroup (, )
playwright.proto:583message
playwright.proto:43string name = 1
string file = 2
int32 line = 3
int32 column = 4
string contextId = 5
rpc CloseTraceGroup (, )
playwright.proto:584rpc GetConsoleLog (, )
playwright.proto:585rpc GetErrorMessages (, )
playwright.proto:586rpc GetDownloadState (, )
playwright.proto:588rpc CancelDownload (, )
playwright.proto:589rpc SaveStorageState (, )
playwright.proto:590rpc GrantPermissions (, )
playwright.proto:592message
playwright.proto:173repeated string permissions = 1
string origin = 2
rpc ClearPermissions (, )
playwright.proto:593Extension handling
message
playwright.proto:378string log = 1
repeated string keywords = 2
repeated string keywordDocumentations = 3
repeated string keywordArguments = 4
rpc CallExtensionKeyword (, stream )
playwright.proto:597message
playwright.proto:96string name = 1
string arguments = 2
rpc SetPeerId (, )
playwright.proto:599rpc Pdf (, )
playwright.proto:602pdf
message
playwright.proto:64bool displayHeaderFooter = 1
string footerTemplate = 2
string format = 3
string headerTemplate = 4
string height = 5
bool landscape = 6
string margin = 7
bool outline = 8
string pageRanges = 9
string path = 10
bool preferCSSPageSize = 11
bool printBackground = 12
float scale = 13
bool tagged = 14
string width = 15
rpc EmulateMedia (, )
playwright.proto:603message
playwright.proto:82string colorScheme = 1
string forcedColors = 2
string media = 3
string reducedMotion = 4
rpc SetTime (, )
playwright.proto:606Clock messages
rpc ClockResume (, )
playwright.proto:607rpc ClockPauseAt (, )
playwright.proto:608rpc AdvanceClock (, )
playwright.proto:609message
playwright.proto:29int32 time = 1
string advanceType = 2
rpc StartCoverage (, )
playwright.proto:612Coverage
message
playwright.proto:34string coverageType = 1
bool resetOnNavigation = 2
bool reportAnonymousScripts = 3
string configFile = 4
string coverageDir = 5
bool raw = 6
rpc StopCoverage (, )
playwright.proto:613
message
playwright.proto:17(message has no fields)
message
playwright.proto:325Used as request type in: Playwright.HandleAlert
Used as field type in:
string alertAction = 1
string promptInput = 2
float timeout = 3
message
playwright.proto:335Used as request type in: Playwright.CloseContext, Playwright.GetBrowserCatalog, Playwright.GetConsoleLog, Playwright.GetErrorMessages, Playwright.SetOffline
bool value = 1
message
playwright.proto:155Used as request type in: Playwright.LaunchBrowserServer, Playwright.NewBrowser
string browser = 1
string rawOptions = 2
message
playwright.proto:24Used as request type in: Playwright.ClockPauseAt, Playwright.SetTime
int32 time = 1
string setType = 2
message
playwright.proto:204Used as request type in: Playwright.CloseBrowserServer, Playwright.ConnectToBrowser
string browser = 1
string url = 2
bool connectCDP = 3
int32 timeout = 4
message
playwright.proto:190Used as request type in: Playwright.CancelDownload, Playwright.GetDownloadState
string id = 1
message
playwright.proto:183Used as request type in: Playwright.Download, Playwright.WaitForDownload
string url = 1
string path = 2
bool waitForFinish = 3
int32 downloadTimeout = 4
message
playwright.proto:217Used as request type in: Playwright.GetBoolProperty, Playwright.GetDomProperty, Playwright.GetElementAttribute
string selector = 1
string property = 2
bool strict = 3
message
playwright.proto:249Used as request type in: Playwright.CheckCheckbox, Playwright.DeselectOption, Playwright.Focus, Playwright.GetBoundingBox, Playwright.GetElement, Playwright.GetElementCount, Playwright.GetElementStates, Playwright.GetElements, Playwright.GetSelectContent, Playwright.GetTableCellIndex, Playwright.GetTableRowIndex, Playwright.GetText, Playwright.ScrollToElement, Playwright.UncheckCheckbox
string selector = 1
bool strict = 2
bool force = 3
message
playwright.proto:271Used as request type in: Playwright.Click, Playwright.Hover, Playwright.Tap, Playwright.WaitForElementsState
string selector = 1
string options = 2
bool strict = 3
message
playwright.proto:18Used as request type in: Playwright.ClearPermissions, Playwright.ClockResume, Playwright.CloseAllBrowsers, Playwright.CloseBrowser, Playwright.CloseTraceGroup, Playwright.DeleteAllCookies, Playwright.GetCookies, Playwright.GetDevices, Playwright.GetPageSource, Playwright.GetTitle, Playwright.GetUrl, Playwright.GetViewportSize, Playwright.GoBack, Playwright.GoForward, Playwright.Health, Playwright.StopCoverage
(message has no fields)
message
playwright.proto:101Used as request type in: Playwright.InitializeExtension, Playwright.SaveStorageState, Playwright.UploadFile
string path = 1
message
playwright.proto:316Used as request type in: Playwright.WaitForRequest, Playwright.WaitForResponse
string urlOrPredicate = 1
float timeout = 2
message
playwright.proto:258Used as request type in: Playwright.SetPeerId, Playwright.SwitchBrowser, Playwright.SwitchContext
string index = 1
message
playwright.proto:130Used as request type in: Playwright.AddCookie, Playwright.MouseMove, Playwright.Reload, Playwright.SetGeolocation
string body = 1
message
playwright.proto:119Used in:
string action = 1
string selector = 2
string value = 3
string optionsAsJson = 4
message
playwright.proto:300string info = 1
message
playwright.proto:211string input = 1
string selector = 2
bool type = 3
message
playwright.proto:178Used in:
string url = 1
int32 defaultTimeout = 2
message
playwright.proto:194Used as request type in: Playwright.GoTo, Playwright.NewPage, Playwright.WaitForNavigation
optional url = 1
string waitUntil = 2
message
playwright.proto:364(message has no fields)
message
playwright.proto:365Used as response type in: Playwright.AddCookie, Playwright.AddLocatorHandlerCustom, Playwright.AddStyleTag, Playwright.AdvanceClock, Playwright.CancelDownload, Playwright.CheckCheckbox, Playwright.ClearPermissions, Playwright.ClearText, Playwright.Click, Playwright.ClockPauseAt, Playwright.ClockResume, Playwright.CloseAllBrowsers, Playwright.CloseBrowserServer, Playwright.CloseContext, Playwright.CloseTraceGroup, Playwright.DeleteAllCookies, Playwright.DeselectOption, Playwright.FillText, Playwright.Focus, Playwright.GoBack, Playwright.GoForward, Playwright.GrantPermissions, Playwright.HandleAlert, Playwright.Hover, Playwright.KeyboardInput, Playwright.KeyboardKey, Playwright.MouseButton, Playwright.MouseMove, Playwright.MouseWheel, Playwright.OpenTraceGroup, Playwright.Press, Playwright.Reload, Playwright.RemoveLocatorHandler, Playwright.SaveStorageState, Playwright.ScrollToElement, Playwright.SetGeolocation, Playwright.SetOffline, Playwright.SetTime, Playwright.SetTimeout, Playwright.SetViewportSize, Playwright.StartCoverage, Playwright.Tap, Playwright.TypeText, Playwright.UncheckCheckbox, Playwright.UploadFile, Playwright.UploadFileBySelector, Playwright.WaitForElementsState, Playwright.WaitForNavigation, Playwright.WaitForPageLoadState
string log = 1
message
playwright.proto:390Used as response type in: Playwright.GetElementCount, Playwright.GetTableCellIndex, Playwright.GetTableRowIndex, Playwright.HighlightElements
string log = 1
int32 body = 2
message
playwright.proto:405Used as response type in: Playwright.EvaluateJavascript, Playwright.RecordSelector
string log = 1
string result = 2
message
playwright.proto:399Used as response type in: Playwright.CallExtensionKeyword, Playwright.Download, Playwright.GetBoundingBox, Playwright.GetBrowserCatalog, Playwright.GetByX, Playwright.GetConsoleLog, Playwright.GetCookies, Playwright.GetDevice, Playwright.GetDevices, Playwright.GetDownloadState, Playwright.GetElementStates, Playwright.GetElements, Playwright.GetErrorMessages, Playwright.GetStyle, Playwright.GetViewportSize, Playwright.HttpRequest, Playwright.WaitForDownload, Playwright.WaitForFunction, Playwright.WaitForResponse
string log = 1
string json = 2
string bodyPart = 3
message
playwright.proto:395Used as response type in: Playwright.GetSelectContent, Playwright.SelectOption
repeated entry = 1
message
playwright.proto:369Used as response type in: Playwright.CloseBrowser, Playwright.ConnectToBrowser, Playwright.EmulateMedia, Playwright.GetDomProperty, Playwright.GetElement, Playwright.GetElementAttribute, Playwright.GetPageSource, Playwright.GetText, Playwright.GetTitle, Playwright.GetUrl, Playwright.GoTo, Playwright.Health, Playwright.LaunchBrowserServer, Playwright.NewBrowser, Playwright.Pdf, Playwright.SetPeerId, Playwright.StopCoverage, Playwright.SwitchBrowser, Playwright.SwitchContext, Playwright.SwitchPage, Playwright.TakeScreenshot, Playwright.WaitForRequest
string log = 1
string body = 2
message
playwright.proto:355(message has no fields)
message
playwright.proto:356Used in:
string value = 2
string label = 3
int32 index = 4
bool selected = 5