Web.Api.WebDriver.Types

The WebDriver protocol involves passing several different kinds of JSON objects. We can encode these as types to make our DSL more robust; this module is a grab bag of these types. For each one we need ToJSON and FromJSON instances, and sometimes also a default value.

Note that while the WebDriver spec defines some JSON objects, in general a given WebDriver server can accept additional properties on any given object. Our types here will be limited to the "spec" object signatures, but our API will need to be user extensible.

Stringy Types

type SessionId = String

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

newtype ElementRef

See https://w3c.github.io/webdriver/webdriver-spec.html#dfn-web-element-reference.

Constructors

ElementRef

Fields

• theElementRef :: String

Instances

Eq ElementRef

Defined in Web.Api.WebDriver.Types

Methods

(==) :: ElementRef -> ElementRef -> Bool

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

Show ElementRef

Defined in Web.Api.WebDriver.Types

Methods

showsPrec :: Int -> ElementRef -> ShowS

show :: ElementRef -> String

showList :: [ElementRef] -> ShowS

IsString ElementRef

Defined in Web.Api.WebDriver.Types

Methods

fromString :: String -> ElementRef

HasElementRef ElementRef

Defined in Web.Api.WebDriver.Classes

Methods

elementRefOf :: ElementRef -> ElementRef

newtype ContextId

Identifier for a browsing context; see https://w3c.github.io/webdriver/webdriver-spec.html#dfn-current-browsing-context.

Constructors

ContextId

Fields

• theContextId :: String

Instances

Eq ContextId

Defined in Web.Api.WebDriver.Types

Methods

(==) :: ContextId -> ContextId -> Bool

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

Show ContextId

Defined in Web.Api.WebDriver.Types

Methods

showsPrec :: Int -> ContextId -> ShowS

show :: ContextId -> String

showList :: [ContextId] -> ShowS

IsString ContextId

Defined in Web.Api.WebDriver.Types

Methods

fromString :: String -> ContextId

HasContextId ContextId

Defined in Web.Api.WebDriver.Classes

Methods

contextIdOf :: ContextId -> ContextId

type Selector = String

For use with a Locator Strategy. See https://w3c.github.io/webdriver/webdriver-spec.html#locator-strategies.

type AttributeName = String

Used with getElementAttribute.

type PropertyName = String

Used with getElementProperty.

type Script = String

Javascript

type CookieName = String

Used with getNamedCookie.

type CssPropertyName = String

Used with getElementCssValue.

data FrameReference

Possible frame references; see https://w3c.github.io/webdriver/webdriver-spec.html#switch-to-frame.

Constructors

TopLevelFrame

FrameNumber Int

FrameContainingElement ElementRef

Instances

Eq FrameReference

Defined in Web.Api.WebDriver.Types

Methods

(==) :: FrameReference -> FrameReference -> Bool

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

Show FrameReference

Defined in Web.Api.WebDriver.Types

Methods

showsPrec :: Int -> FrameReference -> ShowS

show :: FrameReference -> String

showList :: [FrameReference] -> ShowS

Capabilities

data Capabilities

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

Constructors

Capabilities

Fields

• _browserName :: Maybe BrowserName

  browserName

• _browserVersion :: Maybe String

  browserVersion

• _platformName :: Maybe PlatformName

  platformName

• _acceptInsecureCerts :: Maybe Bool

  acceptInsecureCerts

• _pageLoadStrategy :: Maybe String

  pageLoadStrategy

• _proxy :: Maybe ProxyConfig

  proxy

• _setWindowRect :: Maybe Bool

  setWindowRect

• _timeouts :: Maybe TimeoutConfig

  timeouts

• _unhandledPromptBehavior :: Maybe PromptHandler

  unhandledPromptBehavior

• _chromeOptions :: Maybe ChromeOptions

  chromeOptions

• _firefoxOptions :: Maybe FirefoxOptions

  moz:firefoxOptions

Instances

Eq Capabilities

Defined in Web.Api.WebDriver.Types

Methods

(==) :: Capabilities -> Capabilities -> Bool

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

Show Capabilities

Defined in Web.Api.WebDriver.Types

Methods

showsPrec :: Int -> Capabilities -> ShowS

show :: Capabilities -> String

showList :: [Capabilities] -> ShowS

Arbitrary Capabilities

Defined in Web.Api.WebDriver.Types

Methods

arbitrary :: Gen Capabilities

shrink :: Capabilities -> [Capabilities]

ToJSON Capabilities

Defined in Web.Api.WebDriver.Types

Methods

toJSON :: Capabilities -> Value

toEncoding :: Capabilities -> Encoding

toJSONList :: [Capabilities] -> Value

toEncodingList :: [Capabilities] -> Encoding

FromJSON Capabilities

Defined in Web.Api.WebDriver.Types

Methods

parseJSON :: Value -> Parser Capabilities

parseJSONList :: Value -> Parser [Capabilities]

data BrowserName

Used in Capabilities.

Constructors

Firefox

Chrome

Safari

Instances

Bounded BrowserName

Defined in Web.Api.WebDriver.Types

