Modulewebdriver-0.12.0.1Haskell2010

Test.WebDriver.Types

37 types
14 values

Packagewebdriver-0.12.0.1
Exports51
LanguageHaskell2010
LicenceBSD-3-Clause
SourceMonad.hs

WebDriver sessions

4 declarations

newtypenewtype WD a

A state monad for WebDriver commands.

Constructors

WD (StateT WDSession IO a)

Instances13Monad, Functor, MonadFix, Applicative, MonadIO, MonadCatch, …

Monad WDDefined in webdriver-0.12.0.1 · Test.WebDriver.Monad
Functor WDDefined in webdriver-0.12.0.1 · Test.WebDriver.Monad
MonadFix WDDefined in webdriver-0.12.0.1 · Test.WebDriver.Monad
Applicative WDDefined in webdriver-0.12.0.1 · Test.WebDriver.Monad
MonadIO WDDefined in webdriver-0.12.0.1 · Test.WebDriver.Monad
MonadCatch WDDefined in webdriver-0.12.0.1 · Test.WebDriver.Monad
MonadMask WDDefined in webdriver-0.12.0.1 · Test.WebDriver.Monad
MonadThrow WDDefined in webdriver-0.12.0.1 · Test.WebDriver.Monad
WebDriver WDDefined in webdriver-0.12.0.1 · Test.WebDriver.Monad
WDSessionState WDDefined in webdriver-0.12.0.1 · Test.WebDriver.Monad
MonadBase IO WDDefined in webdriver-0.12.0.1 · Test.WebDriver.Monad
MonadBaseControl IO WDDefined in webdriver-0.12.0.1 · Test.WebDriver.Monad
type StM WD a = StM (StateT WDSession IO) aDefined in webdriver-0.12.0.1 · Test.WebDriver.Monad

datadata WDSession

The local state of a WebDriver session. This structure is passed implicitly through all WD computations

Constructors

WDSession
- wdSessHost :: ByteString
- wdSessPort :: Int
- wdSessBasePath :: ByteString
- wdSessId :: Maybe SessionId
  An opaque reference identifying the session to use with WD commands. A value of Nothing indicates that a session hasn't been created yet. Sessions can be created within WD via Test.WebDriver.createSession, or created automatically with Test.WebDriver.runSession
- wdSessHist :: [SessionHistory]
  The complete history of HTTP requests and responses, most recent first.
- wdSessHistUpdate :: SessionHistoryConfig
  Update function used to append new entries to session history
- wdSessHTTPManager :: Manager
  HTTP Manager used for connection pooling by the http-client library.
- wdSessHTTPRetryCount :: Int
  Number of times to retry a HTTP request if it times out
- wdSessRequestHeaders :: RequestHeaders
  Custom request headers to add to every HTTP request.
- wdSessAuthHeaders :: RequestHeaders
  Custom request headers to add *only* to session creation requests. This is usually done when a WebDriver server requires HTTP auth.

newtypenewtype 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

Instances6Eq, Ord, Read, Show, FromJSON, ToJSON

Eq SessionIdDefined in webdriver-0.12.0.1 · Test.WebDriver.Session
Ord SessionIdDefined in webdriver-0.12.0.1 · Test.WebDriver.Session
Read SessionIdDefined in webdriver-0.12.0.1 · Test.WebDriver.Session
Show SessionIdDefined in webdriver-0.12.0.1 · Test.WebDriver.Session
FromJSON SessionIdDefined in webdriver-0.12.0.1 · Test.WebDriver.Session
ToJSON SessionIdDefined in webdriver-0.12.0.1 · Test.WebDriver.Session

datadata SessionHistory

Instances1Show

Show SessionHistoryDefined in webdriver-0.12.0.1 · Test.WebDriver.Session.History

WebDriver configuration

3 declarations

datadata WDConfig

WebDriver session configuration

Constructors

WDConfig
- wdHost :: String
  Host name of the WebDriver server for this session (default 127.0.0.1)
