ById Text
ByName Text
ByClass Text	(Note: multiple classes are not allowed. For more control, use `ByCSS`)
ByTag Text
ByLinkText Text
ByPartialLinkText Text
ByCSS Text
ByXPath Text

Instances

Eq Selector
Ord Selector
Show Selector
ToJSON Selector

Searching for elements

findElem :: Selector -> WD Element Source

Find an element on the page using the given element selector.

findElems :: Selector -> WD [Element]Source

Find all elements on the page matching the given selector.

findElemFrom :: Element -> Selector -> WD Element Source

Search for an element using the given element as root.

findElemsFrom :: Element -> Selector -> WD [Element]Source

Find all elements matching a selector, using the given element as root.

Interacting with elements

click :: Element -> WD ()Source

Click on an element.

submit :: Element -> WD ()Source

Submit a form element. This may be applied to descendents of a form element as well.

getText :: Element -> WD Text Source

Get all visible text within this element.

sendKeys :: Text -> Element -> WD ()Source

Send a sequence of keystrokes to an element. All modifier keys are released at the end of the function. For more information about modifier keys, see http://code.google.com/p/selenium/wiki/JsonWireProtocol#/session/:sessionId/element/:id/value

sendRawKeys :: Text -> Element -> WD ()Source

Similar to sendKeys, but doesn't implicitly release modifier keys afterwards. This allows you to combine modifiers with mouse clicks.

clearInput :: Element -> WD ()Source

Clear a textarea or text input element's value.

Element information

attr :: Element -> Text -> WD (Maybe Text)Source

Retrieve the value of an element's attribute

cssProp :: Element -> Text -> WD (Maybe Text)Source

Retrieve the value of an element's computed CSS property

elemPos :: Element -> WD (Int, Int)Source

Retrieve an element's current position.

elemSize :: Element -> WD (Word, Word)Source

Retrieve an element's current size.

isSelected :: Element -> WD Bool Source

Determine if the element is selected.

isEnabled :: Element -> WD Bool Source

Determine if the element is enabled.

isDisplayed :: Element -> WD Bool Source

Determine if the element is displayed.

tagName :: Element -> WD Text Source

Return the tag name of the given element.

activeElem :: WD Element Source

Return the element that currently has focus.

elemInfo :: Element -> WD Value Source

Describe the element. Returns a JSON object whose meaning is currently undefined by the WebDriver protocol.

Element equality

(<==>) :: Element -> Element -> WD Bool Source

Determines if two element identifiers refer to the same element.

(</=>) :: Element -> Element -> WD Bool Source

Determines if two element identifiers refer to different elements.

Javascript

executeJS :: FromJSON a => [JSArg] -> Text -> WD aSource

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 and converted to an instance of FromJSON.

The first parameter defines arguments to pass to the javascript function. Arguments of type Element will be converted to the corresponding DOM element. Likewise, any elements in the script result will be returned to the client as Elements.

The second parameter defines the script itself 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 argument list and the values may be accessed via the arguments object in the order specified.

asyncJS :: FromJSON a => [JSArg] -> Text -> WD (Maybe a)Source

Executes a snippet of Javascript code asynchronously. This function works similarly to executeJS, except that the Javascript is passed a callback function as its final argument. The script should call this function to signal that it has finished executing, passing to it a value that will be returned as the result of asyncJS. A result of Nothing indicates that the Javascript function timed out (see setScriptTimeout)

data JSArg Source

An existential wrapper for any ToJSON instance. This allows us to pass parameters of many different types to Javascript code.

Constructors

forall a . ToJSON a => JSArg a

Instances

ToJSON JSArg

Windows

newtype WindowHandle Source

An opaque identifier for a browser window

Constructors

WindowHandle Text

Instances

Eq WindowHandle
Ord WindowHandle
Read WindowHandle
Show WindowHandle
ToJSON WindowHandle
FromJSON WindowHandle

currentWindow :: WindowHandle Source

A special WindowHandle that always refers to the currently focused window.

getCurrentWindow :: WD WindowHandle Source

Returns a handle to the currently focused window

closeWindow :: WindowHandle -> WD ()Source

Closes the given window

windows :: WD [WindowHandle]Source

Returns a list of all windows available to the session

focusWindow :: WindowHandle -> WD ()Source

maximize :: WD ()Source

Maximizes the current window if not already maximized

getWindowSize :: WD (Word, Word)Source

Get the dimensions of the current window.

setWindowSize :: (Word, Word) -> WD ()Source

Set the dimensions of the current window.

getWindowPos :: WD (Int, Int)Source

Get the coordinates of the current window.

setWindowPos :: (Int, Int) -> WD ()Source

Set the coordinates of the current window.

Focusing on frames

focusFrame :: FrameSelector -> WD ()Source

Switch focus to the frame specified by the FrameSelector.

data FrameSelector Source

Specifies the frame used by focusFrame

Constructors

WithIndex Integer
WithName Text	focus on a frame by name or ID
WithElement Element	focus on a frame Element
DefaultFrame	focus on the first frame, or the main document if iframes are used.

Instances

Eq FrameSelector
Read FrameSelector
Show FrameSelector
ToJSON FrameSelector

Cookies

data Cookie Source

Cookies are delicious delicacies. When sending cookies to the server, a value of Nothing indicates that the server should use a default value. When receiving cookies from the server, a value of Nothing indicates that the server is unable to specify the value.

Constructors

Cookie
Fields cookName :: Text cookValue :: Text cookPath :: Maybe Text path of this cookie. if Nothing, defaults to / cookDomain :: Maybe Text domain of this cookie. if Nothing, the current pages domain is used cookSecure :: Maybe Bool Is this cookie secure? cookExpiry :: Maybe Integer Expiry date expressed as seconds since the Unix epoch Nothing indicates that the cookie never expires

