# WebDriver Protocol
## newSession[](#newsession "Direct link to newSession")
The New Session command creates a new WebDriver session with the endpoint node. If the creation fails, a session not created error is returned.** **`session`:** Object containing sessionId and capabilities of created WebDriver session.
***
## deleteSession[](#deletesession "Direct link to deleteSession")
The Delete Session command closes any top-level browsing contexts associated with the current session, terminates the connection, and finally closes the current session.** **`status`:** Object containing status of the driver status.
***
## getTimeouts[](#gettimeouts "Direct link to getTimeouts")
The Get Timeouts command gets timeout durations associated with the current session.** **`timeouts`:** Object containing timeout durations for `script`, `pageLoad` and `implicit` timeouts.
***
## setTimeouts[](#settimeouts "Direct link to setTimeouts")
The Set Timeouts command sets timeout durations associated with the current session. The timeouts that can be controlled are listed in the table of session timeouts below.** **`url`:** current top-level browsing context’s active document’s document URL
***
## navigateTo[](#navigateto "Direct link to navigateTo")
The navigateTo (go) command is used to cause the user agent to navigate the current top-level browsing context a new location.** **`title`:** Returns a string which is the same as `document.title` of the current top-level browsing context.
***
## getWindowHandle[](#getwindowhandle "Direct link to getWindowHandle")
The Get Window Handle command returns the window handle for the current top-level browsing context. It can be used as an argument to Switch To Window.** **`handle`:** Returns a string which is the window handle for the current top-level browsing context.
***
## closeWindow[](#closewindow "Direct link to closeWindow")
The Close Window command closes the current top-level browsing context. Once done, if there are no more top-level browsing contexts open, the WebDriver session itself is closed.** **`window`:** New window object containing 'handle' with the value of the handle and 'type' with the value of the created window type
***
## getWindowHandles[](#getwindowhandles "Direct link to getWindowHandles")
The Get Window Handles command returns a list of window handles for every open top-level browsing context. The order in which the window handles are returned is arbitrary.** **`handles`:** An array which is a list of window handles.
***
## printPage[](#printpage "Direct link to printPage")
The Print Page command renders the document to a paginated PDF document. **Note:** Chrome currently only supports this in [headless mode](https://webdriver.io/docs/capabilities/#run-browser-headless), see [`crbug753118`](https://bugs.chromium.org/p/chromium/issues/detail?id=753118)).** **`pdf`:** The base64-encoded PDF representation of the paginated document.
***
## switchToFrame[](#switchtoframe "Direct link to switchToFrame")
The Switch To Frame command is used to select the current top-level browsing context or a child browsing context of the current browsing context to use as the current browsing context for subsequent commands..
### Usage[](#usage-17 "Direct link to Usage")
```
await browser.switchToFrame(id)
```
### Parameters[](#parameters-7 "Direct link to Parameters")
| Name | Type | Details |
| ---- | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | `number, object, null` | one of three possible types: null: this represents the top-level browsing context (i.e., not an iframe), a Number, representing the index of the window object corresponding to a frame, an Element object received using `findElement`. |
### Example[](#example-15 "Direct link to Example")
examples.js
```
loading...
```
[View on GitHub](https://github.com/webdriverio/example-recipes/blob/e8b147e88e7a38351b0918b4f7efbd9ae292201d/api/webdriver/examples.js#L155-L168)
***
## switchToParentFrame[](#switchtoparentframe "Direct link to switchToParentFrame")
The Switch to Parent Frame command sets the current browsing context for future commands to the parent of the current browsing context.** **`windowRect`:** A JSON representation of a "window rect" object. This has 4 properties: `x`, `y`, `width` and `height`.
***
## setWindowRect[](#setwindowrect "Direct link to setWindowRect")
The Set Window Rect command alters the size and the position of the operating system window corresponding to the current top-level browsing context.** **`windowRect`:** A JSON representation of a "window rect" object based on the new window state.
***
## maximizeWindow[](#maximizewindow "Direct link to maximizeWindow")
The Maximize Window command invokes the window manager-specific "maximize" operation, if any, on the window containing the current top-level browsing context. This typically increases the window to the maximum available size without going full-screen.** **`windowRect`:** A JSON representation of a "window rect" object based on the new window state.
***
## minimizeWindow[](#minimizewindow "Direct link to minimizeWindow")
The Minimize Window command invokes the window manager-specific "minimize" operation, if any, on the window containing the current top-level browsing context. This typically hides the window in the system tray.** **`windowRect`:** A JSON representation of a "window rect" object of the (new) current top-level browsing context.
***
## fullscreenWindow[](#fullscreenwindow "Direct link to fullscreenWindow")
The Fullscreen Window command invokes the window manager-specific “full screen” operation, if any, on the window containing the current top-level browsing context. This typically increases the window to the size of the physical display and can hide browser chrome elements such as toolbars.** **`windowRect`:** A JSON representation of a "window rect" object of the (new) current top-level browsing context.
***
## findElement[](#findelement "Direct link to findElement")
The Find Element command is used to find an element in the current browsing context that can be used for future commands. This command returns JSON representation of the element that can be passed to $ command to transform the reference to an extended WebdriverIO element.** **`element`:** A JSON representation of an element object, e.g. `{ 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }`.
***
## findElementFromShadowRoot[](#findelementfromshadowroot "Direct link to findElementFromShadowRoot")
The Find Element From Shadow Root command is used to find an element within the shadow root of an element that can be used for future commands. This command returns JSON representation of the element that can be passed to $ command to transform the reference to an extended WebdriverIO element.** **`element`:** A JSON representation of an element shadow object, e.g. `{ 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }`.
***
## findElements[](#findelements "Direct link to findElements")
The Find Elements command is used to find elements in the current browsing context that can be used for future commands. This command returns array of JSON representation of the elements that can be passed to $ command to transform the reference to an extended WebdriverIO element (See findElement).** **`elements`:** A (possibly empty) JSON list of representations of an element object, e.g. `[{ 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }]`.
***
## findElementsFromShadowRoot[](#findelementsfromshadowroot "Direct link to findElementsFromShadowRoot")
The Find Elements command is used to find elements within the shadow root of an element that can be used for future commands. This command returns array of JSON representation of the elements that can be passed to $ command to transform the reference to an extended WebdriverIO element (See findElement).** **`elements`:** A (possibly empty) JSON list of representations of an element object, e.g. `{ 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }`.
***
## findElementFromElement[](#findelementfromelement "Direct link to findElementFromElement")
The Find Element From Element command is used to find an element from a web element in the current browsing context that can be used for future commands. This command returns JSON representation of the element that can be passed to $ command to transform the reference to an extended WebdriverIO element (See findElement).** **`element`:** A JSON representation of an element object, e.g. `{ 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }`.
***
## findElementsFromElement[](#findelementsfromelement "Direct link to findElementsFromElement")
The Find Elements From Element command is used to find elements from a web element in the current browsing context that can be used for future commands. This command returns array of JSON representation of the elements that can be passed to $ command to transform the reference to an extended WebdriverIO element (See findElement).** **`elements`:** A (possibly empty) JSON list of representations of an element object, e.g. `[{ 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }]`.
***
## getElementShadowRoot[](#getelementshadowroot "Direct link to getElementShadowRoot")
Get the shadow root object of an element. The result object can be used to fetch elements within this shadow root using e.g. findElementFromShadowRoots or findElementsFromShadowRoots.** **`shadowRoot`:** A JSON representation of an element shadow root, e.g. `{ 'shadow-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }`.
***
## getActiveElement[](#getactiveelement "Direct link to getActiveElement")
Get Active Element returns the active element of the current browsing context’s document element. This command returns JSON representation of the element that can be passed to $ command to transform the reference to an extended WebdriverIO element (See findElement).** **`element`:** A JSON representation of an element object, e.g. `{ 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }`.
***
## isElementSelected[](#iselementselected "Direct link to isElementSelected")
Is Element Selected determines if the referenced element is selected or not. This operation only makes sense on input elements of the Checkbox- and Radio Button states, or option elements.** **`isSelected`:** `true` or `false` based on the selected state.
***
## isElementDisplayed[](#iselementdisplayed "Direct link to isElementDisplayed")
Is Element Displayed determines the visibility of an element which is guided by what is perceptually visible to the human eye. In this context, an element's displayedness does not relate to the `visibility` or `display` style properties.** **`isDisplayed`:** `true` or `false` based on the visible state.
***
## getElementAttribute[](#getelementattribute "Direct link to getElementAttribute")
The Get Element Attribute command will return the attribute of a web element.** **`property`:** The value of the named own property of the element.
***
## getElementCSSValue[](#getelementcssvalue "Direct link to getElementCSSValue")
The Get Element CSS Value command retrieves the computed value of the given CSS property of the given web element.** **`cssValue`:** The computed value of the parameter corresponding to property name from the element's style declarations (unless the document type is xml, in which case the return value is simply the empty string).
***
## getElementText[](#getelementtext "Direct link to getElementText")
The Get Element Text command intends to return an element’s text "as rendered". An element's rendered text is also used for locating a elements by their link text and partial link text.** **`text`:** The visible text of the element (including child elements), following the algorithm defined in the Selenium Atoms for [`bot.dom.getVisibleText`](https://github.com/SeleniumHQ/selenium/blob/e09e28f016c9f53196cf68d6f71991c5af4a35d4/javascript/atoms/dom.js#L981).
***
## getElementTagName[](#getelementtagname "Direct link to getElementTagName")
The Get Element Tag Name command returns the qualified element name of the given web element.** **`text`:** The tagName attribute of the element.
***
## getElementRect[](#getelementrect "Direct link to getElementRect")
The Get Element Rect command returns the dimensions and coordinates of the given web element.** **`elementRect`:** A JSON object representing the position and bounding rect of the element.
***
## isElementEnabled[](#iselementenabled "Direct link to isElementEnabled")
Is Element Enabled determines if the referenced element is enabled or not. This operation only makes sense on form controls.** **`isEnabled`:** If the element is in an xml document, or is a disabled form control: `false`, otherwise, `true`.
***
## elementClick[](#elementclick "Direct link to elementClick")
The Element Click command scrolls into view the element if it is not already pointer-interactable, and clicks its in-view center point. If the element's center point is obscured by another element, an element click intercepted error is returned. If the element is outside the viewport, an element not interactable error is returned.** **`pageSource`:** the DOM of the current browsing context active document
***
## executeScript[](#executescript "Direct link to executeScript")
The Execute Script command executes a JavaScript function in the context of the current browsing context and returns the return value of the function.** **`cookies`:** A list of serialized cookies. Each serialized cookie has a number of optional fields which may or may not be returned in addition to `name` and `value`.
***
## addCookie[](#addcookie "Direct link to addCookie")
The Add Cookie command adds a single cookie to the cookie store associated with the active document's address.** **`cookie`:** A serialized cookie, with name and value fields. There are a number of optional fields like `path`, `domain`, and `expiry-time` which may also be present.
***
## deleteCookie[](#deletecookie "Direct link to deleteCookie")
The Delete Cookie command allows you to delete either a single cookie by parameter name, or all the cookies associated with the active document's address if name is undefined.** **`alertText`:** The message of the user prompt.
***
## sendAlertText[](#sendalerttext "Direct link to sendAlertText")
The Send Alert Text command sets the text field of a window\.prompt user prompt to the given value.** **`screenshot`:** The base64-encoded PNG image data comprising the screenshot of the initial viewport.
***
## takeElementScreenshot[](#takeelementscreenshot "Direct link to takeElementScreenshot")
The Take Element Screenshot command takes a screenshot of the visible region encompassed by the bounding rectangle of an element.** **`screenshot`:** The base64-encoded PNG image data comprising the screenshot of the visible region of an element’s bounding rectangle after it has been scrolled into view.
***
## getElementComputedRole[](#getelementcomputedrole "Direct link to getElementComputedRole")
Get the computed WAI-ARIA role of an element.** **`role`:** The result of computing the WAI-ARIA role of element.
***
## getElementComputedLabel[](#getelementcomputedlabel "Direct link to getElementComputedLabel")
Get the accessible name of the element.** **`label`:** The result of a Accessible Name and Description Computation for the Accessible Name of the element.
***
## setPermissions[](#setpermissions "Direct link to setPermissions")
Simulates user modification of a PermissionDescriptor's permission state. **Note:** this feature has not landed in all browsers yet.** **`sensorReading`:** Values of the mock sensor reading.
***
## updateMockSensor[](#updatemocksensor "Direct link to updateMockSensor")
Updates the mock sensor type. **Note:** this feature has not landed in all browsers yet.** **`authenticatorId`:** Returns the string ID of the authenticator.
***
## removeVirtualAuthenticator[](#removevirtualauthenticator "Direct link to removeVirtualAuthenticator")
Removes a previously created Virtual Authenticator.** **`credentials`:** Returns an array of credentials.
***
## removeAllCredentials[](#removeallcredentials "Direct link to removeAllCredentials")
Removes all Public Key Credential Sources stored on a Virtual Authenticator.