- wdPort :: Int
  Port number of the server (default 4444)
- wdCapabilities :: Capabilities
  Capabilities to use for this session
- wdBasePath :: String
  Base path for all API requests (default "/wd/hub")
- wdRequestHeaders :: RequestHeaders
  Custom request headers to add to every HTTP request.
- wdAuthHeaders :: RequestHeaders
  Custom request headers to add *only* to session creation requests. This is usually done when a WebDriver server requires HTTP auth.
- wdHistoryConfig :: SessionHistoryConfig
  Specifies behavior of HTTP request/response history. By default we use unlimitedHistory.
- wdHTTPManager :: Maybe Manager
  Use the given http-client Manager instead of automatically creating one.
- wdHTTPRetryCount :: Int
  Number of times to retry a HTTP request if it times out (default 0)

Instances4Default, GetCapabilities, SetCapabilities, WebDriverConfig

Default WDConfigDefined in webdriver-0.12.0.1 · Test.WebDriver.Config
GetCapabilities WDConfigDefined in webdriver-0.12.0.1 · Test.WebDriver.Config
SetCapabilities WDConfigDefined in webdriver-0.12.0.1 · Test.WebDriver.Config
WebDriverConfig WDConfigDefined in webdriver-0.12.0.1 · Test.WebDriver.Config

valuedefaultConfig :: WDConfig

A default session config connects to localhost on port 4444, and hasn't been initialized server-side. This value is the same as def but with a less polymorphic type.

typetype SessionHistoryConfig = SessionHistory -> [SessionHistory] -> [SessionHistory]

A function used by wdHistoryConfig to append new entries to session history.

Capabilities

6 declarations

datadata Capabilities

A structure describing the capabilities of a session. This record serves dual roles.

It's used to specify the desired capabilities for a session before it's created. In this usage, fields that are set to Nothing indicate that we have no preference for that capability.
When received from the server , it's used to describe the actual capabilities given to us by the WebDriver server. Here a value of Nothing indicates that the server doesn't support the capability. Thus, for Maybe Bool fields, both Nothing and Just False indicate a lack of support for the desired capability.

Constructors

Capabilities
- browser :: Browser
  Browser choice and browser specific settings.
- version :: Maybe String
  Browser version to use.
- platform :: Platform
  Platform on which the browser should run.
- proxy :: ProxyType
  Proxy configuration settings.
- javascriptEnabled :: Maybe Bool
  Whether the session supports executing JavaScript via executeJS and asyncJS.
- takesScreenshot :: Maybe Bool
  Whether the session supports taking screenshots of the current page with the screenshot command
- handlesAlerts :: Maybe Bool
  Whether the session can interact with modal popups, such as window.alert and window.confirm via acceptAlerts, dismissAlerts, etc.
- databaseEnabled :: Maybe Bool
  Whether the session can interact with database storage.
- locationContextEnabled :: Maybe Bool
  Whether the session can set and query the browser's location context with setLocation and getLocation.
- applicationCacheEnabled :: Maybe Bool
  Whether the session can interact with the application cache .
- browserConnectionEnabled :: Maybe Bool
  Whether the session can query for the browser's connectivity and disable it if desired
- cssSelectorsEnabled :: Maybe Bool
  Whether the session supports CSS selectors when searching for elements.
- webStorageEnabled :: Maybe Bool
  Whether Web Storage (getKey, setKey, etc) support is enabled
- rotatable :: Maybe Bool
  Whether the session can rotate the current page's current layout between Portrait and Landscape orientations.
- acceptSSLCerts :: Maybe Bool
  Whether the session should accept all SSL certs by default
- nativeEvents :: Maybe Bool
  Whether the session is capable of generating native OS events when simulating user input.
- unexpectedAlertBehavior :: Maybe UnexpectedAlertBehavior
  How the session should handle unexpected alerts.
- additionalCaps :: [Pair]
  A list of (Text, Value) pairs specifying additional non-standard capabilities.

Instances6Eq, Show, FromJSON, ToJSON, Default, GetCapabilities

