API Docs for: 0.0.5
Show:

Internal.Driver Class

Defined in: lib/driver.js:34
Module: DalekJS

Native Webdriver base class

Methods

_concatDataChunks

(
  • chunk
)
String private

Defined in lib/driver.js:225

Concatenates chunks of strings

Parameters:

  • chunk String

    String to add

Returns:

String:

data Concatenated string

_generateWebdriverCommand

(
  • remote
  • driver
)
Function private

Defined in lib/driver.js:178

Generates the webdriver callback function

Parameters:

  • remote Object

    Dummy request body (function name, url, method)

  • driver DalekJs.Internal.Driver

    Driver instance

Returns:

Function:

webdriverCommand Generated webdriver command function

_mapParams

(
  • providedParams
  • params
  • param
  • idx
)
Object private

Defined in lib/driver.js:85

Mpas object values & keys of two objects

Parameters:

  • providedParams Object

    Values for the paramset

  • params Object

    The object to be filled

  • param String

    The key of the output object

  • idx Integer

    Index of the iteration

Returns:

Object:

params Params for the message body

_onError

(
  • driver
  • response
  • remote
  • options
  • deferred
)
private chainable

Defined in lib/driver.js:255

On error callback function

Parameters:

  • driver DalekJs.Internal.Driver

    Driver instance

  • response Object

    Response from the webdriver server

  • remote Object

    Dummy request body (function name, url, method)

  • options Object

    Request options (method, port, path, headers, etc.)

  • deferred Object

    Webdriver command deferred

_onResponse

(
  • driver
  • remote
  • options
  • deferred
  • response
)
private chainable

Defined in lib/driver.js:205

Response callback function

Parameters:

  • driver DalekJs.Internal.Driver

    Driver instance

  • remote Object

    Dummy request body (function name, url, method)

  • options Object

    Request options (method, port, path, headers, etc.)

  • deferred Object

    Webdriver command deferred

  • response Object

    Response from the webdriver server

_onResponseEnd

(
  • driver
  • response
  • remote
  • options
  • deferred
)
chainable

Defined in lib/driver.js:238

Response end callback function

Parameters:

  • driver DalekJs.Internal.Driver

    Driver instance

  • response Object

    Response from the webdriver server

  • remote Object

    Dummy request body (function name, url, method)

  • options Object

    Request options (method, port, path, headers, etc.)

  • deferred Object

    Webdriver command deferred

_onSuccess

(
  • driver
  • response
  • remote
  • options
  • deferred
)
private chainable

Defined in lib/driver.js:285

On success callback function

Parameters:

  • driver DalekJs.Internal.Driver

    Driver instance

  • response Object

    Response from the webdriver server

  • remote Object

    Dummy request body (function name, url, method)

  • options Object

    Request options (method, port, path, headers, etc.)

  • deferred Object

    Webdriver command deferred

_replacePlaceholderInUrl

(
  • options
  • url
  • option
)
String private

Defined in lib/driver.js:57

Replaces placeholders in urls

Parameters:

  • options Object

    List of url options

  • url String

    URL with placeholders

  • option String

    Option to process

Returns:

String:

url Parsed URL

acceptAlert

(
  • sessionId
)

Defined in lib/commands/page.js:106

Accept an dialog box

Parameters:

  • sessionId GET

    ID of the session to route the command to

activatedEngine

(
  • sessionId
)

Defined in lib/commands/ime.js:83

Indicates whether IME input is active at the moment

Parameters:

  • sessionId GET

    ID of the session to route the command to

activateEngine

(
  • sessionId
  • engine
)

Defined in lib/commands/ime.js:111

Make an engines that is available (appears on the list returned by getAvailableEngines) active. After this call, the engine will be added to the list of engines loaded in the IME daemon and the input sent using sendKeys will be converted by the active engine. Note that this is a platform-independent method of activating IME (the platform-specific way being using keyboard shortcuts)

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • engine POST

    Name of the engine to activate

