WebDriver

W3C Working Draft

More details about this document
This version:
https://www.w3.org/TR/2023/WD-webdriver2-20230119/
Latest published version:
https://www.w3.org/TR/webdriver2/
Latest editor's draft:
https://w3c.github.io/webdriver/
History:
https://www.w3.org/standards/history/webdriver2
Commit history
Test suite:
https://wpt.live/webdriver/
Implementation report:
https://wpt.fyi/results/webdriver
Editors:
Simon Stewart (Apple)
David Burns (BrowserStack)
Feedback:
GitHub w3c/webdriver (pull requests, new issue, open issues)
Channel
#webdriver on irc.w3.org

Abstract

WebDriver is a remote control interface that enables introspection and control of user agents. It provides a platform- and language-neutral wire protocol as a way for out-of-process programs to remotely instruct the behavior of web browsers.

Provided is a set of interfaces to discover and manipulate DOM elements in web documents and to control the behavior of a user agent. It is primarily intended to allow web authors to write tests that automate a user agent from a separate controlling process, but may also be used in such a way as to allow in-browser scripts to control a — possibly separate — browser.

Status of This Document

This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at https://www.w3.org/TR/.

This document was published by the Browser Testing and Tools Working Group as a Working Draft using the Recommendation track.

Publication as a Working Draft does not imply endorsement by W3C and its Members.

This is a draft document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate to cite this document as other than work in progress.

This document was produced by a group operating under the W3C Patent Policy. W3C maintains a public list of any patent disclosures made in connection with the deliverables of the group; that page also includes instructions for disclosing a patent. An individual who has actual knowledge of a patent which the individual believes contains Essential Claim(s) must disclose the information in accordance with section 6 of the W3C Patent Policy.

This document is governed by the 2 November 2021 W3C Process Document.

1. Design

This section is non-normative.

The WebDriver standard attempts to follow a number of design goals:

1.1 Compatibility

This specification is derived from the popular Selenium WebDriver browser automation framework. Selenium is a long-lived project, and due to its age and breadth of use it has a wide range of expected functionality. This specification uses these expectations to inform its design. Where improvements or clarifications have been made, they have been made with care to allow existing users of Selenium WebDriver to avoid unexpected breakages.

1.2 Simplicity

The largest intended group of users of this specification are software developers and testers writing automated tests and other tooling, such as monitoring or load testing, that relies on automating a browser. As such, care has been taken to provide commands that simplify common tasks such as typing into and clicking elements.

1.3 Extensions

WebDriver provides a mechanism for others to define extensions to the protocol for the purposes of automating functionality that cannot be implemented entirely in ECMAScript. This allows other web standards to support the automation of new platform features. It also allows vendors to expose functionality that is specific to their browser.

2. Conformance

As well as sections marked as non-normative, all authoring guidelines, diagrams, examples, and notes in this specification are non-normative. Everything else in this specification is normative.

Conformance requirements phrased as algorithms or specific steps may be implemented in any manner, so long as the end result is equivalent. Algorithms in this document are typically written with readability, rather than performance, in mind.

3. Terminology

In equations, all numbers are integers, addition is represented by “+”, subtraction by “−”, division by “÷”, and bitwise OR by “|”. The characters “(” and “)” are used to provide logical grouping in these contexts.

The mathematical function min(value, value[, value]) returns the smallest item of two or more values. Conversely, the function max(value, value[, value]) returns the largest item of two or more values.

The mathematical function floor(value) produces the largest integer, closest to positive infinity, that is not larger than value.

A Universally Unique Identifier (UUID) is a 128 bits long URN that requires no central registration process. Generating a UUID means Creating a UUID From Truly Random or Pseudo-Random Numbers, and converting it to the string representation. [RFC4122]

The Unix Epoch is a value that approximates the number of seconds that have elapsed since the Epoch, as described by The Open Group Base Specifications Issue 7 section 4.15 (IEEE Std 1003.1).

An integer is a Number that is unchanged under the ToInteger operation.

The initial value of an ECMAScript property is the value defined by the platform for that property, i.e. the value it would have in the absence of any shadowing by content script.

The browser chrome is a non-normative term to refer to the representation through which the user interacts with the user agent itself, as distinct from the accessed web content. Examples of browser chrome elements include, but are not limited to, toolbars (such as the bookmark toolbar), menus (such as the file or context menu), buttons (such as the back and forward buttons), door hangers (such as security and certificate indicators), and decorations (such as operating system widget borders).

4. Interface

The webdriver-active flag is set to true when the user agent is under remote control. It is initially false.

WebIDLinterface mixin NavigatorAutomationInformation {
  readonly attribute boolean webdriver;
};
Navigator includes NavigatorAutomationInformation;
Note

The NavigatorAutomationInformation interface should not be exposed on WorkerNavigator.

webdriver

Returns true if webdriver-active flag is set, false otherwise.

It is acknowledged that this is complementary to the Evil Bit [RFC3514].

5. Nodes

The WebDriver protocol consists of communication between:

Local end

The local end represents the client side of the protocol, which is usually in the form of language-specific libraries providing an API on top of the WebDriver protocol. This specification does not place any restrictions on the details of those libraries above the level of the wire protocol.

Remote end
The remote end hosts the server side of the protocol. Defining the behavior of a remote end in response to the WebDriver protocol forms the largest part of this specification.

For remote ends the standard defines two broad conformance classes, known as node types:

Intermediary node
Intermediary nodes are those that act as proxies, implementing both the local end and remote end of the protocol. However they are not expected to implement remote end steps directly. All nodes between a specific intermediary node and a local end are said to be downstream of that node. Conversely, any nodes between a specific intermediary node and an endpoint node are said to be upstream.
Endpoint node
An endpoint node is the final remote end in a chain of nodes that is not an intermediary node. The endpoint node is implemented by a user agent or a similar program.

All remote end node types must be black-box indistinguishable from a remote end, from the point of view of local end, and so are bound by the requirements on a remote end in terms of the wire protocol.

The readiness state of a remote end indicates whether it is free to accept new connections. It must be false if the maximum active sessions is equal to the length of the list of active sessions, or if the node is an intermediary node and is known to be in a state in which attempting to create new sessions would fail. In all other cases it must be true.

If the intermediary node is a multiplexer that manages multiple endpoint nodes, this might indicate its ability to purvey more sessions, for example if it has hit its maximum capacity.

6. Protocol

WebDriver remote ends must provide an HTTP compliant wire protocol where the endpoints map to different commands.

As this standard only defines the remote end protocol, it puts no demands to how local ends should be implemented. Local ends are only expected to be compatible to the extent that they can speak the remote end’s protocol; no requirements are made upon their exposed user-facing API.

6.1 Algorithms

Various parts of this specification are written in terms of step-by-step algorithms. The details of these algorithms do not have any normative significance; implementations are free to adopt any implementation strategy that produces equivalent output to the specification. In particular, algorithms in this document are optimized for readability rather than performance.

Where algorithms that return values are fallible, they are written in terms of returning either success or error. A success value has an associated data field which encapsulates the value returned, whereas an error value has an associated error code.

When calling a fallible algorithm, the construct “Let result be the result of trying to call algorithm” is equivalent to

  1. Let temp be the result of calling algorithm.

  2. If temp is an error return temp, otherwise let result be temp’s data field.

The result of getting a property with name from object is defined as being the same as the result of calling Object.[[GetOwnProperty]](name) on object.

The result of getting a property with default with arguments name and default from object is defined as being the same as the result of calling Object.[[GetOwnProperty]](name) on object if that results in a value other than undefined and default otherwise.

Setting a property with arguments name and value on object is defined as being the same as calling Object.[[Put]](name, value) on object.

The result of JSON serialization with object of type JSON Object is defined as the result of calling stringify(object).

The result of JSON deserialization with text is defined as the result of calling parse(text).

6.2 Commands

The WebDriver protocol is organized into commands. Each HTTP request with a method and template defined in this specification represents a single command, and therefore each command produces a single HTTP response.

In response to a command, a remote end will run a series of actions known as remote end steps. These provide the sequences of actions that a remote end takes when it receives a particular command.

6.3 Processing model

The remote end is an HTTP server reading requests from the client and writing responses, typically over a TCP socket. For the purposes of this specification we model the data transmission between a particular local end and remote end with a connection to which the remote end may write bytes and read bytes. However the exact details of how this connection works and how it is established are out of scope.

After such a connection has been established, a remote end must run the following steps:

  1. Read bytes from the connection until a complete HTTP request can be constructed from the data. Let request be a request constructed from the received data, according to the requirements of [RFC7230]. If it is not possible to construct a complete HTTP request, the remote end must either close the connection, return an HTTP response with status code 500, or return an error with error code unknown error.

  2. Let request match be the result of the algorithm to match a request with request’s method and URL as arguments.

  3. If request match is of type error, send an error with request match’s error code and jump to step 1.

    Otherwise, let command and command parameters be request match’s data. Let url variables be a url variables dictionary mapping the command parameters to their corresponding values.

  4. If session id is among the variables defined by command parameters:

    Note

    This condition is intended to exclude the New Session and Status commands and any extension commands which do not operate on a particular session.

    1. Let session id be the corresponding variable from command parameters.

    2. Let the current session be the session with ID session id in the list of active sessions, or null if there is no such matching session.

    3. If the current session is null send an error with error code invalid session id, then jump to step 1 in this overall algorithm.

    4. If the current session is not null:

      1. Enqueue request in the current session’s request queue.

      2. Wait until the first element in the current session’s request queue is request:

      3. Dequeue request from the current session’s request queue.

      4. If the list of active sessions no longer contains the current session, set the current session to null.

  5. If request’s method is POST:

    1. Let parse result be the result of parsing as JSON with request’s body as the argument. If this process throws an exception, return an error with error code invalid argument and jump back to step 1 in this overall algorithm.

    2. If parse result is not an Object, send an error with error code invalid argument and jump back to step 1 in this overall algorithm.

      Otherwise, let parameters be parse result.

    Otherwise, let parameters be null.

  6. Wait for navigation to complete. If this returns an error return its value and jump to step 1 in this overall algorithm, otherwise continue.

  7. Let response result be the return value obtained by running the remote end steps for command with an argument named url variables whose value is url variables and an additional argument named parameters whose value is parameters.

  8. If response result is an error, send an error with error code equal to response result’s error code and jump back to step 1 in this overall algorithm.

    Otherwise, if response result is a success, let response data be response result’s data.

  9. Send a response with status 200 and response data.

  10. Jump to step 1.

When required to send an error, with error code and an optional error data dictionary, a remote end must run the following steps:

  1. Let status and name be the error response data for error code.

  2. Let message be an implementation-defined string containing a human-readable description of the reason for the error.

  3. Let stacktrace be an implementation-defined string containing a stack trace report of the active stack frames at the time when the error occurred.

    Let body be a new JSON Object initialized with the following properties:

    "error"
    name
    "message"
    message
    "stacktrace"
    stacktrace
  4. If the error data dictionary contains any entries, set the "data" field on body to a new JSON Object populated with the dictionary.

  5. Send a response with status and body as arguments.

When required to send a response, with arguments status and data, a remote end must run the following steps:

  1. Let response be a new response.

  2. Set response’s HTTP status to status, and status message to the string corresponding to the description of status in the status code registry.

  3. Set the response’s header with name and value with the following values:

    Content-Type
    "application/json; charset=utf-8"
    Cache-Control
    "no-cache"
  4. Let response’s body be the UTF-8 encoded JSON serialization of a JSON Object with a key "value" set to data.

  5. Let response bytes be the byte sequence resulting from serializing response according to the rules in [RFC7230].

  6. Write response bytes to the connection.

A url variable dictionary is defined as the mapping of a command’s URI template variable names to their corresponding values.

6.4 Routing requests

Request routing is the process of going from a HTTP request to the series of steps needed to implement the command represented by that request.

A remote end has an associated URL prefix, which is used as a prefix on all WebDriver-defined URLs on that remote end. This must either be undefined or a path-absolute URL.

In order to match a request given a method and URL, the following steps must be taken:

  1. Let endpoints be a list containing each row in the table of endpoints.

  2. Remove each entry from endpoints for which the concatenation of the URL prefix and the entry’s URI template does not match URL’s path.

  3. If there are no entries in endpoints, return error with error code unknown command.

  4. Remove each entry in endpoints for which the method column is not equal to method.

  5. If there are no entries in endpoints, return error with error code unknown method.

  6. There is now exactly one entry in endpoints; let entry be this entry.

  7. Let parameters be the result of extracting the variables from URL using entry’s URI template.

  8. Let command be entry’s command.

  9. Return success with data command and parameters.

6.5 Endpoints

The following table of endpoints lists the method and URI template for each endpoint node command. Extension commands are implicitly appended to this table.

Method URI Template Command
POST /session New Session
DELETE /session/{session id} Delete Session
GET /status Status
GET /session/{session id}/timeouts Get Timeouts
POST /session/{session id}/timeouts Set Timeouts
POST /session/{session id}/url Navigate To
GET /session/{session id}/url Get Current URL
POST /session/{session id}/back Back
POST /session/{session id}/forward Forward
POST /session/{session id}/refresh Refresh
GET /session/{session id}/title Get Title
GET /session/{session id}/window Get Window Handle
DELETE /session/{session id}/window Close Window
POST /session/{session id}/window Switch To Window
GET /session/{session id}/window/handles Get Window Handles
POST /session/{session id}/window/new New Window
POST /session/{session id}/frame Switch To Frame
POST /session/{session id}/frame/parent Switch To Parent Frame
GET /session/{session id}/window/rect Get Window Rect
POST /session/{session id}/window/rect Set Window Rect
POST /session/{session id}/window/maximize Maximize Window
POST /session/{session id}/window/minimize Minimize Window
POST /session/{session id}/window/fullscreen Fullscreen Window
GET /session/{session id}/element/active Get Active Element
GET /session/{session id}/element/{element id}/shadow Get Element Shadow Root
POST /session/{session id}/element Find Element
POST /session/{session id}/elements Find Elements
POST /session/{session id}/element/{element id}/element Find Element From Element
POST /session/{session id}/element/{element id}/elements Find Elements From Element
POST /session/{session id}/shadow/{shadow id}/element Find Element From Shadow Root
POST /session/{session id}/shadow/{shadow id}/elements Find Elements From Shadow Root
GET /session/{session id}/element/{element id}/selected Is Element Selected
GET /session/{session id}/element/{element id}/attribute/{name} Get Element Attribute
GET /session/{session id}/element/{element id}/property/{name} Get Element Property
GET /session/{session id}/element/{element id}/css/{property name} Get Element CSS Value
GET /session/{session id}/element/{element id}/text Get Element Text
GET /session/{session id}/element/{element id}/name Get Element Tag Name
GET /session/{session id}/element/{element id}/rect Get Element Rect
GET /session/{session id}/element/{element id}/enabled Is Element Enabled
GET /session/{session id}/element/{element id}/computedrole Get Computed Role
GET /session/{session id}/element/{element id}/computedlabel Get Computed Label
POST /session/{session id}/element/{element id}/click Element Click
POST /session/{session id}/element/{element id}/clear Element Clear
POST /session/{session id}/element/{element id}/value Element Send Keys
GET /session/{session id}/source Get Page Source
POST /session/{session id}/execute/sync Execute Script
POST /session/{session id}/execute/async Execute Async Script
GET /session/{session id}/cookie Get All Cookies
GET /session/{session id}/cookie/{name} Get Named Cookie
POST /session/{session id}/cookie Add Cookie
DELETE /session/{session id}/cookie/{name} Delete Cookie
DELETE /session/{session id}/cookie Delete All Cookies
POST /session/{session id}/actions Perform Actions
DELETE /session/{session id}/actions Release Actions
POST /session/{session id}/alert/dismiss Dismiss Alert
POST /session/{session id}/alert/accept Accept Alert
GET /session/{session id}/alert/text Get Alert Text
POST /session/{session id}/alert/text Send Alert Text
GET /session/{session id}/screenshot Take Screenshot
GET /session/{session id}/element/{element id}/screenshot Take Element Screenshot
POST /session/{session id}/print Print Page

6.6 Errors

Errors are represented in the WebDriver protocol by an HTTP response with an HTTP status in the 4xx or 5xx range, and a JSON body containing details of the error. The body is a JSON Object and has a field named "value" whose value is an object bearing three, and sometimes four, fields:

The following table lists each error code, its associated HTTP status, JSON error code, and a non-normative description of the error. The error response data for a particular error code is the values of the HTTP Status and JSON Error Code columns for the row corresponding to that error code.

Error Code HTTP Status JSON Error Code Description
element click intercepted 400 element click intercepted The Element Click command could not be completed because the element receiving the events is obscuring the element that was requested clicked.
element not interactable 400 element not interactable A command could not be completed because the element is not pointer- or keyboard interactable.
insecure certificate 400 insecure certificate Navigation caused the user agent to hit a certificate warning, which is usually the result of an expired or invalid TLS certificate.
invalid argument 400 invalid argument The arguments passed to a command are either invalid or malformed.
invalid cookie domain 400 invalid cookie domain An illegal attempt was made to set a cookie under a different domain than the current page.
invalid element state 400 invalid element state A command could not be completed because the element is in an invalid state, e.g. attempting to clear an element that isn’t both editable and resettable.
invalid selector 400 invalid selector Argument was an invalid selector.
invalid session id 404 invalid session id Occurs if the given session id is not in the list of active sessions, meaning the session either does not exist or that it’s not active.
javascript error 500 javascript error An error occurred while executing JavaScript supplied by the user.
move target out of bounds 500 move target out of bounds The target for mouse interaction is not in the browser’s viewport and cannot be brought into that viewport.
no such alert 404 no such alert An attempt was made to operate on a modal dialog when one was not open.
no such cookie 404 no such cookie No cookie matching the given path name was found amongst the associated cookies of the current browsing context’s active document.
no such element 404 no such element An element could not be located on the page using the given search parameters.
no such frame 404 no such frame A command to switch to a frame could not be satisfied because the frame could not be found.
no such window 404 no such window A command to switch to a window could not be satisfied because the window could not be found.
no such shadow root 404 no such shadow root The element does not have a shadow root.
script timeout error 500 script timeout A script did not complete before its timeout expired.
session not created 500 session not created A new session could not be created.
stale element reference 404 stale element reference A command failed because the referenced element is no longer attached to the DOM.
detached shadow root 404 detached shadow root A command failed because the referenced shadow root is no longer attached to the DOM.
timeout 500 timeout An operation did not complete before its timeout expired.
unable to set cookie 500 unable to set cookie A command to set a cookie’s value could not be satisfied.
unable to capture screen 500 unable to capture screen A screen capture was made impossible.
unexpected alert open 500 unexpected alert open A modal dialog was open, blocking this operation.
unknown command 404 unknown command A command could not be executed because the remote end is not aware of it.
unknown error 500 unknown error An unknown error occurred in the remote end while processing the command.
unknown method 405 unknown method The requested command matched a known URL but did not match any method for that URL.
unsupported operation 500 unsupported operation Indicates that a command that should have executed properly cannot be supported for some reason.

An error data dictionary is a mapping of string keys to JSON serializable values that can optionally be included with error objects.

6.7 Extensions

Using the terminology defined in this section, others may define additional commands that seamlessly integrate with the standard protocol. This allows vendors to expose functionality that is specific to their user agent, and it also allows other web standards to define commands for automating new platform features.

Commands defined in this way are called extension commands and behave no differently than other commands; each has a dedicated HTTP endpoint and a set of remote end steps.

Each extension command has an associated extension command URI Template that is a URI Template string, and which should bear some resemblance to what the command performs. This value, along with the HTTP method and extension command, is added to the table of endpoints and thus follows the same rules for request routing as that of other built-in commands.

In order to avoid potential resource conflicts with other implementations, vendor-specific extension command URI Templates must begin with one or more path segments which uniquely identifies the vendor and UA. It is suggested that vendors use their vendor prefixes without additional characters as outlined in [CSS21], notably in section 4.1.2.2 on vendor keywords, as the name for this path element, and include a vendor-chosen UA identifier.