Methods

minBound :: BrowserName

maxBound :: BrowserName

Enum BrowserName

Defined in Web.Api.WebDriver.Types

Methods

succ :: BrowserName -> BrowserName

pred :: BrowserName -> BrowserName

toEnum :: Int -> BrowserName

fromEnum :: BrowserName -> Int

enumFrom :: BrowserName -> [BrowserName]

enumFromThen :: BrowserName -> BrowserName -> [BrowserName]

enumFromTo :: BrowserName -> BrowserName -> [BrowserName]

enumFromThenTo :: BrowserName -> BrowserName -> BrowserName -> [BrowserName]

Eq BrowserName

Defined in Web.Api.WebDriver.Types

Methods

(==) :: BrowserName -> BrowserName -> Bool

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

Show BrowserName

Defined in Web.Api.WebDriver.Types

Methods

showsPrec :: Int -> BrowserName -> ShowS

show :: BrowserName -> String

showList :: [BrowserName] -> ShowS

Arbitrary BrowserName

Defined in Web.Api.WebDriver.Types

Methods

arbitrary :: Gen BrowserName

shrink :: BrowserName -> [BrowserName]

ToJSON BrowserName

Defined in Web.Api.WebDriver.Types

Methods

toJSON :: BrowserName -> Value

toEncoding :: BrowserName -> Encoding

toJSONList :: [BrowserName] -> Value

toEncodingList :: [BrowserName] -> Encoding

FromJSON BrowserName

Defined in Web.Api.WebDriver.Types

Methods

parseJSON :: Value -> Parser BrowserName

parseJSONList :: Value -> Parser [BrowserName]

data PlatformName

Used in Capabilities.

Constructors

Mac

Instances

Bounded PlatformName

Defined in Web.Api.WebDriver.Types

Methods

minBound :: PlatformName

maxBound :: PlatformName

Enum PlatformName

Defined in Web.Api.WebDriver.Types

Methods

succ :: PlatformName -> PlatformName

pred :: PlatformName -> PlatformName

toEnum :: Int -> PlatformName

fromEnum :: PlatformName -> Int

enumFrom :: PlatformName -> [PlatformName]

enumFromThen :: PlatformName -> PlatformName -> [PlatformName]

enumFromTo :: PlatformName -> PlatformName -> [PlatformName]

enumFromThenTo :: PlatformName -> PlatformName -> PlatformName -> [PlatformName]

Eq PlatformName

Defined in Web.Api.WebDriver.Types

Methods

(==) :: PlatformName -> PlatformName -> Bool

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

Show PlatformName

Defined in Web.Api.WebDriver.Types

Methods

showsPrec :: Int -> PlatformName -> ShowS

show :: PlatformName -> String

showList :: [PlatformName] -> ShowS

Arbitrary PlatformName

Defined in Web.Api.WebDriver.Types

Methods

arbitrary :: Gen PlatformName

shrink :: PlatformName -> [PlatformName]

ToJSON PlatformName

Defined in Web.Api.WebDriver.Types

Methods

toJSON :: PlatformName -> Value

toEncoding :: PlatformName -> Encoding

toJSONList :: [PlatformName] -> Value

toEncodingList :: [PlatformName] -> Encoding

FromJSON PlatformName

Defined in Web.Api.WebDriver.Types

Methods

parseJSON :: Value -> Parser PlatformName

parseJSONList :: Value -> Parser [PlatformName]

emptyCapabilities :: Capabilities

Capabilities with all members set to Nothing.

defaultFirefoxCapabilities :: Capabilities

All members set to Nothing except _browserName, which is Just Firefox.

headlessFirefoxCapabilities :: Capabilities

Passing the "-headless" parameter to Firefox.

defaultChromeCapabilities :: Capabilities

All members set to Nothing except _browserName, which is Just Chrome.

data LogLevel

See https://github.com/mozilla/geckodriver#log-object.

Constructors

LogTrace

LogDebug

LogConfig

LogInfo

LogWarn

LogError

LogFatal

Instances

Bounded LogLevel

Defined in Web.Api.WebDriver.Types

Methods

minBound :: LogLevel

maxBound :: LogLevel

Enum LogLevel

Defined in Web.Api.WebDriver.Types

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]

Eq LogLevel

Defined in Web.Api.WebDriver.Types

Methods

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

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

Show LogLevel

Defined in Web.Api.WebDriver.Types

Methods

showsPrec :: Int -> LogLevel -> ShowS

show :: LogLevel -> String

showList :: [LogLevel] -> ShowS

Arbitrary LogLevel

Defined in Web.Api.WebDriver.Types

Methods

arbitrary :: Gen LogLevel

shrink :: LogLevel -> [LogLevel]

ToJSON LogLevel

Defined in Web.Api.WebDriver.Types

Methods

toJSON :: LogLevel -> Value

toEncoding :: LogLevel -> Encoding

toJSONList :: [LogLevel] -> Value

toEncodingList :: [LogLevel] -> Encoding

FromJSON LogLevel

Defined in Web.Api.WebDriver.Types

Methods

