Test.WebDriver.Capabilities · webdriver-0.15.0.0

Capabilities

2 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
- _capabilitiesBrowserName :: Maybe String
  Identifies the user agent.
- _capabilitiesBrowserVersion :: Maybe String
  Identifies the version of the user agent.
- _capabilitiesPlatformName :: Maybe Platform
  Identifies the operating system of the endpoint node.
- _capabilitiesAcceptInsecureCerts :: Maybe Bool
  Indicates whether untrusted and self-signed TLS certificates are implicitly trusted on navigation for the duration of the session.
- _capabilitiesPageLoadStrategy :: Maybe String
  Defines the current session’s page load strategy.
- _capabilitiesProxy :: Maybe Proxy
  Defines the current session’s proxy configuration.
- _capabilitiesSetWindowRect :: Maybe Bool
  Indicates whether the remote end supports all of the commands in Resizing and Positioning Windows.
- _capabilitiesTimeouts :: Maybe Timeouts
  Describes the timeouts imposed on certain session operations.
- _capabilitiesUnhandledPromptBehavior :: Maybe UserPromptHandler
  Describes the current session’s user prompt handler.
- _capabilitiesGoogChromeOptions :: Maybe ChromeOptions
  Chrome options
- _capabilitiesMozFirefoxOptions :: Maybe FirefoxOptions
  Firefox options
- _capabilitiesWebSocketUrl :: Maybe Bool

Instances4Eq, Show, FromJSON, ToJSON

Eq CapabilitiesDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities
Show CapabilitiesDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities
FromJSON CapabilitiesDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities
ToJSON CapabilitiesDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities

valuedefaultCaps :: Capabilities

#

Default capabilities.

Lenses

valuecapabilitiesBrowserName :: Lens' Capabilities (Maybe String)

#

valuecapabilitiesBrowserVersion :: Lens' Capabilities (Maybe String)

#

valuecapabilitiesPlatformName :: Lens' Capabilities (Maybe Platform)

#

valuecapabilitiesAcceptInsecureCerts :: Lens' Capabilities (Maybe Bool)

#

valuecapabilitiesPageLoadStrategy :: Lens' Capabilities (Maybe String)

#

valuecapabilitiesProxy :: Lens' Capabilities (Maybe Proxy)

#

valuecapabilitiesSetWindowRect :: Lens' Capabilities (Maybe Bool)

#

valuecapabilitiesTimeouts :: Lens' Capabilities (Maybe Timeouts)

#

valuecapabilitiesUnhandledPromptBehavior :: Lens' Capabilities (Maybe UserPromptHandler)

#

valuecapabilitiesGoogChromeOptions :: Lens' Capabilities (Maybe ChromeOptions)

#

valuecapabilitiesMozFirefoxOptions :: Lens' Capabilities (Maybe FirefoxOptions)

#

valuecapabilitiesWebSocketUrl :: Lens' Capabilities (Maybe Bool)

#

Types

datadata Timeouts

#

Constructors

Timeouts
- timeoutsScriptMs :: Maybe Int
- timeoutsPageLoadMs :: Maybe Int
- timeoutsImplicitMs :: Maybe Int

Instances4Eq, Show, FromJSON, ToJSON

Eq TimeoutsDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.Timeouts
Show TimeoutsDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.Timeouts
FromJSON TimeoutsDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.Timeouts
ToJSON TimeoutsDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.Timeouts

datadata UserPromptHandler

#

UserPromptHandlerDismiss UserPromptHandlerAccept UserPromptHandlerDismissAndNotify UserPromptHandlerAcceptAndNotify UserPromptHandlerIgnore

Instances4Eq, Show, FromJSON, ToJSON

Eq UserPromptHandlerDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.UserPromptHandler
Show UserPromptHandlerDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.UserPromptHandler
FromJSON UserPromptHandlerDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.UserPromptHandler
ToJSON UserPromptHandlerDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.UserPromptHandler

datadata Platform

#

Represents the platformName option of the primary capabilities

Constructors

Windows
XP
Vista
Mac
Linux
Unix
Any
Other Text