active

(
  • sessionId
  • id
)

Defined in lib/commands/element.js:92

Get the element on the page that currently has focus. The element will be returned as a WebElement JSON object.

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • id GET

    ID of the element to route the command to

activeEngine

(
  • sessionId
)

Defined in lib/commands/ime.js:68

Get the name of the active IME engine. The name string is platform specific.

Parameters:

  • sessionId GET

    ID of the session to route the command to

addCommand

(
  • remote
)
chainable

Defined in lib/driver.js:161

Generates a new webdriver client command Takes a skeleton of obtions that will be converted into a new function that can be invoked & will issue a webdriver command to the webdriver server

Parameters:

  • remote Object

    Object skeleton that will be turned into a webdriver client method

alertText

(
  • sessionId
)

Defined in lib/commands/page.js:76

Checks a prompt text

Parameters:

  • sessionId GET

    ID of the session to route the command to

applicationCacheStatus

(
  • sessionId
)

Defined in lib/commands/storage.js:123

Get the status of the html5 application cache.

Parameters:

  • sessionId GET

    ID of the session to route the command to

asyncScript

(
  • sessionId
  • ms
)

Defined in lib/commands/timeout.js:53

Set the amount of time, in milliseconds, that asynchronous scripts executed by /session/:sessionId/execute_async are permitted to run before they are aborted and a |Timeout| error is returned to the client.

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • ms POST

    The amount of time to wait, in milliseconds. This value has a lower bound of 0

availableEngines

(
  • sessionId
)

Defined in lib/commands/ime.js:53

List all available engines on the machine. To use an engine, it has to be present in this list.

Parameters:

  • sessionId GET

    ID of the session to route the command to

back

(
  • sessionId
)

Defined in lib/commands/url.js:85

Navigate backwards in the browser history, if possible

Parameters:

  • sessionId GET

    ID of the session to route the command to

buttonClick

(
  • sessionId
  • button
)

Defined in lib/commands/interaction.js:59

Click any mouse button (at the coordinates set by the last moveto command). Note that calling this command after calling buttondown and before calling button up (or any out-of-order interactions sequence) will yield undefined behaviour).

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • button POST

    Which button, enum: {LEFT = 0, MIDDLE = 1 , RIGHT = 2}. Defaults to the left mouse button if not specified.

buttondown

(
  • sessionId
  • button
)

Defined in lib/commands/interaction.js:78

Click and hold the left mouse button (at the coordinates set by the last moveto command). Note that the next mouse-related command that should follow is buttonup. Any other mouse command (such as click or another call to buttondown) will yield undefined behaviour.

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • button POST

    Which button, enum: {LEFT = 0, MIDDLE = 1 , RIGHT = 2}. Defaults to the left mouse button if not specified.

buttonup

(
  • sessionId
  • button
)

Defined in lib/commands/interaction.js:96

Releases the mouse button previously held (where the mouse is currently at). Must be called once for every buttondown command issued. See the note in click and buttondown about implications of out-of-order commands.

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • button POST

    Which button, enum: {LEFT = 0, MIDDLE = 1 , RIGHT = 2}. Defaults to the left mouse button if not specified.

changeWindow

(
  • sessionId
  • name
)

Defined in lib/commands/window.js:63

Change focus to another window. The window to change focus to may be specified by its server assigned window handle, or by the value of its name attribute.

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • name POST

    Name of the window to switch to

childElement

(
  • sessionId
  • elementId
  • using
  • value
)

Defined in lib/commands/element.js:123

Search for an element on the page, starting from the identified element. The located element will be returned as a WebElement JSON object. The table below lists the locator strategies that each server should support. Each locator must return the first matching element located in the DOM.

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • elementId GET

    ID of the element to route the command to

  • using POST

    The locator strategy to use. // Not yet supported

  • value POST

    The The search target.

clear

