Test.WebDriver.Commands

This module exports basic WD actions that can be used to interact with a browser session.

Sessions

createSession :: (HasCallStack, WebDriver wd) => Capabilities -> wd WDSession

Create a new session with the given Capabilities. The returned session becomes the "current session" for this action.

Note: if you're using runSession to run your WebDriver commands, you don't need to call this explicitly.

closeSession :: (HasCallStack, WebDriver wd) => wd ()

Close the current session and the browser associated with it.

sessions :: (HasCallStack, WebDriver wd) => wd [(SessionId, Capabilities)]

Retrieve a list of active sessions and their Capabilities.

getActualCaps :: (HasCallStack, WebDriver wd) => wd Capabilities

Get the actual server-side Capabilities of the current session.

Browser interaction

Web navigation

openPage :: (HasCallStack, WebDriver wd) => String -> wd ()

Opens a new page by the given URL.

forward :: (HasCallStack, WebDriver wd) => wd ()

Navigate forward in the browser history.

back :: (HasCallStack, WebDriver wd) => wd ()

Navigate backward in the browser history.

refresh :: (HasCallStack, WebDriver wd) => wd ()

Refresh the current page

Page info

getCurrentURL :: (HasCallStack, WebDriver wd) => wd String

Gets the URL of the current page.

getSource :: (HasCallStack, WebDriver wd) => wd Text

Get the current page source

getTitle :: (HasCallStack, WebDriver wd) => wd Text

Get the title of the current page.

saveScreenshot :: (HasCallStack, WebDriver wd) => FilePath -> wd ()

Save a screenshot to a particular location

screenshot :: (HasCallStack, WebDriver wd) => wd ByteString

Grab a screenshot of the current page as a PNG image

screenshotBase64 :: (HasCallStack, WebDriver wd) => wd ByteString

Grab a screenshot as a base-64 encoded PNG image. This is the protocol-defined format.

Timeouts

setImplicitWait :: (HasCallStack, WebDriver wd) => Integer -> wd ()

Sets the amount of time (ms) we implicitly wait when searching for elements.

setScriptTimeout :: (HasCallStack, WebDriver wd) => Integer -> wd ()

Sets the amount of time (ms) we wait for an asynchronous script to return a result.

setPageLoadTimeout :: (HasCallStack, WebDriver wd) => Integer -> wd ()

Sets the amount of time (ms) to wait for a page to finish loading before throwing a Timeout exception.

Web elements

newtype Element

An opaque identifier for a web page element.

Constructors

Element Text

Instances

FromJSON Element

Defined in Test.WebDriver.Commands.Internal

Methods

parseJSON :: Value -> Parser Element

parseJSONList :: Value -> Parser [Element]

omittedField :: Maybe Element

ToJSON Element

Defined in Test.WebDriver.Commands.Internal

Methods

toJSON :: Element -> Value

toEncoding :: Element -> Encoding

toJSONList :: [Element] -> Value

toEncodingList :: [Element] -> Encoding

omitField :: Element -> Bool

Read Element

Defined in Test.WebDriver.Commands.Internal

Methods

readsPrec :: Int -> ReadS Element

readList :: ReadS [Element]

readPrec :: ReadPrec Element

readListPrec :: ReadPrec [Element]

Show Element

Defined in Test.WebDriver.Commands.Internal

Methods

showsPrec :: Int -> Element -> ShowS

show :: Element -> String

showList :: [Element] -> ShowS

Eq Element

Defined in Test.WebDriver.Commands.Internal

Methods

(==) :: Element -> Element -> Bool

(/=) :: Element -> Element -> Bool

Ord Element

Defined in Test.WebDriver.Commands.Internal

Methods

compare :: Element -> Element -> Ordering

(<) :: Element -> Element -> Bool

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

(>) :: Element -> Element -> Bool

(>=) :: Element -> Element -> Bool

max :: Element -> Element -> Element

min :: Element -> Element -> Element

data Selector

Specifies element(s) within a DOM tree using various selection methods.

Constructors

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

ToJSON Selector

Defined in Test.WebDriver.Commands

Methods

toJSON :: Selector -> Value

toEncoding :: Selector -> Encoding

toJSONList :: [Selector] -> Value

toEncodingList :: [Selector] -> Encoding

omitField :: Selector -> Bool

Show Selector