parseJSON :: Value -> Parser LogLevel

parseJSONList :: Value -> Parser [LogLevel]

data FirefoxOptions

See https://github.com/mozilla/geckodriver#firefox-capabilities.

Constructors

FirefoxOptions

Fields

• _firefoxBinary :: Maybe FilePath

  binary

• _firefoxArgs :: Maybe [String]

  args

• _firefoxLog :: Maybe FirefoxLog
• _firefoxPrefs :: Maybe (HashMap Text Value)

  prefs

Instances

Eq FirefoxOptions

Defined in Web.Api.WebDriver.Types

Methods

(==) :: FirefoxOptions -> FirefoxOptions -> Bool

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

Show FirefoxOptions

Defined in Web.Api.WebDriver.Types

Methods

showsPrec :: Int -> FirefoxOptions -> ShowS

show :: FirefoxOptions -> String

showList :: [FirefoxOptions] -> ShowS

Arbitrary FirefoxOptions

Defined in Web.Api.WebDriver.Types

Methods

arbitrary :: Gen FirefoxOptions

shrink :: FirefoxOptions -> [FirefoxOptions]

ToJSON FirefoxOptions

Defined in Web.Api.WebDriver.Types

Methods

toJSON :: FirefoxOptions -> Value

toEncoding :: FirefoxOptions -> Encoding

toJSONList :: [FirefoxOptions] -> Value

toEncodingList :: [FirefoxOptions] -> Encoding

FromJSON FirefoxOptions

Defined in Web.Api.WebDriver.Types

Methods

parseJSON :: Value -> Parser FirefoxOptions

parseJSONList :: Value -> Parser [FirefoxOptions]

newtype FirefoxLog

See https://github.com/mozilla/geckodriver#log-object.

Constructors

FirefoxLog

Fields

• _firefoxLogLevel :: Maybe LogLevel

Instances

Eq FirefoxLog

Defined in Web.Api.WebDriver.Types

Methods

(==) :: FirefoxLog -> FirefoxLog -> Bool

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

Show FirefoxLog

Defined in Web.Api.WebDriver.Types

Methods

showsPrec :: Int -> FirefoxLog -> ShowS

show :: FirefoxLog -> String

showList :: [FirefoxLog] -> ShowS

Arbitrary FirefoxLog

Defined in Web.Api.WebDriver.Types

Methods

arbitrary :: Gen FirefoxLog

shrink :: FirefoxLog -> [FirefoxLog]

ToJSON FirefoxLog

Defined in Web.Api.WebDriver.Types

Methods

toJSON :: FirefoxLog -> Value

toEncoding :: FirefoxLog -> Encoding

toJSONList :: [FirefoxLog] -> Value

toEncodingList :: [FirefoxLog] -> Encoding

FromJSON FirefoxLog

Defined in Web.Api.WebDriver.Types

Methods

parseJSON :: Value -> Parser FirefoxLog

parseJSONList :: Value -> Parser [FirefoxLog]

defaultFirefoxOptions :: FirefoxOptions

All members set to Nothing.

data ChromeOptions

See https://sites.google.com/a/chromium.org/chromedriver/capabilities.

Constructors

ChromeOptions

Fields

• _chromeBinary :: Maybe FilePath

  binary

• _chromeArgs :: Maybe [String]

  args

• _chromePrefs :: Maybe (HashMap Text Value)

  prefs

Instances

Eq ChromeOptions

Defined in Web.Api.WebDriver.Types

Methods

(==) :: ChromeOptions -> ChromeOptions -> Bool

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

Show ChromeOptions

Defined in Web.Api.WebDriver.Types

Methods

showsPrec :: Int -> ChromeOptions -> ShowS

show :: ChromeOptions -> String

showList :: [ChromeOptions] -> ShowS

Arbitrary ChromeOptions

Defined in Web.Api.WebDriver.Types

Methods

arbitrary :: Gen ChromeOptions

shrink :: ChromeOptions -> [ChromeOptions]

ToJSON ChromeOptions

Defined in Web.Api.WebDriver.Types

Methods

toJSON :: ChromeOptions -> Value

toEncoding :: ChromeOptions -> Encoding

toJSONList :: [ChromeOptions] -> Value

toEncodingList :: [ChromeOptions] -> Encoding

FromJSON ChromeOptions

Defined in Web.Api.WebDriver.Types

Methods

parseJSON :: Value -> Parser ChromeOptions

parseJSONList :: Value -> Parser [ChromeOptions]

defaultChromeOptions :: ChromeOptions

All members set to Nothing.

Proxy

data ProxyConfig

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

Constructors

ProxyConfig

Fields

• _proxyType :: Maybe ProxyType

  proxyType

• _proxyAutoconfigUrl :: Maybe String

  proxyAutoconfigUrl

• _ftpProxy :: Maybe HostAndOptionalPort

  ftpProxy

• _httpProxy :: Maybe HostAndOptionalPort

  httpProxy

• _noProxy :: Maybe [String]

  noProxy

• _sslProxy :: Maybe HostAndOptionalPort

  sslProxy