Eq CapabilitiesDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
Show CapabilitiesDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
FromJSON CapabilitiesDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
ToJSON CapabilitiesDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
Default CapabilitiesDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
GetCapabilities CapabilitiesDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities

valuedefaultCaps :: Capabilities

Default capabilities. This is the same as the Default instance, but with less polymorphism. By default, we use firefox of an unspecified version with default system-wide proxy settings on whatever platform is available . All Maybe capabilities are set to Nothing (no preference).

valueallCaps :: Capabilities

Same as defaultCaps, but with all Maybe Bool capabilities set to Just True.

datadata Platform

Represents platform options supported by WebDriver. The value Any represents no preference.

Windows XP Vista Mac Linux Unix Any

Instances7Bounded, Enum, Eq, Ord, Show, FromJSON, …

Bounded PlatformDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
Enum PlatformDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
Eq PlatformDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
Ord PlatformDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
Show PlatformDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
FromJSON PlatformDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
ToJSON PlatformDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities

datadata ProxyType

Available settings for the proxy Capabilities field

Constructors

NoProxy
UseSystemSettings
AutoDetect
PAC
Use a proxy auto-config file specified by URL
- autoConfigUrl :: String
Manual
Manually specify proxy hosts as hostname:port strings. Note that behavior is undefined for empty strings.
- ftpProxy :: String
- sslProxy :: String
- httpProxy :: String

Instances4Eq, Show, FromJSON, ToJSON

Eq ProxyTypeDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
Show ProxyTypeDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
FromJSON ProxyTypeDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
ToJSON ProxyTypeDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities

datadata UnexpectedAlertBehavior

AcceptAlert DismissAlert IgnoreAlert

Instances8Bounded, Enum, Eq, Ord, Read, Show, …

Bounded UnexpectedAlertBehaviorDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
Enum UnexpectedAlertBehaviorDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
Eq UnexpectedAlertBehaviorDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
Ord UnexpectedAlertBehaviorDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
Read UnexpectedAlertBehaviorDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
Show UnexpectedAlertBehaviorDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
FromJSON UnexpectedAlertBehaviorDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
ToJSON UnexpectedAlertBehaviorDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities

Browser-specific capabilities

datadata Browser

This constructor simultaneously specifies which browser the session will use, while also providing browser-specific configuration. Default configuration is provided for each browser by firefox, chrome, opera, ie, etc.

This library uses firefox as its Default browser configuration, when no browser choice is specified.

Constructors

Firefox
- ffProfile :: Maybe (PreparedProfile Firefox)
  The firefox profile to use. If Nothing, a default temporary profile is automatically created and used.
- ffLogPref :: LogLevel
  Firefox logging preference
- ffBinary :: Maybe FilePath
  Server-side path to Firefox binary. If Nothing, use a sensible system-based default.
- ffAcceptInsecureCerts :: Maybe Bool
  Available after Firefox 52, and required only for Firefox geckodriver. Indicates whether untrusted and self-signed TLS certificates are implicitly trusted on navigation for the duration of the session.
Chrome
- chromeDriverVersion :: Maybe String
  Version of the Chrome Webdriver server server to use
  for more information on chromedriver see https://github.com/SeleniumHQ/selenium/wiki/ChromeDriver
- chromeBinary :: Maybe FilePath
  Server-side path to Chrome binary. If Nothing, use a sensible system-based default.
- chromeOptions :: [String]
  A list of command-line options to pass to the Chrome binary.
- chromeExtensions :: [ChromeExtension]
  A list of extensions to use.
- chromeExperimentalOptions :: Object
  Experimental options not yet exposed through a standard API.
IE
- ieIgnoreProtectedModeSettings :: Bool
  Whether to skip the protected mode check. If set, tests may become flaky, unresponsive, or browsers may hang. If not set, and protected mode settings are not the same for all zones, an exception will be thrown on driver construction.
- ieIgnoreZoomSetting :: Bool
  Indicates whether to skip the check that the browser's zoom level is set to 100%. Value is set to false by default.