Note

Other specifications may define additional WebDriver capabilities. Each defined capability must have a capability name which is a string not containing a ":" (colon) character, an additional capability deserialization algorithm which is a set of steps taking a single argument value which has a JSON type, returning either success wrapping the deserialized capability value or error.

An additional WebDriver capability may also define a matched capability serialization algorithm, which is a set of steps used to determine if a capability is matched by the current implementation and provide any computed value to return to the user. This set of steps takes a single argument value, which is the output of the corresponding additional capability deserialization algorithm, and returns either null to indicate the capability is not matched, or a non-null JSON-serializable value if the capability is matched.

Other specifications may also define WebDriver new session algorithms, which are called just after a new session is created, and before the new session response is sent to the remote end. These algorithms are called with session representing the WebDriver session that will be established, and capabilities, the capabilities object that will be returned to the remote end. It is permitted for such an algorithm to modify any entry in the capabilities object with a name that's an additional WebDriver capability defined by the same specification.

Remote ends may also introduce extension capabilities that are extra capabilities used to provide configuration or fulfill other vendor-specific needs. Extension capabilities’ key must contain a ":" (colon) character, denoting an implementation specific namespace. The value can be arbitrary JSON types.

As with extension commands, it is suggested that the key used to denote the extension capability namespace is based on the vendor keywords listed in [CSS21] and precedes the first ":" character in the string.

7. Capabilities

WebDriver capabilities are used to communicate the features supported by a given implementation. The local end may use capabilities to define which features it requires the remote end to satisfy when creating a new session. Likewise, the remote end uses capabilities to describe the full feature set for a session.

The following table of standard capabilities enumerates the capabilities each implementation must support. An implementation may define additional extension capabilities.

Capability Key Value Type Description
Browser name "browserName" string Identifies the user agent.
Browser version "browserVersion" string Identifies the version of the user agent.
Platform name "platformName" string Identifies the operating system of the endpoint node.
Accept insecure TLS certificates "acceptInsecureCerts" boolean Indicates whether untrusted and self-signed TLS certificates are implicitly trusted on navigation for the duration of the session.
Page load strategy "pageLoadStrategy" string Defines the current session’s page load strategy.
Proxy configuration "proxy" JSON Object Defines the current session’s proxy configuration.
Window dimensioning/positioning "setWindowRect" boolean Indicates whether the remote end supports all of the resizing and repositioning commands.
Session timeouts "timeouts" JSON Object Describes the timeouts imposed on certain session operations.
Strict file interactability "strictFileInteractability" boolean Defines the current session’s strict file interactability.
Unhandled prompt behavior "unhandledPromptBehavior" string Describes the current session’s user prompt handler. Defaults to the dismiss and notify state.

7.1 Proxy

The proxy configuration capability is a JSON Object nested within the primary capabilities. Implementations may define additional proxy configuration options, but they must not alter the semantics of those listed below.

Key Value Type Description Valid values
proxyType string Indicates the type of proxy configuration. "pac", "direct", "autodetect", "system", or "manual".
proxyAutoconfigUrl string Defines the URL for a proxy auto-config file if proxyType is equal to "pac". Any URL.
ftpProxy string Defines the proxy host for FTP traffic when the proxyType is "manual". A host and optional port for scheme "ftp".
httpProxy string Defines the proxy host for HTTP traffic when the proxyType is "manual". A host and optional port for scheme "http".
noProxy array Lists the address for which the proxy should be bypassed when the proxyType is "manual". A List containing any number of Strings.
sslProxy string Defines the proxy host for encrypted TLS traffic when the proxyType is "manual". A host and optional port for scheme "https".
socksProxy string Defines the proxy host for a SOCKS proxy when the proxyType is "manual". A host and optional port with an undefined scheme.
socksVersion number Defines the SOCKS proxy version when the proxyType is "manual". Any integer between 0 and 255 inclusive.

A host and optional port for a scheme is defined as being a valid host, optionally followed by a colon and a valid port. The host may include credentials. If the port is omitted and scheme has a default port, this is the implied port. Otherwise, the port is left undefined.

A proxyType of "direct" indicates that the browser should not use a proxy at all.

A proxyType of "system" indicates that the browser should use the various proxies configured for the underlying Operating System.

A proxyType of "autodetect" indicates that the proxy to use should be detected in an implementation-specific way.

The remote end steps to deserialize as a proxy argument parameter are:

  1. If parameter is not a JSON Object return an error with error code invalid argument.

  2. Let proxy be a new, empty proxy configuration object.

  3. For each enumerable own property in parameter run the following substeps:

    1. Let key be the name of the property.

    2. Let value be the result of getting a property named name from parameter.

    3. If there is no matching key for key in the proxy configuration table return an error with error code invalid argument.

    4. If value is not one of the valid values for that key, return an error with error code invalid argument.

    5. Set a property key to value on proxy.

  4. If proxy does not have an own property for "proxyType" return an error with error code invalid argument.

  5. If the result of getting a property named "proxyType" from proxy equals "pac", and proxy does not have an own property for "proxyAutoconfigUrl" return an error with error code invalid argument.

  6. If proxy has an own property for "socksProxy" and does not have an own property for "socksVersion" return an error with error code invalid argument.

  7. Return success with data proxy.

A proxy configuration object is a JSON Object where each of its own properties matching keys in the proxy configuration meets the validity criteria for that key.

7.2 Processing capabilities

To process capabilities with argument parameters, the endpoint node must take the following steps:

  1. Let capabilities request be the result of getting the property "capabilities" from parameters.

    1. If capabilities request is not a JSON Object, return error with error code invalid argument.

  2. Let required capabilities be the result of getting the property "alwaysMatch" from capabilities request.

    1. If required capabilities is undefined, set the value to an empty JSON Object.

    2. Let required capabilities be the result of trying to validate capabilities with argument required capabilities.

  3. Let all first match capabilities be the result of getting the property "firstMatch" from capabilities request.

    1. If all first match capabilities is undefined, set the value to a JSON List with a single entry of an empty JSON Object.

    2. If all first match capabilities is not a JSON List with one or more entries, return error with error code invalid argument.

  4. Let validated first match capabilities be an empty JSON List.

  5. For each first match capabilities corresponding to an indexed property in all first match capabilities:

    1. Let validated capabilities be the result of trying to validate capabilities with argument first match capabilities.

    2. Append validated capabilities to validated first match capabilities.

  6. Let merged capabilities be an empty List.

  7. For each first match capabilities corresponding to an indexed property in validated first match capabilities:

    1. Let merged be the result of trying to merge capabilities with required capabilities and first match capabilities as arguments.

    2. Append merged to merged capabilities.

  8. For each capabilities corresponding to an indexed property in merged capabilities:

    1. Let matched capabilities be the result of trying to match capabilities with capabilities as an argument.

    2. If matched capabilities is not null, return success with data matched capabilities.

  9. Return success with data null.

When required to validate capabilities with argument capability:

  1. If capability is not a JSON Object return an error with error code invalid argument.

  2. Let result be an empty JSON Object.

  3. For each enumerable own property in capability, run the following substeps:

    1. Let name be the name of the property.

    2. Let value be the result of getting a property named name from capability.

    3. Run the substeps of the first matching condition:

      value is null

      Let deserialized be set to null.

      name equals "acceptInsecureCerts"

      If value is not a boolean return an error with error code invalid argument. Otherwise, let deserialized be set to value

      name equals "browserName"
      name equals "browserVersion"
      name equals "platformName"

      If value is not a string return an error with error code invalid argument. Otherwise, let deserialized be set to value.

      name equals "pageLoadStrategy"

      Let deserialized be the result of trying to deserialize as a page load strategy with argument value.

      name equals "proxy"

      Let deserialized be the result of trying to deserialize as a proxy with argument value.

      name equals "strictFileInteractability"

      If value is not a boolean return an error with error code invalid argument. Otherwise, let deserialized be set to value

      name equals "timeouts"

      Let deserialized be the result of trying to JSON deserialize as a timeouts configuration the value.

      name equals "unhandledPromptBehavior"

      Let deserialized be the result of trying to deserialize as an unhandled prompt behavior with argument value.

      name is the name of an additional WebDriver capability

      Let deserialized be the result of trying to run the additional capability deserialization algorithm for the extension capability corresponding to name, with argument value.

      name is the key of an extension capability

      If name is known to the implementation, let deserialized be the result of trying to deserialize value in an implementation-specific way. Otherwise, let deserialized be set to value.

      The remote end is an endpoint node

      Return an error with error code invalid argument.

    4. If deserialized is not null, set a property on result with name name and value deserialized.

  4. Return success with data result.

When merging capabilities with JSON Object arguments primary and secondary, an endpoint node must take the following steps:

  1. Let result be a new JSON Object.

  2. For each enumerable own property in primary, run the following substeps:

    1. Let name be the name of the property.

    2. Let value be the result of getting a property named name from primary.

    3. Set a property on result with name name and value value.
  3. If secondary is undefined, return result.

  4. For each enumerable own property in secondary, run the following substeps:

    1. Let name be the name of the property.

    2. Let value be the result of getting a property named name from secondary.

    3. Let primary value be the result of getting the property name from primary.

    4. If primary value is not undefined, return an error with error code invalid argument.

    5. Set a property on result with name name and value value.
  5. Return result.

Note

When matching capabilities with JSON Object argument capabilities, an endpoint node must take the following steps:

  1. Let matched capabilities be a JSON Object with the following entries:

    "browserName"
    ASCII Lowercase name of the user agent as a string.
    "browserVersion"
    The user agent version, as a string.
    "platformName"
    ASCII Lowercase name of the current platform as a string.
    "acceptInsecureCerts"
    Boolean initially set to false, indicating the session will not implicitly trust untrusted or self-signed TLS certificates on navigation.
    "strictFileInteractability"
    Boolean initially set to false, indicating that interactability checks will be applied to <input type=file>.
    "setWindowRect"
    Boolean indicating whether the remote end supports all of the resizing and positioning commands.
  2. Optionally add extension capabilities as entries to matched capabilities. The values of these may be elided, and there is no requirement that all extension capabilities be added.

    Note
  3. For each name and value corresponding to capability’s own properties:

    1. Let match value equal value.

    2. Run the substeps of the first matching name:

      "browserName"

      If value is not a string equal to the "browserName" entry in matched capabilities, return success with data null.

      Note

      There is a chance the remote end will need to start a browser process to correctly determine the browserName. Lightweight checks are preferred before this is done.

      "browserVersion"

      Compare value to the "browserVersion" entry in matched capabilities using an implementation-defined comparison algorithm. The comparison is to accept a value that places constraints on the version using the "<", "<=", ">", and ">=" operators.

      If the two values do not match, return success with data null.

      Note

      Version comparison is left as an implementation detail since each user agent will likely have conflicting methods of encoding the user agent version, and standardizing these schemes is beyond the scope of this standard.

      Note

      There is a chance the remote end will need to start a browser process to correctly determine the browserVersion. Lightweight checks are preferred before this is done.

      "platformName"

      If value is not a string equal to the "platformName" entry in matched capabilities, return success with data null.

      Note

      The following platform names are in common usage with well-understood semantics and, when matching capabilities, greatest interoperability can be achieved by honoring them as valid synonyms for well-known Operating Systems:

      Key System
      "linux" Any server or desktop system based upon the Linux kernel.
      "mac" Any version of Apple’s macOS.
      "windows" Any version of Microsoft Windows, including desktop and mobile versions.

      This list is not exhaustive.

      When returning capabilities from New Session, it is valid to return a more specific platformName, allowing users to correctly identify the Operating System the WebDriver implementation is running on.

      "acceptInsecureCerts"

      If value is true and the endpoint node does not support insecure TLS certificates, return success with data null.

      Note

      If the endpoint node does not support insecure TLS certificates and this is the reason no match is ultimately made, it is useful to provide this information to the local end.

      "proxy"

      If the endpoint node does not allow the proxy it uses to be configured, or if the proxy configuration defined in value is not one that passes the endpoint node’s implementation-specific validity checks, return success with data null.

      Note

      A local end would only send this capability if it expected it to be honored and the configured proxy used. The intent is that if this is not possible a new session will not be established.

      Otherwise
    3. Set a property on matched capabilities with name name and value match value.

  4. Return success with data matched capabilities.

8. Sessions

A session is equivalent to a single instantiation of a particular user agent, including all its child browsers. WebDriver gives each session a unique session ID that can be used to differentiate one session from another, allowing multiple user agents to be controlled from a single HTTP server, and allowing sessions to be routed via a multiplexer (known as an intermediary node).

A WebDriver session represents the connection between a local end and a specific remote end.

A session is started when a New Session is invoked. It is an error to send any commands before starting a session, or to continue to send commands after the session has been closed. Maintaining session continuity between commands to the remote end requires passing a session ID.

A session is torn down at some later point; either explicitly by invoking Delete Session, or implicitly when Close Window is called at the last remaining top-level browsing context.

An intermediary node will maintain an associated session for each active session. This is the session on the upstream neighbor that is created when the intermediary node executes the New Session command. Closing a session on an intermediary node will also close the session of the associated session.

All commands, except New Session and Status, have an associated current session, which is the session in which that command will run.

A remote end has an associated list of active sessions, which is a list of all sessions that are currently started. A remote end that is not an intermediary node has at most one active session at a given time.

A remote end has an associated maximum active sessions (an integer) that defines the number of active sessions that are supported. This may be “unlimited” for intermediary nodes, but must be exactly one for a remote end that is an endpoint node.

A session has an associated session ID (a string representation of a UUID) used to uniquely identify this session. Unless stated otherwise it is null.

A session has an associated current browsing context, which is the browsing context against which commands will run, an associated current parent browsing context, which is set to the parent of the current browsing context when changing browsing contexts, and an associated current top-level browsing context, which is set to the top-browsing context ancestor of the current browsing context, when changing browsing contexts.

A session has an associated session timeouts that records the timeout duration values used to control the behavior of script evaluation, navigation, and element retrieval.

A session has an associated page loading strategy, which is one of the keywords from the table of page load strategies. Unless stated otherwise, it is normal.

A session has an associated secure TLS state that indicates whether untrusted or self-signed TLS certificates should be trusted for the duration of the WebDriver session. If it is unset, this indicates that certificate- or TLS errors that occur upon navigation should be suppressed. The state can be unset by providing an "acceptInsecureCerts" capability with the value true. Unless stated otherwise, it is set.

A session has an associated strict file interactability state which is a boolean.

A session has an associated user prompt handler. Unless stated otherwise it is in the dismiss and notify state.

A session has an associated browsing context input state map, which is a Weak Map with top-level browsing contexts as keys, and input state objects as values. This is initially set to an empty map.

A session has an associated request queue which is a queue of requests that are currently awaiting processing.

When asked to close the session, a remote end must take the following steps:

  1. Perform the following substeps based on the remote end’s type:

    Remote end is an endpoint node
    1. Set the webdriver-active flag to false.

    2. An endpoint node must close any top-level browsing contexts associated with the session, without prompting to unload.

    Remote end is an intermediary node
    1. Close the associated session. If this causes an error to occur, complete the remainder of this algorithm before returning the error.

  2. Remove the current session from active sessions.

  3. Perform any implementation-specific cleanup steps.

  4. If an error has occurred in any of the steps above, return the error, otherwise return success with data null.

Closing a session might cause the associated browser process to be killed. It is assumed that any implementation-specific cleanup steps are performed after the response has been sent back to the client so that the connection is not prematurely closed.

8.1 New Session

HTTP Method URI Template
POST /session

The New Session command creates a new WebDriver session with the endpoint node. If the creation fails, a session not created error is returned.

If the remote end is an intermediary node, it may use the result of the capabilities processing algorithm to route the new session request to the appropriate endpoint node. An intermediary node is free to define extension capabilities to assist in this process, however, these specific capabilities must not be forwarded to the endpoint node.

If the intermediary node requires additional information unrelated to user agent features, it is recommended that this information be passed as top-level parameters, and not as part of the requested capabilities. An intermediary node must forward custom, top-level parameters (i.e. non-capabilities) to subsequent remote end nodes.

The remote end steps are:

  1. If the maximum active sessions is equal to the length of the list of active sessions, return error with error code session not created.

  2. If the remote end is an intermediary node, take implementation-defined steps that either result in returning an error with error code session not created, or in returning a success with data that is isomorphic to that returned by remote ends according to the rest of this algorithm. If an error is not returned, the intermediary node must retain a reference to the session created on the upstream node as the associated session such that commands may be forwarded to this associated session on subsequent commands.

    Note

    How this is done is entirely up to the implementation, but typically the sessionId, and URL and URL prefix of the upstream remote end will need to be tracked.

  3. If the maximum active sessions is equal to the length of the list of active sessions, return error with error code session not created.

  4. Let capabilities be the result of trying to process capabilities with parameters as an argument.

  5. If capabilities’s is null, return error with error code session not created.

  6. Let session id be the result of generating a UUID.

  7. Let session be a new session with the session ID of session id.

  8. Set the current session to session.

  9. Run any WebDriver new session algorithm defined in external specifications, with arguments session and capabilities.

  10. Append session to active sessions.

  11. Let body be a JSON Object initialized with:

    "sessionId"
    session id
    "capabilities"
    capabilities
  12. Initialize the following from capabilities:

    1. Let strategy be the result of getting property "pageLoadStrategy" from capabilities.

    2. If strategy is a string, set the current session’s page loading strategy to strategy. Otherwise, set the page loading strategy to normal and set a property of capabilities with name "pageLoadStrategy" and value "normal".

    3. Let strictFileInteractability be the result of getting property "strictFileInteractability" from capabilities.

    4. If strictFileInteractability is a boolean, set the current session’s strict file interactability to strictFileInteractability. Otherwise set the current session’s strict file interactability to false.

    5. Let proxy be the result of getting property "proxy" from capabilities and run the substeps of the first matching statement:

      proxy is a proxy configuration object

      Take implementation-defined steps to set the user agent proxy using the extracted proxy configuration. If the defined proxy cannot be configured return error with error code session not created.

      Otherwise
      Set a property of capabilities with name "proxy" and a value that is a new JSON Object.
    6. If capabilities has a property with the key "timeouts":

      1. Let timeouts be the result of trying to JSON deserialize as a timeouts configuration the value of the "timeouts" property.

      2. Make the session timeouts the new timeouts.

    7. Set a property on capabilities with name "timeouts" and value that of the JSON deserialization of the session timeouts.

    8. Apply changes to the user agent for any implementation-defined capabilities selected during the capabilities processing step.

  13. Set the webdriver-active flag to true.

  14. Set the current top-level browsing context for session with the top-level browsing context of the UA’s current browsing context.

    Note

    WebDriver implementations typically start a completely new browser instance, but there is no requirement in this specification (or for WebDriver only to be used to automate only web browsers). Implementations might choose to use an existing browser instance, eg. by selecting the window that currently has focus.

  15. Set the request queue to a new queue.

  16. Return success with data body.

8.2 Delete Session

HTTP Method URI Template
DELETE /session/{session id}

The remote end steps are:

  1. If the current session is an active session, try to close the session.

  2. Return success with data null.

8.3 Status

HTTP Method URI Template
GET /status
Note

Implementations may optionally include additional meta information as part of the body, but the top-level properties ready and message are reserved and must not be overwritten.

The remote end steps are:

  1. Let body be a new JSON Object with the following properties:

    "ready"

    The remote end’s readiness state.

    "message"

    An implementation-defined string explaining the remote end’s readiness state.

  2. Return success with data body.

9. Timeouts

A timeouts configuration is a record of the different timeouts that control the behavior of script evaluation, navigation, and element retrieval:

Field Default JSON key Optional Nullable Description
Script timeout 30,000 "script"

Specifies when to interrupt a script that is being evaluated.

A null value implies that scripts should never be interrupted, but instead run indefinitely.

Page load timeout 300,000 "pageLoad"

Provides the timeout limit used to interrupt an explicit navigation attempt.

Implicit wait timeout 0 "implicit"

Specifies a time to wait for the element location strategy to complete when locating an element

Informative.

