Web.Api.WebDriver.Endpoints

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.

Documentation

runIsolated :: (Monad eff, Monad (t eff), MonadTrans t) => Capabilities -> WebDriverTT t eff a -> WebDriverTT t eff ()

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

Sessions

New Session

newSession :: (Monad eff, Monad (t eff), MonadTrans t) => Capabilities -> WebDriverTT t eff SessionId

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 eff, Monad (t eff), MonadTrans t) => (Value -> Value) -> Capabilities -> WebDriverTT t eff SessionId

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 eff, Monad (t eff), MonadTrans t) => WebDriverTT t eff ()

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

Status

sessionStatus :: (Monad eff, Monad (t eff), MonadTrans t) => WebDriverTT t eff (Bool, String)

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

Get Timeouts

getTimeouts :: (Monad eff, Monad (t eff), MonadTrans t) => WebDriverTT t eff TimeoutConfig

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

Set Timeouts

setTimeouts :: (Monad eff, Monad (t eff), MonadTrans t) => TimeoutConfig -> WebDriverTT t eff ()

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

Navigation

Navigate To

navigateTo :: (Monad eff, Monad (t eff), MonadTrans t) => Url -> WebDriverTT t eff ()

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 eff, Monad (t eff), MonadTrans t) => Url -> WebDriverTT t eff ()

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 eff, Monad (t eff), MonadTrans t) => WebDriverTT t eff Url

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

Go Back

goBack :: (Monad eff, Monad (t eff), MonadTrans t) => WebDriverTT t eff ()

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

Go Forward

goForward :: (Monad eff, Monad (t eff), MonadTrans t) => WebDriverTT t eff ()

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

Page Refresh

pageRefresh :: (Monad eff, Monad (t eff), MonadTrans t) => WebDriverTT t eff ()

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

Get Title

getTitle :: (Monad eff, Monad (t eff), MonadTrans t) => WebDriverTT t eff String

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

Command Contexts

Get Window Handle

getWindowHandle :: (Monad eff, Monad (t eff), MonadTrans t) => WebDriverTT t eff ContextId

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

Close Window

closeWindow :: (Monad eff, Monad (t eff), MonadTrans t) => WebDriverTT t eff [ContextId]

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

Switch To Window

switchToWindow :: (Monad eff, Monad (t eff), MonadTrans t, HasContextId a) => a -> WebDriverTT t eff ()

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

Get Window Handles

getWindowHandles :: (Monad eff, Monad (t eff), MonadTrans t) => WebDriverTT t eff [ContextId]

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

Switch To Frame

switchToFrame :: (Monad eff, Monad (t eff), MonadTrans t) => FrameReference -> WebDriverTT t eff ()

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

Switch To Parent Frame

switchToParentFrame :: (Monad eff, Monad (t eff), MonadTrans t) => WebDriverTT t eff ()

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

Get Window Rect

getWindowRect :: (Monad eff, Monad (t eff), MonadTrans t) => WebDriverTT t eff Rect

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

Set Window Rect

setWindowRect :: (Monad eff, Monad (t eff), MonadTrans t) => Rect -> WebDriverTT t eff Rect

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

Maximize Window

maximizeWindow :: (Monad eff, Monad (t eff), MonadTrans t) => WebDriverTT t eff Rect

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

Minimize Window

minimizeWindow :: (Monad eff, Monad (t eff), MonadTrans t) => WebDriverTT t eff Rect

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

Fullscreen Window

fullscreenWindow :: (Monad eff, Monad (t eff), MonadTrans t) => WebDriverTT t eff Rect

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

Element Retrieval

Find Element

findElement :: (Monad eff, Monad (t eff), MonadTrans t) => LocationStrategy -> Selector -> WebDriverTT t eff ElementRef

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

Find Elements

findElements :: (Monad eff, Monad (t eff), MonadTrans t) => LocationStrategy -> Selector -> WebDriverTT t eff [ElementRef]

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

Find Element From Element

findElementFromElement :: (Monad eff, Monad (t eff), MonadTrans t, HasElementRef a) => LocationStrategy -> Selector -> a -> WebDriverTT t eff ElementRef

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

Find Elements From Element

findElementsFromElement :: (Monad eff, Monad (t eff), MonadTrans t, HasElementRef a) => LocationStrategy -> Selector -> a -> WebDriverTT t eff [ElementRef]

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

Get Active Element

getActiveElement :: (Monad eff, Monad (t eff), MonadTrans t) => WebDriverTT t eff ElementRef

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

Element State

Is Element Selected

isElementSelected :: (Monad eff, Monad (t eff), MonadTrans t, HasElementRef a) => a -> WebDriverTT t eff Bool

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

Get Element Attribute

getElementAttribute :: (Monad eff, Monad (t eff), MonadTrans t, HasElementRef a) => AttributeName -> a -> WebDriverTT t eff (Either Bool String)

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