- ieInitialBrowserUrl :: Maybe Text
  Allows the user to specify the initial URL loaded when IE starts. Intended to be used with ignoreProtectedModeSettings to allow the user to initialize IE in the proper Protected Mode zone. Using this capability may cause browser instability or flaky and unresponsive code. Only "best effort" support is provided when using this capability.
- ieElementScrollBehavior :: IEElementScrollBehavior
  Allows the user to specify whether elements are scrolled into the viewport for interaction to align with the top or bottom of the viewport. The default value is to align with the top of the viewport.
- ieEnablePersistentHover :: Bool
  Determines whether persistent hovering is enabled (true by default). Persistent hovering is achieved by continuously firing mouse over events at the last location the mouse cursor has been moved to.
- ieEnableElementCacheCleanup :: Bool
  Determines whether the driver should attempt to remove obsolete elements from the element cache on page navigation (true by default). This is to help manage the IE driver's memory footprint , removing references to invalid elements.
- ieRequireWindowFocus :: Bool
  Determines whether to require that the IE window have focus before performing any user interaction operations (mouse or keyboard events). This capability is false by default, but delivers much more accurate native events interactions.
- ieBrowserAttachTimeout :: Integer
  The timeout, in milliseconds, that the driver will attempt to locate and attach to a newly opened instance of Internet Explorer . The default is zero, which indicates waiting indefinitely.
- ieLogFile :: Maybe FilePath
  The path to file where server should write log messages to. By default it writes to stdout.
- ieLogLevel :: IELogLevel
  The log level used by the server. Defaults to IELogFatal
- ieHost :: Maybe Text
  The address of the host adapter on which the server will listen for commands.
- ieExtractPath :: Maybe Text
  The path to the directory used to extract supporting files used by the server. Defaults to the TEMP directory if not specified.
- ieSilent :: Bool
  Suppresses diagnostic output when the server is started.
- ieForceCreateProcess :: Bool
  Forces launching Internet Explorer using the CreateProcess API. If this option is not specified, IE is launched using the IELaunchURL, if it is available. For IE 8 and above, this option requires the TabProcGrowth registry value to be set to 0.
- ieSwitches :: Maybe Text
  Specifies command-line switches with which to launch Internet Explorer. This is only valid when used with the forceCreateProcess.
Opera
- operaBinary :: Maybe FilePath
  Server-side path to the Opera binary
- operaProduct :: Maybe String
  Which Opera product we're using, e.g. "desktop", "core"
- operaDetach :: Bool
  Whether the Opera instance should stay open after we close the session. If false, closing the session closes the browser.
- operaAutoStart :: Bool
  Whether to auto-start the Opera binary. If false, OperaDriver will wait for a connection from the browser. By default this is True.
- operaIdle :: Bool
  Whether to use Opera's alternative implicit wait implementation. It will use an in-browser heuristic to guess when a page has finished loading. This feature is experimental, and disabled by default.
- operaDisplay :: Maybe Int
  (*nix only) which X display to use.
- operaLauncher :: Maybe FilePath
  Path to the launcher binary to use. The launcher is a gateway between OperaDriver and the Opera browser. If Nothing, OperaDriver will use the launcher supplied with the package.
- operaPort :: Maybe Word16
  The port we should use to connect to Opera. If Just 0 , use a random port. If Nothing, use the default Opera port. The default opera constructor uses Just 0, since Nothing is likely to cause "address already in use" errors.
- operaHost :: Maybe String
  The host Opera should connect to. Unless you're starting Opera manually you won't need this.
- operaOptions :: Maybe String
  Command-line arguments to pass to Opera.
- operaLogFile :: Maybe FilePath
  Where to send the log output. If Nothing, logging is disabled.
- operaLogPref :: LogLevel
  Log level preference. Defaults to LogInfo
Phantomjs
- phantomjsBinary :: Maybe FilePath
- phantomjsOptions :: [String]
HTMLUnit
IPhone
IPad
Android
Browser Text
some other browser, specified by a string name

