Safe Haskell	None
Language	Haskell2010

WebDriverPreCore.HTTP.SpecDefinition

Contents

The HttpSpec Type
The API

Description

Deprecated: Deprecated in favour of WebDriverPreCore.HTTP.API. SpecDefinition module will be removed in a future release ~ 2027-02-01. See ChangeLog.md for upgrade instructions

Synopsis

data HttpSpec a
- = Get {
  - description :: Text
  - path :: UrlPath
  - parser :: HttpResponse -> Result a
  }
- | Post {
  - description :: Text
  - path :: UrlPath
  - body :: Value
  - parser :: HttpResponse -> Result a
  }
- | PostEmpty {
  - description :: Text
  - path :: UrlPath
  - parser :: HttpResponse -> Result a
  }
- | Delete {
  - description :: Text
  - path :: UrlPath
  - parser :: HttpResponse -> Result a
  }
newSession :: FullCapabilities -> HttpSpec SessionResponse
newSession' :: ToJSON a => a -> HttpSpec SessionResponse
status :: HttpSpec Status
deleteSession :: Session -> HttpSpec ()
getTimeouts :: Session -> HttpSpec Timeouts
setTimeouts :: Session -> Timeouts -> HttpSpec ()
navigateTo :: Session -> URL -> HttpSpec ()
getCurrentUrl :: Session -> HttpSpec URL
back :: Session -> HttpSpec ()
forward :: Session -> HttpSpec ()
refresh :: Session -> HttpSpec ()
getTitle :: Session -> HttpSpec Text
getWindowHandle :: Session -> HttpSpec Handle
newWindow :: Session -> HttpSpec WindowHandleSpec
closeWindow :: Session -> HttpSpec [Handle]
switchToWindow :: Session -> Handle -> HttpSpec ()
switchToFrame :: Session -> FrameReference -> HttpSpec ()
getPageSource :: Session -> HttpSpec Text
executeScript :: Session -> Script -> HttpSpec Value
executeScriptAsync :: Session -> Script -> HttpSpec Value
addCookie :: Session -> Cookie -> HttpSpec ()
getAllCookies :: Session -> HttpSpec [Cookie]
getNamedCookie :: Session -> Text -> HttpSpec Cookie
deleteCookie :: Session -> Text -> HttpSpec ()
deleteAllCookies :: Session -> HttpSpec ()
performActions :: Session -> Actions -> HttpSpec ()
releaseActions :: Session -> HttpSpec ()
dismissAlert :: Session -> HttpSpec ()
acceptAlert :: Session -> HttpSpec ()
getAlertText :: Session -> HttpSpec Text
sendAlertText :: Session -> Text -> HttpSpec ()
takeScreenshot :: Session -> HttpSpec Text
printPage :: Session -> HttpSpec Text
getWindowHandles :: Session -> HttpSpec [Handle]
getWindowRect :: Session -> HttpSpec WindowRect
setWindowRect :: Session -> WindowRect -> HttpSpec WindowRect
maximizeWindow :: Session -> HttpSpec WindowRect
minimizeWindow :: Session -> HttpSpec WindowRect
fullscreenWindow :: Session -> HttpSpec WindowRect
switchToParentFrame :: Session -> HttpSpec ()
getActiveElement :: Session -> HttpSpec ElementId
findElement :: Session -> Selector -> HttpSpec ElementId
findElements :: Session -> Selector -> HttpSpec [ElementId]
findElementFromElement :: Session -> ElementId -> Selector -> HttpSpec ElementId
findElementsFromElement :: Session -> ElementId -> Selector -> HttpSpec [ElementId]
isElementSelected :: Session -> ElementId -> HttpSpec Bool
getElementAttribute :: Session -> ElementId -> Text -> HttpSpec Text
getElementProperty :: Session -> ElementId -> Text -> HttpSpec Value
getElementCssValue :: Session -> ElementId -> Text -> HttpSpec Text
getElementShadowRoot :: Session -> ElementId -> HttpSpec ShadowRootElementId
getElementText :: Session -> ElementId -> HttpSpec Text
getElementTagName :: Session -> ElementId -> HttpSpec Text
getElementRect :: Session -> ElementId -> HttpSpec WindowRect
isElementEnabled :: Session -> ElementId -> HttpSpec Bool
getElementComputedRole :: Session -> ElementId -> HttpSpec Text
getElementComputedLabel :: Session -> ElementId -> HttpSpec Text
elementClick :: Session -> ElementId -> HttpSpec ()
elementClear :: Session -> ElementId -> HttpSpec ()
elementSendKeys :: Session -> ElementId -> Text -> HttpSpec ()
takeElementScreenshot :: Session -> ElementId -> HttpSpec Text
findElementFromShadowRoot :: Session -> ShadowRootElementId -> Selector -> HttpSpec ElementId
findElementsFromShadowRoot :: Session -> ShadowRootElementId -> Selector -> HttpSpec [ElementId]