• _socksProxy :: Maybe HostAndOptionalPort

  socksProxy

• _socksVersion :: Maybe Int

  socksVersion

Instances

Eq ProxyConfig

Defined in Web.Api.WebDriver.Types

Methods

(==) :: ProxyConfig -> ProxyConfig -> Bool

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

Show ProxyConfig

Defined in Web.Api.WebDriver.Types

Methods

showsPrec :: Int -> ProxyConfig -> ShowS

show :: ProxyConfig -> String

showList :: [ProxyConfig] -> ShowS

Arbitrary ProxyConfig

Defined in Web.Api.WebDriver.Types

Methods

arbitrary :: Gen ProxyConfig

shrink :: ProxyConfig -> [ProxyConfig]

ToJSON ProxyConfig

Defined in Web.Api.WebDriver.Types

Methods

toJSON :: ProxyConfig -> Value

toEncoding :: ProxyConfig -> Encoding

toJSONList :: [ProxyConfig] -> Value

toEncodingList :: [ProxyConfig] -> Encoding

FromJSON ProxyConfig

Defined in Web.Api.WebDriver.Types

Methods

parseJSON :: Value -> Parser ProxyConfig

parseJSONList :: Value -> Parser [ProxyConfig]

emptyProxyConfig :: ProxyConfig

ProxyConfig object with all members set to Nothing.

data ProxyType

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

Constructors

ProxyPac

pac

ProxyDirect

direct

ProxyAutodetect

autodetect

ProxySystem

system

ProxyManual

manual

Instances

Bounded ProxyType

Defined in Web.Api.WebDriver.Types

Methods

minBound :: ProxyType

maxBound :: ProxyType

Enum ProxyType

Defined in Web.Api.WebDriver.Types

Methods

succ :: ProxyType -> ProxyType

pred :: ProxyType -> ProxyType

toEnum :: Int -> ProxyType

fromEnum :: ProxyType -> Int

enumFrom :: ProxyType -> [ProxyType]

enumFromThen :: ProxyType -> ProxyType -> [ProxyType]

enumFromTo :: ProxyType -> ProxyType -> [ProxyType]

enumFromThenTo :: ProxyType -> ProxyType -> ProxyType -> [ProxyType]

Eq ProxyType

Defined in Web.Api.WebDriver.Types

Methods

(==) :: ProxyType -> ProxyType -> Bool

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

Show ProxyType

Defined in Web.Api.WebDriver.Types

Methods

showsPrec :: Int -> ProxyType -> ShowS

show :: ProxyType -> String

showList :: [ProxyType] -> ShowS

Arbitrary ProxyType

Defined in Web.Api.WebDriver.Types

Methods

arbitrary :: Gen ProxyType

shrink :: ProxyType -> [ProxyType]

ToJSON ProxyType

Defined in Web.Api.WebDriver.Types

Methods

toJSON :: ProxyType -> Value

toEncoding :: ProxyType -> Encoding

toJSONList :: [ProxyType] -> Value

toEncodingList :: [ProxyType] -> Encoding

FromJSON ProxyType

Defined in Web.Api.WebDriver.Types

Methods

parseJSON :: Value -> Parser ProxyType

parseJSONList :: Value -> Parser [ProxyType]

data HostAndOptionalPort

See https://w3c.github.io/webdriver/webdriver-spec.html#dfn-host-and-optional-port.

Constructors

HostAndOptionalPort

Fields

• _urlHost :: Host
• _urlPort :: Maybe Port

Instances

Eq HostAndOptionalPort

Defined in Web.Api.WebDriver.Types

Methods

(==) :: HostAndOptionalPort -> HostAndOptionalPort -> Bool

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

Show HostAndOptionalPort

Defined in Web.Api.WebDriver.Types

Methods

showsPrec :: Int -> HostAndOptionalPort -> ShowS

show :: HostAndOptionalPort -> String

showList :: [HostAndOptionalPort] -> ShowS

Arbitrary HostAndOptionalPort

Defined in Web.Api.WebDriver.Types

Methods

arbitrary :: Gen HostAndOptionalPort

shrink :: HostAndOptionalPort -> [HostAndOptionalPort]

ToJSON HostAndOptionalPort

Defined in Web.Api.WebDriver.Types

Methods

toJSON :: HostAndOptionalPort -> Value

toEncoding :: HostAndOptionalPort -> Encoding

toJSONList :: [HostAndOptionalPort] -> Value

toEncodingList :: [HostAndOptionalPort] -> Encoding

FromJSON HostAndOptionalPort

Defined in Web.Api.WebDriver.Types

Methods

parseJSON :: Value -> Parser HostAndOptionalPort

parseJSONList :: Value -> Parser [HostAndOptionalPort]

Timeout

data TimeoutConfig

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

Constructors

TimeoutConfig

Fields

• _script :: Maybe Int

  script

• _pageLoad :: Maybe Int

  pageLoad

• _implicit :: Maybe Int

  implicit

Instances

Eq TimeoutConfig

Defined in Web.Api.WebDriver.Types

Methods