Instances5Eq, Show, FromJSON, ToJSON, Default

Eq BrowserDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
Show BrowserDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
FromJSON BrowserDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
ToJSON BrowserDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
Default BrowserDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities

Default settings for browsers

valuefirefox :: Browser

Default Firefox settings. All Maybe fields are set to Nothing. ffLogPref is set to LogInfo.

valuechrome :: Browser

Default Chrome settings. All Maybe fields are set to Nothing, no options are specified, and no extensions are used.

valueie :: Browser

Default IE settings. See the IE constructor for more details on individual defaults

valueopera :: Browser

Default Opera settings. See the Opera constructor for more details on individual defaults.

valueiPhone :: Browser

valueiPad :: Browser

valueandroid :: Browser

datadata LogLevel

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

LogOff LogSevere LogWarning LogInfo LogConfig LogFine LogFiner LogFinest LogDebug LogAll

Instances9Bounded, Enum, Eq, Ord, Read, Show, …

Bounded LogLevelDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
Enum LogLevelDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
Eq LogLevelDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
Ord LogLevelDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
Read LogLevelDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
Show LogLevelDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
FromJSON LogLevelDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
ToJSON LogLevelDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
Default LogLevelDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities

datadata IELogLevel

Logging levels for Internet Explorer

IELogTrace IELogDebug IELogInfo IELogWarn IELogError IELogFatal

Instances9Bounded, Enum, Eq, Ord, Read, Show, …

Bounded IELogLevelDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
Enum IELogLevelDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
Eq IELogLevelDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
Ord IELogLevelDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
Read IELogLevelDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
Show IELogLevelDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
FromJSON IELogLevelDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
ToJSON IELogLevelDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
Default IELogLevelDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities

datadata IEElementScrollBehavior

Specifies how elements scroll into the viewport. (see ieElementScrollBehavior)

AlignTop AlignBottom

Instances9Bounded, Enum, Eq, Ord, Read, Show, …

Bounded IEElementScrollBehaviorDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
Enum IEElementScrollBehaviorDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
Eq IEElementScrollBehaviorDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
Ord IEElementScrollBehaviorDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
Read IEElementScrollBehaviorDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
Show IEElementScrollBehaviorDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
FromJSON IEElementScrollBehaviorDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
ToJSON IEElementScrollBehaviorDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities
Default IEElementScrollBehaviorDefined in webdriver-0.12.0.1 · Test.WebDriver.Capabilities

WebDriver objects and command-specific types

14 declarations

newtypenewtype Element

An opaque identifier for a web page element.

Constructors

Element Text

Instances6Eq, Ord, Read, Show, FromJSON, ToJSON

Eq ElementDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands.Internal
Ord ElementDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands.Internal
Read ElementDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands.Internal
Show ElementDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands.Internal
FromJSON ElementDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands.Internal
ToJSON ElementDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands.Internal

newtypenewtype WindowHandle

An opaque identifier for a browser window

Constructors

WindowHandle Text

Instances7Eq, Ord, Read, Show, FromJSON, ToJSON, …

Eq WindowHandleDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands.Internal
Ord WindowHandleDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands.Internal
Read WindowHandleDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands.Internal
Show WindowHandleDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands.Internal
FromJSON WindowHandleDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands.Internal
ToJSON WindowHandleDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands.Internal
Default WindowHandleDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands.Internal

valuecurrentWindow :: WindowHandle

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

datadata 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

Instances4Eq, Ord, Show, ToJSON

Eq SelectorDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands
Ord SelectorDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands
Show SelectorDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands
ToJSON SelectorDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands

datadata 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

Instances1ToJSON

ToJSON JSArgDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands

datadata 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.

Instances4Eq, Read, Show, ToJSON

Eq FrameSelectorDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands
Read FrameSelectorDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands
Show FrameSelectorDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands
ToJSON FrameSelectorDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands

