Test.WebDriver.Commands.Internal

Internal functions used to implement the functions exported by Test.WebDriver.Commands. These may be useful for implementing non-standard webdriver commands.

Low-level webdriver functions

doCommand

Arguments

:: (WebDriver wd, HasCallStack, ToJSON a, FromJSON b)

=> Method

HTTP request method

-> Text

URL of request

-> a

JSON parameters passed in the body of the request. Note that, as a special case, anything that converts to Data.Aeson.Null will result in an empty request body.

-> wd b

The JSON result of the HTTP request.

Commands with :sessionId URL parameter

doSessCommand :: (HasCallStack, WebDriver wd, ToJSON a, FromJSON b) => Method -> Text -> a -> wd b

This a convenient wrapper around doCommand that automatically prepends the session URL parameter to the wire command URL. For example, passing a URL of "refresh" will expand to "session:sessionIdrefresh", where :sessionId is a URL parameter as described in https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol

newtype SessionId

An opaque identifier for a WebDriver session. These handles are produced by the server on session creation, and act to identify a session in progress.

Constructors

SessionId Text

Instances

FromJSON SessionId

Defined in Test.WebDriver.Session

Methods

parseJSON :: Value -> Parser SessionId

parseJSONList :: Value -> Parser [SessionId]

ToJSON SessionId

Defined in Test.WebDriver.Session

Methods

toJSON :: SessionId -> Value

toEncoding :: SessionId -> Encoding

toJSONList :: [SessionId] -> Value

toEncodingList :: [SessionId] -> Encoding

Read SessionId

Defined in Test.WebDriver.Session

Methods

readsPrec :: Int -> ReadS SessionId

readList :: ReadS [SessionId]

readPrec :: ReadPrec SessionId

readListPrec :: ReadPrec [SessionId]

Show SessionId

Defined in Test.WebDriver.Session

Methods

showsPrec :: Int -> SessionId -> ShowS

show :: SessionId -> String

showList :: [SessionId] -> ShowS

Eq SessionId

Defined in Test.WebDriver.Session

Methods

(==) :: SessionId -> SessionId -> Bool

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

Ord SessionId

Defined in Test.WebDriver.Session

Methods

compare :: SessionId -> SessionId -> Ordering

(<) :: SessionId -> SessionId -> Bool

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

(>) :: SessionId -> SessionId -> Bool

(>=) :: SessionId -> SessionId -> Bool

max :: SessionId -> SessionId -> SessionId

min :: SessionId -> SessionId -> SessionId

Commands with element :id URL parameters

doElemCommand :: (HasCallStack, WebDriver wd, ToJSON a, FromJSON b) => Method -> Element -> Text -> a -> wd b

A wrapper around doSessCommand to create element URLs. For example, passing a URL of "/active" will expand to "session:sessionIdelement:id/active", where :sessionId and :id are URL parameters as described in the wire protocol.

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]

ToJSON Element

Defined in Test.WebDriver.Commands.Internal

Methods

toJSON :: Element -> Value

toEncoding :: Element -> Encoding

toJSONList :: [Element] -> Value

toEncodingList :: [Element] -> Encoding

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

Commands with :windowHandle URL parameters

doWinCommand :: (HasCallStack, WebDriver wd, ToJSON a, FromJSON b) => Method -> WindowHandle -> Text -> a -> wd b

A wrapper around doSessCommand to create window handle URLS. For example, passing a URL of "/size" will expand to "session:sessionIdwindow:windowHandle/", where :sessionId and :windowHandle are URL parameters as described in the wire protocol

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]

ToJSON WindowHandle

Defined in Test.WebDriver.Commands.Internal

Methods

toJSON :: WindowHandle -> Value

toEncoding :: WindowHandle -> Encoding

toJSONList :: [WindowHandle] -> Value

toEncodingList :: [WindowHandle] -> Encoding

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.

Exceptions

newtype NoSessionId

A command requiring a session ID was attempted when no session ID was available.

Constructors

NoSessionId String

Instances

Exception NoSessionId

Defined in Test.WebDriver.Commands.Internal

Methods

toException :: NoSessionId -> SomeException

fromException :: SomeException -> Maybe NoSessionId

displayException :: NoSessionId -> String

Show NoSessionId

Defined in Test.WebDriver.Commands.Internal

Methods

showsPrec :: Int -> NoSessionId -> ShowS

show :: NoSessionId -> String

showList :: [NoSessionId] -> ShowS

Eq NoSessionId

Defined in Test.WebDriver.Commands.Internal

Methods

(==) :: NoSessionId -> NoSessionId -> Bool

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