(==) :: TimeoutConfig -> TimeoutConfig -> Bool

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

Show TimeoutConfig

Defined in Web.Api.WebDriver.Types

Methods

showsPrec :: Int -> TimeoutConfig -> ShowS

show :: TimeoutConfig -> String

showList :: [TimeoutConfig] -> ShowS

Arbitrary TimeoutConfig

Defined in Web.Api.WebDriver.Types

Methods

arbitrary :: Gen TimeoutConfig

shrink :: TimeoutConfig -> [TimeoutConfig]

ToJSON TimeoutConfig

Defined in Web.Api.WebDriver.Types

Methods

toJSON :: TimeoutConfig -> Value

toEncoding :: TimeoutConfig -> Encoding

toJSONList :: [TimeoutConfig] -> Value

toEncodingList :: [TimeoutConfig] -> Encoding

FromJSON TimeoutConfig

Defined in Web.Api.WebDriver.Types

Methods

parseJSON :: Value -> Parser TimeoutConfig

parseJSONList :: Value -> Parser [TimeoutConfig]

emptyTimeoutConfig :: TimeoutConfig

TimeoutConfig object with all members set to Nothing.

Input and Actions

data InputSource

See https://w3c.github.io/webdriver/webdriver-spec.html#dfn-input-sources.

Constructors

NullInputSource

null

KeyInputSource

key

PointerInputSource

pointer

Instances

Bounded InputSource

Defined in Web.Api.WebDriver.Types

Methods

minBound :: InputSource

maxBound :: InputSource

Enum InputSource

Defined in Web.Api.WebDriver.Types

Methods

succ :: InputSource -> InputSource

pred :: InputSource -> InputSource

toEnum :: Int -> InputSource

fromEnum :: InputSource -> Int

enumFrom :: InputSource -> [InputSource]

enumFromThen :: InputSource -> InputSource -> [InputSource]

enumFromTo :: InputSource -> InputSource -> [InputSource]

enumFromThenTo :: InputSource -> InputSource -> InputSource -> [InputSource]

Eq InputSource

Defined in Web.Api.WebDriver.Types

Methods

(==) :: InputSource -> InputSource -> Bool

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

Show InputSource

Defined in Web.Api.WebDriver.Types

Methods

showsPrec :: Int -> InputSource -> ShowS

show :: InputSource -> String

showList :: [InputSource] -> ShowS

Arbitrary InputSource

Defined in Web.Api.WebDriver.Types

Methods

arbitrary :: Gen InputSource

shrink :: InputSource -> [InputSource]

ToJSON InputSource

Defined in Web.Api.WebDriver.Types

Methods

toJSON :: InputSource -> Value

toEncoding :: InputSource -> Encoding

toJSONList :: [InputSource] -> Value

toEncodingList :: [InputSource] -> Encoding

FromJSON InputSource

Defined in Web.Api.WebDriver.Types

Methods

parseJSON :: Value -> Parser InputSource

parseJSONList :: Value -> Parser [InputSource]

data PointerSubtype

See https://w3c.github.io/webdriver/webdriver-spec.html#dfn-pointer-input-state.

Constructors

PointerMouse

mouse

PointerPen

pen

PointerTouch

touch

Instances

Bounded PointerSubtype

Defined in Web.Api.WebDriver.Types

Methods

minBound :: PointerSubtype

maxBound :: PointerSubtype

Enum PointerSubtype

Defined in Web.Api.WebDriver.Types

Methods

succ :: PointerSubtype -> PointerSubtype

pred :: PointerSubtype -> PointerSubtype

toEnum :: Int -> PointerSubtype

fromEnum :: PointerSubtype -> Int

enumFrom :: PointerSubtype -> [PointerSubtype]

enumFromThen :: PointerSubtype -> PointerSubtype -> [PointerSubtype]

enumFromTo :: PointerSubtype -> PointerSubtype -> [PointerSubtype]

enumFromThenTo :: PointerSubtype -> PointerSubtype -> PointerSubtype -> [PointerSubtype]

Eq PointerSubtype

Defined in Web.Api.WebDriver.Types

Methods

(==) :: PointerSubtype -> PointerSubtype -> Bool

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

Show PointerSubtype

Defined in Web.Api.WebDriver.Types

Methods

showsPrec :: Int -> PointerSubtype -> ShowS

show :: PointerSubtype -> String

showList :: [PointerSubtype] -> ShowS

Arbitrary PointerSubtype

Defined in Web.Api.WebDriver.Types

Methods

arbitrary :: Gen PointerSubtype

shrink :: PointerSubtype -> [PointerSubtype]

ToJSON PointerSubtype

Defined in Web.Api.WebDriver.Types

Methods

toJSON :: PointerSubtype -> Value

toEncoding :: PointerSubtype -> Encoding

toJSONList :: [PointerSubtype] -> Value

toEncodingList :: [PointerSubtype] -> Encoding

FromJSON PointerSubtype

Defined in Web.Api.WebDriver.Types

Methods

parseJSON :: Value -> Parser PointerSubtype

parseJSONList :: Value -> Parser [PointerSubtype]