(
  • sessionId
  • elementId
)

Defined in lib/commands/element.js:243

Clear a TEXTAREA or text INPUT element's value

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • elementId GET

    ID of the element to route the command to

click

(
  • sessionId
  • id
)

Defined in lib/commands/element.js:162

Click on an element.

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • id GET

    ID of the element to route the command to

close

(
  • sessionId
)

Defined in lib/commands/window.js:165

Closes the current window.

Parameters:

  • sessionId GET

    ID of the session to route the command to

createSession

(
  • desiredCapabilities
  • requiredCapabilities
)

Defined in lib/commands/session.js:35

Create a new session. The server should attempt to create a session that most closely matches the desired and required capabilities. Required capabilities have higher priority than desired capabilities and must be set for the session to be created.

Parameters:

  • desiredCapabilities POST

    An object describing the session's desired capabilities.

  • requiredCapabilities POST

    An object describing the session's required capabilities

cssProperty

(
  • sessionId
  • elementId
  • propertyName
)

Defined in lib/commands/element.js:389

Query the value of an element's computed CSS property. The CSS property to query should be specified using the CSS property name, not the JavaScript property name (e.g. background-color instead of backgroundColor).

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • elementId GET

    ID of the element to route the command to

  • propertyName GET

    Name of the css property to fetch

deactivateEngine

(
  • sessionId
)

Defined in lib/commands/ime.js:97

De-activates the currently-active IME engine

Parameters:

  • sessionId GET

    ID of the session to route the command to

dismissAlert

(
  • sessionId
)

Defined in lib/commands/page.js:120

Cancel an dialog box

Parameters:

  • sessionId GET

    ID of the session to route the command to

displayed

(
  • sessionId
  • elementId
)

Defined in lib/commands/element.js:324

Determine an element's location on the page. The point (0, 0) refers to the upper-left corner of the page. The element's coordinates are returned as a JSON object with x and y properties.

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • elementId GET

    ID of the element to route the command to

doubleclickPage

(
  • sessionId
)

Defined in lib/commands/interaction.js:114

Double-clicks at the current mouse coordinates (set by moveto).

Parameters:

  • sessionId GET

    ID of the session to route the command to

doubletap

(
  • sessionId
)

Defined in lib/commands/interaction.js:212

Double tap on the touch screen using finger motion events.

Parameters:

  • sessionId GET

    ID of the session to route the command to

element

(
  • sessionId
  • elementId
  • using
  • value
)

Defined in lib/commands/element.js:143

Search for an element on the page, starting from the identified element. The located element will be returned as a WebElement JSON object. The table below lists the locator strategies that each server should support. Each locator must return the first matching element located in the DOM.

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • elementId GET

    ID of the element to route the command to

  • using POST

    The locator strategy to use. // Not yet supported

  • value POST

    The The search target.

element

(
  • sessionId
  • selector
)

Defined in lib/commands/element.js:35

Search for an element on the page, starting from the document root. The located element will be returned as a WebElement JSON object.

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • selector POST

    The The search target.

elementInfo

(
  • sessionId
  • elementId
)

Defined in lib/commands/element.js:107

Get the element on the page that currently has focus. The element will be returned as a WebElement JSON object.

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • elementId GET

    ID of the element to route the command to

elements

(
  • sessionId
  • selector
)

Defined in lib/commands/element.js:64

Search for multiple elements on the page, starting from the document root. The located element will be returned as a WebElement JSON object.

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • selector POST

    The The search target.

enabled

(
  • sessionId
  • elementId
)

Defined in lib/commands/element.js:273

Determine if an element is currently enabled

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • elementId GET

    ID of the element to route the command to

equals

(
  • sessionId
  • elementId
  • other
)

Defined in lib/commands/element.js:309

Test if two element IDs refer to the same DOM element

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • elementId GET

    ID of the element to route the command to

  • other GET

    ID of the element to compare

execute

(
  • sessionId
  • script
  • args
)