mkCookie :: Text -> Text -> Cookie Source

Creates a Cookie with only a name and value specified. All other fields are set to Nothing, which tells the server to use default values.

cookies :: WD [Cookie]Source

Retrieve all cookies visible to the current page.

setCookie :: Cookie -> WD ()Source

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

deleteCookie :: Cookie -> WD ()Source

Delete a cookie. This will do nothing is the cookie isn't visible to the current page.

deleteVisibleCookies :: WD ()Source

Delete all visible cookies on the current page.

Alerts

getAlertText :: WD Text Source

Get the text of an alert dialog.

replyToAlert :: Text -> WD ()Source

Sends keystrokes to Javascript prompt() dialog.

acceptAlert :: WD ()Source

Accepts the currently displayed alert dialog.

dismissAlert :: WD ()Source

Dismisses the currently displayed alert dialog.

Mouse gestures

moveTo :: (Int, Int) -> WD ()Source

Moves the mouse to the given position relative to the active element.

moveToCenter :: Element -> WD ()Source

Moves the mouse to the center of a given element.

moveToFrom :: (Int, Int) -> Element -> WD ()Source

Moves the mouse to the given position relative to the given element.

clickWith :: MouseButton -> WD ()Source

Click at the current mouse position with the given mouse button.

data MouseButton Source

A mouse button

Constructors

LeftButton
MiddleButton
RightButton

Instances

Bounded MouseButton
Enum MouseButton
Eq MouseButton
Ord MouseButton
Show MouseButton
ToJSON MouseButton
FromJSON MouseButton

mouseDown :: WD ()Source

Press and hold the left mouse button down. Note that undefined behavior occurs if the next mouse command is not mouseUp.

mouseUp :: WD ()Source

Release the left mouse button.

withMouseDown :: WD a -> WD aSource

Perform the given action with the left mouse button held down. The mouse is automatically released afterwards.

doubleClick :: WD ()Source

Double click at the current mouse location.

Screen orientation

data Orientation Source

A screen orientation

Constructors

Landscape
Portrait

Instances

Bounded Orientation
Enum Orientation
Eq Orientation
Ord Orientation
Show Orientation
ToJSON Orientation
FromJSON Orientation

getOrientation :: WD Orientation Source

Get the current screen orientation for rotatable display devices.

setOrientation :: Orientation -> WD ()Source

Set the current screen orientation for rotatable display devices.

Geo-location

getLocation :: WD (Int, Int, Int)Source

Get the current geographical location of the device.

setLocation :: (Int, Int, Int) -> WD ()Source

Set the current geographical location of the device.

HTML 5 Web Storage

storageSize :: WebStorageType -> WD Integer Source

Get the current number of keys in a web storage area.

getAllKeys :: WebStorageType -> WD [Text]Source

Get a list of all keys from a web storage area.

deleteAllKeys :: WebStorageType -> WD ()Source

Delete all keys within a given web storage area.

getKey :: WebStorageType -> Text -> WD Text Source

Get the value associated with a key in the given web storage area. Unset keys result in empty strings, since the Web Storage spec makes no distinction between the empty string and an undefined value.

setKey :: WebStorageType -> Text -> Text -> WD Text Source

Set a key in the given web storage area.

deleteKey :: WebStorageType -> Text -> WD ()Source

Delete a key in the given web storage area.

Uploading files to remote server

These functions allow you to upload a file to a remote server. Note that this operation isn't supported by all WebDriver servers, and the location where the file is stored is not standardized.

uploadFile :: FilePath -> WD ()Source

Uploads a file from the local filesystem by its file path.

uploadRawFile Source

Arguments

:: FilePath	File path to use with this bytestring.
-> Integer	Modification time (in seconds since Unix epoch).
-> ByteString	The file contents as a lazy ByteString
-> WD ()

Uploads a raw bytestring with associated file info.

uploadZipEntry :: Entry -> WD ()Source

Lowest level interface to the file uploading mechanism. This allows you to specify the exact details of the zip entry sent across network.

Touch gestures

touchClick :: Element -> WD ()Source

Single tap on the touch screen at the given element's location.

touchDown :: (Int, Int) -> WD ()Source

Emulates pressing a finger down on the screen at the given location.

touchUp :: (Int, Int) -> WD ()Source

Emulates removing a finger from the screen at the given location.

touchMove :: (Int, Int) -> WD ()Source

Emulates moving a finger on the screen to the given location.

touchScroll :: (Int, Int) -> WD ()Source

Emulate finger-based touch scroll. Use this function if you don't care where the scroll begins

touchScrollFrom :: (Int, Int) -> Element -> WD ()Source

Emulate finger-based touch scroll, starting from the given location relative to the given element.

touchDoubleClick :: Element -> WD ()Source

Emulate a double click on a touch device.

touchLongClick :: Element -> WD ()Source

Emulate a long click on a touch device.

touchFlick :: (Int, Int) -> WD ()Source

Emulate a flick on the touch screen. The coordinates indicate x and y velocity, respectively. Use this function if you don't care where the flick starts.

touchFlickFrom Source

Arguments

:: Int	flick velocity
-> (Int, Int)	a location relative to the given element
-> Element	the given element
-> WD ()

Emulate a flick on the touch screen.

IME support

availableIMEEngines :: WD [Text]Source

activeIMEEngine :: WD Text Source

checkIMEActive :: WD Bool Source

activateIME :: Text -> WD ()Source

deactivateIME :: WD ()Source

Server information

serverStatus :: WD Value Source

Get information from the server as a JSON Object. For more information about this object see http://code.google.com/p/selenium/wiki/JsonWireProtocol#/status

Eq Cookie
Show Cookie
ToJSON Cookie
FromJSON Cookie