Defined in Test.WebDriver.Commands

Methods

showsPrec :: Int -> Selector -> ShowS

show :: Selector -> String

showList :: [Selector] -> ShowS

Eq Selector

Defined in Test.WebDriver.Commands

Methods

(==) :: Selector -> Selector -> Bool

(/=) :: Selector -> Selector -> Bool

Ord Selector

Defined in Test.WebDriver.Commands

Methods

compare :: Selector -> Selector -> Ordering

(<) :: Selector -> Selector -> Bool

(<=) :: Selector -> Selector -> Bool

(>) :: Selector -> Selector -> Bool

(>=) :: Selector -> Selector -> Bool

max :: Selector -> Selector -> Selector

min :: Selector -> Selector -> Selector

Searching for elements

findElem :: (HasCallStack, WebDriver wd) => Selector -> wd Element

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

findElems :: (HasCallStack, WebDriver wd) => Selector -> wd [Element]

Find all elements on the page matching the given selector.

findElemFrom :: (HasCallStack, WebDriver wd) => Element -> Selector -> wd Element

Search for an element using the given element as root.

findElemsFrom :: (HasCallStack, WebDriver wd) => Element -> Selector -> wd [Element]

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

Interacting with elements

click :: (HasCallStack, WebDriver wd) => Element -> wd ()

Click on an element.

submit :: (HasCallStack, WebDriver wd) => Element -> wd ()

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

getText :: (HasCallStack, WebDriver wd) => Element -> wd Text

Get all visible text within this element.

Sending key inputs to elements

sendKeys :: (HasCallStack, WebDriver wd) => Text -> Element -> wd ()

Send a sequence of keystrokes to an element. All modifier keys are released at the end of the function. Named constants for special modifier keys can be found in Test.WebDriver.Common.Keys

sendRawKeys :: (HasCallStack, WebDriver wd) => Text -> wd ()

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

clearInput :: (HasCallStack, WebDriver wd) => Element -> wd ()

Clear a textarea or text input element's value.

Element information

attr :: (HasCallStack, WebDriver wd) => Element -> Text -> wd (Maybe Text)

Retrieve the value of an element's attribute

cssProp :: (HasCallStack, WebDriver wd) => Element -> Text -> wd (Maybe Text)

Retrieve the value of an element's computed CSS property

elemPos :: (HasCallStack, WebDriver wd) => Element -> wd (Float, Float)

Retrieve an element's current position.

elemSize :: (HasCallStack, WebDriver wd) => Element -> wd (Float, Float)

Retrieve an element's current size.

isSelected :: (HasCallStack, WebDriver wd) => Element -> wd Bool

Determine if the element is selected.

isEnabled :: (HasCallStack, WebDriver wd) => Element -> wd Bool

Determine if the element is enabled.

isDisplayed :: (HasCallStack, WebDriver wd) => Element -> wd Bool

Determine if the element is displayed.

tagName :: (HasCallStack, WebDriver wd) => Element -> wd Text

Return the tag name of the given element.

activeElem :: (HasCallStack, WebDriver wd) => wd Element

Return the element that currently has focus.

elemInfo :: (HasCallStack, WebDriver wd) => Element -> wd Value

Deprecated: This command does not work with Marionette (Firefox) driver, and is likely to be completely removed in Selenium 4

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

Element equality

(<==>) :: (HasCallStack, WebDriver wd) => Element -> Element -> wd Bool infix 4

Determines if two element identifiers refer to the same element.

(</=>) :: (HasCallStack, WebDriver wd) => Element -> Element -> wd Bool infix 4

Determines if two element identifiers refer to different elements.

Javascript

executeJS :: (Foldable f, FromJSON a, WebDriver wd) => f JSArg -> Text -> wd a

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 a sequence of 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.

When using executeJS, GHC might complain about an ambiguous type in situations where the result of the executeJS call is ignored/discard. Consider the following example:

	jsExample = do
		e <- findElem (ById "foo")
		executeJS [] "someAction()"
		return e

Because the result of the executeJS is discarded, GHC cannot resolve which instance of the fromJSON class to use when parsing the Selenium server response. In such cases, we can use the ignoreReturn helper function located in Test.WebDriver.JSON. ignoreReturn has no runtime effect; it simply helps the type system by expicitly providing a fromJSON instance to use.

	import Test.WebDriver.JSON (ignoreReturn)
	jsExample = do
		e <- findElem (ById "foo")
		ignoreReturn $ executeJS [] "someAction()"
		return e