The HttpSpec Type

data HttpSpec a Source #

The HttpSpec type is a specification for a WebDriver Http command. Every endpoint function in this module returns a HttpSpec object.

Constructors

Get
Fields description :: Text path :: UrlPath parser :: HttpResponse -> Result a
Post
Fields description :: Text path :: UrlPath body :: Value parser :: HttpResponse -> Result a
PostEmpty
Fields description :: Text path :: UrlPath parser :: HttpResponse -> Result a
Delete
Fields description :: Text path :: UrlPath parser :: HttpResponse -> Result a

Instances

Instances details

Show a => Show (HttpSpec a) Source #
Instance details Defined in WebDriverPreCore.HTTP.SpecDefinition Methods showsPrec :: Int -> HttpSpec a -> ShowS # show :: HttpSpec a -> String # showList :: [HttpSpec a] -> ShowS #

The API

Root Methods

newSession :: FullCapabilities -> HttpSpec SessionResponse Source #

Return a spec to create a new session given FullCapabilities object.

newSession' can be used if FullCapabilities doesn't meet your requirements.

spec

POST 	/session 	New Session

newSession' :: ToJSON a => a -> HttpSpec SessionResponse Source #

Return a spec to create a new session given an object of any type that implements ToJSON.

The FullCapabilities type and associated types should work for the vast majority use cases, but if the required capabilities are not covered by the types provided, newSession'. can be used with a custom type instead. newSession' works with any type that implements ToJSON, (including an Aeson Value).

Obviously, any type used must produce a JSON object compatible with capabilities as defined W3C spec.

spec

POST 	/session 	New Session

status :: HttpSpec Status Source #

Return a spec to get the status of the driver.

spec

GET 	/status 	Status

Session Methods

deleteSession :: Session -> HttpSpec () Source #

Return a spec to delete a session given a Session.

spec

DELETE 	/session/{session id} 	Delete Session

getTimeouts :: Session -> HttpSpec Timeouts Source #

Return a spec to get the timeouts of a session given a Session.

spec

GET 	/session/{session id}/timeouts 	Get Timeouts

setTimeouts :: Session -> Timeouts -> HttpSpec () Source #

Return a spec to set the timeouts of a session given a Session and Timeouts.

spec

POST 	/session/{session id}/timeouts 	Set Timeouts

navigateTo :: Session -> URL -> HttpSpec () Source #

Return a spec to navigate to a URL given a Session and a Text URL.

spec

POST 	/session/{session id}/url 	Navigate To

getCurrentUrl :: Session -> HttpSpec URL Source #

Return a spec to get the current URL of a session given a Session.

spec

GET 	/session/{session id}/url 	Get Current URL

back :: Session -> HttpSpec () Source #

Return a spec to navigate back in the browser history given a Session.

spec

POST 	/session/{session id}/back 	Back

forward :: Session -> HttpSpec () Source #

Return a spec to navigate forward in the browser history given a Session.

spec

POST 	/session/{session id}/forward 	Forward

refresh :: Session -> HttpSpec () Source #

Return a spec to refresh the current page given a Session.

spec

POST 	/session/{session id}/refresh 	Refresh

getTitle :: Session -> HttpSpec Text Source #

Return a spec to get the title of the current page given a Session.

spec

GET 	/session/{session id}/title 	Get Title

getWindowHandle :: Session -> HttpSpec Handle Source #

Return a spec to get the current window handle given a Session.

spec

GET 	/session/{session id}/window 	Get Window Handle

newWindow :: Session -> HttpSpec WindowHandleSpec Source #

Return a spec to create a new window given a Session.

spec

POST 	/session/{session id}/window/new 	New Window

closeWindow :: Session -> HttpSpec [Handle] Source #

Return a spec to close the current window given a Session.

spec

DELETE 	/session/{session id}/window 	Close Window

switchToWindow :: Session -> Handle -> HttpSpec () Source #

Return a spec to switch to a different window given a Session and WindowHandle.

spec

POST 	/session/{session id}/window 	Switch To Window

switchToFrame :: Session -> FrameReference -> HttpSpec () Source #

Return a spec to switch to a different frame given a Session and FrameReference.

spec

POST 	/session/{session id}/frame 	Switch To Frame

getPageSource :: Session -> HttpSpec Text Source #

Return a spec to get the source of the current page given a Session.

spec

GET 	/session/{session id}/source 	Get Page Source

executeScript :: Session -> Script -> HttpSpec Value Source #

Return a spec to execute a script in the context of the current page given a Session, Text script, and a list of Value arguments.

spec

POST 	/session/{session id}/execute/sync 	Execute Script