Defined in lib/commands/execute.js:38

Inject a snippet of JavaScript into the page for execution in the context of the currently selected frame. The executed script is assumed to be synchronous and the result of evaluating the script is returned to the client. The script argument defines the script to execute in the form of a function body. The value returned by that function will be returned to the client. The function will be invoked with the provided args array and the values may be accessed via the arguments object in the order specified.

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • script POST

    The script to execute.

  • args POST

    The script arguments.

executeAsync

(
  • sessionId
  • script
  • args
)

Defined in lib/commands/execute.js:71

Inject a snippet of JavaScript into the page for execution in the context of the currently selected frame. The executed script is assumed to be asynchronous and must signal that is done by invoking the provided callback, which is always provided as the final argument to the function. The value to this callback will be returned to the client. Asynchronous script commands may not span page loads. If an unload event is fired while waiting for a script result, an error should be returned to the client.

The script argument defines the script to execute in teh form of a function body. The function will be invoked with the provided args array and the values may be accessed via the arguments object in the order specified. The final argument will always be a callback function that must be invoked to signal that the script has finished.

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • script POST

    The script to execute.

  • args POST

    The script arguments.

flick

(
  • sessionId
  • element
  • xoffset
  • yoffset
  • speed
)

Defined in lib/commands/interaction.js:240

Flick on the touch screen using finger motion events. This flickcommand starts at a particulat screen location.

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • element POST

    ID of the element where the flick starts

  • xoffset POST

    The x offset in pixels to flick by

  • yoffset POST

    The y offset in pixels to flick by

  • speed POST

    The speed in pixels per seconds

forward

(
  • sessionId
)

Defined in lib/commands/url.js:71

Navigate forwards in the browser history, if possible.

Parameters:

  • sessionId GET

    ID of the session to route the command to

frame

(
  • sessionId
  • id
)

Defined in lib/commands/frame.js:35

Change focus to another frame on the page. If the frame id is null, the server should switch to the page's default content.

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • id POST

    Identifier for the frame to change focus to.

generateBody

(
  • options
  • cb
  • wd
  • params
)
String

Defined in lib/driver.js:102

Generates the message body for webdriver client requests of type POST

Parameters:

  • options Object

    Browser options (name, bin path, etc.)

  • cb Function | Undefined

    Callback function that should be invoked to generate the message body

  • wd Dalek.Internal.Webdriver

    Webdriver base object

  • params Object

    Parameters that should be part of the message body

Returns:

String:

body Serialized JSON of body request data

generateParamset

(
  • requestedParams
  • providedParams
)
Object

Defined in lib/driver.js:72

Generates a set of params for the message body of the request

Parameters:

  • requestedParams Object | Null

    Keys & placeholders for the paramset

  • providedParams Object

    Values for the paramset

Returns:

Object:

params Params for the message body

generateRequestOptions

(
  • hostname
  • port
  • prefix
  • url
  • method
  • body
)
Object

Defined in lib/driver.js:128

Generates the request options for a webdriver client request

Parameters:

  • hostname String

    Hostname of the webdriver server

  • port Integer

    Port of the webdriver server

  • prefix String

    Url address prefix of the webdriver endpoint

  • url String

    Url of the webdriver method

  • method String

    Request method e.g. (GET, POST, DELETE, PUT)

  • body String

    The message body of the request

Returns:

Object:

options Request options

geoLocation

(
  • sessionId
)

Defined in lib/commands/page.js:134

Get the current geo location

Parameters:

  • sessionId GET

    ID of the session to route the command to

getAttribute

(
  • sessionId
  • elementId
  • attr
)

Defined in lib/commands/element.js:288

Get the value of an element's attribute.

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • elementId GET

    ID of the element to route the command to

  • attr GET

    Attribute that should be fetched

getCookie

(
  • sessionId
  • name
)

Defined in lib/commands/cookie.js:49