The timeouts object for a timeouts configuration timeouts is an object initialized with the following properties:

"script"
timeouts' script timeout value, if set, or its default value.
"pageLoad"
timeouts' page load timeout’s value, if set, or its default value.
"implicit"
timeouts' implicit wait timeout’s value, if set, or its default value.

To JSON deserialize an input value into a timeouts configuration record:

  1. Let timeouts be a new timeouts configuration.

  2. If value is not a JSON Object, return error with error code invalid argument.

  3. If value has a property with the key "script":

    1. Let script duration be the value of property "script".

    2. If script duration is a number and less than 0 or greater than maximum safe integer, or it is not null, return error with error code invalid argument.

    3. Set timeouts’s script timeout to script duration.

  4. If value has a property with the key "pageLoad":

    1. Let page load duration be the value of property "pageLoad".

    2. If page load duration is less than 0 or greater than maximum safe integer, return error with error code invalid argument.

    3. Set timeouts’s page load timeout to page load duration.

  5. If value has a property with the key "implicit":

    1. Let implicit duration be the value of property "implicit".

    2. If implicit duration is less than 0 or greater than maximum safe integer, return error with error code invalid argument.

    3. Set timeouts’s implicit wait timeout to implicit duration.

  6. Return success with data timeouts.

9.1 Get Timeouts

HTTP Method URI Template
GET /session/{session id}/timeouts

The remote end step are:

  1. Let timeouts be the timeouts object for session’s timeouts configuration

  2. Return success with data timeouts.

9.2 Set Timeouts

HTTP Method URI Template
POST /session/{session id}/timeouts

The remote end steps are:

  1. Let timeouts be the result of trying to JSON deserialize as a timeouts configuration the request’s parameters.

  2. Make the session timeouts the new timeouts.

  3. Return success with data null.

11. Contexts

Many WebDriver commands happen in the context of either the current browsing context or current top-level browsing context. The current top-level browsing context is represented in the protocol by its associated window handle. When a top-level browsing context is selected using the Switch To Window command, a specific browsing context can be selected using the Switch to Frame command.

Note

The use of the term “window” to refer to a top-level browsing context is legacy and doesn’t correspond with either the operating system notion of a “window” or the DOM Window object.

A browsing context is said to be no longer open if its navigable has been destroyed.

Each browsing context has an associated window handle which uniquely identifies it. This must be a String and must not be "current".

The web window identifier is the string constant "window-fcc6-11e5-b4f8-330a88ab9d7f".

The web frame identifier is the string constant "frame-075b-4da1-b6ba-e579c2d3230a".

The WindowProxy reference object with WindowProxy object window is given by:

  1. Let identifier be the web window identifier if the associated browsing context of window is a top-level browsing context.

    Otherwise let it be the web frame identifier.

  2. Return a JSON Object initialized with the following properties:

    identifier

    Associated window handle of the window’s browsing context.

When required to set the current browsing context given a context, an implementation must follow the following steps:

  1. Set the current session’s current browsing context to context.
  2. Set the current session’s current parent browsing context to the parent browsing context of context, if that context exists, or null otherwise.

When required to set the current top-level browsing context given a context, an implementation must follow the following steps:

  1. Assert: context is a top-level browsing context.
  2. Set the current session’s current top-level browsing context to context.
  3. Set the current browsing context to context.
Note

In accordance with the focus section of the [HTML] specification, commands are unaffected by whether the operating system window has focus or not.

11.1 Get Window Handle

HTTP Method URI Template
GET /session/{session id}/window

The remote end steps are:

  1. If the current top-level browsing context is no longer open, return error with error code no such window.

  2. Return success with data being the window handle associated with the current top-level browsing context.

11.2 Close Window

HTTP Method URI Template
DELETE /session/{session id}/window

The remote end steps are:

  1. If the current top-level browsing context is no longer open, return error with error code no such window.

  2. Handle any user prompts and return its value if it is an error.

  3. Close the current top-level browsing context.

  4. If there are no more open top-level browsing contexts, then try to close the session.

  5. Return the result of running the remote end steps for the Get Window Handles command.

11.3 Switch To Window

HTTP Method URI Template
POST /session/{session id}/window
Note

Switching window will select the current top-level browsing context used as the target for all subsequent commands. In a tabbed browser, this will typically make the tab containing the browsing context the selected tab.

The remote end steps are:

  1. Let handle be the result of getting the property "handle" from the parameters argument.

  2. If handle is undefined, return error with error code invalid argument.

  3. If there is an active user prompt, that prevents the focusing of another top-level browsing context, return error with error code unexpected alert open.

  4. If handle is equal to the associated window handle for some top-level browsing context in the current session, let context be the that browsing context, and set the current top-level browsing context with context.

    Otherwise, return error with error code no such window.

  5. Update any implementation-specific state that would result from the user selecting the current browsing context for interaction, without altering OS-level focus.

  6. Return success with data null.

11.4 Get Window Handles

HTTP Method URI Template
GET /session/{session id}/window/handles

The order in which the window handles are returned is arbitrary.

The remote end steps are:

  1. Let handles be a JSON List.

  2. For each top-level browsing context in the remote end, push the associated window handle onto handles.

  3. Return success with data handles.

11.5 New Window

HTTP Method URI Template
POST /session/{session id}/window/new

Create a new top-level browsing context.

The remote end steps are:

  1. If the implementation does not support creating new top-level browsing contexts, return error with error code unsupported operation.

  2. If the current top-level browsing context is no longer open, return error with error code no such window.

  3. Handle any user prompts and return its value if it is an error.

  4. Let type hint be the result of getting the property "type" from the parameters argument.

  5. Create a new top-level browsing context by running the window open steps with url set to "about:blank", target set to the empty string, and features set to "noopener" and the user agent configured to create a new browsing context. This must be done without invoking the focusing steps for the created browsing context. If type hint has the value "tab", and the implementation supports multiple browsing context in the same OS window, the new browsing context should share an OS window with the current browsing context. If type hint is "window", and the implementation supports multiple browsing contexts in separate OS windows, the created browsing context should be in a new OS window. In all other cases the details of how the browsing context is presented to the user are implementation defined.

  6. Let handle be the associated window handle of the newly created window.

  7. Let type be "tab" if the newly created window shares an OS-level window with the current browsing context, or "window" otherwise.

  8. Let result be a new JSON Object initialized with:

    "handle"
    The value of handle.
    "type"
    The value of type.
  9. Return success with data result.

11.6 Switch To Frame

HTTP Method URI Template
POST /session/{session id}/frame
Note

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.

The remote end steps are:

  1. Let id be the result of getting the property "id" from the parameters argument.

  2. If id is not null, a Number object, or an Object that represents a web element, return error with error code invalid argument.

  3. Run the substeps of the first matching condition:

    id is null
    1. If the current top-level browsing context is no longer open, return error with error code no such window.

    2. Handle any user prompts and return its value if it is an error.

    3. Set the current browsing context with the current top-level browsing context.

    id is a Number object
    1. If id is less than 0 or greater than 216 – 1, return error with error code invalid argument.

    2. If the current browsing context is no longer open, return error with error code no such window.

    3. Handle any user prompts and return its value if it is an error.

    4. Let window be the associated window of the current browsing context’s active document.

    5. If id is not a supported property index of window, return error with error code no such frame.

    6. Let child window be the WindowProxy object obtained by calling window.[[GetOwnProperty]] (id).

    7. Set the current browsing context with child window’s browsing context.

    id represents a web element
    1. If the current browsing context is no longer open, return error with error code no such window.

    2. Handle any user prompts and return its value if it is an error.

    3. Let element be the result of trying to get a known element with id.

    4. If element is not a frame or iframe element, return error with error code no such frame.

    5. Set the current browsing context with element’s nested navigable's active browsing context.

  4. Update any implementation-specific state that would result from the user selecting the current browsing context for interaction, without altering OS-level focus.

  5. Return success with data null.

Note

WebDriver is not bound by the same origin policy, so it is always possible to switch into child browsing contexts, even if they are different origin to the current browsing context.

11.7 Switch To Parent Frame

HTTP Method URI Template
POST /session/{session id}/frame/parent

The remote end steps are:

  1. Run the substeps if the current browsing context is already the top-level browsing context:

    1. If the current browsing context is no longer open, return error with error code no such window.

    2. Return success with data null.

  2. If the current parent browsing context is no longer open, return error with error code no such window.

  3. Handle any user prompts and return its value if it is an error.

  4. If the current session's current parent browsing context is not null, set the current browsing context with the current parent browsing context.

  5. Update any implementation-specific state that would result from the user selecting the current browsing context for interaction, without altering OS-level focus.

  6. Return success with data null.

11.8 Resizing and positioning windows

WebDriver provides commands for interacting with the operating system window containing the current top-level browsing context. Because different operating systems’ window managers provide different abilities, not all of the commands in this section can be supported by all remote ends. Support for these commands is determined by the window dimensioning/positioning capability. Where a command is not supported, an unsupported operation error is returned.

The top-level browsing context has an associated window state which describes what visibility state its OS widget window is in. It can be in one of the following states:

State Keyword Default Description
Maximized window state "maximized" The window is maximized.
Minimized window state "minimized" The window is iconified.
Normal window state "normal" The window is shown normally.
Fullscreen window state "fullscreen" The window is in full screen mode.

If for whatever reason the top-level browsing context’s OS window cannot enter either of the window states, or if this concept is not applicable on the current system, the default state must be normal.

A top-level browsing context’s window rect is defined as a dictionary of the screenX, screenY, outerWidth and outerHeight attributes of the WindowProxy.

The WindowRect object for a WindowProxy, window is an Object initialized with the following properties:

"x"

window’s screenX attribute.

"y"

window’s screenY attribute.

"width"

windows’s outerWidth attribute.

"height"

window’s outerHeight attribute.

To maximize the window, given an operating system level window with an associated top-level browsing context, run the implementation-specific steps to transition the operating system level window into the maximized window state. If the window manager supports window resizing but does not have a concept of window maximization, the window dimensions must be increased to the maximum available size permitted by the window manager for the current screen. Return when the window has completed the transition, or within an implementation-defined timeout.

To iconify the window, given an operating system level window with an associated top-level browsing context, run implementation-specific steps to iconify, minimize, or hide the window from the visible screen. Do not return from this operation until the visibility state of the top-level browsing context’s active document has reached the hidden state, or until the operation times out.

To restore the window, given an operating system level window with an associated top-level browsing context, run implementation-specific steps to restore or unhide the window to the visible screen. Do not return from this operation until the visibility state of the top-level browsing context’s active document has reached the visible state, or until the operation times out.

11.8.1 Get Window Rect

HTTP Method URI Template
GET /session/{session id}/window/rect
Note

The Get Window Rect command returns the size and position on the screen of the operating system window corresponding to the current top-level browsing context.

The remote end steps are:

  1. If the current top-level browsing context is no longer open, return error with error code no such window.

  2. Handle any user prompts and return its value if it is an error.

  3. Return success with data set to the WindowRect object for the current top-level browsing context.

11.8.2 Set Window Rect

HTTP Method URI Template
POST /session/{session id}/window/rect
Note

The Set Window Rect command alters the size and the position of the operating system window corresponding to the current top-level browsing context.

The remote end steps are:

  1. Let width be the result of getting a property named width from the parameters argument, else let it be null.

  2. Let height be the result of getting a property named height from the parameters argument, else let it be null.

  3. Let x be the result of getting a property named x from the parameters argument, else let it be null.

  4. Let y be the result of getting a property named y from the parameters argument, else let it be null.

  5. If width or height is neither null nor a Number from 0 to 231 − 1, return error with error code invalid argument.

  6. If x or y is neither null nor a Number from −(231) to 231 − 1, return error with error code invalid argument.

  7. If the remote end does not support the Set Window Rect command for the current top-level browsing context for any reason, return error with error code unsupported operation.

  8. If the current top-level browsing context is no longer open, return error with error code no such window.

  9. Handle any user prompts and return its value if it is an error.

  10. Fully exit fullscreen.

  11. Restore the window.

  12. If width and height are not null:

    1. Set the width, in CSS pixels, of the operating system window containing the current top-level browsing context, including any browser chrome and externally drawn window decorations to a value that is as close as possible to width.

    2. Set the height, in CSS pixels, of the operating system window containing the current top-level browsing context, including any browser chrome and externally drawn window decorations to a value that is as close as possible to height.

      Note
  13. If x and y are not null:

    1. Run the implementation-specific steps to set the position of the operating system level window containing the current top-level browsing context to the position given by the x and y coordinates.

      Note
  14. Return success with data set to the WindowRect object for the current top-level browsing context.

11.8.3 Maximize Window

HTTP Method URI Template
POST /session/{session id}/window/maximize
Note

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.

The remote end steps are:

  1. If the remote end does not support the Maximize Window command for the current top-level browsing context for any reason, return error with error code unsupported operation.

  2. If the current top-level browsing context is no longer open, return error with error code no such window.

  3. Handle any user prompts and return its value if it is an error.

  4. Fully exit fullscreen.

  5. Restore the window.

  6. Maximize the window of the current top-level browsing context.

  7. Return success with data set to the WindowRect object for the current top-level browsing context.

11.8.4 Minimize Window

HTTP Method URI Template
POST /session/{session id}/window/minimize
Note

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.

The remote end steps are:

  1. If the remote end does not support the Minimize Window command for the current top-level browsing context for any reason, return error with error code unsupported operation.

  2. If the current top-level browsing context is no longer open, return error with error code no such window.

  3. Handle any user prompts and return its value if it is an error.

  4. Fully exit fullscreen.

  5. Iconify the window.

  6. Return success with data set to the WindowRect object for the current top-level browsing context.

11.8.5 Fullscreen Window

HTTP Method URI Template
POST /session/{session id}/window/fullscreen

The remote end steps are:

  1. If the remote end does not support fullscreen return error with error code unsupported operation.

  2. If the current top-level browsing context is no longer open, return error with error code no such window.

  3. Handle any user prompts and return its value if it is an error.

  4. Restore the window.

  5. Call fullscreen an element with the current top-level browsing context’s active document’s document element.

  6. Return success with data set to the WindowRect object for the current top-level browsing context.

12. Elements

A web element is an abstraction used to identify an element when it is transported via the protocol, between remote- and local ends.

The web element identifier is the string constant "element-6066-11e4-a52e-4f735466cecf".

An ECMAScript Object represents a web element if it has a web element identifier own property.

The WebDriver node id is a globally unique string representing a handle to a DOM node in a specific WebDriver session.

A WebDriver session has a browsing context group node map, which is a weak map between a browsing context group and a node id map.

A node id map is weak map between nodes and their corresponding WebDriver node id.

A WebDriver session has a navigable seen nodes map which is a weak map between a navigable and a set.

To get a node given session, browsing context, and reference:

  1. Let browsing context group node map be session's browsing context group node map.
  2. Let browsing context group be browsing context's browsing context group.
  3. If browsing context group node map does not contain browsing context group, return null.
  4. Let node id map be browsing context group node map[browsing context group].
  5. Let node be the entry in node id map whose value is reference, if such an entry exists, or null otherwise.
  6. Return node.

To get or create a node reference given session, browsing context, and node:

  1. Let browsing context group node map be session's browsing context group node map.
  2. Let browsing context group be browsing context's browsing context group.
  3. If browsing context group node map does not contain browsing context group, set browsing context group node map[browsing context group] to a new weak map.
  4. Let node id map be browsing context group node map[browsing context group].
  5. If node id map does not contain node:
    1. Let node id be a new globally unique string.
    2. Set node id map[node] to node id.
    3. Let navigable be browsing context's active document's node navigable.
    4. Let navigable seen nodes map be session's navigable seen nodes map.
    5. If navigable seen nodes map does not contain navigable, set navigable seen nodes map[navigable] to an empty set.
    6. Append node id to navigable seen nodes map[navigable].
  6. Return node id map[node].

A node reference is known given session, browsing context, and reference if the following steps return true:

  1. Let navigable be browsing context's active document's node navigable.
  2. Let navigable seen nodes map be session's navigable seen nodes map.
  3. If navigable seen nodes map contains navigable and navigable seen nodes map[navigable] contains reference, return true, otherwise return false.

To get a known element given reference:

  1. If not node reference is known with current session, current browsing context, and reference return error with error code no such element.
  2. Let node be the result of get a node with current session, current browsing context, and reference.
  3. If node is not null and node does not implement Element return error with error code no such element.
  4. If node is null or node is stale return error with error code stale element reference.
  5. Return success with data node.

To get or create a web element reference given element:

  1. Assert: element implements Element.
  2. Return the result of trying to get or create a node reference given current session, current browsing context, and element.

The web element reference object for element is given by:

  1. Let identifier be the web element identifier.

  2. Let reference be the result of get or create a web element reference with element.

  3. Return a JSON Object initialized with a property with name identifier and value reference.

To deserialize a web element by a JSON Object object that represents a web element:

  1. If object has no own property web element identifier, return error with error code invalid argument.

  2. Let reference be the result of getting the web element identifier property from object.

  3. Let element be the result of trying to get a known element with reference.

  4. Return success with data element.

An element is stale if its node document is not the active document or if it is not connected.

To scroll into view an element perform the following steps only if the element is not already in view:

  1. Let options be the following ScrollIntoViewOptions:

    Logical scroll position "block"
    "end"
    Logical scroll position "inline"
    "nearest"
  2. Run Function.[[Call]](scrollIntoView, options) with element as the this value.

Editable elements are those that can be used for typing and clearing, and they fall into two subcategories:

Mutable form control elements

Denotes input elements that are mutable (e.g. that are not read only or disabled) and whose type attribute is in one of the following states:

And the textarea element.

Mutable elements

Denotes elements that are editing hosts or content editable.

An element is said to have pointer events disabled if the resolved value of its "pointer-events" style property is "none".

An element is to be considered read only if it is an input element whose readonly attribute is set.

12.1 Interactability

In order to determine if an element can be interacted with using pointer actions, WebDriver performs hit-testing to find if the interaction will be able to reach the requested element.

An interactable element is an element which is either pointer-interactable or keyboard-interactable.

A pointer-interactable element is defined to be the first element, defined by the paint order found at the center point of its rectangle that is inside the viewport, excluding the size of any rendered scrollbars.

A keyboard-interactable element is any element that has a focusable area, is a body element, or is the document element.

An element’s in-view center point is the origin position of the rectangle that is the intersection between the element’s first DOMRect of getClientRects() and the initial viewport. Given an element that is known to be in view, it can be calculated this way:

  1. Let rectangle be the first element of the DOMRect sequence returned by calling getClientRects() on element.

  2. Let left be max(0, min(x coordinate, x coordinate + width dimension)).

  3. Let right be min(innerWidth, max(x coordinate, x coordinate + width dimension)).

  4. Let top be max(0, min(y coordinate, y coordinate + height dimension)).

  5. Let bottom be min(innerHeight, max(y coordinate, y coordinate + height dimension)).

  6. Let x be floor((left + right) ÷ 2.0).

  7. Let y be floor((top + bottom) ÷ 2.0).

  8. Return the pair of (x, y).

An element is in view if it is a member of its own pointer-interactable paint tree, given the pretense that its pointer events are not disabled.

An element is obscured if the pointer-interactable paint tree at its center point is empty, or the first element in this tree is not an inclusive descendant of itself.

An element’s pointer-interactable paint tree is produced this way:

  1. If element is not in the same tree as the current browsing context’s active document, return an empty sequence.

  2. Let rectangles be the DOMRect sequence returned by calling getClientRects().

  3. If rectangles has the length of 0, return an empty sequence.

  4. Let center point be the in-view center point of the first indexed element in rectangles.

  5. Return the elements from point given the coordinates center point.

12.2 Shadow Roots

A shadow root is an abstraction used to identify a shadow root when it is transported via the protocol, between remote and local ends.

The shadow root identifier is the string constant "shadow-6066-11e4-a52e-4f735466cecf".

An ECMAScript Object represents a shadow root if it has a shadow root identifier own property.