newtype InputSourceParameter

See https://w3c.github.io/webdriver/webdriver-spec.html#dfn-pointer-input-state.

Constructors

InputSourceParameter

Fields

• _pointerSubtype :: Maybe PointerSubtype

  subtype

Instances

Eq InputSourceParameter

Defined in Web.Api.WebDriver.Types

Methods

(==) :: InputSourceParameter -> InputSourceParameter -> Bool

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

Show InputSourceParameter

Defined in Web.Api.WebDriver.Types

Methods

showsPrec :: Int -> InputSourceParameter -> ShowS

show :: InputSourceParameter -> String

showList :: [InputSourceParameter] -> ShowS

Arbitrary InputSourceParameter

Defined in Web.Api.WebDriver.Types

Methods

arbitrary :: Gen InputSourceParameter

shrink :: InputSourceParameter -> [InputSourceParameter]

ToJSON InputSourceParameter

Defined in Web.Api.WebDriver.Types

Methods

toJSON :: InputSourceParameter -> Value

toEncoding :: InputSourceParameter -> Encoding

toJSONList :: [InputSourceParameter] -> Value

toEncodingList :: [InputSourceParameter] -> Encoding

FromJSON InputSourceParameter

Defined in Web.Api.WebDriver.Types

Methods

parseJSON :: Value -> Parser InputSourceParameter

parseJSONList :: Value -> Parser [InputSourceParameter]

data Action

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

Constructors

Action

Fields

• _inputSourceType :: Maybe InputSource

  type

• _inputSourceId :: Maybe String

  id

• _inputSourceParameters :: Maybe InputSourceParameter

  parameters

• _actionItems :: [ActionItem]

  actions

Instances

Eq Action

Defined in Web.Api.WebDriver.Types

Methods

(==) :: Action -> Action -> Bool

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

Show Action

Defined in Web.Api.WebDriver.Types

Methods

showsPrec :: Int -> Action -> ShowS

show :: Action -> String

showList :: [Action] -> ShowS

Arbitrary Action

Defined in Web.Api.WebDriver.Types

Methods

arbitrary :: Gen Action

shrink :: Action -> [Action]

ToJSON Action

Defined in Web.Api.WebDriver.Types

Methods

toJSON :: Action -> Value

toEncoding :: Action -> Encoding

toJSONList :: [Action] -> Value

toEncodingList :: [Action] -> Encoding

FromJSON Action

Defined in Web.Api.WebDriver.Types

Methods

parseJSON :: Value -> Parser Action

parseJSONList :: Value -> Parser [Action]

emptyAction :: Action

All members set to Nothing except _actionItems, which is the empty list.

data ActionType

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

Constructors

PauseAction

pause

KeyUpAction

keyUp

KeyDownAction

keyDown

PointerDownAction

pointerDown

PointerUpAction

pointerUp

PointerMoveAction

pointerMove

PointerCancelAction

pointerCancel

Instances

Bounded ActionType

Defined in Web.Api.WebDriver.Types

Methods

minBound :: ActionType

maxBound :: ActionType

Enum ActionType

Defined in Web.Api.WebDriver.Types

Methods

succ :: ActionType -> ActionType

pred :: ActionType -> ActionType

toEnum :: Int -> ActionType

fromEnum :: ActionType -> Int

enumFrom :: ActionType -> [ActionType]

enumFromThen :: ActionType -> ActionType -> [ActionType]

enumFromTo :: ActionType -> ActionType -> [ActionType]

enumFromThenTo :: ActionType -> ActionType -> ActionType -> [ActionType]

Eq ActionType

Defined in Web.Api.WebDriver.Types

Methods

(==) :: ActionType -> ActionType -> Bool

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

Show ActionType

Defined in Web.Api.WebDriver.Types

Methods

showsPrec :: Int -> ActionType -> ShowS

show :: ActionType -> String

showList :: [ActionType] -> ShowS

Arbitrary ActionType

Defined in Web.Api.WebDriver.Types

Methods

arbitrary :: Gen ActionType

shrink :: ActionType -> [ActionType]

ToJSON ActionType

Defined in Web.Api.WebDriver.Types

Methods

toJSON :: ActionType -> Value

toEncoding :: ActionType -> Encoding

toJSONList :: [ActionType] -> Value

toEncodingList :: [ActionType] -> Encoding

FromJSON ActionType

Defined in Web.Api.WebDriver.Types

Methods

parseJSON :: Value -> Parser ActionType

parseJSONList :: Value -> Parser [ActionType]

data ActionItem

See https://w3c.github.io/webdriver/webdriver-spec.html#dfn-process-an-input-source-action-sequence.

Constructors

ActionItem

Fields

• _actionType :: Maybe ActionType

  type

• _actionDuration :: Maybe Int

  duration

• _actionOrigin :: Maybe String

  origin

• _actionValue :: Maybe String

  value

• _actionButton :: Maybe Int

  button

• _actionX :: Maybe Int

  x

• _actionY :: Maybe Int

  y

Instances

Eq ActionItem

Defined in Web.Api.WebDriver.Types