Retrieve a cookies by its name.

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • name GET

    Name of the cookie

getCookies

(
  • sessionId
)

Defined in lib/commands/cookie.js:35

Retrieve all cookies visible to the current page.

Parameters:

  • sessionId GET

    ID of the session to route the command to

getLocalStorage

(
  • sessionId
)

Defined in lib/commands/storage.js:35

Get all keys of the browsers local storage

Parameters:

  • sessionId GET

    ID of the session to route the command to

getLocalStorageSize

(
  • sessionId
)

Defined in lib/commands/storage.js:66

Get the number of items in the storage

Parameters:

  • sessionId GET

    ID of the session to route the command to

getSessionStorage

(
  • sessionId
)

Defined in lib/commands/storage.js:80

Get all keys of the browsers session storage

Parameters:

  • sessionId GET

    ID of the session to route the command to

getSessionStorageEntry

(
  • sessionId
  • key
)

Defined in lib/commands/storage.js:94

Get the storage item for the given key

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • key GET

    The key to get

getSessionStorageSize

(
  • sessionId
)

Defined in lib/commands/storage.js:109

Get the number of items in the storage

Parameters:

  • sessionId GET

    ID of the session to route the command to

getUrl

(
  • sessionId
)

Defined in lib/commands/url.js:57

Retrieve the URL of the current page

Parameters:

  • sessionId GET

    ID of the session to route the command to

getWindowPosition

(
  • sessionId
  • windowHandle
)

Defined in lib/commands/window.js:116

Get the position of the specified window. If the :windowHandle URL parameter is "current", the position of the currently active window will be returned.

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • windowHandle GET

    ID of the window to route the command to

getWindowSize

(
  • sessionId
  • windowHandle
)

Defined in lib/commands/window.js:80

Get the size of the specified window. If the :windowHandle URL parameter is "current", the size of the currently active window will be returned.

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • windowHandle GET

    ID of the window to route the command to

implicitWait

(
  • sessionId
  • ms
)

Defined in lib/commands/timeout.js:71

Set the amount of time the driver should wait when searching for elements. When searching for a single element, the driver should poll the page until an element is found or the timeout expires, whichever occurs first. When searching for multiple elements, the driver should poll the page until at least one element is found or the timeout expires, at which point it should return an empty list.

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • ms POST

    The amount of time to wait, in milliseconds. This value has a lower bound of 0

location

(
  • sessionId
  • elementId
)

Defined in lib/commands/element.js:341

Determine an element's location on the page. The point (0, 0) refers to the upper-left corner of the page. The element's coordinates are returned as a JSON object with x and y properties.

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • elementId GET

    ID of the element to route the command to

locationInView

(
  • sessionId
  • elementId
)

Defined in lib/commands/element.js:357

Determine an element's location on the screen once it has been scrolled into view. Note: This is considered an internal command and should only be used to determine an element's location for correctly generating native events.

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • elementId GET

    ID of the element to route the command to

log

(
  • sessionId
)

Defined in lib/commands/page.js:166

Get the log for a given log type. Log buffer is reset after each request.

Parameters:

  • sessionId GET

    ID of the session to route the command to

logTypes

(
  • sessionId
)

Defined in lib/commands/page.js:181

Get available log types

Parameters:

  • sessionId GET

    ID of the session to route the command to

longpress

(
  • sessionId
)

Defined in lib/commands/interaction.js:226

Long press on the touch screen using finger motion events.

Parameters:

  • sessionId GET

    ID of the session to route the command to

moveto

(
  • sessionId
  • element
  • xoffset
  • yoffset
)

Defined in lib/commands/interaction.js:35