executeScriptAsync :: Session -> Script -> HttpSpec Value Source #

Return a spec to execute an asynchronous script in the context of the current page given a Session, Text script, and a list of Value arguments.

spec

POST 	/session/{session id}/execute/async 	Execute Async Script

addCookie :: Session -> Cookie -> HttpSpec () Source #

Return a spec to add a cookie to the current page given a Session and Cookie.

spec

POST 	/session/{session id}/cookie 	Add Cookie

getAllCookies :: Session -> HttpSpec [Cookie] Source #

Return a spec to get all cookies of the current page given a Session.

spec

GET 	/session/{session id}/cookie 	Get All Cookies

getNamedCookie :: Session -> Text -> HttpSpec Cookie Source #

Return a spec to get a named cookie of the current page given a Session and cookie name.

spec

GET 	/session/{session id}/cookie/{name} 	Get Named Cookie

deleteCookie :: Session -> Text -> HttpSpec () Source #

Return a spec to delete a named cookie from the current page given a Session and cookie name.

spec

DELETE 	/session/{session id}/cookie/{name} 	Delete Cookie

deleteAllCookies :: Session -> HttpSpec () Source #

Return a spec to delete all cookies from the current page given a Session.

spec

DELETE 	/session/{session id}/cookie 	Delete All Cookies

performActions :: Session -> Actions -> HttpSpec () Source #

Return a spec to perform actions on the current page given a Session and Actions.

spec

POST 	/session/{session id}/actions 	Perform Actions

releaseActions :: Session -> HttpSpec () Source #

Return a spec to release actions on the current page given a Session.

spec

DELETE 	/session/{session id}/actions 	Release Actions

dismissAlert :: Session -> HttpSpec () Source #

Return a spec to dismiss an alert on the current page given a Session.

spec

POST 	/session/{session id}/alert/dismiss 	Dismiss Alert

acceptAlert :: Session -> HttpSpec () Source #

Return a spec to accept an alert on the current page given a Session.

spec

POST 	/session/{session id}/alert/accept 	Accept Alert

getAlertText :: Session -> HttpSpec Text Source #

Return a spec to get the text of an alert on the current page given a Session.

spec

GET 	/session/{session id}/alert/text 	Get Alert Text

sendAlertText :: Session -> Text -> HttpSpec () Source #

Return a spec to send text to an alert on the current page given a Session and Text.

spec

POST 	/session/{session id}/alert/text 	Send Alert Text

takeScreenshot :: Session -> HttpSpec Text Source #

Return a spec to take a screenshot of the current page given a Session.

spec

GET 	/session/{session id}/screenshot 	Take Screenshot

printPage :: Session -> HttpSpec Text Source #

Return a spec to print the current page given a Session.

spec

POST 	/session/{session id}/print 	Print Page

Window Methods

getWindowHandles :: Session -> HttpSpec [Handle] Source #

Return a spec to get all window handles of the current session given a Session.

spec

GET 	/session/{session id}/window/handles 	Get Window Handles

getWindowRect :: Session -> HttpSpec WindowRect Source #

Return a spec to get the window rect of the current window given a Session.

spec

GET 	/session/{session id}/window/rect 	Get Window Rect

setWindowRect :: Session -> WindowRect -> HttpSpec WindowRect Source #

Return a spec to set the window rect of the current window given a Session and WindowRect.

spec

POST 	/session/{session id}/window/rect 	Set Window Rect

maximizeWindow :: Session -> HttpSpec WindowRect Source #

Return a spec to maximize the current window given a Session.

spec

POST 	/session/{session id}/window/maximize 	Maximize Window

minimizeWindow :: Session -> HttpSpec WindowRect Source #

Return a spec to minimize the current window given a Session.

spec

POST 	/session/{session id}/window/minimize 	Minimize Window

fullscreenWindow :: Session -> HttpSpec WindowRect Source #

Return a spec to fullscreen the current window given a Session.

spec

POST 	/session/{session id}/window/fullscreen 	Fullscreen Window

Frame Methods

switchToParentFrame :: Session -> HttpSpec () Source #

Return a spec to switch to the parent frame given a Session.

spec

POST 	/session/{session id}/frame/parent 	Switch To Parent Frame

Element(s) Methods

getActiveElement :: Session -> HttpSpec ElementId Source #

Return a spec to get the active element of the current page given a Session.

spec

GET 	/session/{session id}/element/active 	Get Active Element

findElement :: Session -> Selector -> HttpSpec ElementId Source #

Return a spec to find an element on the current page given a Session and Selector.

spec

POST 	/session/{session id}/element 	Find Element

findElements :: Session -> Selector -> HttpSpec [ElementId] Source #

Return a spec to find elements on the current page given a Session and Selector.

