Copyright	2018 Automattic Inc.
License	GPL-3
Maintainer	Nathan Bloomfield (nbloomf@gmail.com)
Stability	experimental
Portability	POSIX
Safe Haskell	None
Language	Haskell2010

Web.Api.WebDriver.Endpoints

Contents

Sessions
Navigation
Command Contexts
Element Retrieval
Element State
Element Interaction
Document Handling
Cookies
Actions
- Perform Actions
- Release Actions
User Prompts
Screen Capture
- Take Screenshot
- Take Element Screenshot

Description

These bindings try to stick as closely to the spec as possible. We use the following conventions.

The Stealth suffix on a function indicates that it does not log request or response data (but it does log that a request/response occurred).
A prime (') on a POST function name indicates that it takes an additional function parameter that mutates the payload after it is converted to JSON, but before sending the request. This is a cheap way to future-proof the bindings and accommodate nonstandard request parameters.

The most recent version of the spec is available at https://w3c.github.io/webdriver/webdriver-spec.html.

Synopsis

Documentation

runIsolated :: Monad m => Capabilities -> WebDriverT m a -> WebDriverT m () Source #

Run a WebDriver computation in an isolated browser session. Ensures that the session is closed on the remote end.

Sessions

New Session

newSession :: Monad m => Capabilities -> WebDriverT m SessionId Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#new-session. For an extensible version allowing arbitrary changes to the JSON value representing the Capabilities parameter, see newSession'.

newSession' :: Monad m => (Value -> Value) -> Capabilities -> WebDriverT m SessionId Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#new-session. This generalizes newSession' by taking an additional function Value -> Value that is applied to the Capabilities parameter after it is converted to JSON, but before it is passed to the HTTP call.

Delete Session

deleteSession :: Monad m => WebDriverT m () Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#delete-session.

Status

sessionStatus :: Monad m => WebDriverT m (Bool, String) Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#status.

Get Timeouts

getTimeouts :: Monad m => WebDriverT m TimeoutConfig Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#get-timeouts.

Set Timeouts

setTimeouts :: Monad m => TimeoutConfig -> WebDriverT m () Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#set-timeouts.

Navigation

Navigate To

navigateTo :: Monad m => Url -> WebDriverT m () Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#navigate-to. To access this enpoint without logging the request or the result, use navigateToStealth.

navigateToStealth :: Monad m => Url -> WebDriverT m () Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#navigate-to. This function does not log the request or response; if you do want the interaction logged, use navigateTo.

Get Current URL

getCurrentUrl :: Monad m => WebDriverT m Url Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#get-current-url.

Go Back

goBack :: Monad m => WebDriverT m () Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#back.

Go Forward

goForward :: Monad m => WebDriverT m () Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#forward.

Page Refresh

pageRefresh :: Monad m => WebDriverT m () Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#refresh.

Get Title

getTitle :: Monad m => WebDriverT m String Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#get-title.

Command Contexts

Get Window Handle

getWindowHandle :: Monad m => WebDriverT m ContextId Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#get-window-handle.

Close Window

closeWindow :: Monad m => WebDriverT m [ContextId] Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#close-window.

Switch To Window

switchToWindow :: (Monad m, HasContextId t) => t -> WebDriverT m () Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#switch-to-window.

Get Window Handles

getWindowHandles :: Monad m => WebDriverT m [ContextId] Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#get-window-handles.

Switch To Frame

switchToFrame :: Monad m => FrameReference -> WebDriverT m () Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#switch-to-frame.

Switch To Parent Frame

switchToParentFrame :: Monad m => WebDriverT m () Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#switch-to-parent-frame.

Get Window Rect

getWindowRect :: Monad m => WebDriverT m Rect Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#get-window-rect.

Set Window Rect

setWindowRect :: Monad m => Rect -> WebDriverT m Rect Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#set-window-rect.

Maximize Window

maximizeWindow :: Monad m => WebDriverT m Rect Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#maximize-window.

Minimize Window

minimizeWindow :: Monad m => WebDriverT m Rect Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#minimize-window.

Fullscreen Window

fullscreenWindow :: Monad m => WebDriverT m Rect Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#fullscreen-window.

Element Retrieval

Find Element

findElement :: Monad m => LocationStrategy -> Selector -> WebDriverT m ElementRef Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#find-element.

Find Elements

findElements :: Monad m => LocationStrategy -> Selector -> WebDriverT m [ElementRef] Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#find-elements.

Find Element From Element

findElementFromElement :: (Monad m, HasElementRef t) => LocationStrategy -> Selector -> t -> WebDriverT m ElementRef Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#find-element-from-element.

Find Elements From Element

findElementsFromElement :: (Monad m, HasElementRef t) => LocationStrategy -> Selector -> t -> WebDriverT m [ElementRef] Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#find-elements-from-element.

Get Active Element

getActiveElement :: Monad m => WebDriverT m ElementRef Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#get-active-element.

Element State

Is Element Selected

isElementSelected :: (Monad m, HasElementRef t) => t -> WebDriverT m Bool Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#is-element-selected.

Get Element Attribute

getElementAttribute :: (Monad m, HasElementRef t) => t -> AttributeName -> WebDriverT m (Either Bool String) Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#get-element-attribute.

Get Element Property

getElementProperty :: (Monad m, HasElementRef t) => t -> PropertyName -> WebDriverT m Value Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#get-element-property.

Get Element CSS Value

getElementCssValue :: (Monad m, HasElementRef t) => t -> CssPropertyName -> WebDriverT m String Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#get-element-css-value.

Get Element Text

getElementText :: (Monad m, HasElementRef t) => t -> WebDriverT m String Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#get-element-text.

Get Element Tag Name

getElementTagName :: (Monad m, HasElementRef t) => t -> WebDriverT m String Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#get-element-tag-name.

Get Element Rect

getElementRect :: (Monad m, HasElementRef t) => t -> WebDriverT m Rect Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#get-element-rect.

Is Element Enabled

isElementEnabled :: (Monad m, HasElementRef t) => t -> WebDriverT m Bool Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#is-element-enabled.

Element Interaction

Element Click

elementClick :: (Monad m, HasElementRef t) => t -> WebDriverT m () Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#element-click.

Element Clear

elementClear :: (Monad m, HasElementRef t) => t -> WebDriverT m () Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#element-clear.

Element Send Keys

elementSendKeys :: (Monad m, HasElementRef t) => t -> String -> WebDriverT m () Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#element-send-keys.

Document Handling

Get Page Source

getPageSource :: Monad m => WebDriverT m String Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#get-page-source.

getPageSourceStealth :: Monad m => WebDriverT m String Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#get-page-source. Does not dump the page source into the logs. :)

Execute Script

executeScript :: Monad m => Script -> [Value] -> WebDriverT m Value Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#execute-script.

Execute Async Script

executeAsyncScript :: Monad m => Script -> [Value] -> WebDriverT m Value Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#execute-async-script.

Cookies

Get All Cookies

getAllCookies :: Monad m => WebDriverT m [Cookie] Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#get-all-cookies.

Get Named Cookie

getNamedCookie :: Monad m => CookieName -> WebDriverT m Cookie Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#get-named-cookie.

Add Cookie

addCookie :: Monad m => Cookie -> WebDriverT m () Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#add-cookie.

Delete Cookie

deleteCookie :: Monad m => CookieName -> WebDriverT m () Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#delete-cookie.

Delete All Cookies

deleteAllCookies :: Monad m => WebDriverT m () Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#delete-all-cookies.

Actions

Perform Actions

performActions :: Monad m => [Action] -> WebDriverT m () Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#perform-actions. For a variant on this endpoint that does not log the request and response, see performActionsStealth.

performActionsStealth :: Monad m => [Action] -> WebDriverT m () Source #

See https://w3c.github.io/webdriver/webdriver-spec.html#perform-actions. This function is identical to performActions except that it does not log the request or response. Handy if the action includes secret info.