Methods

(==) :: ActionItem -> ActionItem -> Bool

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

Show ActionItem

Defined in Web.Api.WebDriver.Types

Methods

showsPrec :: Int -> ActionItem -> ShowS

show :: ActionItem -> String

showList :: [ActionItem] -> ShowS

Arbitrary ActionItem

Defined in Web.Api.WebDriver.Types

Methods

arbitrary :: Gen ActionItem

shrink :: ActionItem -> [ActionItem]

ToJSON ActionItem

Defined in Web.Api.WebDriver.Types

Methods

toJSON :: ActionItem -> Value

toEncoding :: ActionItem -> Encoding

toJSONList :: [ActionItem] -> Value

toEncodingList :: [ActionItem] -> Encoding

FromJSON ActionItem

Defined in Web.Api.WebDriver.Types

Methods

parseJSON :: Value -> Parser ActionItem

parseJSONList :: Value -> Parser [ActionItem]

emptyActionItem :: ActionItem

All members set to Nothing.

Misc

data LocationStrategy

See https://w3c.github.io/webdriver/webdriver-spec.html#dfn-table-of-location-strategies.

Constructors

CssSelector

css selector

LinkTextSelector

link text

PartialLinkTextSelector

partial link text

TagName

tag name

XPathSelector

xpath

Instances

Bounded LocationStrategy

Defined in Web.Api.WebDriver.Types

Methods

minBound :: LocationStrategy

maxBound :: LocationStrategy

Enum LocationStrategy

Defined in Web.Api.WebDriver.Types

Methods

succ :: LocationStrategy -> LocationStrategy

pred :: LocationStrategy -> LocationStrategy

toEnum :: Int -> LocationStrategy

fromEnum :: LocationStrategy -> Int

enumFrom :: LocationStrategy -> [LocationStrategy]

enumFromThen :: LocationStrategy -> LocationStrategy -> [LocationStrategy]

enumFromTo :: LocationStrategy -> LocationStrategy -> [LocationStrategy]

enumFromThenTo :: LocationStrategy -> LocationStrategy -> LocationStrategy -> [LocationStrategy]

Eq LocationStrategy

Defined in Web.Api.WebDriver.Types

Methods

(==) :: LocationStrategy -> LocationStrategy -> Bool

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

Show LocationStrategy

Defined in Web.Api.WebDriver.Types

Methods

showsPrec :: Int -> LocationStrategy -> ShowS

show :: LocationStrategy -> String

showList :: [LocationStrategy] -> ShowS

Arbitrary LocationStrategy

Defined in Web.Api.WebDriver.Types

Methods

arbitrary :: Gen LocationStrategy

shrink :: LocationStrategy -> [LocationStrategy]

ToJSON LocationStrategy

Defined in Web.Api.WebDriver.Types

Methods

toJSON :: LocationStrategy -> Value

toEncoding :: LocationStrategy -> Encoding

toJSONList :: [LocationStrategy] -> Value

toEncodingList :: [LocationStrategy] -> Encoding

FromJSON LocationStrategy

Defined in Web.Api.WebDriver.Types

Methods

parseJSON :: Value -> Parser LocationStrategy

parseJSONList :: Value -> Parser [LocationStrategy]

data Rect

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

Constructors

Rect

Fields

• _rectX :: Scientific

  x

• _rectY :: Scientific

  y

• _rectWidth :: Scientific

  width

• _rectHeight :: Scientific

  height

Instances

Eq Rect

Defined in Web.Api.WebDriver.Types

Methods

(==) :: Rect -> Rect -> Bool

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

Show Rect

Defined in Web.Api.WebDriver.Types

Methods

showsPrec :: Int -> Rect -> ShowS

show :: Rect -> String

showList :: [Rect] -> ShowS

Arbitrary Rect

Defined in Web.Api.WebDriver.Types

Methods

arbitrary :: Gen Rect

shrink :: Rect -> [Rect]

ToJSON Rect

Defined in Web.Api.WebDriver.Types

Methods

toJSON :: Rect -> Value

toEncoding :: Rect -> Encoding

toJSONList :: [Rect] -> Value

toEncodingList :: [Rect] -> Encoding

FromJSON Rect

Defined in Web.Api.WebDriver.Types

Methods

parseJSON :: Value -> Parser Rect

parseJSONList :: Value -> Parser [Rect]

emptyRect :: Rect

All members set to `0`.

data PromptHandler

See https://w3c.github.io/webdriver/webdriver-spec.html#dfn-known-prompt-handling-approaches-table.

Constructors

DismissPrompts

dismiss

AcceptPrompts

accept

DismissPromptsAndNotify

dismiss and notify

AcceptPromptsAndNotify

accept and notify

IgnorePrompts

ignore

Instances

Bounded PromptHandler

Defined in Web.Api.WebDriver.Types

Methods

minBound :: PromptHandler

maxBound :: PromptHandler

Enum PromptHandler

Defined in Web.Api.WebDriver.Types

Methods

succ :: PromptHandler -> PromptHandler

pred :: PromptHandler -> PromptHandler