Instances5Eq, Ord, Show, FromJSON, ToJSON

Eq PlatformDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.Platform
Ord PlatformDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.Platform
Show PlatformDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.Platform
FromJSON PlatformDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.Platform
ToJSON PlatformDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.Platform

Chrome

2 declarations

datadata ChromeOptions

#

See https://developer.chrome.com/docs/chromedriver/capabilities#chromeoptions_object

Constructors

ChromeOptions
- _chromeOptionsArgs :: Maybe [String]
  List of command-line arguments to use when starting Chrome. Arguments with an associated value should be separated by a = sign (such as, ['start-maximized', 'user-data-dir=tmptemp_profile']). See a list of Chrome arguments: https://peter.sh/experiments/chromium-command-line-switches/
- _chromeOptionsBinary :: Maybe FilePath
  Path to the Chrome executable to use. On macOS X, this should be the actual binary, not just the app, such as, ApplicationsGoogle Chrome.appContentsMacOS/Google Chrome.
- _chromeOptionsExtensions :: Maybe [ChromeExtension]
  A list of Chrome extensions to install on startup. Each item in the list should be a base-64 encoded packed Chrome extension (.crx)
- _chromeOptionsLocalState :: Maybe Object
  A dictionary with each entry consisting of the name of the preference and its value. These preferences are applied to the Local State file in the user data folder.
- _chromeOptionsPrefs :: Maybe Object
  A dictionary with each entry consisting of the name of the preference and its value. These preferences are only applied to the user profile in use. See the Preferences file in Chrome's user data directory for examples.
- _chromeOptionsDetach :: Maybe Bool
  If false, Chrome is quit when ChromeDriver is killed, regardless of whether the session is quit. If true, Chrome only quits if the session is quit or closed. If true and the session isn't quit, ChromeDriver cannot clean up the temporary user data directory that the running Chrome instance is using.
- _chromeOptionsDebuggerAddress :: Maybe String
  An address of a Chrome debugger server to connect to, in the form of hostname/ip:port, such as '127.0.0.1:38947'
- _chromeOptionsExcludeSwitches :: Maybe [String]
  List of Chrome command line switches to exclude that ChromeDriver by default passes when starting Chrome. Don't prefix switches with --.
- _chromeOptionsMinidumpPath :: Maybe FilePath
  Directory to store Chrome minidumps. (Supported only on Linux.)
- _chromeOptionsMobileEmulation :: Maybe ChromeMobileEmulation
  A dictionary with either a value for "deviceName," or values for "deviceMetrics", and "userAgent." Refer to Mobile Emulation for more information.
- _chromeOptionsPerfLoggingPrefs :: Maybe Object
  An optional dictionary that specifies performance logging preferences.
- _chromeOptionsWindowTypes :: Maybe [String]
  A list of window types that appear in the list of window handles. For access to webview elements, include "webview" in this list.

Instances4Eq, Show, FromJSON, ToJSON

Eq ChromeOptionsDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.ChromeOptions
Show ChromeOptionsDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.ChromeOptions
FromJSON ChromeOptionsDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.ChromeOptions
ToJSON ChromeOptionsDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.ChromeOptions

valuedefaultChromeOptions :: ChromeOptions

#

Empty ChromeOptions.

Lenses

valuechromeOptionsWindowTypes :: Lens' ChromeOptions (Maybe [String])

#

valuechromeOptionsPrefs :: Lens' ChromeOptions (Maybe Object)

#

valuechromeOptionsPerfLoggingPrefs :: Lens' ChromeOptions (Maybe Object)

#

valuechromeOptionsMobileEmulation :: Lens' ChromeOptions (Maybe ChromeMobileEmulation)

#

valuechromeOptionsMinidumpPath :: Lens' ChromeOptions (Maybe FilePath)

#

valuechromeOptionsLocalState :: Lens' ChromeOptions (Maybe Object)

#

valuechromeOptionsExtensions :: Lens' ChromeOptions (Maybe [ChromeExtension])

#

valuechromeOptionsExcludeSwitches :: Lens' ChromeOptions (Maybe [String])

#