asyncJS :: (HasCallStack, Foldable f, FromJSON a, WebDriver wd) => f JSArg -> Text -> wd (Maybe a)

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

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

Defined in Test.WebDriver.Commands

Methods

toJSON :: JSArg -> Value

toEncoding :: JSArg -> Encoding

toJSONList :: [JSArg] -> Value

toEncodingList :: [JSArg] -> Encoding

omitField :: JSArg -> Bool

Windows

newtype WindowHandle

An opaque identifier for a browser window

Constructors

WindowHandle Text

Instances

FromJSON WindowHandle

Defined in Test.WebDriver.Commands.Internal

Methods

parseJSON :: Value -> Parser WindowHandle

parseJSONList :: Value -> Parser [WindowHandle]

omittedField :: Maybe WindowHandle

ToJSON WindowHandle

Defined in Test.WebDriver.Commands.Internal

Methods

toJSON :: WindowHandle -> Value

toEncoding :: WindowHandle -> Encoding

toJSONList :: [WindowHandle] -> Value

toEncodingList :: [WindowHandle] -> Encoding

omitField :: WindowHandle -> Bool

Read WindowHandle

Defined in Test.WebDriver.Commands.Internal

Methods

readsPrec :: Int -> ReadS WindowHandle

readList :: ReadS [WindowHandle]

readPrec :: ReadPrec WindowHandle

readListPrec :: ReadPrec [WindowHandle]

Show WindowHandle

Defined in Test.WebDriver.Commands.Internal

Methods

showsPrec :: Int -> WindowHandle -> ShowS

show :: WindowHandle -> String

showList :: [WindowHandle] -> ShowS

Default WindowHandle

Defined in Test.WebDriver.Commands.Internal

Methods

def :: WindowHandle

Eq WindowHandle

Defined in Test.WebDriver.Commands.Internal

Methods

(==) :: WindowHandle -> WindowHandle -> Bool

(/=) :: WindowHandle -> WindowHandle -> Bool

Ord WindowHandle

Defined in Test.WebDriver.Commands.Internal

Methods

compare :: WindowHandle -> WindowHandle -> Ordering

(<) :: WindowHandle -> WindowHandle -> Bool

(<=) :: WindowHandle -> WindowHandle -> Bool

(>) :: WindowHandle -> WindowHandle -> Bool

(>=) :: WindowHandle -> WindowHandle -> Bool

max :: WindowHandle -> WindowHandle -> WindowHandle

min :: WindowHandle -> WindowHandle -> WindowHandle

currentWindow :: WindowHandle

A special WindowHandle that always refers to the currently focused window. This is also used by the Default instance.

getCurrentWindow :: (HasCallStack, WebDriver wd) => wd WindowHandle

Returns a handle to the currently focused window

closeWindow :: (HasCallStack, WebDriver wd) => WindowHandle -> wd ()

Closes the given window

windows :: (HasCallStack, WebDriver wd) => wd [WindowHandle]

Returns a list of all windows available to the session

focusWindow :: (HasCallStack, WebDriver wd) => WindowHandle -> wd ()

maximize :: (HasCallStack, WebDriver wd) => wd ()

Maximizes the current window if not already maximized

getWindowSize :: (HasCallStack, WebDriver wd) => wd (Word, Word)

Get the dimensions of the current window.

setWindowSize :: (HasCallStack, WebDriver wd) => (Word, Word) -> wd ()

Set the dimensions of the current window.

getWindowPos :: (HasCallStack, WebDriver wd) => wd (Int, Int)

Get the coordinates of the current window.

setWindowPos :: (HasCallStack, WebDriver wd) => (Int, Int) -> wd ()

Set the coordinates of the current window.

Focusing on frames

focusFrame :: (HasCallStack, WebDriver wd) => FrameSelector -> wd ()

Switch focus to the frame specified by the FrameSelector.

data FrameSelector

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

ToJSON FrameSelector

Defined in Test.WebDriver.Commands

Methods

toJSON :: FrameSelector -> Value

toEncoding :: FrameSelector -> Encoding

toJSONList :: [FrameSelector] -> Value