toEnum :: Int -> PromptHandler

fromEnum :: PromptHandler -> Int

enumFrom :: PromptHandler -> [PromptHandler]

enumFromThen :: PromptHandler -> PromptHandler -> [PromptHandler]

enumFromTo :: PromptHandler -> PromptHandler -> [PromptHandler]

enumFromThenTo :: PromptHandler -> PromptHandler -> PromptHandler -> [PromptHandler]

Eq PromptHandler

Defined in Web.Api.WebDriver.Types

Methods

(==) :: PromptHandler -> PromptHandler -> Bool

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

Show PromptHandler

Defined in Web.Api.WebDriver.Types

Methods

showsPrec :: Int -> PromptHandler -> ShowS

show :: PromptHandler -> String

showList :: [PromptHandler] -> ShowS

Arbitrary PromptHandler

Defined in Web.Api.WebDriver.Types

Methods

arbitrary :: Gen PromptHandler

shrink :: PromptHandler -> [PromptHandler]

ToJSON PromptHandler

Defined in Web.Api.WebDriver.Types

Methods

toJSON :: PromptHandler -> Value

toEncoding :: PromptHandler -> Encoding

toJSONList :: [PromptHandler] -> Value

toEncodingList :: [PromptHandler] -> Encoding

FromJSON PromptHandler

Defined in Web.Api.WebDriver.Types

Methods

parseJSON :: Value -> Parser PromptHandler

parseJSONList :: Value -> Parser [PromptHandler]

data Cookie

See https://w3c.github.io/webdriver/webdriver-spec.html#dfn-table-for-cookie-conversion.

Constructors

Cookie

Fields

• _cookieName :: Maybe String

  name

• _cookieValue :: Maybe String

  value

• _cookiePath :: Maybe String

  path

• _cookieDomain :: Maybe String

  domain

• _cookieSecure :: Maybe Bool

  secure

• _cookieHttpOnly :: Maybe Bool

  httpOnly

• _cookieExpiryTime :: Maybe String

  expiryTime

Instances

Eq Cookie

Defined in Web.Api.WebDriver.Types

Methods

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

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

Show Cookie

Defined in Web.Api.WebDriver.Types

Methods

showsPrec :: Int -> Cookie -> ShowS

show :: Cookie -> String

showList :: [Cookie] -> ShowS

Arbitrary Cookie

Defined in Web.Api.WebDriver.Types

Methods

arbitrary :: Gen Cookie

shrink :: Cookie -> [Cookie]

ToJSON Cookie

Defined in Web.Api.WebDriver.Types

Methods

toJSON :: Cookie -> Value

toEncoding :: Cookie -> Encoding

toJSONList :: [Cookie] -> Value

toEncodingList :: [Cookie] -> Encoding

FromJSON Cookie

Defined in Web.Api.WebDriver.Types

Methods

parseJSON :: Value -> Parser Cookie

parseJSONList :: Value -> Parser [Cookie]

emptyCookie :: Cookie

All members set to Nothing.

Error Responses

data ResponseErrorCode

Semantic HTTP error responses. See https://w3c.github.io/webdriver/webdriver-spec.html#locator-strategies.

Constructors

ElementClickIntercepted

ElementNotSelectable

ElementNotInteractable

InsecureCertificate

InvalidArgument

InvalidCookieDomain

InvalidCoordinates

InvalidElementState

InvalidSelector

InvalidSessionId

JavaScriptError

MoveTargetOutOfBounds

NoSuchAlert

NoSuchCookie

NoSuchElement

NoSuchFrame

NoSuchWindow

ScriptTimeout

SessionNotCreated

StaleElementReference

Timeout

UnableToSetCookie

UnableToCaptureScreen

UnexpectedAlertOpen

UnknownCommand

UnknownError

UnknownMethod

UnsupportedOperation

UnhandledErrorCode Text

Just in case!

Instances

Eq ResponseErrorCode

Defined in Web.Api.WebDriver.Types

Methods

(==) :: ResponseErrorCode -> ResponseErrorCode -> Bool

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

Show ResponseErrorCode

Defined in Web.Api.WebDriver.Types

Methods

showsPrec :: Int -> ResponseErrorCode -> ShowS

show :: ResponseErrorCode -> String

showList :: [ResponseErrorCode] -> ShowS

Arbitrary ResponseErrorCode

Defined in Web.Api.WebDriver.Types

Methods

arbitrary :: Gen ResponseErrorCode

shrink :: ResponseErrorCode -> [ResponseErrorCode]

ToJSON ResponseErrorCode

Defined in Web.Api.WebDriver.Types

Methods

toJSON :: ResponseErrorCode -> Value

toEncoding :: ResponseErrorCode -> Encoding

toJSONList :: [ResponseErrorCode] -> Value

toEncodingList :: [ResponseErrorCode] -> Encoding

FromJSON ResponseErrorCode

Defined in Web.Api.WebDriver.Types

Methods

parseJSON :: Value -> Parser ResponseErrorCode

parseJSONList :: Value -> Parser [ResponseErrorCode]