valuemkCookie :: 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.

datadata Orientation

A screen orientation

Landscape Portrait

Instances7Bounded, Enum, Eq, Ord, Show, FromJSON, …

Bounded OrientationDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands
Enum OrientationDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands
Eq OrientationDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands
Ord OrientationDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands
Show OrientationDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands
FromJSON OrientationDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands
ToJSON OrientationDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands

datadata MouseButton

A mouse button

LeftButton MiddleButton RightButton

Instances7Bounded, Enum, Eq, Ord, Show, FromJSON, …

Bounded MouseButtonDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands
Enum MouseButtonDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands
Eq MouseButtonDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands
Ord MouseButtonDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands
Show MouseButtonDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands
FromJSON MouseButtonDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands
ToJSON MouseButtonDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands

datadata WebStorageType

An HTML 5 storage type

LocalStorage SessionStorage

Instances5Bounded, Enum, Eq, Ord, Show

Bounded WebStorageTypeDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands
Enum WebStorageTypeDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands
Eq WebStorageTypeDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands
Ord WebStorageTypeDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands
Show WebStorageTypeDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands

typetype LogType = String

datadata LogEntry

A record that represents a single log entry.

Constructors

LogEntry
- 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

Instances5Eq, Ord, Read, Show, FromJSON

Eq LogEntryDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands
Ord LogEntryDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands
Read LogEntryDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands
Show LogEntryDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands
FromJSON LogEntryDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands

datadata ApplicationCacheStatus

Uncached Idle Checking Downloading UpdateReady Obsolete

Instances7Bounded, Enum, Eq, Ord, Read, Show, …

Bounded ApplicationCacheStatusDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands
Enum ApplicationCacheStatusDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands
Eq ApplicationCacheStatusDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands
Ord ApplicationCacheStatusDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands
Read ApplicationCacheStatusDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands
Show ApplicationCacheStatusDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands
FromJSON ApplicationCacheStatusDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands

Exceptions

13 declarations

newtypenewtype InvalidURL

An invalid URL was given

Constructors

InvalidURL String

Instances3Eq, Show, Exception

Eq InvalidURLDefined in webdriver-0.12.0.1 · Test.WebDriver.Exceptions.Internal
Show InvalidURLDefined in webdriver-0.12.0.1 · Test.WebDriver.Exceptions.Internal
Exception InvalidURLDefined in webdriver-0.12.0.1 · Test.WebDriver.Exceptions.Internal

newtypenewtype NoSessionId

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

Constructors

NoSessionId String

Instances3Eq, Show, Exception

Eq NoSessionIdDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands.Internal
Show NoSessionIdDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands.Internal
Exception NoSessionIdDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands.Internal

newtypenewtype BadJSON

An error occured when parsing a JSON value.

Constructors

BadJSON String

Instances3Eq, Show, Exception

Eq BadJSONDefined in webdriver-0.12.0.1 · Test.WebDriver.JSON
Show BadJSONDefined in webdriver-0.12.0.1 · Test.WebDriver.JSON
Exception BadJSONDefined in webdriver-0.12.0.1 · Test.WebDriver.JSON

datadata HTTPStatusUnknown

An unexpected HTTP status was sent by the server.

Constructors

HTTPStatusUnknown Int String

Instances3Eq, Show, Exception

Eq HTTPStatusUnknownDefined in webdriver-0.12.0.1 · Test.WebDriver.Exceptions.Internal
Show HTTPStatusUnknownDefined in webdriver-0.12.0.1 · Test.WebDriver.Exceptions.Internal
Exception HTTPStatusUnknownDefined in webdriver-0.12.0.1 · Test.WebDriver.Exceptions.Internal

datadata HTTPConnError

HTTP connection errors.

Constructors

HTTPConnError String Int

Instances3Eq, Show, Exception