valuechromeOptionsDetach :: Lens' ChromeOptions (Maybe Bool)

#

valuechromeOptionsDebuggerAddress :: Lens' ChromeOptions (Maybe String)

#

valuechromeOptionsBinary :: Lens' ChromeOptions (Maybe FilePath)

#

valuechromeOptionsArgs :: Lens' ChromeOptions (Maybe [String])

#

Client hints

datadata ChromeClientHints

#

See https://developer.chrome.com/docs/chromedriver/mobile-emulation

Constructors

ChromeClientHints
- _chromeClientHintsPlatform :: String
  The operating system. It can be either a known value (Android, "Chrome OS", "Chromium OS", Fuchsia, Linux, "macOS", Windows), that exactly matches the value returned by Chrome running on the given platform, or it can be a user defined value. This value is mandatory.
- _chromeClientHintsMobile :: Bool
  Whether the browser should request a mobile or desktop resource version. Usually Chrome running on a mobile phone with Android sets this value to true. Chrome on a tablet Android device sets this value to false. Chrome on a desktop device also sets this value to false. You can use this information to specify a realistic emulation. This value is mandatory.
- _chromeClientHintsBrands :: Maybe [BrandAndVersion]
  List of brand / major version pairs. If omitted the browser uses its own values.
- _chromeClientHintsFullVersionList :: Maybe [BrandAndVersion]
  List of brand / version pairs. It omitted the browser uses its own values.
- _chromeClientHintsPlatformVersion :: Maybe String
  OS version. Defaults to empty string.
- _chromeClientHintsModel :: Maybe String
  Device model. Defaults to empty string.
- _chromeClientHintsArchitecture :: Maybe String
  CPU architecture. Known values are "x86" and "arm". The user is free to provide any string value. Defaults to empty string.
- _chromeClientHintsBitness :: Maybe String
  Platform bitness. Known values are "32" and "64". The user is free to provide any string value. Defaults to empty string.
- _chromeClientHintsWow64 :: Maybe Bool
  Emulation of windows 32 on windows 64. A boolean value that defaults to false.

Instances4Eq, Show, FromJSON, ToJSON

Eq ChromeClientHintsDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.ChromeOptions
Show ChromeClientHintsDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.ChromeOptions
FromJSON ChromeClientHintsDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.ChromeOptions
ToJSON ChromeClientHintsDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.ChromeOptions

valuemkChromeClientHints :: String -> Bool -> ChromeClientHints

#

valuechromeClientHintsWow64 :: Lens' ChromeClientHints (Maybe Bool)

#

valuechromeClientHintsPlatformVersion :: Lens' ChromeClientHints (Maybe String)

#

valuechromeClientHintsPlatform :: Lens' ChromeClientHints String

#

valuechromeClientHintsModel :: Lens' ChromeClientHints (Maybe String)

#

valuechromeClientHintsMobile :: Lens' ChromeClientHints Bool

#

valuechromeClientHintsFullVersionList :: Lens' ChromeClientHints (Maybe [BrandAndVersion])

#

valuechromeClientHintsBrands :: Lens' ChromeClientHints (Maybe [BrandAndVersion])

#

valuechromeClientHintsBitness :: Lens' ChromeClientHints (Maybe String)

#

valuechromeClientHintsArchitecture :: Lens' ChromeClientHints (Maybe String)

#

datadata BrandAndVersion

#

Constructors

BrandAndVersion
- brandAndVersionBrand :: String
- brandAndVersionVersion :: String

Instances4Eq, Show, FromJSON, ToJSON

Eq BrandAndVersionDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.ChromeOptions
Show BrandAndVersionDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.ChromeOptions
FromJSON BrandAndVersionDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.ChromeOptions
ToJSON BrandAndVersionDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.ChromeOptions

Device metrics

datadata ChromeDeviceMetrics

#

See https://developer.chrome.com/docs/chromedriver/mobile-emulation

Constructors

ChromeDeviceMetrics
- _chromeDeviceMetricsWidth :: Maybe Int
  The width in pixels of the device's screen.
- _chromeDeviceMetricsHeight :: Maybe Int
  The height in pixels of the device's screen.
