HORIZON HASKELLDocslts/ghc-9.10.xc74966e2026-09-27Search names, modules, packages, or :: a typeCtrl K

GHC 9.10.3 · lts/ghc-9.10.x · c74966e · 2026-09-27

WebDriver sessions

4 declarations
newtypenewtype WD a
#

A state monad for WebDriver commands.

Constructors

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

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

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

WebDriver configuration

3 declarations
datadata WDConfig
#

WebDriver session configuration

Constructors

Instances4Default, GetCapabilities, SetCapabilities, WebDriverConfig

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.

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

Instances6Eq, Show, FromJSON, ToJSON, Default, GetCapabilities
datadata Platform
#

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

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

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
Instances8Bounded, Enum, Eq, Ord, Read, Show, …

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

datadata LogLevel
#

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

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

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

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

WebDriver objects and command-specific types

14 declarations
newtypenewtype Element
#

An opaque identifier for a web page element.

Constructors

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

Instances7Eq, Ord, Read, Show, FromJSON, ToJSON, …
datadata Selector
#

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

Constructors

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

Instances1ToJSON
  • ToJSON JSArgDefined in webdriver-0.12.0.1 · Test.WebDriver.Commands
datadata FrameSelector
#

Specifies the frame used by focusFrame

Constructors

Instances4Eq, Read, Show, ToJSON
datadata 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

Instances6Eq, Show, Generic, FromJSON, ToJSON, Rep
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

Instances7Bounded, Enum, Eq, Ord, Show, FromJSON, …
datadata MouseButton
#
Instances7Bounded, Enum, Eq, Ord, Show, FromJSON, …
datadata LogEntry
#

A record that represents a single log entry.

Constructors

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
Instances7Bounded, Enum, Eq, Ord, Read, Show, …

Exceptions

13 declarations
newtypenewtype InvalidURL
#

An invalid URL was given

Constructors

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

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

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 FailedCommandType
#
Instances5Bounded, Enum, Eq, Ord, Show
datadata FailedCommandInfo
#

Detailed information about the failed command provided by the server.

Constructors

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