Eq HTTPConnErrorDefined in webdriver-0.12.0.1 · Test.WebDriver.Exceptions.Internal
Show HTTPConnErrorDefined in webdriver-0.12.0.1 · Test.WebDriver.Exceptions.Internal
Exception HTTPConnErrorDefined in webdriver-0.12.0.1 · Test.WebDriver.Exceptions.Internal

newtypenewtype UnknownCommand

A command was sent to the WebDriver server that it didn't recognize.

Constructors

UnknownCommand String

Instances3Eq, Show, Exception

Eq UnknownCommandDefined in webdriver-0.12.0.1 · Test.WebDriver.Exceptions.Internal
Show UnknownCommandDefined in webdriver-0.12.0.1 · Test.WebDriver.Exceptions.Internal
Exception UnknownCommandDefined in webdriver-0.12.0.1 · Test.WebDriver.Exceptions.Internal

newtypenewtype ServerError

A server-side exception occured

Constructors

ServerError String

Instances3Eq, Show, Exception

Eq ServerErrorDefined in webdriver-0.12.0.1 · Test.WebDriver.Exceptions.Internal
Show ServerErrorDefined in webdriver-0.12.0.1 · Test.WebDriver.Exceptions.Internal
Exception ServerErrorDefined in webdriver-0.12.0.1 · Test.WebDriver.Exceptions.Internal

datadata FailedCommand

This exception encapsulates a broad variety of exceptions that can occur when a command fails.

Constructors

FailedCommand FailedCommandType FailedCommandInfo

Instances2Show, Exception

Show FailedCommandDefined in webdriver-0.12.0.1 · Test.WebDriver.Exceptions.Internal
Exception FailedCommandDefined in webdriver-0.12.0.1 · Test.WebDriver.Exceptions.Internal

datadata FailedCommandType

The type of failed command exception that occured.

Instances5Bounded, Enum, Eq, Ord, Show

Bounded FailedCommandTypeDefined in webdriver-0.12.0.1 · Test.WebDriver.Exceptions.Internal
Enum FailedCommandTypeDefined in webdriver-0.12.0.1 · Test.WebDriver.Exceptions.Internal
Eq FailedCommandTypeDefined in webdriver-0.12.0.1 · Test.WebDriver.Exceptions.Internal
Ord FailedCommandTypeDefined in webdriver-0.12.0.1 · Test.WebDriver.Exceptions.Internal
Show FailedCommandTypeDefined in webdriver-0.12.0.1 · Test.WebDriver.Exceptions.Internal

datadata FailedCommandInfo

Detailed information about the failed command provided by the server.

Constructors

FailedCommandInfo
- errMsg :: String
  The error message.
- errSess :: Maybe WDSession
  The session associated with the exception.
- errScreen :: Maybe ByteString
  A screen shot of the focused window when the exception occured, if provided.
- errClass :: Maybe String
  The "class" in which the exception was raised, if provided.
- errStack :: [StackFrame]
  A stack trace of the exception.

Instances2Show, FromJSON

Show FailedCommandInfoDefined in webdriver-0.12.0.1 · Test.WebDriver.Exceptions.Internal
Provides a readable printout of the error information, useful for logging.
FromJSON FailedCommandInfoDefined in webdriver-0.12.0.1 · Test.WebDriver.Exceptions.Internal

datadata StackFrame

An individual stack frame from the stack trace provided by the server during a FailedCommand.

Constructors

StackFrame
- sfFileName :: String
- sfClassName :: String
- sfMethodName :: String
- sfLineNumber :: Int

Instances3Eq, Show, FromJSON

Eq StackFrameDefined in webdriver-0.12.0.1 · Test.WebDriver.Exceptions.Internal
Show StackFrameDefined in webdriver-0.12.0.1 · Test.WebDriver.Exceptions.Internal
FromJSON StackFrameDefined in webdriver-0.12.0.1 · Test.WebDriver.Exceptions.Internal

valuemkFailedCommandInfo

Constructs a FailedCommandInfo from only an error message.

valuefailedCommand

Convenience function to throw a FailedCommand locally with no server-side info present.