Default package
Get desktop application:
View/edit binary Protocol Buffers messages
service Playwright
playwright.proto:458rpc AddCookie (, )
playwright.proto:462Cookie messages
Locator handlers
message
playwright.proto:126string selector = 1
bool noWaitAfter = 2
string times = 3
repeated handlerSpecs = 4
rpc AddStyleTag (, )
playwright.proto:521Adds a <style> to head of site.
message
playwright.proto:282string content = 1
rpc AdvanceClock (, )
playwright.proto:627message
playwright.proto:34int32 time = 1
string advanceType = 2
rpc AriaSnapShot (, )
playwright.proto:460Aria Snapshot
message
playwright.proto:20string locator = 1
bool strict = 2
rpc CallExtensionKeyword (, stream )
playwright.proto:615message
playwright.proto:109string name = 1
string arguments = 2
rpc CancelDownload (, )
playwright.proto:606rpc CheckCheckbox (, )
playwright.proto:505Checks checkbox specified by selector
rpc ClearPermissions (, )
playwright.proto:611rpc ClearText (, )
playwright.proto:482Wraps playwrights page.fill with empty text to clear input specified with selector
message
playwright.proto:251string selector = 1
bool strict = 2
rpc Click (, )
playwright.proto:527Clicks element specified by selector and options
rpc ClockPauseAt (, )
playwright.proto:626rpc ClockResume (, )
playwright.proto:625rpc CloseAllBrowsers (, )
playwright.proto:597rpc CloseBrowser (, )
playwright.proto:596rpc CloseContext (, )
playwright.proto:598rpc ClosePage (, )
playwright.proto:599message
playwright.proto:25bool runBeforeUnload = 1
message
playwright.proto:450string log = 1
string errors = 2
string console = 3
string pageId = 4
rpc CloseTraceGroup (, )
playwright.proto:601rpc ConnectToBrowser (, )
playwright.proto:595rpc DeleteAllCookies (, )
playwright.proto:464rpc DeselectOption (, )
playwright.proto:503Deselects options in Select element matching selector
rpc Download (, )
playwright.proto:525Download url content
rpc EmulateMedia (, )
playwright.proto:621message
playwright.proto:95string colorScheme = 1
string forcedColors = 2
string media = 3
string reducedMotion = 4
Evaluates javascript on the active page
message
playwright.proto:354string selector = 1
string script = 2
string arg = 3
bool allElements = 4
bool strict = 5
rpc FillText (, )
playwright.proto:480Wraps playwrights page.fill to fill text of input specified with selector
message
playwright.proto:244string selector = 1
string text = 2
bool strict = 3
bool force = 4
rpc Focus (, )
playwright.proto:533Focuses element specified by selector
rpc GetBoolProperty (, )
playwright.proto:489Gets the boolean DOM property 'property' of selector specified element
message
playwright.proto:400string log = 1
bool body = 2
rpc GetBoundingBox (, )
playwright.proto:547Gets elements x, y coordinates and width, height as json object
rpc GetByX (, )
playwright.proto:515Returns references to a Playwirght element handle.
message
playwright.proto:68string strategy = 1
string text = 2
string options = 3
bool strict = 4
bool all = 5
string frameSelector = 6
rpc GetConsoleLog (, )
playwright.proto:602rpc GetCookies (, )
playwright.proto:463rpc GetDevice (, )
playwright.proto:558message
playwright.proto:336string name = 1
rpc GetDevices (, )
playwright.proto:559rpc GetDomProperty (, )
playwright.proto:484Gets the DOM property 'property' of selector specified element
rpc GetDownloadState (, )
playwright.proto:605rpc GetElement (, )
playwright.proto:511Returns a reference to a Playwirght element handle.
Gets the XML attribute 'attribute' of selector specified element
rpc GetElementCount (, )
playwright.proto:476Returns the count of elements found with selector
rpc GetElementStates (, )
playwright.proto:517Returns all Element states as IntFlag
rpc GetElements (, )
playwright.proto:513Returns references to multiple Playwirght element handles.
rpc GetErrorMessages (, )
playwright.proto:603rpc GetPageSource (, )
playwright.proto:495Gets pages HTML code
rpc GetSelectContent (, )
playwright.proto:499Gets the Select element specified by selector and returns the contents
rpc GetStyle (, )
playwright.proto:545Gets an elements computed style
message
playwright.proto:362string selector = 1
string pseudo = 2
string styleKey = 3
bool strict = 4
rpc GetTableRowIndex (, )
playwright.proto:575rpc GetText (, )
playwright.proto:485rpc GetTitle (, )
playwright.proto:474Gets title of currently open Playwright page
rpc GetUrl (, )
playwright.proto:493Returns current playwright page url
rpc GetViewportSize (, )
playwright.proto:491Wraps playwrights page.textContent, returns textcontent of element by selector
rpc GoBack (, )
playwright.proto:470Navigate to the next page in history
rpc GoForward (, )
playwright.proto:472Navigate to the previous page in history.
rpc GoTo (, )
playwright.proto:468Opens the url in currently open Playwright page
rpc GrantPermissions (, )
playwright.proto:609message
playwright.proto:186repeated string permissions = 1
string origin = 2
rpc HandleAlert (, )
playwright.proto:565rpc Health (, )
playwright.proto:509Health check endpoint for the service
Highlights elements matching selector for duration
message
playwright.proto:292string selector = 1
int32 duration = 2
string width = 3
string style = 4
string color = 5
bool strict = 6
string mode = 7
rpc Hover (, )
playwright.proto:531Hovers an element specified by selector and options
rpc HttpRequest (, )
playwright.proto:549Makes a `fetch` request in the browser
message
playwright.proto:324string url = 1
string method = 2
string body = 3
string headers = 4
Extension handling
message
playwright.proto:393string log = 1
repeated string keywords = 2
repeated string keywordDocumentations = 3
repeated string keywordArguments = 4
rpc KeyboardInput (, )
playwright.proto:573message
playwright.proto:162string action = 1
string input = 2
int32 delay = 3
rpc KeyboardKey (, )
playwright.proto:572message
playwright.proto:157string action = 1
string key = 2
rpc MergeCoverage (, )
playwright.proto:632message
playwright.proto:48string input_folder = 1
string output_folder = 2
string config = 3
string name = 4
repeated string reports = 5
rpc MouseButton (, )
playwright.proto:568message
playwright.proto:147string action = 1
string json = 2
rpc MouseMove (, )
playwright.proto:569rpc MouseWheel (, )
playwright.proto:570message
playwright.proto:152int32 deltaX = 1
int32 deltaY = 2
rpc NewBrowser (, )
playwright.proto:591rpc NewContext (, )
playwright.proto:590message
playwright.proto:173string rawOptions = 1
int32 defaultTimeout = 2
string traceFile = 3
message
playwright.proto:425string id = 1
string log = 2
string contextOptions = 3
bool newBrowser = 4
rpc NewPage (, )
playwright.proto:589message
playwright.proto:442string log = 1
string body = 2
string video = 3
bool newBrowser = 4
bool newContext = 5
message
playwright.proto:179string browser = 1
string rawOptions = 2
int32 defaultTimeout = 3
string traceFile = 4
message
playwright.proto:432string id = 1
string log = 2
string contextOptions = 3
bool newBrowser = 4
string video = 5
string pageId = 6
string browserId = 7
rpc OpenTraceGroup (, )
playwright.proto:600message
playwright.proto:56string name = 1
string file = 2
int32 line = 3
int32 column = 4
string contextId = 5
rpc Pdf (, )
playwright.proto:620pdf
message
playwright.proto:77bool 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 Press (, )
playwright.proto:497Inputs a list of keypresses to element specified by selector
message
playwright.proto:256string selector = 1
bool strict = 2
repeated string key = 3
int32 pressDelay = 4
int32 keyDelay = 5
rpc RecordSelector (, )
playwright.proto:541message
playwright.proto:64string label = 1
rpc Reload (, )
playwright.proto:583message
playwright.proto:139string selector = 1
rpc SaveStorageState (, )
playwright.proto:607rpc ScrollToElement (, )
playwright.proto:581rpc SelectOption (, )
playwright.proto:501Selects option matching matcher in Select element matching selector
message
playwright.proto:302string selector = 1
string matcherJson = 2
bool strict = 3
rpc SetGeolocation (, )
playwright.proto:556Geolocation
rpc SetOffline (, )
playwright.proto:582rpc SetPeerId (, )
playwright.proto:617rpc SetTime (, )
playwright.proto:624Clock messages
rpc SetTimeout (, )
playwright.proto:519Set's playwright timeout
message
playwright.proto:270float timeout = 1
rpc SetViewportSize (, )
playwright.proto:543Get Page State JSON
message
playwright.proto:319int32 width = 1
int32 height = 2
rpc StartCoverage (, )
playwright.proto:630Coverage
message
playwright.proto:39string coverageType = 1
bool resetOnNavigation = 2
bool reportAnonymousScripts = 3
string configFile = 4
string coverageDir = 5
bool raw = 6
rpc StopCoverage (, )
playwright.proto:631rpc SwitchBrowser (, )
playwright.proto:588rpc SwitchContext (, )
playwright.proto:587rpc SwitchPage (, )
playwright.proto:586Playwright State handling keywords
message
playwright.proto:277string id = 1
float timeout = 2
rpc TakeScreenshot (, )
playwright.proto:466Screen shot method
message
playwright.proto:102string selector = 1
string mask = 2
string options = 3
bool strict = 4
rpc Tap (, )
playwright.proto:529Taps element specified by selector and options
rpc TypeText (, )
playwright.proto:478Wraps playwrights page.type to type text into input specified with selector
message
playwright.proto:236string selector = 1
string text = 2
int32 delay = 3
bool clear = 4
bool strict = 5
rpc UncheckCheckbox (, )
playwright.proto:507Unchecks checkbox specified by selector
rpc UploadFile (, )
playwright.proto:578rpc UploadFileBySelector (stream , )
playwright.proto:579message
playwright.proto:117repeated string path = 1
string selector = 2
bool strict = 3
string name = 4
string mimeType = 5
string buffer = 6
rpc WaitForAlerts (, )
playwright.proto:566message
playwright.proto:346repeated items = 1
message
playwright.proto:389repeated string items = 1
rpc WaitForDownload (, )
playwright.proto:552Waits for element be in a specific state
rpc WaitForFunction (, )
playwright.proto:537Executes javascript on the active page and retries until the expression is true
message
playwright.proto:308string script = 1
string selector = 2
string options = 3
bool strict = 4
message
playwright.proto:212string state = 1
int32 timeout = 2
rpc WaitForRequest (, )
playwright.proto:550rpc WaitForResponse (, stream )
playwright.proto:551
message
playwright.proto:17(message has no fields)
message
playwright.proto:340Used as request type in: Playwright.HandleAlert
Used as field type in:
string alertAction = 1
string promptInput = 2
float timeout = 3
message
playwright.proto:350Used as request type in: Playwright.CloseContext, Playwright.GetBrowserCatalog, Playwright.GetConsoleLog, Playwright.GetErrorMessages, Playwright.SetOffline
bool value = 1
message
playwright.proto:168Used as request type in: Playwright.LaunchBrowserServer, Playwright.NewBrowser
string browser = 1
string rawOptions = 2
message
playwright.proto:29Used as request type in: Playwright.ClockPauseAt, Playwright.SetTime
int32 time = 1
string setType = 2
message
playwright.proto:217Used as request type in: Playwright.CloseBrowserServer, Playwright.ConnectToBrowser
string browser = 1
string url = 2
bool connectCDP = 3
int32 timeout = 4
message
playwright.proto:203Used as request type in: Playwright.CancelDownload, Playwright.GetDownloadState
string id = 1
message
playwright.proto:196Used as request type in: Playwright.Download, Playwright.WaitForDownload
string url = 1
string path = 2
bool waitForFinish = 3
int32 downloadTimeout = 4
message
playwright.proto:230Used as request type in: Playwright.GetBoolProperty, Playwright.GetDomProperty, Playwright.GetElementAttribute
string selector = 1
string property = 2
bool strict = 3
message
playwright.proto:264Used 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:286Used 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:114Used as request type in: Playwright.InitializeExtension, Playwright.SaveStorageState, Playwright.UploadFile
string path = 1
message
playwright.proto:331Used as request type in: Playwright.WaitForRequest, Playwright.WaitForResponse
string urlOrPredicate = 1
float timeout = 2
message
playwright.proto:273Used as request type in: Playwright.SetPeerId, Playwright.SwitchBrowser, Playwright.SwitchContext
string index = 1
message
playwright.proto:143Used as request type in: Playwright.AddCookie, Playwright.ExecutePlaywright, Playwright.MouseMove, Playwright.Reload, Playwright.SetGeolocation
string body = 1
message
playwright.proto:132Used in:
string action = 1
string selector = 2
string value = 3
string optionsAsJson = 4
message
playwright.proto:315string info = 1
message
playwright.proto:224string input = 1
string selector = 2
bool type = 3
message
playwright.proto:191Used in:
string url = 1
int32 defaultTimeout = 2
message
playwright.proto:207Used as request type in: Playwright.GoTo, Playwright.NewPage, Playwright.WaitForNavigation
optional url = 1
string waitUntil = 2
message
playwright.proto:379(message has no fields)
message
playwright.proto:380Used 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.ExecutePlaywright, Playwright.FillText, Playwright.Focus, Playwright.GoBack, Playwright.GoForward, Playwright.GrantPermissions, Playwright.HandleAlert, Playwright.Hover, Playwright.KeyboardInput, Playwright.KeyboardKey, Playwright.MergeCoverage, 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:405Used as response type in: Playwright.GetElementCount, Playwright.GetTableCellIndex, Playwright.GetTableRowIndex, Playwright.HighlightElements
string log = 1
int32 body = 2
message
playwright.proto:420Used as response type in: Playwright.EvaluateJavascript, Playwright.RecordSelector
string log = 1
string result = 2
message
playwright.proto:414Used 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:410Used as response type in: Playwright.GetSelectContent, Playwright.SelectOption
repeated entry = 1
message
playwright.proto:384Used as response type in: Playwright.AriaSnapShot, 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:370(message has no fields)
message
playwright.proto:371Used in:
string value = 2
string label = 3
int32 index = 4
bool selected = 5