toEncodingList :: [FrameSelector] -> Encoding

omitField :: FrameSelector -> Bool

Read FrameSelector

Defined in Test.WebDriver.Commands

Methods

readsPrec :: Int -> ReadS FrameSelector

readList :: ReadS [FrameSelector]

readPrec :: ReadPrec FrameSelector

readListPrec :: ReadPrec [FrameSelector]

Show FrameSelector

Defined in Test.WebDriver.Commands

Methods

showsPrec :: Int -> FrameSelector -> ShowS

show :: FrameSelector -> String

showList :: [FrameSelector] -> ShowS

Eq FrameSelector

Defined in Test.WebDriver.Commands

Methods

(==) :: FrameSelector -> FrameSelector -> Bool

(/=) :: FrameSelector -> FrameSelector -> Bool

Cookies

data Cookie

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 Double

  Expiry date expressed as seconds since the Unix epoch Nothing indicates that the cookie never expires

Instances

FromJSON Cookie

Defined in Test.WebDriver.Cookies

Methods

parseJSON :: Value -> Parser Cookie

parseJSONList :: Value -> Parser [Cookie]

omittedField :: Maybe Cookie

ToJSON Cookie

Defined in Test.WebDriver.Cookies

Methods

toJSON :: Cookie -> Value

toEncoding :: Cookie -> Encoding

toJSONList :: [Cookie] -> Value

toEncodingList :: [Cookie] -> Encoding

omitField :: Cookie -> Bool

Generic Cookie

Defined in Test.WebDriver.Cookies

Associated Types

type Rep Cookie :: Type -> Type

Methods

from :: Cookie -> Rep Cookie x

to :: Rep Cookie x -> Cookie

Show Cookie

Defined in Test.WebDriver.Cookies

Methods

showsPrec :: Int -> Cookie -> ShowS

show :: Cookie -> String

showList :: [Cookie] -> ShowS

Eq Cookie

Defined in Test.WebDriver.Cookies

Methods

(==) :: Cookie -> Cookie -> Bool

(/=) :: Cookie -> Cookie -> Bool

type Rep Cookie

Defined in Test.WebDriver.Cookies