To get a known shadow root given session and reference:

  1. If not node reference is known with current session, current browsing context, and reference return error with error code no such element.
  2. Let node be the result of get a node with current session, current browsing context, and reference.
  3. If node is not null and node does not implement ShadowRoot return error with error code no such shadow root.
  4. If node is null or node is detached return error with error code detached shadow root.
  5. Return success with data node.

To get or create a shadow root reference with shadow root:

  1. Assert: element implements ShadowRoot.
  2. Return the result of trying to get or create a node reference given current session, current browsing context, and element.

The shadow root reference object for shadow root is given by:

  1. Let identifier be the shadow root identifier.

  2. Let reference be the result of get or create a shadow root reference given shadow root.

  3. Return a JSON Object initialized with a property with name identifier and value reference.

When required to deserialize a shadow root by a JSON Object object that represents a shadow root:

  1. If object has no own property shadow root identifier, return error with error code invalid argument.

  2. Let reference be the result of getting the shadow root identifier property from object.

  3. Let shadow be the result of trying to get a known shadow root with argument reference.

  4. Return success with data shadow.

A shadow root is detached if its node document is not the active document or if the element node referred to as its host is stale.

12.3 Retrieval

The Find Element, Find Elements, Find Element From Element, Find Elements From Element, Find Element From Shadow Root, and Find Elements From Shadow Root commands allow lookup of individual elements and collections of elements. Element retrieval searches are performed using pre-order traversal of the document’s nodes that match the provided selector’s expression.

When required to find with arguments start node, using and value, a remote end must run the following steps:

  1. Let end time be the current time plus the session implicit wait timeout.

  2. Let location strategy be equal to using.

  3. Let selector be equal to value.

  4. Let elements returned be the result of trying to call the relevant element location strategy with arguments start node, and selector.

  5. If a DOMException, SyntaxError, XPathException, or other error occurs during the execution of the element location strategy, return error invalid selector.
  6. If elements returned is empty and the current time is less than end time return to step 4. Otherwise, continue to the next step.

  7. Let result be an empty JSON List.

  8. For each element in elements returned, append the web element reference object for element, to result.

  9. Return success with data result.

12.3.1 Locator strategies

An element location strategy is an enumerated attribute deciding what technique should be used to search for elements in the current browsing context. The following table of location strategies lists the keywords and states defined for this attribute:

State Keyword
CSS selector "css selector"
Link text selector "link text"
Partial link text selector "partial link text"
Tag name "tag name"
XPath selector "xpath"
12.3.1.1 CSS selectors

To find a web element with the CSS Selector strategy the following steps need to be completed:

  1. Let elements be the result of calling querySelectorAll() with start node as this and selector as the argument. If this causes an exception to be thrown, return error with error code invalid selector.

  2. Return success with data elements.

12.3.1.4 Tag name

To find a web element with the Tag Name strategy return success with data set to the result of calling getElementsByTagName() with start node as this and selector as the argument.

12.3.1.5 XPath

To find a web element with the XPath Selector strategy the following steps need to be completed:

  1. Let evaluateResult be the result of calling evaluate, with arguments selector, start node, null, ORDERED_NODE_SNAPSHOT_TYPE, and null.

    Note

    A snapshot is used to promote operation atomicity.

  2. Let index be 0.

  3. Let length be the result of getting the property "snapshotLength" from evaluateResult. If this throws an XPathException return error with error code invalid selector, otherwise if this throws any other exception return error with error code unknown error.

  4. Let result be an empty NodeList.

  5. Repeat, while index is less than length:

    1. Let node be the result of calling snapshotItem with evaluateResult as this and index as the argument.
    2. If node is not an element return an error with error code invalid selector.

    3. Append node to result.
    4. Increment index by 1.
  6. Return success with data result.

12.3.2 Find Element

HTTP Method URI Template
POST /session/{session id}/element
Note

The remote end steps are:

  1. Let location strategy be the result of getting a property called "using".

  2. If location strategy is not present as a keyword in the table of location strategies, return error with error code invalid argument.

  3. Let selector be the result of getting a property called "value".

  4. If selector is undefined, return error with error code invalid argument.

  5. If the current browsing context is no longer open, return error with error code no such window.

  6. Handle any user prompts and return its value if it is an error.

  7. Let start node be the current browsing context’s document element.

  8. If start node is null, return error with error code no such element.

  9. Let result be the result of trying to Find with start node, location strategy, and selector.

  10. If result is empty, return error with error code no such element. Otherwise, return the first element of result.

12.3.3 Find Elements

HTTP Method URI Template
POST /session/{session id}/elements

The remote end steps are:

  1. Let location strategy be the result of getting a property called "using".

  2. If location strategy is not present as a keyword in the table of location strategies, return error with error code invalid argument.

  3. Let selector be the result of getting a property called "value".

  4. If selector is undefined, return error with error code invalid argument.

  5. If the current browsing context is no longer open, return error with error code no such window.

  6. Handle any user prompts and return its value if it is an error.

  7. Let start node be the current browsing context’s document element.

  8. If start node is null, return error with error code no such element.

  9. Return the result of trying to Find with start node, location strategy, and selector.

12.3.4 Find Element From Element

HTTP Method URI Template
POST /session/{session id}/element/{element id}/element

The remote end steps are:

  1. Let location strategy be the result of getting a property called "using".

  2. If location strategy is not present as a keyword in the table of location strategies, return error with error code invalid argument.

  3. Let selector be the result of getting a property called "value".

  4. If selector is undefined, return error with error code invalid argument.

  5. If the current browsing context is no longer open, return error with error code no such window.

  6. Handle any user prompts and return its value if it is an error.

  7. Let start node be the result of trying to get a known element with url variable element id.

  8. Let result be the value of trying to Find with start node, location strategy, and selector.
  9. If result is empty, return error with error code no such element. Otherwise, return the first element of result.

12.3.5 Find Elements From Element

HTTP Method URI Template
POST /session/{session id}/element/{element id}/elements

The remote end steps are:

  1. Let location strategy be the result of getting a property called "using".

  2. If location strategy is not present as a keyword in the table of location strategies, return error with error code invalid argument.

  3. Let selector be the result of getting a property called "value".

  4. If selector is undefined, return error with error code invalid argument.

  5. If the current browsing context is no longer open, return error with error code no such window.

  6. Handle any user prompts and return its value if it is an error.

  7. Let start node be the result of trying to get a known element with url variable element id.

  8. Return the result of trying to Find with start node, location strategy, and selector.

12.3.6 Find Element From Shadow Root

HTTP Method URI Template
POST /session/{session id}/shadow/{shadow id}/element

The remote end steps are:

  1. Let location strategy be the result of getting a property called "using".

  2. If location strategy is not present as a keyword in the table of location strategies, return error with error code invalid argument.

  3. Let selector be the result of getting a property called "value".

  4. If selector is undefined, return error with error code invalid argument.

  5. If the current browsing context is no longer open, return error with error code no such window.

  6. Handle any user prompts and return its value if it is an error.

  7. Let start node be the result of trying to get a known shadow root with url variable shadow id.

  8. Let result be the value of trying to Find with start node, location strategy, and selector.
  9. If result is empty, return error with error code no such element. Otherwise, return the first element of result.

12.3.7 Find Elements From Shadow Root

HTTP Method URI Template
POST /session/{session id}/shadow/{shadow id}/elements

The remote end steps are:

  1. Let location strategy be the result of getting a property called "using".

  2. If location strategy is not present as a keyword in the table of location strategies, return error with error code invalid argument.

  3. Let selector be the result of getting a property called "value".

  4. If selector is undefined, return error with error code invalid argument.

  5. If the current browsing context is no longer open, return error with error code no such window.

  6. Handle any user prompts and return its value if it is an error.

  7. Let start node be the result of trying to get a known shadow root with url variable shadow id.

  8. Return the result of trying to Find with start node, location strategy, and selector.

12.3.8 Get Active Element

HTTP Method URI Template
GET /session/{session id}/element/active

The remote end steps are:

  1. If the current browsing context is no longer open, return error with error code no such window.

  2. Handle any user prompts and return its value if it is an error.

  3. Let active element be the active element of the current browsing context’s document element.

  4. If active element is a non-null element, return success with data set to web element reference object for active element.

    Otherwise, return error with error code no such element.

12.3.9 Get Element Shadow Root

HTTP Method URI Template
GET /session/{session id}/element/{element id}/shadow

The remote end steps are:

  1. If the current browsing context is no longer open, return error with error code no such window.

  2. Handle any user prompts and return its value if it is an error.

  3. Let element be the result of trying to get a known element with url variable element id.

  4. Let shadow root be element's shadow root.

  5. If shadow root is null, return error with error code no such shadow root.

  6. Let serialized be the shadow root reference object for shadow root.

  7. Return success with data serialized.

12.4 State

To calculate the absolute position of element:

  1. Let rect be the value returned by calling getBoundingClientRect().

  2. Let window be the associated window of current top-level browsing context.

  3. Let x be (scrollX of window + rect’s x coordinate).

  4. Let y be (scrollY of window + rect’s y coordinate).

  5. Return a pair of (x, y).

To determine if node is not in the same tree as another node, other, run the following substeps:

  1. If the node’s node document is not other’s node document, return true.

  2. Return true if the result of calling the node’s compareDocumentPosition() with other as argument is DOCUMENT_POSITION_DISCONNECTED (1), otherwise return false.

An element’s container is:

option element in a valid element context
optgroup element in a valid element context

The element’s element context, which is determined by:

  1. Let datalist parent be the first datalist element reached by traversing the tree in reverse order from element, or undefined if the root of the tree is reached.

  2. Let select parent be the first select element reached by traversing the tree in reverse order from element, or undefined if the root of the tree is reached.

  3. If datalist parent is undefined, the element context is select parent. Otherwise, the element context is datalist parent.

option element in an invalid element context

The element does not have a container.

Otherwise

The container is the element itself.

12.4.1 Is Element Selected

HTTP Method URI Template
GET /session/{session id}/element/{element id}/selected
Note

The Is Element Selected command 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 on option elements.

The remote end steps are:

  1. If the current browsing context is no longer open, return error with error code no such window.

  2. Handle any user prompts and return its value if it is an error.

  3. Let element be the result of trying to get a known element with url variable element id.

  4. Let selected be the value corresponding to the first matching statement:

    element is an input element with a type attribute in the Checkbox- or Radio Button state

    The result of element’s checkedness.

    element is an option element

    The result of element’s selectedness.

    Otherwise
    False.
  5. Return success with data selected.

12.4.2 Get Element Attribute

HTTP Method URI Template
GET /session/{session id}/element/{element id}/attribute/{name}

The remote end steps are:

  1. If the current browsing context is no longer open, return error with error code no such window.

  2. Handle any user prompts and return its value if it is an error.

  3. Let element be the result of trying to get a known element with url variable element id.

  4. Let result be the result of the first matching condition:
    If name is a boolean attribute

    "true" (string) if the element hasAttribute() with name, otherwise null.

    Otherwise

    The result of getting an attribute by name name.

  5. Return success with data result.

Note

Please note that the behavior of this command deviates from the behavior of getAttribute() in [DOM], which in the case of a set boolean attribute would return an empty string. The reason this command returns true as a string is because this evaluates to true in most dynamically typed programming languages, but still preserves the expected type information.

12.4.3 Get Element Property

HTTP Method URI Template
GET /session/{session id}/element/{element id}/property/{name}

The remote end steps are:

  1. If the current browsing context is no longer open, return error with error code no such window.

  2. Handle any user prompts and return its value if it is an error.

  3. Let element be the result of trying to get a known element with url variable element id.

  4. Let property be the result of calling the Object.[[GetProperty]](name) on element.

  5. Let result be the value of property if not undefined, or null.

  6. Return success with data result.

12.4.4 Get Element CSS Value

HTTP Method URI Template
GET /session/{session id}/element/{element id}/css/{property name}

The remote end steps are:

  1. If the current browsing context is no longer open, return error with error code no such window.

  2. Handle any user prompts and return its value if it is an error.

  3. Let element be the result of trying to get a known element with url variable element id.

  4. Let computed value be the result of the first matching condition:

    current browsing context’s active document’s type is not "xml"
    computed value of parameter property name from element’s style declarations. property name is obtained from url variables.
    Otherwise
    "" (empty string)
  5. Return success with data computed value.

12.4.5 Get Element Text

HTTP Method URI Template
GET /session/{session id}/element/{element id}/text
Note

When processing text, whitespace is defined as characters from the Unicode Character Database with the Unicode character property "WSpace=Y" or "WS". [UAX44]

The remote end steps are:

  1. If the current browsing context is no longer open, return error with error code no such window.

  2. Handle any user prompts and return its value if it is an error.

  3. Let element be the result of trying to get a known element with url variable element id.

  4. Let rendered text be the result of performing implementation-specific steps whose result is exactly the same as the result of a Function.[[Call]](null, element) with bot.dom.getVisibleText as the this value.

  5. Return success with data rendered text.

12.4.6 Get Element Tag Name

HTTP Method URI Template
GET /session/{session id}/element/{element id}/name

The remote end steps are:

  1. If the current browsing context is no longer open, return error with error code no such window.

  2. Handle any user prompts and return its value if it is an error.

  3. Let element be the result of trying to get a known element with url variable element id.

  4. Let qualified name be the result of getting element’s tagName IDL attribute.

  5. Return success with data qualified name.

12.4.7 Get Element Rect

HTTP Method URI Template
GET /session/{session id}/element/{element id}/rect
Note

The remote end steps are:

  1. If the current browsing context is no longer open, return error with error code no such window.

  2. Handle any user prompts and return its value if it is an error.

  3. Let element be the result of trying to get a known element with url variable element id.

  4. Calculate the absolute position of element and let it be coordinates.

  5. Let rect be element’s bounding rectangle.

  6. Let body be a new JSON Object initialized with:

    "x"
    The first value of coordinates.
    "y"
    The second value of coordinates.
    "width"
    Value of rect’s width dimension.
    "height"
    Value of rect’s height dimension.
  7. Return success with data body.

12.4.8 Is Element Enabled

HTTP Method URI Template
GET /session/{session id}/element/{element id}/enabled

The remote end steps are:

  1. If the current browsing context is no longer open, return error with error code no such window.

  2. Handle any user prompts and return its value if it is an error.

  3. Let element be the result of trying to get a known element with url variable element id.

  4. Let enabled be a boolean initially set to true if the current browsing context’s active document’s type is not "xml".

    Otherwise, let enabled to false and jump to the last step of this algorithm.

  5. Set enabled to false if a form control is disabled.

  6. Return success with data enabled.

12.4.9 Get Computed Role

HTTP Method URI Template
GET /session/{session id}/element/{element id}/computedrole

The remote end steps are:

  1. If the current browsing context is no longer open, return error with error code no such window.

  2. Handle any user prompts and return its value if it is an error.

  3. Let element be the result of trying to get a known element with url variable element id.

  4. Let role be the result of computing the WAI-ARIA role of element.

  5. Return success with data role.

12.4.10 Get Computed Label

HTTP Method URI Template
GET /session/{session id}/element/{element id}/computedlabel

The remote end steps are:

  1. If the current browsing context is no longer open, return error with error code no such window.

  2. Handle any user prompts and return its value if it is an error.

  3. Let element be the result of trying to get a known element with url variable element id.

  4. Let label be the result of a Accessible Name and Description Computation for the Accessible Name of the element.

  5. Return success with data label.

12.5 Interaction

The element interaction commands provide a high-level instruction set for manipulating form controls. Unlike Actions, they will implicitly scroll elements into view and check that it is an interactable element.

Some resettable elements define their own clear algorithm. Unlike their associated reset algorithms, changes made to form controls as part of these algorithms do count as changes caused by the user (and thus, e.g. do cause input events to fire). When the clear algorithm is invoked for an element that does not define its own clear algorithm, its reset algorithm must be invoked instead.

The clear algorithm for input elements is to set the dirty value flag and dirty checkedness flag back to false, set the value of the element to an empty string, set the checkedness of the element to true if the element has a checked content attribute and false if it does not, empty the list of selected files, and then invoke the value sanitization algorithm iff the type attribute’s current state defines one.

The clear algorithm for textarea elements is to set the dirty value flag back to false, and set the raw value of element to an empty string.

The clear algorithm for output elements is set the element’s value mode flag to default and then to set the element’s textContent IDL attribute to an empty string (thus clearing the element’s child nodes).

12.5.1 Element Click

HTTP Method URI Template
POST /session/{session id}/element/{element id}/click
Note

The remote end steps are:

  1. If the current browsing context is no longer open, return error with error code no such window.

  2. Handle any user prompts and return its value if it is an error.

  3. Let element be the result of trying to get a known element with element id.

  4. If the element is an input element in the file upload state return error with error code invalid argument.

  5. Scroll into view the element’s container.

  6. If element’s container is still not in view, return error with error code element not interactable.

  7. If element’s container is obscured by another element, return error with error code element click intercepted.

  8. Matching on element:

    option element
    1. Let parent node be the element’s container.

    2. Fire a mouseOver event at parent node.

    3. Fire a mouseMove event at parent node.

    4. Fire a mouseDown event at parent node.

    5. Run the focusing steps on parent node.

    6. If element is not disabled:

      1. Fire an input event at parent node.

      2. Let previous selectedness be equal to element selectedness.

      3. If element’s container has the multiple attribute, toggle the element’s selectedness state by setting it to the opposite value of its current selectedness.

        Otherwise, set the element’s selectedness state to true.

      4. If previous selectedness is false, fire a change event at parent node.

    7. Fire a mouseUp event at parent node.

    8. Fire a click event at parent node.

    Otherwise
    1. Let input state be the result of get the input state given current session and current top-level browsing context.

    2. Let actions options be a new actions options with the is element origin steps set to represents a web element, and the get element origin steps set to get a WebElement origin.

    3. Let input id be a the result of generating a UUID.

    4. Let source be the result of create an input source with input state, and "pointer".

    5. Add an input source with input state, input id and source.

    6. Let click point be the element’s in-view center point.

    7. Let pointer move action be an action object constructed with arguments input id, "pointer", and "pointerMove".

    8. Set a property x to 0 on pointer move action.

    9. Set a property y to 0 on pointer move action.

    10. Set a property origin to element on pointer move action.

    11. Let pointer down action be an action object constructed with arguments input id, "pointer", and "pointerDown".

    12. Set a property button to 0 on pointer down action.

    13. Let pointer up action be an action object constructed with arguments input id, "mouse", and "pointerUp" as arguments.

    14. Set a property button to 0 on pointer up action.

    15. Let actions be the list «pointer move action, pointer down action, pointer move action».

    16. Dispatch a list of actions with input state, actions, current browsing context, and actions options.

    17. Remove an input source with input state and input id.

  9. Wait until the user agent event loop has spun enough times to process the DOM events generated by the previous step.

  10. Perform implementation-defined steps to allow any navigations triggered by the click to start.

    Note

    It is not always clear how long this will cause the algorithm to wait, and it is acknowledged that some implementations may have unavoidable race conditions. The intention is to allow a new attempt to navigate to begin so that the next step in the algorithm is meaningful. It is possible the click does not cause an attempt to navigate, in which case the implementation-defined steps can return immediately, and the next step will also return immediately.

  11. Try to wait for navigation to complete.

  12. Try to run the post-navigation checks.

  13. Return success with data null.

12.5.2 Element Clear

HTTP Method URI Template
POST /session/{session id}/element/{element id}/clear

To clear a content editable element:

  1. If element’s innerHTML IDL attribute is an empty string do nothing and return.

  2. Run the focusing steps for element.

  3. Set element’s innerHTML IDL attribute to an empty string.

  4. Run the unfocusing steps for the element.

To clear a resettable element:

  1. Let empty be the result of the first matching condition:

    element is an input element whose type attribute is in the File Upload state
    True if the list of selected files has a length of 0, and false otherwise.
    Otherwise
    True if its value IDL attribute is an empty string, and false otherwise.
  2. If element is a candidate for constraint validation it satisfies its constraints, and empty is true, abort these substeps.

  3. Invoke the focusing steps for element.

  4. Invoke the clear algorithm for element.

  5. Invoke the unfocusing steps for the element.