Move the mouse by an offset of the specificed element. If no element is specified, the move is relative to the current mouse cursor. If an element is provided but no offset, the mouse will be moved to the center of the element. If the element is not visible, it will be scrolled into view.

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • element POST

    Opaque ID assigned to the element to move to, as described in the WebElement JSON Object. If not specified or is null, the offset is relative to current position of the mouse.

  • xoffset POST

    X offset to move to, relative to the top-left corner of the element. If not specified, the mouse will move to the middle of the element.

  • yoffset POST

    Y offset to move to, relative to the top-left corner of the element. If not specified, the mouse will move to the middle of the element.

name

(
  • sessionId
  • elementId
)

Defined in lib/commands/element.js:228

Query for an element's tag name

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • elementId GET

    ID of the element to route the command to

orientation

(
  • sessionId
)

Defined in lib/commands/page.js:63

Checks the device orientation

Parameters:

  • sessionId GET

    ID of the session to route the command to

parseUrl

(
  • url
  • options
)
String

Defined in lib/driver.js:44

Parses an JSON Wire protocol dummy url

Parameters:

  • url String

    URL with placeholders

  • options Object

    List of url options

Returns:

String:

url Parsed URL

promptText

(
  • sessionId
  • text
)

Defined in lib/commands/page.js:90

Sets a prompt text

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • text POST

    Text to set

refresh

(
  • sessionId
)

Defined in lib/commands/url.js:99

Refresh the current page

Parameters:

  • sessionId GET

    ID of the session to route the command to

screenshot

(
  • sessionId
)

Defined in lib/commands/screenshot.js:35

Take a screenshot of the current page.

Parameters:

  • sessionId GET

    ID of the session to route the command to

selected

(
  • sessionId
  • elementId
)

Defined in lib/commands/element.js:258

Determine if an OPTION element, or an INPUT element of type checkbox or radiobutton is currently selected

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • elementId GET

    ID of the element to route the command to

sendKeys

(
  • sessionId
  • id
  • text
)

Defined in lib/commands/element.js:412

Get the log for a given log type. Log buffer is reset after each request.

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • id GET

    ID of the element to route the command to

  • text POST

    The keys sequence to be sent

session

(
  • sessionId
)

Defined in lib/commands/session.js:83

Retrieve the capabilities of the specified session.

Parameters:

  • sessionId GET

    ID of the session to route the command to

session

(
  • sessionId
)

Defined in lib/commands/session.js:97

Delete the session.

Parameters:

  • sessionId GET

    ID of the session to route the command to

sessions

()

Defined in lib/commands/session.js:70

Returns a list of the currently active sessions

setCookie

(
  • sessionId
  • cookie
)

Defined in lib/commands/cookie.js:64

Set a cookie. If the cookie path is not specified, it should be set to "/". Likewise, if the domain is omitted, it should default to the current page's domain.

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • cookie POST

    The cookie object

setGeoLocation

(
  • sessionId
  • latitude
  • longitude
  • altitude
)

Defined in lib/commands/page.js:148

Set the geo location

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • latitude POST

    The new location

  • longitude POST

    The new location

  • altitude POST

    The new location

setLocalStorage

(
  • sessionId
  • key
  • value
)

Defined in lib/commands/storage.js:49

Set the storage item for the given key

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • key POST

    The key to set

  • value POST

    The value to set

setWindowPosition

(
  • sessionId
  • x
  • y
)

Defined in lib/commands/window.js:132

Set the position of the specified window.

Parameters:

  • sessionId POST

    ID of the session to route the command to

  • x POST

    The X coordinates for the window, relative to the upper left corner of the screen.

  • y POST

    The Y coordinates for the window, relative to the upper left corner of the screen.

setWindowSize

(
  • sessionId
  • windowHandle
  • width
  • height
)

Defined in lib/commands/window.js:96

Change the size of the specified window. If the :windowHandle URL parameter is "current", the currently active window will be resized.

Parameters:

  • sessionId POST

    ID of the session to route the command to

  • windowHandle POST

    ID of the window to route the command to

  • width POST

    The new window width

  • height POST

    The new window height

size

(
  • sessionId
  • elementId
)