type Rep Cookie = D1 ('MetaData "Cookie" "Test.WebDriver.Cookies" "webdriver-0.12.0.1-8JmazsyRpy7L97LhpPVxVb" 'False) (C1 ('MetaCons "Cookie" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cookName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "cookValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "cookPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "cookDomain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "cookSecure") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "cookExpiry") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Double))))))

mkCookie :: Text -> Text -> Cookie

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 :: (HasCallStack, WebDriver wd) => wd [Cookie]

Retrieve all cookies visible to the current page.

setCookie :: (HasCallStack, WebDriver wd) => Cookie -> wd ()

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 :: (HasCallStack, WebDriver wd) => Cookie -> wd ()

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

deleteVisibleCookies :: (HasCallStack, WebDriver wd) => wd ()

Delete all visible cookies on the current page.

deleteCookieByName :: (HasCallStack, WebDriver wd) => Text -> wd ()

Alerts

getAlertText :: (HasCallStack, WebDriver wd) => wd Text

Get the text of an alert dialog.

replyToAlert :: (HasCallStack, WebDriver wd) => Text -> wd ()

Sends keystrokes to Javascript prompt() dialog.

acceptAlert :: (HasCallStack, WebDriver wd) => wd ()

Accepts the currently displayed alert dialog.

dismissAlert :: (HasCallStack, WebDriver wd) => wd ()

Dismisses the currently displayed alert dialog.

Mouse gestures

moveTo :: (HasCallStack, WebDriver wd) => (Int, Int) -> wd ()

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

moveToCenter :: (HasCallStack, WebDriver wd) => Element -> wd ()

Moves the mouse to the center of a given element.

moveToFrom :: (HasCallStack, WebDriver wd) => (Int, Int) -> Element -> wd ()

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

clickWith :: (HasCallStack, WebDriver wd) => MouseButton -> wd ()

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

data MouseButton

A mouse button

Constructors

LeftButton

MiddleButton

RightButton

Instances

FromJSON MouseButton

Defined in Test.WebDriver.Commands

Methods

parseJSON :: Value -> Parser MouseButton

parseJSONList :: Value -> Parser [MouseButton]

omittedField :: Maybe MouseButton

ToJSON MouseButton

Defined in Test.WebDriver.Commands

Methods

toJSON :: MouseButton -> Value

toEncoding :: MouseButton -> Encoding

toJSONList :: [MouseButton] -> Value

toEncodingList :: [MouseButton] -> Encoding

omitField :: MouseButton -> Bool

Bounded MouseButton

Defined in Test.WebDriver.Commands

Methods

minBound :: MouseButton

maxBound :: MouseButton

Enum MouseButton

Defined in Test.WebDriver.Commands

Methods

succ :: MouseButton -> MouseButton

pred :: MouseButton -> MouseButton

toEnum :: Int -> MouseButton

fromEnum :: MouseButton -> Int

enumFrom :: MouseButton -> [MouseButton]

enumFromThen :: MouseButton -> MouseButton -> [MouseButton]

enumFromTo :: MouseButton -> MouseButton -> [MouseButton]

enumFromThenTo :: MouseButton -> MouseButton -> MouseButton -> [MouseButton]

Show MouseButton

Defined in Test.WebDriver.Commands

Methods

showsPrec :: Int -> MouseButton -> ShowS

show :: MouseButton -> String

showList :: [MouseButton] -> ShowS

Eq MouseButton

Defined in Test.WebDriver.Commands

Methods

(==) :: MouseButton -> MouseButton -> Bool

(/=) :: MouseButton -> MouseButton -> Bool

Ord MouseButton

Defined in Test.WebDriver.Commands

Methods

compare :: MouseButton -> MouseButton -> Ordering

(<) :: MouseButton -> MouseButton -> Bool

(<=) :: MouseButton -> MouseButton -> Bool

(>) :: MouseButton -> MouseButton -> Bool

(>=) :: MouseButton -> MouseButton -> Bool

max :: MouseButton -> MouseButton -> MouseButton

min :: MouseButton -> MouseButton -> MouseButton

mouseDown :: (HasCallStack, WebDriver wd) => wd ()

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

mouseUp :: (HasCallStack, WebDriver wd) => wd ()

Release the left mouse button.

withMouseDown :: (HasCallStack, WebDriver wd) => wd a -> wd a

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

doubleClick :: (HasCallStack, WebDriver wd) => wd ()

Double click at the current mouse location.

HTML 5 Web Storage

data WebStorageType

An HTML 5 storage type

Constructors

LocalStorage

SessionStorage

Instances

Bounded WebStorageType

Defined in Test.WebDriver.Commands

Methods

minBound :: WebStorageType

maxBound :: WebStorageType

Enum WebStorageType

Defined in Test.WebDriver.Commands

Methods

succ :: WebStorageType -> WebStorageType

pred :: WebStorageType -> WebStorageType

toEnum :: Int -> WebStorageType

fromEnum :: WebStorageType -> Int

enumFrom :: WebStorageType -> [WebStorageType]

enumFromThen :: WebStorageType -> WebStorageType -> [WebStorageType]

enumFromTo :: WebStorageType -> WebStorageType -> [WebStorageType]

enumFromThenTo :: WebStorageType -> WebStorageType -> WebStorageType -> [WebStorageType]

Show WebStorageType

Defined in Test.WebDriver.Commands

Methods

showsPrec :: Int -> WebStorageType -> ShowS

show :: WebStorageType -> String

showList :: [WebStorageType] -> ShowS

Eq WebStorageType

Defined in Test.WebDriver.Commands

Methods

(==) :: WebStorageType -> WebStorageType -> Bool

(/=) :: WebStorageType -> WebStorageType -> Bool

Ord WebStorageType

Defined in Test.WebDriver.Commands

Methods

compare :: WebStorageType -> WebStorageType -> Ordering

(<) :: WebStorageType -> WebStorageType -> Bool

(<=) :: WebStorageType -> WebStorageType -> Bool

(>) :: WebStorageType -> WebStorageType -> Bool

(>=) :: WebStorageType -> WebStorageType -> Bool

max :: WebStorageType -> WebStorageType -> WebStorageType

min :: WebStorageType -> WebStorageType -> WebStorageType

storageSize :: (HasCallStack, WebDriver wd) => WebStorageType -> wd Integer

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

getAllKeys :: (HasCallStack, WebDriver wd) => WebStorageType -> wd [Text]

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

deleteAllKeys :: (HasCallStack, WebDriver wd) => WebStorageType -> wd ()

Delete all keys within a given web storage area.

getKey :: (HasCallStack, WebDriver wd) => WebStorageType -> Text -> wd Text

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 :: (HasCallStack, WebDriver wd) => WebStorageType -> Text -> Text -> wd Text

Set a key in the given web storage area.

deleteKey :: (HasCallStack, WebDriver wd) => WebStorageType -> Text -> wd ()

Delete a key in the given web storage area.

HTML 5 Application Cache

data ApplicationCacheStatus

Constructors

Uncached

Idle

Checking

Downloading

UpdateReady

Obsolete

Instances

FromJSON ApplicationCacheStatus

Defined in Test.WebDriver.Commands

Methods

parseJSON :: Value -> Parser ApplicationCacheStatus

parseJSONList :: Value -> Parser [ApplicationCacheStatus]

omittedField :: Maybe ApplicationCacheStatus

Bounded ApplicationCacheStatus

Defined in Test.WebDriver.Commands

Methods

minBound :: ApplicationCacheStatus

maxBound :: ApplicationCacheStatus

Enum ApplicationCacheStatus

Defined in Test.WebDriver.Commands

Methods

succ :: ApplicationCacheStatus -> ApplicationCacheStatus

pred :: ApplicationCacheStatus -> ApplicationCacheStatus

toEnum :: Int -> ApplicationCacheStatus

fromEnum :: ApplicationCacheStatus -> Int

enumFrom :: ApplicationCacheStatus -> [ApplicationCacheStatus]

enumFromThen :: ApplicationCacheStatus -> ApplicationCacheStatus -> [ApplicationCacheStatus]

enumFromTo :: ApplicationCacheStatus -> ApplicationCacheStatus -> [ApplicationCacheStatus]

enumFromThenTo :: ApplicationCacheStatus -> ApplicationCacheStatus -> ApplicationCacheStatus -> [ApplicationCacheStatus]

Read ApplicationCacheStatus

Defined in Test.WebDriver.Commands

Methods

readsPrec :: Int -> ReadS ApplicationCacheStatus

readList :: ReadS [ApplicationCacheStatus]

readPrec :: ReadPrec ApplicationCacheStatus

readListPrec :: ReadPrec [ApplicationCacheStatus]

Show ApplicationCacheStatus

Defined in Test.WebDriver.Commands

Methods

showsPrec :: Int -> ApplicationCacheStatus -> ShowS

show :: ApplicationCacheStatus -> String

showList :: [ApplicationCacheStatus] -> ShowS

Eq ApplicationCacheStatus

Defined in Test.WebDriver.Commands

Methods

(==) :: ApplicationCacheStatus -> ApplicationCacheStatus -> Bool

(/=) :: ApplicationCacheStatus -> ApplicationCacheStatus -> Bool

Ord ApplicationCacheStatus

Defined in Test.WebDriver.Commands

Methods

compare :: ApplicationCacheStatus -> ApplicationCacheStatus -> Ordering

(<) :: ApplicationCacheStatus -> ApplicationCacheStatus -> Bool

(<=) :: ApplicationCacheStatus -> ApplicationCacheStatus -> Bool

(>) :: ApplicationCacheStatus -> ApplicationCacheStatus -> Bool

(>=) :: ApplicationCacheStatus -> ApplicationCacheStatus -> Bool

max :: ApplicationCacheStatus -> ApplicationCacheStatus -> ApplicationCacheStatus

min :: ApplicationCacheStatus -> ApplicationCacheStatus -> ApplicationCacheStatus

getApplicationCacheStatus :: WebDriver wd => wd ApplicationCacheStatus

Mobile device support

Screen orientation

data Orientation

A screen orientation

Constructors

Landscape

Portrait

Instances

FromJSON Orientation

Defined in Test.WebDriver.Commands

Methods

parseJSON :: Value -> Parser Orientation

parseJSONList :: Value -> Parser [Orientation]

omittedField :: Maybe Orientation

ToJSON Orientation

Defined in Test.WebDriver.Commands

Methods

toJSON :: Orientation -> Value

toEncoding :: Orientation -> Encoding

toJSONList :: [Orientation] -> Value

toEncodingList :: [Orientation] -> Encoding

omitField :: Orientation -> Bool

Bounded Orientation

Defined in Test.WebDriver.Commands

Methods

minBound :: Orientation

maxBound :: Orientation

Enum Orientation

Defined in Test.WebDriver.Commands

Methods

succ :: Orientation -> Orientation

pred :: Orientation -> Orientation

toEnum :: Int -> Orientation

fromEnum :: Orientation -> Int

enumFrom :: Orientation -> [Orientation]

enumFromThen :: Orientation -> Orientation -> [Orientation]

enumFromTo :: Orientation -> Orientation -> [Orientation]

enumFromThenTo :: Orientation -> Orientation -> Orientation -> [Orientation]

Show Orientation

Defined in Test.WebDriver.Commands

Methods

showsPrec :: Int -> Orientation -> ShowS

show :: Orientation -> String

showList :: [Orientation] -> ShowS

Eq Orientation

Defined in Test.WebDriver.Commands

Methods

(==) :: Orientation -> Orientation -> Bool

(/=) :: Orientation -> Orientation -> Bool

Ord Orientation

Defined in Test.WebDriver.Commands

Methods

compare :: Orientation -> Orientation -> Ordering

(<) :: Orientation -> Orientation -> Bool

(<=) :: Orientation -> Orientation -> Bool

(>) :: Orientation -> Orientation -> Bool

(>=) :: Orientation -> Orientation -> Bool

max :: Orientation -> Orientation -> Orientation

min :: Orientation -> Orientation -> Orientation

getOrientation :: (HasCallStack, WebDriver wd) => wd Orientation

Get the current screen orientation for rotatable display devices.

setOrientation :: (HasCallStack, WebDriver wd) => Orientation -> wd ()

Set the current screen orientation for rotatable display devices.

Geo-location

getLocation :: (HasCallStack, WebDriver wd) => wd (Int, Int, Int)

Get the current geographical location of the device.

setLocation :: (HasCallStack, WebDriver wd) => (Int, Int, Int) -> wd ()

Set the current geographical location of the device.

Touch gestures

touchClick :: (HasCallStack, WebDriver wd) => Element -> wd ()

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

touchDown :: (HasCallStack, WebDriver wd) => (Int, Int) -> wd ()

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

touchUp :: (HasCallStack, WebDriver wd) => (Int, Int) -> wd ()

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

touchMove :: (HasCallStack, WebDriver wd) => (Int, Int) -> wd ()

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

touchScroll :: (HasCallStack, WebDriver wd) => (Int, Int) -> wd ()

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

touchScrollFrom :: (HasCallStack, WebDriver wd) => (Int, Int) -> Element -> wd ()

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

touchDoubleClick :: (HasCallStack, WebDriver wd) => Element -> wd ()

Emulate a double click on a touch device.

touchLongClick :: (HasCallStack, WebDriver wd) => Element -> wd ()

Emulate a long click on a touch device.

touchFlick :: (HasCallStack, WebDriver wd) => (Int, Int) -> wd ()

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

Arguments

:: (HasCallStack, WebDriver wd)

=> 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 :: (HasCallStack, WebDriver wd) => wd [Text]

activeIMEEngine :: (HasCallStack, WebDriver wd) => wd Text

checkIMEActive :: (HasCallStack, WebDriver wd) => wd Bool

activateIME :: (HasCallStack, WebDriver wd) => Text -> wd ()

deactivateIME :: (HasCallStack, WebDriver wd) => wd ()

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 :: (HasCallStack, WebDriver wd) => FilePath -> wd ()

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

uploadRawFile

Arguments

:: (HasCallStack, WebDriver wd)

=> 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 :: (HasCallStack, WebDriver wd) => Entry -> wd ()

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

Server information and logs

serverStatus :: WebDriver wd => wd Value

Get information from the server as a JSON Object. For more information about this object see https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#status

getLogs :: (HasCallStack, WebDriver wd) => LogType -> wd [LogEntry]

Retrieve the log buffer for a given log type. The server-side log buffer is reset after each request.

Which log types are available is server defined, but the wire protocol lists these as common log types: client, driver, browser, server

getLogTypes :: (HasCallStack, WebDriver wd) => wd [LogType]

Get a list of available log types.

type LogType = String

data LogEntry

A record that represents a single log entry.

Constructors

LogEntry

Fields

• logTime :: Integer

  timestamp for the log entry. The standard does not specify the epoch or the unit of time.

• logLevel :: LogLevel

  log verbosity level

• logMsg :: Text

Instances

FromJSON LogEntry

Defined in Test.WebDriver.Commands

Methods

parseJSON :: Value -> Parser LogEntry

parseJSONList :: Value -> Parser [LogEntry]

omittedField :: Maybe LogEntry

Read LogEntry

Defined in Test.WebDriver.Commands

Methods

readsPrec :: Int -> ReadS LogEntry

readList :: ReadS [LogEntry]

readPrec :: ReadPrec LogEntry

readListPrec :: ReadPrec [LogEntry]

Show LogEntry

Defined in Test.WebDriver.Commands

Methods

showsPrec :: Int -> LogEntry -> ShowS

show :: LogEntry -> String

showList :: [LogEntry] -> ShowS

Eq LogEntry

Defined in Test.WebDriver.Commands

Methods

(==) :: LogEntry -> LogEntry -> Bool

(/=) :: LogEntry -> LogEntry -> Bool

Ord LogEntry

Defined in Test.WebDriver.Commands

Methods

compare :: LogEntry -> LogEntry -> Ordering

(<) :: LogEntry -> LogEntry -> Bool

(<=) :: LogEntry -> LogEntry -> Bool

(>) :: LogEntry -> LogEntry -> Bool

(>=) :: LogEntry -> LogEntry -> Bool

max :: LogEntry -> LogEntry -> LogEntry

min :: LogEntry -> LogEntry -> LogEntry

data LogLevel

Indicates a log verbosity level. Used in Browser and Opera configuration.

Constructors

LogOff

LogSevere

LogWarning

LogInfo

LogConfig

LogFine

LogFiner

LogFinest

LogDebug

LogAll

Instances

FromJSON LogLevel

Defined in Test.WebDriver.Capabilities

Methods

parseJSON :: Value -> Parser LogLevel

parseJSONList :: Value -> Parser [LogLevel]

omittedField :: Maybe LogLevel

ToJSON LogLevel

Defined in Test.WebDriver.Capabilities

Methods

toJSON :: LogLevel -> Value

toEncoding :: LogLevel -> Encoding

toJSONList :: [LogLevel] -> Value

toEncodingList :: [LogLevel] -> Encoding

omitField :: LogLevel -> Bool

Bounded LogLevel

Defined in Test.WebDriver.Capabilities

Methods

minBound :: LogLevel

maxBound :: LogLevel

Enum LogLevel

Defined in Test.WebDriver.Capabilities

Methods

succ :: LogLevel -> LogLevel

pred :: LogLevel -> LogLevel

toEnum :: Int -> LogLevel

fromEnum :: LogLevel -> Int

enumFrom :: LogLevel -> [LogLevel]

enumFromThen :: LogLevel -> LogLevel -> [LogLevel]

enumFromTo :: LogLevel -> LogLevel -> [LogLevel]

enumFromThenTo :: LogLevel -> LogLevel -> LogLevel -> [LogLevel]

Read LogLevel

Defined in Test.WebDriver.Capabilities

Methods

readsPrec :: Int -> ReadS LogLevel

readList :: ReadS [LogLevel]

readPrec :: ReadPrec LogLevel

readListPrec :: ReadPrec [LogLevel]

Show LogLevel

Defined in Test.WebDriver.Capabilities

Methods

showsPrec :: Int -> LogLevel -> ShowS

show :: LogLevel -> String

showList :: [LogLevel] -> ShowS

Default LogLevel

Defined in Test.WebDriver.Capabilities

Methods

def :: LogLevel

Eq LogLevel

Defined in Test.WebDriver.Capabilities

Methods

(==) :: LogLevel -> LogLevel -> Bool

(/=) :: LogLevel -> LogLevel -> Bool

Ord LogLevel

Defined in Test.WebDriver.Capabilities

Methods

compare :: LogLevel -> LogLevel -> Ordering

(<) :: LogLevel -> LogLevel -> Bool

(<=) :: LogLevel -> LogLevel -> Bool

(>) :: LogLevel -> LogLevel -> Bool

(>=) :: LogLevel -> LogLevel -> Bool

max :: LogLevel -> LogLevel -> LogLevel

min :: LogLevel -> LogLevel -> LogLevel