Get Element Property

getElementProperty :: (Monad eff, Monad (t eff), MonadTrans t, HasElementRef a) => PropertyName -> a -> WebDriverTT t eff Value

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

Get Element CSS Value

getElementCssValue :: (Monad eff, Monad (t eff), MonadTrans t, HasElementRef a) => CssPropertyName -> a -> WebDriverTT t eff String

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

Get Element Text

getElementText :: (Monad eff, Monad (t eff), MonadTrans t, HasElementRef a) => a -> WebDriverTT t eff String

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

Get Element Tag Name

getElementTagName :: (Monad eff, Monad (t eff), MonadTrans t, HasElementRef a) => a -> WebDriverTT t eff String

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

Get Element Rect

getElementRect :: (Monad eff, Monad (t eff), MonadTrans t, HasElementRef a) => a -> WebDriverTT t eff Rect

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

Is Element Enabled

isElementEnabled :: (Monad eff, Monad (t eff), MonadTrans t, HasElementRef a) => a -> WebDriverTT t eff Bool

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

Element Interaction

Element Click

elementClick :: (Monad eff, Monad (t eff), MonadTrans t, HasElementRef a) => a -> WebDriverTT t eff ()

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

Element Clear

elementClear :: (Monad eff, Monad (t eff), MonadTrans t, HasElementRef a) => a -> WebDriverTT t eff ()

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

Element Send Keys

elementSendKeys :: (Monad eff, Monad (t eff), MonadTrans t, HasElementRef a) => String -> a -> WebDriverTT t eff ()

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

Document Handling

Get Page Source

getPageSource :: (Monad eff, Monad (t eff), MonadTrans t) => WebDriverTT t eff String

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

getPageSourceStealth :: (Monad eff, Monad (t eff), MonadTrans t) => WebDriverTT t eff String

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 eff, Monad (t eff), MonadTrans t) => Script -> [Value] -> WebDriverTT t eff Value

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

Execute Async Script

executeAsyncScript :: (Monad eff, Monad (t eff), MonadTrans t) => Script -> [Value] -> WebDriverTT t eff Value

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

Cookies

Get All Cookies

getAllCookies :: (Monad eff, Monad (t eff), MonadTrans t) => WebDriverTT t eff [Cookie]

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

Get Named Cookie

getNamedCookie :: (Monad eff, Monad (t eff), MonadTrans t) => CookieName -> WebDriverTT t eff Cookie

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

Add Cookie

addCookie :: (Monad eff, Monad (t eff), MonadTrans t) => Cookie -> WebDriverTT t eff ()

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

Delete Cookie

deleteCookie :: (Monad eff, Monad (t eff), MonadTrans t) => CookieName -> WebDriverTT t eff ()

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

Delete All Cookies

deleteAllCookies :: (Monad eff, Monad (t eff), MonadTrans t) => WebDriverTT t eff ()

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

Actions

Perform Actions

performActions :: (Monad eff, Monad (t eff), MonadTrans t) => [Action] -> WebDriverTT t eff ()

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 eff, Monad (t eff), MonadTrans t) => [Action] -> WebDriverTT t eff ()

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.

Release Actions

releaseActions :: (Monad eff, Monad (t eff), MonadTrans t) => WebDriverTT t eff ()

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

User Prompts

Dismiss Alert

dismissAlert :: (Monad eff, Monad (t eff), MonadTrans t) => WebDriverTT t eff ()

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

Accept Alert

acceptAlert :: (Monad eff, Monad (t eff), MonadTrans t) => WebDriverTT t eff ()

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

Get Alert Text

getAlertText :: (Monad eff, Monad (t eff), MonadTrans t) => WebDriverTT t eff (Maybe String)

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

Send Alert Text

sendAlertText :: (Monad eff, Monad (t eff), MonadTrans t) => String -> WebDriverTT t eff ()

See https://w3c.github.io/webdriver/webdriver-spec.html#send-alert-text.

Screen Capture

Take Screenshot

takeScreenshot :: (Monad eff, Monad (t eff), MonadTrans t) => WebDriverTT t eff ByteString

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

Take Element Screenshot

takeElementScreenshot :: (Monad eff, Monad (t eff), MonadTrans t, HasElementRef a) => a -> WebDriverTT t eff ByteString

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

_WEB_ELEMENT_ID :: Text

Spec-defined "web element identifier" string constant. See https://w3c.github.io/webdriver/webdriver-spec.html#elements.

_WEB_WINDOW_ID :: Text

Spec-defined "web window identifier" string constant. See https://w3c.github.io/webdriver/webdriver-spec.html#command-contexts.

_WEB_FRAME_ID :: Text

Spec-defined "web frame identifier" string constant. See https://w3c.github.io/webdriver/webdriver-spec.html#command-contexts.