- _chromeDeviceMetricsPixelRatio :: Maybe Double
  The device's pixel ratio.
- _chromeDeviceMetricsTouch :: Maybe Bool
  Whether to emulate touch events. The value defaults to true and usually can be omitted.
- _chromeDeviceMetricsMobile :: Maybe Bool
  Whether the browser must behave as a mobile user agent (overlay scrollbars, emit orientation events, shrink the content to fit the viewport, etc.). The value defaults to true and usually can be omitted.

Instances4Eq, Show, FromJSON, ToJSON

Eq ChromeDeviceMetricsDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.ChromeOptions
Show ChromeDeviceMetricsDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.ChromeOptions
FromJSON ChromeDeviceMetricsDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.ChromeOptions
ToJSON ChromeDeviceMetricsDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.ChromeOptions

valuechromeDeviceMetricsWidth :: Lens' ChromeDeviceMetrics (Maybe Int)

#

valuechromeDeviceMetricsTouch :: Lens' ChromeDeviceMetrics (Maybe Bool)

#

valuechromeDeviceMetricsPixelRatio :: Lens' ChromeDeviceMetrics (Maybe Double)

#

valuechromeDeviceMetricsMobile :: Lens' ChromeDeviceMetrics (Maybe Bool)

#

valuechromeDeviceMetricsHeight :: Lens' ChromeDeviceMetrics (Maybe Int)

#

Extensions

newtypenewtype ChromeExtension

#

A packed Google Chrome extension (.crx), as base64-encoded Text.

Instances5Eq, Read, Show, FromJSON, ToJSON

Eq ChromeExtensionDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.ChromeOptions
Read ChromeExtensionDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.ChromeOptions
Show ChromeExtensionDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.ChromeOptions
FromJSON ChromeExtensionDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.ChromeOptions
ToJSON ChromeExtensionDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.ChromeOptions

valueloadExtension :: MonadIO m => FilePath -> m ChromeExtension

#

Load a .crx file as a ChromeExtension.

valueloadRawExtension :: ByteString -> ChromeExtension

#

Load raw .crx data as a ChromeExtension.

Mobile emulation

datadata ChromeMobileEmulation

#

See https://developer.chrome.com/docs/chromedriver/mobile-emulation

Constructors

ChromeMobileEmulationSpecificDevice
Specify a known device. To enable device emulation with a specific device, the "mobileEmulation" dictionary must contain a "deviceName." Use a valid device name from the DevTools Emulated Devices settings as the value for "deviceName."
- _chromeMobileEmulationDeviceName :: String
ChromeMobileEmulationIndividualAttributes
Specify individual device attributes.
- _chromeMobileEmulationDeviceMetrics :: Maybe ChromeDeviceMetrics
- _chromeMobileEmulationClientHints :: Maybe ChromeClientHints
- _chromeMobileEmulationUserAgent :: Maybe String
  ChromeDriver is capable to infer "userAgent" value from "clientHints" on the following platforms: Android, "Chrome OS", "Chromium OS", Fuchsia, Linux, "macOS", Windows. Therefore this value can be omitted.
  If "clientHints" dictionary is omitted (legacy mode) ChromeDriver does its best to infer the "clientHints" from "userAgent". This feature is not reliable, due to internal ambiguities of "userAgent" value format.

Instances4Eq, Show, FromJSON, ToJSON

Eq ChromeMobileEmulationDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.ChromeOptions
Show ChromeMobileEmulationDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.ChromeOptions
FromJSON ChromeMobileEmulationDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.ChromeOptions
ToJSON ChromeMobileEmulationDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.ChromeOptions

valuechromeMobileEmulationUserAgent :: Traversal' ChromeMobileEmulation (Maybe String)

#

valuechromeMobileEmulationDeviceName :: Traversal' ChromeMobileEmulation String

#

valuechromeMobileEmulationDeviceMetrics :: Traversal' ChromeMobileEmulation (Maybe ChromeDeviceMetrics)

#

valuechromeMobileEmulationClientHints :: Traversal' ChromeMobileEmulation (Maybe ChromeClientHints)

#

Firefox