The remote end steps for Element Clear are:

  1. If the current browsing context is no longer open, return error with error code no such window.

  2. Handle any user prompts and return its value if it is an error.

  3. Let element be the result of trying to get a known element with element id.

  4. If element is not editable, return an error with error code invalid element state.

  5. Scroll into view the element.

  6. Wait in an implementation-specific way up to the session implicit wait timeout for element to become interactable.

  7. If element is not interactable, return error with error code element not interactable.

  8. Run the substeps of the first matching statement:

    element is a mutable form control element

    Invoke the steps to clear a resettable element.

    element is a mutable element

    Invoke the steps to clear a content editable element.

    Otherwise

    Return error with error code invalid element state.

  9. Return success with data null.

12.5.3 Element Send Keys

HTTP Method URI Template
POST /session/{session id}/element/{element id}/value
Note

The Element Send Keys command scrolls into view the form control element and then sends the provided keys to the element. In case the element is not keyboard-interactable, an element not interactable error is returned.

A non-typeable form control is an input element whose type attribute state causes the primary input mechanism not to be through means of a keyboard, whether virtual or physical.

Non-typeable form controls means to refer to form control elements rendered by the user agent as something other than as a text input control. When targetting an input element in the color state being presented as a color wheel, interaction with it will be simulated, rather than typed using key emulation with actions.

Other examples of non-typeable form controls include form controls interacted with via system-native widgets, such as a scrolled option list for select elements and a number keypad for input elements in the number state on non-desktop devices.

The key input source used for input may be cleared mid-way through “typing” by sending the null key, which is U+E000 (NULL).

To clear the modifier key state given input state, input id, source, undo actions, and browsing context:

  1. If source is not a key input source return error with error code invalid argument.

  2. Let actions options be a new actions options with the is element origin steps set to represents a web element, and the get element origin steps set to get a WebElement origin.

  3. For each entry key in the lexically sorted keys of undo actions:

    1. Let action be the value of undo actions equal to the key entry key.

    2. If action is not an action object with type "key" and subtype "keyUp", return error with error code invalid argument.

    3. Let actions be the list «action»

    4. Dispatch a list of actions with input state, actions, current browsing context, and actions options.

An extended grapheme cluster is typeable if it consists of a single unicode code point and the code is not undefined.

The shifted state for keyboard is the value of keyboard’s shift property.

To dispatch the events for a typeable string given input state, input id, source, text, and browsing context:

  1. Let actions options be a new actions options with the is element origin steps set to represents a web element, and the get element origin steps set to get a WebElement origin.

  2. For each char of text:
    1. Let global key state be the result of get the global key state with input state.

    2. If char is a shifted character, and the shifted state of source is false:

      1. Let action be an action object constructed with input id, "key", and "keyDown", and set its value property to U+E008 ("left shift").

      2. Let actions be the list «action».

      3. Dispatch a list of actions with input state, actions, and current browsing context.

    3. If char is not a shifted character and the shifted state of source is true:

      1. Let action be an action object constructed with input id, "key", and "keyUp", and set its value property to U+E008 ("left shift").

      2. Let tick actions be the list «action».

      3. Dispatch a list of actions with input state, actions, current browsing context, and actions options.

    4. Let keydown action be an action object constructed with arguments input id, "key", and "keyDown".

    5. Set the value property of keydown action to char.

    6. Let keyup action be a copy of keydown action with the subtype property changed to "keyUp".

    7. Let actions be the list «keydown action, keyup action»

    8. Dispatch a list of actions with input state, actions, current browsing context, and actions options.

When required to dispatch a composition event given type and cluster, and browsing context, the remote end must perform implementation-specific action dispatch steps on browsing context equivalent to sending composition events in accordance with the requirements of [UI-EVENTS], and producing the following event with the specified properties.

To dispatch actions for a string given input state, input id, source, text, browsing context, and actions options:

  1. Let clusters be an array created by breaking text into extended grapheme clusters.

  2. Let undo actions be an empty map.

  3. Let current typeable text be an empty list.

  4. For each cluster corresponding to an indexed property in clusters run the substeps of the first matching statement:

    cluster is the null key
    1. Dispatch the events for a typeable string with input state, input id, source, current typeable text, and browsing context. Empty current typeable text.

    2. Try to clear the modifier key state with input state, input id, source, undo actions and browsing context.

    3. Clear undo actions.

    cluster is a modifier key
    1. Dispatch the events for a typeable string with input state, input id, source, current typeable text, and browsing context.

    2. Emptycurrent typeable text.

    3. Let keydown action be an action object constructed with arguments input id, "key", and "keyDown".

    4. Set the value property of keydown action to cluster.

    5. Let actions be the list «keydown action»

    6. Dispatch a list of actions with input state, actions, current browsing context, and actions options.

    7. Add an entry to undo actions with key cluster and value being a copy of keydown action with the subtype property modified to "keyUp".

    cluster is typeable

    Append cluster to current typeable text.

    Otherwise
    1. Dispatch the events for a typeable string with input state, input id, source, current typeable text, and browsing context.

    2. Empty current typeable text.

    3. Dispatch a composition event with arguments "compositionstart", undefined, and browsing context.

    4. Dispatch a composition event with arguments "compositionupdate", cluster, and browsing context.

    5. Dispatch a composition event with arguments "compositionend", cluster, and browsing context.

  5. Dispatch the events for a typeable string with input state, input id and source, current typeable text, and browsing context.

  6. Try to clear the modifier key state with arguments input state, input id, source, undo actions, and browsing context.

The remote end steps for Element Send Keys are:

  1. Let text be the result of getting a property called "text" from the parameters argument.

  2. If text is not a String, return an error with error code invalid argument.

  3. If the current browsing context is no longer open, return error with error code no such window.

  4. Handle any user prompts, and return its value if it is an error.

  5. Let element be the result of trying to get a known element with url variable element id.

  6. Let file be true if element is input element in the file upload state, or false otherwise.

  7. If file is false or the current session’s strict file interactability, is true run the following substeps:

    1. Scroll into view the element.

    2. Wait in an implementation-specific way up to the session implicit wait timeout for element to become keyboard-interactable.

    3. If element is not keyboard-interactable, return error with error code element not interactable.

    4. If element is not the active element run the focusing steps for the element.

  8. Run the substeps of the first matching condition:

    file is true
    1. Let files be the result of splitting text on the newline (\n) character.

    2. If files is of 0 length, return an error with error code invalid argument.

    3. Let multiple equal the result of calling hasAttribute() with "multiple" on element.

    4. if multiple is false and the length of files is not equal to 1, return an error with error code invalid argument.

    5. Verify that each file given by the user exists. If any do not, return error with error code invalid argument.

    6. Complete implementation specific steps equivalent to setting the selected files on the input element. If multiple is true files are be appended to element’s selected files.

    7. Fire these events in order on element:

      1. input
      2. change
    8. Return success with data null.

    element is a non-typeable form control
    1. If element does not have an own property named value return an error with error code element not interactable

    2. If element is not mutable return an error with error code element not interactable.

    3. Set a property value to text on element.

    4. If element is suffering from bad input return an error with error code invalid argument.

    5. Return success with data null.

    element is content editable
    If element does not currently have focus, set the text insertion caret after any child content.
    Otherwise
    1. If element does not currently have focus, let current text length be the length of element’s API value.

    2. Set the text insertion caret using set selection range using current text length for both the start and end parameters.

  9. Let input state be the result of get the input state with current session and current top-level browsing context.

  10. Let input id be a the result of generating a UUID.

  11. Let source be the result of create an input source with input state, and "key".

  12. Add an input source with input state, input id and source.

  13. Dispatch actions for a string with arguments input state, input id, and source, text, and current browsing context.

  14. Remove an input source with input state and input id.

  15. Return success with data null.

13. Document

13.1 Get Page Source

HTTP Method URI Template
GET /session/{session id}/source
Note

The Get Page Source command returns a string serialization of the DOM of the current browsing context active document.

The remote end steps are:

  1. If the current browsing context is no longer open, return error with error code no such window.

  2. Handle any user prompts and return its value if it is an error.

  3. Let source be the result of invoking the fragment serializing algorithm on a fictional node whose only child is the document element providing true for the require well-formed flag. If this causes an exception to be thrown, let source be null.

  4. Let source be the result of serializing to string the current browsing context active document, if source is null.

  5. Return success with data source.

13.2 Executing Script

A collection is an Object that implements the Iterable interface, and whose:

When required to JSON deserialize with argument value and optional argument seen, a remote end must run the following steps:

  1. If seen is not provided, let seen be an empty List.

  2. Jump to the first appropriate step below:

  3. Matching on value:

    undefined
    null
    type Boolean
    type Number
    type String

    Return success with data value.

    Object that represents a web element

    Return the deserialized web element of value.

    Object that represents a shadow root

    Return the deserialized shadow root of value.

    instance of Array
    instance of Object

    Return the result of running the clone an object algorithm with arguments value and seen, and the JSON deserialize algorithm as the clone algorithm.

To perform a JSON clone return the result of calling the internal JSON clone algorithm with arguments value and an empty List.

When required to run the internal JSON clone algorithm with arguments value and seen, a remote end must return the value of the first matching statement, matching on value:

undefined
null

Return success with data null.

type Boolean
type Number
type String

Return success with data value.

instance of Element

If the element is stale, return error with error code stale element reference.

Otherwise:

  1. Let reference be the web element reference object for value.

  2. Return success with data reference.

instance of ShadowRoot

If the shadow root is detached, return error with error code detached shadow root.

Otherwise:

  1. Let reference be the shadow root reference object for value.

  2. Return success with data reference.

a WindowProxy object

If the associated browsing context of the WindowProxy object in value has been destroyed, return error with error code stale element reference.

Otherwise:

  1. Let reference be the WindowProxy reference object for value.

  2. Return success with data reference.

has an own property named "toJSON" that is a Function
Return success with the value returned by Function.[[Call]](toJSON) with value as the this value.
Otherwise
  1. Let result be the return value of running the clone an object algorithm with arguments value and seen, and the internal JSON clone algorithm as the clone algorithm.

  2. Return success with data result.

To clone an object, taking the arguments value, seen, and clone algorithm:

  1. If value is in seen, return error with error code javascript error.

  2. Append value to seen.

  3. Let result be the value of the first matching statement, matching on value:

    a collection

    A new Array which length property is equal to the result of getting the property length of value.

    Otherwise

    A new Object.

  4. For each enumerable property in value, run the following substeps:

    1. Let name be the name of the property.

    2. Let source property value be the result of getting a property named name from value. If doing so causes script to be run and that script throws an error, return error with error code javascript error.

    3. Let cloned property result be the result of calling the clone algorithm with arguments source property value and seen.

    4. If cloned property result is a success, set a property of result with name name and value equal to cloned property result’s data.

    5. Otherwise, return cloned property result.

  5. Remove the last element of seen.

  6. Return success with data result.

When required to extract the script arguments from a request with argument parameters the implementation must:

  1. Let script be the result of getting a property named script from the parameters.

  2. If script is not a String, return error with error code invalid argument.

  3. Let args be the result of getting a property named args from the parameters.

  4. If args is not an Array return error with error code invalid argument.

  5. Let arguments be the result of calling the JSON deserialize algorithm with arguments args.

  6. Return success with data script and arguments.

The rules to execute a function body are as follows. The algorithm returns an ECMAScript completion record.

If at any point during the algorithm a user prompt appears, immediately return Completion { [[Type]]: normal, [[Value]]: null, [[Target]]: empty }, but continue to run the other steps of this algorithm in parallel.

  1. Let window be the associated window of the current browsing context’s active document.

  2. Let environment settings be window’s relevant settings object.

  3. Let global scope be environment settings realm’s global environment.
  4. If body is not parsable as a FunctionBody or if parsing detects an early error, return Completion { [[Type]]: normal, [[Value]]: null, [[Target]]: empty }.

  5. If body begins with a directive prologue that contains a use strict directive then let strict be true, otherwise let strict be false.

  6. Prepare to run script with environment settings.

  7. Prepare to run a callback with environment settings.

  8. Let function be the result of calling FunctionCreate, with arguments:

    kind
    Normal.
    list
    An empty List.
    body
    The result of parsing body above.
    global scope
    The result of parsing global scope above.
    strict
    The result of parsing strict above.
  9. Let completion be Function.[[Call]](window, parameters) with function as the this value.

  10. Clean up after running a callback with environment settings.

  11. Clean up after running script with environment settings.

  12. Return completion.

Note

The above algorithm is not associated with any particular element, and is therefore not subject to the document CSP directives.

13.2.1 Execute Script

HTTP Method URI Template
POST /session/{session id}/execute/sync

The remote end steps are:

  1. Let body and arguments be the result of trying to extract the script arguments from a request with argument parameters.

  2. If the current browsing context is no longer open, return error with error code no such window.

  3. Handle any user prompts, and return its value if it is an error.

  4. Let promise be a new Promise.

  5. Run the following substeps in parallel:

    1. Let scriptPromise be the result of promise-calling execute a function body, with arguments body and arguments.

    2. Upon fulfillment of scriptPromise with value v, resolve promise with value v.

    3. Upon rejection of scriptPromise with value r, reject promise with value r.

  6. If promise is still pending and the session script timeout is reached, return error with error code script timeout.

  7. Upon fulfillment of promise with value v, let result be a JSON clone of v, and return success with data result.

  8. Upon rejection of promise with reason r, let result be a JSON clone of r, and return error with error code javascript error and data result.

13.2.2 Execute Async Script

HTTP Method URI Template
POST /session/{session id}/execute/async
Note

The Execute Async Script command causes JavaScript to execute as an anonymous function. An additional value is provided as the final argument to the function. This is a function that may be invoked to signal the completion of the asynchronous operation. The first argument provided to the function will be serialized to JSON and returned by Execute Async Script.

The remote end steps are:

  1. Let body and arguments by the result of trying to extract the script arguments from a request with argument parameters.

  2. If the current browsing context is no longer open, return error with error code no such window.

  3. Handle any user prompts, and return its value if it is an error.

  4. Let promise be a new Promise.

  5. Run the following substeps in parallel:

    1. Let resolvingFunctions be CreateResolvingFunctions(promise).

    2. Append resolvingFunctions.[[Resolve]] to arguments.

    3. Let result be the result of calling execute a function body, with arguments body and arguments.

    4. If scriptResult.[[Type]] is not normal, then reject promise with value scriptResult.[[Value]], and abort these steps.

      Note

      Prior revisions of this specification did not recognize the return value of the provided script. In order to preserve legacy behavior, the return value only influences the command if it is a "thenable" object or if determining this produces an exception.

    5. If Type(scriptResult.[[Value]]) is not Object, then abort these steps.

    6. Let then be Get(scriptResult.[[Value]], "then").

    7. If then.[[Type]] is not normal, then reject promise with value then.[[Value]], and abort these steps.

    8. If IsCallable(then.[[Type]]) is false, then abort these steps.

    9. Let scriptPromise be PromiseResolve(Promise, scriptResult.[[Value]]).

    10. Upon fulfillment of scriptPromise with value v, resolve promise with value v.

    11. Upon rejection of scriptPromise with value r, reject promise with value r.

  6. If promise is still pending and session script timeout milliseconds is reached, return error with error code script timeout.

  7. Upon fulfillment of promise with value v, let result be a JSON clone of v, and return success with data result.

  8. Upon rejection of promise with reason r, let result be a JSON clone of r, and return error with error code javascript error and data result.

14. Cookies

This section describes the interaction with cookies as described in [RFC6265].

A cookie is described in [RFC6265] by a name-value pair holding the cookie’s data, followed by zero or more attribute-value pairs describing its characteristics.

The following table for cookie conversion defines the cookie concepts relevant to WebDriver, how these are referred to in [RFC6265], what keys they map to in a serialized cookie, as well as the attribute-value keys needed when constructing a list of arguments for creating a cookie.

For informational purposes, the table includes a legend of whether the field is optional in the serialized cookie provided to Add Cookie, and a brief non-normative description of the field and the expected input type of its associated value.

Concept RFC 6265 Field JSON Key Attribute Key Optional Description
Cookie name name "name" The name of the cookie.
Cookie value value "value" The cookie value.
Cookie path path "path" "Path" The cookie path. Defaults to "/" if omitted when adding a cookie.
Cookie domain domain "domain" "Domain" The domain the cookie is visible to. Defaults to the current browsing context’s active document’s URL domain if omitted when adding a cookie.
Cookie secure only secure-only-flag "secure" "Secure" Whether the cookie is a secure cookie. Defaults to false if omitted when adding a cookie.
Cookie HTTP only http-only-flag "httpOnly" "HttpOnly" Whether the cookie is an HTTP only cookie. Defaults to false if omitted when adding a cookie.
Cookie expiry time expiry-time "expiry" "Max-Age" When the cookie expires, specified in seconds since Unix Epoch. Must not be set if omitted when adding a cookie.
Cookie same site samesite "sameSite" "SameSite" Whether the cookie applies to a SameSite policy. Defaults to None if omitted when adding a cookie. Can be set to either Lax or Strict.

A serialized cookie is a JSON Object where a cookie’s [RFC6265] fields listed in the table for cookie conversion are mapped using the JSON Key and the associated field’s value from the cookie store. The optional fields may be omitted.

To get all associated cookies to a document, the user agent must return the enumerated set of cookies that meet the requirements set out in the first step of the algorithm in [RFC6265] to compute cookie-string for an ‘HTTP API’, from the cookie store of the given document’s address. The returned cookies must include HttpOnly cookies.

When the remote end is instructed to create a cookie, this is synonymous to carrying out the steps described in [RFC6265] section 5.3, under receiving a cookie, except the user agent may not ignore the received cookie in its entirety (disregard step 1).

To delete cookies given an optional filter argument name that is a string:

  1. For each cookie among all associated cookies of the current browsing context’s active document, run the substeps of the first matching condition:

    name is undefined
    name is equal to cookie name

    Set the cookie expiry time to a Unix timestamp in the past.

    Otherwise
    Do nothing.

14.1 Get All Cookies

HTTP Method URI Template
GET /session/{session id}/cookie

The remote end steps are:

  1. If the current browsing context is no longer open, return error with error code no such window.

  2. Handle any user prompts, and return its value if it is an error.

  3. Let cookies be a new JSON List.

  4. For each cookie in all associated cookies of the current browsing context’s active document:

    1. Let serialized cookie be the result of serializing cookie.

    2. Append serialized cookie to cookies

  5. Return success with data cookies.

14.5 Delete All Cookies

HTTP Method URI Template
DELETE /session/{session id}/cookie

The remote end steps are:

  1. If the current browsing context is no longer open, return error with error code no such window.

  2. Handle any user prompts, and return its value if it is an error.

  3. Delete cookies, giving no filtering argument.

  4. Return success with data null.

15. Actions

The Actions API provides a low-level interface for providing virtualized device input to the web browser. Conceptually, the Actions commands divide time into a series of ticks. The local end sends a series of actions which correspond to the change in state, if any, of each input device during each tick. For example, pressing a key is represented by an action sequence consisting of a single key input device and two ticks, the first containing a keyDown action, and the second a keyUp action, whereas a pinch-zoom input is represented by an action sequence consisting of three ticks and two pointer input devices of type touch, each performing a sequence of actions pointerDown, followed by pointerMove, and then pointerUp.

15.1 Actions Options

Configuration of actions dispatch is controlled by a actions options object. This is a struct that has a fields named is element origin, which is a set of steps that validate if a protocol object represents an element origin, and get element origin, which is a set of steps used to deserialize an element.

To get a WebElement origin with origin and browsing context:,

  1. Assert: browsing context is the current browsing context.

  2. Let element be equal to the result of trying to get a known element with argument origin.

  3. Return success with data element.

15.2 Input sources

An input source is a virtual device providing input events. Each input source is represented by an struct specific to the type of the input source. Each input source has an input id which is stored as a key in the input state map.