spec

POST 	/session/{session id}/elements 	Find Elements

Element Instance Methods

findElementFromElement :: Session -> ElementId -> Selector -> HttpSpec ElementId Source #

Return a spec to find an element from another element given a Session, ElementId, and Selector.

spec

POST 	/session/{session id}/element/{element id}/element 	Find Element From Element

findElementsFromElement :: Session -> ElementId -> Selector -> HttpSpec [ElementId] Source #

Return a spec to find elements from another element given a Session, ElementId, and Selector.

spec

POST 	/session/{session id}/element/{element id}/elements 	Find Elements From Element

isElementSelected :: Session -> ElementId -> HttpSpec Bool Source #

Return a spec to check if an element is selected given a Session and ElementId.

spec

GET 	/session/{session id}/element/{element id}/selected 	Is Element Selected

getElementAttribute :: Session -> ElementId -> Text -> HttpSpec Text Source #

Return a spec to get an attribute of an element given a Session, ElementId, and attribute name.

spec

GET 	/session/{session id}/element/{element id}/attribute/{name} 	Get Element Attribute

getElementProperty :: Session -> ElementId -> Text -> HttpSpec Value Source #

Return a spec to get a property of an element given a Session, ElementId, and property name.

spec

GET 	/session/{session id}/element/{element id}/property/{name} 	Get Element Property

getElementCssValue :: Session -> ElementId -> Text -> HttpSpec Text Source #

Return a spec to get the CSS value of an element given a Session, ElementId, and CSS property name.

spec

GET 	/session/{session id}/element/{element id}/css/{property name} 	Get Element CSS Value

getElementShadowRoot :: Session -> ElementId -> HttpSpec ShadowRootElementId Source #

Return a spec to get the shadow root of an element given a Session and ElementId.

spec

GET 	/session/{session id}/element/{element id}/shadow 	Get Element Shadow Root

getElementText :: Session -> ElementId -> HttpSpec Text Source #

Return a spec to get the text of an element given a Session and ElementId.

spec

GET 	/session/{session id}/element/{element id}/text 	Get Element Text

getElementTagName :: Session -> ElementId -> HttpSpec Text Source #

Return a spec to get the tag name of an element given a Session and ElementId.

spec

GET 	/session/{session id}/element/{element id}/name 	Get Element Tag Name

getElementRect :: Session -> ElementId -> HttpSpec WindowRect Source #

Return a spec to get the rect of an element given a Session and ElementId.

spec

GET 	/session/{session id}/element/{element id}/rect 	Get Element Rect

isElementEnabled :: Session -> ElementId -> HttpSpec Bool Source #

Return a spec to check if an element is enabled given a Session and ElementId. SAP will foc spec

GET 	/session/{session id}/element/{element id}/enabled 	Is Element Enabled

getElementComputedRole :: Session -> ElementId -> HttpSpec Text Source #

Return a spec to get the computed role of an element given a Session and ElementId.

spec

GET 	/session/{session id}/element/{element id}/computedrole 	Get Computed Role

getElementComputedLabel :: Session -> ElementId -> HttpSpec Text Source #

Return a spec to get the computed label of an element given a Session and ElementId.

spec

GET 	/session/{session id}/element/{element id}/computedlabel 	Get Computed Label

elementClick :: Session -> ElementId -> HttpSpec () Source #

Return a spec to click an element given a Session and ElementId.

spec

POST 	/session/{session id}/element/{element id}/click 	Element Click

elementClear :: Session -> ElementId -> HttpSpec () Source #

Return a spec to clear an element given a Session and ElementId.

spec

POST 	/session/{session id}/element/{element id}/clear 	Element Clear

elementSendKeys :: Session -> ElementId -> Text -> HttpSpec () Source #

Return a spec to send keys to an element given a Session, ElementId, and keys to send.

spec

POST 	/session/{session id}/element/{element id}/value 	Element Send Keys

takeElementScreenshot :: Session -> ElementId -> HttpSpec Text Source #

Return a spec to take a screenshot of an element given a Session and ElementId.

spec

GET 	/session/{session id}/element/{element id}/screenshot 	Take Element Screenshot

Shadow DOM Methods

findElementFromShadowRoot :: Session -> ShadowRootElementId -> Selector -> HttpSpec ElementId Source #

Return a spec to find an element from the shadow root given a Session, ElementId, and Selector.

spec

POST 	/session/{session id}/shadow/{shadow id}/element 	Find Element From Shadow Root

findElementsFromShadowRoot :: Session -> ShadowRootElementId -> Selector -> HttpSpec [ElementId] Source #

Return a spec to find elements from the shadow root given a Session, ElementId, and Selector.

spec

POST 	/session/{session id}/shadow/{shadow id}/elements 	Find Elements From Shadow Root