3 declarations

datadata FirefoxOptions

#

See https://developer.mozilla.org/en-US/docs/Web/WebDriver/Capabilities/firefoxOptions

Constructors

FirefoxOptions
- _firefoxOptionsBinary :: Maybe String
  Absolute path to the custom Firefox binary to use.
  On macOS you may either give the path to the application bundle, i.e. /Applications/Firefox.app, or the absolute path to the executable binary inside this bundle, for example /Applications/Firefox.app/Contents/MacOS/firefox-bin.
  geckodriver will attempt to deduce the default location of Firefox on the current system if left undefined.
- _firefoxOptionsArgs :: Maybe [String]
  Command line arguments to pass to the Firefox binary. These must include the leading dash (-) where required, e.g. ["-headless"].
  To have geckodriver pick up an existing profile on the local filesystem, you may pass ["-profile", -- "/path/to/profile"]. But if a profile has to be transferred to a target machine it is recommended to use the profile entry.
- _firefoxOptionsProfile :: Maybe (Profile Firefox)
  Base64-encoded ZIP of a profile directory to use for the Firefox instance. This may be used to e.g. install extensions or custom certificates, but for setting custom preferences we recommend using the prefs entry instead.
- _firefoxOptionsLog :: Maybe FirefoxLogLevel
  To increase the logging verbosity of geckodriver and Firefox, you may pass a log object that may look like {"log": {"level": "trace"}} to include all trace-level logs and above.
- _firefoxOptionsPrefs :: Maybe Object
  Map of preference name to preference value, which can be a string, a boolean or an integer.
- _firefoxOptionsEnv :: Maybe (Map String String)
  Map of environment variable name to environment variable value, both of which must be strings.
  On Desktop, the Firefox under test will launch with given variable in its environment. On Android, the GeckoView-based App will have the given variable added to the env block in its configuration YAML.

Instances4Eq, Show, FromJSON, ToJSON

Eq FirefoxOptionsDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.FirefoxOptions
Show FirefoxOptionsDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.FirefoxOptions
FromJSON FirefoxOptionsDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.FirefoxOptions
ToJSON FirefoxOptionsDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.FirefoxOptions

valueemptyFirefoxOptions :: FirefoxOptions

#

valuedefaultFirefoxOptions :: FirefoxOptions

#

Empty FirefoxOptions.

Lenses

valuefirefoxOptionsBinary :: Lens' FirefoxOptions (Maybe String)

#

valuefirefoxOptionsArgs :: Lens' FirefoxOptions (Maybe [String])

#

valuefirefoxOptionsProfile :: Lens' FirefoxOptions (Maybe (Profile Firefox))

#

valuefirefoxOptionsLog :: Lens' FirefoxOptions (Maybe FirefoxLogLevel)

#

valuefirefoxOptionsPrefs :: Lens' FirefoxOptions (Maybe Object)

#

valuefirefoxOptionsEnv :: Lens' FirefoxOptions (Maybe (Map String String))

#

Log level

datadata FirefoxLogLevel

#

Constructors

FirefoxLogLevel
- _firefoxLogLevelLevel :: FirefoxLogLevelType

Instances4Eq, Show, FromJSON, ToJSON

Eq FirefoxLogLevelDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.FirefoxOptions
Show FirefoxLogLevelDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.FirefoxOptions
FromJSON FirefoxLogLevelDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.FirefoxOptions
ToJSON FirefoxLogLevelDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.FirefoxOptions

datadata FirefoxLogLevelType

#

FirefoxLogLevelTypeTrace FirefoxLogLevelTypeDebug FirefoxLogLevelTypeConfig FirefoxLogLevelTypeInfo FirefoxLogLevelTypeWarn FirefoxLogLevelTypeError FirefoxLogLevelTypeFatal

Instances4Eq, Show, FromJSON, ToJSON

Eq FirefoxLogLevelTypeDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.FirefoxOptions
Show FirefoxLogLevelTypeDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.FirefoxOptions
FromJSON FirefoxLogLevelTypeDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.FirefoxOptions
ToJSON FirefoxLogLevelTypeDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.FirefoxOptions