To create an input source given input state, type and optional subtype:

  1. Run the substeps matching the first matching value of type:

    "none"
    Let source be the result of create a null input source.
    "key"
    Let source be the result of create a key input source.
    "pointer"
    Let source be the result of create a pointer input source with input state and subtype.
    "wheel"
    Let source be the result of create a wheel input source.
    Otherwise:
    Return error with error code invalid argument.
  2. Return success with data source.

15.2.1 Null input source

A null input source is an input source that is not associated with a specific physical device. a null input source has no type-specific items, and supports the following actions:

Action Non-normative Description
pause Used with an integer argument to specify the duration of a tick, or as a placeholder to indicate that an input source does nothing during a particular tick.

To create a null input source, return a new null input source.

15.2.2 Key input source

A key input source is an input source that is associated with a keyboard-type device.

A key input source has the following items:

Item Non-normative Description Default Value
pressed A set of strings representing currently pressed keys. Empty set
alt A boolean indicating whether the alt modifier is depressed. False
ctrl A boolean indicating whether the ctrl modifier is depressed. False
meta A boolean indicating whether the meta modifier is depressed. False
shift A boolean indicating whether the shift modifier is depressed. False

A key input source supports the same pause action as a null input source plus the following actions:

Action Non-normative Description
keyDown Used to indicate that a particular key should be held down.
keyUp Used to indicate that a depressed key should be released.

To create a key input source, return a new key input source with the items initalized to their default values.

15.2.3 Pointer input source

A pointer input source is an input source that is associated with a pointer-type input device.

A pointer input source has the following items:

Item Non-normative Description Default Value
subtype The type of pointing device. This can be "mouse", "pen", or "touch".
pointerId The numeric id of the pointing device. This is a positive integer, with the values 0 and 1 reserved for mouse-type pointers.
pressed A set of unsigned integers representing the pointer buttons that are currently depressed. Empty set
x An unsigned integer representing the pointer x location in viewport coordinates. 0
y An unsigned integer representing the pointer y location in viewport coordindates. 0

A pointer input source supports the same pause action as a null input source plus the following actions:

Action Non-normative Description
pointerDown Used to indicate that a pointer should be depressed in some way e.g. by holding a button down (for a mouse) or by coming into contact with the active surface (for a touch or pen device).
pointerUp Used to indicate that a pointer should be released in some way e.g. by releasing a mouse button or moving a pen or touch device away from the active surface.
pointerMove Used to indicate a location on the screen that a pointer should move to, either in its active (pressed) or inactive state.
pointerCancel Used to cancel a pointer action.

To create a pointer input source object given input state, and subtype, return a new pointer input source with subtype set to subtype, pointerId set to get a pointer id with input state and subtype, and the other items set to their default values.

15.2.4 Wheel input source

A wheel input source is an input source that is associated with a wheel-type input device. A wheel input source has no type specific items, and supports the same pause action as a null input source plus the following actions:

Action Non-normative Description
scroll Used to indicate that the scroll wheel is rolled down, up, right or left to scroll the page down, up, right or left.

To create a wheel input source return a new wheel input source.

15.3 Input state

An input state represents the overall state of a collection of input sources. An input state has the following items:

To get the input state given session and browsing context:

  1. Assert: browsing context is a top-level browsing context.

  2. Let input state map be session's browsing context input state map.

  3. If input state map does not contain browsing context, set input state map[browsing context] to create an input state.

  4. Return input state map[browsing context].

To reset the input state given session and browsing context:

  1. Assert: browsing context is a top-level browsing context.

  2. Let input state map be session's browsing context input state map.

  3. If input state map[browsing context] exists, then remove input state map[browsing context].

To create an input state:

  1. Let input state be an input state with the input state map set to an empty map, and the input cancel list set to an empty list.

  2. Return input state.

To add an input source given input state, input id, and source:

  1. Let input state map be input state's input state map.

  2. Set input state map[input id] to source.

To remove an input source given input state, and input id:

  1. Assert: None of the items in input state's input cancel list has id equal to input id.

  2. Let input state map be input state's input state map.

  3. Remove input state map[input id].

To get an input source given input state and input id:

  1. Let input state map be input state's input state map.

  2. If input state map[input id] exists, return input state map[input id].

  3. Return undefined.

To get or create an input source given input state, type, input id, and optional subtype:

  1. Let source be get an input source with input state and input id.

  2. If source is not undefined and source's type is not equal to type, or source is a pointer input sourcereturn error with error code invalid argument.

  3. If source is undefined, set source to the result of trying to create an input source with input state and type.

  4. Return success with data source.

A global key state is a struct with items pressed, altKey, ctrlKey, metaKey, and shiftKey.

To get the global key state given input state:

  1. Let input state map be input state's input state map.

  2. Let sources be the result of getting the values with input state map.

  3. Let key state be a new global key state with pressed set to an empty set, altKey, ctrlKey, metaKey, and shiftKey set to false.

  4. For each source in sources:

    1. If source is not a key input source, continue to the first step of this loop.

    2. Set key state's pressed item to the union of its current value and source's pressed item.

    3. If source's alt item is true, set key state's altKey item to true.

    4. If source's ctrl item is true, set key state's ctrlKey item to true.

    5. If source's meta item is true, set key state's metaKey item to true.

    6. If source's shift item is true, set key state's shiftKey item to true.

  5. Return key state.

To get a pointer id given input state and subtype:

  1. Let minimum id be 0 if subtype is "mouse', or 2 otherwise.
  2. Let pointer ids be an empty set.
  3. Let sources be the result of getting the values with input state's input state map.

  4. For each source in sources.:

    1. If source is a pointer input source, append source's pointerId to pointer ids.

  5. Return the smallest integer that is greater than or equal to minimum id and that is not contained in pointer ids.

15.4 Ticks

A tick is the basic unit of time over which actions can be performed. During a tick, each input source has an assigned action — possibly a noop pause action — which may result in changes to the user agent internal state and eventually cause DOM events to be fired at the page. The next tick begins after the user agent has had a chance to process all DOM events generated in the current tick.

Waiting asynchronously means waiting for something to occur whilst allowing the browser to continue processing the event loop.

At the lowest level, the behavior of actions is intended to mimic the remote end’s behavior with an actual input device as closely as possible, and the implementation strategy may involve e.g. injecting synthesized events into a browser event loop. Therefore the steps to dispatch an action will inevitably end up in implementation-specific territory. However there are certain content observable effects that must be consistent across implementations. To accommodate this, the specification requires that remote ends perform implementation-specific action dispatch steps on a browsing context context, and a list of events and their properties. These steps must be equivalent to performing the given input device manipulations on context, such that trusted events corresponding to the entries in list of eventsare dispatched.

Note
Note

15.5 Processing actions

The algorithm for extracting an action sequence from a request takes the JSON Object representing an action sequence, validates the input, and returns a data structure that is the transpose of the input JSON, such that the actions to be performed in a single tick are grouped together.

To get coordinates relative to an origin given source, x offset, y offset, origin, browsing context, and actions options:

  1. Run the substeps of the first matching value of origin

    "viewport"
    1. Let x equal x offset and y equal y offset.

    "pointer"
    Note

    This is only possible if source is a pointer input source

    1. Let start x be equal to the x property of source.

    2. Let start y be equal to the y property of source.

    3. Let x equal start x + x offset and y equal start y + y offset.

    Otherwise
    1. Let element be the result of trying to run actions options' get element origin steps with origin and browsing context.

    2. If element is null, return error with error code no such element.

    3. Let x element and y element be the result of calculating the in-view center point of element.

    4. Let x equal x element + x offset, and y equal y element + y offset.

  2. Return (x, y)

To extract an action sequence given input state, parameters, and actions options:

  1. Let actions be the result of getting a property from parameters named actions.

  2. If actions is undefined or is not an Array, return error with error code invalid argument.

  3. Let actions by tick be an empty List.

  4. For each value action sequence corresponding to an indexed property in actions:

    1. Let source actions be the result of trying to process an input source action sequence given input state, action sequence, and actions options.

    2. For each action in source actions:

      1. Let i be the zero-based index of action in source actions.

      2. If the length of actions by tick is less than i + 1, append a new List to actions by tick.

      3. Append action to the List at index i in actions by tick.

  5. Return success with data actions by tick.

When required to process an input source action sequence, given input state, action sequence, and actions options, a remote end must:

  1. Let type be the result of getting a property named "type" from action sequence.

  2. If type is not "key", "pointer", "wheel", or "none", return an error with error code invalid argument.

  3. Let id be the result of getting the property "id" from action sequence.

  4. If id is undefined or is not a String, return error with error code invalid argument.

  5. If type is equal to "pointer", let parameters data be the result of getting the property "parameters" from action sequence. Then let parameters be the result of trying to process pointer parameters with argument parameters data.

  6. Let source be the result of trying to get or create an input source given input state, type and id.

  7. If parameters is not undefined, then if its pointerType property is not equal to source’s subtype property, return an error with error code invalid argument.

  8. Let action items be the result of getting a property named actions from action sequence.

  9. If action items is not an Array, return error with error code invalid argument.

  10. Let actions be a new list.

  11. For each action item in action items:

    1. If action item is not an Object return error with error code invalid argument.

    2. If type is "none" let action be the result of trying to process a null action with parameters id, and action item.

    3. Otherwise, if type is "key" let action be the result of trying to process a key action with parameters id, and action item.

    4. Otherwise, if type is "pointer" let action be the result of trying to process a pointer action with parameters id, parameters, action item, and actions options.

    5. Otherwise, if type is "wheel" let action be the result of trying to process a wheel action with parameters id, and action item, and actions options.

    6. Append action to actions.

  12. Return success with data actions.

The default pointer parameters consist of an object with property pointerType set to mouse.

To process pointer parameters given parameters data:

  1. Let parameters be the default pointer parameters.

  2. If parameters data is undefined, return success with data parameters.

  3. If parameters data is not an Object, return error with error code invalid argument.

  4. Let pointer type be the result of getting a property named pointerType from parameters data.

  5. If pointer type is not undefined:

    1. If pointer type does not have one of the values "mouse", "pen", or "touch", return error with error code invalid argument.

    2. Set the pointerType property of parameters to pointer type.

  6. Return success with data parameters.

An action object constructed with arguments id, type, and subtype is an object with property id set to id, type set to type and subtype set to subtype. Specific action objects have further properties added by other algorithms in this specification.

To process a null action given id and action item:

  1. Let subtype be the result of getting a property named "type" from action item.

  2. If subtype is not "pause", return error with error code invalid argument.

  3. Let action be an action object constructed with arguments id, "none", and subtype.

  4. Let result be the result of trying to process a pause action with arguments action item and action.

  5. Return result.

To process a key action given id and action item:

  1. Let subtype be the result of getting a property named "type" from action item.

  2. If subtype is not one of the values "keyUp", "keyDown", or "pause", return an error with error code invalid argument.

  3. Let action be an action object constructed with arguments id, "key", and subtype.

  4. If subtype is "pause", let result be the result of trying to process a pause action with arguments action item and action, and return result.

  5. Let key be the result of getting a property named value from action item.

  6. If key is not a String containing a single unicode code point or grapheme cluster? return error with error code invalid argument.

  7. Set the value property on action to key.

  8. Return success with data action.

To process a pointer action given id, parameters, action item, and action options:

  1. Let subtype be the result of getting a property named "type" from action item.

  2. If subtype is not one of the values "pause", "pointerUp", "pointerDown", "pointerMove", or "pointerCancel", return an error with error code invalid argument.

  3. Let action be an action object constructed with arguments id, "pointer", and subtype.

  4. If subtype is "pause", let result be the result of trying to process a pause action with arguments action item, action, and actions options, and return result.

  5. Set the pointerType property of action equal to the pointerType property of parameters.

  6. If subtype is "pointerUp" or "pointerDown", process a pointer up or pointer down action with arguments action item and action. If doing so results in an error, return that error.

  7. If subtype is "pointerMove" process a pointer move action with arguments action item, action, and actions options. If doing so results in an error, return that error.

  8. If subtype is "pointerCancel" process a pointer cancel action. If doing so results in an error, return that error.

  9. Return success with data action.

To process a wheel action given id, action item, and actions options:

  1. Let subtype be the result of getting a property named "type" from action item.

  2. If subtype is not the value "pause", or "scroll", return an error with error code invalid argument.

  3. Let action be an action object constructed with arguments id, "wheel", and subtype.

  4. If subtype is "pause", let result be the result of trying to process a pause action with arguments action item and action, and return result.

  5. Let duration be the result of getting a property named duration from action item.

  6. If duration is not undefined and duration is not an Integer greater than or equal to 0, return error with error code invalid argument.

  7. Set the duration property of action to duration.

  8. Let origin be the result of getting the property origin from action item.

  9. If origin is undefined let origin equal "viewport".

  10. If origin is not equal to "viewport" or "pointer", or actions options' is element origin steps given origin return false, return error with error code invalid argument.

  11. Set the origin property of action to origin.

  12. Let x be the result of getting the property x from action item.

  13. If x is not an Integer, return error with error code invalid argument.

  14. Set the x property of action to x.

  15. Let y be the result of getting the property y from action item.

  16. If y is not an Integer, return error with error code invalid argument.

  17. Set the y property of action to y.

  18. Let deltaX be the result of getting the property deltaX from action item.

  19. If deltaX is not an Integer, return error with error code invalid argument.

  20. Set the deltaX property of action to deltaX.

  21. Let deltaY be the result of getting the property deltaY from action item.

  22. If deltaY is not an Integer, return error with error code invalid argument.

  23. Set the deltaY property of action to deltaY.

  24. Return success with data action.

To process a pause action given action item, and action:

  1. Let duration be the result of getting the property "duration" from action item.

  2. If duration is not undefined and duration is not an Integer greater than or equal to 0, return error with error code invalid argument.

  3. Set the duration property of action to duration.

  4. Return success with data action.

To process a pointer up or pointer down action given action item, and action:

  1. Let button be the result of getting the property button from action item.

  2. If button is not an Integer greater than or equal to 0 return error with error code invalid argument.

  3. Set the button property of action to button.

  4. Let width be the result of getting the property width from action item.

  5. If width is not undefined and width is not a Number greater than or equal to 0 return error with error code invalid argument.

  6. Set the width property of action to width.

  7. Let height be the result of getting the property height from action item.

  8. If height is not undefined and height is not a Number greater than or equal to 0 return error with error code invalid argument.

  9. Set the height property of action to height.

  10. Let pressure be the result of getting the property pressure from action item.

  11. If pressure is not undefined and pressure is not a Number greater than or equal to 0 and less than or equal to 1 return error with error code invalid argument.

  12. Set the pressure property of action to pressure.

  13. Let tangentialPressure be the result of getting the property tangentialPressure from action item.

  14. If tangentialPressure is not undefined and tangentialPressure is not a Number greater than or equal to -1 and less than or equal to 1 return error with error code invalid argument.

  15. Set the tangentialPressure property of action to tangentialPressure.

  16. Let tiltX be the result of getting the property tiltX from action item.

  17. If tiltX is not undefined and tiltX is not an Integer greater than or equal to -90 and less than or equal to 90 return error with error code invalid argument.

  18. Set the tiltX property of action to tiltX.

  19. Let tiltY be the result of getting the property tiltY from action item.

  20. If tiltY is not undefined and tiltY is not an Integer greater than or equal to -90 and less than or equal to 90 return error with error code invalid argument.

  21. Set the tiltY property of action to tiltY.

  22. Let twist be the result of getting the property twist from action item.

  23. If twist is not undefined and twist is not an Integer greater than or equal to 0 and less than or equal to 359 return error with error code invalid argument.

  24. Set the twist property of action to twist.

  25. Let altitudeAngle be the result of getting the property altitudeAngle from action item.

  26. If altitudeAngle is not undefined and altitudeAngle is not a Number greater than or equal to 0 and less than or equal to π/2 return error with error code invalid argument.

  27. Set the altitudeAngle property of action to altitudeAngle.

  28. Let azimuthAngle be the result of getting the property azimuthAngle from action item.

  29. If azimuthAngle is not undefined and azimuthAngle is not a Number greater than or equal to 0 and less than or equal to 2π return error with error code invalid argument.

  30. Set the azimuthAngle property of action to azimuthAngle.

  31. Return success with data null.

To process a pointer move action given action item, action, and actions options:

  1. Let duration be the result of getting the property duration from action item.

  2. If duration is not undefined and duration is not an Integer greater than or equal to 0, return error with error code invalid argument.

  3. Set the duration property of action to duration.

  4. Let origin be the result of getting the property origin from action item.

  5. If origin is undefined let origin equal "viewport".

  6. If origin is not equal to "viewport" or "pointer", and actions options is element origin steps given origin return false, return error with error code invalid argument.

  7. Set the origin property of action to origin.

  8. Let x be the result of getting the property x from action item.

  9. If x is not an Integer, return error with error code invalid argument.

  10. Set the x property of action to x.

  11. Let y be the result of getting the property y from action item.

  12. If y is not an Integer, return error with error code invalid argument.

  13. Set the y property of action to y.

  14. Let width be the result of getting the property width from action item.

  15. If width is not undefined and width is not a Number greater than or equal to 0 return error with error code invalid argument.

  16. Set the width property of action to width.

  17. Let height be the result of getting the property height from action item.

  18. If height is not undefined and height is not a Number greater than or equal to 0 return error with error code invalid argument.

  19. Set the height property of action to height.

  20. Let pressure be the result of getting the property pressure from action item.

  21. If pressure is not undefined and pressure is not a Number greater than or equal to 0 and less than or equal to 1 return error with error code invalid argument.

  22. Set the pressure property of action to pressure.

  23. Let tangentialPressure be the result of getting the property tangentialPressure from action item.

  24. If tangentialPressure is not undefined and tangentialPressure is not a Number greater than or equal to -1 and less than or equal to 1 return error with error code invalid argument.

  25. Set the tangentialPressure property of action to tangentialPressure.

  26. Let tiltX be the result of getting the property tiltX from action item.

  27. If tiltX is not undefined and tiltX is not an Integer greater than or equal to -90 and less than or equal to 90 return error with error code invalid argument.

  28. Set the tiltX property of action to tiltX.

  29. Let tiltY be the result of getting the property tiltY from action item.

  30. If tiltY is not undefined and tiltY is not an Integer greater than or equal to -90 and less than or equal to 90 return error with error code invalid argument.

  31. Set the tiltY property of action to tiltY.

  32. Let twist be the result of getting the property twist from action item.

  33. If twist is not undefined and twist is not an Integer greater than or equal to 0 and less than or equal to 359 return error with error code invalid argument.

  34. Set the twist property of action to twist.

  35. Let altitudeAngle be the result of getting the property altitudeAngle from action item.

  36. If altitudeAngle is not undefined and altitudeAngle is not a Number greater than or equal to 0 and less than or equal to π/2 return error with error code invalid argument.

  37. Set the altitudeAngle property of action to altitudeAngle.

  38. Let azimuthAngle be the result of getting the property azimuthAngle from action item.

  39. If azimuthAngle is not undefined and azimuthAngle is not a Number greater than or equal to 0 and less than or equal to 2π return error with error code invalid argument.

  40. Set the azimuthAngle property of action to azimuthAngle.

  41. Return success with data null.

15.6 Dispatching actions

The algorithm to dispatch actions takes a list of actions grouped by tick, and then causes each action to be run at the appropriate point in the sequence.

To dispatch actions given input state, actions by tick, browsing context, and actions options:

  1. Let token be a new unique identifier.

  2. Enqueue token in session's actions queue.

  3. Wait for token to be the first item in input state's actions queue.

    Note
  4. Let actions result be the result of dispatch actions inner with input state, actions by tick, browsing context, and actions options.

  5. Dequeue input state's actions queue.

    Assert: this returns token

  6. Return actions result.

To dispatch actions inner given input state, actions by tick, browsing context, and actions options:

  1. For each item tick actions in actions by tick:

    1. Let tick duration be the result of computing the tick duration with argument tick actions.

    2. Try to dispatch tick actions with tick actions, tick duration, browsing context, and actions options.

    3. Wait until the following conditions are all met:

      • There are no pending asynchronous waits arising from the last invocation of the dispatch tick actions steps.

      • The user agent event loop has spun enough times to process the DOM events generated by the last invocation of the dispatch tick actions steps.

      • At least tick duration milliseconds have passed.

  2. Return success with data null.