Defined in lib/commands/element.js:373

Determine an element's size in pixels. The size will be returned as a JSON object with width and height properties.

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • elementId GET

    ID of the element to route the command to

source

(
  • sessionId
)

Defined in lib/commands/page.js:35

Get the current page source

Parameters:

  • sessionId GET

    ID of the session to route the command to

status

()

Defined in lib/commands/ime.js:35

Query the server's current status. The server should respond with a general "HTTP 200 OK" response if it is alive and accepting commands. The response body should be a JSON object describing the state of the server. All server implementations should return two basic objects describing the server's current platform and when the server was built. All fields are optional; if omitted, the client should assume the value is uknown. Furthermore, server implementations may include additional fields not listed here.

submit

(
  • sessionId
  • id
)

Defined in lib/commands/element.js:177

Submit a FORM element. The submit command may also be applied to any element that is a descendant of a FORM element.

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • id GET

    ID of the element to route the command to

tap

(
  • sessionId
)

Defined in lib/commands/interaction.js:128

Single tap on the touch enabled device.

Parameters:

  • sessionId GET

    ID of the session to route the command to

text

(
  • sessionId
  • id
)

Defined in lib/commands/element.js:193

Returns the visible text for the element.

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • id GET

    ID of the element to route the command to

timeouts

(
  • sessionId
  • type
  • ms
)

Defined in lib/commands/timeout.js:35

Configure the amount of time that a particular type of operation can execute for before they are aborted and a |Timeout| error is returned to the client.

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • type POST

    The type of operation to set the timeout for. Valid values are: "script" for script timeouts, "implicit" for modifying the implicit wait timeout and "page load" for setting a page load timeout

  • ms POST

    The amount of time to wait, in milliseconds. This value has a lower bound of 0

title

(
  • sessionId
)

Defined in lib/commands/page.js:49

Get the current page title

Parameters:

  • sessionId GET

    ID of the session to route the command to

touchdown

(
  • sessionId
  • x
  • y
)

Defined in lib/commands/interaction.js:143

Finger down on the screen.

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • x POST

    X coordinate on the screen.

  • y POST

    Y coordinate on the screen.

touchmove

(
  • sessionId
  • x
  • y
)

Defined in lib/commands/interaction.js:177

Finger move on the screen.

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • x POST

    X coordinate on the screen.

  • y POST

    Y coordinate on the screen.

touchscroll

(
  • sessionId
  • x
  • y
)

Defined in lib/commands/interaction.js:194

Scroll on the touch screen using finger based motion events. Use this command if you don't care where the scroll starts on the screen.

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • x POST

    X coordinate on the screen.

  • y POST

    Y coordinate on the screen.

touchup

(
  • sessionId
  • x
  • y
)

Defined in lib/commands/interaction.js:160

Finger up on the screen.

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • x POST

    X coordinate on the screen.

  • y POST

    Y coordinate on the screen.

url

(
  • sessionId
  • page
)

Defined in lib/commands/url.js:35

Navigate to a new URL

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • page POST

    The URL to navigate to.

val

(
  • sessionId
  • id
  • text
)

Defined in lib/commands/element.js:208

Send a sequence of key strokes to an element

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • id GET

    ID of the element to route the command to

  • text POST

    The keys sequence to be sent

windowHandle

(
  • sessionId
)

Defined in lib/commands/window.js:35

Retrieve the current window handle.

Parameters:

  • sessionId GET

    ID of the session to route the command to

windowHandles

(
  • sessionId
)

Defined in lib/commands/window.js:49

Retrieve the list of all window handles available to the session.

Parameters:

  • sessionId GET

    ID of the session to route the command to

windowMaximize

(
  • sessionId
  • windowHandle
)

Defined in lib/commands/window.js:149

Maximize the specified window if not already maximized. If the :windowHandle URL parameter is "current", the currently active window will be maximized.

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • windowHandle GET

    ID of the window to route the command to