To compute the tick duration given tick actions:

  1. Let max duration be 0.

  2. For each action object in tick actions:

    1. let duration be undefined.

    2. If action object has subtype property set to "pause" or action object has type property set to "pointer" and subtype property set to "pointerMove", or action object has type property set to "wheel" and subtype property set to "scroll", let duration be equal to the duration property of action object.

    3. If duration is not undefined, and duration is greater than max duration, let max duration be equal to duration.

  3. Return max duration.

To dispatch tick actions given input state, tick actions, tick duration, browsing context, and actions options:

  1. For each action object in tick actions:

    1. Let input id be equal to the value of action object’s id property.

    2. Let source type be equal to the value of action object’s type property.

    3. Let source be the result of get an input source given input state and input id.

    4. Assert: source is not undefined.

    5. Let global key state be the result of get the global key state with input state.

    6. Let subtype be action object’s subtype.

    7. Let algorithm be the value of the column dispatch action algorithm from the following table where the source type column is source type and the subtype column is equal to subtype.

      source type subtype Dispatch action algorithm
      "none" "pause" Dispatch a pause action
      "key" "pause" Dispatch a pause action
      "key" "keyDown" Dispatch a keyDown action
      "key" "keyUp" Dispatch a keyUp action
      "pointer" "pause" Dispatch a pause action
      "pointer" "pointerDown" Dispatch a pointerDown action
      "pointer" "pointerUp" Dispatch a pointerUp action
      "pointer" "pointerMove" Dispatch a pointerMove action
      "pointer" "pointerCancel" Dispatch a pointerCancel action
      "wheel" "pause" Dispatch a pause action
      "wheel" "scroll" Dispatch a scroll action
    8. Try to run algorithm with arguments action object, source, global key state, tick duration, browsing context, and actions options.
    9. If subtype is "keyDown", append a copy of action object with the subtype property changed to "keyUp" to input state’s input cancel list.

    10. If subtype is "pointerDown", append a copy of action object with the subtype property changed to "pointerUp" to input state’s input cancel list.

  2. Return success with data null.

To dispatch a list of actions given input state, actions, browsing context, and actions options:

Note
  1. Let tick actions be the list «actions»

  2. Let actions by tick be the list «tick actions».

  3. Return the result of dispatch actions with input state, actions by tick, current browsing context, and actions options.

15.6.1 General actions

To dispatch a pause action given action object, source, global key state, tick duration, browsing context, and actions options:

  1. Return success with data null.

15.6.2 Keyboard actions

The normalized key value for a raw key key is, if key appears in the table below, the string value in the second column on the row containing key’s unicode code point in the first column, otherwise it is key.

key’s codepoint Normalized key value
\uE000"Unidentified"
\uE001"Cancel"
\uE002"Help"
\uE003"Backspace"
\uE004"Tab"
\uE005"Clear"
\uE006"Return"
\uE007"Enter"
\uE008"Shift"
\uE009"Control"
\uE00A"Alt"
\uE00B"Pause"
\uE00C"Escape"
\uE00D" "
\uE00E"PageUp"
\uE00F"PageDown"
\uE010"End"
\uE011"Home"
\uE012"ArrowLeft"
\uE013"ArrowUp"
\uE014"ArrowRight"
\uE015"ArrowDown"
\uE016"Insert"
\uE017"Delete"
\uE018";"
\uE019"="
\uE01A"0"
\uE01B"1"
\uE01C"2"
\uE01D"3"
\uE01E"4"
\uE01F"5"
\uE020"6"
\uE021"7"
\uE022"8"
\uE023"9"
\uE024"*"
\uE025"+"
\uE026","
\uE027"-"
\uE028"."
\uE029"/"
\uE031"F1"
\uE032"F2"
\uE033"F3"
\uE034"F4"
\uE035"F5"
\uE036"F6"
\uE037"F7"
\uE038"F8"
\uE039"F9"
\uE03A"F10"
\uE03B"F11"
\uE03C"F12"
\uE03D"Meta"
\uE040"ZenkakuHankaku"
\uE050"Shift"
\uE051"Control"
\uE052"Alt"
\uE053"Meta"
\uE054"PageUp"
\uE055"PageDown"
\uE056"End"
\uE057"Home"
\uE058"ArrowLeft"
\uE059"ArrowUp"
\uE05A"ArrowRight"
\uE05B"ArrowDown"
\uE05C"Insert"
\uE05D"Delete"

The code for key is the value in the last column of the following table on the row with key in either the first or second column, if any such row exists, otherwise it is undefined.

A shifted character is one that appears in the second column of the following table.

Key Alternate Key code
"`""~""Backquote"
"\""|""Backslash"
"\uE003""Backspace"
"[""{""BracketLeft"
"]""}""BracketRight"
",""<""Comma"
"0"")""Digit0"
"1""!""Digit1"
"2""@""Digit2"
"3""#""Digit3"
"4""$""Digit4"
"5""%""Digit5"
"6""^""Digit6"
"7""&""Digit7"
"8""*""Digit8"
"9""(""Digit9"
"=""+""Equal"
"<"">""IntlBackslash"
"a""A""KeyA"
"b""B""KeyB"
"c""C""KeyC"
"d""D""KeyD"
"e""E""KeyE"
"f""F""KeyF"
"g""G""KeyG"
"h""H""KeyH"
"i""I""KeyI"
"j""J""KeyJ"
"k""K""KeyK"
"l""L""KeyL"
"m""M""KeyM"
"n""N""KeyN"
"o""O""KeyO"
"p""P""KeyP"
"q""Q""KeyQ"
"r""R""KeyR"
"s""S""KeyS"
"t""T""KeyT"
"u""U""KeyU"
"v""V""KeyV"
"w""W""KeyW"
"x""X""KeyX"
"y""Y""KeyY"
"z""Z""KeyZ"
"-""_""Minus"
"."".""Period"
"'"""""Quote"
";"":""Semicolon"
"/""?""Slash"
"\uE00A""AltLeft"
"\uE052""AltRight"
"\uE009""ControlLeft"
"\uE051""ControlRight"
"\uE006""Enter"
"\uE03D""OSLeft"
"\uE053""OSRight"
"\uE008""ShiftLeft"
"\uE050""ShiftRight"
" ""\uE00D""Space"
"\uE004""Tab"
"\uE017""Delete"
"\uE010""End"
"\uE002""Help"
"\uE011""Home"
"\uE016""Insert"
"\uE00F""PageDown"
"\uE00E""PageUp"
"\uE015""ArrowDown"
"\uE012""ArrowLeft"
"\uE014""ArrowRight"
"\uE013""ArrowUp"
"\uE00C""Escape"
"\uE031""F1"
"\uE032""F2"
"\uE033""F3"
"\uE034""F4"
"\uE035""F5"
"\uE036""F6"
"\uE037""F7"
"\uE038""F8"
"\uE039""F9"
"\uE03A""F10"
"\uE03B""F11"
"\uE03C""F12"
"\uE01A""\uE05C""Numpad0"
"\uE01B""\uE056""Numpad1"
"\uE01C""\uE05B""Numpad2"
"\uE01D""\uE055""Numpad3"
"\uE01E""\uE058""Numpad4"
"\uE01F""Numpad5"
"\uE020""\uE05A""Numpad6"
"\uE021""\uE057""Numpad7"
"\uE022""\uE059""Numpad8"
"\uE023""\uE054""Numpad9"
"\uE025""NumpadAdd"
"\uE026""NumpadComma"
"\uE028""\uE05D""NumpadDecimal"
"\uE029""NumpadDivide"
"\uE007""NumpadEnter"
"\uE024""NumpadMultiply"
"\uE027""NumpadSubtract"

The key location for key is the value in the last column in the table below on the row with key appears in the first column, if such a row exists, otherwise it is 0.

key’s codepoint Description Location
\uE007Enter1
\uE008Left Shift1
\uE009Left Control1
\uE00ALeft Alt1
\uE01ANumpad 03
\uE01BNumpad 13
\uE01CNumpad 23
\uE01DNumpad 33
\uE01ENumpad 43
\uE01FNumpad 53
\uE020Numpad 63
\uE021Numpad 73
\uE022Numpad 83
\uE023Numpad 93
\uE024Numpad *3
\uE025Numpad +3
\uE026Numpad ,3
\uE027Numpad -3
\uE028Numpad .3
\uE029Numpad /3
\uE03DLeft Meta1
\uE050Right Shift2
\uE051Right Control2
\uE052Right Alt2
\uE053Right Meta2
\uE054Numpad PageUp3
\uE055Numpad PageDown3
\uE056Numpad End3
\uE057Numpad Home3
\uE058Numpad ArrowLeft3
\uE059Numpad ArrowUp3
\uE05ANumpad ArrowRight3
\uE05BNumpad ArrowDown3
\uE05CNumpad Insert3
\uE05DNumpad Delete3

To dispatch a keyDown action given action object, source, global key state, tick duration, browsing context, and actions options:

  1. Let raw key be equal to the action object’s value property.

  2. Let key be equal to the normalized key value for raw key.

  3. If the source’s pressed property contains key, let repeat be true, otherwise let repeat be false.

  4. Let code be the code for raw key.

  5. Let location be the key location for raw key.

  6. Let charCode, keyCode and which be the implementation-specific values of the charCode, keyCode and which properties appropriate for a key with key key and location location on a 102 key US keyboard, following the guidelines in [UI-EVENTS].

  7. If key is "Alt", let source's alt property be true.

  8. If key is "Shift", let source's shift property be true.

  9. If key is "Control", let source's ctrl property be true.

  10. If key is "Meta", let source's meta property be true.

  11. Add key to source’s pressed property.

  12. Perform implementation-specific action dispatch steps on browsing context equivalent to pressing a key on the keyboard in accordance with the requirements of [UI-EVENTS], and producing the following events, as appropriate, with the specified properties. This will always produce events including at least a keyDown event.

    • keyDown with properties:
      Attribute Value
      keykey
      codecode
      locationlocation
      altKeysource’s alt property
      shiftKeysource’s shift property
      ctrlKeysource’s ctrl property
      metaKeysource’s meta property
      repeatrepeat
      isComposingfalse
      charCodecharCode
      keyCodekeyCode
      whichwhich
    • keyPress with properties:
      Attribute Value
      keykey
      codecode
      locationlocation
      altKeysource’s alt property
      shiftKeysource’s shift property
      ctrlKeysource’s ctrl property
      metaKeysource’s meta property
      repeatrepeat
      isComposingfalse
      charCodecharCode
      keyCodekeyCode
      whichwhich
  13. Return success with data null.

Note

To dispatch a keyUp action given,action object, source, global key state, tick duration, browsing context, and actions options:

  1. Let raw key be equal to action object’s value property.

  2. Let key be equal to the normalized key value for raw key.

  3. If the source’s pressed item does not contain key, return.

  4. Let code be the code for raw key.

  5. Let location be the key location for raw key.

  6. Let charCode, keyCode and which be the implementation-specific values of the charCode, keyCode and which properties appropriate for a key with key key and location location on a 102 key US keyboard, following the guidelines in [UI-EVENTS].

  7. If key is "Alt", let source's alt property be false.

  8. If key is "Shift", let source's shift property be false.

  9. If key is "Control", let source's ctrl property be false.

  10. If key is "Meta", let source's meta property be false.

  11. Remove key from sources’s pressed property.

  12. Perform implementation-specific action dispatch steps on browsing context equivalent to releasing a key on the keyboard in accordance with the requirements of [UI-EVENTS], and producing at least the following events with the specified properties:

    • keyup, with properties:
      Attribute Value
      keykey
      codecode
      locationlocation
      altKeysource’s altKey property
      shiftKeysource’s shift property
      ctrlKeysource’s ctrl property
      metaKeysource’s meta property
      repeatfalse
      isComposingfalse
      charCodecharCode
      keyCodekeyCode
      whichwhich
  13. Return success with data null.

15.6.3 Pointer actions

To dispatch a pointerDown action given action object, input state, global key state, tick duration, browsing context, and actions options:

  1. Let pointerType be equal to action object’s pointerType property.

  2. Let button be equal to action object’s button property.

  3. If the input state’s pressed property contains button return success with data null.

  4. Let x be equal to input state’s x property.

  5. Let y be equal to input state’s y property.

  6. Add button to the set corresponding to input state’s pressed property, and let buttons be the resulting value of that property.

  7. Let width be equal to action object’s width property.

  8. Let height be equal to action object’s height property.

  9. Let pressure be equal to action object’s pressure property.

  10. Let tangentialPressure be equal to action object’s tangentialPressure property.

  11. Let tiltX be equal to action object’s tiltX property.

  12. Let tiltY be equal to action object’s tiltY property.

  13. Let twist be equal to action object’s twist property.

  14. Let altitudeAngle be equal to action object’s altitudeAngle property.

  15. Let azimuthAngle be equal to action object’s azimuthAngle property.

  16. Perform implementation-specific action dispatch steps on browsing context equivalent to pressing the button numbered button on the pointer with pointerId equal to input source's pointerId, having type pointerType at viewport x coordinate x, viewport y coordinate y, width, height, pressure, tangentialPressure, tiltX, tiltY, twist, altitudeAngle, azimuthAngle, with buttons buttons depressed in accordance with the requirements of [UI-EVENTS] and [POINTER-EVENTS]. set ctrlKey, shiftKey, altKey, and metaKey equal to the corresponding items in global key state. Type specific properties for the pointer that are not exposed through the webdriver API must be set to the default value specified for hardware that doesn’t support that property.

  17. Return success with data null.

To dispatch a pointerUp action given, action object, source, global key state, tick duration, browsing context, and actions options:

  1. Let pointerType be equal to action object’s pointerType property.

  2. Let button be equal to action object’s button property.

  3. If the source’s pressed property does not contain button, return success with data null.

  4. Let x be equal to source’s x property.

  5. Let y be equal to source’s y property.

  6. Remove button from the set corresponding to source’s pressed property, and let buttons be the resulting value of that property.

  7. Perform implementation-specific action dispatch steps on browsing context equivalent to releasing the button numbered button on the pointer with pointerId equal to input source's pointerId, having type pointerType at viewport x coordinate x, viewport y coordinate y, with buttons buttons depressed, in accordance with the requirements of [UI-EVENTS] and [POINTER-EVENTS]. The generated events must set ctrlKey, shiftKey, altKey, and metaKey equal to the corresponding items in global key state. Type specific properties for the pointer that are not exposed through the webdriver API must be set to the default value specified for hardware that doesn’t support that property.

  8. Return success with data null.

To dispatch a pointerMove action given action object, source, global key state, tick duration, browsing context, and actions options:

  1. Let x offset be equal to the x property of action object.

  2. Let y offset be equal to the y property of action object.

  3. Let origin be equal to the origin property of action object.

  4. Let (x, y) be the result of trying to get coordinates relative to an origin with source, x offset, y offset, origin, browsing context, and actions options.

  5. If x is less than 0 or greater than the width of the viewport in CSS pixels, then return error with error code move target out of bounds.

  6. If y is less than 0 or greater than the height of the viewport in CSS pixels, then return error with error code move target out of bounds.

  7. Let duration be equal to action object’s duration property if it is not undefined, or tick duration otherwise.

  8. If duration is greater than 0 and inside any implementation-defined bounds, asynchronously wait for an implementation defined amount of time to pass.

  9. Let width be equal to action object’s width property.

  10. Let height be equal to action object’s height property.

  11. Let pressure be equal to action object’s pressure property.

  12. Let tangentialPressure be equal to action object’s tangentialPressure property.

  13. Let tiltX be equal to action object’s tiltX property.

  14. Let tiltY be equal to action object’s tiltY property.

  15. Let twist be equal to action object’s twist property.

  16. Let altitudeAngle be equal to action object’s altitudeAngle property.

  17. Let azimuthAngle be equal to action object’s azimuthAngle property.

  18. Perform a pointer move with arguments source, global key state, duration, start x, start y, x, y, width, height, pressure, tangentialPressure, tiltX, tiltY, twist, altitudeAngle, azimuthAngle.

  19. Return success with data null.

To perform a pointer move given source, global key state, duration, start x, start y, target x, target y, width, height, pressure, tangentialPressure, tiltX, tiltY, twist, altitudeAngle, and azimuthAngle:

  1. Let time delta be the time since the beginning of the current tick, measured in milliseconds on a monotonic clock.

  2. Let duration ratio be the ratio of time delta and duration, if duration is greater than 0, or 1 otherwise.

  3. If duration ratio is 1, or close enough to 1 that the implementation will not further subdivide the move action, let last be true. Otherwise let last be false.

  4. If last is true, let x equal target x and y equal target y.

    Otherwise let x equal an approximation to duration ratio × (target x - start x) + start x, and y equal an approximation to duration ratio × (target y - start y) + start y.

  5. Let current x equal the x property of input state.

  6. Let current y equal the y property of input state.

  7. If x is not equal to current x or y is not equal to current y, run the following steps:

    1. Let buttons be equal to input state’s buttons property.

    2. Perform implementation-specific action dispatch steps on browsing context equivalent to moving the pointer with pointerId equal to input source's pointerId, having type pointerType from viewport x coordinate current x, viewport y coordinate current y to viewport x coordinate x and viewport y coordinate y, width, height, pressure, tangentialPressure, tiltX, tiltY, twist, altitudeAngle, azimuthAngle, with buttons buttons depressed, in accordance with the requirements of [UI-EVENTS] and [POINTER-EVENTS]. The generated events must set ctrlKey, shiftKey, altKey, and metaKey equal to the corresponding items in global key state. Type specific properties for the pointer that are not exposed through the WebDriver API must be set to the default value specified for hardware that doesn’t support that property. In the case where the pointerType is "pen" or "touch", and buttons is empty, this may be a no-op. For a pointer of type "mouse" this will always produce events including at least a pointerMove event.

    3. Let input state’s x property equal x and y property equal y.

  8. If last is true, return.

  9. Run the following substeps in parallel:

    Note
    1. Asynchronously wait for an implementation defined amount of time to pass.

    2. Perform a pointer move with arguments input state, duration, start x, start y, target x, target y.

To dispatch a pointerCancel action given action object, source, global key state, tick duration, browsing context, and actions options:

  1. Perform implementation-specific action dispatch steps on browsing context equivalent to cancelling the any action of the pointer with pointerId equal to source's pointerId item. having type pointerType, in accordance with the requirements of [UI-EVENTS] and [POINTER-EVENTS].

  2. Return success with data null.

15.6.4 Wheel actions

To dispatch a scroll action given action object, source, global key state, tick duration, browsing context, and actions options:

  1. Let x offset be equal to the x property of action object.

  2. Let y offset be equal to the y property of action object.

  3. Let origin be equal to the origin property of action object.

  4. Let (x, y) be the result of trying to get coordinates relative to an origin with source, x offset, y offset, origin, browsing context, and actions options.

  5. If x is less than 0 or greater than the width of the viewport in CSS pixels, then return error with error code move target out of bounds.

  6. If y is less than 0 or greater than the height of the viewport in CSS pixels, then return error with error code move target out of bounds.

  7. Let delta x be equal to the deltaX property of action object.

  8. Let delta y be equal to the deltaY property of action object.

  9. Let duration be equal to action object’s duration property if it is not undefined, or tick duration otherwise.

  10. If duration is greater than 0 and inside any implementation-defined bounds, asynchronously wait for an implementation defined amount of time to pass.

  11. Perform a scroll with arguments global key state, duration, x, y, delta x, delta y, 0, 0.

  12. Return success with data null.

To perform a scroll given duration, x, y, target delta x, target delta y, current delta x and current delta y:

  1. Let time delta be the time since the beginning of the current tick, measured in milliseconds on a monotonic clock.

  2. Let duration ratio be the ratio of time delta and duration, if duration is greater than 0, or 1 otherwise.

  3. If duration ratio is 1, or close enough to 1 that the implementation will not further subdivide the move action, let last be true. Otherwise let last be false.

  4. If last is true, let delta x equal target delta x - current delta x and delta y equal target delta y - current delta y.

    Otherwise let delta x equal an approximation to duration ratio × target delta x - current delta x, and delta y equal an approximation to duration ratio × target delta y - current delta y.

  5. If delta x is not equal to 0 or delta y is not equal to 0, run the following steps:

    1. Perform implementation-specific action dispatch steps on browsing context equivalent to wheel scroll at viewport x coordinate x, viewport y coordinate y, deltaX value delta x, deltaY value delta y, in accordance with the requirements of [UI-EVENTS]. The generated events must set ctrlKey, shiftKey, altKey, and metaKey equal to the corresponding items in global key state.

    2. Let current delta x property equal delta x + current delta x and current delta y property equal delta y + current delta y.

  6. If last is true, return.

  7. Run the following substeps in parallel:

    Note
    1. Asynchronously wait for an implementation defined amount of time to pass.

    2. Perform a scroll with arguments duration, x, y, target delta x, target delta y, current delta x, current delta y.

15.7 Perform Actions

HTTP Method URI Template
POST /session/{session id}/actions

The remote end steps are:

  1. Let input state be the result of get the input state with current session and current top-level browsing context.

  2. Let actions options be a new actions options with the is element origin steps set to represents a web element, and the get element origin steps set to get a WebElement origin.

  3. Let actions by tick be the result of trying to extract an action sequence given input state, parameters, and actions options.

  4. If the current browsing context is no longer open, return error with error code no such window.

  5. Handle any user prompts. If this results in an error, return that error.

  6. Dispatch actions given input state, actions by tick, current browsing context, and actions options. If this results in an error return that error.

  7. Return success with data null.

15.8 Release Actions

HTTP Method URI Template
DELETE /session/{session id}/actions
Note

The Release Actions command is used to release all the keys and pointer buttons that are currently depressed. This causes events to be fired as if the state was released by an explicit series of actions. It also clears all the internal state of the virtual devices.

The remote end steps are:

  1. If the current browsing context is no longer open, return error with error code no such window.

  2. Let input state be the result of get the input state with current session and current top-level browsing context.

  3. Let actions options be a new actions options with the is element origin steps set to represents a web element, and the get element origin steps set to get a WebElement origin.

  4. Let undo actions be input state’s input cancel list in reverse order.

  5. Try to dispatch tick actions with arguments undo actions, 0, current browsing context, and actions options.

  6. Reset the input state with current session and current top-level browsing context.

  7. Return success with data null.

16. User prompts

This chapter describes interaction with various types of user prompts. The common denominator for user prompts is that they are modal windows requiring users to interact with them before the event loop is unpaused and control is returned to the current top-level browsing context.

By default user prompts are not handled automatically unless a user prompt handler has been defined. When a user prompt appears, it is the task of the subsequent command to handle it. If the subsequent requested command is not one listed in this chapter, an unexpected alert open error will be returned.

User prompts that are spawned from beforeunload event handlers, are dismissed implicitly upon navigation or close window, regardless of the defined user prompt handler.

A user prompt has an associated user prompt message that is the string message shown to the user, or null if the message length is 0.

The following table of simple dialogs enumerates all supported simple dialogs, along with the commands that are allowed to interact with it as a non-normative reference:

Definition Dialog Interactions
Alert window.alert Accept Alert
Dismiss Alert
Get Alert Text
Confirm window.confirm Dismiss Alert
Accept Alert
Get Alert Text
Prompt window.prompt Dismiss Alert
Accept Alert
Get Alert Text
Send Alert Text

The current user prompt is said to be the active user prompt, which can be one of the entries on the table of simple dialogs.

To dismiss the current user prompt, do so as if the user would click the Cancel or OK button, whichever is present, in that order.

To accept the current user prompt, do so as if the user would click the OK button.

The user prompt handler defines what action the remote end must take when a user prompt is encountered. This is defined by the unhandled prompt behavior capability. The following known prompt handling approaches table lists the keywords and states for the attribute:

Keyword State Description
"dismiss" Dismiss state All simple dialogs encountered should be dismissed.
"accept" Accept state All simple dialogs encountered should be accepted.
"dismiss and notify" Dismiss and notify state All simple dialogs encountered should be dismissed, and an error returned that the dialog was handled.
"accept and notify" Accept and notify state All simple dialogs encountered should be accepted, and an error returned that the dialog was handled.
"ignore" Ignore state All simple dialogs encountered should be left to the user to handle.

When required to deserialize as an unhandled prompt behavior an argument value:

  1. If value is not a string return an error with error code invalid argument.

  2. If value is not present as a keyword in the known prompt handling approaches table return an error with error code invalid argument.

  3. Return success with data value.

An annotated unexpected alert open error is an error with error code unexpected alert open and an optional error data dictionary with the following entries:

"text"
The current user prompt’s message.

In order to handle any user prompts a remote end must take the following steps:

  1. If there is no current user prompt, abort these steps and return success.

  2. Perform the following substeps based on the current session’s user prompt handler:

    dismiss state

    Dismiss the current user prompt.

    accept state

    Accept the current user prompt.

    dismiss and notify state
    1. Dismiss the current user prompt.

    2. Return an annotated unexpected alert open error.

    accept and notify state
    1. Accept the current user prompt.

    2. Return an annotated unexpected alert open error.

    ignore state

    Return an annotated unexpected alert open error.

  3. Return success.

16.1 Dismiss Alert

HTTP Method URI Template
POST /session/{session id}/alert/dismiss
Note

The Dismiss Alert command dismisses a simple dialog if present. A request to dismiss an alert user prompt, which may not necessarily have a dismiss button, has the same effect as accepting it.

The remote end steps are:

  1. If the current top-level browsing context is no longer open, return error with error code no such window.

  2. If there is no current user prompt, return error with error code no such alert.

  3. Dismiss the current user prompt.

  4. Return success with data null.

16.2 Accept Alert

HTTP Method URI Template
POST /session/{session id}/alert/accept

The remote end steps are:

  1. If the current top-level browsing context is no longer open, return error with error code no such window.

  2. If there is no current user prompt, return error with error code no such alert.

  3. Accept the current user prompt.

  4. Return success with data null.

16.3 Get Alert Text

HTTP Method URI Template
GET /session/{session id}/alert/text

The remote end steps are:

  1. If the current top-level browsing context is no longer open, return error with error code no such window.

  2. If there is no current user prompt, return error with error code no such alert.

  3. Let message be the text message associated with the current user prompt, or otherwise be null.

  4. Return success with data message.

16.4 Send Alert Text

HTTP Method URI Template
POST /session/{session id}/alert/text
Note

The Send Alert Text command sets the text field of a window.prompt user prompt to the given value.

The remote end steps are:

  1. Let text be the result of getting the property "text" from parameters.

  2. If text is not a String, return error with error code invalid argument.

  3. If the current top-level browsing context is no longer open, return error with error code no such window.

  4. If there is no current user prompt, return error with error code no such alert.

  5. Run the substeps of the first matching current user prompt:

    alert
    confirm

    Return error with error code element not interactable.

    prompt

    Do nothing.

    Otherwise

    Return error with error code unsupported operation.

  6. Perform user agent dependent steps to set the value of current user prompt’s text field to text.

  7. Return success with data null.

17. Screen capture

Screenshots are a mechanism for providing additional visual diagnostic information. They work by dumping a snapshot of the initial viewport’s framebuffer as a lossless PNG image. It is returned to the local end as a Base64 encoded string.

WebDriver provides the Take Screenshot command to capture the top-level browsing context’s initial viewport, and a command Take Element Screenshot for doing the same with the visible region of an element’s bounding rectangle after it has been scrolled into view.

In order to draw a bounding box from the framebuffer, given a rectangle:

  1. If either the initial viewport’s width or height is 0 CSS pixels, return error with error code unable to capture screen.

  2. Let paint width be the initial viewport’s width – min(rectangle x coordinate, rectangle x coordinate + rectangle width dimension).

  3. Let paint height be the initial viewport’s height – min(rectangle y coordinate, rectangle y coordinate + rectangle height dimension).

  4. Let canvas be a new canvas element, and set its width and height to paint width and paint height, respectively.

  5. Let context, a canvas context mode, be the result of invoking the 2D context creation algorithm given canvas as the target.

  6. Complete implementation specific steps equivalent to drawing the region of the framebuffer specified by the following coordinates onto context:

    X coordinate
    rectangle x coordinate
    Y coordinate
    rectangle y coordinate
    Width
    paint width
    Height
    paint height
  7. Return success with canvas.

To encode a canvas as Base64 a canvas element:

  1. If the canvas element’s bitmap’s origin-clean flag is set to false, return error with error code unable to capture screen.

  2. If the canvas element’s bitmap has no pixels (i.e. either its horizontal dimension or vertical dimension is zero) then return error with error code unable to capture screen.

  3. Let file be a serialization of the canvas element’s bitmap as a file, using "image/png" as an argument.

  4. Let data url be a data: URL representing file. [RFC2397]

  5. Let index be the index of "," in data url.

  6. Let encoded string be a substring of data url using (index + 1) as the start argument.

  7. Return success with data encoded string.

17.1 Take Screenshot

HTTP Method URI Template
GET /session/{session id}/screenshot

The remote end steps are:

  1. If the current top-level browsing context is no longer open, return error with error code no such window.

  2. When the user agent is next to run the animation frame callbacks:

    1. Let root rect be the current top-level browsing context’s document element’s rectangle.

    2. Let screenshot result be the result of trying to call draw a bounding box from the framebuffer, given root rect as an argument.

    3. Let canvas be a canvas element of screenshot result’s data.

    4. Let encoding result be the result of trying encoding a canvas as Base64 canvas.

    5. Let encoded string be encoding result’s data.

  3. Return success with data encoded string.

17.2 Take Element Screenshot

HTTP Method URI Template
GET /session/{session id}/element/{element id}/screenshot
Note

The Take Element Screenshot command takes a screenshot of the visible region encompassed by the bounding rectangle of an element.

The remote end steps are:

  1. If the current browsing context is no longer open, return error with error code no such window.

  2. Handle any user prompts and return its value if it is an error.

  3. Let element be the result of trying to get a known element with url variable element id.

  4. Scroll into view the element.

  5. When the user agent is next to run the animation frame callbacks:

    1. Let element rect be element’s rectangle.

    2. Let screenshot result be the result of trying to call draw a bounding box from the framebuffer, given element rect as an argument.

    3. Let canvas be a canvas element of screenshot result’s data.

    4. Let encoding result be the result of trying encoding a canvas as Base64 canvas.

    5. Let encoded string be encoding result’s data.

  6. Return success with data encoded string.

18. Print

The print functions are a mechanism to render the document to a paginated format. It is returned to the local end as a Base64 encoded string containing a PDF representation of the paginated document.

When required to parse a page range with arguments pageRanges and totalPages, an implementation must:

  1. Let pages be an empty Set
  2. For each range in pageRanges, run the following steps:
    1. If range is not either a Number or a String, return error with error code invalid argument.
    2. If range is a Number:

      1. If range is not an integer or is less than 0, return error with error code invalid argument
      2. Append range to pages

      Otherwise:

      1. Let rangeParts be the result of splitting range on a "-" character.
      2. If rangeParts has fewer than 1 or more than 2 elements, return error with error code invalid argument.
      3. If rangeParts has one element, append the result of trying to parse as an integer the first element of rangeParts to pages.

        Otherwise:

        1. If the first element of rangeParts is equivalent to an empty string, let lowerBound be 1. Otherwise let lowerBound be the result of trying to parse as an integer the first element of rangeParts.
        2. If the second element of rangeParts is equivalent to an empty string let upperBound be totalPages. Otherwise let upperBound be the result of trying to parse as an integer the second element of rangeParts.
        3. If lowerBound is greater than upperBound, return error with error code invalid argument.
        4. Append all integers in the inclusive range lowerBound to upperBound to pages
    3. Return success with data pages.

A String is equivalent to an empty string if it has zero length after removing all whitespace characters.

When required to parse as an integer with argument input an implementation must:

  1. Let stripped be the result of stripping all leading and trailing whitespace characters from input.
  2. If stripped has zero length, return error with status invalid argument.
  3. If stripped contains any characters outside the range U+0030 - U+0039 (i.e. 0 - 9) inclusive, return error with status invalid argument.
  4. Let output be the result of calling parseInt with string stripped and radix 10.
  5. Return success with data output.

A. Privacy

It is advisable that remote ends create a new profile when creating a new session. This prevents potentially sensitive session data from being accessible to new sessions, ensuring both privacy and preventing state from bleeding through to the next session.

B. Security

A user agent can rely on a command-line flag or a configuration option to test whether to enable WebDriver, or alternatively make the user agent initiate or confirm the connection through a privileged content document or control widget, in case the user agent does not directly implement the HTTP endpoints.

It is strongly suggested that user agents require users to take explicit action to enable WebDriver, and that WebDriver remains disabled in publicly consumed versions of the user agent.

To prevent arbitrary machines on the network from connecting and creating sessions, it is suggested that only connections from loopback devices are allowed by default.

The remote end can include a configuration option to limit the accepted IP range allowed to connect and make requests. The default setting for this might be to limit connections to the IPv4 localhost CIDR range 127.0.0.0/8 and the IPv6 localhost address ::1. [RFC4632]

It is also suggested that user agents make an effort to visually distinguish a user agent session that is under control of WebDriver from those used for normal browsing sessions. This can be done through a browser chrome element such as a “door hanger”, colorful decoration of the OS window, or some widget element that is prevalent in the window so that it easy to identify automation windows.

C. Element displayedness

Although WebDriver does not define a primitive to ascertain the visibility of an element in the viewport, we acknowledge that it is an important feature for many users. Here we include a recommended approach which will give a simplified approximation of an element’s visibility, but please note that it relies only on tree-traversal, and only covers a subset of visibility checks.

The visibility of an element 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.

The approach recommended to implementors to ascertain an element’s visibility was originally developed by the Selenium project, and is based on crude approximations about an element's nature and relationship in the tree. An element is in general to be considered visible if any part of it is drawn on the canvas within the boundaries of the viewport.

The element displayed algorithm is a boolean state where true signifies that the element is displayed and false signifies that the element is not displayed. To compute the state on element, invoke the Function.[[Call]](null, element, false), with bot.dom.isShown as the this value. If doing so does not produce an error, return the return value from this function call. Otherwise return an error with error code unknown error.

This function is typically exposed to GET requests with a URI Template of /session/{session id}/element/{element id}/displayed.

D. Acknowledgements

There have been a lot of people that have helped make browser automation possible over the years and thereby furthered the goals of this standard. In particular, thanks goes to the Selenium Open Source community, without which this standard would never have been possible.

This standard is authored by Aleksey Chemakin, Andreas Tolfsen, Andrey Botalov, Brian Burg, Christian Bromann, Clayton Martin, Daniel Wagner-Hall, David Burns, Dominique Hazael-Massieux, Eran Messeri, Erik Wilde, Gábor Csárdi, Henrik Skupin, James Graham, Jason Juang, Jason Leyba, Jim Evans, John Chen, John Jansen, Jonathan Lipps, Jonathon Kereliuk, Luke Inman-Semerau, Maja Frydrychowicz, Malini Das, Manoj Kumar, Marc Fisher, Mike Pennisi, Ondřej Machulda, Randall Kent, Sam Sneddon, Seva Lotoshnikov, Simon Stewart, Sri Harsha, Titus Fortner, and Vangelis Katsikaros. The work is coordinated and edited by David Burns and Simon Stewart.

Thanks to Berge Schwebs Bjørlo, Lukas Tetzlaff, Malcolm Rowe, Michael[tm] Smith, Nathan Bloomfield, Philippe Le Hégaret, Robin Berjon, Ross Patterson, and Wilhelm Joys Andersen for proofreading and suggesting areas for improvement.

E. Index

This specification relies on several other underlying specifications.

ARIA and related specifications

The following terms are defined in the Accessible Rich Internet Applications (WAI-ARIA) 1.2 specification: [wai-aria-1.2]

The following terms are defined in the Accessible Name and Description Computation 1.1 specification: [accname-1.1]

Web App Security

The following terms are defined in the Content Security Policy Level 3 specification: [CSP3]

Base16, Base32, and Base64 Data Encodings

The following terms are defined in The Base16, Base32, and Base64 Data Encodings specification: [RFC4648]

DOM

The following terms are defined in the DOM Parsing and Serialization specification: [DOM-PARSING]

The following attributes are defined in the UI Events specification: [UI-EVENTS]

The following attributes are defined in the UI Events Code specification: [UIEVENTS-CODE]

The following attributes are defined in the UI Events Code specification: [UIEVENTS-KEY]

ECMAScript

The following terms are defined in the ECMAScript Language Specification: [ECMA-262]

This specification also presumes that you are able to call some of the internal methods from the ECMAScript Language Specification [ECMAScript]:
The ECMAScript Language Specification also defines the following types, values, and operations that are used throughout this specification:
Encoding

The following terms are defined in the WHATWG Encoding specification: [ENCODING]

Fetch

The following terms are defined in the WHATWG Fetch specification: [FETCH]

Fullscreen

The following terms are defined in the WHATWG Fullscreen specification: [FULLSCREEN]

HTML

The following terms are defined in the HTML specification: [HTML]

The HTML specification also defines states of the input element:

The HTML specification also defines a range of different attributes:

The HTML Editing APIs specification defines the following terms: [EDITING]

The following events are also defined in the HTML specification:

The “data” URL scheme specification defines the following terms: [RFC2397]

HTTP and related specifications

To be HTTP compliant, it is supposed that the implementation supports the relevant subsets of [RFC7230], [RFC7231], [RFC7232], [RFC7234], and [RFC7235].

The following terms are defined in the Cookie specification: [RFC6265]

The following terms are defined in the Same Site Cookie specification: [RFC6265bis]

The following terms are defined in the Hypertext Transfer Protocol (HTTP) Status Code Registry:

The following terms are defined in the Netscape Navigator Proxy Auto-Config File Format:

The specification uses URI Templates. [URI-TEMPLATE]

Interaction
The following terms are defined in the Page Visibility Specification [PAGE-VISIBILITY]
Selenium
The following functions are defined within the Selenium project, at revision a6b161a159c3d581b130f03a2e6e35f577f38dec.
Styling
The following terms are defined in the CSS Values and Units Module Level 3 specification: [CSS3-VALUES]
The following properties are defined in the CSS Basic Box Model Level 3 specification: [CSS3-BOX]
The following terms are defined in the CSS Device Adaptation Module Level 1 specification: [CSS-DEVICE-ADAPT]
The following properties are defined in the CSS Display Module Level 3 specification: [CSS3-DISPLAY]
The following terms are defined in the Geometry Interfaces Module Level 1 specification: [GEOMETRY-1]
The following terms are defined in the CSS Cascading and Inheritance Level 4 specification: [CSS-CASCADE-4]
The following terms are defined in the CSS Object Model: [CSSOM]:
The following functions are defined in the CSSOM View Module: [CSSOM-VIEW]:
The following terms are defined in [mediaqueries-4]:
SOCKS Proxy and related specification:

To be SOCKS Proxy and SOCKS authentication compliant, it is supposed that the implementation supports the relevant subsets of [RFC1928] and [RFC1929].

Unicode
The following terms are defined in the standard: [Unicode]
Unicode Standard Annex #29
The following terms are defined in the standard: [UAX29]
Unicode Standard Annex #44
The following terms are defined in the standard: [UAX44]
URLs
The following terms are defined in the WHATWG URL standard: [URL]
Web IDL

The IDL fragments in this specification must be interpreted as required for conforming IDL fragments, as described in the Web IDL specification. [WEBIDL]

Promises Guide

The following terms are defined in the Promises Guide. [PROMISES-GUIDE]

XML Namespaces

The following terms are defined in the Namespaces in XML [XML-NAMES]

XPATH

The following terms are defined in the Document Object Model XPath standard [XPATH]

E.1 Terms defined by this specification